# {py:mod}`abtem.core.axes`

```{py:module} abtem.core.axes
```

```{autodoc2-docstring} abtem.core.axes
:parser: rst
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`AxesMetadataList <abtem.core.axes.AxesMetadataList>`
  -
* - {py:obj}`AxisAlignedTiltAxis <abtem.core.axes.AxisAlignedTiltAxis>`
  - ```{autodoc2-docstring} abtem.core.axes.AxisAlignedTiltAxis
    :parser: rst
    :summary:
    ```
* - {py:obj}`AxisMetadata <abtem.core.axes.AxisMetadata>`
  - ```{autodoc2-docstring} abtem.core.axes.AxisMetadata
    :parser: rst
    :summary:
    ```
* - {py:obj}`EnergyAxis <abtem.core.axes.EnergyAxis>`
  - ```{autodoc2-docstring} abtem.core.axes.EnergyAxis
    :parser: rst
    :summary:
    ```
* - {py:obj}`EnergyLossAxis <abtem.core.axes.EnergyLossAxis>`
  - ```{autodoc2-docstring} abtem.core.axes.EnergyLossAxis
    :parser: rst
    :summary:
    ```
* - {py:obj}`FrozenPhononsAxis <abtem.core.axes.FrozenPhononsAxis>`
  - ```{autodoc2-docstring} abtem.core.axes.FrozenPhononsAxis
    :parser: rst
    :summary:
    ```
* - {py:obj}`LinearAxis <abtem.core.axes.LinearAxis>`
  - ```{autodoc2-docstring} abtem.core.axes.LinearAxis
    :parser: rst
    :summary:
    ```
* - {py:obj}`NonLinearAxis <abtem.core.axes.NonLinearAxis>`
  - ```{autodoc2-docstring} abtem.core.axes.NonLinearAxis
    :parser: rst
    :summary:
    ```
* - {py:obj}`OrdinalAxis <abtem.core.axes.OrdinalAxis>`
  - ```{autodoc2-docstring} abtem.core.axes.OrdinalAxis
    :parser: rst
    :summary:
    ```
* - {py:obj}`ParameterAxis <abtem.core.axes.ParameterAxis>`
  - ```{autodoc2-docstring} abtem.core.axes.ParameterAxis
    :parser: rst
    :summary:
    ```
* - {py:obj}`PositionsAxis <abtem.core.axes.PositionsAxis>`
  - ```{autodoc2-docstring} abtem.core.axes.PositionsAxis
    :parser: rst
    :summary:
    ```
* - {py:obj}`PrismPlaneWavesAxis <abtem.core.axes.PrismPlaneWavesAxis>`
  - ```{autodoc2-docstring} abtem.core.axes.PrismPlaneWavesAxis
    :parser: rst
    :summary:
    ```
* - {py:obj}`RealSpaceAxis <abtem.core.axes.RealSpaceAxis>`
  - ```{autodoc2-docstring} abtem.core.axes.RealSpaceAxis
    :parser: rst
    :summary:
    ```
* - {py:obj}`ReciprocalSpaceAxis <abtem.core.axes.ReciprocalSpaceAxis>`
  - ```{autodoc2-docstring} abtem.core.axes.ReciprocalSpaceAxis
    :parser: rst
    :summary:
    ```
* - {py:obj}`SampleAxis <abtem.core.axes.SampleAxis>`
  - ```{autodoc2-docstring} abtem.core.axes.SampleAxis
    :parser: rst
    :summary:
    ```
* - {py:obj}`ScaleAxis <abtem.core.axes.ScaleAxis>`
  - ```{autodoc2-docstring} abtem.core.axes.ScaleAxis
    :parser: rst
    :summary:
    ```
* - {py:obj}`ScanAxis <abtem.core.axes.ScanAxis>`
  - ```{autodoc2-docstring} abtem.core.axes.ScanAxis
    :parser: rst
    :summary:
    ```
* - {py:obj}`SpinAxis <abtem.core.axes.SpinAxis>`
  - ```{autodoc2-docstring} abtem.core.axes.SpinAxis
    :parser: rst
    :summary:
    ```
* - {py:obj}`ThicknessAxis <abtem.core.axes.ThicknessAxis>`
  - ```{autodoc2-docstring} abtem.core.axes.ThicknessAxis
    :parser: rst
    :summary:
    ```
* - {py:obj}`TiltAxis <abtem.core.axes.TiltAxis>`
  - ```{autodoc2-docstring} abtem.core.axes.TiltAxis
    :parser: rst
    :summary:
    ```
* - {py:obj}`UnknownAxis <abtem.core.axes.UnknownAxis>`
  - ```{autodoc2-docstring} abtem.core.axes.UnknownAxis
    :parser: rst
    :summary:
    ```
* - {py:obj}`WaveVectorAxis <abtem.core.axes.WaveVectorAxis>`
  - ```{autodoc2-docstring} abtem.core.axes.WaveVectorAxis
    :parser: rst
    :summary:
    ```
````

### Functions

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`axis_from_dict <abtem.core.axes.axis_from_dict>`
  - ```{autodoc2-docstring} abtem.core.axes.axis_from_dict
    :parser: rst
    :summary:
    ```
* - {py:obj}`axis_to_dict <abtem.core.axes.axis_to_dict>`
  - ```{autodoc2-docstring} abtem.core.axes.axis_to_dict
    :parser: rst
    :summary:
    ```
* - {py:obj}`format_axes_metadata <abtem.core.axes.format_axes_metadata>`
  - ```{autodoc2-docstring} abtem.core.axes.format_axes_metadata
    :parser: rst
    :summary:
    ```
* - {py:obj}`format_label <abtem.core.axes.format_label>`
  - ```{autodoc2-docstring} abtem.core.axes.format_label
    :parser: rst
    :summary:
    ```
* - {py:obj}`format_title <abtem.core.axes.format_title>`
  - ```{autodoc2-docstring} abtem.core.axes.format_title
    :parser: rst
    :summary:
    ```
* - {py:obj}`format_value <abtem.core.axes.format_value>`
  - ```{autodoc2-docstring} abtem.core.axes.format_value
    :parser: rst
    :summary:
    ```
* - {py:obj}`latex_float <abtem.core.axes.latex_float>`
  - ```{autodoc2-docstring} abtem.core.axes.latex_float
    :parser: rst
    :summary:
    ```
````

### Data

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`categories <abtem.core.axes.categories>`
  - ```{autodoc2-docstring} abtem.core.axes.categories
    :parser: rst
    :summary:
    ```
* - {py:obj}`complex_labels <abtem.core.axes.complex_labels>`
  - ```{autodoc2-docstring} abtem.core.axes.complex_labels
    :parser: rst
    :summary:
    ```
````

### API

```{py:class} AxesMetadataList(...)
:canonical: abtem.core.axes.AxesMetadataList

