open-space-toolkit-physics 11.3.0__py39-none-manylinux2014_aarch64.whl
Sign up to get free protection for your applications and to get access to all the features.
- open_space_toolkit_physics-11.3.0.dist-info/METADATA +29 -0
- open_space_toolkit_physics-11.3.0.dist-info/RECORD +104 -0
- open_space_toolkit_physics-11.3.0.dist-info/WHEEL +5 -0
- open_space_toolkit_physics-11.3.0.dist-info/top_level.txt +1 -0
- open_space_toolkit_physics-11.3.0.dist-info/zip-safe +1 -0
- ostk/__init__.py +1 -0
- ostk/physics/OpenSpaceToolkitPhysicsPy.cpython-39-aarch64-linux-gnu.so +0 -0
- ostk/physics/__init__.py +6 -0
- ostk/physics/__init__.pyi +488 -0
- ostk/physics/coordinate/__init__.pyi +1002 -0
- ostk/physics/coordinate/frame/__init__.pyi +30 -0
- ostk/physics/coordinate/frame/provider/__init__.pyi +77 -0
- ostk/physics/coordinate/frame/provider/iau.pyi +64 -0
- ostk/physics/coordinate/frame/provider/iers.pyi +584 -0
- ostk/physics/coordinate/spherical.pyi +421 -0
- ostk/physics/data/__init__.pyi +459 -0
- ostk/physics/data/provider.pyi +21 -0
- ostk/physics/environment/__init__.pyi +108 -0
- ostk/physics/environment/atmospheric/__init__.pyi +181 -0
- ostk/physics/environment/atmospheric/earth.pyi +552 -0
- ostk/physics/environment/gravitational/__init__.pyi +559 -0
- ostk/physics/environment/gravitational/earth.pyi +56 -0
- ostk/physics/environment/magnetic/__init__.pyi +171 -0
- ostk/physics/environment/magnetic/earth.pyi +56 -0
- ostk/physics/environment/object/__init__.pyi +430 -0
- ostk/physics/environment/object/celestial/__init__.pyi +248 -0
- ostk/physics/environment/object/celestial/moon.pyi +2 -0
- ostk/physics/environment/object/celestial/sun.pyi +2 -0
- ostk/physics/libopen-space-toolkit-physics.so.11 +0 -0
- ostk/physics/py.typed +0 -0
- ostk/physics/test/__init__.py +1 -0
- ostk/physics/test/coordinate/__init__.py +1 -0
- ostk/physics/test/coordinate/frame/__init__.py +1 -0
- ostk/physics/test/coordinate/frame/provider/__init__.py +1 -0
- ostk/physics/test/coordinate/frame/provider/iers/__init__.py +1 -0
- ostk/physics/test/coordinate/frame/provider/iers/conftest.py +38 -0
- ostk/physics/test/coordinate/frame/provider/iers/data/finals2000A.data +10953 -0
- ostk/physics/test/coordinate/frame/provider/iers/data/ser7.dat +524 -0
- ostk/physics/test/coordinate/frame/provider/iers/test_bulletin_a.py +108 -0
- ostk/physics/test/coordinate/frame/provider/iers/test_finals_2000a.py +93 -0
- ostk/physics/test/coordinate/frame/provider/iers/test_manager.py +205 -0
- ostk/physics/test/coordinate/spherical/__init__.py +1 -0
- ostk/physics/test/coordinate/spherical/test_aer.py +143 -0
- ostk/physics/test/coordinate/spherical/test_lla.py +514 -0
- ostk/physics/test/coordinate/test_axes.py +116 -0
- ostk/physics/test/coordinate/test_frame.py +107 -0
- ostk/physics/test/coordinate/test_position.py +201 -0
- ostk/physics/test/coordinate/test_transform.py +294 -0
- ostk/physics/test/coordinate/test_velocity.py +180 -0
- ostk/physics/test/data/conftest.py +34 -0
- ostk/physics/test/data/data/manifest.json +22 -0
- ostk/physics/test/data/provider/test_provider.py +34 -0
- ostk/physics/test/data/test_direction.py +40 -0
- ostk/physics/test/data/test_manifest.py +43 -0
- ostk/physics/test/data/test_manifest_manager.py +62 -0
- ostk/physics/test/data/test_scalar.py +54 -0
- ostk/physics/test/data/test_vector.py +70 -0
- ostk/physics/test/environment/__init__.py +1 -0
- ostk/physics/test/environment/atmospheric/__init__.py +1 -0
- ostk/physics/test/environment/atmospheric/earth/__init__.py +1 -0
- ostk/physics/test/environment/atmospheric/earth/conftest.py +67 -0
- ostk/physics/test/environment/atmospheric/earth/data/SW-Last5Years.test.csv +22 -0
- ostk/physics/test/environment/atmospheric/earth/data/SpaceWeather-All-v1.2.test.txt +811 -0
- ostk/physics/test/environment/atmospheric/earth/test_cssi_space_weather.py +126 -0
- ostk/physics/test/environment/atmospheric/earth/test_exponential.py +34 -0
- ostk/physics/test/environment/atmospheric/earth/test_manager.py +173 -0
- ostk/physics/test/environment/atmospheric/earth/test_nrlmsise00.py +34 -0
- ostk/physics/test/environment/atmospheric/test_earth.py +141 -0
- ostk/physics/test/environment/gravitational/__init__.py +1 -0
- ostk/physics/test/environment/gravitational/earth/__init__.py +1 -0
- ostk/physics/test/environment/gravitational/earth/test_manager.py +76 -0
- ostk/physics/test/environment/gravitational/test_earth.py +103 -0
- ostk/physics/test/environment/gravitational/test_moon.py +55 -0
- ostk/physics/test/environment/gravitational/test_spherical.py +36 -0
- ostk/physics/test/environment/gravitational/test_sun.py +53 -0
- ostk/physics/test/environment/magnetic/__init__.py +1 -0
- ostk/physics/test/environment/magnetic/earth/test_manager.py +64 -0
- ostk/physics/test/environment/magnetic/test_earth.py +38 -0
- ostk/physics/test/environment/object/__init__.py +1 -0
- ostk/physics/test/environment/object/celestial/__init__ .py +1 -0
- ostk/physics/test/environment/object/celestial/test_earth.py +174 -0
- ostk/physics/test/environment/object/celestial/test_moon.py +17 -0
- ostk/physics/test/environment/object/celestial/test_sun.py +17 -0
- ostk/physics/test/environment/object/test_celestial.py +12 -0
- ostk/physics/test/test_environment.py +97 -0
- ostk/physics/test/test_import.py +25 -0
- ostk/physics/test/time/__init__.py +1 -0
- ostk/physics/test/time/test_date.py +136 -0
- ostk/physics/test/time/test_date_time.py +230 -0
- ostk/physics/test/time/test_duration.py +215 -0
- ostk/physics/test/time/test_instant.py +103 -0
- ostk/physics/test/time/test_interval.py +432 -0
- ostk/physics/test/time/test_scale.py +11 -0
- ostk/physics/test/time/test_time.py +114 -0
- ostk/physics/test/unit/__init__.py +1 -0
- ostk/physics/test/unit/derived/__init__.py +1 -0
- ostk/physics/test/unit/derived/test_angle.py +368 -0
- ostk/physics/test/unit/test_derived.py +152 -0
- ostk/physics/test/unit/test_electric_current.py +5 -0
- ostk/physics/test/unit/test_length.py +297 -0
- ostk/physics/test/unit/test_mass.py +141 -0
- ostk/physics/test/unit/test_time.py +101 -0
- ostk/physics/time.pyi +1744 -0
- ostk/physics/unit.pyi +1590 -0
@@ -0,0 +1,1002 @@
|
|
1
|
+
from __future__ import annotations
|
2
|
+
import numpy
|
3
|
+
import ostk.core.type
|
4
|
+
import ostk.mathematics.geometry.d3.transformation.rotation
|
5
|
+
import ostk.physics.time
|
6
|
+
import ostk.physics.unit
|
7
|
+
import typing
|
8
|
+
from . import frame
|
9
|
+
from . import spherical
|
10
|
+
__all__ = ['Axes', 'Frame', 'Position', 'Transform', 'Velocity', 'frame', 'spherical']
|
11
|
+
class Axes:
|
12
|
+
"""
|
13
|
+
|
14
|
+
Axes.
|
15
|
+
|
16
|
+
|
17
|
+
"""
|
18
|
+
__hash__: typing.ClassVar[None] = None
|
19
|
+
@staticmethod
|
20
|
+
def _pybind11_conduit_v1_(*args, **kwargs):
|
21
|
+
...
|
22
|
+
@staticmethod
|
23
|
+
def undefined() -> Axes:
|
24
|
+
"""
|
25
|
+
Get undefined axes.
|
26
|
+
|
27
|
+
Returns:
|
28
|
+
Axes: Undefined axes.
|
29
|
+
"""
|
30
|
+
def __eq__(self, arg0: Axes) -> bool:
|
31
|
+
"""
|
32
|
+
Equality operator.
|
33
|
+
|
34
|
+
Args:
|
35
|
+
other (Axes): Other Axes.
|
36
|
+
|
37
|
+
Returns:
|
38
|
+
bool: True if equal.
|
39
|
+
"""
|
40
|
+
def __init__(self, x_axis: numpy.ndarray[numpy.float64[3, 1]], y_axis: numpy.ndarray[numpy.float64[3, 1]], z_axis: numpy.ndarray[numpy.float64[3, 1]], frame: Frame) -> None:
|
41
|
+
"""
|
42
|
+
Constructor.
|
43
|
+
|
44
|
+
Args:
|
45
|
+
x_axis (np.ndarray): X-axis.
|
46
|
+
y_axis (np.ndarray): Y-axis.
|
47
|
+
z_axis (np.ndarray): Z-axis.
|
48
|
+
frame (Frame): Frame of reference.
|
49
|
+
"""
|
50
|
+
def __ne__(self, arg0: Axes) -> bool:
|
51
|
+
"""
|
52
|
+
Inequality operator.
|
53
|
+
|
54
|
+
Args:
|
55
|
+
other (Axes): Other Axes.
|
56
|
+
|
57
|
+
Returns:
|
58
|
+
bool: True if not equal.
|
59
|
+
"""
|
60
|
+
def __repr__(self) -> str:
|
61
|
+
...
|
62
|
+
def __str__(self) -> str:
|
63
|
+
...
|
64
|
+
def get_frame(self) -> Frame:
|
65
|
+
"""
|
66
|
+
Get the frame of reference.
|
67
|
+
|
68
|
+
Returns:
|
69
|
+
Frame: Frame of reference.
|
70
|
+
"""
|
71
|
+
def in_frame(self, frame: Frame, instant: ostk.physics.time.Instant) -> Axes:
|
72
|
+
"""
|
73
|
+
Get the axes in another frame of reference.
|
74
|
+
|
75
|
+
Args:
|
76
|
+
frame (Frame): Frame of reference.
|
77
|
+
instant (Instant): Instant.
|
78
|
+
|
79
|
+
Returns:
|
80
|
+
Axes: Axes in the other frame of reference.
|
81
|
+
"""
|
82
|
+
def is_defined(self) -> bool:
|
83
|
+
"""
|
84
|
+
Check if defined.
|
85
|
+
|
86
|
+
Returns:
|
87
|
+
bool: True if defined.
|
88
|
+
"""
|
89
|
+
def x(self) -> numpy.ndarray[numpy.float64[3, 1]]:
|
90
|
+
"""
|
91
|
+
Get the X-axis.
|
92
|
+
|
93
|
+
Returns:
|
94
|
+
np.ndarray: X-axis.
|
95
|
+
"""
|
96
|
+
def y(self) -> numpy.ndarray[numpy.float64[3, 1]]:
|
97
|
+
"""
|
98
|
+
Get the Y-axis.
|
99
|
+
|
100
|
+
Returns:
|
101
|
+
np.ndarray: Y-axis.
|
102
|
+
"""
|
103
|
+
def z(self) -> numpy.ndarray[numpy.float64[3, 1]]:
|
104
|
+
"""
|
105
|
+
Get the Z-axis.
|
106
|
+
|
107
|
+
Returns:
|
108
|
+
np.ndarray: Z-axis.
|
109
|
+
"""
|
110
|
+
class Frame:
|
111
|
+
"""
|
112
|
+
|
113
|
+
Reference frame
|
114
|
+
|
115
|
+
:reference: https://en.wikipedia.org/wiki/Frame_of_reference
|
116
|
+
|
117
|
+
:note: Implementation heavily inspired by (the great!) https://www.orekit.org/static/architecture/frames.html
|
118
|
+
|
119
|
+
|
120
|
+
"""
|
121
|
+
__hash__: typing.ClassVar[None] = None
|
122
|
+
@staticmethod
|
123
|
+
def CIRF() -> Frame:
|
124
|
+
"""
|
125
|
+
Get the Celestial Intermediate Reference Frame (CIRF).
|
126
|
+
|
127
|
+
Returns:
|
128
|
+
Frame: CIRF.
|
129
|
+
"""
|
130
|
+
@staticmethod
|
131
|
+
def GCRF() -> Frame:
|
132
|
+
"""
|
133
|
+
Get the Geocentric Celestial Reference Frame (GCRF).
|
134
|
+
|
135
|
+
Returns:
|
136
|
+
Frame: GCRF.
|
137
|
+
"""
|
138
|
+
@staticmethod
|
139
|
+
def ITRF() -> Frame:
|
140
|
+
"""
|
141
|
+
Get the International Terrestrial Reference Frame (ITRF).
|
142
|
+
|
143
|
+
Returns:
|
144
|
+
Frame: ITRF.
|
145
|
+
"""
|
146
|
+
@staticmethod
|
147
|
+
def J2000(theory: ...) -> Frame:
|
148
|
+
"""
|
149
|
+
Get the J2000 frame.
|
150
|
+
|
151
|
+
Args:
|
152
|
+
theory (Theory): Theory.
|
153
|
+
|
154
|
+
Returns:
|
155
|
+
Frame: J2000.
|
156
|
+
"""
|
157
|
+
@staticmethod
|
158
|
+
def MOD(epoch: ostk.physics.time.Instant) -> Frame:
|
159
|
+
"""
|
160
|
+
Get the MOD frame.
|
161
|
+
|
162
|
+
Args:
|
163
|
+
epoch (Instant): Epoch.
|
164
|
+
|
165
|
+
Returns:
|
166
|
+
Frame: MOD.
|
167
|
+
"""
|
168
|
+
@staticmethod
|
169
|
+
def TEME() -> Frame:
|
170
|
+
"""
|
171
|
+
Get the True Equator Mean Equinox (TEME) frame.
|
172
|
+
|
173
|
+
Returns:
|
174
|
+
Frame: TEME.
|
175
|
+
"""
|
176
|
+
@staticmethod
|
177
|
+
def TEME_of_epoch(epoch: ostk.physics.time.Instant) -> Frame:
|
178
|
+
"""
|
179
|
+
Get the True Equator Mean Equinox (TEME) frame of epoch.
|
180
|
+
|
181
|
+
Args:
|
182
|
+
epoch (Instant): Epoch.
|
183
|
+
|
184
|
+
Returns:
|
185
|
+
Frame: TEME of epoch.
|
186
|
+
"""
|
187
|
+
@staticmethod
|
188
|
+
def TIRF() -> Frame:
|
189
|
+
"""
|
190
|
+
Get the Terrestrial Intermediate Reference Frame (TIRF).
|
191
|
+
|
192
|
+
Returns:
|
193
|
+
Frame: TIRF.
|
194
|
+
"""
|
195
|
+
@staticmethod
|
196
|
+
def TOD(epoch: ostk.physics.time.Instant, theory: ...) -> Frame:
|
197
|
+
"""
|
198
|
+
Get the TOD frame.
|
199
|
+
|
200
|
+
Args:
|
201
|
+
epoch (Instant): Epoch.
|
202
|
+
theory (Theory): Theory.
|
203
|
+
|
204
|
+
Returns:
|
205
|
+
Frame: TOD.
|
206
|
+
"""
|
207
|
+
@staticmethod
|
208
|
+
def _pybind11_conduit_v1_(*args, **kwargs):
|
209
|
+
...
|
210
|
+
@staticmethod
|
211
|
+
def construct(name: ostk.core.type.String, is_quasi_inertial: bool, parent_frame: Frame, provider: ...) -> Frame:
|
212
|
+
"""
|
213
|
+
Construct a frame.
|
214
|
+
|
215
|
+
Args:
|
216
|
+
name (String): Name.
|
217
|
+
is_quasi_inertial (bool): True if quasi-inertial.
|
218
|
+
parent_frame (Frame): Parent frame.
|
219
|
+
provider (Provider): Provider.
|
220
|
+
|
221
|
+
Returns:
|
222
|
+
Frame: Frame.
|
223
|
+
"""
|
224
|
+
@staticmethod
|
225
|
+
def destruct(name: ostk.core.type.String) -> None:
|
226
|
+
"""
|
227
|
+
Destruct a frame.
|
228
|
+
|
229
|
+
Args:
|
230
|
+
name (String): Name.
|
231
|
+
"""
|
232
|
+
@staticmethod
|
233
|
+
def exists(name: ostk.core.type.String) -> bool:
|
234
|
+
"""
|
235
|
+
Check if a frame exists.
|
236
|
+
|
237
|
+
Args:
|
238
|
+
name (String): Name.
|
239
|
+
|
240
|
+
Returns:
|
241
|
+
bool: True if exists.
|
242
|
+
"""
|
243
|
+
@staticmethod
|
244
|
+
def undefined() -> Frame:
|
245
|
+
"""
|
246
|
+
Get undefined frame.
|
247
|
+
|
248
|
+
Returns:
|
249
|
+
Frame: Undefined frame.
|
250
|
+
"""
|
251
|
+
@staticmethod
|
252
|
+
def with_name(name: ostk.core.type.String) -> Frame:
|
253
|
+
"""
|
254
|
+
Get the frame with a given name.
|
255
|
+
|
256
|
+
Args:
|
257
|
+
name (String): Name.
|
258
|
+
|
259
|
+
Returns:
|
260
|
+
Frame: Frame.
|
261
|
+
"""
|
262
|
+
def __eq__(self, arg0: Frame) -> bool:
|
263
|
+
"""
|
264
|
+
Equality operator.
|
265
|
+
|
266
|
+
Args:
|
267
|
+
other (Frame): Other frame.
|
268
|
+
|
269
|
+
Returns:
|
270
|
+
bool: True if equal.
|
271
|
+
"""
|
272
|
+
def __ne__(self, arg0: Frame) -> bool:
|
273
|
+
"""
|
274
|
+
Inequality operator.
|
275
|
+
|
276
|
+
Args:
|
277
|
+
other (Frame): Other frame.
|
278
|
+
|
279
|
+
Returns:
|
280
|
+
bool: True if not equal.
|
281
|
+
"""
|
282
|
+
def __repr__(self) -> str:
|
283
|
+
...
|
284
|
+
def __str__(self) -> str:
|
285
|
+
...
|
286
|
+
def access_ancestor(self, ancestor_degree: int) -> Frame:
|
287
|
+
"""
|
288
|
+
Access the ancestor frame.
|
289
|
+
|
290
|
+
Args:
|
291
|
+
ancestor_degree (int): Ancestor degree.
|
292
|
+
|
293
|
+
Returns:
|
294
|
+
Frame: Ancestor frame.
|
295
|
+
"""
|
296
|
+
def access_parent(self) -> Frame:
|
297
|
+
"""
|
298
|
+
Access the parent frame.
|
299
|
+
|
300
|
+
Returns:
|
301
|
+
Frame: Parent frame.
|
302
|
+
"""
|
303
|
+
def access_provider(self) -> ...:
|
304
|
+
"""
|
305
|
+
Access the provider.
|
306
|
+
|
307
|
+
Returns:
|
308
|
+
Provider: Provider.
|
309
|
+
"""
|
310
|
+
def get_axes_in(self, frame: Frame, instant: ostk.physics.time.Instant) -> ...:
|
311
|
+
"""
|
312
|
+
Get the axes in another frame.
|
313
|
+
|
314
|
+
Args:
|
315
|
+
frame (Frame): Frame.
|
316
|
+
instant (Instant): Instant.
|
317
|
+
|
318
|
+
Returns:
|
319
|
+
Axes: Axes.
|
320
|
+
"""
|
321
|
+
def get_name(self) -> ostk.core.type.String:
|
322
|
+
"""
|
323
|
+
Get the name.
|
324
|
+
|
325
|
+
Returns:
|
326
|
+
String: Name.
|
327
|
+
"""
|
328
|
+
def get_origin_in(self, frame: Frame, instant: ostk.physics.time.Instant) -> Position:
|
329
|
+
"""
|
330
|
+
Get the origin in another frame.
|
331
|
+
|
332
|
+
Args:
|
333
|
+
frame (Frame): Frame.
|
334
|
+
instant (Instant): Instant.
|
335
|
+
|
336
|
+
Returns:
|
337
|
+
Position: Origin.
|
338
|
+
"""
|
339
|
+
def get_transform_to(self, frame: Frame, instant: ostk.physics.time.Instant) -> ...:
|
340
|
+
"""
|
341
|
+
Get the transformation to another frame.
|
342
|
+
|
343
|
+
Args:
|
344
|
+
frame (Frame): Frame.
|
345
|
+
instant (Instant): Instant.
|
346
|
+
|
347
|
+
Returns:
|
348
|
+
Transform: Transformation.
|
349
|
+
"""
|
350
|
+
def get_velocity_in(self, frame: Frame, instant: ostk.physics.time.Instant) -> Velocity:
|
351
|
+
"""
|
352
|
+
Get the velocity in another frame.
|
353
|
+
|
354
|
+
Args:
|
355
|
+
frame (Frame): Frame.
|
356
|
+
instant (Instant): Instant.
|
357
|
+
|
358
|
+
Returns:
|
359
|
+
Velocity: Velocity.
|
360
|
+
"""
|
361
|
+
def has_parent(self) -> bool:
|
362
|
+
"""
|
363
|
+
Check if the frame has a parent.
|
364
|
+
|
365
|
+
Returns:
|
366
|
+
bool: True if the frame has a parent.
|
367
|
+
"""
|
368
|
+
def is_defined(self) -> bool:
|
369
|
+
"""
|
370
|
+
Check if the instance is defined.
|
371
|
+
|
372
|
+
Returns:
|
373
|
+
bool: True if the instance is defined.
|
374
|
+
"""
|
375
|
+
def is_quasi_inertial(self) -> bool:
|
376
|
+
"""
|
377
|
+
Check if the frame is quasi-inertial.
|
378
|
+
|
379
|
+
Returns:
|
380
|
+
bool: True if the frame is quasi-inertial.
|
381
|
+
"""
|
382
|
+
class Position:
|
383
|
+
"""
|
384
|
+
|
385
|
+
Position.
|
386
|
+
|
387
|
+
"""
|
388
|
+
__hash__: typing.ClassVar[None] = None
|
389
|
+
@staticmethod
|
390
|
+
def _pybind11_conduit_v1_(*args, **kwargs):
|
391
|
+
...
|
392
|
+
@staticmethod
|
393
|
+
def from_lla(lla: spherical.LLA, celestial: ... = None) -> Position:
|
394
|
+
"""
|
395
|
+
Create a Position from LLA.
|
396
|
+
|
397
|
+
Args:
|
398
|
+
lla (LLA): LLA.
|
399
|
+
celestial_object (Celestial): Celestial object. Defaults to None. If None, the central body from the global environment instance will be used if it's available.
|
400
|
+
|
401
|
+
Returns:
|
402
|
+
Position: Position.
|
403
|
+
"""
|
404
|
+
@staticmethod
|
405
|
+
def meters(coordinates: numpy.ndarray[numpy.float64[3, 1]], frame: ...) -> Position:
|
406
|
+
"""
|
407
|
+
Create a Position in meters.
|
408
|
+
|
409
|
+
Args:
|
410
|
+
coordinates (np.ndarray): Coordinates.
|
411
|
+
frame (Frame): Frame of reference.
|
412
|
+
|
413
|
+
Returns:
|
414
|
+
Position: Position in meters.
|
415
|
+
"""
|
416
|
+
@staticmethod
|
417
|
+
def undefined() -> Position:
|
418
|
+
"""
|
419
|
+
Get undefined Position.
|
420
|
+
|
421
|
+
Returns:
|
422
|
+
Position: Undefined Position.
|
423
|
+
"""
|
424
|
+
def __eq__(self, arg0: Position) -> bool:
|
425
|
+
"""
|
426
|
+
Equality operator.
|
427
|
+
|
428
|
+
Args:
|
429
|
+
other (Position): Other Position.
|
430
|
+
|
431
|
+
Returns:
|
432
|
+
bool: True if equal.
|
433
|
+
"""
|
434
|
+
def __init__(self, coordinates: numpy.ndarray[numpy.float64[3, 1]], unit: ostk.physics.unit.Length.Unit, frame: ...) -> None:
|
435
|
+
"""
|
436
|
+
Constructs a Position.
|
437
|
+
|
438
|
+
Args:
|
439
|
+
coordinates (np.ndarray): Coordinates.
|
440
|
+
unit (Unit): Unit.
|
441
|
+
frame (Frame): Frame of reference.
|
442
|
+
"""
|
443
|
+
def __ne__(self, arg0: Position) -> bool:
|
444
|
+
"""
|
445
|
+
Inequality operator.
|
446
|
+
|
447
|
+
Args:
|
448
|
+
other (Position): Other Position.
|
449
|
+
|
450
|
+
Returns:
|
451
|
+
bool: True if not equal.
|
452
|
+
"""
|
453
|
+
def __repr__(self) -> str:
|
454
|
+
...
|
455
|
+
def __str__(self) -> str:
|
456
|
+
...
|
457
|
+
def access_frame(self) -> ...:
|
458
|
+
"""
|
459
|
+
Access the frame of reference.
|
460
|
+
|
461
|
+
Returns:
|
462
|
+
Frame: Frame of reference.
|
463
|
+
"""
|
464
|
+
def get_coordinates(self) -> numpy.ndarray[numpy.float64[3, 1]]:
|
465
|
+
"""
|
466
|
+
Get the coordinates.
|
467
|
+
|
468
|
+
Returns:
|
469
|
+
np.ndarray: Coordinates.
|
470
|
+
"""
|
471
|
+
def get_unit(self) -> ostk.physics.unit.Length.Unit:
|
472
|
+
"""
|
473
|
+
Get the unit.
|
474
|
+
|
475
|
+
Returns:
|
476
|
+
Unit: Unit.
|
477
|
+
"""
|
478
|
+
def in_frame(self, frame: ..., instant: ostk.physics.time.Instant) -> Position:
|
479
|
+
"""
|
480
|
+
Get the Position in another frame of reference.
|
481
|
+
|
482
|
+
Args:
|
483
|
+
frame (Frame): Frame of reference.
|
484
|
+
instant (Instant): Instant.
|
485
|
+
|
486
|
+
Returns:
|
487
|
+
Position: Position in another frame of reference.
|
488
|
+
"""
|
489
|
+
def in_meters(self) -> Position:
|
490
|
+
"""
|
491
|
+
Get the Position in meters.
|
492
|
+
|
493
|
+
Returns:
|
494
|
+
Position: Position in meters.
|
495
|
+
"""
|
496
|
+
def in_unit(self, arg0: ostk.physics.unit.Length.Unit) -> Position:
|
497
|
+
"""
|
498
|
+
Get the Position in the unit.
|
499
|
+
|
500
|
+
Returns:
|
501
|
+
Position: Position in the unit.
|
502
|
+
"""
|
503
|
+
def is_defined(self) -> bool:
|
504
|
+
"""
|
505
|
+
Check if the Position is defined.
|
506
|
+
|
507
|
+
Returns:
|
508
|
+
bool: True if the Position is defined.
|
509
|
+
"""
|
510
|
+
def is_near(self, position: Position, tolerance: ostk.physics.unit.Length) -> bool:
|
511
|
+
"""
|
512
|
+
Check if the Position is near another Position.
|
513
|
+
|
514
|
+
Args:
|
515
|
+
position (Position): Position to compare with.
|
516
|
+
tolerance (Length): Tolerance.
|
517
|
+
|
518
|
+
Returns:
|
519
|
+
bool: True if the Position is near another Position.
|
520
|
+
"""
|
521
|
+
def to_string(self, precision: ostk.core.type.Integer = ...) -> ostk.core.type.String:
|
522
|
+
"""
|
523
|
+
Create a string representation.
|
524
|
+
|
525
|
+
Args:
|
526
|
+
precision (Integer): Precision.
|
527
|
+
|
528
|
+
Returns:
|
529
|
+
String: String representation.
|
530
|
+
"""
|
531
|
+
class Transform:
|
532
|
+
"""
|
533
|
+
|
534
|
+
Transform.
|
535
|
+
|
536
|
+
:reference: https://en.wikipedia.org/wiki/Active_and_passive_transformation
|
537
|
+
:reference: https://core.ac.uk/download/pdf/77055186.pdf
|
538
|
+
|
539
|
+
"""
|
540
|
+
class Type:
|
541
|
+
"""
|
542
|
+
|
543
|
+
Transform type.
|
544
|
+
|
545
|
+
|
546
|
+
Members:
|
547
|
+
|
548
|
+
Undefined :
|
549
|
+
Undefined type.
|
550
|
+
|
551
|
+
|
552
|
+
Active :
|
553
|
+
Active type.
|
554
|
+
|
555
|
+
|
556
|
+
Passive :
|
557
|
+
Passive type.
|
558
|
+
|
559
|
+
"""
|
560
|
+
Active: typing.ClassVar[Transform.Type] # value = <Type.Active: 1>
|
561
|
+
Passive: typing.ClassVar[Transform.Type] # value = <Type.Passive: 2>
|
562
|
+
Undefined: typing.ClassVar[Transform.Type] # value = <Type.Undefined: 0>
|
563
|
+
__members__: typing.ClassVar[dict[str, Transform.Type]] # value = {'Undefined': <Type.Undefined: 0>, 'Active': <Type.Active: 1>, 'Passive': <Type.Passive: 2>}
|
564
|
+
@staticmethod
|
565
|
+
def _pybind11_conduit_v1_(*args, **kwargs):
|
566
|
+
...
|
567
|
+
def __eq__(self, other: typing.Any) -> bool:
|
568
|
+
...
|
569
|
+
def __getstate__(self) -> int:
|
570
|
+
...
|
571
|
+
def __hash__(self) -> int:
|
572
|
+
...
|
573
|
+
def __index__(self) -> int:
|
574
|
+
...
|
575
|
+
def __init__(self, value: int) -> None:
|
576
|
+
...
|
577
|
+
def __int__(self) -> int:
|
578
|
+
...
|
579
|
+
def __ne__(self, other: typing.Any) -> bool:
|
580
|
+
...
|
581
|
+
def __repr__(self) -> str:
|
582
|
+
...
|
583
|
+
def __setstate__(self, state: int) -> None:
|
584
|
+
...
|
585
|
+
def __str__(self) -> str:
|
586
|
+
...
|
587
|
+
@property
|
588
|
+
def name(self) -> str:
|
589
|
+
...
|
590
|
+
@property
|
591
|
+
def value(self) -> int:
|
592
|
+
...
|
593
|
+
__hash__: typing.ClassVar[None] = None
|
594
|
+
@staticmethod
|
595
|
+
def _pybind11_conduit_v1_(*args, **kwargs):
|
596
|
+
...
|
597
|
+
@staticmethod
|
598
|
+
def active(instant: ostk.physics.time.Instant, translation: numpy.ndarray[numpy.float64[3, 1]], velocity: numpy.ndarray[numpy.float64[3, 1]], orientation: ostk.mathematics.geometry.d3.transformation.rotation.Quaternion, angular_velocity: numpy.ndarray[numpy.float64[3, 1]]) -> Transform:
|
599
|
+
"""
|
600
|
+
Create an active transform.
|
601
|
+
|
602
|
+
Args:
|
603
|
+
instant (Instant): Instant.
|
604
|
+
translation (np.ndarray): Translation.
|
605
|
+
velocity (np.ndarray): Velocity.
|
606
|
+
orientation (Quaternion): Orientation.
|
607
|
+
angular_velocity (np.ndarray): Angular velocity.
|
608
|
+
|
609
|
+
Returns:
|
610
|
+
Transform: Active transform.
|
611
|
+
"""
|
612
|
+
@staticmethod
|
613
|
+
def identity(arg0: ostk.physics.time.Instant) -> Transform:
|
614
|
+
"""
|
615
|
+
Get identity transform.
|
616
|
+
|
617
|
+
Returns:
|
618
|
+
Transform: Identity transform.
|
619
|
+
"""
|
620
|
+
@staticmethod
|
621
|
+
def passive(instant: ostk.physics.time.Instant, translation: numpy.ndarray[numpy.float64[3, 1]], velocity: numpy.ndarray[numpy.float64[3, 1]], orientation: ostk.mathematics.geometry.d3.transformation.rotation.Quaternion, angular_velocity: numpy.ndarray[numpy.float64[3, 1]]) -> Transform:
|
622
|
+
"""
|
623
|
+
Create a passive transform.
|
624
|
+
|
625
|
+
Args:
|
626
|
+
instant (Instant): Instant.
|
627
|
+
translation (np.ndarray): Translation.
|
628
|
+
velocity (np.ndarray): Velocity.
|
629
|
+
orientation (Quaternion): Orientation.
|
630
|
+
angular_velocity (np.ndarray): Angular velocity.
|
631
|
+
|
632
|
+
Returns:
|
633
|
+
Transform: Passive transform.
|
634
|
+
"""
|
635
|
+
@staticmethod
|
636
|
+
def undefined() -> Transform:
|
637
|
+
"""
|
638
|
+
Get undefined transform.
|
639
|
+
|
640
|
+
Returns:
|
641
|
+
Transform: Undefined transform.
|
642
|
+
"""
|
643
|
+
def __eq__(self, arg0: Transform) -> bool:
|
644
|
+
"""
|
645
|
+
Equality operator.
|
646
|
+
|
647
|
+
Args:
|
648
|
+
other (Transform): Other transform.
|
649
|
+
|
650
|
+
Returns:
|
651
|
+
bool: True if equal.
|
652
|
+
"""
|
653
|
+
def __imul__(self, arg0: Transform) -> Transform:
|
654
|
+
"""
|
655
|
+
Multiplication assignment operator.
|
656
|
+
|
657
|
+
Args:
|
658
|
+
other (Transform): Other transform.
|
659
|
+
|
660
|
+
Returns:
|
661
|
+
Transform: Composition.
|
662
|
+
"""
|
663
|
+
def __init__(self, instant: ostk.physics.time.Instant, translation: numpy.ndarray[numpy.float64[3, 1]], velocity: numpy.ndarray[numpy.float64[3, 1]], orientation: ostk.mathematics.geometry.d3.transformation.rotation.Quaternion, angular_velocity: numpy.ndarray[numpy.float64[3, 1]], type: ...) -> None:
|
664
|
+
"""
|
665
|
+
Constructs a transform.
|
666
|
+
|
667
|
+
Args:
|
668
|
+
instant (Instant): Instant.
|
669
|
+
translation (np.ndarray): Translation.
|
670
|
+
velocity (np.ndarray): Velocity.
|
671
|
+
orientation (Quaternion): Orientation.
|
672
|
+
angular_velocity (np.ndarray): Angular velocity.
|
673
|
+
type (Type): Type.
|
674
|
+
"""
|
675
|
+
def __mul__(self, arg0: Transform) -> Transform:
|
676
|
+
"""
|
677
|
+
Multiplication operator.
|
678
|
+
|
679
|
+
Args:
|
680
|
+
other (Transform): Other transform.
|
681
|
+
|
682
|
+
Returns:
|
683
|
+
Transform: Composition.
|
684
|
+
"""
|
685
|
+
def __ne__(self, arg0: Transform) -> bool:
|
686
|
+
"""
|
687
|
+
Inequality operator.
|
688
|
+
|
689
|
+
Args:
|
690
|
+
other (Transform): Other transform.
|
691
|
+
|
692
|
+
Returns:
|
693
|
+
bool: True if not equal.
|
694
|
+
"""
|
695
|
+
def __repr__(self) -> str:
|
696
|
+
...
|
697
|
+
def __str__(self) -> str:
|
698
|
+
...
|
699
|
+
def access_angular_velocity(self) -> numpy.ndarray[numpy.float64[3, 1]]:
|
700
|
+
"""
|
701
|
+
Access the angular velocity.
|
702
|
+
|
703
|
+
Returns:
|
704
|
+
np.ndarray: Angular velocity.
|
705
|
+
"""
|
706
|
+
def access_instant(self) -> ostk.physics.time.Instant:
|
707
|
+
"""
|
708
|
+
Access the instant.
|
709
|
+
|
710
|
+
Returns:
|
711
|
+
Instant: Instant.
|
712
|
+
"""
|
713
|
+
def access_orientation(self) -> ostk.mathematics.geometry.d3.transformation.rotation.Quaternion:
|
714
|
+
"""
|
715
|
+
Access the orientation.
|
716
|
+
|
717
|
+
Returns:
|
718
|
+
Quaternion: Orientation.
|
719
|
+
"""
|
720
|
+
def access_translation(self) -> numpy.ndarray[numpy.float64[3, 1]]:
|
721
|
+
"""
|
722
|
+
Access the translation.
|
723
|
+
|
724
|
+
Returns:
|
725
|
+
np.ndarray: Translation.
|
726
|
+
"""
|
727
|
+
def access_velocity(self) -> numpy.ndarray[numpy.float64[3, 1]]:
|
728
|
+
"""
|
729
|
+
Access the velocity.
|
730
|
+
|
731
|
+
Returns:
|
732
|
+
np.ndarray: Velocity.
|
733
|
+
"""
|
734
|
+
def apply_to_position(self, position: numpy.ndarray[numpy.float64[3, 1]]) -> numpy.ndarray[numpy.float64[3, 1]]:
|
735
|
+
"""
|
736
|
+
Apply the transform to a position.
|
737
|
+
|
738
|
+
Args:
|
739
|
+
position (Position): Position.
|
740
|
+
|
741
|
+
Returns:
|
742
|
+
np.ndarray: Transformed position.
|
743
|
+
"""
|
744
|
+
def apply_to_vector(self, vector: numpy.ndarray[numpy.float64[3, 1]]) -> numpy.ndarray[numpy.float64[3, 1]]:
|
745
|
+
"""
|
746
|
+
Apply the transform to a vector.
|
747
|
+
|
748
|
+
Args:
|
749
|
+
vector (np.ndarray): Vector.
|
750
|
+
|
751
|
+
Returns:
|
752
|
+
np.ndarray: Transformed vector.
|
753
|
+
"""
|
754
|
+
def apply_to_velocity(self, position: numpy.ndarray[numpy.float64[3, 1]], velocity: numpy.ndarray[numpy.float64[3, 1]]) -> numpy.ndarray[numpy.float64[3, 1]]:
|
755
|
+
"""
|
756
|
+
Apply the transform to a velocity.
|
757
|
+
|
758
|
+
Args:
|
759
|
+
position (Position): Position.
|
760
|
+
velocity (Velocity): Velocity.
|
761
|
+
|
762
|
+
Returns:
|
763
|
+
np.ndarray: Transformed velocity.
|
764
|
+
"""
|
765
|
+
def get_angular_velocity(self) -> numpy.ndarray[numpy.float64[3, 1]]:
|
766
|
+
"""
|
767
|
+
Get the angular velocity.
|
768
|
+
|
769
|
+
Returns:
|
770
|
+
np.ndarray: Angular velocity.
|
771
|
+
"""
|
772
|
+
def get_instant(self) -> ostk.physics.time.Instant:
|
773
|
+
"""
|
774
|
+
Get the instant.
|
775
|
+
|
776
|
+
Returns:
|
777
|
+
Instant: Instant.
|
778
|
+
"""
|
779
|
+
def get_inverse(self) -> Transform:
|
780
|
+
"""
|
781
|
+
Get the inverse.
|
782
|
+
|
783
|
+
Returns:
|
784
|
+
Transform: Inverse.
|
785
|
+
"""
|
786
|
+
def get_orientation(self) -> ostk.mathematics.geometry.d3.transformation.rotation.Quaternion:
|
787
|
+
"""
|
788
|
+
Get the orientation.
|
789
|
+
|
790
|
+
Returns:
|
791
|
+
Quaternion: Orientation.
|
792
|
+
"""
|
793
|
+
def get_translation(self) -> numpy.ndarray[numpy.float64[3, 1]]:
|
794
|
+
"""
|
795
|
+
Get the translation.
|
796
|
+
|
797
|
+
Returns:
|
798
|
+
np.ndarray: Translation.
|
799
|
+
"""
|
800
|
+
def get_velocity(self) -> numpy.ndarray[numpy.float64[3, 1]]:
|
801
|
+
"""
|
802
|
+
Get the velocity.
|
803
|
+
|
804
|
+
Returns:
|
805
|
+
np.ndarray: Velocity.
|
806
|
+
"""
|
807
|
+
def is_defined(self) -> bool:
|
808
|
+
"""
|
809
|
+
Check if the transform is defined.
|
810
|
+
|
811
|
+
Returns:
|
812
|
+
bool: True if the transform is defined.
|
813
|
+
"""
|
814
|
+
def is_identity(self) -> bool:
|
815
|
+
"""
|
816
|
+
Check if the transform is the identity.
|
817
|
+
|
818
|
+
Returns:
|
819
|
+
bool: True if the transform is the identity.
|
820
|
+
"""
|
821
|
+
class Velocity:
|
822
|
+
"""
|
823
|
+
|
824
|
+
Velocity.
|
825
|
+
|
826
|
+
"""
|
827
|
+
class Unit:
|
828
|
+
"""
|
829
|
+
|
830
|
+
Velocity unit.
|
831
|
+
|
832
|
+
|
833
|
+
Members:
|
834
|
+
|
835
|
+
Undefined :
|
836
|
+
Undefined.
|
837
|
+
|
838
|
+
|
839
|
+
MeterPerSecond :
|
840
|
+
Meter per second.
|
841
|
+
|
842
|
+
"""
|
843
|
+
MeterPerSecond: typing.ClassVar[Velocity.Unit] # value = <Unit.MeterPerSecond: 1>
|
844
|
+
Undefined: typing.ClassVar[Velocity.Unit] # value = <Unit.Undefined: 0>
|
845
|
+
__members__: typing.ClassVar[dict[str, Velocity.Unit]] # value = {'Undefined': <Unit.Undefined: 0>, 'MeterPerSecond': <Unit.MeterPerSecond: 1>}
|
846
|
+
@staticmethod
|
847
|
+
def _pybind11_conduit_v1_(*args, **kwargs):
|
848
|
+
...
|
849
|
+
def __eq__(self, other: typing.Any) -> bool:
|
850
|
+
...
|
851
|
+
def __getstate__(self) -> int:
|
852
|
+
...
|
853
|
+
def __hash__(self) -> int:
|
854
|
+
...
|
855
|
+
def __index__(self) -> int:
|
856
|
+
...
|
857
|
+
def __init__(self, value: int) -> None:
|
858
|
+
...
|
859
|
+
def __int__(self) -> int:
|
860
|
+
...
|
861
|
+
def __ne__(self, other: typing.Any) -> bool:
|
862
|
+
...
|
863
|
+
def __repr__(self) -> str:
|
864
|
+
...
|
865
|
+
def __setstate__(self, state: int) -> None:
|
866
|
+
...
|
867
|
+
def __str__(self) -> str:
|
868
|
+
...
|
869
|
+
@property
|
870
|
+
def name(self) -> str:
|
871
|
+
...
|
872
|
+
@property
|
873
|
+
def value(self) -> int:
|
874
|
+
...
|
875
|
+
__hash__: typing.ClassVar[None] = None
|
876
|
+
@staticmethod
|
877
|
+
def _pybind11_conduit_v1_(*args, **kwargs):
|
878
|
+
...
|
879
|
+
@staticmethod
|
880
|
+
def meters_per_second(coordinates: numpy.ndarray[numpy.float64[3, 1]], frame: ...) -> Velocity:
|
881
|
+
"""
|
882
|
+
Create a velocity in meters per second.
|
883
|
+
|
884
|
+
Args:
|
885
|
+
coordinates (np.ndarray): Coordinates.
|
886
|
+
frame (Frame): Frame of reference.
|
887
|
+
|
888
|
+
Returns:
|
889
|
+
Velocity: Velocity in meters per second.
|
890
|
+
"""
|
891
|
+
@staticmethod
|
892
|
+
def string_from_unit(unit: ...) -> ostk.core.type.String:
|
893
|
+
"""
|
894
|
+
Create a string from unit.
|
895
|
+
|
896
|
+
Args:
|
897
|
+
unit (Unit): Unit.
|
898
|
+
|
899
|
+
Returns:
|
900
|
+
String: String.
|
901
|
+
"""
|
902
|
+
@staticmethod
|
903
|
+
def undefined() -> Velocity:
|
904
|
+
"""
|
905
|
+
Get undefined velocity.
|
906
|
+
|
907
|
+
Returns:
|
908
|
+
Velocity: Undefined velocity.
|
909
|
+
"""
|
910
|
+
def __eq__(self, arg0: Velocity) -> bool:
|
911
|
+
"""
|
912
|
+
Equality operator.
|
913
|
+
|
914
|
+
Args:
|
915
|
+
other (Velocity): Other velocity.
|
916
|
+
|
917
|
+
Returns:
|
918
|
+
bool: True if equal.
|
919
|
+
"""
|
920
|
+
def __init__(self, coordinates: numpy.ndarray[numpy.float64[3, 1]], unit: ..., frame: ...) -> None:
|
921
|
+
"""
|
922
|
+
Constructs a velocity.
|
923
|
+
|
924
|
+
Args:
|
925
|
+
coordinates (np.ndarray): Coordinates.
|
926
|
+
unit (Unit): Unit.
|
927
|
+
frame (Frame): Frame of reference.
|
928
|
+
"""
|
929
|
+
def __ne__(self, arg0: Velocity) -> bool:
|
930
|
+
"""
|
931
|
+
Inequality operator.
|
932
|
+
|
933
|
+
Args:
|
934
|
+
other (Velocity): Other velocity.
|
935
|
+
|
936
|
+
Returns:
|
937
|
+
bool: True if not equal.
|
938
|
+
"""
|
939
|
+
def __repr__(self) -> str:
|
940
|
+
...
|
941
|
+
def __str__(self) -> str:
|
942
|
+
...
|
943
|
+
def access_frame(self) -> ...:
|
944
|
+
"""
|
945
|
+
Access the frame of reference.
|
946
|
+
|
947
|
+
Returns:
|
948
|
+
Frame: Frame of reference.
|
949
|
+
"""
|
950
|
+
def get_coordinates(self) -> numpy.ndarray[numpy.float64[3, 1]]:
|
951
|
+
"""
|
952
|
+
Get the coordinates.
|
953
|
+
|
954
|
+
Returns:
|
955
|
+
np.ndarray: Coordinates.
|
956
|
+
"""
|
957
|
+
def get_unit(self) -> ...:
|
958
|
+
"""
|
959
|
+
Get the unit.
|
960
|
+
|
961
|
+
Returns:
|
962
|
+
Unit: Unit.
|
963
|
+
"""
|
964
|
+
def in_frame(self, position: Position, frame: ..., instant: ostk.physics.time.Instant) -> Velocity:
|
965
|
+
"""
|
966
|
+
Convert to frame.
|
967
|
+
|
968
|
+
Args:
|
969
|
+
position (Position): Position.
|
970
|
+
frame (Frame): Frame.
|
971
|
+
instant (Instant): Instant.
|
972
|
+
|
973
|
+
Returns:
|
974
|
+
Velocity: Velocity.
|
975
|
+
"""
|
976
|
+
def in_unit(self, unit: ...) -> Velocity:
|
977
|
+
"""
|
978
|
+
Convert to unit.
|
979
|
+
|
980
|
+
Args:
|
981
|
+
unit (Unit): Unit.
|
982
|
+
|
983
|
+
Returns:
|
984
|
+
Velocity: Velocity.
|
985
|
+
"""
|
986
|
+
def is_defined(self) -> bool:
|
987
|
+
"""
|
988
|
+
Check if the instance is defined.
|
989
|
+
|
990
|
+
Returns:
|
991
|
+
bool: True if the instance is defined.
|
992
|
+
"""
|
993
|
+
def to_string(self, precision: ostk.core.type.Integer = ...) -> ostk.core.type.String:
|
994
|
+
"""
|
995
|
+
Convert to string.
|
996
|
+
|
997
|
+
Args:
|
998
|
+
precision (int): Precision.
|
999
|
+
|
1000
|
+
Returns:
|
1001
|
+
String: String.
|
1002
|
+
"""
|