BGlib.be.analysis.BESHOfitter

class BGlib.be.analysis.BESHOfitter(h5_main, **kwargs)[source]

Creates an instance of the BESHOFitter class

Parameters:

  • h5_main (pyUSID.io.USIDataset) – Main dataset containing band excitation measurement

  • h5_target_group (h5py.Group, optional. Default = None) – Location where to look for existing results and to place newly computed results. Use this kwarg if the results need to be written to a different HDF5 file. By default, this value is set to the parent group containing h5_main

  • kwargs (dict, optional) – Keyword arguments such as “verbose” and “cores” that will be passed onto Process

__init__(h5_main, **kwargs)[source]

Creates an instance of the BESHOFitter class

Parameters:

  • h5_main (pyUSID.io.USIDataset) – Main dataset containing band excitation measurement

  • h5_target_group (h5py.Group, optional. Default = None) – Location where to look for existing results and to place newly computed results. Use this kwarg if the results need to be written to a different HDF5 file. By default, this value is set to the parent group containing h5_main

  • kwargs (dict, optional) – Keyword arguments such as “verbose” and “cores” that will be passed onto Process

Methods

__init__(h5_main, **kwargs)

Creates an instance of the BESHOFitter class

compute([override])

Creates placeholders for the results, applies the _unit_computation() to chunks of the dataset

do_fit(*args[, override])

Computes the Fit

do_guess(*args[, override])

Computes the Guess

set_up_fit([fit_func, h5_partial_fit, h5_guess])

Need this because during the set up, we won't know which strategy is being used.

set_up_guess([guess_func, h5_partial_guess])

Need this because during the set up, we won't know which strategy is being used.

test(**kwargs)

Tests the process on a subset (for example a pixel) of the whole data.

use_partial_computation([h5_partial_group])

Extracts the necessary parameters from the provided h5 group to resume computation

Attributes

parms_dict

The name of the HDF5 dataset that should be present to signify which positions have already been computed This is NOT a fully private variable so that multiple processes can be run within a single group - Eg Fitter In the case of Fitter - this name can be changed from 'completed_guesses' to 'completed_fits' check_for_duplicates will be called by the Child class where they have the opportunity to change this variable before checking for duplicates