Bases: {py:obj}`list`

```

`````{py:class} AxisAlignedTiltAxis
:canonical: abtem.core.axes.AxisAlignedTiltAxis

Bases: {py:obj}`abtem.core.axes.NonLinearAxis`

```{autodoc2-docstring} abtem.core.axes.AxisAlignedTiltAxis
:parser: rst
```

````{py:attribute} direction
:canonical: abtem.core.axes.AxisAlignedTiltAxis.direction
:type: str
:value: >
   'x'

```{autodoc2-docstring} abtem.core.axes.AxisAlignedTiltAxis.direction
:parser: rst
```

````

````{py:method} item_metadata(...)
:canonical: abtem.core.axes.AxisAlignedTiltAxis.item_metadata

````

````{py:property} tilt
:canonical: abtem.core.axes.AxisAlignedTiltAxis.tilt

```{autodoc2-docstring} abtem.core.axes.AxisAlignedTiltAxis.tilt
:parser: rst
```

````

````{py:attribute} units
:canonical: abtem.core.axes.AxisAlignedTiltAxis.units
:type: str
:value: >
   'mrad'

```{autodoc2-docstring} abtem.core.axes.AxisAlignedTiltAxis.units
:parser: rst
```

````

`````

`````{py:class} AxisMetadata
:canonical: abtem.core.axes.AxisMetadata

```{autodoc2-docstring} abtem.core.axes.AxisMetadata
:parser: rst
```

````{py:method} concatenate(...) -> abtem.core.axes.AxisMetadata
:canonical: abtem.core.axes.AxisMetadata.concatenate

```{autodoc2-docstring} abtem.core.axes.AxisMetadata.concatenate
:parser: rst
```

