cfdm.core.PropertiesData¶
-
class
cfdm.core.
PropertiesData
(properties=None, data=None, source=None, copy=True, _use_data=True)[source]¶ Bases:
cfdm.core.abstract.properties.Properties
Mixin class for a data array with descriptive properties.
New in version (cfdm): 1.7.0
Initialisation
- Parameters
- properties:
dict
, optional Set descriptive properties. The dictionary keys are property names, with corresponding values. Ignored if the source parameter is set.
Properties may also be set after initialisation with the
set_properties
andset_property
methods.- Parameter example:
properties={'standard_name': 'altitude'}
- data: data_like, optional
Set the data. Ignored if the source parameter is set.
A data_like object is any object that can be converted to a
Data
object, i.e.numpy
array_like objects,Data
objects, and cfdm.core instances that containData
objects.The data also may be set after initialisation with the
set_data
method.- source: optional
Initialise the properties and data from those of source.
Note that if source is a
PropertiesData
instance thencfdm.core.PropertiesData(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.
- properties:
Properties¶
Methods
Remove a property. |
|
Return a property. |
|
Whether a property has been set. |
|
Set a property. |
|
Return all properties. |
|
Remove all properties. |
|
Set properties. |
Data¶
Methods
Remove the data. |
|
Return the data. |
|
Whether or not the construct has data. |
|
Set the data. |
Attributes
Return the data. |
Miscellaneous¶
Methods
Return a deep copy. |
|
Whether or not there are cell bounds. |
Special¶
Methods
Called by the |
Docstring substitutions¶
Methods
Return the special docstring substitutions. |
|
Returns the substitutions that apply to methods of the class. |
|
Returns the class {{package}} substitutions package depth. |
|
Returns method names excluded in the class substitutions. |