nectarchain.makers.component.spe.spe_algorithm.SPEalgorithm#

class SPEalgorithm(pixels_id, config=None, parent=None, **kwargs)[source]#

Bases: Component

Methods

`add_traits`	Dynamically add trait attributes to the HasTraits instance.
`class_config_rst_doc`	Generate rST documentation for this class' config options.
`class_config_section`	Get the config section for this class.
`class_get_help`	Get the help string for this class in ReST format.
`class_get_trait_help`	Get the helptext string for a single trait.
`class_own_trait_events`	Get a dict of all event handlers defined on this class, not a parent.
`class_own_traits`	Get a dict of all the traitlets defined on this class, not a parent.
`class_print_help`	Get the help string for a single trait and print it.
`class_trait_names`	Get a list of all the names of this class' traits.
`class_traits`	Get a `dict` of all the traits of this class.
`from_name`	Obtain an instance of a subclass via its name
`get_current_config`	return the current configuration as a dict (e.g. the values of all traits, even if they were not set during configuration).
`has_trait`	Returns True if the object has a trait with the specified name.
`hold_trait_notifications`	Context manager for bundling trait change notifications and cross validation.
`non_abstract_subclasses`	Get a dict of all non-abstract subclasses of this class.
`notify_change`	Notify observers of a change event
`observe`	Setup a handler to be called when a trait changes.
`on_trait_change`	DEPRECATED: Setup a handler to be called when a trait changes.
`read_param_from_yaml`	Reads parameters from a YAML file and updates the internal parameters of the FlatFieldSPEMaker class.
`section_names`	return section names as a list
`set_trait`	Forcibly sets trait attribute, including read-only attributes.
`setup_instance`
`trait_defaults`	Return a trait's default value or a dictionary of them
`trait_events`	Get a `dict` of all the event handlers of this class.
`trait_has_value`	Returns True if the specified trait has a value.
`trait_metadata`	Get metadata values for trait by key.
`trait_names`	Get a list of all the names of this class' traits.
`trait_values`	A `dict` of trait names and their values.
`traits`	Get a `dict` of all the traits of this class.
`unobserve`	Remove a trait change handler.
`unobserve_all`	Remove trait change handlers of any type for the specified name.
`update_config`	Update config and load the new values

Attributes

`config`	A trait whose value must be an instance of a specified class.
`cross_validation_lock`	A contextmanager for running a block with our cross validation lock set to True.
`display_toggle`	Enable/disable display of SPE fit results
`npixels`
`order`	The order of the polynome used in the savgol filter algorithm
`parameters`
`parent`	A trait whose value must be an instance of a specified class.
`pixels_id`
`results`
`window_length`	The windows leght used for the savgol filter algorithm

display_toggle#: Enable/disable display of SPE fit results

order#: The order of the polynome used in the savgol filter algorithm

read_param_from_yaml(parameters_file, only_update=False)[source]#

Reads parameters from a YAML file and updates the internal parameters of the FlatFieldSPEMaker class.

Return type:

None

Parameters:

parameters_filestr: The name of the YAML file containing the parameters.
only_updatebool, optional: If True, only the parameters that exist in the YAML file will be updated. Default is False.

window_length#: The windows leght used for the savgol filter algorithm