````

````{py:method} coordinates(...) -> tuple
:canonical: abtem.core.axes.AxisMetadata.coordinates

```{autodoc2-docstring} abtem.core.axes.AxisMetadata.coordinates
:parser: rst
```

````

````{py:method} copy() -> abtem.core.axes.AxisMetadata
:canonical: abtem.core.axes.AxisMetadata.copy

```{autodoc2-docstring} abtem.core.axes.AxisMetadata.copy
:parser: rst
```

````

````{py:method} format_coordinates(...)
:canonical: abtem.core.axes.AxisMetadata.format_coordinates

```{autodoc2-docstring} abtem.core.axes.AxisMetadata.format_coordinates
:parser: rst
```

````

````{py:method} format_label(...) -> str
:canonical: abtem.core.axes.AxisMetadata.format_label

```{autodoc2-docstring} abtem.core.axes.AxisMetadata.format_label
:parser: rst
```

````

````{py:method} format_title(...) -> str
:canonical: abtem.core.axes.AxisMetadata.format_title

```{autodoc2-docstring} abtem.core.axes.AxisMetadata.format_title
:parser: rst
```

````

````{py:method} format_type() -> str
:canonical: abtem.core.axes.AxisMetadata.format_type

```{autodoc2-docstring} abtem.core.axes.AxisMetadata.format_type
:parser: rst
```

````

````{py:method} from_dict(...) -> abtem.core.axes.AxisMetadata
:canonical: abtem.core.axes.AxisMetadata.from_dict
:staticmethod:

```{autodoc2-docstring} abtem.core.axes.AxisMetadata.from_dict
:parser: rst
```

````

````{py:method} item_metadata(...) -> dict
:canonical: abtem.core.axes.AxisMetadata.item_metadata

```{autodoc2-docstring} abtem.core.axes.AxisMetadata.item_metadata
:parser: rst
```

````

````{py:attribute} label
:canonical: abtem.core.axes.AxisMetadata.label
:type: str
:value: <Multiline-String>

```{autodoc2-docstring} abtem.core.axes.AxisMetadata.label
:parser: rst
```

````

````{py:method} limits(...) -> tuple
:canonical: abtem.core.axes.AxisMetadata.limits

```{autodoc2-docstring} abtem.core.axes.AxisMetadata.limits
:parser: rst
```

````

````{py:attribute} tex_label
:canonical: abtem.core.axes.AxisMetadata.tex_label
:type: typing.Optional[str]
:value: >
   None

```{autodoc2-docstring} abtem.core.axes.AxisMetadata.tex_label
:parser: rst
```

````

````{py:attribute} tex_units
:canonical: abtem.core.axes.AxisMetadata.tex_units
:type: typing.Optional[str]
:value: >
   None

```{autodoc2-docstring} abtem.core.axes.AxisMetadata.tex_units
:parser: rst
```

````

````{py:method} to_dict() -> dict
:canonical: abtem.core.axes.AxisMetadata.to_dict

```{autodoc2-docstring} abtem.core.axes.AxisMetadata.to_dict
:parser: rst
```

````

````{py:method} to_ordinal_axis(...)
:canonical: abtem.core.axes.AxisMetadata.to_ordinal_axis

```{autodoc2-docstring} abtem.core.axes.AxisMetadata.to_ordinal_axis
:parser: rst
```

````

````{py:attribute} units
:canonical: abtem.core.axes.AxisMetadata.units
:type: typing.Optional[str]
:value: >
   None

```{autodoc2-docstring} abtem.core.axes.AxisMetadata.units
:parser: rst
```

````

`````

`````{py:class} EnergyAxis
:canonical: abtem.core.axes.EnergyAxis

Bases: {py:obj}`abtem.core.axes.NonLinearAxis`

```{autodoc2-docstring} abtem.core.axes.EnergyAxis
:parser: rst
```

````{py:method} format_title(...) -> str
:canonical: abtem.core.axes.EnergyAxis.format_title

```{autodoc2-docstring} abtem.core.axes.EnergyAxis.format_title
:parser: rst
```

````

````{py:method} item_metadata(...)
:canonical: abtem.core.axes.EnergyAxis.item_metadata

````

