/
coordinate.py
206 lines (155 loc) · 5.05 KB
/
coordinate.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
from .propertiesdatabounds import PropertiesDataBounds
class Coordinate(PropertiesDataBounds):
"""Mixin for CF data model dimension and auxiliary coordinates.
.. versionadded:: (cfdm) 1.7.0
"""
def del_climatology(self, default=ValueError()):
"""Remove the climatology setting.
.. versionadded:: (cfdm) 1.8.9.0
.. seealso:: `get_climatology`, `is_climatology`,
`set_climatology`,
:Parameters:
default: optional
Return the value of the *default* parameter if the
climatology status has not been set.
{{default Exception}}
:Returns:
`str`
The removed climatology value.
**Examples:**
>>> c = {{package}}.{{class}}()
>>> c.set_climatology(True)
>>> c.is_climatology()
True
>>> c.get_climatology()
True
>>> c.del_climatology()
True
>>> c.is_climatology()
False
>>> print(c.get_climatology(None))
None
>>> print(c.del_climatology(None))
None
>>> c.set_climatology(False)
>>> c.is_climatology()
False
"""
out = self._del_component("climatology", None)
if out is not None:
return out
if default is None:
return
return self._default(
default,
f"{self.__class__.__name__!r} has no climatology set",
)
def get_climatology(self, default=ValueError()):
"""Return the climatology setting.
.. versionadded:: (cfdm) 1.8.9.0
.. seealso:: `del_climatology`, `is_climatology`,
`set_climatology`,
:Parameters:
default: optional
Return the value of the *default* parameter if the
climatology status has not been set.
{{default Exception}}
:Returns:
`str`
**Examples:**
>>> c = {{package}}.{{class}}()
>>> c.set_climatology(True)
>>> c.is_climatology()
True
>>> c.get_climatology()
True
>>> c.del_climatology()
True
>>> c.is_climatology()
False
>>> print(c.get_climatology(None))
None
>>> print(c.del_climatology(None))
None
>>> c.set_climatology(False)
>>> c.is_climatology()
False
"""
out = self._get_component("climatology", None)
if out is not None:
return out
if default is None:
return
return self._default(
default,
f"{self.__class__.__name__!r} has no climatology set",
)
def is_climatology(self):
"""True if the coordinates are climatological.
.. versionadded:: (cfdm) 1.8.9.0
.. seealso:: `del_climatology`, `get_climatology`,
`set_climatology`,
:Returns:
`bool`
Whether or not the coordinates are climatological.
**Examples:**
>>> c = {{package}}.{{class}}()
>>> c.set_climatology(True)
>>> c.is_climatology()
True
>>> c.get_climatology()
True
>>> c.del_climatology()
True
>>> c.is_climatology()
False
>>> print(c.get_climatology(None))
None
>>> print(c.del_climatology(None))
None
>>> c.set_climatology(False)
>>> c.is_climatology()
False
"""
return bool(self._get_component("climatology", None))
def set_climatology(self, climatology):
"""Set whether or not coordinates are climatological.
Only coordinate constructs with units of reference time (or unset
units) can be set as climatological.
.. versionadded:: (cfdm) 1.8.9.0
.. seealso:: `del_climatology`, `get_climatology`,
`is_climatology`, `set_climatology`,
:Parameters:
climatology: `bool`
Whether or not the coordinates are climatological.
:Returns:
`None`
**Examples:**
>>> c = {{package}}.{{class}}()
>>> c.set_climatology(True)
>>> c.is_climatology()
True
>>> c.get_climatology()
True
>>> c.del_climatology()
True
>>> c.is_climatology()
False
>>> print(c.get_climatology(None))
None
>>> print(c.del_climatology(None))
None
>>> c.set_climatology(False)
>>> c.is_climatology()
False
"""
climatology = bool(climatology)
if climatology:
units = self.get_property("units", None)
if units is not None and " since " not in units:
# Construct does not have reference time units
raise ValueError(
f"Can't set {self!r} set as climatological: "
f"Incorrect units: {units!r}"
)
self._set_component("climatology", climatology, copy=False)