-
Notifications
You must be signed in to change notification settings - Fork 14
Expand file tree
/
Copy pathcalc.html
More file actions
1158 lines (936 loc) · 91.1 KB
/
calc.html
File metadata and controls
1158 lines (936 loc) · 91.1 KB
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>Module: calc — hklpy 1.1</title>
<script data-cfasync="false">
document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
document.documentElement.dataset.theme = localStorage.getItem("theme") || "";
</script>
<!--
this give us a css class that will be invisible only if js is disabled
-->
<noscript>
<style>
.pst-js-only { display: none !important; }
</style>
</noscript>
<!-- Loaded before other Sphinx assets -->
<link href="_static/styles/theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />
<link href="_static/styles/pydata-sphinx-theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=8f2a1f02" />
<link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=4ae1632d" />
<link rel="stylesheet" type="text/css" href="_static/tabs.css?v=a5c4661c" />
<link rel="stylesheet" type="text/css" href="_static/sphinx-design.min.css?v=95c83b7e" />
<!-- So that users can add custom icons -->
<script src="_static/scripts/fontawesome.js?digest=8878045cc6db502f8baf"></script>
<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />
<script src="_static/documentation_options.js?v=6f037312"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/design-tabs.js?v=f930bc37"></script>
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Module: configuration" href="configuration.html" />
<link rel="prev" title="API Reference" href="api.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="1.1" />
</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>
<dialog id="pst-search-dialog">
<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"
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>
</dialog>
<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">
<p class="title logo__title">hklpy 1.1</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="user_guide.html">
User Guide
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="install.html">
Install
</a>
</li>
<li class="nav-item current active">
<a class="nav-link nav-internal" href="api.html">
API Reference
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="release_notes.html">
Release History
</a>
</li>
</ul>
</nav></div>
</div>
<div class="navbar-header-items__end">
<div class="navbar-item navbar-persistent--container">
<button class="btn search-button-field search-button__button pst-js-only" 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>
</div>
<div class="navbar-item">
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings"></i>
</button></div>
</div>
</div>
<div class="navbar-persistent--mobile">
<button class="btn search-button-field search-button__button pst-js-only" 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>
</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">
<dialog id="pst-primary-sidebar-modal"></dialog>
<div id="pst-primary-sidebar" 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="user_guide.html">
User Guide
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="install.html">
Install
</a>
</li>
<li class="nav-item current active">
<a class="nav-link nav-internal" href="api.html">
API Reference
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="release_notes.html">
Release History
</a>
</li>
</ul>
</nav></div>
</div>
<div class="sidebar-header-items__end">
<div class="navbar-item">
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings"></i>
</button></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"><a class="current reference internal" href="#">Module: <code class="docutils literal notranslate"><span class="pre">calc</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="configuration.html">Module: <code class="docutils literal notranslate"><span class="pre">configuration</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="context.html">Module: <code class="docutils literal notranslate"><span class="pre">context</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="diffract.html">Module: <code class="docutils literal notranslate"><span class="pre">diffract</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="engine.html">Module: <code class="docutils literal notranslate"><span class="pre">engine</span></code></a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="geometries.html">Module: <code class="docutils literal notranslate"><span class="pre">geometries</span></code></a><details><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="geometry_tables.html">Diffractometer Geometries</a></li>
</ul>
</details></li>
<li class="toctree-l1"><a class="reference internal" href="sample.html">Module: <code class="docutils literal notranslate"><span class="pre">sample</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="user.html">Module: <code class="docutils literal notranslate"><span class="pre">user</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="util.html">Module: <code class="docutils literal notranslate"><span class="pre">util</span></code></a></li>
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
</ul>
</div>
</nav></div>
</div>
<div class="sidebar-primary-items__end sidebar-primary__section">
<div class="sidebar-primary-item">
<div id="ethical-ad-placement"
class="flat"
data-ea-publisher="readthedocs"
data-ea-type="readthedocs-sidebar"
data-ea-manual="true">
</div></div>
</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="api.html" class="nav-link">API Reference</a></li>
<li class="breadcrumb-item active" aria-current="page"><span class="ellipsis">Module: <code class="docutils literal notranslate"><span class="pre">calc</span></code></span></li>
</ul>
</nav>
</div>
</div>
</div>
</div>
<div id="searchbox"></div>
<article class="bd-article">
<section id="module-hkl.calc">
<span id="module-calc"></span><span id="calc"></span><h1>Module: <code class="docutils literal notranslate"><span class="pre">calc</span></code><a class="headerlink" href="#module-hkl.calc" title="Link to this heading">#</a></h1>
<p>Calculation support for diffractometers</p>
<div class="pst-scrollable-table-container"><table class="autosummary longtable table">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#hkl.calc.default_decision_function" title="hkl.calc.default_decision_function"><code class="xref py py-obj docutils literal notranslate"><span class="pre">default_decision_function</span></code></a>(position, solutions)</p></td>
<td><p>The default decision function - returns the first solution.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#hkl.calc.UnreachableError" title="hkl.calc.UnreachableError"><code class="xref py py-obj docutils literal notranslate"><span class="pre">UnreachableError</span></code></a>(msg, pseudo, physical)</p></td>
<td><p>Position is unreachable.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#hkl.calc.CalcRecip" title="hkl.calc.CalcRecip"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CalcRecip</span></code></a>(dtype[, engine, sample, lattice, ...])</p></td>
<td><p>Reciprocal space calculations</p></td>
</tr>
</tbody>
</table>
</div>
<p><strong>Specific Geometries</strong></p>
<div class="pst-scrollable-table-container"><table class="autosummary longtable table">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#hkl.calc.CalcApsPolar" title="hkl.calc.CalcApsPolar"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CalcApsPolar</span></code></a>(**kwargs)</p></td>
<td><p>Geometry: APS POLAR</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#hkl.calc.CalcE4CH" title="hkl.calc.CalcE4CH"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CalcE4CH</span></code></a>(**kwargs)</p></td>
<td><p>Geometry: E4CH</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#hkl.calc.CalcE4CV" title="hkl.calc.CalcE4CV"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CalcE4CV</span></code></a>(**kwargs)</p></td>
<td><p>Geometry: E4CV</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#hkl.calc.CalcE6C" title="hkl.calc.CalcE6C"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CalcE6C</span></code></a>(**kwargs)</p></td>
<td><p>Geometry: E6C</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#hkl.calc.CalcK4CV" title="hkl.calc.CalcK4CV"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CalcK4CV</span></code></a>(**kwargs)</p></td>
<td><p>Geometry: K4CV</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#hkl.calc.CalcK6C" title="hkl.calc.CalcK6C"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CalcK6C</span></code></a>(**kwargs)</p></td>
<td><p>Geometry: K6C</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#hkl.calc.CalcPetra3_p09_eh2" title="hkl.calc.CalcPetra3_p09_eh2"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CalcPetra3_p09_eh2</span></code></a>(**kwargs)</p></td>
<td><p>Geometry: PETRA3 P09 EH2</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#hkl.calc.CalcPetra3_p23_4c" title="hkl.calc.CalcPetra3_p23_4c"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CalcPetra3_p23_4c</span></code></a>(**kwargs)</p></td>
<td><p>Geometry: PETRA3 P23 4C</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#hkl.calc.CalcPetra3_p23_6c" title="hkl.calc.CalcPetra3_p23_6c"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CalcPetra3_p23_6c</span></code></a>(**kwargs)</p></td>
<td><p>Geometry: PETRA3 P23 6C</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#hkl.calc.CalcSoleilMars" title="hkl.calc.CalcSoleilMars"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CalcSoleilMars</span></code></a>(**kwargs)</p></td>
<td><p>Geometry: SOLEIL MARS</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#hkl.calc.CalcSoleilNanoscopiumRobot" title="hkl.calc.CalcSoleilNanoscopiumRobot"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CalcSoleilNanoscopiumRobot</span></code></a>(**kwargs)</p></td>
<td><p>Geometry: SOLEIL NANOSCOPIUM ROBOT</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#hkl.calc.CalcSoleilSiriusKappa" title="hkl.calc.CalcSoleilSiriusKappa"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CalcSoleilSiriusKappa</span></code></a>(**kwargs)</p></td>
<td><p>Geometry: SOLEIL SIRIUS KAPPA</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#hkl.calc.CalcSoleilSiriusTurret" title="hkl.calc.CalcSoleilSiriusTurret"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CalcSoleilSiriusTurret</span></code></a>(**kwargs)</p></td>
<td><p>Geometry: SOLEIL SIRIUS TURRET</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#hkl.calc.CalcSoleilSixsMed1p2" title="hkl.calc.CalcSoleilSixsMed1p2"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CalcSoleilSixsMed1p2</span></code></a>(**kwargs)</p></td>
<td><p>Geometry: SOLEIL SIXS MED1+2</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#hkl.calc.CalcSoleilSixsMed2p2" title="hkl.calc.CalcSoleilSixsMed2p2"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CalcSoleilSixsMed2p2</span></code></a>(**kwargs)</p></td>
<td><p>Geometry: SOLEIL SIXS MED2+2</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#hkl.calc.CalcSoleilSixsMed2p3" title="hkl.calc.CalcSoleilSixsMed2p3"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CalcSoleilSixsMed2p3</span></code></a>(**kwargs)</p></td>
<td><p>Geometry: SOLEIL SIXS MED2+3</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">CalcSoleilSixsMed2p3v2</span></code>(**kwargs)</p></td>
<td><p>Geometry: SOLEIL SIXS MED2+3 v2</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#hkl.calc.CalcZaxis" title="hkl.calc.CalcZaxis"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CalcZaxis</span></code></a>(**kwargs)</p></td>
<td><p>Geometry: ZAXIS</p></td>
</tr>
</tbody>
</table>
</div>
<dl class="py class">
<dt class="sig sig-object py" id="hkl.calc.CalcApsPolar">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">hkl.calc.</span></span><span class="sig-name descname"><span class="pre">CalcApsPolar</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/hkl/calc.html#CalcApsPolar"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#hkl.calc.CalcApsPolar" title="Link to this definition">#</a></dt>
<dd><p>Geometry: APS POLAR</p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="hkl.calc.CalcE4CH">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">hkl.calc.</span></span><span class="sig-name descname"><span class="pre">CalcE4CH</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/hkl/calc.html#CalcE4CH"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#hkl.calc.CalcE4CH" title="Link to this definition">#</a></dt>
<dd><p>Geometry: E4CH</p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="hkl.calc.CalcE4CV">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">hkl.calc.</span></span><span class="sig-name descname"><span class="pre">CalcE4CV</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/hkl/calc.html#CalcE4CV"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#hkl.calc.CalcE4CV" title="Link to this definition">#</a></dt>
<dd><p>Geometry: E4CV</p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="hkl.calc.CalcE6C">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">hkl.calc.</span></span><span class="sig-name descname"><span class="pre">CalcE6C</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/hkl/calc.html#CalcE6C"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#hkl.calc.CalcE6C" title="Link to this definition">#</a></dt>
<dd><p>Geometry: E6C</p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="hkl.calc.CalcK4CV">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">hkl.calc.</span></span><span class="sig-name descname"><span class="pre">CalcK4CV</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/hkl/calc.html#CalcK4CV"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#hkl.calc.CalcK4CV" title="Link to this definition">#</a></dt>
<dd><p>Geometry: K4CV</p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="hkl.calc.CalcK6C">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">hkl.calc.</span></span><span class="sig-name descname"><span class="pre">CalcK6C</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/hkl/calc.html#CalcK6C"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#hkl.calc.CalcK6C" title="Link to this definition">#</a></dt>
<dd><p>Geometry: K6C</p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="hkl.calc.CalcPetra3_p09_eh2">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">hkl.calc.</span></span><span class="sig-name descname"><span class="pre">CalcPetra3_p09_eh2</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/hkl/calc.html#CalcPetra3_p09_eh2"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#hkl.calc.CalcPetra3_p09_eh2" title="Link to this definition">#</a></dt>
<dd><p>Geometry: PETRA3 P09 EH2</p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="hkl.calc.CalcPetra3_p23_4c">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">hkl.calc.</span></span><span class="sig-name descname"><span class="pre">CalcPetra3_p23_4c</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/hkl/calc.html#CalcPetra3_p23_4c"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#hkl.calc.CalcPetra3_p23_4c" title="Link to this definition">#</a></dt>
<dd><p>Geometry: PETRA3 P23 4C</p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="hkl.calc.CalcPetra3_p23_6c">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">hkl.calc.</span></span><span class="sig-name descname"><span class="pre">CalcPetra3_p23_6c</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/hkl/calc.html#CalcPetra3_p23_6c"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#hkl.calc.CalcPetra3_p23_6c" title="Link to this definition">#</a></dt>
<dd><p>Geometry: PETRA3 P23 6C</p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="hkl.calc.CalcRecip">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">hkl.calc.</span></span><span class="sig-name descname"><span class="pre">CalcRecip</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dtype</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">engine</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'hkl'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sample</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'main'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lattice</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">degrees</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">units</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'user'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lock_engine</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inverted_axes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/hkl/calc.html#CalcRecip"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#hkl.calc.CalcRecip" title="Link to this definition">#</a></dt>
<dd><p>Reciprocal space calculations</p>
<div class="pst-scrollable-table-container"><table class="autosummary longtable table">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#hkl.calc.CalcRecip.add_sample" title="hkl.calc.CalcRecip.add_sample"><code class="xref py py-obj docutils literal notranslate"><span class="pre">add_sample</span></code></a>(sample[, select])</p></td>
<td><p>Add an HklSample</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#hkl.calc.CalcRecip.calc_linear_path" title="hkl.calc.CalcRecip.calc_linear_path"><code class="xref py py-obj docutils literal notranslate"><span class="pre">calc_linear_path</span></code></a>(start, end, n[, num_params])</p></td>
<td><p>Construct a trajectory from start to end with n steps (n+1 points).</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#hkl.calc.CalcRecip.energy" title="hkl.calc.CalcRecip.energy"><code class="xref py py-obj docutils literal notranslate"><span class="pre">energy</span></code></a></p></td>
<td><p>The energy associated with the geometry, in keV</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#hkl.calc.CalcRecip.engine" title="hkl.calc.CalcRecip.engine"><code class="xref py py-obj docutils literal notranslate"><span class="pre">engine</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#hkl.calc.CalcRecip.engine_locked" title="hkl.calc.CalcRecip.engine_locked"><code class="xref py py-obj docutils literal notranslate"><span class="pre">engine_locked</span></code></a></p></td>
<td><p>If set, do not allow the engine to be changed post-initialization</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#hkl.calc.CalcRecip.engines" title="hkl.calc.CalcRecip.engines"><code class="xref py py-obj docutils literal notranslate"><span class="pre">engines</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#hkl.calc.CalcRecip.forward" title="hkl.calc.CalcRecip.forward"><code class="xref py py-obj docutils literal notranslate"><span class="pre">forward</span></code></a>(position[, engine])</p></td>
<td><p>Calculate real positions from pseudo positions.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#hkl.calc.CalcRecip.forward_iter" title="hkl.calc.CalcRecip.forward_iter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">forward_iter</span></code></a>(start, end, max_iters, *[, ...])</p></td>
<td><p>Iteratively attempt to go from a pseudo start -> end position</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#hkl.calc.CalcRecip.geometry_name" title="hkl.calc.CalcRecip.geometry_name"><code class="xref py py-obj docutils literal notranslate"><span class="pre">geometry_name</span></code></a></p></td>
<td><p>Name of this geometry, as defined in <strong>libhkl</strong>.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#hkl.calc.CalcRecip.geometry_table" title="hkl.calc.CalcRecip.geometry_table"><code class="xref py py-obj docutils literal notranslate"><span class="pre">geometry_table</span></code></a>([rst])</p></td>
<td><p>Describe this geometry in a table.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#hkl.calc.CalcRecip.get_path" title="hkl.calc.CalcRecip.get_path"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_path</span></code></a>(start[, end, n, path_type])</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#hkl.calc.CalcRecip.inverse" title="hkl.calc.CalcRecip.inverse"><code class="xref py py-obj docutils literal notranslate"><span class="pre">inverse</span></code></a>(real)</p></td>
<td><p>Calculate pseudo positions from real positions.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#hkl.calc.CalcRecip.inverted_axes" title="hkl.calc.CalcRecip.inverted_axes"><code class="xref py py-obj docutils literal notranslate"><span class="pre">inverted_axes</span></code></a></p></td>
<td><p>The physical axis names to invert</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#hkl.calc.CalcRecip.new_sample" title="hkl.calc.CalcRecip.new_sample"><code class="xref py py-obj docutils literal notranslate"><span class="pre">new_sample</span></code></a>(name[, select])</p></td>
<td><p>Convenience function to add a sample by name</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#hkl.calc.CalcRecip.parameters" title="hkl.calc.CalcRecip.parameters"><code class="xref py py-obj docutils literal notranslate"><span class="pre">parameters</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#hkl.calc.CalcRecip.physical_axes" title="hkl.calc.CalcRecip.physical_axes"><code class="xref py py-obj docutils literal notranslate"><span class="pre">physical_axes</span></code></a></p></td>
<td><p>Physical (real) motor positions as an OrderedDict</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#hkl.calc.CalcRecip.physical_axis_names" title="hkl.calc.CalcRecip.physical_axis_names"><code class="xref py py-obj docutils literal notranslate"><span class="pre">physical_axis_names</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#hkl.calc.CalcRecip.physical_positions" title="hkl.calc.CalcRecip.physical_positions"><code class="xref py py-obj docutils literal notranslate"><span class="pre">physical_positions</span></code></a></p></td>
<td><p>Physical (real) motor positions</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#hkl.calc.CalcRecip.Position" title="hkl.calc.CalcRecip.Position"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Position</span></code></a></p></td>
<td><p>Dynamically-generated physical motor position class</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#hkl.calc.CalcRecip.pseudo_axes" title="hkl.calc.CalcRecip.pseudo_axes"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pseudo_axes</span></code></a></p></td>
<td><p>Ordered dictionary of axis name to position</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#hkl.calc.CalcRecip.pseudo_axis_names" title="hkl.calc.CalcRecip.pseudo_axis_names"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pseudo_axis_names</span></code></a></p></td>
<td><p>Pseudo axis names from the current engine</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#hkl.calc.CalcRecip.pseudo_positions" title="hkl.calc.CalcRecip.pseudo_positions"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pseudo_positions</span></code></a></p></td>
<td><p>Pseudo axis positions/values from the current engine</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#hkl.calc.CalcRecip.sample" title="hkl.calc.CalcRecip.sample"><code class="xref py py-obj docutils literal notranslate"><span class="pre">sample</span></code></a></p></td>
<td><p>Currently selected sample.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#hkl.calc.CalcRecip.sample_name" title="hkl.calc.CalcRecip.sample_name"><code class="xref py py-obj docutils literal notranslate"><span class="pre">sample_name</span></code></a></p></td>
<td><p>The name of the currently selected sample.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#hkl.calc.CalcRecip.units" title="hkl.calc.CalcRecip.units"><code class="xref py py-obj docutils literal notranslate"><span class="pre">units</span></code></a></p></td>
<td><p>The units used for calculations</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#hkl.calc.CalcRecip.update" title="hkl.calc.CalcRecip.update"><code class="xref py py-obj docutils literal notranslate"><span class="pre">update</span></code></a>()</p></td>
<td><p>Calculate the pseudo axis positions from the real axis positions</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#hkl.calc.CalcRecip.wavelength" title="hkl.calc.CalcRecip.wavelength"><code class="xref py py-obj docutils literal notranslate"><span class="pre">wavelength</span></code></a></p></td>
<td><p>The wavelength associated with the geometry, in angstrom</p></td>
</tr>
</tbody>
</table>
</div>
<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>dtype</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a>) – Diffractometer type (usually specified by a subclass)</p></li>
<li><p><strong>engine</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a><em>, </em><em>optional</em>) – ‘hkl’, for example</p></li>
<li><p><strong>sample</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a><em>, </em><em>optional</em>) – Default sample name (default: ‘main’)</p></li>
<li><p><strong>lattice</strong> (<em>Lattice</em><em>, </em><em>optional</em>) – Lattice to use with the default sample</p></li>
<li><p><strong>degrees</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><em>bool</em></a><em>, </em><em>optional</em>) – Use degrees instead of radians (default: True)</p></li>
<li><p><strong>units</strong> (<em>{'user'</em><em>, </em><em>}</em>) – The type of units to use internally</p></li>
<li><p><strong>lock_engine</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><em>bool</em></a><em>, </em><em>optional</em>) – Don’t allow the engine to be changed during
the life of this object</p></li>
<li><p><strong>inverted_axes</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.13)"><em>list</em></a><em>, </em><em>optional</em>) – Names of axes to invert the sign</p></li>
</ul>
</dd>
</dl>
<dl class="py property">
<dt class="sig sig-object py" id="hkl.calc.CalcRecip.Position">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Position</span></span><a class="headerlink" href="#hkl.calc.CalcRecip.Position" title="Link to this definition">#</a></dt>
<dd><p>Dynamically-generated physical motor position class</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="hkl.calc.CalcRecip._canonical2user">
<span class="sig-name descname"><span class="pre">_canonical2user</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">canonical</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/hkl/calc.html#CalcRecip._canonical2user"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#hkl.calc.CalcRecip._canonical2user" title="Link to this definition">#</a></dt>
<dd><p>Convert canonical axis names to user (renames).</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="hkl.calc.CalcRecip._cfg_reciprocal">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">_cfg_reciprocal</span></span><a class="headerlink" href="#hkl.calc.CalcRecip._cfg_reciprocal" title="Link to this definition">#</a></dt>
<dd><p>Return reciprocal lattice to save as configuration.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="hkl.calc.CalcRecip._get_axis_by_name">
<span class="sig-name descname"><span class="pre">_get_axis_by_name</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/hkl/calc.html#CalcRecip._get_axis_by_name"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#hkl.calc.CalcRecip._get_axis_by_name" title="Link to this definition">#</a></dt>
<dd><p>Given an axis name, return the HklParameter</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a>) – If a name map is specified, this is the mapped name.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="hkl.calc.CalcRecip._get_path_fcn">
<span class="sig-name descname"><span class="pre">_get_path_fcn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path_type</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/hkl/calc.html#CalcRecip._get_path_fcn"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#hkl.calc.CalcRecip._get_path_fcn" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="hkl.calc.CalcRecip._get_sample">
<span class="sig-name descname"><span class="pre">_get_sample</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/hkl/calc.html#CalcRecip._get_sample"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#hkl.calc.CalcRecip._get_sample" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="hkl.calc.CalcRecip._invert_physical_positions">
<span class="sig-name descname"><span class="pre">_invert_physical_positions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pos</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/hkl/calc.html#CalcRecip._invert_physical_positions"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#hkl.calc.CalcRecip._invert_physical_positions" title="Link to this definition">#</a></dt>
<dd><p>Invert the physical axis positions based on the settings</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>pos</strong> (<em>OrderedDict</em>) – NOTE: Modified in-place</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="hkl.calc.CalcRecip._re_init">
<span class="sig-name descname"><span class="pre">_re_init</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/hkl/calc.html#CalcRecip._re_init"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#hkl.calc.CalcRecip._re_init" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="hkl.calc.CalcRecip._repr_info">
<span class="sig-name descname"><span class="pre">_repr_info</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/hkl/calc.html#CalcRecip._repr_info"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#hkl.calc.CalcRecip._repr_info" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="hkl.calc.CalcRecip.add_sample">
<span class="sig-name descname"><span class="pre">add_sample</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sample</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">select</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/hkl/calc.html#CalcRecip.add_sample"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#hkl.calc.CalcRecip.add_sample" title="Link to this definition">#</a></dt>
<dd><p>Add an HklSample</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>sample</strong> (<em>HklSample instance</em>) – The sample name, or optionally an already-created HklSample
instance</p></li>
<li><p><strong>select</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><em>bool</em></a><em>, </em><em>optional</em>) – Select the sample to focus calculations on</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="hkl.calc.CalcRecip.axes_c">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">axes_c</span></span><a class="headerlink" href="#hkl.calc.CalcRecip.axes_c" title="Link to this definition">#</a></dt>
<dd><p>User-defined real-space axes held constant during forward() calculation.</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="hkl.calc.CalcRecip.axes_r">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">axes_r</span></span><a class="headerlink" href="#hkl.calc.CalcRecip.axes_r" title="Link to this definition">#</a></dt>
<dd><p>User-defined real-space axes used for forward() calculation.</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="hkl.calc.CalcRecip.axes_w">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">axes_w</span></span><a class="headerlink" href="#hkl.calc.CalcRecip.axes_w" title="Link to this definition">#</a></dt>
<dd><p>User-defined real-space axes written by forward() calculation.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="hkl.calc.CalcRecip.calc_linear_path">
<span class="sig-name descname"><span class="pre">calc_linear_path</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">start</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">end</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">n</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">num_params</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/hkl/calc.html#CalcRecip.calc_linear_path"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#hkl.calc.CalcRecip.calc_linear_path" title="Link to this definition">#</a></dt>
<dd><p>Construct a trajectory from start to end with n steps (n+1 points).</p>
<p>Example (for <code class="docutils literal notranslate"><span class="pre">hkl</span></code> engine):</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">e4cv</span><span class="o">.</span><span class="n">calc</span><span class="o">.</span><span class="n">calc_linear_path</span><span class="p">((</span><span class="mi">1</span><span class="p">,</span><span class="mi">1</span><span class="p">,</span><span class="mi">0</span><span class="p">),</span> <span class="p">(</span><span class="mi">1</span><span class="p">,</span><span class="o">-</span><span class="mi">1</span><span class="p">,</span><span class="mi">0</span><span class="p">),</span> <span class="mi">4</span><span class="p">,</span> <span class="n">num_params</span><span class="o">=</span><span class="mi">3</span><span class="p">)</span>
<span class="go">[(1.0, 1.0, 0.0),</span>
<span class="go">(1.0, 0.5, 0.0),</span>
<span class="go">(1.0, 0.0, 0.0),</span>
<span class="go">(1.0, -0.5, 0.0),</span>
<span class="go">(1.0, -1.0, 0.0)]</span>
</pre></div>
</div>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="hkl.calc.CalcRecip.energy">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">energy</span></span><a class="headerlink" href="#hkl.calc.CalcRecip.energy" title="Link to this definition">#</a></dt>
<dd><p>The energy associated with the geometry, in keV</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="hkl.calc.CalcRecip.engine">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">engine</span></span><a class="headerlink" href="#hkl.calc.CalcRecip.engine" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="hkl.calc.CalcRecip.engine_locked">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">engine_locked</span></span><a class="headerlink" href="#hkl.calc.CalcRecip.engine_locked" title="Link to this definition">#</a></dt>
<dd><p>If set, do not allow the engine to be changed post-initialization</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="hkl.calc.CalcRecip.engines">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">engines</span></span><a class="headerlink" href="#hkl.calc.CalcRecip.engines" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="hkl.calc.CalcRecip.forward">
<span class="sig-name descname"><span class="pre">forward</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">position</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">engine</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/hkl/calc.html#CalcRecip.forward"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#hkl.calc.CalcRecip.forward" title="Link to this definition">#</a></dt>
<dd><p>Calculate real positions from pseudo positions.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="hkl.calc.CalcRecip.forward_iter">
<span class="sig-name descname"><span class="pre">forward_iter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">start</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">end</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_iters</span></span></em>, <em class="sig-param"><span class="keyword-only-separator o"><abbr title="Keyword-only parameters separator (PEP 3102)"><span class="pre">*</span></abbr></span></em>, <em class="sig-param"><span class="n"><span class="pre">threshold</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.99</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">decision_fcn</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/hkl/calc.html#CalcRecip.forward_iter"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#hkl.calc.CalcRecip.forward_iter" title="Link to this definition">#</a></dt>
<dd><p>Iteratively attempt to go from a pseudo start -> end position</p>
<p>For every solution failure, the position is moved back.
For every success, the position is moved closer to the destination.</p>
<p>After up to max_iters, the position can be reached, the solutions will
be returned. Otherwise, ValueError will be raised stating the last
position that was reachable and the corresponding motor positions.</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>start</strong> (<em>Position</em>)</p></li>
<li><p><strong>end</strong> (<em>Position</em>)</p></li>
<li><p><strong>max_iters</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a>) – Maximum number of iterations</p></li>
<li><p><strong>threshold</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.13)"><em>float</em></a><em>, </em><em>optional</em>) – Normalized proximity to <cite>end</cite> position to stop iterating</p></li>
<li><p><strong>decision_fcn</strong> (<em>callable</em><em>, </em><em>optional</em>) – <p>Function to choose a solution from several. Defaults to picking the
first solution. Here is the default <code class="docutils literal notranslate"><span class="pre">decision_fcn()</span></code>:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">def</span><span class="w"> </span><span class="nf">decision</span><span class="p">(</span><span class="n">pseudo_position</span><span class="p">,</span> <span class="n">solution_list</span><span class="p">):</span>
<span class="k">return</span> <span class="n">solution_list</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
</pre></div>
</div>
</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p><strong>solutions</strong></p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.13)">list</a></p>
</dd>
<dt class="field-even">Raises<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#hkl.calc.UnreachableError" title="hkl.calc.UnreachableError"><strong>UnreachableError</strong></a><strong> (</strong><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ValueError" title="(in Python v3.13)"><strong>ValueError</strong></a><strong>)</strong> – Position cannot be reached
The last valid HKL position and motor positions are accessible
in this exception instance.</p>
</dd>
</dl>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="hkl.calc.CalcRecip.geometry_name">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">geometry_name</span></span><a class="headerlink" href="#hkl.calc.CalcRecip.geometry_name" title="Link to this definition">#</a></dt>
<dd><p>Name of this geometry, as defined in <strong>libhkl</strong>.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="hkl.calc.CalcRecip.geometry_table">
<span class="sig-name descname"><span class="pre">geometry_table</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">rst</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/hkl/calc.html#CalcRecip.geometry_table"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#hkl.calc.CalcRecip.geometry_table" title="Link to this definition">#</a></dt>
<dd><p>Describe this geometry in a table.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>rst</strong> (<em>bool</em>) – When True, format using restructured text. Otherwise,
use a simpler representation</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="hkl.calc.CalcRecip.get_path">
<span class="sig-name descname"><span class="pre">get_path</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">start</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">end</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">n</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">100</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'linear'</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/hkl/calc.html#CalcRecip.get_path"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#hkl.calc.CalcRecip.get_path" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="hkl.calc.CalcRecip.inverse">
<span class="sig-name descname"><span class="pre">inverse</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">real</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/hkl/calc.html#CalcRecip.inverse"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#hkl.calc.CalcRecip.inverse" title="Link to this definition">#</a></dt>
<dd><p>Calculate pseudo positions from real positions.</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="hkl.calc.CalcRecip.inverted_axes">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">inverted_axes</span></span><a class="headerlink" href="#hkl.calc.CalcRecip.inverted_axes" title="Link to this definition">#</a></dt>
<dd><p>The physical axis names to invert</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="hkl.calc.CalcRecip.new_sample">
<span class="sig-name descname"><span class="pre">new_sample</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">select</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/hkl/calc.html#CalcRecip.new_sample"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#hkl.calc.CalcRecip.new_sample" title="Link to this definition">#</a></dt>
<dd><p>Convenience function to add a sample by name</p>
<p>Keyword arguments are passed to the new HklSample initializer.</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>name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a>) – The sample name</p></li>
<li><p><strong>select</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><em>bool</em></a><em>, </em><em>optional</em>) – Select the sample to focus calculations on</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="hkl.calc.CalcRecip.parameters">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parameters</span></span><a class="headerlink" href="#hkl.calc.CalcRecip.parameters" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="hkl.calc.CalcRecip.physical_axes">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">physical_axes</span></span><a class="headerlink" href="#hkl.calc.CalcRecip.physical_axes" title="Link to this definition">#</a></dt>
<dd><p>Physical (real) motor positions as an OrderedDict</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="hkl.calc.CalcRecip.physical_axis_names">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">physical_axis_names</span></span><a class="headerlink" href="#hkl.calc.CalcRecip.physical_axis_names" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="hkl.calc.CalcRecip.physical_positions">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">physical_positions</span></span><a class="headerlink" href="#hkl.calc.CalcRecip.physical_positions" title="Link to this definition">#</a></dt>
<dd><p>Physical (real) motor positions</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="hkl.calc.CalcRecip.pseudo_axes">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">pseudo_axes</span></span><a class="headerlink" href="#hkl.calc.CalcRecip.pseudo_axes" title="Link to this definition">#</a></dt>
<dd><p>Ordered dictionary of axis name to position</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="hkl.calc.CalcRecip.pseudo_axis_names">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">pseudo_axis_names</span></span><a class="headerlink" href="#hkl.calc.CalcRecip.pseudo_axis_names" title="Link to this definition">#</a></dt>
<dd><p>Pseudo axis names from the current engine</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="hkl.calc.CalcRecip.pseudo_positions">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">pseudo_positions</span></span><a class="headerlink" href="#hkl.calc.CalcRecip.pseudo_positions" title="Link to this definition">#</a></dt>
<dd><p>Pseudo axis positions/values from the current engine</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="hkl.calc.CalcRecip.sample">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">sample</span></span><a class="headerlink" href="#hkl.calc.CalcRecip.sample" title="Link to this definition">#</a></dt>
<dd><p>Currently selected sample.</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="hkl.calc.CalcRecip.sample_name">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">sample_name</span></span><a class="headerlink" href="#hkl.calc.CalcRecip.sample_name" title="Link to this definition">#</a></dt>
<dd><p>The name of the currently selected sample.</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="hkl.calc.CalcRecip.units">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">units</span></span><a class="headerlink" href="#hkl.calc.CalcRecip.units" title="Link to this definition">#</a></dt>
<dd><p>The units used for calculations</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="hkl.calc.CalcRecip.update">
<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/hkl/calc.html#CalcRecip.update"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#hkl.calc.CalcRecip.update" title="Link to this definition">#</a></dt>
<dd><p>Calculate the pseudo axis positions from the real axis positions</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="hkl.calc.CalcRecip.wavelength">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">wavelength</span></span><a class="headerlink" href="#hkl.calc.CalcRecip.wavelength" title="Link to this definition">#</a></dt>
<dd><p>The wavelength associated with the geometry, in angstrom</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="hkl.calc.CalcSoleilMars">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">hkl.calc.</span></span><span class="sig-name descname"><span class="pre">CalcSoleilMars</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/hkl/calc.html#CalcSoleilMars"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#hkl.calc.CalcSoleilMars" title="Link to this definition">#</a></dt>
<dd><p>Geometry: SOLEIL MARS</p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="hkl.calc.CalcSoleilNanoscopiumRobot">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">hkl.calc.</span></span><span class="sig-name descname"><span class="pre">CalcSoleilNanoscopiumRobot</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/hkl/calc.html#CalcSoleilNanoscopiumRobot"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#hkl.calc.CalcSoleilNanoscopiumRobot" title="Link to this definition">#</a></dt>
<dd><p>Geometry: SOLEIL NANOSCOPIUM ROBOT</p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="hkl.calc.CalcSoleilSiriusKappa">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">hkl.calc.</span></span><span class="sig-name descname"><span class="pre">CalcSoleilSiriusKappa</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/hkl/calc.html#CalcSoleilSiriusKappa"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#hkl.calc.CalcSoleilSiriusKappa" title="Link to this definition">#</a></dt>
<dd><p>Geometry: SOLEIL SIRIUS KAPPA</p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="hkl.calc.CalcSoleilSiriusTurret">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">hkl.calc.</span></span><span class="sig-name descname"><span class="pre">CalcSoleilSiriusTurret</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/hkl/calc.html#CalcSoleilSiriusTurret"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#hkl.calc.CalcSoleilSiriusTurret" title="Link to this definition">#</a></dt>
<dd><p>Geometry: SOLEIL SIRIUS TURRET</p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="hkl.calc.CalcSoleilSixsMed1p2">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">hkl.calc.</span></span><span class="sig-name descname"><span class="pre">CalcSoleilSixsMed1p2</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/hkl/calc.html#CalcSoleilSixsMed1p2"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#hkl.calc.CalcSoleilSixsMed1p2" title="Link to this definition">#</a></dt>
<dd><p>Geometry: SOLEIL SIXS MED1+2</p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="hkl.calc.CalcSoleilSixsMed2p2">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">hkl.calc.</span></span><span class="sig-name descname"><span class="pre">CalcSoleilSixsMed2p2</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/hkl/calc.html#CalcSoleilSixsMed2p2"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#hkl.calc.CalcSoleilSixsMed2p2" title="Link to this definition">#</a></dt>
<dd><p>Geometry: SOLEIL SIXS MED2+2</p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="hkl.calc.CalcSoleilSixsMed2p3">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">hkl.calc.</span></span><span class="sig-name descname"><span class="pre">CalcSoleilSixsMed2p3</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/hkl/calc.html#CalcSoleilSixsMed2p3"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#hkl.calc.CalcSoleilSixsMed2p3" title="Link to this definition">#</a></dt>
<dd><p>Geometry: SOLEIL SIXS MED2+3</p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="hkl.calc.CalcZaxis">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">hkl.calc.</span></span><span class="sig-name descname"><span class="pre">CalcZaxis</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/hkl/calc.html#CalcZaxis"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#hkl.calc.CalcZaxis" title="Link to this definition">#</a></dt>
<dd><p>Geometry: ZAXIS</p>
</dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="hkl.calc.UnreachableError">
<em class="property"><span class="k"><span class="pre">exception</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">hkl.calc.</span></span><span class="sig-name descname"><span class="pre">UnreachableError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">msg</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pseudo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">physical</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/hkl/calc.html#UnreachableError"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#hkl.calc.UnreachableError" title="Link to this definition">#</a></dt>
<dd><p>Position is unreachable.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="hkl.calc.UnreachableError.pseudo">
<span class="sig-name descname"><span class="pre">pseudo</span></span><a class="headerlink" href="#hkl.calc.UnreachableError.pseudo" title="Link to this definition">#</a></dt>
<dd><p>Last reachable pseudo position in the trajectory</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>sequence</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="hkl.calc.UnreachableError.physical">
<span class="sig-name descname"><span class="pre">physical</span></span><a class="headerlink" href="#hkl.calc.UnreachableError.physical" title="Link to this definition">#</a></dt>
<dd><p>Corresponding physical motor positions</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>sequence</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="hkl.calc.default_decision_function">
<span class="sig-prename descclassname"><span class="pre">hkl.calc.</span></span><span class="sig-name descname"><span class="pre">default_decision_function</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">position</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">solutions</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/hkl/calc.html#default_decision_function"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#hkl.calc.default_decision_function" title="Link to this definition">#</a></dt>
<dd><p>The default decision function - returns the first solution.</p>
</dd></dl>
</section>
</article>
<footer class="prev-next-footer d-print-none">
<div class="prev-next-area">
<a class="left-prev"
href="api.html"
title="previous page">
<i class="fa-solid fa-angle-left"></i>
<div class="prev-next-info">
<p class="prev-next-subtitle">previous</p>
<p class="prev-next-title">API Reference</p>
</div>
</a>
<a class="right-next"
href="configuration.html"
title="next page">
<div class="prev-next-info">