cfdm.core.ParametersDomainAncillaries


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

Bases: cfdm.core.abstract.parameters.Parameters

Mixin to collect named parameters and domain ancillaries.

New in version (cfdm): 1.7.0

Initialisation

Parameters
parameters: dict, optional

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

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. Ignored if the source parameter is set.

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

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

Note that if source is a ParametersDomainAncillaries instance then cfdm.core.ParametersDomainAncillaries(source=source) is equivalent to source.copy().

copy: bool, optional

If True (the default) deep copy input parameters prior to initialisation. If False arguments 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

cfdm.core.ParametersDomainAncilliaries._docstring_special_substitutions

cfdm.core.ParametersDomainAncilliaries._docstring_substitutions

cfdm.core.ParametersDomainAncilliaries._docstring_package_depth

cfdm.core.ParametersDomainAncilliaries._docstring_method_exclusions