SpectralShapeZero

class glotaran.builtin.megacomplexes.spectral.shape.SpectralShapeZero[source]

Bases: object

A constant spectral shape with value 0

Attributes Summary

`label`
`type`

Methods Summary

`as_dict`
`calculate`	calculate calculates the shape.
`fill`	Returns a copy of the {cls._name} instance with all members which are Parameters are replaced by the value of the corresponding parameter in the parameter group.
`from_dict`
`get_parameters`	Returns all parameter full labels of the item.
`mprint`
`validate`

Methods Documentation

as_dict() → dict

calculate(axis: numpy.ndarray) → numpy.ndarray[source]

calculate calculates the shape.

Only works after calling fill.

Parameters: axis (np.ndarray) – The axis to calculate the shape on.
Returns: shape
Return type: numpy.ndarray

fill(model: Model, parameters: ParameterGroup) → cls

Returns a copy of the {cls._name} instance with all members which are Parameters are replaced by the value of the corresponding parameter in the parameter group.

Parameters

model – A glotaran model.
parameter (ParameterGroup) – The parameter group to fill from.

classmethod from_dict(values: dict) → cls

get_parameters() → list[str]: Returns all parameter full labels of the item.

property label: prop_type

mprint(parameters: ParameterGroup = None, initial_parameters: ParameterGroup = None) → str

property type: prop_type

validate(model: Model, parameters: ParameterGroup | None = None) → list[str]