shnitsel.data.dataset_containers.multi_series

Classes

MultiSeriesDataset

Class to serve as the basis for Layered and Stacked multi-dataseries datasets.

Module Contents

class MultiSeriesDataset(basis, combined=None)

Bases: shnitsel.data.dataset_containers.data_series.DataSeries

Class to serve as the basis for Layered and Stacked multi-dataseries datasets.

Is itself a DataSeries, but with different, more specific semantics than a generic DataSeries.

Parameters:

• basis (xarray.Dataset | Sequence[shnitsel.data.dataset_containers.frames.Frames | shnitsel.data.dataset_containers.trajectory.Trajectory | xarray.Dataset])

• combined (xarray.Dataset | None)

_basis_data: Sequence[shnitsel.data.dataset_containers.frames.Frames | shnitsel.data.dataset_containers.trajectory.Trajectory | xarray.Dataset] | None = None

property grouping_dimension: str

Return type:

str

property as_stacked: shnitsel.data.dataset_containers.multi_stacked.MultiSeriesStacked

Abstractmethod:

Return type:

shnitsel.data.dataset_containers.multi_stacked.MultiSeriesStacked

property as_layered: shnitsel.data.dataset_containers.multi_layered.MultiSeriesLayered

Abstractmethod:

Return type:

shnitsel.data.dataset_containers.multi_layered.MultiSeriesLayered

get_grouping_metadata()

Return type:

shnitsel.data.trajectory_grouping_params.TrajectoryGroupingMetadata

classmethod get_type_marker()

Return type:

str