SpectralShapeZero

class glotaran.builtin.megacomplexes.spectral.shape.SpectralShapeZero

Bases: object

A constant spectral shape with value 0

Attributes Summary

label	ModelProperty is an extension of the property decorator.
type	ModelProperty is an extension of the property decorator.

Methods Summary

as_dict
calculate	calculate calculates the shape.
fill
from_dict
markdown
validate

Methods Documentation

as_dict() → dict

calculate(axis: numpy.ndarray) → numpy.ndarray

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

classmethod from_dict(values: dict) → cls

property label: model_property.glotaran_property_type

ModelProperty is an extension of the property decorator.

It adds convenience functions for meta programming model items.

markdown(all_parameters: ParameterGroup = None, initial_parameters: ParameterGroup = None) → MarkdownStr

property type: model_property.glotaran_property_type

ModelProperty is an extension of the property decorator.

It adds convenience functions for meta programming model items.

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