Axis#

class Axis(name, type, unit=None)[source]#

Description of an axis including type and units. .. attribute:: name

The name of the axis. Must be one of: “t”, “c”, “z”, “y”, “x”.

type:

str

Parameters:

  • name (Literal['t', 'c', 'z', 'y', 'x']) –

  • type (Literal['time', 'space', 'channel']) –

  • unit (Optional[Union[Literal['angstrom', 'attometer', 'centimeter', 'decimeter', 'exameter', 'femtometer', 'foot', 'gigameter', 'hectometer', 'inch', 'kilometer', 'megameter', 'meter', 'micrometer', 'mile', 'millimeter', 'nanometer', 'parsec', 'petameter', 'picometer', 'terameter', 'yard', 'yoctometer', 'yottameter', 'zeptometer', 'zettameter'], ~typing.Literal['attosecond', 'centisecond', 'day', 'decisecond', 'exasecond', 'femtosecond', 'gigasecond', 'hectosecond', 'hour', 'kilosecond', 'megasecond', 'microsecond', 'millisecond', 'minute', 'nanosecond', 'petasecond', 'picosecond', 'second', 'terasecond', 'yoctosecond', 'yottasecond', 'zeptosecond', 'zettasecond']]]) –

type#

The type of the axis. Msut be one of: “time”, “space”, “channel”.

Type:

str

unit#

The units of the axis.

Type:

str

Methods

Attributes

unit

name

type