# cf.DomainAxis

class `cf.``DomainAxis`(size=None, ncdim=None)

  Bases: `object`

  A CF domain axis construct.

  A domain axis construct specifies the number of points along an independent axis of the domain. It comprises a positive integer representing the size of the axis. In CF-netCDF it is usually defined either by a netCDF dimension or by a scalar coordinate variable, which implies a domain axis of size one. The field construct’s data array spans the domain axis constructs of the domain, with the optional exception of size one axes, because their presence makes no difference to the order of the elements.

  Attributes

  Attribute | Type | Description
  --- | --- | ---
  !size | int | The size of the domain axis.
  !ncdim | str | The name of this domain axis as a netCDF dimension.

  Initialization

  Parameters: | size: int, optional The size of the domain axis. ncdim: str, optional The name of this domain axis as a netCDF dimension.

  `__init__`(size=None, ncdim=None)

    Initialization

    Parameters: | size: int, optional The size of the domain axis. ncdim: str, optional The name of this domain axis as a netCDF dimension.

  Methods

  `__init__`([size, ncdim]) | Initialization
  `copy`() | Return a deep copy.
  `equals`(other[, rtol, atol, …]) | Return True if two domain axis objects are equal.
  `inspect`() | Inspect the object for debugging.

  `copy`()

    Return a deep copy.

    `d.copy()` is equivalent to `copy.deepcopy(d)`.

    Returns: | out: The deep copy.
    Examples: |

        >>> e = d.copy()

  `equals`(other, rtol=None, atol=None, ignore_fill_value=False, traceback=False, ignore=(), _set=False)

    Return True if two domain axis objects are equal.

    Parameters: | other : object The object to compare for equality. traceback : bool, optional If True then print a traceback highlighting where the two domain axes differ. atol : optional Ignored. rtol : optional Ignored. ignore : optional Ignored. ignore_fill_value : optional Ignored.
    Returns: | out : bool Whether or not the two domain axes are equal.

  `inspect`()

    Inspect the object for debugging.

    See also

    cf.inspect

    Returns: | None
    Examples: |

        >>> f.inspect()