tsdat.transform

Submodules

• tsdat.transform.adi
• tsdat.transform.converters

Classes

Automatic	Base class for running data conversions on retrieved raw data.
BinAverage	Base class for running data conversions on retrieved raw data.
CreateTimeGrid	Base class for running data conversions on retrieved raw data.
Interpolate	Base class for running data conversions on retrieved raw data.
NearestNeighbor	Base class for running data conversions on retrieved raw data.

class tsdat.transform.Automatic

Bases: _ADIBaseTransformer

Base class for running data conversions on retrieved raw data.

transformation_type :str = TRANS_AUTO

class tsdat.transform.BinAverage

Bases: _ADIBaseTransformer

Base class for running data conversions on retrieved raw data.

transformation_type :str = TRANS_BIN_AVERAGE

class tsdat.transform.CreateTimeGrid

Bases: tsdat.io.base.DataConverter

Base class for running data conversions on retrieved raw data.

interval :str

The frequency of time points. This is passed to pd.timedelta_range as the ‘freq’ argument. E.g., ’30s’, ‘5min’, ‘10min’, ‘1H’, etc.

Class Methods

convert

Runs the data converter on the retrieved data.

Method Descriptions

convert(self, data: xarray.DataArray, variable_name: str, dataset_config: Optional[tsdat.config.dataset.DatasetConfig] = None, retrieved_dataset: Optional[tsdat.io.base.RetrievedDataset] = None, retriever: Optional[tsdat.io.retrievers.StorageRetriever] = None, time_span: Optional[Tuple[str, str]] = None, input_key: Optional[str] = None, **kwargs: Any) → Optional[xarray.DataArray]

Runs the data converter on the retrieved data.

Parameters

• data (xr.DataArray) – The retrieved DataArray to convert.

• retrieved_dataset (RetrievedDataset) – The retrieved dataset containing data to convert.

• dataset_config (DatasetConfig) – The output dataset configuration.

• variable_name (str) – The name of the variable to convert.

Returns

Optional[xr.DataArray] –

The converted DataArray for the specified variable,

or None if the conversion was done in-place.

class tsdat.transform.Interpolate

Bases: _ADIBaseTransformer

Base class for running data conversions on retrieved raw data.

transformation_type :str = TRANS_INTERPOLATE

class tsdat.transform.NearestNeighbor

Bases: _ADIBaseTransformer

Base class for running data conversions on retrieved raw data.

transformation_type :str = TRANS_SUBSAMPLE