Skip to content

Latest commit

 

History

History
49 lines (36 loc) · 1.26 KB

axes.rst

File metadata and controls

49 lines (36 loc) · 1.26 KB

Axes

Note

This section characterizes protocols for axes. The purpose of a protocol is to provide support for nominal and structural subtyping.

Axis protocols

One essential building block for datasets like GridDatasetType and ParticleDatasetType are AxisType and GridAxisType. Similar to datasets, protocols are in place to provide available attributes.

AxisType

In addition, AxisType provides methods to check for equivalence between axes and to append another axis.

AxisType.equivalent

AxisType.append

As grid axes provide uniformity for each dimension of a grid, the GridAxisType extends AxisType.

GridAxisType

Axes container

Axes serve the purpose of providing meta information for DatasetType and are in general occurring in a combination with other axes. For this, two special purpose axes container exist, GridDatasetAxes and ParticleDatasetAxes.

GridDatasetAxes

ParticleDatasetAxes