cf.DomainAxis¶

class
cf.
DomainAxis
(size=None, source=None, copy=True)[source]¶ Bases:
cfdm.domainaxis.DomainAxis
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.
NetCDF interface
The netCDF dimension name of the construct may be accessed with the
nc_set_dimension
,nc_get_dimension
,nc_del_dimension
andnc_has_dimension
methods.Initialisation
 Parameters
 size:
int
, optional The size of the domain axis.
The size may also be set after initialisation with the
set_size
method. Parameter example:
size=192
 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 thencf.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¶
Methods
Return the canonical identity. 

Return all possible identities. 
Attributes
Return a description of the construct type. 
Size¶
Methods
Remove the size. 

Whether the size has been set. 

Return the size. 

Set the size. 
Attributes
The domain axis size. 
Miscellaneous¶
Methods
Return a deep copy. 

Returns the commands to create the domain axis construct. 

Whether two domain axis constructs are the same. 

Inspect the object for debugging. 
NetCDF¶
Methods
Remove the netCDF dimension name. 

Return the netCDF dimension name. 

Whether the netCDF dimension name has been set. 

Set the netCDF dimension name. 

Inspect the unlimited status of the a netCDF dimension. 

Set the unlimited status of the a netCDF dimension. 
Arithmetic and comparison operations¶
Arithmetic, bitwise and comparison operations are defined on a field construct as elementwise operations on its data which yield a new field construct or, for augmented assignments, modify the field construct’s data inplace.
Comparison operators
The rich comparison operator 

The rich comparison operator 

The rich comparison operator 

The rich comparison operator 

The rich comparison operator 

The rich comparison operator 
Binary arithmetic operators
The binary arithmetic operation 

The binary arithmetic operation 
Binary arithmetic operators with reflected (swapped) operands
The binary arithmetic operation 
Augmented arithmetic assignments
The augmented arithmetic assignment 

The augmented arithmetic assignment 
Unary arithmetic operators
Implements the builtin function 
Groups¶
Methods
Return the netCDF dimension group hierarchy. 

Remove the netCDF dimension group hierarchy. 

Set the netCDF dimension group hierarchy. 
Special¶
Methods
Called by the 

Returns the hash value of the domain axis. 

Called by the 

Called by the 