-
Notifications
You must be signed in to change notification settings - Fork 16
/
base.py
383 lines (276 loc) · 11 KB
/
base.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
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
from mosaic import h5
from .domain import Space, Time, SlowTime, Grid
__all__ = ['Gridded', 'Saved', 'GriddedSaved', 'ProblemBase']
class Gridded:
"""
Objects of this type are defined over a spatio-temporal grid.
This grid can be provided either as a Grid object or as any of Space, Time or SlowTime
objects that define a grid.
Parameters
----------
grid : Grid, optional
Existing grid, if not provided one will be created.
space : Space, optional
time : Time, optional
slow_time : SlowTime, optional
"""
def __init__(self, **kwargs):
grid = kwargs.pop('grid', None)
space = kwargs.pop('space', None)
time = kwargs.pop('time', None)
slow_time = kwargs.pop('slow_time', None)
if grid is None:
grid = Grid(space, time, slow_time)
else:
grid = Grid(grid.space, grid.time, grid.slow_time)
self._grid = grid
@property
def grid(self):
"""
Access the grid.
"""
return self._grid
@property
def space(self):
"""
Access the space grid.
"""
return self._grid.space
@property
def time(self):
"""
Access the time grid.
"""
return self._grid.time
@property
def slow_time(self):
"""
Access the slow time grid.
"""
return self._grid.slow_time
def resample(self, grid=None, space=None, time=None, slow_time=None):
raise NotImplementedError('Resampling has not been implemented yet.')
class Saved:
"""
Saved objects include helper functions to interact with the file system.
Classes that inherit from Saved need to define ``__get_desc__`` and ``__set_desc__``
to define how the object is described to be saved and how a loaded description is
digested by the class respectively.
``__get_desc__`` expects a dict-like object with all the attributes that need to
be stored to disk and is called when dumping the object.
``__set_desc__`` will take a dict-like object as a parameter, which it can then be
used to set the state of the object, and is called when loading it.
Parameters
----------
name : str
Name of the saved object.
"""
def __init__(self, **kwargs):
self.name = kwargs.pop('name', self.__class__.__name__.lower())
def dump(self, *args, **kwargs):
"""
Dump the object according to the ``__get_desc__`` description.
See :class:`~mosaic.file_manipulation.h5.HDF5` for more information on the parameters of this method.
Returns
-------
"""
description = self.__get_desc__(**kwargs)
kwargs['parameter'] = kwargs.get('parameter', self.name)
with h5.HDF5(*args, **kwargs, mode='w') as file:
file.dump(description)
def append(self, *args, **kwargs):
"""
Append the object to a file according to the ``__get_desc__`` description.
See :class:`~mosaic.file_manipulation.h5.HDF5` for more information on the parameters of this method.
Returns
-------
"""
kwargs['parameter'] = kwargs.get('parameter', self.name)
if not h5.file_exists(*args, **kwargs):
self.dump(*args, **kwargs)
return
description = self.__get_desc__(**kwargs)
with h5.HDF5(*args, **kwargs, mode='a') as file:
file.append(description)
def load(self, *args, **kwargs):
"""
Load the object using ``__set_desc__`` to digest the description.
See :class:`~mosaic.file_manipulation.h5.HDF5` for more information on the parameters of this method.
Returns
-------
"""
kwargs['parameter'] = self.name
with h5.HDF5(*args, **kwargs, mode='r') as file:
description = file.load(filter=kwargs.pop('filter', None), only=kwargs.pop('only', None))
self.__set_desc__(description)
def rm(self, *args, **kwargs):
"""
Remove file.
See :class:`~mosaic.file_manipulation.h5.rm` for more information on the parameters of this method.
Returns
-------
"""
kwargs['parameter'] = self.name
h5.rm(*args, **kwargs, mode='r')
def __get_desc__(self, **kwargs):
return {}
def __set_desc__(self, description):
pass
class GriddedSaved(Saved, Gridded):
"""
Objects of this type are include utils to dump and load the instance, taking into
account that it is defined over a grid.
"""
def __init__(self, **kwargs):
Saved.__init__(self, **kwargs)
Gridded.__init__(self, **kwargs)
def dump(self, *args, **kwargs):
"""
Dump the object according to the ``__get_desc__`` description.
It will ensure that the grid of the instance is also dumped to disk.
See :class:`~mosaic.file_manipulation.h5.HDF5` for more information on the parameters of this method.
Returns
-------
"""
grid_description = self.grid_description()
description = self.__get_desc__(**kwargs)
grid_description.update(description)
kwargs['parameter'] = kwargs.get('parameter', self.name)
with h5.HDF5(*args, **kwargs, mode='w') as file:
file.dump(grid_description)
def append(self, *args, **kwargs):
"""
Append the object to a file according to the ``__get_desc__`` description.
It will ensure that the grid of the instance is also dumped to disk.
See :class:`~mosaic.file_manipulation.h5.HDF5` for more information on the parameters of this method.
Returns
-------
"""
kwargs['parameter'] = kwargs.get('parameter', self.name)
if not h5.file_exists(*args, **kwargs):
self.dump(*args, **kwargs)
return
grid_description = self.grid_description()
description = self.__get_desc__(**kwargs)
grid_description.update(description)
with h5.HDF5(*args, **kwargs, mode='a') as file:
file.append(grid_description)
def load(self, *args, **kwargs):
"""
Load the object using ``__set_desc__`` to digest the description.
It will use the grid loaded from file to determine the grid of the instance.
See :class:`~mosaic.file_manipulation.h5.HDF5` for more information on the parameters of this method.
Returns
-------
"""
kwargs['parameter'] = self.name
with h5.HDF5(*args, **kwargs, mode='r') as file:
description = file.load(filter=kwargs.pop('filter', None), only=kwargs.pop('only', None))
# TODO If there's already a grid and they don't match, resample instead
if 'space' in description and self._grid.space is None:
space = Space(shape=description.space.shape,
spacing=description.space.spacing,
extra=description.space.extra,
absorbing=description.space.absorbing)
self._grid.space = space
if 'time' in description and self._grid.time is None:
time = Time(start=description.time.start,
stop=description.time.stop,
step=description.time.step,
num=description.time.num)
self._grid.time = time
if 'slow_time' in description and self._grid.slow_time is None:
slow_time = SlowTime(frame_step=description.slow_time.frame_step,
frame_rate=description.slow_time.frame_rate,
num_frame=description.slow_time.num_frame,
acq_step=description.slow_time.acq_step,
acq_rate=description.slow_time.acq_rate,
num_acq=description.slow_time.num_acq)
self._grid.slow_time = slow_time
self.__set_desc__(description)
def grid_description(self):
"""
Get a description of the grid of the object.
Returns
-------
dict
Description of the grid.
"""
grid_description = dict()
if self.space is not None:
space = self.space
grid_description['space'] = {
'shape': space.shape,
'spacing': space.spacing,
'extra': space.extra,
'absorbing': space.absorbing,
}
if self.time is not None:
time = self.time
grid_description['time'] = {
'start': time.start,
'stop': time.stop,
'step': time.step,
'num': time.num,
}
if self.slow_time is not None:
slow_time = self.slow_time
grid_description['slow_time'] = {
'start': slow_time.start,
'stop': slow_time.stop,
'frame_step': slow_time.frame_step,
'frame_rate': slow_time.frame_rate,
'num_frame': slow_time.num_frame,
'acq_step': slow_time.acq_step,
'acq_rate': slow_time.acq_rate,
'num_acq': slow_time.num_acq,
}
return grid_description
def resample(self, grid=None, space=None, time=None, slow_time=None):
super().resample(grid=grid, space=space, time=time, slow_time=slow_time)
class ProblemBase(GriddedSaved):
"""
Base class for the different components of the problem that need to have access to it and
that also create sub-problems.
Parameters
----------
name : str
Name of the object.
problem : Problem
Problem to which the object belongs.
grid : Grid or any of Space or Time
Grid on which the object is defined
"""
def __init__(self, **kwargs):
problem = kwargs.pop('problem', None)
if problem is not None:
kwargs['space'] = kwargs.get('space', problem.space)
kwargs['time'] = kwargs.get('time', problem.time)
kwargs['slow_time'] = kwargs.get('slow_time', problem.slow_time)
super().__init__(**kwargs)
self._problem = problem
@property
def problem(self):
"""
Access problem object.
"""
return self._problem
def sub_problem(self, shot, sub_problem):
"""
Create a subset object for a certain shot.
A SubProblem contains everything that is needed to fully determine how to run a particular shot.
This method takes care of selecting the portions of the object that are needed
for a given shot.
By default, this has no effect.
Parameters
----------
shot : Shot
Shot for which the SubProblem is being generated.
sub_problem : SubProblem
Container for the sub-problem being generated.
Returns
-------
ProblemBase
ProblemBase instance.
"""
return self