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 CFnetCDF 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
Initialisation
 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: optional
Convert source, which can be any type of object, to a
DomainAxis
instance.All other parameters, apart from copy, are ignored and their values are instead inferred from source by assuming that it has the
DomainAxis
API. Any parameters that can not be retrieved from source in this way are assumed to have their default value.Note that if
x
is also aDomainAxis
instance thencfdm.core.DomainAxis(source=x)
is equivalent tox.copy()
. copy:
bool
, optional If True (the default) then deep copy the input parameters prior to initialisation. By default the parameters are not deep copied.
 size:
Inspection¶
Attributes
Return a description of the construct type. 
Size¶
Methods
Remove the size. 

Return the size. 

Whether the size has been set. 

Set the size. 
Miscellaneous¶
Methods
Return a deep copy. 
Special¶
Methods
Called by the 
Docstring substitutions¶
Methods
Return the special docstring substitutions. 

Returns the substitutions that apply to methods of the class. 

Returns the class {{package}} substitutions package depth. 

Returns method names excluded in the class substitutions. 