np_univariate

NumPy-backed data providers.

class pysatl_cpd.data.providers.plain.np_univariate.NDArrayUnivariateProvider(data, annotation)

Bases: DataProvider[Number, AnnotationT], Generic

Data provider for 1-D NumPy arrays.

Parameters:

• data (ndarray[tuple[int, ...], dtype[double]]) – 1-D numeric array containing the timeseries data.

• annotation (TypeVar(AnnotationT, bound= UnlabeledTimeseriesAnnotation)) – Annotation object associated with the timeseries.

Raises:

ValueError – If the data is not 1-dimensional.

__init__(data, annotation)

Parameters:

• data (NumericArray)

• annotation (AnnotationT)

Return type:

None

__iter__()

Iterate over series values.

Returns:

Iterator over the underlying NumPy scalars.

Return type:

Iterator[double]

__len__()

Return the series length.

Returns:

Number of samples in the series.

Return type:

int

property annotation: AnnotationT

Return the annotation associated with this timeseries.

Returns:

The annotation object for this series.

Return type:

annotation

property raw_data: UnivariateNumericArray

Return a copy of the underlying data array.

Returns:

Copy of the underlying univariate numeric array.

Return type:

raw_data

cut(start, stop, *, annotation=None)

Extract a slice of the timeseries data.

Parameters:

• start (int) – Start index of the slice (inclusive).

• stop (int) – Stop index of the slice (inclusive).

• annotation (Optional[TypeVar(AnnotationT, bound= UnlabeledTimeseriesAnnotation)]) – Optional annotation for the sliced data.

Returns:

New provider containing the sliced data.

Return type:

NDArrayUnivariateProvider[TypeVar(AnnotationT, bound= UnlabeledTimeseriesAnnotation)]

classmethod merge(providers, annotation_builder=None)

Merge multiple providers into a single provider.

Parameters:

• providers (Sequence[Self]) – Sequence of providers to merge.

• annotation_builder (Callable[[Sequence[TypeVar(AnnotationT, bound= UnlabeledTimeseriesAnnotation)]], TypeVar(AnnotationT, bound= UnlabeledTimeseriesAnnotation)] | None) – Optional function to build the merged annotation.

Returns:

New provider with merged data and annotation.

Return type:

NDArrayUnivariateProvider