````{py:attribute} label
:canonical: abtem.core.axes.EnergyAxis.label
:type: str
:value: >
   'Energy'

```{autodoc2-docstring} abtem.core.axes.EnergyAxis.label
:parser: rst
```

````

````{py:attribute} units
:canonical: abtem.core.axes.EnergyAxis.units
:type: str
:value: >
   'eV'

```{autodoc2-docstring} abtem.core.axes.EnergyAxis.units
:parser: rst
```

````

`````

`````{py:class} EnergyLossAxis
:canonical: abtem.core.axes.EnergyLossAxis

Bases: {py:obj}`abtem.core.axes.NonLinearAxis`

```{autodoc2-docstring} abtem.core.axes.EnergyLossAxis
:parser: rst
```

````{py:method} format_title(...) -> str
:canonical: abtem.core.axes.EnergyLossAxis.format_title

```{autodoc2-docstring} abtem.core.axes.EnergyLossAxis.format_title
:parser: rst
```

````

````{py:method} item_metadata(...)
:canonical: abtem.core.axes.EnergyLossAxis.item_metadata

````

````{py:attribute} label
:canonical: abtem.core.axes.EnergyLossAxis.label
:type: str
:value: >
   'energy loss'

```{autodoc2-docstring} abtem.core.axes.EnergyLossAxis.label
:parser: rst
```

````

````{py:attribute} units
:canonical: abtem.core.axes.EnergyLossAxis.units
:type: str
:value: >
   'eV'

```{autodoc2-docstring} abtem.core.axes.EnergyLossAxis.units
:parser: rst
```

````

`````

`````{py:class} FrozenPhononsAxis
:canonical: abtem.core.axes.FrozenPhononsAxis

Bases: {py:obj}`abtem.core.axes.AxisMetadata`

```{autodoc2-docstring} abtem.core.axes.FrozenPhononsAxis
:parser: rst
```

````{py:attribute} label
:canonical: abtem.core.axes.FrozenPhononsAxis.label
:type: str
:value: >
   'Frozen phonons'

```{autodoc2-docstring} abtem.core.axes.FrozenPhononsAxis.label
:parser: rst
```

````

`````

`````{py:class} LinearAxis
:canonical: abtem.core.axes.LinearAxis

Bases: {py:obj}`abtem.core.axes.AxisMetadata`

```{autodoc2-docstring} abtem.core.axes.LinearAxis
:parser: rst
```

````{py:method} convert_units(...)
:canonical: abtem.core.axes.LinearAxis.convert_units

```{autodoc2-docstring} abtem.core.axes.LinearAxis.convert_units
:parser: rst
```

````

````{py:method} coordinates(...) -> tuple[float, ...]
:canonical: abtem.core.axes.LinearAxis.coordinates

```{autodoc2-docstring} abtem.core.axes.LinearAxis.coordinates
:parser: rst
```

````

````{py:method} format_coordinates(...) -> str
:canonical: abtem.core.axes.LinearAxis.format_coordinates

```{autodoc2-docstring} abtem.core.axes.LinearAxis.format_coordinates
:parser: rst
```

````

````{py:attribute} offset
:canonical: abtem.core.axes.LinearAxis.offset
:type: float
:value: >
   0.0

```{autodoc2-docstring} abtem.core.axes.LinearAxis.offset
:parser: rst
```

````

````{py:attribute} sampling
:canonical: abtem.core.axes.LinearAxis.sampling
:type: float
:value: >
   1.0

```{autodoc2-docstring} abtem.core.axes.LinearAxis.sampling
:parser: rst
```

````

````{py:method} to_ordinal_axis(...)
:canonical: abtem.core.axes.LinearAxis.to_ordinal_axis

```{autodoc2-docstring} abtem.core.axes.LinearAxis.to_ordinal_axis
:parser: rst
```

````

````{py:attribute} units
:canonical: abtem.core.axes.LinearAxis.units
:type: str
:value: <Multiline-String>

```{autodoc2-docstring} abtem.core.axes.LinearAxis.units
:parser: rst
```

````

`````

`````{py:class} NonLinearAxis
:canonical: abtem.core.axes.NonLinearAxis

Bases: {py:obj}`abtem.core.axes.OrdinalAxis`

```{autodoc2-docstring} abtem.core.axes.NonLinearAxis
:parser: rst
```

