postprocessor.core.processes.autoreg.autoregParameters

class postprocessor.core.processes.autoreg.autoregParameters(**kwargs)

Bases: ParametersABC

Parameters for the ‘autoreg’ process

Parameters for the ‘autoreg’ process.

Attributes

sampling_periodfloat

Sampling period of measurement values, in unit time.

freq_npointsint

Number of points for the frequency axis of the closed-form solution of the estimated periodogram. Defines the resolution for use in, for example, plots.

# Sampling period should be listed in the HDF5 metadata (i.e. the # ‘time_settings/timeinterval’ attribute, unit seconds). When using # this processor in a typical routine, use the sampling period from # there rather than relying on this default value of 5 minutes.

Methods

from_yaml(source)	Returns instance from a yaml filename or stdin
to_dict([iterable])	Recursive function to return a nested dictionary of the attributes of the class instance.
to_yaml([path])	Returns a yaml stream of the attributes of the class instance.
update(name, new_value)	Update values recursively if name is a dictionary, inject data where found.

default
from_dict

__init__(**kwargs)

Defines parameters as attributes

Methods

__init__(**kwargs)	Defines parameters as attributes
default(**kwargs)
from_dict(d)
from_yaml(source)	Returns instance from a yaml filename or stdin
to_dict([iterable])	Recursive function to return a nested dictionary of the attributes of the class instance.
to_yaml([path])	Returns a yaml stream of the attributes of the class instance.
update(name, new_value)	Update values recursively if name is a dictionary, inject data where found.

classmethod from_yaml(source: Union[PosixPath, str])

Returns instance from a yaml filename or stdin

to_dict(iterable='null')

Recursive function to return a nested dictionary of the attributes of the class instance.

to_yaml(path: Optional[Union[PosixPath, str]] = None)

Returns a yaml stream of the attributes of the class instance. If path is provided, the yaml stream is saved there.

Parameters

pathUnion[PosixPath, str]

Output path.

update(name: str, new_value)

Update values recursively if name is a dictionary, inject data where found. It forbids type changes.