-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmirage.html
7888 lines (7255 loc) · 926 KB
/
mirage.html
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
<!DOCTYPE html>
<html lang="en" data-content_root="./" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>mirage package — MIRAGE documentation</title>
<script data-cfasync="false">
document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
document.documentElement.dataset.theme = localStorage.getItem("theme") || "";
</script>
<!-- Loaded before other Sphinx assets -->
<link href="_static/styles/theme.css?digest=dfe6caa3a7d634c4db9b" rel="stylesheet" />
<link href="_static/styles/bootstrap.css?digest=dfe6caa3a7d634c4db9b" rel="stylesheet" />
<link href="_static/styles/pydata-sphinx-theme.css?digest=dfe6caa3a7d634c4db9b" rel="stylesheet" />
<link href="_static/vendor/fontawesome/6.5.2/css/all.min.css?digest=dfe6caa3a7d634c4db9b" rel="stylesheet" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.5.2/webfonts/fa-solid-900.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.5.2/webfonts/fa-brands-400.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.5.2/webfonts/fa-regular-400.woff2" />
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
<link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery.css?v=d2d258e8" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-binder.css?v=f4aeca0c" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-dataframe.css?v=2082cf3c" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-rendered-html.css?v=1277b6f3" />
<link rel="stylesheet" type="text/css" href="_static/css/custom.css?v=98d29b3f" />
<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=dfe6caa3a7d634c4db9b" />
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
<script src="_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
<script src="_static/documentation_options.js?v=5929fcd5"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/clipboard.min.js?v=a7894cd8"></script>
<script src="_static/copybutton.js?v=f281be69"></script>
<script async="async" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
<script>DOCUMENTATION_OPTIONS.pagename = 'mirage';</script>
<link rel="icon" href="_static/sid_logo_dark.ico"/>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="mirage.papers package" href="mirage.papers.html" />
<link rel="prev" title="mirage" href="modules.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
</head>
<body data-bs-spy="scroll" data-bs-target=".bd-toc-nav" data-offset="180" data-bs-root-margin="0px 0px -60%" data-default-mode="">
<div id="pst-skip-link" class="skip-link d-print-none"><a href="#main-content">Skip to main content</a></div>
<div id="pst-scroll-pixel-helper"></div>
<button type="button" class="btn rounded-pill" id="pst-back-to-top">
<i class="fa-solid fa-arrow-up"></i>Back to top</button>
<input type="checkbox"
class="sidebar-toggle"
id="pst-primary-sidebar-checkbox"/>
<label class="overlay overlay-primary" for="pst-primary-sidebar-checkbox"></label>
<input type="checkbox"
class="sidebar-toggle"
id="pst-secondary-sidebar-checkbox"/>
<label class="overlay overlay-secondary" for="pst-secondary-sidebar-checkbox"></label>
<div class="search-button__wrapper">
<div class="search-button__overlay"></div>
<div class="search-button__search-container">
<form class="bd-search d-flex align-items-center"
action="search.html"
method="get">
<i class="fa-solid fa-magnifying-glass"></i>
<input type="search"
class="form-control"
name="q"
id="search-input"
placeholder="Search the docs ..."
aria-label="Search the docs ..."
autocomplete="off"
autocorrect="off"
autocapitalize="off"
spellcheck="false"/>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
</form></div>
</div>
<div class="pst-async-banner-revealer d-none">
<aside id="bd-header-version-warning" class="d-none d-print-none" aria-label="Version warning"></aside>
</div>
<header class="bd-header navbar navbar-expand-lg bd-navbar d-print-none">
<div class="bd-header__inner bd-page-width">
<button class="pst-navbar-icon sidebar-toggle primary-toggle" aria-label="Site navigation">
<span class="fa-solid fa-bars"></span>
</button>
<div class="col-lg-3 navbar-header-items__start">
<div class="navbar-item">
<a class="navbar-brand logo" href="index.html">
<img src="_static/sid_logo_light.png" class="logo__image only-light" alt=""/>
<script>document.write(`<img src="_static/sid_logo_dark.png" class="logo__image only-dark" alt=""/>`);</script>
<p class="title logo__title">MIRAGE</p>
</a></div>
</div>
<div class="col-lg-9 navbar-header-items">
<div class="me-auto navbar-header-items__center">
<div class="navbar-item">
<nav>
<ul class="bd-navbar-elements navbar-nav">
<li class="nav-item ">
<a class="nav-link nav-internal" href="getting_started.html">
Getting Started
</a>
</li>
<li class="nav-item current active">
<a class="nav-link nav-internal" href="modules.html">
mirage
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="gallery/index.html">
Examples Gallery
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="references.html">
References
</a>
</li>
</ul>
</nav></div>
</div>
<div class="navbar-header-items__end">
<div class="navbar-item navbar-persistent--container">
<script>
document.write(`
<button class="btn search-button-field search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
<span class="search-button__default-text">Search</span>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
</button>
`);
</script>
</div>
<div class="navbar-item">
<script>
document.write(`
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto"></i>
</button>
`);
</script></div>
</div>
</div>
<div class="navbar-persistent--mobile">
<script>
document.write(`
<button class="btn search-button-field search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
<span class="search-button__default-text">Search</span>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
</button>
`);
</script>
</div>
<button class="pst-navbar-icon sidebar-toggle secondary-toggle" aria-label="On this page">
<span class="fa-solid fa-outdent"></span>
</button>
</div>
</header>
<div class="bd-container">
<div class="bd-container__inner bd-page-width">
<div class="bd-sidebar-primary bd-sidebar">
<div class="sidebar-header-items sidebar-primary__section">
<div class="sidebar-header-items__center">
<div class="navbar-item">
<nav>
<ul class="bd-navbar-elements navbar-nav">
<li class="nav-item ">
<a class="nav-link nav-internal" href="getting_started.html">
Getting Started
</a>
</li>
<li class="nav-item current active">
<a class="nav-link nav-internal" href="modules.html">
mirage
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="gallery/index.html">
Examples Gallery
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="references.html">
References
</a>
</li>
</ul>
</nav></div>
</div>
<div class="sidebar-header-items__end">
<div class="navbar-item">
<script>
document.write(`
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto"></i>
</button>
`);
</script></div>
</div>
</div>
<div class="sidebar-primary-items__start sidebar-primary__section">
<div class="sidebar-primary-item">
<nav class="bd-docs-nav bd-links"
aria-label="Section Navigation">
<p class="bd-links__title" role="heading" aria-level="1">Section Navigation</p>
<div class="bd-toc-item navbar-nav"><ul class="current nav bd-sidenav">
<li class="toctree-l1 current active has-children"><a class="current reference internal" href="#">mirage package</a><details open="open"><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2"><a class="reference internal" href="mirage.papers.html">mirage.papers package</a></li>
<li class="toctree-l2"><a class="reference internal" href="mirage.photo.html">mirage.photo package</a></li>
<li class="toctree-l2"><a class="reference internal" href="mirage.sim.html">mirage.sim package</a></li>
<li class="toctree-l2"><a class="reference internal" href="mirage.synth.html">mirage.synth package</a></li>
<li class="toctree-l2"><a class="reference internal" href="mirage.tests.html">mirage.tests package</a></li>
<li class="toctree-l2"><a class="reference internal" href="mirage.vis.html">mirage.vis package</a></li>
</ul>
</details></li>
</ul>
</div>
</nav></div>
</div>
<div class="sidebar-primary-items__end sidebar-primary__section">
</div>
<div id="rtd-footer-container"></div>
</div>
<main id="main-content" class="bd-main" role="main">
<div class="bd-content">
<div class="bd-article-container">
<div class="bd-header-article d-print-none">
<div class="header-article-items header-article__inner">
<div class="header-article-items__start">
<div class="header-article-item">
<nav aria-label="Breadcrumb" class="d-print-none">
<ul class="bd-breadcrumbs">
<li class="breadcrumb-item breadcrumb-home">
<a href="index.html" class="nav-link" aria-label="Home">
<i class="fa-solid fa-home"></i>
</a>
</li>
<li class="breadcrumb-item"><a href="modules.html" class="nav-link">mirage</a></li>
<li class="breadcrumb-item active" aria-current="page">mirage package</li>
</ul>
</nav>
</div>
</div>
</div>
</div>
<div id="searchbox"></div>
<article class="bd-article">
<section id="mirage-package">
<h1>mirage package<a class="headerlink" href="#mirage-package" title="Link to this heading">#</a></h1>
<section id="subpackages">
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Link to this heading">#</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="mirage.papers.html">mirage.papers package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="mirage.papers.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="mirage.papers.html#mirage-papers-attitude-paper-module">mirage.papers.attitude_paper module</a></li>
<li class="toctree-l2"><a class="reference internal" href="mirage.papers.html#module-contents">Module contents</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="mirage.photo.html">mirage.photo package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="mirage.photo.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="mirage.photo.html#module-mirage.photo.astrometry">mirage.photo.astrometry module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="mirage.photo.html#mirage.photo.astrometry.get_astrometry_solver"><code class="docutils literal notranslate"><span class="pre">get_astrometry_solver()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.photo.html#mirage.photo.astrometry.look_and_up_from_wcs"><code class="docutils literal notranslate"><span class="pre">look_and_up_from_wcs()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.photo.html#mirage.photo.astrometry.wcs_from_contours"><code class="docutils literal notranslate"><span class="pre">wcs_from_contours()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.photo.html#mirage.photo.astrometry.wcs_from_pixels"><code class="docutils literal notranslate"><span class="pre">wcs_from_pixels()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="mirage.photo.html#module-mirage.photo.exceptions">mirage.photo.exceptions module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="mirage.photo.html#mirage.photo.exceptions.AstrometryError"><code class="docutils literal notranslate"><span class="pre">AstrometryError</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.photo.html#mirage.photo.exceptions.BadFitsError"><code class="docutils literal notranslate"><span class="pre">BadFitsError</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.photo.html#mirage.photo.exceptions.NoMatchesError"><code class="docutils literal notranslate"><span class="pre">NoMatchesError</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.photo.html#mirage.photo.exceptions.NoSourcesError"><code class="docutils literal notranslate"><span class="pre">NoSourcesError</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.photo.html#mirage.photo.exceptions.NoStreaksError"><code class="docutils literal notranslate"><span class="pre">NoStreaksError</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="mirage.photo.html#module-mirage.photo.io">mirage.photo.io module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="mirage.photo.html#mirage.photo.io.load_fits"><code class="docutils literal notranslate"><span class="pre">load_fits()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.photo.html#mirage.photo.io.save_light_curve"><code class="docutils literal notranslate"><span class="pre">save_light_curve()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="mirage.photo.html#module-mirage.photo.photometry">mirage.photo.photometry module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="mirage.photo.html#mirage.photo.photometry.background_subtract"><code class="docutils literal notranslate"><span class="pre">background_subtract()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.photo.html#mirage.photo.photometry.compute_contours"><code class="docutils literal notranslate"><span class="pre">compute_contours()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.photo.html#mirage.photo.photometry.crop_around_centroid"><code class="docutils literal notranslate"><span class="pre">crop_around_centroid()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.photo.html#mirage.photo.photometry.crop_at"><code class="docutils literal notranslate"><span class="pre">crop_at()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.photo.html#mirage.photo.photometry.draw_contours_on_image"><code class="docutils literal notranslate"><span class="pre">draw_contours_on_image()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.photo.html#mirage.photo.photometry.fill_contours_on_image"><code class="docutils literal notranslate"><span class="pre">fill_contours_on_image()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.photo.html#mirage.photo.photometry.filter_contours"><code class="docutils literal notranslate"><span class="pre">filter_contours()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.photo.html#mirage.photo.photometry.get_shape_factor"><code class="docutils literal notranslate"><span class="pre">get_shape_factor()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.photo.html#mirage.photo.photometry.image_centroid"><code class="docutils literal notranslate"><span class="pre">image_centroid()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.photo.html#mirage.photo.photometry.object_mask"><code class="docutils literal notranslate"><span class="pre">object_mask()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.photo.html#mirage.photo.photometry.process_subframes"><code class="docutils literal notranslate"><span class="pre">process_subframes()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.photo.html#mirage.photo.photometry.source_flux_from_subframe"><code class="docutils literal notranslate"><span class="pre">source_flux_from_subframe()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="mirage.photo.html#module-mirage.photo.vis">mirage.photo.vis module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="mirage.photo.html#mirage.photo.vis.animate_subframes"><code class="docutils literal notranslate"><span class="pre">animate_subframes()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.photo.html#mirage.photo.vis.plot_fits"><code class="docutils literal notranslate"><span class="pre">plot_fits()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="mirage.photo.html#module-mirage.photo">Module contents</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="mirage.sim.html">mirage.sim package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="mirage.sim.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="mirage.sim.html#module-mirage.sim.interp">mirage.sim.interp module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="mirage.sim.html#mirage.sim.interp.MLPBrightnessModel"><code class="docutils literal notranslate"><span class="pre">MLPBrightnessModel</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="mirage.sim.html#mirage.sim.interp.MLPBrightnessModel.brightness"><code class="docutils literal notranslate"><span class="pre">MLPBrightnessModel.brightness()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="mirage.sim.html#mirage.sim.interp.MLPBrightnessModel.eval"><code class="docutils literal notranslate"><span class="pre">MLPBrightnessModel.eval()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="mirage.sim.html#mirage.sim.interp.MLPBrightnessModel.gen_train_dataset"><code class="docutils literal notranslate"><span class="pre">MLPBrightnessModel.gen_train_dataset()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="mirage.sim.html#mirage.sim.interp.MLPBrightnessModel.load_from_file"><code class="docutils literal notranslate"><span class="pre">MLPBrightnessModel.load_from_file()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="mirage.sim.html#mirage.sim.interp.MLPBrightnessModel.save_to_file"><code class="docutils literal notranslate"><span class="pre">MLPBrightnessModel.save_to_file()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="mirage.sim.html#mirage.sim.interp.MLPBrightnessModel.train"><code class="docutils literal notranslate"><span class="pre">MLPBrightnessModel.train()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="mirage.sim.html#module-mirage.sim">Module contents</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="mirage.synth.html">mirage.synth package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="mirage.synth.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="mirage.synth.html#module-mirage.synth.synthetic">mirage.synth.synthetic module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="mirage.synth.html#mirage.synth.synthetic.camera_rmag_limits"><code class="docutils literal notranslate"><span class="pre">camera_rmag_limits()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.synth.html#mirage.synth.synthetic.generate_synthetic_dataset"><code class="docutils literal notranslate"><span class="pre">generate_synthetic_dataset()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.synth.html#mirage.synth.synthetic.generate_synthetic_sequence"><code class="docutils literal notranslate"><span class="pre">generate_synthetic_sequence()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.synth.html#mirage.synth.synthetic.key_model_points"><code class="docutils literal notranslate"><span class="pre">key_model_points()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.synth.html#mirage.synth.synthetic.key_point_visibility"><code class="docutils literal notranslate"><span class="pre">key_point_visibility()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.synth.html#mirage.synth.synthetic.model_parameters"><code class="docutils literal notranslate"><span class="pre">model_parameters()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.synth.html#mirage.synth.synthetic.order_key_points"><code class="docutils literal notranslate"><span class="pre">order_key_points()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.synth.html#mirage.synth.synthetic.random_camera_params"><code class="docutils literal notranslate"><span class="pre">random_camera_params()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.synth.html#mirage.synth.synthetic.zip_directory"><code class="docutils literal notranslate"><span class="pre">zip_directory()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="mirage.synth.html#module-mirage.synth">Module contents</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="mirage.tests.html">mirage.tests package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="mirage.tests.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="mirage.tests.html#module-mirage.tests.common">mirage.tests.common module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.common.by_3_strat"><code class="docutils literal notranslate"><span class="pre">by_3_strat()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.common.n_by_3_sphere_strat"><code class="docutils literal notranslate"><span class="pre">n_by_3_sphere_strat()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="mirage.tests.html#module-mirage.tests.test_albedo">mirage.tests.test_albedo module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_albedo.test_albedo_irradiance"><code class="docutils literal notranslate"><span class="pre">test_albedo_irradiance()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="mirage.tests.html#module-mirage.tests.test_attitude">mirage.tests.test_attitude module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_attitude.n_by_3_sphere_strat"><code class="docutils literal notranslate"><span class="pre">n_by_3_sphere_strat()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_attitude.test_cart_sph"><code class="docutils literal notranslate"><span class="pre">test_cart_sph()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_attitude.test_dcm_to_ea313"><code class="docutils literal notranslate"><span class="pre">test_dcm_to_ea313()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_attitude.test_dcm_to_mrp"><code class="docutils literal notranslate"><span class="pre">test_dcm_to_mrp()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_attitude.test_dcm_to_quat"><code class="docutils literal notranslate"><span class="pre">test_dcm_to_quat()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_attitude.test_mrp_to_quat"><code class="docutils literal notranslate"><span class="pre">test_mrp_to_quat()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_attitude.test_quat_inv"><code class="docutils literal notranslate"><span class="pre">test_quat_inv()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_attitude.test_rotation_dynamics"><code class="docutils literal notranslate"><span class="pre">test_rotation_dynamics()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_attitude.test_rv_add"><code class="docutils literal notranslate"><span class="pre">test_rv_add()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_attitude.test_rv_to_dcm"><code class="docutils literal notranslate"><span class="pre">test_rv_to_dcm()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_attitude.test_rv_to_mrp"><code class="docutils literal notranslate"><span class="pre">test_rv_to_mrp()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_attitude.test_rv_to_quat"><code class="docutils literal notranslate"><span class="pre">test_rv_to_quat()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_attitude.test_torque_free_propagation"><code class="docutils literal notranslate"><span class="pre">test_torque_free_propagation()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="mirage.tests.html#module-mirage.tests.test_coordinates">mirage.tests.test_coordinates module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_coordinates.test_date_to_gast"><code class="docutils literal notranslate"><span class="pre">test_date_to_gast()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_coordinates.test_date_to_gmst"><code class="docutils literal notranslate"><span class="pre">test_date_to_gmst()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_coordinates.test_date_to_julian_centuries"><code class="docutils literal notranslate"><span class="pre">test_date_to_julian_centuries()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_coordinates.test_delta_psi_delta_epsilon"><code class="docutils literal notranslate"><span class="pre">test_delta_psi_delta_epsilon()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_coordinates.test_gtod_to_tod"><code class="docutils literal notranslate"><span class="pre">test_gtod_to_tod()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_coordinates.test_itrf_to_gtod"><code class="docutils literal notranslate"><span class="pre">test_itrf_to_gtod()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_coordinates.test_itrf_to_j2000"><code class="docutils literal notranslate"><span class="pre">test_itrf_to_j2000()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_coordinates.test_j2000_to_itrf"><code class="docutils literal notranslate"><span class="pre">test_j2000_to_itrf()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_coordinates.test_mod_to_j2000"><code class="docutils literal notranslate"><span class="pre">test_mod_to_j2000()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_coordinates.test_tod_to_mod"><code class="docutils literal notranslate"><span class="pre">test_tod_to_mod()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_coordinates.test_ut1_minus_utc"><code class="docutils literal notranslate"><span class="pre">test_ut1_minus_utc()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="mirage.tests.html#module-mirage.tests.test_dataio">mirage.tests.test_dataio module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_dataio.test_download_data"><code class="docutils literal notranslate"><span class="pre">test_download_data()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="mirage.tests.html#module-mirage.tests.test_geodetic">mirage.tests.test_geodetic module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_geodetic.test_geoc_geod_lat_conversion"><code class="docutils literal notranslate"><span class="pre">test_geoc_geod_lat_conversion()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_geodetic.test_lat_lon_cell_area"><code class="docutils literal notranslate"><span class="pre">test_lat_lon_cell_area()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_geodetic.test_radius_at_geodetic_lat"><code class="docutils literal notranslate"><span class="pre">test_radius_at_geodetic_lat()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="mirage.tests.html#module-mirage.tests.test_lighting">mirage.tests.test_lighting module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_lighting.test_bad_brdf_name"><code class="docutils literal notranslate"><span class="pre">test_bad_brdf_name()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_lighting.test_energy_conservation"><code class="docutils literal notranslate"><span class="pre">test_energy_conservation()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_lighting.test_engine_run"><code class="docutils literal notranslate"><span class="pre">test_engine_run()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="mirage.tests.html#module-mirage.tests.test_math">mirage.tests.test_math module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_math.test_angle_between_deg"><code class="docutils literal notranslate"><span class="pre">test_angle_between_deg()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_math.test_angle_between_rad"><code class="docutils literal notranslate"><span class="pre">test_angle_between_rad()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_math.test_angle_wrapping"><code class="docutils literal notranslate"><span class="pre">test_angle_wrapping()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_math.test_cart_to_sph_and_back"><code class="docutils literal notranslate"><span class="pre">test_cart_to_sph_and_back()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_math.test_dms"><code class="docutils literal notranslate"><span class="pre">test_dms()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_math.test_hat_zeros"><code class="docutils literal notranslate"><span class="pre">test_hat_zeros()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_math.test_hms"><code class="docutils literal notranslate"><span class="pre">test_hms()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_math.test_nll"><code class="docutils literal notranslate"><span class="pre">test_nll()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_math.test_points_to_plane"><code class="docutils literal notranslate"><span class="pre">test_points_to_plane()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_math.test_tilde"><code class="docutils literal notranslate"><span class="pre">test_tilde()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_math.test_vecnorm_shape"><code class="docutils literal notranslate"><span class="pre">test_vecnorm_shape()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="mirage.tests.html#module-mirage.tests.test_modelio">mirage.tests.test_modelio module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_modelio.test_online_models"><code class="docutils literal notranslate"><span class="pre">test_online_models()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="mirage.tests.html#module-mirage.tests.test_orbit">mirage.tests.test_orbit module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_orbit.test_coe_to_rv_and_back"><code class="docutils literal notranslate"><span class="pre">test_coe_to_rv_and_back()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_orbit.test_gg_torque"><code class="docutils literal notranslate"><span class="pre">test_gg_torque()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_orbit.test_hifi_propagation"><code class="docutils literal notranslate"><span class="pre">test_hifi_propagation()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_orbit.test_j2_acc"><code class="docutils literal notranslate"><span class="pre">test_j2_acc()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="mirage.tests.html#module-mirage.tests.test_sampling">mirage.tests.test_sampling module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_sampling.test_rand_cone_vectors"><code class="docutils literal notranslate"><span class="pre">test_rand_cone_vectors()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_sampling.test_rand_points_in_shell"><code class="docutils literal notranslate"><span class="pre">test_rand_points_in_shell()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="mirage.tests.html#module-mirage.tests.test_spaceobject">mirage.tests.test_spaceobject module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_spaceobject.test_convex_inversion"><code class="docutils literal notranslate"><span class="pre">test_convex_inversion()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_spaceobject.test_download_model"><code class="docutils literal notranslate"><span class="pre">test_download_model()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_spaceobject.test_identifier_inits"><code class="docutils literal notranslate"><span class="pre">test_identifier_inits()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_spaceobject.test_is_convex"><code class="docutils literal notranslate"><span class="pre">test_is_convex()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_spaceobject.test_set_model_directory"><code class="docutils literal notranslate"><span class="pre">test_set_model_directory()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_spaceobject.test_spaceobject_init"><code class="docutils literal notranslate"><span class="pre">test_spaceobject_init()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_spaceobject.test_spaceobject_propagate"><code class="docutils literal notranslate"><span class="pre">test_spaceobject_propagate()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="mirage.tests.html#module-mirage.tests.test_station">mirage.tests.test_station module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_station.test_eci_az_el"><code class="docutils literal notranslate"><span class="pre">test_eci_az_el()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_station.test_light_curve_observation_runs"><code class="docutils literal notranslate"><span class="pre">test_light_curve_observation_runs()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_station.test_sky_brightness"><code class="docutils literal notranslate"><span class="pre">test_sky_brightness()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_station.test_station_altitude_references"><code class="docutils literal notranslate"><span class="pre">test_station_altitude_references()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_station.test_station_from_lat_lon"><code class="docutils literal notranslate"><span class="pre">test_station_from_lat_lon()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_station.test_station_from_presets"><code class="docutils literal notranslate"><span class="pre">test_station_from_presets()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_station.test_station_j2000"><code class="docutils literal notranslate"><span class="pre">test_station_j2000()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="mirage.tests.html#module-mirage.tests.test_time">mirage.tests.test_time module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_time.test_date_to_jd"><code class="docutils literal notranslate"><span class="pre">test_date_to_jd()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_time.test_date_to_sidereal"><code class="docutils literal notranslate"><span class="pre">test_date_to_sidereal()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.tests.html#mirage.tests.test_time.test_jd_date_round_trip"><code class="docutils literal notranslate"><span class="pre">test_jd_date_round_trip()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="mirage.tests.html#module-mirage.tests">Module contents</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="mirage.vis.html">mirage.vis package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="mirage.vis.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="mirage.vis.html#module-mirage.vis.visualization">mirage.vis.visualization module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="mirage.vis.html#mirage.vis.visualization.celestial_grid"><code class="docutils literal notranslate"><span class="pre">celestial_grid()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.vis.html#mirage.vis.visualization.earth_border_points"><code class="docutils literal notranslate"><span class="pre">earth_border_points()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.vis.html#mirage.vis.visualization.get_cbar_ax"><code class="docutils literal notranslate"><span class="pre">get_cbar_ax()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.vis.html#mirage.vis.visualization.orbit_plotter"><code class="docutils literal notranslate"><span class="pre">orbit_plotter()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.vis.html#mirage.vis.visualization.plot3"><code class="docutils literal notranslate"><span class="pre">plot3()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.vis.html#mirage.vis.visualization.plot_angle_between"><code class="docutils literal notranslate"><span class="pre">plot_angle_between()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.vis.html#mirage.vis.visualization.plot_arrow"><code class="docutils literal notranslate"><span class="pre">plot_arrow()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.vis.html#mirage.vis.visualization.plot_balltree"><code class="docutils literal notranslate"><span class="pre">plot_balltree()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.vis.html#mirage.vis.visualization.plot_basis"><code class="docutils literal notranslate"><span class="pre">plot_basis()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.vis.html#mirage.vis.visualization.plot_conic_sensor"><code class="docutils literal notranslate"><span class="pre">plot_conic_sensor()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.vis.html#mirage.vis.visualization.plot_egi"><code class="docutils literal notranslate"><span class="pre">plot_egi()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.vis.html#mirage.vis.visualization.plot_kdtree"><code class="docutils literal notranslate"><span class="pre">plot_kdtree()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.vis.html#mirage.vis.visualization.plot_map_with_grid"><code class="docutils literal notranslate"><span class="pre">plot_map_with_grid()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.vis.html#mirage.vis.visualization.plot_visible_band"><code class="docutils literal notranslate"><span class="pre">plot_visible_band()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.vis.html#mirage.vis.visualization.render_observation_scenario"><code class="docutils literal notranslate"><span class="pre">render_observation_scenario()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.vis.html#mirage.vis.visualization.render_spaceobject"><code class="docutils literal notranslate"><span class="pre">render_spaceobject()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.vis.html#mirage.vis.visualization.render_video"><code class="docutils literal notranslate"><span class="pre">render_video()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.vis.html#mirage.vis.visualization.scatter3"><code class="docutils literal notranslate"><span class="pre">scatter3()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.vis.html#mirage.vis.visualization.show_and_copy"><code class="docutils literal notranslate"><span class="pre">show_and_copy()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.vis.html#mirage.vis.visualization.texit"><code class="docutils literal notranslate"><span class="pre">texit()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.vis.html#mirage.vis.visualization.textured_ellipsoid"><code class="docutils literal notranslate"><span class="pre">textured_ellipsoid()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.vis.html#mirage.vis.visualization.two_sphere"><code class="docutils literal notranslate"><span class="pre">two_sphere()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.vis.html#mirage.vis.visualization.vis_attitude_motion"><code class="docutils literal notranslate"><span class="pre">vis_attitude_motion()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="mirage.vis.html#mirage.vis.visualization.wavelength_to_rgb"><code class="docutils literal notranslate"><span class="pre">wavelength_to_rgb()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="mirage.vis.html#module-mirage.vis">Module contents</a></li>
</ul>
</li>
</ul>
</div>
</section>
<section id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Link to this heading">#</a></h2>
</section>
<section id="module-mirage.albedo">
<span id="mirage-albedo-module"></span><h2>mirage.albedo module<a class="headerlink" href="#module-mirage.albedo" title="Link to this heading">#</a></h2>
<dl class="py function">
<dt class="sig sig-object py" id="mirage.albedo.albedo_irradiance">
<span class="sig-prename descclassname"><span class="pre">mirage.albedo.</span></span><span class="sig-name descname"><span class="pre">albedo_irradiance</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">date</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">datetime</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sat_pos_ecef</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#mirage.albedo.albedo_irradiance" title="Link to this definition">#</a></dt>
<dd><p>Computes the total irradiance reflected from the surface of Earth at a satellite [W/m^2]
The surface BRDF function used here is found in <a class="reference external" href="https://hal-mines-paristech.archives-ouvertes.fr/file/index/docid/1024989/filename/2014_igarss_albedo_blanc.pdf">Blanc 2014</a></p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>date</strong> (<em>datetime.datetime</em>) – Date to evaluate at (UTC)</p></li>
<li><p><strong>sat_pos_ecef</strong> (<em>np.ndarray</em>) – Position of the satellite in Earth-Centered Earth-Fixed coordianates (ex. ITRF)</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Total irradiance due to Earth albedo [W/m^2]</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>float</p>
</dd>
</dl>
</dd></dl>
</section>
<section id="module-mirage.attitude">
<span id="mirage-attitude-module"></span><h2>mirage.attitude module<a class="headerlink" href="#module-mirage.attitude" title="Link to this heading">#</a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="mirage.attitude.AlignedAndConstrainedAttitude">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mirage.attitude.</span></span><span class="sig-name descname"><span class="pre">AlignedAndConstrainedAttitude</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">v_align</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">v_const</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dates</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span><span class="p"><span class="pre">[</span></span><span class="pre">datetime</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">axis_order</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">(0,</span> <span class="pre">1,</span> <span class="pre">2)</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mirage.attitude.AlignedAndConstrainedAttitude" title="Link to this definition">#</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<dl class="py method">
<dt class="sig sig-object py" id="mirage.attitude.AlignedAndConstrainedAttitude.basis_vectors_at_dates">
<span class="sig-name descname"><span class="pre">basis_vectors_at_dates</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dates</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span><span class="p"><span class="pre">[</span></span><span class="pre">datetime</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">ndarray</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">ndarray</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">ndarray</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mirage.attitude.AlignedAndConstrainedAttitude.basis_vectors_at_dates" title="Link to this definition">#</a></dt>
<dd><p>Body basis vectors in inertial coordinates</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>dates</strong> (<em>np.ndarray</em><em>[</em><em>datetime.datetime</em><em>, </em><em>Any</em><em>] </em><em>[</em><em>n</em><em>,</em><em>]</em>) – Dates (UTC)</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>First, second, and third body basis vectors in inertial coordinates</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>tuple[np.ndarray, np.ndarray, np.ndarray]</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mirage.attitude.AlignedAndConstrainedAttitude.dcms_at_dates">
<span class="sig-name descname"><span class="pre">dcms_at_dates</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dates_or_jds</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span><span class="p"><span class="pre">[</span></span><span class="pre">datetime</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">ndarray</span></span></span><a class="headerlink" href="#mirage.attitude.AlignedAndConstrainedAttitude.dcms_at_dates" title="Link to this definition">#</a></dt>
<dd><p>DCM from inertial to body axes</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>dates_or_jds</strong> (<em>np.ndarray</em><em>[</em><em>Union</em><em>[</em><em>datetime.datetime</em><em>, </em><em>float</em><em>]</em><em>] </em><em>[</em><em>n</em><em>,</em><em>]</em>) – Dates or Julian dates (UTC)</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>DCM array</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>np.ndarray [3,3xn]</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mirage.attitude.AlignedAndConstrainedAttitude.propagate">
<span class="sig-name descname"><span class="pre">propagate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">epsecs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">ndarray</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">ndarray</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mirage.attitude.AlignedAndConstrainedAttitude.propagate" title="Link to this definition">#</a></dt>
<dd><p>Propagates the attitude profile to an array of epoch seconds</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>epsecs</strong> (<em>np.ndarray</em><em> [</em><em>n</em><em>,</em><em>]</em>) – Seconds after the definition epoch</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Quaternion and angular velocity [rad/s] at each requested time</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>tuple[np.ndarray [n,4], np.ndarray [n,3]]</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="mirage.attitude.AttitudeRepresentation">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mirage.attitude.</span></span><span class="sig-name descname"><span class="pre">AttitudeRepresentation</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">repr_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">components</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mirage.attitude.AttitudeRepresentation" title="Link to this definition">#</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<dl class="py method">
<dt class="sig sig-object py" id="mirage.attitude.AttitudeRepresentation.identity">
<span class="sig-name descname"><span class="pre">identity</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mirage.attitude.AttitudeRepresentation.identity" title="Link to this definition">#</a></dt>
<dd><p>Returns the identity element of <cite>SO3</cite> as the current representation type, if possible</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The identity element</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#mirage.attitude.AttitudeRepresentation" title="mirage.attitude.AttitudeRepresentation">AttitudeRepresentation</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mirage.attitude.AttitudeRepresentation.inverse">
<span class="sig-name descname"><span class="pre">inverse</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mirage.attitude.AttitudeRepresentation.inverse" title="Link to this definition">#</a></dt>
<dd><p>Returns the inverse of the attitude in the current representation via quaternions</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Inverse of the current attitude</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#mirage.attitude.AttitudeRepresentation" title="mirage.attitude.AttitudeRepresentation">AttitudeRepresentation</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mirage.attitude.AttitudeRepresentation.to">
<span class="sig-name descname"><span class="pre">to</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">target_repr_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mirage.attitude.AttitudeRepresentation.to" title="Link to this definition">#</a></dt>
<dd><p>Converts the attitude in <cite>self</cite> to a new representation</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>target_repr_name</strong> (<em>str</em>) – Name of the target representation name</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Coverted attitude representation</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#mirage.attitude.AttitudeRepresentation" title="mirage.attitude.AttitudeRepresentation">AttitudeRepresentation</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mirage.attitude.AttitudeRepresentation.to_upper_hemisphere">
<span class="sig-name descname"><span class="pre">to_upper_hemisphere</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mirage.attitude.AttitudeRepresentation.to_upper_hemisphere" title="Link to this definition">#</a></dt>
<dd><p>Transforms the attitude representation to the upper hemisphere of <span class="math notranslate nohighlight">\(S^3\)</span> via quaternions</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Upper hemisphere representation</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#mirage.attitude.AttitudeRepresentation" title="mirage.attitude.AttitudeRepresentation">AttitudeRepresentation</a></p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="mirage.attitude.RbtfAttitude">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mirage.attitude.</span></span><span class="sig-name descname"><span class="pre">RbtfAttitude</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">w0</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">q0</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">itensor</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mirage.attitude.RbtfAttitude" title="Link to this definition">#</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>Class for rigid body torque free attitude propatation
using accelerated semi-analytical solution with elliptic integrals</p>
<dl class="py method">
<dt class="sig sig-object py" id="mirage.attitude.RbtfAttitude.dcms_at_dates">
<span class="sig-name descname"><span class="pre">dcms_at_dates</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dates_or_jds</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span><span class="p"><span class="pre">[</span></span><span class="pre">datetime</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">ndarray</span></span></span><a class="headerlink" href="#mirage.attitude.RbtfAttitude.dcms_at_dates" title="Link to this definition">#</a></dt>
<dd><p>The direction cosine matrices for the orientation of this attitude profile at a set of datetimes or Julian dates</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>dates_or_jds</strong> (<em>np.ndarray</em><em>[</em><em>Union</em><em>[</em><em>datetime.datetime</em><em>, </em><em>float</em><em>]</em><em>]</em>) – Array of datetimes or Julian dates</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Stack of DCMs <span class="math notranslate nohighlight">\(A_i\)</span> which each transform inertial vectors into the body frame via multiplication on the left</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>np.ndarray [3,3xn]</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mirage.attitude.RbtfAttitude.propagate">
<span class="sig-name descname"><span class="pre">propagate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">epsec_space</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">ndarray</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">ndarray</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mirage.attitude.RbtfAttitude.propagate" title="Link to this definition">#</a></dt>
<dd><p>Propagates attitude forward to all epoch seconds</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>epsec_space</strong> (<em>np.ndarray</em>) – Seconds after the definition epoch to propagate to</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Orientation of body over time as a quaternion and body frame angular velocity</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Tuple[np.ndarray [n,4], np.ndarray [n,3]]</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="mirage.attitude.SpinStabilizedAttitude">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mirage.attitude.</span></span><span class="sig-name descname"><span class="pre">SpinStabilizedAttitude</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">rot_rate</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inertial_rot_axis</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">jd0</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rot_angle0</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mirage.attitude.SpinStabilizedAttitude" title="Link to this definition">#</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<dl class="py method">
<dt class="sig sig-object py" id="mirage.attitude.SpinStabilizedAttitude.basis_vectors_at_jds">
<span class="sig-name descname"><span class="pre">basis_vectors_at_jds</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">jd_eval</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">ndarray</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">ndarray</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">ndarray</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mirage.attitude.SpinStabilizedAttitude.basis_vectors_at_jds" title="Link to this definition">#</a></dt>
<dd><p>Returns the set of basis vectors in the inertial frame at a given Julian date, used for plotting</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>jd_eval</strong> (<em>np.ndarray</em><em> [</em><em>n</em><em>,</em><em>]</em>) – Julian dates to evaluate at</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Unit vector bases at each time</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Tuple[np.ndarray [n,3], np.ndarray [n,3], np.ndarray [n,3]]</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mirage.attitude.SpinStabilizedAttitude.dcms_at_dates">
<span class="sig-name descname"><span class="pre">dcms_at_dates</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dates_or_jds</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span><span class="p"><span class="pre">[</span></span><span class="pre">datetime</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">ndarray</span></span></span><a class="headerlink" href="#mirage.attitude.SpinStabilizedAttitude.dcms_at_dates" title="Link to this definition">#</a></dt>
<dd><p>DCM from inertial to body axes</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>dates_or_jds</strong> (<em>np.ndarray</em><em>[</em><em>Union</em><em>[</em><em>datetime.datetime</em><em>, </em><em>float</em><em>]</em><em>] </em><em>[</em><em>n</em><em>,</em><em>]</em>) – Dates or Julian dates to evaluate at (UTC)</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>DCMs</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>np.ndarray [3,3xn]</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mirage.attitude.SpinStabilizedAttitude.propagate">
<span class="sig-name descname"><span class="pre">propagate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">epsecs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">ndarray</span></span></span><a class="headerlink" href="#mirage.attitude.SpinStabilizedAttitude.propagate" title="Link to this definition">#</a></dt>
<dd><p>Propagates the attitude profile to an array of epoch seconds</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>epsecs</strong> (<em>np.ndarray</em><em> [</em><em>n</em><em>,</em><em>]</em>) – Seconds after the definition epoch</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Quaternion and angular velocity [rad/s] at each requested time</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>tuple[np.ndarray [n,4], np.ndarray [n,3]]</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="mirage.attitude.analytic_torque_free_angular_velocity">
<span class="sig-prename descclassname"><span class="pre">mirage.attitude.</span></span><span class="sig-name descname"><span class="pre">analytic_torque_free_angular_velocity</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">omega0</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">itensor</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">teval</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">itensor_org_factor</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">ndarray</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mirage.attitude.analytic_torque_free_angular_velocity" title="Link to this definition">#</a></dt>
<dd><p>Analytically propogates angular velocity assuming no torque is being applied</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>omega0</strong> (<em>np.ndarray</em><em> [</em><em>n</em><em>,</em><em>3</em><em>]</em>) – Initial angular velocity in body frame [rad/s]</p></li>
<li><p><strong>itensor</strong> (<em>np.ndarray</em><em> [</em><em>3</em><em>,</em><em>3</em><em>]</em>) – Principal moments of inertia satisfying <cite>i[3,3] < i[2,2] < i[1,1]</cite> [kg m^2]</p></li>
<li><p><strong>teval</strong> (<em>np.ndarray</em><em> [</em><em>n</em><em>,</em><em>]</em>) – Times to compute angular velocity for after initial state time [seconds]</p></li>
<li><p><strong>itensor_org_factor</strong> (<em>int</em><em>, </em><em>optional</em>) – If inertia tensor was reorganized with an even or odd number of flips, defaults to 1</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Angular velocity [rad/s]; <span class="math notranslate nohighlight">\(k^2\)</span> term of elliptic integral, <span class="math notranslate nohighlight">\(\tau_0\)</span>, <span class="math notranslate nohighlight">\(\dot{\tau}\)</span>; short-axis model (SAM) flag</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Tuple[np.ndarray [n,3], float, float, float, bool]</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="mirage.attitude.analytic_torque_free_attitude">
<span class="sig-prename descclassname"><span class="pre">mirage.attitude.</span></span><span class="sig-name descname"><span class="pre">analytic_torque_free_attitude</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">quat0</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">omega</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">itensor</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">teval</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ksquared</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tau0</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tau_dot</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_sam</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">itensor_org_factor</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">itensor_inv_inds</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">[0,</span> <span class="pre">1,</span> <span class="pre">2]</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">ndarray</span></span></span><a class="headerlink" href="#mirage.attitude.analytic_torque_free_attitude" title="Link to this definition">#</a></dt>
<dd><p>Analytically propagates orientation under torque-free rigid-body motion</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>quat0</strong> (<em>np.ndarray</em><em> [</em><em>4x1</em><em>]</em>) – Quaternion from the body frame to inertial at initial time step</p></li>
<li><p><strong>omega</strong> (<em>np.ndarray</em><em> [</em><em>n</em><em>,</em><em>3</em><em>]</em>) – Body angular velocities at each point in <cite>teval</cite> [rad/s]</p></li>
<li><p><strong>itensor</strong> (<em>np.ndarray</em><em> [</em><em>3</em><em>,</em><em>3</em><em>]</em>) – Principal inertia tensor satisfying <cite>itensor[0,0] <= itensor[1,1] <= itensor[2,2]</cite> [kg m^2]</p></li>
<li><p><strong>teval</strong> (<em>np.ndarray</em><em> [</em><em>n</em><em>,</em><em>]</em>) – Times to output attitude soliution at, <cite>teval[0]</cite> corresponds to <cite>quat0</cite> and <cite>omega[0,:]</cite></p></li>
<li><p><strong>ksquared</strong> (<em>float</em>) – <span class="math notranslate nohighlight">\(k^2\)</span> parameter from the angular velocity propagation</p></li>
<li><p><strong>tau0</strong> (<em>float</em>) – Initial value of :math:` au` from the angular velocity propagation</p></li>
<li><p><strong>tau_dot</strong> (<em>float</em>) – Rate of change of :math:` au` from the angular velocity propagation</p></li>
<li><p><strong>is_sam</strong> (<em>bool</em>) – Indicates the rotation mode. 0 = long-axis mode (LAM), 1 = short-axis mode (SAM)</p></li>
<li><p><strong>itensor_org_factor</strong> (<em>int</em><em>, </em><em>optional</em>) – Indicates if an even or odd number of flips was required to reorganize the inertia tensor, defaults to 1</p></li>
<li><p><strong>itensor_inv_inds</strong> (<em>list</em><em>, </em><em>optional</em>) – Inverse mapping from the user’s inertia tensor to the one used here, defaults to [0, 1, 2]</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Propagated quaternions at each time in <cite>teval</cite></p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>np.ndarray [n,]</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="mirage.attitude.davenport">
<span class="sig-prename descclassname"><span class="pre">mirage.attitude.</span></span><span class="sig-name descname"><span class="pre">davenport</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">rhat_body</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rhat_ref</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">ndarray</span></span></span><a class="headerlink" href="#mirage.attitude.davenport" title="Link to this definition">#</a></dt>
<dd><p>Computes the quaternion estimate of the attitude of a body using Davenport’s q-method.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>rhat_body</strong> (<em>np.ndarray</em><em> [</em><em>n</em><em>,</em><em>3</em><em>]</em>) – The unit vectors in the body frame</p></li>
<li><p><strong>rhat_ref</strong> (<em>np.ndarray</em><em> [</em><em>n</em><em>,</em><em>3</em><em>]</em>) – The same unit vectors in the reference frame</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Quaternion estimate of the attitude of the body</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>np.ndarray [4,1]</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="mirage.attitude.dcm_to_ea313">
<span class="sig-prename descclassname"><span class="pre">mirage.attitude.</span></span><span class="sig-name descname"><span class="pre">dcm_to_ea313</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dcm</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">ndarray</span></span></span><a class="headerlink" href="#mirage.attitude.dcm_to_ea313" title="Link to this definition">#</a></dt>
<dd><p>Finds the Euler angle (3-1-3) body frame sequence corresponding to the input direction cosine matrices</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>dcm</strong> (<em>np.ndarray</em><em> [</em><em>3</em><em>,</em><em>3xn</em><em>]</em>) – DCM array</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Euler angle array</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>np.ndarray [n,3]</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="mirage.attitude.dcm_to_mrp">
<span class="sig-prename descclassname"><span class="pre">mirage.attitude.</span></span><span class="sig-name descname"><span class="pre">dcm_to_mrp</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">c</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">ndarray</span></span></span><a class="headerlink" href="#mirage.attitude.dcm_to_mrp" title="Link to this definition">#</a></dt>
<dd><p>Converts direction cosine matrices to modified Rodrigues parameters via quaternions</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>c</strong> (<em>np.ndarray</em><em> [</em><em>3</em><em>,</em><em>3xn</em><em>]</em>) – Direction cosine matrix array</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>MRP array</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>np.ndarray [n,3]</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="mirage.attitude.dcm_to_quat">
<span class="sig-prename descclassname"><span class="pre">mirage.attitude.</span></span><span class="sig-name descname"><span class="pre">dcm_to_quat</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">c</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">ndarray</span></span></span><a class="headerlink" href="#mirage.attitude.dcm_to_quat" title="Link to this definition">#</a></dt>
<dd><p>Converts DCMs to quaternions using Sheppard’s method</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>c</strong> (<em>np.ndarray</em><em> [</em><em>3</em><em>,</em><em>3xn</em><em>]</em>) – Input DCM array</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Computed quaternions</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>np.ndarray [n,4]</p>
</dd>
</dl>
</dd></dl>