State

systematica.models.meta_model.state

State

State()

State class for computing features from a data object.

Static methods

from_registry

from_registry(
    data: vectorbtpro.data.base.Data,
    window: int,
    minp: int = None,
    to_numpy: bool = False,
    state_registry: List[systematica.models.meta_model.state_registries.StateConfig] = None,
) ‑> pandas.core.frame.DataFrame | numpy.ndarray

Calculate all registered features.

Parameters:

Name	Type	Default	Description
data	vbt.Data	--	Data object. Must include required data from the registry.
window	tp.FrequencyLike	--	Window size as an integer.
minp	int	None	Minimum number of observations required.
to_numpy	bool	False	Output numpy array. Pandas DataFrame otherwise. Defaults to False.
state_registry	StateConfig	None	State representation registry. if None, uses STATE_REGISTRY. Defaults to None.

Returns:

Type	Description
pd.DataFrame | tp.Array2d	Computed features.