cf.CoordinateConversion

---

class cf.CoordinateConversion(parameters=None, domain_ancillaries=None, source=None, copy=True)

Bases: cfdm.coordinateconversion.CoordinateConversion

A coordinate conversion component of a coordinate reference construct of the CF data model.

A coordinate conversion formula converting coordinate values taken from the dimension or auxiliary coordinate constructs to a different coordinate system. A term of the conversion formula can be a scalar or vector parameter which does not depend on any domain axis constructs, may have units, or may be a descriptive string (such as the projection name “mercator”), or it can be a reference to a domain ancillary construct (such as one containing spatially varying orography data). A coordinate reference construct relates the coordinate values of the field to locations in a planetary reference frame.

New in version 3.0.0.

Initialization

Parameters:

parameters: dict, optional

Set parameters. The dictionary keys are term names, with corresponding parameter values. Ignored if the source parameter is set.

Parameter example:

parameters={'earth_radius': 6371007.}

Parameters may also be set after initialisation with the set_parameters and set_parameter methods.

domain_ancillaries: dict, optional

Set references to domain ancillary constructs. The dictionary keys are term names, with corresponding domain ancillary construct keys. Ignored if the source parameter is set.

Parameter example:

domain_ancillaries={'orog': 'domainancillary2'}

Domain ancillaries may also be set after initialisation with the set_domain_ancillaries and set_domain_ancillary methods.

source: optional

Initialize the parameters and domain ancillary terms from those of source.

copy: bool, optional

If False then do not deep copy input parameters prior to initialization. By default arguments are deep copied.

Parameter terms

Methods

del_parameter	Delete a parameter.
get_parameter	Get a parameter value.
has_parameter	Whether a parameter has been set.
set_parameter	Set a parameter-valued term.
parameters	Return all parameters.
clear_parameters	Remove all parameters.
set_parameters	Set parameters.

Domain ancillary terms

Methods

del_domain_ancillary	Delete a domain ancillary.
get_domain_ancillary	Return a domain ancillary term.
has_domain_ancillary	Whether a domain ancillary has been set.
set_domain_ancillary	Set an domain ancillary-valued term.
domain_ancillaries	Return all domain_ancillaries.
clear_domain_ancillaries	Remove all domain_ancillaries.
set_domain_ancillaries	Set domain_ancillaries.

Miscellaneous

Methods

copy	Return a deep copy.
equals	Whether two instances are the same.

Special

Methods

__bool__	Called by the bool built-in function.
__deepcopy__	Called by the copy.deepcopy function.
__nonzero__	Called by the bool built-in function.
__repr__	Called by the repr built-in function.
__str__	Called by the str built-in function.