Inner variables

There are many inner variables within the pyBumpHunter classes. They are used to store the parameters defining the behavior of the scan methods and to store the results.

These variables are also used to by the print/plot methods to retrieve the results and parameters of the last scan performed.

How to use the inner variables ?

The inner variable variables can be used as you would use any other class.
You can simply access it as follow:

import pyBumpHunter

BH = pyBumpHunter.BumpHunter1D()
print(BH.variable_name)

Thus, most of the parameters that can be passed as argument of the init method of the 'BumpHunter1D' and BumpHunter2D classes can be set by accessing it after declaring a new instance.

It is also possible to access the results of the last scan function by accessing the result inner variables, so you don't have to depend only on the builtin display metohds of the BumpHunter1D and BumpHunter2D classes.

Note that the result inner variables of the BumpHunter1D and BmpHunter2D class can't be defined with the init method.

See the full list of inner parameter variables.
See the full list of inner result variables.