trendminer.data_reference module

This module groups definitions related to data references that identify tags (i.e. time series).

class trendminer.data_reference.DataReference(id: uuid.UUID, name: str, type: trendminer.data_reference.DataReferenceType, path: Optional[str] = None)

Bases: object

A data reference points to a particular data item (Time Series or Asset Attribute).

id() → uuid.UUID

UUID of data reference

name() → str

Name of data reference

path() → Optional[str]

The (optional) path of data reference


Type of data reference

class trendminer.data_reference.DataReferenceDescriptor(data_reference: trendminer.data_reference.DataReference, shift_in_seconds: int, interpolation_type: trendminer.data_reference.InterpolationType)

Bases: object

A DataReferenceDescriptor is a DataReference in a context, namely the shift applied to the reference and the selected interpolation type for the reference.


The DataReference of the descriptor


The InterpolationType of the descriptor

shift_in_seconds() → int

The shift (in seconds) of the descriptor

class trendminer.data_reference.DataReferenceType(value)

Bases: enum.Enum

Type of a Data Reference. It is either a time series, or an attribute of an asset (pointing to a time series). .

class trendminer.data_reference.InterpolationType(value)

Bases: enum.Enum

The type of interpolation

DEFAULT = 'default'
LINEAR = 'linear'
STEP_AFTER = 'step-after'
trendminer.data_reference.from_ds_time_series_info(interpolation_type: str)trendminer.data_reference.InterpolationType

Attempt to interpret some string as a InterpolationType


interpolation_type – The string representation to intepret


The resulting InterpolationType


Exception – If the string representation does not correspond some InterpolationType