-
Notifications
You must be signed in to change notification settings - Fork 9
/
json.json
2379 lines (2379 loc) · 159 KB
/
json.json
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
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"type": "package",
"path": "docstrings",
"file": "__package__.yaml",
"_implicit_name": "docstrings",
"config": {
"name": "tudatpy",
"version": null
},
"summary": null,
"extended_summary": null,
"routine_listings": null,
"see_also": null,
"notes": null,
"references": null,
"examples": null,
"classes": null,
"functions": null,
"constants": null,
"modules": [
"interface",
"numerical-simulation",
"plotting",
"cli",
"util"
],
"name": "tudatpy",
"version": null,
"interface": {
"type": "package",
"path": "docstrings/interface",
"file": "__package__.yaml",
"_implicit_name": "interface",
"config": null,
"summary": null,
"extended_summary": null,
"routine_listings": null,
"see_also": null,
"notes": null,
"references": null,
"examples": null,
"classes": null,
"functions": null,
"constants": null,
"modules": [
"spice"
],
"name": "interface",
"version": null,
"spice": {
"type": "module",
"path": "docstrings/interface",
"file": "spice.yaml",
"_implicit_name": "spice",
"config": null,
"summary": null,
"extended_summary": null,
"routine_listings": null,
"see_also": null,
"notes": "None",
"references": null,
"examples": null,
"classes": [
{
"name": "SpiceEphemeris",
"short_summary": "Ephemeris derived class which retrieves the state of a body directly from the SPICE library.",
"deprecation_warning": null,
"extended_summary": "Ephemeris derived class which retrieves the state of a body directly from the SPICE library.\nThe body of which the ephemeris is to be retrieved, as well as the origin and orientation\nof the reference frame in which the states are returned, and any corrections that are\napplied, are defined once during object construction.\n",
"parameters": null,
"attributes": null,
"yields": null,
"other_parameters": null,
"raises": null,
"warns": null,
"warnings": null,
"see_also": null,
"notes": null,
"references": null,
"examples": null,
"methods": [
{
"name": "__init__",
"short_summary": "Constructor.",
"deprecation_warning": null,
"extended_summary": "Constructor, sets the input variables for the calls to the spice function to retrieve state.",
"parameters": [
{
"name": "target_body_name",
"type": null,
"description": "Name of body of which the ephemeris is to be calculated."
},
{
"name": "observer_body_name",
"type": null,
"description": "Name of body relative to which the ephemeris is to be calculated."
},
{
"name": "correct_for_stellar_aberration",
"type": null,
"description": "Boolean whether to correct for stellar Aberration in retrieved values of (observed state).\n"
},
{
"name": "correct_for_light_time_aberration",
"type": null,
"description": "Boolean whether to correct for light time in retrieved values of (observed state).\n"
},
{
"name": "converge_ligh_time_aberration",
"type": null,
"description": "Boolean whether to use single iteration or max. 3 iterations for calculating light time.\n"
},
{
"name": "reference_frame_name",
"type": null,
"description": "Name of the reference frame in which the epehemeris is to be calculated.\n"
},
{
"name": "reference_julian_day",
"type": null,
"description": "Reference julian day w.r.t. which ephemeris is evaluated.\n"
}
],
"returns": null,
"yields": null,
"other_parameters": null,
"raises": null,
"warns": null,
"warnings": null,
"see_also": null,
"notes": null,
"references": null,
"examples": null
},
{
"name": "get_cartesian_state",
"short_summary": "Get Cartesian state from ephemeris.",
"deprecation_warning": null,
"extended_summary": " Returns Cartesian state from ephemeris at given Julian day.",
"parameters": [
{
"name": "seconds_since_epoch",
"type": "float",
"description": "Seconds since epoch at which ephemeris is to be evaluated."
}
],
"returns": null,
"yields": null,
"other_parameters": null,
"raises": null,
"warns": null,
"warnings": null,
"see_also": null,
"notes": null,
"references": null,
"examples": null
}
]
}
],
"functions": [
{
"name": "convert_julian_date_to_ephemeris_time",
"short_summary": "Convert a Julian date to ephemeris time (equivalent to TDB in Spice).",
"deprecation_warning": null,
"extended_summary": "The following math is for documentation demonstration purposes\n\n.. math:: X(e^{j\\omega } ) = x(n)e^{ - j\\omega n}\n\n\\f$ f(x) = a + b \\f$\n\nFunction to convert a Julian date to ephemeris time, which is\nequivalent to barycentric dynamical time. A leap second kernel\nmust have been loaded to use this function.\n",
"parameters": [
{
"name": "julian_date",
"type": "int",
"description": "Julian date that is to be converted to ephemeris time."
}
],
"returns": {
"name": "ephemeris_time",
"type": "float",
"description": "Julian date calculated from ephemeris time."
},
"yields": null,
"other_parameters": null,
"raises": null,
"warns": null,
"warnings": null,
"see_also": null,
"notes": null,
"references": null,
"examples": null
},
{
"name": "convert_ephemeris_time_to_julian_date",
"short_summary": "Convert ephemeris time (equivalent to TDB) to a Julian date.",
"deprecation_warning": null,
"extended_summary": "Function to convert ephemeris time, which is nearly equal to\nbarycentric dynamical time, to the Julian date. A leap second\nkernel must have been loaded to use this function.\n",
"parameters": [
{
"name": "ephemeris_time",
"type": "float",
"description": "Ephemeris time that is to be converted to Julian date."
}
],
"returns": {
"name": "julian_date",
"type": "float",
"description": "Julian date calculated from ephemeris time."
},
"yields": null,
"other_parameters": null,
"raises": null,
"warns": null,
"warnings": null,
"see_also": null,
"notes": null,
"references": null,
"examples": null
},
{
"name": "convert_date_string_to_ephemeris_time",
"short_summary": "Converts a date string to ephemeris time.",
"deprecation_warning": null,
"extended_summary": "Function to convert a date string, for instance\n1988 June 13, 3:29:48 to ephemeris time, wrapper for `str2et_c`\nspice function.\n",
"parameters": [
{
"name": "date_string",
"type": "str",
"description": "String representing the date. See documentation of spice\nfunction `str2et_c` for details on supported formats.\n"
}
],
"returns": {
"name": "ephemeris_time",
"type": "str",
"description": "Ephemeris time corresponding to given date_string."
},
"yields": null,
"other_parameters": null,
"raises": null,
"warns": null,
"warnings": null,
"see_also": null,
"notes": null,
"references": null,
"examples": null
},
{
"name": "get_body_cartesian_state_at_epoch",
"short_summary": "Get Cartesian state of a body, as observed from another body.",
"deprecation_warning": null,
"extended_summary": "This function returns the state of a body, relative to another\nbody, in a frame specified by the user. Corrections for light-time\ncorrection and stellar aberration can be applied to obtain the\nstate of one of the bodies, as observed from the other. Wrapper\nfor `spkezr_c` spice function.\n",
"parameters": [
{
"name": "target_body_name",
"type": "str",
"description": "Name of the body of which the state is to be obtained. A kernel\nwith the ephemeris of this body must have been loaded. The\nstring must be a spice-recognized name or ID.\n"
},
{
"name": "observer_body_name",
"type": "str",
"description": "Name of the body relative to which the state is to be obtained.\nA kernel with the ephemeris of this body must have been loaded.\nThe string must be a spice-recognized name or ID.\n"
},
{
"name": "reference_frame_name",
"type": "str",
"description": "The spice-recognized name of the reference frame in which the\nstate is to be returned. Spice kernel(s) required to perform\nthe necessary conversion from the states of the target and\nobserver bodies to this frame need to have been loaded.\n"
},
{
"name": "aberration_corrections",
"type": "str",
"description": "Setting for correction for setting corrections. See Spice\ndocumentation for extended discussion.\nShort summary:\n\n- NONE: none\n- LT: light time corrected (one iteration for calculation)\n- CN: light time corrected (multiple iterations, max 3) for calculation\n- S: Stellar aberration corrected.\n- XLT and XCN: can be provided to make the ephemeris time input argument the transmission time, instead of reception time. Arguments can be combined (i.e.\"LT+S\" or \"XCN+S\").\n"
},
{
"name": "ephemeris_time",
"type": "float",
"description": "Observation time (or transmission time of observed light, see description\nof aberrationCorrections).\n"
}
],
"returns": {
"name": "cartesian_state_vector",
"type": "np.ndarray[6,]",
"description": "Cartesian state vector (x,y,z, position+velocity)."
},
"yields": null,
"other_parameters": null,
"raises": null,
"warns": null,
"warnings": null,
"see_also": null,
"notes": null,
"references": null,
"examples": null
},
{
"name": "get_body_cartesian_position_at_epoch",
"short_summary": "Get Cartesian position of a body, as observed from another body.",
"deprecation_warning": null,
"extended_summary": "This function returns the position of a body, relative to another\nbody, in a frame specified by the user. Corrections for light-time\ncorrection and stellar aberration can be applied to obtain the\nstate of one of the bodies, as observed from the other. Wrapper\nfor `spkpos_c` spice function.\n",
"parameters": [
{
"name": "target_body_name",
"type": "str",
"description": "Name of the body of which the state is to be obtained. A kernel\nwith the ephemeris of this body must have been loaded. The\nstring must be a spice-recognized name or ID.\n"
},
{
"name": "observer_body_name",
"type": "str",
"description": "Name of the body relative to which the state is to be obtained.\nA kernel with the ephemeris of this body must have been loaded.\nThe string must be a spice-recognized name or ID.\n"
},
{
"name": "reference_frame_name",
"type": "str",
"description": "The spice-recognized name of the reference frame in which the\nstate is to be returned. Spice kernel(s) required to perform\nthe necessary conversion from the states of the target and\nobserver bodies to this frame need to have been loaded.\n"
},
{
"name": "aberration_corrections",
"type": "str",
"description": "Setting for correction for setting corrections. See Spice\ndocumentation for extended discussion.\nShort summary:\n\n- NONE: none\n- LT: light time corrected (one iteration for calculation)\n- CN: light time corrected (multiple iterations, max 3) for calculation,\n- S: Stellar aberration corrected.\n- XLT and XCN: can be provided to make the ephemeris time input argument the transmission time, instead of reception time. Arguments can be combined (i.e.\"LT+S\" or \"XCN+S\").\n"
},
{
"name": "ephemeris_time",
"type": "float",
"description": "Observation time (or transmission time of observed light, see description\nof aberrationCorrections).\n"
}
],
"returns": null,
"yields": null,
"other_parameters": null,
"raises": null,
"warns": null,
"warnings": null,
"see_also": null,
"notes": null,
"references": null,
"examples": null
},
{
"name": "get_cartesian_state_from_tle_at_epoch",
"short_summary": "Get Cartesian state of a satellite from its two-line element set at a specified epoch.",
"deprecation_warning": null,
"extended_summary": "This function retrieves the state of a satellite at a certain epoch\nby propagating the SGP or SDP models (near-Earth resp. deep space)\nwith the given two-line elements (TLE). This function serves as a\nwrapper for the `ev2lin_` function in CSpice.\n",
"parameters": [
{
"name": "epoch",
"type": "float",
"description": "Time in seconds since J2000 at which the state is to be retrieved."
},
{
"name": "tle",
"type": ":class:`~tudatpy.kernel.astro.ephemerides.Tle`",
"description": "Shared pointer to a Tle object containing the SGP/SDP model parameters as derived from the element set."
}
],
"returns": {
"name": "cartesian_state_vector",
"type": "np.ndarray[6,]",
"description": "Cartesian state vector (x,y,z, position+velocity)."
},
"yields": null,
"other_parameters": null,
"raises": null,
"warns": null,
"warnings": null,
"see_also": null,
"notes": null,
"references": null,
"examples": null
},
{
"name": "compute_rotation_quaternion_between_frames",
"short_summary": "Compute quaternion of rotation between two frames.",
"deprecation_warning": null,
"extended_summary": "This function computes the quaternion of rotation between two\nframes at a given time instant. kernels defining the two frames,\nas well as any required intermediate frames, at the requested\ntime must have been loaded. Wrapper for `pxform_c` spice function.\n",
"parameters": [
{
"name": "original_frame",
"type": null,
"description": "Reference frame from which the rotation is made."
},
{
"name": "new_frame",
"type": null,
"description": "Reference frame to which the rotation is made."
},
{
"name": "ephemeris_time",
"type": null,
"description": "Value of ephemeris time at which rotation is to be determined."
}
],
"returns": {
"name": null,
"type": null,
"description": "Rotation quaternion from original to new frame at given time."
},
"yields": null,
"other_parameters": null,
"raises": null,
"warns": null,
"warnings": null,
"see_also": null,
"notes": null,
"references": null,
"examples": null
},
{
"name": "compute_rotation_matrix_derivative_between_frames",
"short_summary": "Computes time derivative of rotation matrix between two frames.",
"deprecation_warning": null,
"extended_summary": "This function computes the derivative of the rotation matrix\nbetween two frames at a given time instant. kernels defining the\ntwo frames, as well as any required intermediate frames, at the\nrequested time must have been loaded. Wrapper for (part of) `sxform_c` spice function.\n",
"parameters": [
{
"name": "original_frame",
"type": null,
"description": "Reference frame from which the rotation is made."
},
{
"name": "new_frame",
"type": null,
"description": "Reference frame to which the rotation is made."
},
{
"name": "ephemeris_time",
"type": null,
"description": "Value of ephemeris time at which rotation is to be determined."
}
],
"returns": {
"name": null,
"type": null,
"description": "Time derivative of rotation matrix from original to new frame at given time."
},
"yields": null,
"other_parameters": null,
"raises": null,
"warns": null,
"warnings": null,
"see_also": null,
"notes": null,
"references": null,
"examples": null
},
{
"name": "get_angular_velocity_vector_of_frame_in_original_frame",
"short_summary": "Computes the angular velocity of one frame w.r.t. to another frame.",
"deprecation_warning": null,
"extended_summary": "Computes the angular velocity of one frame w.r.t. to another frame.\nat a given time instant. kernels defining the two frames, as well\nas any required intermediate frames, at the requested time must\nhave been loaded. Wrapper for `xf2rav_c`_ spice function (utilizing `sxform_c`_).\n\n.. _`xf2rav_c`: https://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/xf2rav_c.html\n.. _`sxform_c`: https://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/sxform_c.html\n",
"parameters": [
{
"name": "original_frame",
"type": null,
"description": "Reference frame from which the rotation is made."
},
{
"name": "new_frame",
"type": null,
"description": "Reference frame to which the rotation is made."
},
{
"name": "ephemeris_time",
"type": null,
"description": "Value of ephemeris time at which rotation is to be determined."
}
],
"returns": {
"name": null,
"type": null,
"description": "Angular velocity of newFrame w.r.t. originalFrame, expressed in originalFrame."
},
"yields": null,
"other_parameters": null,
"raises": null,
"warns": null,
"warnings": null,
"see_also": null,
"notes": null,
"references": null,
"examples": null
},
{
"name": "get_body_properties",
"short_summary": "Get property of a body from Spice.",
"deprecation_warning": null,
"extended_summary": "Function to retrieve a property of a body from Spice, wraps the bodvrd_c Spice function.\n",
"parameters": [
{
"name": "body_name",
"type": null,
"description": "Name of the body of which the property is to be retrieved."
},
{
"name": "property",
"type": null,
"description": "Name of the property that is to be retrieved. Naming conventions can be found\nin the `bodvrd_c`_ function documentation.\n\n.. _`bodvrd_c`: https://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/bodvrd_c.html\n"
},
{
"name": "maximum_number_of_values",
"type": "int",
"description": "Number of values by which the property is expressed (i.e. 1 for\ngravitational parameter, 3 for tri-axial ellipsoid principal axes).\n"
}
],
"returns": {
"name": null,
"type": null,
"description": "Property value(s) expressed in an STL vector of doubles."
},
"yields": null,
"other_parameters": null,
"raises": null,
"warns": null,
"warnings": null,
"see_also": null,
"notes": "Function returns values with distance unit km, not m!\n",
"references": null,
"examples": null
},
{
"name": "get_body_gravitational_parameter",
"short_summary": "Get gravitational parameter of a body.",
"deprecation_warning": null,
"extended_summary": "This function retrieves the gravitational parameter of a body.\nWraps the `bodvrd_c`_ spice function with \"GM\" as property type.\n\n.. _`bodvrd_c`: https://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/bodvrd_c.html\n",
"parameters": [
{
"name": "body",
"type": null,
"description": "Name of the body of which the parameter is to be retrieved."
}
],
"returns": {
"name": null,
"type": null,
"description": "Gravitational parameter of requested body."
},
"yields": null,
"other_parameters": null,
"raises": null,
"warns": null,
"warnings": null,
"see_also": null,
"notes": null,
"references": null,
"examples": null
},
{
"name": "get_average_radius",
"short_summary": "Get the (arithmetic) mean of the three principal axes of the tri-axial ellipsoid shape.",
"deprecation_warning": null,
"extended_summary": "Returns the (arithmetic) mean of the three principal axes of the\ntri-axial ellipsoid shape of the requested body. Uses the `bodvrd_c` spice function with \"RADII\" as property type.\n\n.. _`bodvrd_c`: https://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/bodvrd_c.html\n",
"parameters": [
{
"name": "body",
"type": null,
"description": "Name of the body of which the average radius is to be retrieved."
}
],
"returns": {
"name": null,
"type": null,
"description": "Arithmetic mean of principal axes of tri-axial ellipsoid shape model of body."
},
"yields": null,
"other_parameters": null,
"raises": null,
"warns": null,
"warnings": null,
"see_also": null,
"notes": null,
"references": null,
"examples": null
},
{
"name": "convert_body_name_to_naif_id",
"short_summary": "Convert a body name to its NAIF identification number.",
"deprecation_warning": null,
"extended_summary": "This function converts a body name to its NAIF identification\nnumber. The NAIF id number is required for a number of spice\nfunctions, whereas the name is easily interpretable by the user.\nWrapper for the ``bods2c_c`` function.\n",
"parameters": [
{
"name": "body_name",
"type": null,
"description": "Name of the body for which NAIF id is to be retrieved."
}
],
"returns": {
"name": null,
"type": null,
"description": "NAIF id number for the body with bodyName."
},
"yields": null,
"other_parameters": null,
"raises": null,
"warns": null,
"warnings": null,
"see_also": null,
"notes": null,
"references": null,
"examples": null
},
{
"name": "check_body_property_in_kernel_pool",
"short_summary": "Check if a certain property of a body is in the kernel pool.",
"deprecation_warning": null,
"extended_summary": "This function checks if a certain property of a body is in the\nkernel pool. These properties are defined in PCK kernels. Their\nnames are given in the kernel file, typical names can be found in\nthe Spice documentation. Wrapper for the `bodfnd_c`_ function.\n\n.. _`bodfnd_c`: https://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/bodfnd_c.html\n",
"parameters": [
{
"name": "body_name",
"type": null,
"description": "Name of the body of which the property is to be checked."
},
{
"name": "body_property",
"type": null,
"description": "Name of the property of which the presence is to be checked, not case-sensitive."
}
],
"returns": {
"name": null,
"type": "bool",
"description": "True if property is in pool, false if not."
},
"yields": null,
"other_parameters": null,
"raises": null,
"warns": null,
"warnings": null,
"see_also": null,
"notes": null,
"references": null,
"examples": null
},
{
"name": "get_standard_kernels",
"short_summary": "Get the paths to the default legacy kernels.",
"deprecation_warning": null,
"extended_summary": null,
"parameters": null,
"returns": null,
"yields": null,
"other_parameters": null,
"raises": null,
"warns": null,
"warnings": null,
"see_also": null,
"notes": null,
"references": null,
"examples": null
},
{
"name": "load_standard_kernels",
"short_summary": "Load the default legacy kernels.",
"deprecation_warning": null,
"extended_summary": null,
"parameters": [
{
"name": "kernel_paths",
"type": "List[str]",
"description": "Optional addition kernels to be loaded."
}
],
"returns": null,
"yields": null,
"other_parameters": null,
"raises": null,
"warns": null,
"warnings": null,
"see_also": null,
"notes": null,
"references": null,
"examples": null
},
{
"name": "get_total_count_of_kernels_loaded",
"short_summary": "Get the number of spice kernels currently loaded.",
"deprecation_warning": null,
"extended_summary": "This function returns the amount of Spice kernels that are loaded\ninto the kernel pool. The same kernel can be loaded multiple times.\nWrapper for the `ktotal_c`_ function.\n\n.. _`ktotal_c`: https://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/ktotal_c.html\n",
"parameters": null,
"returns": {
"name": "n_kernels",
"type": "int",
"description": "Number of spice kernels currently loaded."
},
"yields": null,
"other_parameters": null,
"raises": null,
"warns": null,
"warnings": null,
"see_also": null,
"notes": null,
"references": null,
"examples": null
},
{
"name": "load_kernel",
"short_summary": "Loads a Spice kernel into the pool.",
"deprecation_warning": null,
"extended_summary": "This function loads a Spice kernel into the kernel pool, from which\nit can be used by the various internal spice routines. Matters\nregarding the manner in which Spice handles different kernels\ncontaining the same information can be found in the spice required\nreading documentation, kernel section. Wrapper for the `furnsh_c`_\nfunction.\n\n.. _`furnsh_c`: https://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/furnsh_c.html\n",
"parameters": [
{
"name": "file_path",
"type": "str",
"description": "Path to the spice kernel to be loaded."
}
],
"returns": null,
"yields": null,
"other_parameters": null,
"raises": null,
"warns": null,
"warnings": null,
"see_also": null,
"notes": null,
"references": null,
"examples": null
},
{
"name": "clear_kernels",
"short_summary": "Clear all loaded spice kernels.",
"deprecation_warning": null,
"extended_summary": "This function removes all Spice kernels from the kernel pool.\nWrapper for the `kclear_c`_ function.\n\n.. _`kclear_c`: https://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/kclear_c.html\n",
"parameters": null,
"returns": null,
"yields": null,
"other_parameters": null,
"raises": null,
"warns": null,
"warnings": null,
"see_also": null,
"notes": null,
"references": null,
"examples": null
}
],
"constants": null,
"name": "spice",
"version": null,
"convert_julian_date_to_ephemeris_time": "\nConvert a Julian date to ephemeris time (equivalent to TDB in Spice).\n\nThe following math is for documentation demonstration purposes\n\n.. math:: X(e^{j\\omega } ) = x(n)e^{ - j\\omega n}\n\n\\f$ f(x) = a + b \\f$\n\nFunction to convert a Julian date to ephemeris time, which is\nequivalent to barycentric dynamical time. A leap second kernel\nmust have been loaded to use this function.\n\n\nParameters\n----------\njulian_date : int\n Julian date that is to be converted to ephemeris time.\n\nReturns\n-------\nephemeris_time : floatJulian date calculated from ephemeris time.\n\n",
"convert_ephemeris_time_to_julian_date": "\nConvert ephemeris time (equivalent to TDB) to a Julian date.\n\nFunction to convert ephemeris time, which is nearly equal to\nbarycentric dynamical time, to the Julian date. A leap second\nkernel must have been loaded to use this function.\n\n\nParameters\n----------\nephemeris_time : float\n Ephemeris time that is to be converted to Julian date.\n\nReturns\n-------\njulian_date : floatJulian date calculated from ephemeris time.\n\n",
"convert_date_string_to_ephemeris_time": "\nConverts a date string to ephemeris time.\n\nFunction to convert a date string, for instance\n1988 June 13, 3:29:48 to ephemeris time, wrapper for `str2et_c`\nspice function.\n\n\nParameters\n----------\ndate_string : str\n String representing the date. See documentation of spice\n function `str2et_c` for details on supported formats.\n\n\nReturns\n-------\nephemeris_time : strEphemeris time corresponding to given date_string.\n\n",
"get_body_cartesian_state_at_epoch": "\nGet Cartesian state of a body, as observed from another body.\n\nThis function returns the state of a body, relative to another\nbody, in a frame specified by the user. Corrections for light-time\ncorrection and stellar aberration can be applied to obtain the\nstate of one of the bodies, as observed from the other. Wrapper\nfor `spkezr_c` spice function.\n\n\nParameters\n----------\ntarget_body_name : str\n Name of the body of which the state is to be obtained. A kernel\n with the ephemeris of this body must have been loaded. The\n string must be a spice-recognized name or ID.\n\nobserver_body_name : str\n Name of the body relative to which the state is to be obtained.\n A kernel with the ephemeris of this body must have been loaded.\n The string must be a spice-recognized name or ID.\n\nreference_frame_name : str\n The spice-recognized name of the reference frame in which the\n state is to be returned. Spice kernel(s) required to perform\n the necessary conversion from the states of the target and\n observer bodies to this frame need to have been loaded.\n\naberration_corrections : str\n Setting for correction for setting corrections. See Spice\n documentation for extended discussion.\n Short summary:\n\n - NONE: none\n - LT: light time corrected (one iteration for calculation)\n - CN: light time corrected (multiple iterations, max 3) for calculation\n - S: Stellar aberration corrected.\n - XLT and XCN: can be provided to make the ephemeris time input argument the transmission time, instead of reception time. Arguments can be combined (i.e.\"LT+S\" or \"XCN+S\").\n\nephemeris_time : float\n Observation time (or transmission time of observed light, see description\n of aberrationCorrections).\n\n\nReturns\n-------\ncartesian_state_vector : np.ndarray[6,]Cartesian state vector (x,y,z, position+velocity).\n\n",
"get_body_cartesian_position_at_epoch": "\nGet Cartesian position of a body, as observed from another body.\n\nThis function returns the position of a body, relative to another\nbody, in a frame specified by the user. Corrections for light-time\ncorrection and stellar aberration can be applied to obtain the\nstate of one of the bodies, as observed from the other. Wrapper\nfor `spkpos_c` spice function.\n\n\nParameters\n----------\ntarget_body_name : str\n Name of the body of which the state is to be obtained. A kernel\n with the ephemeris of this body must have been loaded. The\n string must be a spice-recognized name or ID.\n\nobserver_body_name : str\n Name of the body relative to which the state is to be obtained.\n A kernel with the ephemeris of this body must have been loaded.\n The string must be a spice-recognized name or ID.\n\nreference_frame_name : str\n The spice-recognized name of the reference frame in which the\n state is to be returned. Spice kernel(s) required to perform\n the necessary conversion from the states of the target and\n observer bodies to this frame need to have been loaded.\n\naberration_corrections : str\n Setting for correction for setting corrections. See Spice\n documentation for extended discussion.\n Short summary:\n\n - NONE: none\n - LT: light time corrected (one iteration for calculation)\n - CN: light time corrected (multiple iterations, max 3) for calculation,\n - S: Stellar aberration corrected.\n - XLT and XCN: can be provided to make the ephemeris time input argument the transmission time, instead of reception time. Arguments can be combined (i.e.\"LT+S\" or \"XCN+S\").\n\nephemeris_time : float\n Observation time (or transmission time of observed light, see description\n of aberrationCorrections).\n\n",
"get_cartesian_state_from_tle_at_epoch": "\nGet Cartesian state of a satellite from its two-line element set at a specified epoch.\n\nThis function retrieves the state of a satellite at a certain epoch\nby propagating the SGP or SDP models (near-Earth resp. deep space)\nwith the given two-line elements (TLE). This function serves as a\nwrapper for the `ev2lin_` function in CSpice.\n\n\nParameters\n----------\nepoch : float\n Time in seconds since J2000 at which the state is to be retrieved.\ntle : :class:`~tudatpy.kernel.astro.ephemerides.Tle`\n Shared pointer to a Tle object containing the SGP/SDP model parameters as derived from the element set.\n\nReturns\n-------\ncartesian_state_vector : np.ndarray[6,]Cartesian state vector (x,y,z, position+velocity).\n\n",
"compute_rotation_quaternion_between_frames": "\nCompute quaternion of rotation between two frames.\n\nThis function computes the quaternion of rotation between two\nframes at a given time instant. kernels defining the two frames,\nas well as any required intermediate frames, at the requested\ntime must have been loaded. Wrapper for `pxform_c` spice function.\n\n\nParameters\n----------\noriginal_frame\n Reference frame from which the rotation is made.\nnew_frame\n Reference frame to which the rotation is made.\nephemeris_time\n Value of ephemeris time at which rotation is to be determined.\n\nReturns\n-------\nRotation quaternion from original to new frame at given time.\n\n",
"compute_rotation_matrix_derivative_between_frames": "\nComputes time derivative of rotation matrix between two frames.\n\nThis function computes the derivative of the rotation matrix\nbetween two frames at a given time instant. kernels defining the\ntwo frames, as well as any required intermediate frames, at the\nrequested time must have been loaded. Wrapper for (part of) `sxform_c` spice function.\n\n\nParameters\n----------\noriginal_frame\n Reference frame from which the rotation is made.\nnew_frame\n Reference frame to which the rotation is made.\nephemeris_time\n Value of ephemeris time at which rotation is to be determined.\n\nReturns\n-------\nTime derivative of rotation matrix from original to new frame at given time.\n\n",
"get_angular_velocity_vector_of_frame_in_original_frame": "\nComputes the angular velocity of one frame w.r.t. to another frame.\n\nComputes the angular velocity of one frame w.r.t. to another frame.\nat a given time instant. kernels defining the two frames, as well\nas any required intermediate frames, at the requested time must\nhave been loaded. Wrapper for `xf2rav_c`_ spice function (utilizing `sxform_c`_).\n\n.. _`xf2rav_c`: https://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/xf2rav_c.html\n.. _`sxform_c`: https://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/sxform_c.html\n\n\nParameters\n----------\noriginal_frame\n Reference frame from which the rotation is made.\nnew_frame\n Reference frame to which the rotation is made.\nephemeris_time\n Value of ephemeris time at which rotation is to be determined.\n\nReturns\n-------\nAngular velocity of newFrame w.r.t. originalFrame, expressed in originalFrame.\n\n",
"get_body_properties": "\nGet property of a body from Spice.\n\nFunction to retrieve a property of a body from Spice, wraps the bodvrd_c Spice function.\n\n\nParameters\n----------\nbody_name\n Name of the body of which the property is to be retrieved.\nproperty\n Name of the property that is to be retrieved. Naming conventions can be found\n in the `bodvrd_c`_ function documentation.\n\n .. _`bodvrd_c`: https://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/bodvrd_c.html\n\nmaximum_number_of_values : int\n Number of values by which the property is expressed (i.e. 1 for\n gravitational parameter, 3 for tri-axial ellipsoid principal axes).\n\n\nReturns\n-------\nProperty value(s) expressed in an STL vector of doubles.\n\n",
"get_body_gravitational_parameter": "\nGet gravitational parameter of a body.\n\nThis function retrieves the gravitational parameter of a body.\nWraps the `bodvrd_c`_ spice function with \"GM\" as property type.\n\n.. _`bodvrd_c`: https://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/bodvrd_c.html\n\n\nParameters\n----------\nbody\n Name of the body of which the parameter is to be retrieved.\n\nReturns\n-------\nGravitational parameter of requested body.\n\n",
"get_average_radius": "\nGet the (arithmetic) mean of the three principal axes of the tri-axial ellipsoid shape.\n\nReturns the (arithmetic) mean of the three principal axes of the\ntri-axial ellipsoid shape of the requested body. Uses the `bodvrd_c` spice function with \"RADII\" as property type.\n\n.. _`bodvrd_c`: https://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/bodvrd_c.html\n\n\nParameters\n----------\nbody\n Name of the body of which the average radius is to be retrieved.\n\nReturns\n-------\nArithmetic mean of principal axes of tri-axial ellipsoid shape model of body.\n\n",
"convert_body_name_to_naif_id": "\nConvert a body name to its NAIF identification number.\n\nThis function converts a body name to its NAIF identification\nnumber. The NAIF id number is required for a number of spice\nfunctions, whereas the name is easily interpretable by the user.\nWrapper for the ``bods2c_c`` function.\n\n\nParameters\n----------\nbody_name\n Name of the body for which NAIF id is to be retrieved.\n\nReturns\n-------\nNAIF id number for the body with bodyName.\n\n",
"check_body_property_in_kernel_pool": "\nCheck if a certain property of a body is in the kernel pool.\n\nThis function checks if a certain property of a body is in the\nkernel pool. These properties are defined in PCK kernels. Their\nnames are given in the kernel file, typical names can be found in\nthe Spice documentation. Wrapper for the `bodfnd_c`_ function.\n\n.. _`bodfnd_c`: https://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/bodfnd_c.html\n\n\nParameters\n----------\nbody_name\n Name of the body of which the property is to be checked.\nbody_property\n Name of the property of which the presence is to be checked, not case-sensitive.\n\nReturns\n-------\nbool\nTrue if property is in pool, false if not.\n\n",
"get_standard_kernels": "\nGet the paths to the default legacy kernels.\n\n",
"load_standard_kernels": "\nLoad the default legacy kernels.\n\n\nParameters\n----------\nkernel_paths : List[str]\n Optional addition kernels to be loaded.\n",
"get_total_count_of_kernels_loaded": "\nGet the number of spice kernels currently loaded.\n\nThis function returns the amount of Spice kernels that are loaded\ninto the kernel pool. The same kernel can be loaded multiple times.\nWrapper for the `ktotal_c`_ function.\n\n.. _`ktotal_c`: https://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/ktotal_c.html\n\n\nReturns\n-------\nn_kernels : intNumber of spice kernels currently loaded.\n\n",
"load_kernel": "\nLoads a Spice kernel into the pool.\n\nThis function loads a Spice kernel into the kernel pool, from which\nit can be used by the various internal spice routines. Matters\nregarding the manner in which Spice handles different kernels\ncontaining the same information can be found in the spice required\nreading documentation, kernel section. Wrapper for the `furnsh_c`_\nfunction.\n\n.. _`furnsh_c`: https://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/furnsh_c.html\n\n\nParameters\n----------\nfile_path : str\n Path to the spice kernel to be loaded.\n",
"clear_kernels": "\nClear all loaded spice kernels.\n\nThis function removes all Spice kernels from the kernel pool.\nWrapper for the `kclear_c`_ function.\n\n.. _`kclear_c`: https://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/kclear_c.html\n\n",
"SpiceEphemeris": {
"name": "SpiceEphemeris",
"short_summary": "Ephemeris derived class which retrieves the state of a body directly from the SPICE library.",
"deprecation_warning": null,
"extended_summary": "Ephemeris derived class which retrieves the state of a body directly from the SPICE library.\nThe body of which the ephemeris is to be retrieved, as well as the origin and orientation\nof the reference frame in which the states are returned, and any corrections that are\napplied, are defined once during object construction.\n",
"parameters": null,
"attributes": null,
"yields": null,
"other_parameters": null,
"raises": null,
"warns": null,
"warnings": null,
"see_also": null,
"notes": null,
"references": null,
"examples": null,
"methods": [
{
"name": "__init__",
"short_summary": "Constructor.",
"deprecation_warning": null,
"extended_summary": "Constructor, sets the input variables for the calls to the spice function to retrieve state.",
"parameters": [
{
"name": "target_body_name",
"type": null,
"description": "Name of body of which the ephemeris is to be calculated."
},
{
"name": "observer_body_name",
"type": null,
"description": "Name of body relative to which the ephemeris is to be calculated."
},
{
"name": "correct_for_stellar_aberration",
"type": null,
"description": "Boolean whether to correct for stellar Aberration in retrieved values of (observed state).\n"
},
{
"name": "correct_for_light_time_aberration",
"type": null,
"description": "Boolean whether to correct for light time in retrieved values of (observed state).\n"
},
{
"name": "converge_ligh_time_aberration",
"type": null,
"description": "Boolean whether to use single iteration or max. 3 iterations for calculating light time.\n"
},
{
"name": "reference_frame_name",
"type": null,
"description": "Name of the reference frame in which the epehemeris is to be calculated.\n"
},
{
"name": "reference_julian_day",
"type": null,
"description": "Reference julian day w.r.t. which ephemeris is evaluated.\n"
}
],
"returns": null,
"yields": null,
"other_parameters": null,
"raises": null,
"warns": null,
"warnings": null,
"see_also": null,
"notes": null,
"references": null,
"examples": null
},
{
"name": "get_cartesian_state",
"short_summary": "Get Cartesian state from ephemeris.",
"deprecation_warning": null,
"extended_summary": " Returns Cartesian state from ephemeris at given Julian day.",
"parameters": [
{
"name": "seconds_since_epoch",
"type": "float",
"description": "Seconds since epoch at which ephemeris is to be evaluated."
}
],
"returns": null,
"yields": null,
"other_parameters": null,
"raises": null,
"warns": null,
"warnings": null,
"see_also": null,
"notes": null,
"references": null,
"examples": null
}
],
"__init__": "\nConstructor.\n\nConstructor, sets the input variables for the calls to the spice function to retrieve state.\n\nParameters\n----------\ntarget_body_name\n Name of body of which the ephemeris is to be calculated.\nobserver_body_name\n Name of body relative to which the ephemeris is to be calculated.\ncorrect_for_stellar_aberration\n Boolean whether to correct for stellar Aberration in retrieved values of (observed state).\n\ncorrect_for_light_time_aberration\n Boolean whether to correct for light time in retrieved values of (observed state).\n\nconverge_ligh_time_aberration\n Boolean whether to use single iteration or max. 3 iterations for calculating light time.\n\nreference_frame_name\n Name of the reference frame in which the epehemeris is to be calculated.\n\nreference_julian_day\n Reference julian day w.r.t. which ephemeris is evaluated.\n\n",
"get_cartesian_state": "\nGet Cartesian state from ephemeris.\n\n Returns Cartesian state from ephemeris at given Julian day.\n\nParameters\n----------\nseconds_since_epoch : float\n Seconds since epoch at which ephemeris is to be evaluated.\n",
"__docstring__": "\nEphemeris derived class which retrieves the state of a body directly from the SPICE library.\n\nEphemeris derived class which retrieves the state of a body directly from the SPICE library.\nThe body of which the ephemeris is to be retrieved, as well as the origin and orientation\nof the reference frame in which the states are returned, and any corrections that are\napplied, are defined once during object construction.\n\n"
}
}
},
"numerical-simulation": {
"type": "package",
"path": "docstrings/numerical-simulation",
"file": "__package__.yaml",
"_implicit_name": "numerical-simulation",
"config": null,
"summary": null,
"extended_summary": null,
"routine_listings": null,
"see_also": null,
"notes": null,
"references": null,
"examples": null,
"classes": null,
"functions": null,
"constants": null,
"modules": [
"environment_setup"
],
"name": "numerical-simulation",
"version": null,
"environment_setup": {
"type": "module",
"path": "docstrings/numerical-simulation",
"file": "environment_setup.yaml",
"_implicit_name": "environment_setup",
"config": null,
"summary": null,
"extended_summary": null,
"routine_listings": null,
"see_also": null,
"notes": "None",
"references": null,
"examples": null,
"classes": [
{
"name": "RotationModelSettings",
"short_summary": "Base class for providing settings for automatic rotation model creation.",
"deprecation_warning": null,
"extended_summary": "This class is a functional base class for settings of rotation models that require no information in addition to their type.\nBasic rotation model has constant orientation of the rotation axis (body-fixed z-axis) and constant rotation rate about this axis.\nRotation models requiring additional information must be created using the factory functions which create the specific object derived from this base class.\n",
"parameters": null,
"attributes": [
{
"name": "rotation_type",
"type": "RotationModelType",
"description": "Type of rotation model that is to be created."
},
{
"name": "base_frame",
"type": "str",
"description": "Base frame of rotation model."
},
{
"name": "target_frame",
"type": "str",
"description": null
}
],
"yields": null,
"other_parameters": null,
"raises": null,
"warns": null,
"warnings": null,
"see_also": null,
"notes": null,
"references": null,
"examples": null,
"methods": null
},
{
"name": "GravityFieldSettings",
"short_summary": "Base class for providing settings for automatic gravity field model creation.",
"deprecation_warning": null,
"extended_summary": "This class is a functional base class for settings of gravity field models that require no information in addition to their type.\nGravity field model classes requiring additional information must be created using an object derived from this class.\n",
"parameters": null,
"attributes": [
{
"name": "gravity_field_type",
"type": "GravityFieldType",
"description": "Type of gravity field model that is to be created."
}
],
"yields": null,
"other_parameters": null,
"raises": null,
"warns": null,
"warnings": null,
"see_also": null,
"notes": null,
"references": null,
"examples": null,
"methods": [
{
"name": "__init__",
"short_summary": null,
"deprecation_warning": null,
"extended_summary": null,
"parameters": null,
"returns": null,
"yields": null,
"other_parameters": null,
"raises": null,
"warns": null,
"warnings": null,
"see_also": null,
"notes": null,
"references": null,
"examples": null
}
]
},
{
"name": "CentralGravityFieldSettings",
"short_summary": "`GravityFieldSettings` derived class defining settings of point mass gravity field.",
"deprecation_warning": null,
"extended_summary": "Derived class of `GravityFieldSettings` for central gravity fields, which are defined by a single gravitational parameter.\n",
"parameters": null,
"attributes": [
{
"name": "gravitational_parameter",
"type": "float",
"description": "Gravitational parameter of central gravity field."
}
],
"yields": null,
"other_parameters": null,
"raises": null,
"warns": null,
"warnings": null,
"see_also": null,
"notes": null,
"references": null,
"examples": null,
"methods": null
},
{
"name": "SphericalHarmonicsGravityFieldSettings",
"short_summary": "`GravityFieldSettings` derived class defining settings of spherical harmonic gravity field representation.",
"deprecation_warning": null,
"extended_summary": "Derived class of `GravityFieldSettings` for gravity fields, which are defined by a spherical harmonic gravity field representation.\n",
"parameters": null,
"attributes": [
{
"name": "gravitational_parameter",
"type": "float",
"description": "Gravitational parameter of gravity field."
},
{
"name": "reference_radius",
"type": "float",
"description": "Reference radius of spherical harmonic field expansion."
},