firecrown.parameters.DerivedParameterScalar

class firecrown.parameters.DerivedParameterScalar(section, name, val)[source]

Bases: DerivedParameter

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)

Constructs a new derived parameter.

get_val()

Returns the value contained.

__eq__(other)

Compare two DerivedParameterScalar objects for equality.

Inherited from DerivedParameter

__init__(section, name)

Constructs a new derived parameter.

get_full_name()

Constructs the full name using section--name.

get_val()

Returns the value contained.


__eq__(other)[source]

Compare two DerivedParameterScalar objects for equality.

This implementation raises a NotImplemented exception unless both objects are DerivedParameterScalar objects.

Two DerivedParameterScalar objects are equal if they have the same section, name and value.

Parameters

other (object) –

Return type

bool

get_val()[source]

Returns the value contained.

Return type

float