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
andset_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
andset_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 thencfdm.core.ParametersDomainAncillaries(source=source)
is equivalent tosource.copy()
.- copy:
bool
, optional If False then do not deep copy input parameters prior to initialisation. By default arguments are deep copied.
- parameters:
Parameter terms¶
Methods
Delete a parameter. |
|
Get a parameter value. |
|
Whether a parameter has been set. |
|
Set a parameter-valued term. |
|
Return all parameters. |
|
Remove all parameters. |
|
Set parameters. |
Domain ancillary terms¶
Methods
Delete a domain ancillary. |
|
Return a domain ancillary term. |
|
Whether a domain ancillary has been set. |
|
Set an domain ancillary-valued term. |
|
Return all domain_ancillaries. |
|
Remove all domain_ancillaries. |
|
Set domain_ancillaries. |
Miscellaneous¶
Methods
Return a deep copy. |
Special¶
Methods
Called by the |
Docstring substitutions¶
Methods
|
|
|
|
|
|
|