Methods

There are three kind of methods in pyBumpHunter:

• Scan methods
  Apply the BumpHunter algorithm to data according to a specific set of parameters.

• Plot/print methods
  Use the results of the scan methods to produce pretty plots and print results in a clear and concise way.

• Variables management methods
  Help to manage all the parameter and result inner variables of the BumpHunter class.

All these functions use the inner variables of the 'BumpHunter1D' and 'BumpHunter2D' classes to store the parameters and store/access results.
More about inner variables.

NOTE : The BUmpHunter2D class is still under development/testing. All the scan and plot/print methods are not available yet.

About multithreading

Nowadays, most machines (laptops, servers, ...) have multi-core CPUs, allowing us to run tasks in parallel.

Because it would be a waste not to profit of such feature, pyBumpHunter gives a option to use multithreading in order to speed-up the scan functions.

This feature can be enabled using the "nworker" parameter.

This is a transparent features that doesn't require any fancy third party tools/library.

Just make sure you have enough resources available on your machine.