cfdm.core.DomainAxis¶
-
class
cfdm.core.
DomainAxis
(size=None, source=None, copy=True)[source]¶ Bases:
cfdm.core.abstract.container.Container
A domain axis construct of the CF data model.
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.
New in version (cfdm): 1.7.0
Initialization
- Parameters
- size:
int
, optional The size of the domain axis.
- Parameter example:
size=192
The size may also be set after initialisation with the
set_size
method.- source:
Initialize the size from that of source.
Note that if source is a
DomainAxis
instance thencfdm.core.DomainAxis(source=source)
is equivalent tosource.copy()
.- copy:
bool
, optional If False then do not deep copy input parameters prior to initialization. By default arguments are deep copied.
- size:
Size¶
Methods
Remove the size. |
|
Return the size. |
|
Whether the size has been set. |
|
Set the size. |
Attributes
Return a description of the construct type. |
Docstring substitutions¶
Methods
Return the special docstring substitutions. |
|
Return the docstring substitutions that apply to methods of the given class. |
|
Return the package depth, N, for {{package}} docstring substitutions for the given class. |
|
Return the names of methods to exclude from docstring substitutions for the given class. |