tsdat.transform.converters
¶
Classes¶
Base class for running data conversions on retrieved raw data. |
|
Base class for running data conversions on retrieved raw data. |
|
Base class for running data conversions on retrieved raw data. |
|
Base class for running data conversions on retrieved raw data. |
|
Base class for running data conversions on retrieved raw data. |
- class tsdat.transform.converters.Automatic[source]¶
Bases:
_ADIBaseTransformer
Base class for running data conversions on retrieved raw data.
- class tsdat.transform.converters.BinAverage[source]¶
Bases:
_ADIBaseTransformer
Base class for running data conversions on retrieved raw data.
- class tsdat.transform.converters.CreateTimeGrid[source]¶
Bases:
tsdat.io.base.DataConverter
Base class for running data conversions on retrieved raw data.
- interval :str[source]¶
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
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] [source]¶
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.