forked from shredEngineer/MagnetiCalc
-
Notifications
You must be signed in to change notification settings - Fork 0
/
MagnetiCalc_Data.py
196 lines (147 loc) · 6.92 KB
/
MagnetiCalc_Data.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
""" MagnetiCalc_Data module. """
# ISC License
#
# Copyright (c) 2020–2022, Paul Wilhelm, M. Sc. <[email protected]>
#
# Permission to use, copy, modify, and/or distribute this software for any
# purpose with or without fee is hereby granted, provided that the above
# copyright notice and this permission notice appear in all copies.
#
# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
import numpy as np
from typing import Dict, Tuple, List
from collections.abc import MutableMapping
class MagnetiCalc_Data(MutableMapping):
""" MagnetiCalc_Data class. """
def __init__(self, data: Dict) -> None:
"""
Initializes MagnetiCalc_Data class.
This object can be accessed like a dictionary to get the data from an HDF5 export.
Moreover, it provides convenience functions for accessing reshaped or transformed copies of this data.
@param data: Dictionary
"""
self.dictionary: Dict = {}
self.update(data)
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
def get_wire(self) -> Tuple[np.ndarray, np.ndarray, np.ndarray]:
"""
Gets the wire points as three separate 1D arrays (raveled).
@return: x, y, z
"""
assert "wire_points" in self, "Sorry, there are no wire points in this data."
wire_points = self["wire_points"]
x, y, z = wire_points["x"], wire_points["y"], wire_points["z"]
return x, y, z
def get_wire_list(self) -> List:
"""
Gets the wire points as a single list of 3D points (raveled).
@return: List
"""
return list(zip(self.get_wire()))
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
def get_current(self) -> float:
"""
Gets the wire current.
"""
assert "wire_current" in self, "Sorry, there is no wire current in this data."
return self["wire_current"]
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
def get_dimension(self) -> Tuple[int, int, int]:
"""
Gets the sampling volume dimension.
@return: nx, ny, nz
"""
fields = self._get_fields()
return fields["nx"], fields["ny"], fields["nz"]
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
def get_axes(self, reduce: bool = False) -> Tuple[np.ndarray, np.ndarray, np.ndarray]:
"""
Gets the sampling volume axes as three separate 1D arrays (raveled).
@param reduce: Enable to reduce each raveled array to its minimal representation (axis ticks)
@return: x, y, z
"""
fields = self._get_fields()
x, y, z = fields["x"], fields["y"], fields["z"]
if reduce:
x, y, z = np.array(sorted(list(set(x)))), np.array(sorted(list(set(y)))), np.array(sorted(list(set(z))))
return x, y, z
def get_axes_list(self, **kwargs) -> List:
"""
Gets the sampling volume axes as a single list of 3D points (raveled).
@return: List
"""
return list(zip(self.get_axes(**kwargs)))
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
def get_field(self, field_type: str, as_3d: bool = False) -> Tuple[np.ndarray, np.ndarray, np.ndarray]:
"""
Gets the field as three separate 1D arrays (raveled).
@param field_type: Field type ("A" or "B")
@param as_3d: Enable to transform each raveled 1D array into an unraveled 3D mesh (indexed by the minimal axes)
"""
assert field_type in ["A", "B"], "Invalid field type"
fields = self._get_fields()
keys = [field_type + "_x", field_type + "_y", field_type + "_z"]
assert all([key in fields for key in keys]), f"Sorry, there is no {field_type}-field in this data."
field_x, field_y, field_z = [fields[key] for key in keys]
if as_3d:
shape_3d = self.get_dimension()
field_x = np.reshape(field_x, shape_3d, order="F")
field_y = np.reshape(field_y, shape_3d, order="F")
field_z = np.reshape(field_z, shape_3d, order="F")
return field_x, field_y, field_z
def get_a_field(self, **kwargs) -> Tuple[np.ndarray, np.ndarray, np.ndarray]:
"""
Gets the A-field components as three separate 1D arrays (raveled).
Please refer to L{get_field()} for possible arguments.
@return: A_x, A_y, A_z
"""
return self.get_field("A", **kwargs)
def get_a_field_list(self, **kwargs) -> List:
"""
Gets the A-field components as a single list of 3D points (raveled).
Please refer to L{get_field()} for possible arguments.
@return: List
"""
return list(zip(self.get_a_field(**kwargs)))
def get_b_field(self, **kwargs) -> Tuple[np.ndarray, np.ndarray, np.ndarray]:
"""
Gets the B-field components.
Please refer to L{get_field()} for possible arguments.
@return: B_x, B_y, B_z
"""
return self.get_field("B", **kwargs)
def get_b_field_list(self, **kwargs) -> List:
"""
Gets the B-field components as a single list of 3D points (raveled).
Please refer to L{get_field()} for possible arguments.
@return: List
"""
return list(zip(self.get_b_field(**kwargs)))
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
def _get_fields(self) -> Dict:
"""
Gets the raw "fields" dictionary from the data.
@return: Dictionary
"""
assert "fields" in self, "Sorry, there are no fields in this data."
return self["fields"]
# ------------------------------------------------------------------------------------------------------------------
def __getitem__(self, key):
return self.dictionary[self._keytransform(key)]
def __setitem__(self, key, value):
self.dictionary[self._keytransform(key)] = value
def __delitem__(self, key):
del self.dictionary[self._keytransform(key)]
def __iter__(self):
return iter(self.dictionary)
def __len__(self):
return len(self.dictionary)
# noinspection PyMethodMayBeStatic
def _keytransform(self, key):
return key