# cfdm.core.CoordinateConversion¶

class cfdm.core.CoordinateConversion(parameters=None, domain_ancillaries=None, source=None, copy=True)[source]

Bases: cfdm.core.abstract.parametersdomainancillaries.ParametersDomainAncillaries

A coordinate conversion for a coordinate reference.

That is, 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 (cfdm): 1.7.0

Initialisation

Parameters
parameters: dict, optional

Set parameters. The dictionary keys are term names, with corresponding parameter values.

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

Parameter example:

parameters={'earth_radius': 6371007.}

domain_ancillaries: dict, optional

Set references to domain ancillary constructs. The dictionary keys are term names, with corresponding domain ancillary construct keys.

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

Parameter example:

domain_ancillaries={'orog': 'domainancillary2'}

source: optional

Convert source, which can be any type of object, to a CoordinateConversion instance.

All other parameters, apart from copy, are ignored and their values are instead inferred from source by assuming that it has the CoordinateConversion 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 a CoordinateConversion instance then cfdm.core.CoordinateConversion(source=x) is equivalent to x.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.

## 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.

## Special¶

Methods

 __deepcopy__ Called by the copy.deepcopy function.

## Docstring substitutions¶

Methods

 _docstring_special_substitutions Return the special docstring substitutions. _docstring_substitutions Returns the substitutions that apply to methods of the class. _docstring_package_depth Returns the class {{package}} substitutions package depth. _docstring_method_exclusions Returns method names excluded in the class substitutions.