firecrown.parameters.DerivedParameter#
- class firecrown.parameters.DerivedParameter(section, name, val)[source]#
Bases:
object
Represents a derived scalar parameter generated by an Updatable object.
- This class provide the type that encapsulate a derived scalar quantity (represented
by a float) computed by an Updatable object during a statistical analysis.
- Parameters:
section (
str
) –name (
str
) –val (
float
) –
Public Methods:
__init__
(section, name, val)Initialize the DerivedParameter object.
get_val
()Return the value of this parameter.
__eq__
(other)Compare two DerivedParameter objects for equality.
Constructs the full name using section--name.
- __eq__(other)[source]#
Compare two DerivedParameter objects for equality.
This implementation raises a NotImplemented exception unless both objects are DerivedParameter objects.
Two DerivedParameter objects are equal if they have the same section, name and value.
- Parameters:
other (
object
) –- Return type:
bool