shnitsel.data.dataset_containers.multi_layered#

Classes#

MultiSeriesLayered

A version of the multi-series dataset where the data is indexed along a new trajectory dimension.

Module Contents#

class MultiSeriesLayered(framesets)#

Bases: shnitsel.data.dataset_containers.multi_series.MultiSeriesDataset

A version of the multi-series dataset where the data is indexed along a new trajectory dimension. Missing data across trajectories is padded with np.nan values and can thus lead to typing issues.

Parameters:

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

_stacked_repr_cached: MultiSeriesStacked | None = None#
property grouping_dimension: str#
Return type:

str

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

Get a stacked representation of the layered datasets in this object

Returns:

The converted (or extracted from cache) stacked version of this multi-data dataset.

Return type:

MultiSeriesStacked

property as_layered: Self#
Return type:

Self

classmethod get_type_marker()#
Return type:

str