````{py:method} format_coordinates(...)
:canonical: abtem.core.axes.NonLinearAxis.format_coordinates

```{autodoc2-docstring} abtem.core.axes.NonLinearAxis.format_coordinates
:parser: rst
```

````

````{py:method} format_title(...) -> str
:canonical: abtem.core.axes.NonLinearAxis.format_title

````

````{py:attribute} units
:canonical: abtem.core.axes.NonLinearAxis.units
:type: str
:value: >
   'unknown'

```{autodoc2-docstring} abtem.core.axes.NonLinearAxis.units
:parser: rst
```

````

`````

`````{py:class} OrdinalAxis
:canonical: abtem.core.axes.OrdinalAxis

Bases: {py:obj}`abtem.core.axes.AxisMetadata`

```{autodoc2-docstring} abtem.core.axes.OrdinalAxis
:parser: rst
```

````{py:method} concatenate(...) -> abtem.core.axes.OrdinalAxis
:canonical: abtem.core.axes.OrdinalAxis.concatenate

````

````{py:method} coordinates(...) -> tuple
:canonical: abtem.core.axes.OrdinalAxis.coordinates

```{autodoc2-docstring} abtem.core.axes.OrdinalAxis.coordinates
:parser: rst
```

````

````{py:method} format_all_titles() -> list[str]
:canonical: abtem.core.axes.OrdinalAxis.format_all_titles

```{autodoc2-docstring} abtem.core.axes.OrdinalAxis.format_all_titles
:parser: rst
```

````

````{py:method} format_title(...) -> str
:canonical: abtem.core.axes.OrdinalAxis.format_title

````

````{py:method} item_metadata(...)
:canonical: abtem.core.axes.OrdinalAxis.item_metadata

````

````{py:method} to_ordinal_axis(...) -> abtem.core.axes.OrdinalAxis
:canonical: abtem.core.axes.OrdinalAxis.to_ordinal_axis

```{autodoc2-docstring} abtem.core.axes.OrdinalAxis.to_ordinal_axis
:parser: rst
```

````

````{py:attribute} values
:canonical: abtem.core.axes.OrdinalAxis.values
:type: tuple
:value: >
   ()

```{autodoc2-docstring} abtem.core.axes.OrdinalAxis.values
:parser: rst
```

````

`````

`````{py:class} ParameterAxis
:canonical: abtem.core.axes.ParameterAxis

Bases: {py:obj}`abtem.core.axes.NonLinearAxis`

```{autodoc2-docstring} abtem.core.axes.ParameterAxis
:parser: rst
```

````{py:attribute} label
:canonical: abtem.core.axes.ParameterAxis.label
:type: str
:value: <Multiline-String>

```{autodoc2-docstring} abtem.core.axes.ParameterAxis.label
:parser: rst
```

````

`````

`````{py:class} PositionsAxis
:canonical: abtem.core.axes.PositionsAxis

Bases: {py:obj}`abtem.core.axes.OrdinalAxis`

```{autodoc2-docstring} abtem.core.axes.PositionsAxis
:parser: rst
```

````{py:method} format_title(...) -> str
:canonical: abtem.core.axes.PositionsAxis.format_title

````

````{py:attribute} label
:canonical: abtem.core.axes.PositionsAxis.label
:type: str
:value: >
   'x, y'

```{autodoc2-docstring} abtem.core.axes.PositionsAxis.label
:parser: rst
```

````

````{py:attribute} units
:canonical: abtem.core.axes.PositionsAxis.units
:type: str
:value: >
   'Å'

```{autodoc2-docstring} abtem.core.axes.PositionsAxis.units
:parser: rst
```

````

`````

````{py:class} PrismPlaneWavesAxis
:canonical: abtem.core.axes.PrismPlaneWavesAxis

Bases: {py:obj}`abtem.core.axes.AxisMetadata`

```{autodoc2-docstring} abtem.core.axes.PrismPlaneWavesAxis
:parser: rst
```

````

`````{py:class} RealSpaceAxis
:canonical: abtem.core.axes.RealSpaceAxis

Bases: {py:obj}`abtem.core.axes.LinearAxis`

```{autodoc2-docstring} abtem.core.axes.RealSpaceAxis
:parser: rst
```

