cfdm.core.abstract.ParametersDomainAncillaries


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

Bases: cfdm.core.abstract.parameters.Parameters

Abstract base class for a collection of named parameters and named domain ancillary constructs.

New in version 1.7.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.

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

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.

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.

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.