tape.analysis.structure_function.calculator_registrar

Module Contents

Functions

register_sf_subclasses()	This method will identify all of the subclasses of StructureFunctionCalculator
update_sf_subclasses()	This function is used to register newly created subclasses of the

Attributes

SF_METHODS

register_sf_subclasses()

This method will identify all of the subclasses of StructureFunctionCalculator and build a dictionary that maps name : subclass.

Returns:

A dictionary of all of subclasses of StructureFunctionCalculator. Where the str returned from subclass.name_id() is the key, and the class is the value.

Return type:

dict

Raises:

ValueError – If a duplicate key is found, a ValueError will be raised. This would likely occur if a user copy/pasted an existing subclass but failed to update the unique name_id string.

update_sf_subclasses()

This function is used to register newly created subclasses of the StructureFunctionCalculator.

SF_METHODS