````{py:attribute} endpoint
:canonical: abtem.core.axes.RealSpaceAxis.endpoint
:type: bool
:value: >
   True

```{autodoc2-docstring} abtem.core.axes.RealSpaceAxis.endpoint
:parser: rst
```

````

````{py:attribute} sampling
:canonical: abtem.core.axes.RealSpaceAxis.sampling
:type: float
:value: >
   1.0

```{autodoc2-docstring} abtem.core.axes.RealSpaceAxis.sampling
:parser: rst
```

````

````{py:attribute} units
:canonical: abtem.core.axes.RealSpaceAxis.units
:type: str
:value: >
   'pixels'

```{autodoc2-docstring} abtem.core.axes.RealSpaceAxis.units
:parser: rst
```

````

`````

`````{py:class} ReciprocalSpaceAxis
:canonical: abtem.core.axes.ReciprocalSpaceAxis

Bases: {py:obj}`abtem.core.axes.LinearAxis`

```{autodoc2-docstring} abtem.core.axes.ReciprocalSpaceAxis
:parser: rst
```

````{py:attribute} fftshift
:canonical: abtem.core.axes.ReciprocalSpaceAxis.fftshift
:type: bool
:value: >
   True

```{autodoc2-docstring} abtem.core.axes.ReciprocalSpaceAxis.fftshift
:parser: rst
```

````

````{py:attribute} sampling
:canonical: abtem.core.axes.ReciprocalSpaceAxis.sampling
:type: float
:value: >
   1.0

```{autodoc2-docstring} abtem.core.axes.ReciprocalSpaceAxis.sampling
:parser: rst
```

````

````{py:attribute} units
:canonical: abtem.core.axes.ReciprocalSpaceAxis.units
:type: str
:value: >
   'pixels'

```{autodoc2-docstring} abtem.core.axes.ReciprocalSpaceAxis.units
:parser: rst
```

````

`````

````{py:class} SampleAxis
:canonical: abtem.core.axes.SampleAxis

Bases: {py:obj}`abtem.core.axes.AxisMetadata`

```{autodoc2-docstring} abtem.core.axes.SampleAxis
:parser: rst
```

````

`````{py:class} ScaleAxis
:canonical: abtem.core.axes.ScaleAxis

```{autodoc2-docstring} abtem.core.axes.ScaleAxis
:parser: rst
```

````{py:method} format_label()
:canonical: abtem.core.axes.ScaleAxis.format_label

```{autodoc2-docstring} abtem.core.axes.ScaleAxis.format_label
:parser: rst
```

````

````{py:attribute} label
:canonical: abtem.core.axes.ScaleAxis.label
:type: str
:value: <Multiline-String>

```{autodoc2-docstring} abtem.core.axes.ScaleAxis.label
:parser: rst
```

````

````{py:attribute} tex_label
:canonical: abtem.core.axes.ScaleAxis.tex_label
:type: str | None
:value: >
   None

```{autodoc2-docstring} abtem.core.axes.ScaleAxis.tex_label
:parser: rst
```

````

````{py:attribute} units
:canonical: abtem.core.axes.ScaleAxis.units
:type: typing.Optional[str]
:value: >
   None

```{autodoc2-docstring} abtem.core.axes.ScaleAxis.units
:parser: rst
```

````

`````

````{py:class} ScanAxis
:canonical: abtem.core.axes.ScanAxis

Bases: {py:obj}`abtem.core.axes.RealSpaceAxis`

```{autodoc2-docstring} abtem.core.axes.ScanAxis
:parser: rst
```

````

`````{py:class} SpinAxis
:canonical: abtem.core.axes.SpinAxis

Bases: {py:obj}`abtem.core.axes.OrdinalAxis`

```{autodoc2-docstring} abtem.core.axes.SpinAxis
:parser: rst
```

````{py:attribute} label
:canonical: abtem.core.axes.SpinAxis.label
:type: str
:value: >
   'spin'

```{autodoc2-docstring} abtem.core.axes.SpinAxis.label
:parser: rst
```

````

````{py:attribute} values
:canonical: abtem.core.axes.SpinAxis.values
:type: tuple
:value: >
   ('up', 'down')

```{autodoc2-docstring} abtem.core.axes.SpinAxis.values
:parser: rst
```

````

`````

`````{py:class} ThicknessAxis
:canonical: abtem.core.axes.ThicknessAxis

Bases: {py:obj}`abtem.core.axes.NonLinearAxis`

```{autodoc2-docstring} abtem.core.axes.ThicknessAxis
:parser: rst
```

````{py:attribute} label
:canonical: abtem.core.axes.ThicknessAxis.label
:type: str
:value: >
   'thickness'

```{autodoc2-docstring} abtem.core.axes.ThicknessAxis.label
:parser: rst
```

````

````{py:attribute} units
:canonical: abtem.core.axes.ThicknessAxis.units
:type: str
:value: >
   'Å'

```{autodoc2-docstring} abtem.core.axes.ThicknessAxis.units
:parser: rst
```

````

`````

`````{py:class} TiltAxis
:canonical: abtem.core.axes.TiltAxis

Bases: {py:obj}`abtem.core.axes.OrdinalAxis`

```{autodoc2-docstring} abtem.core.axes.TiltAxis
:parser: rst
```

````{py:method} item_metadata(...)
:canonical: abtem.core.axes.TiltAxis.item_metadata

````

````{py:property} tilt
:canonical: abtem.core.axes.TiltAxis.tilt
:type: tuple

```{autodoc2-docstring} abtem.core.axes.TiltAxis.tilt
:parser: rst
```

````

````{py:attribute} units
:canonical: abtem.core.axes.TiltAxis.units
:type: str
:value: >
   'mrad'

```{autodoc2-docstring} abtem.core.axes.TiltAxis.units
:parser: rst
```

````

`````

`````{py:class} UnknownAxis
:canonical: abtem.core.axes.UnknownAxis

Bases: {py:obj}`abtem.core.axes.AxisMetadata`

```{autodoc2-docstring} abtem.core.axes.UnknownAxis
:parser: rst
```

````{py:attribute} label
:canonical: abtem.core.axes.UnknownAxis.label
:type: str
:value: >
   'unknown'

```{autodoc2-docstring} abtem.core.axes.UnknownAxis.label
:parser: rst
```

````

`````

`````{py:class} WaveVectorAxis
:canonical: abtem.core.axes.WaveVectorAxis

Bases: {py:obj}`abtem.core.axes.OrdinalAxis`

```{autodoc2-docstring} abtem.core.axes.WaveVectorAxis
:parser: rst
```

````{py:attribute} units
:canonical: abtem.core.axes.WaveVectorAxis.units
:type: str
:value: >
   '1/Å'

```{autodoc2-docstring} abtem.core.axes.WaveVectorAxis.units
:parser: rst
```

````

`````

````{py:function} axis_from_dict(...)
:canonical: abtem.core.axes.axis_from_dict

```{autodoc2-docstring} abtem.core.axes.axis_from_dict
:parser: rst
```
````

````{py:function} axis_to_dict(...)
:canonical: abtem.core.axes.axis_to_dict

```{autodoc2-docstring} abtem.core.axes.axis_to_dict
:parser: rst
```
````

````{py:data} categories
:canonical: abtem.core.axes.categories
:value: >
   None

```{autodoc2-docstring} abtem.core.axes.categories
:parser: rst
```

````

````{py:data} complex_labels
:canonical: abtem.core.axes.complex_labels
:value: >
   None

```{autodoc2-docstring} abtem.core.axes.complex_labels
:parser: rst
```

````

````{py:function} format_axes_metadata(...)
:canonical: abtem.core.axes.format_axes_metadata

```{autodoc2-docstring} abtem.core.axes.format_axes_metadata
:parser: rst
```
````

````{py:function} format_label(...) -> str
:canonical: abtem.core.axes.format_label

```{autodoc2-docstring} abtem.core.axes.format_label
:parser: rst
```
````

````{py:function} format_title(...) -> str
:canonical: abtem.core.axes.format_title

```{autodoc2-docstring} abtem.core.axes.format_title
:parser: rst
```
````

````{py:function} format_value(...) -> str
:canonical: abtem.core.axes.format_value

```{autodoc2-docstring} abtem.core.axes.format_value
:parser: rst
```
````

````{py:function} latex_float(...) -> str
:canonical: abtem.core.axes.latex_float

```{autodoc2-docstring} abtem.core.axes.latex_float
:parser: rst
```
````