-
Notifications
You must be signed in to change notification settings - Fork 19
Expand file tree
/
Copy pathdiffpy.morph.morphs.html
More file actions
1311 lines (1152 loc) · 116 KB
/
diffpy.morph.morphs.html
File metadata and controls
1311 lines (1152 loc) · 116 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 class="writer-html5" lang="en" data-content_root="../">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>diffpy.morph.morphs package — diffpy.morph 0.0.1 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=03e43079" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=9edc463e" />
<link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" />
<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../_static/documentation_options.js?v=f539c95a"></script>
<script src="../_static/doctools.js?v=fd6eb6e6"></script>
<script src="../_static/sphinx_highlight.js?v=6ffebe34"></script>
<script src="../_static/clipboard.min.js?v=a7894cd8"></script>
<script src="../_static/copybutton.js?v=cca77546"></script>
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="prev" title="diffpy.morph.morph_helpers package" href="diffpy.morph.morph_helpers.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../index.html" class="icon icon-home">
diffpy.morph
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../quickstart.html">Quickstart</a></li>
<li class="toctree-l1"><a class="reference internal" href="../tutorials.html">Advanced Tutorials</a></li>
<li class="toctree-l1"><a class="reference internal" href="../morphpy.html">Using diffpy.morph in Python</a></li>
<li class="toctree-l1"><a class="reference internal" href="../license.html">License</a></li>
<li class="toctree-l1"><a class="reference internal" href="../release.html">Release notes</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="diffpy.morph.html">Package API</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="diffpy.morph.morph_helpers.html">diffpy.morph.morph_helpers package</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">diffpy.morph.morphs package</a></li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">diffpy.morph</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="diffpy.morph.html">diffpy.morph package</a></li>
<li class="breadcrumb-item active">diffpy.morph.morphs package</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/diffpy/diffpy.morph/blob/main/doc/source/api/diffpy.morph.morphs.rst" class="fa fa-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="module-diffpy.morph.morphs">
<span id="diffpy-morph-morphs-package"></span><h1>diffpy.morph.morphs package<a class="headerlink" href="#module-diffpy.morph.morphs" title="Link to this heading"></a></h1>
<p>Definition of morphs.</p>
<section id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Link to this heading"></a></h2>
<section id="module-diffpy.morph.morphs.morphscale">
<span id="diffpy-morph-morphs-morphscale-module"></span><h3>diffpy.morph.morphs.morphscale module<a class="headerlink" href="#module-diffpy.morph.morphs.morphscale" title="Link to this heading"></a></h3>
<p>Class MorphScale – scale the morph data.</p>
<dl class="py class">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphscale.MorphScale">
<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">diffpy.morph.morphs.morphscale.</span></span><span class="sig-name descname"><span class="pre">MorphScale</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</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/diffpy/morph/morphs/morphscale.html#MorphScale"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#diffpy.morph.morphs.morphscale.MorphScale" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#diffpy.morph.morphs.morph.Morph" title="diffpy.morph.morphs.morph.Morph"><code class="xref py py-class docutils literal notranslate"><span class="pre">Morph</span></code></a></p>
<p>Scale the morph.</p>
<p>This scales the morph.</p>
<section id="configuration-variables">
<h4>Configuration Variables<a class="headerlink" href="#configuration-variables" title="Link to this heading"></a></h4>
<dl class="simple">
<dt>scale</dt><dd><p>The scale to apply to y_target_in.</p>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p>No return.</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphscale.MorphScale.morph">
<span class="sig-name descname"><span class="pre">morph</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x_morph</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y_morph</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x_target</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y_target</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/diffpy/morph/morphs/morphscale.html#MorphScale.morph"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#diffpy.morph.morphs.morphscale.MorphScale.morph" title="Link to this definition"></a></dt>
<dd><p>Apply a scale factor.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphscale.MorphScale.parnames">
<span class="sig-name descname"><span class="pre">parnames</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['scale']</span></span><a class="headerlink" href="#diffpy.morph.morphs.morphscale.MorphScale.parnames" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphscale.MorphScale.summary">
<span class="sig-name descname"><span class="pre">summary</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Scale</span> <span class="pre">morph</span> <span class="pre">by</span> <span class="pre">specified</span> <span class="pre">amount'</span></span><a class="headerlink" href="#diffpy.morph.morphs.morphscale.MorphScale.summary" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphscale.MorphScale.xinlabel">
<span class="sig-name descname"><span class="pre">xinlabel</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'r</span> <span class="pre">(A)'</span></span><a class="headerlink" href="#diffpy.morph.morphs.morphscale.MorphScale.xinlabel" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphscale.MorphScale.xoutlabel">
<span class="sig-name descname"><span class="pre">xoutlabel</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'r</span> <span class="pre">(A)'</span></span><a class="headerlink" href="#diffpy.morph.morphs.morphscale.MorphScale.xoutlabel" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphscale.MorphScale.yinlabel">
<span class="sig-name descname"><span class="pre">yinlabel</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'G</span> <span class="pre">(1/A^2)'</span></span><a class="headerlink" href="#diffpy.morph.morphs.morphscale.MorphScale.yinlabel" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphscale.MorphScale.youtlabel">
<span class="sig-name descname"><span class="pre">youtlabel</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'G</span> <span class="pre">(1/A^2)'</span></span><a class="headerlink" href="#diffpy.morph.morphs.morphscale.MorphScale.youtlabel" title="Link to this definition"></a></dt>
<dd></dd></dl>
</section>
</dd></dl>
</section>
<section id="module-diffpy.morph.morphs.morphshape">
<span id="diffpy-morph-morphs-morphshape-module"></span><h3>diffpy.morph.morphs.morphshape module<a class="headerlink" href="#module-diffpy.morph.morphs.morphshape" title="Link to this heading"></a></h3>
<p>Class MorphSphere – apply a spherical shape function to the morph class
MorphSpheroid – apply a spheroidal shape function to the morph.</p>
<dl class="py class">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphshape.MorphSphere">
<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">diffpy.morph.morphs.morphshape.</span></span><span class="sig-name descname"><span class="pre">MorphSphere</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</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/diffpy/morph/morphs/morphshape.html#MorphSphere"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#diffpy.morph.morphs.morphshape.MorphSphere" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#diffpy.morph.morphs.morph.Morph" title="diffpy.morph.morphs.morph.Morph"><code class="xref py py-class docutils literal notranslate"><span class="pre">Morph</span></code></a></p>
<p>Apply a spherical characteristic function to the morph.</p>
<section id="id1">
<h4>Configuration Variables<a class="headerlink" href="#id1" title="Link to this heading"></a></h4>
<dl class="simple">
<dt>radius</dt><dd><p>The radius of the sphere.</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphshape.MorphSphere.morph">
<span class="sig-name descname"><span class="pre">morph</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x_morph</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y_morph</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x_target</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y_target</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/diffpy/morph/morphs/morphshape.html#MorphSphere.morph"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#diffpy.morph.morphs.morphshape.MorphSphere.morph" title="Link to this definition"></a></dt>
<dd><p>Apply a scale factor.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphshape.MorphSphere.parnames">
<span class="sig-name descname"><span class="pre">parnames</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['radius']</span></span><a class="headerlink" href="#diffpy.morph.morphs.morphshape.MorphSphere.parnames" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphshape.MorphSphere.summary">
<span class="sig-name descname"><span class="pre">summary</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Apply</span> <span class="pre">spherical</span> <span class="pre">characteristic</span> <span class="pre">function</span> <span class="pre">to</span> <span class="pre">morph'</span></span><a class="headerlink" href="#diffpy.morph.morphs.morphshape.MorphSphere.summary" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphshape.MorphSphere.xinlabel">
<span class="sig-name descname"><span class="pre">xinlabel</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'r</span> <span class="pre">(A)'</span></span><a class="headerlink" href="#diffpy.morph.morphs.morphshape.MorphSphere.xinlabel" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphshape.MorphSphere.xoutlabel">
<span class="sig-name descname"><span class="pre">xoutlabel</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'r</span> <span class="pre">(A)'</span></span><a class="headerlink" href="#diffpy.morph.morphs.morphshape.MorphSphere.xoutlabel" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphshape.MorphSphere.yinlabel">
<span class="sig-name descname"><span class="pre">yinlabel</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'G</span> <span class="pre">(1/A^2)'</span></span><a class="headerlink" href="#diffpy.morph.morphs.morphshape.MorphSphere.yinlabel" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphshape.MorphSphere.youtlabel">
<span class="sig-name descname"><span class="pre">youtlabel</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'G</span> <span class="pre">(1/A^2)'</span></span><a class="headerlink" href="#diffpy.morph.morphs.morphshape.MorphSphere.youtlabel" title="Link to this definition"></a></dt>
<dd></dd></dl>
</section>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphshape.MorphSpheroid">
<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">diffpy.morph.morphs.morphshape.</span></span><span class="sig-name descname"><span class="pre">MorphSpheroid</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</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/diffpy/morph/morphs/morphshape.html#MorphSpheroid"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#diffpy.morph.morphs.morphshape.MorphSpheroid" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#diffpy.morph.morphs.morph.Morph" title="diffpy.morph.morphs.morph.Morph"><code class="xref py py-class docutils literal notranslate"><span class="pre">Morph</span></code></a></p>
<p>Apply a spherical characteristic function to the morph.</p>
<section id="id2">
<h4>Configuration Variables<a class="headerlink" href="#id2" title="Link to this heading"></a></h4>
<dl class="simple">
<dt>radius</dt><dd><p>The equatorial radius of the spheroid.</p>
</dd>
<dt>pradius</dt><dd><p>The polar radius of the spheroid.</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphshape.MorphSpheroid.morph">
<span class="sig-name descname"><span class="pre">morph</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x_morph</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y_morph</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x_target</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y_target</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/diffpy/morph/morphs/morphshape.html#MorphSpheroid.morph"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#diffpy.morph.morphs.morphshape.MorphSpheroid.morph" title="Link to this definition"></a></dt>
<dd><p>Apply a scale factor.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphshape.MorphSpheroid.parnames">
<span class="sig-name descname"><span class="pre">parnames</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['radius',</span> <span class="pre">'pradius']</span></span><a class="headerlink" href="#diffpy.morph.morphs.morphshape.MorphSpheroid.parnames" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphshape.MorphSpheroid.summary">
<span class="sig-name descname"><span class="pre">summary</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Apply</span> <span class="pre">spheroidal</span> <span class="pre">characteristic</span> <span class="pre">function</span> <span class="pre">to</span> <span class="pre">morph'</span></span><a class="headerlink" href="#diffpy.morph.morphs.morphshape.MorphSpheroid.summary" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphshape.MorphSpheroid.xinlabel">
<span class="sig-name descname"><span class="pre">xinlabel</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'r</span> <span class="pre">(A)'</span></span><a class="headerlink" href="#diffpy.morph.morphs.morphshape.MorphSpheroid.xinlabel" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphshape.MorphSpheroid.xoutlabel">
<span class="sig-name descname"><span class="pre">xoutlabel</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'r</span> <span class="pre">(A)'</span></span><a class="headerlink" href="#diffpy.morph.morphs.morphshape.MorphSpheroid.xoutlabel" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphshape.MorphSpheroid.yinlabel">
<span class="sig-name descname"><span class="pre">yinlabel</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'G</span> <span class="pre">(1/A^2)'</span></span><a class="headerlink" href="#diffpy.morph.morphs.morphshape.MorphSpheroid.yinlabel" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphshape.MorphSpheroid.youtlabel">
<span class="sig-name descname"><span class="pre">youtlabel</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'G</span> <span class="pre">(1/A^2)'</span></span><a class="headerlink" href="#diffpy.morph.morphs.morphshape.MorphSpheroid.youtlabel" title="Link to this definition"></a></dt>
<dd></dd></dl>
</section>
</dd></dl>
</section>
<section id="module-diffpy.morph.morphs.morphshift">
<span id="diffpy-morph-morphs-morphshift-module"></span><h3>diffpy.morph.morphs.morphshift module<a class="headerlink" href="#module-diffpy.morph.morphs.morphshift" title="Link to this heading"></a></h3>
<p>Class MorphShift – shift the morph.</p>
<dl class="py class">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphshift.MorphShift">
<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">diffpy.morph.morphs.morphshift.</span></span><span class="sig-name descname"><span class="pre">MorphShift</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</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/diffpy/morph/morphs/morphshift.html#MorphShift"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#diffpy.morph.morphs.morphshift.MorphShift" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#diffpy.morph.morphs.morph.Morph" title="diffpy.morph.morphs.morph.Morph"><code class="xref py py-class docutils literal notranslate"><span class="pre">Morph</span></code></a></p>
<p>Shift the morph.</p>
<section id="id3">
<h4>Configuration Variables<a class="headerlink" href="#id3" title="Link to this heading"></a></h4>
<dl class="simple">
<dt>vshift</dt><dd><p>The vertical shift to apply to the morph.</p>
</dd>
<dt>hshift</dt><dd><p>The horizontal shift to apply to the morph.</p>
</dd>
</dl>
<p>Note that a horizontal shift may cause edge effects, since the morph does
not know what lies beyond the edge of the signals.</p>
<dl class="py method">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphshift.MorphShift.morph">
<span class="sig-name descname"><span class="pre">morph</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x_morph</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y_morph</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x_target</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y_target</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/diffpy/morph/morphs/morphshift.html#MorphShift.morph"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#diffpy.morph.morphs.morphshift.MorphShift.morph" title="Link to this definition"></a></dt>
<dd><p>Apply the shifts.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphshift.MorphShift.parnames">
<span class="sig-name descname"><span class="pre">parnames</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['hshift',</span> <span class="pre">'vshift']</span></span><a class="headerlink" href="#diffpy.morph.morphs.morphshift.MorphShift.parnames" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphshift.MorphShift.summary">
<span class="sig-name descname"><span class="pre">summary</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Shift</span> <span class="pre">morph</span> <span class="pre">by</span> <span class="pre">specified</span> <span class="pre">amount'</span></span><a class="headerlink" href="#diffpy.morph.morphs.morphshift.MorphShift.summary" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphshift.MorphShift.xinlabel">
<span class="sig-name descname"><span class="pre">xinlabel</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'r</span> <span class="pre">(A)'</span></span><a class="headerlink" href="#diffpy.morph.morphs.morphshift.MorphShift.xinlabel" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphshift.MorphShift.xoutlabel">
<span class="sig-name descname"><span class="pre">xoutlabel</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'r</span> <span class="pre">(A)'</span></span><a class="headerlink" href="#diffpy.morph.morphs.morphshift.MorphShift.xoutlabel" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphshift.MorphShift.yinlabel">
<span class="sig-name descname"><span class="pre">yinlabel</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'G</span> <span class="pre">(1/A^2)'</span></span><a class="headerlink" href="#diffpy.morph.morphs.morphshift.MorphShift.yinlabel" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphshift.MorphShift.youtlabel">
<span class="sig-name descname"><span class="pre">youtlabel</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'G</span> <span class="pre">(1/A^2)'</span></span><a class="headerlink" href="#diffpy.morph.morphs.morphshift.MorphShift.youtlabel" title="Link to this definition"></a></dt>
<dd></dd></dl>
</section>
</dd></dl>
</section>
<section id="module-diffpy.morph.morphs.morphfuncy">
<span id="diffpy-morph-morphs-morphfuncy-module"></span><h3>diffpy.morph.morphs.morphfuncy module<a class="headerlink" href="#module-diffpy.morph.morphs.morphfuncy" title="Link to this heading"></a></h3>
<p>Class MorphFuncy – apply a user-supplied python function to the
y-axis.</p>
<dl class="py class">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphfuncy.MorphFuncy">
<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">diffpy.morph.morphs.morphfuncy.</span></span><span class="sig-name descname"><span class="pre">MorphFuncy</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</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/diffpy/morph/morphs/morphfuncy.html#MorphFuncy"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#diffpy.morph.morphs.morphfuncy.MorphFuncy" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#diffpy.morph.morphs.morph.Morph" title="diffpy.morph.morphs.morph.Morph"><code class="xref py py-class docutils literal notranslate"><span class="pre">Morph</span></code></a></p>
<p>Apply a custom function to the y-axis of the morph function.</p>
<p>General morph function that applies a user-supplied function to the
y-coordinates of morph data to make it align with a target.</p>
<section id="id4">
<h4>Configuration Variables<a class="headerlink" href="#id4" title="Link to this heading"></a></h4>
<dl class="simple">
<dt>function: callable</dt><dd><p>The user-supplied function that applies a transformation to the
y-coordinates of the data.</p>
</dd>
<dt>parameters: dict</dt><dd><p>A dictionary of parameters to pass to the function.</p>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">returns<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><em>A tuple (x_morph_out, y_morph_out, x_target_out, y_target_out)</em></p></li>
<li><p><em>where the target values remain the same and the morph data is</em></p></li>
<li><p><em>transformed according to the user-specified function and parameters</em></p></li>
<li><p><em>The morphed data is returned on the same grid as the unmorphed data</em></p></li>
</ul>
</dd>
</dl>
<p class="rubric">Example</p>
<p>Import the funcy morph function:</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">diffpy.morph.morphs.morphfuncy</span><span class="w"> </span><span class="kn">import</span> <span class="n">MorphFuncy</span>
</pre></div>
</div>
<p>Define or import the user-supplied transformation function:</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">import</span><span class="w"> </span><span class="nn">numpy</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">np</span>
<span class="gp">>>> </span><span class="k">def</span><span class="w"> </span><span class="nf">sine_function</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">,</span> <span class="n">amplitude</span><span class="p">,</span> <span class="n">frequency</span><span class="p">):</span>
<span class="gp">>>> </span> <span class="k">return</span> <span class="n">amplitude</span> <span class="o">*</span> <span class="n">np</span><span class="o">.</span><span class="n">sin</span><span class="p">(</span><span class="n">frequency</span> <span class="o">*</span> <span class="n">x</span><span class="p">)</span> <span class="o">*</span> <span class="n">y</span>
</pre></div>
</div>
<p>Provide initial guess for parameters:</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">parameters</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'amplitude'</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span> <span class="s1">'frequency'</span><span class="p">:</span> <span class="mi">2</span><span class="p">}</span>
</pre></div>
</div>
<p>Run the funcy morph given input morph array (x_morph, y_morph)and target
array (x_target, y_target):</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">morph</span> <span class="o">=</span> <span class="n">MorphFuncy</span><span class="p">()</span>
<span class="gp">>>> </span><span class="n">morph</span><span class="o">.</span><span class="n">funcy_function</span> <span class="o">=</span> <span class="n">sine_function</span>
<span class="gp">>>> </span><span class="n">morph</span><span class="o">.</span><span class="n">funcy</span> <span class="o">=</span> <span class="n">parameters</span>
<span class="gp">>>> </span><span class="n">x_morph_out</span><span class="p">,</span> <span class="n">y_morph_out</span><span class="p">,</span> <span class="n">x_target_out</span><span class="p">,</span> <span class="n">y_target_out</span> <span class="o">=</span>
<span class="gp">... </span><span class="n">morph</span><span class="o">.</span><span class="n">morph</span><span class="p">(</span><span class="n">x_morph</span><span class="p">,</span> <span class="n">y_morph</span><span class="p">,</span> <span class="n">x_target</span><span class="p">,</span> <span class="n">y_target</span><span class="p">)</span>
</pre></div>
</div>
<p>To access parameters from the morph instance:</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">x_morph_in</span> <span class="o">=</span> <span class="n">morph</span><span class="o">.</span><span class="n">x_morph_in</span>
<span class="gp">>>> </span><span class="n">y_morph_in</span> <span class="o">=</span> <span class="n">morph</span><span class="o">.</span><span class="n">y_morph_in</span>
<span class="gp">>>> </span><span class="n">x_target_in</span> <span class="o">=</span> <span class="n">morph</span><span class="o">.</span><span class="n">x_target_in</span>
<span class="gp">>>> </span><span class="n">y_target_in</span> <span class="o">=</span> <span class="n">morph</span><span class="o">.</span><span class="n">y_target_in</span>
<span class="gp">>>> </span><span class="n">parameters_out</span> <span class="o">=</span> <span class="n">morph</span><span class="o">.</span><span class="n">funcy</span>
</pre></div>
</div>
<dl class="py method">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphfuncy.MorphFuncy.morph">
<span class="sig-name descname"><span class="pre">morph</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x_morph</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y_morph</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x_target</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y_target</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/diffpy/morph/morphs/morphfuncy.html#MorphFuncy.morph"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#diffpy.morph.morphs.morphfuncy.MorphFuncy.morph" title="Link to this definition"></a></dt>
<dd><p>Apply the user-supplied Python function to the y-coordinates
of the morph data.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphfuncy.MorphFuncy.parnames">
<span class="sig-name descname"><span class="pre">parnames</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['funcy_function',</span> <span class="pre">'funcy']</span></span><a class="headerlink" href="#diffpy.morph.morphs.morphfuncy.MorphFuncy.parnames" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphfuncy.MorphFuncy.summary">
<span class="sig-name descname"><span class="pre">summary</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Apply</span> <span class="pre">a</span> <span class="pre">Python</span> <span class="pre">function</span> <span class="pre">to</span> <span class="pre">the</span> <span class="pre">y-axis</span> <span class="pre">data'</span></span><a class="headerlink" href="#diffpy.morph.morphs.morphfuncy.MorphFuncy.summary" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphfuncy.MorphFuncy.xinlabel">
<span class="sig-name descname"><span class="pre">xinlabel</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'r</span> <span class="pre">(A)'</span></span><a class="headerlink" href="#diffpy.morph.morphs.morphfuncy.MorphFuncy.xinlabel" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphfuncy.MorphFuncy.xoutlabel">
<span class="sig-name descname"><span class="pre">xoutlabel</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'r</span> <span class="pre">(A)'</span></span><a class="headerlink" href="#diffpy.morph.morphs.morphfuncy.MorphFuncy.xoutlabel" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphfuncy.MorphFuncy.yinlabel">
<span class="sig-name descname"><span class="pre">yinlabel</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'G</span> <span class="pre">(1/A^2)'</span></span><a class="headerlink" href="#diffpy.morph.morphs.morphfuncy.MorphFuncy.yinlabel" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphfuncy.MorphFuncy.youtlabel">
<span class="sig-name descname"><span class="pre">youtlabel</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'G</span> <span class="pre">(1/A^2)'</span></span><a class="headerlink" href="#diffpy.morph.morphs.morphfuncy.MorphFuncy.youtlabel" title="Link to this definition"></a></dt>
<dd></dd></dl>
</section>
</dd></dl>
</section>
<section id="module-diffpy.morph.morphs.morphchain">
<span id="diffpy-morph-morphs-morphchain-module"></span><h3>diffpy.morph.morphs.morphchain module<a class="headerlink" href="#module-diffpy.morph.morphs.morphchain" title="Link to this heading"></a></h3>
<p>MorphChain – Chain of morphs executed in order.</p>
<dl class="py class">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphchain.MorphChain">
<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">diffpy.morph.morphs.morphchain.</span></span><span class="sig-name descname"><span class="pre">MorphChain</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/diffpy/morph/morphs/morphchain.html#MorphChain"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#diffpy.morph.morphs.morphchain.MorphChain" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></p>
<p>Class for chaining morphs together.</p>
<p>This class is a queue of morphs that get executed in order via the ‘morph’
method. This class derives from the built-in list, and list methods are
used to modify the queue.</p>
<p>This derives from list and relies on its methods where possible.</p>
<section id="instance-attributes">
<h4>Instance Attributes<a class="headerlink" href="#instance-attributes" title="Link to this heading"></a></h4>
<dl class="simple">
<dt>config: dict</dt><dd><p>All configuration variables.</p>
</dd>
</dl>
</section>
<section id="properties">
<h4>Properties<a class="headerlink" href="#properties" title="Link to this heading"></a></h4>
<dl class="simple">
<dt>x_morph_in</dt><dd><p>Last morph input x data.</p>
</dd>
<dt>y_morph_in</dt><dd><p>Last morph input y data.</p>
</dd>
<dt>x_morph_out</dt><dd><p>Last morph result x data.</p>
</dd>
<dt>y_morph_out</dt><dd><p>Last morph result y data.</p>
</dd>
<dt>x_target_in</dt><dd><p>Last target input x data.</p>
</dd>
<dt>y_target_in</dt><dd><p>Last target input y data.</p>
</dd>
<dt>x_target_out</dt><dd><p>Last target result x data.</p>
</dd>
<dt>y_target_out</dt><dd><p>Last target result y data.</p>
</dd>
<dt>xy_morph_in</dt><dd><p>Tuple of (x_morph_in, y_morph_in) from first morph.</p>
</dd>
<dt>xy_morph_out</dt><dd><p>Tuple of (x_morph_out, y_morph_out) from last morph.</p>
</dd>
<dt>xy_target_in</dt><dd><p>Tuple of (x_target_in, y_target_in) from first morph.</p>
</dd>
<dt>xy_target_out</dt><dd><p>Tuple of (x_target_out, y_target_out) from last morph.</p>
</dd>
<dt>xyallout</dt><dd><p>Tuple of (x_morph_out, y_morph_out, x_target_out, y_target_out)
from last morph.</p>
</dd>
<dt>parnames</dt><dd><p>Names of parameters collected from morphs (Read only).</p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>The properties return tuples of None if there are no morphs.</p>
<dl class="py method">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphchain.MorphChain.morph">
<span class="sig-name descname"><span class="pre">morph</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x_morph</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y_morph</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x_target</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y_target</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/diffpy/morph/morphs/morphchain.html#MorphChain.morph"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#diffpy.morph.morphs.morphchain.MorphChain.morph" title="Link to this definition"></a></dt>
<dd><p>Apply the chain of morphs to the input data.</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>x_morph</strong> – Morphed arrays.</p></li>
<li><p><strong>y_morph</strong> – Morphed arrays.</p></li>
<li><p><strong>x_target</strong> – Target arrays.</p></li>
<li><p><strong>y_target</strong> – Target arrays.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>A tuple of numpy arrays
(x_morph_out, y_morph_out, x_target_out, y_target_out).</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>tuple</p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>Config may be altered by the morphs.</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphchain.MorphChain.parnames">
<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">parnames</span></span><a class="headerlink" href="#diffpy.morph.morphs.morphchain.MorphChain.parnames" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphchain.MorphChain.x_morph_in">
<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">x_morph_in</span></span><a class="headerlink" href="#diffpy.morph.morphs.morphchain.MorphChain.x_morph_in" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphchain.MorphChain.x_morph_out">
<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">x_morph_out</span></span><a class="headerlink" href="#diffpy.morph.morphs.morphchain.MorphChain.x_morph_out" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphchain.MorphChain.x_target_in">
<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">x_target_in</span></span><a class="headerlink" href="#diffpy.morph.morphs.morphchain.MorphChain.x_target_in" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphchain.MorphChain.x_target_out">
<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">x_target_out</span></span><a class="headerlink" href="#diffpy.morph.morphs.morphchain.MorphChain.x_target_out" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphchain.MorphChain.xy_morph_in">
<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">xy_morph_in</span></span><a class="headerlink" href="#diffpy.morph.morphs.morphchain.MorphChain.xy_morph_in" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphchain.MorphChain.xy_morph_out">
<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">xy_morph_out</span></span><a class="headerlink" href="#diffpy.morph.morphs.morphchain.MorphChain.xy_morph_out" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphchain.MorphChain.xy_target_in">
<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">xy_target_in</span></span><a class="headerlink" href="#diffpy.morph.morphs.morphchain.MorphChain.xy_target_in" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphchain.MorphChain.xy_target_out">
<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">xy_target_out</span></span><a class="headerlink" href="#diffpy.morph.morphs.morphchain.MorphChain.xy_target_out" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphchain.MorphChain.xyallout">
<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">xyallout</span></span><a class="headerlink" href="#diffpy.morph.morphs.morphchain.MorphChain.xyallout" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphchain.MorphChain.y_morph_in">
<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">y_morph_in</span></span><a class="headerlink" href="#diffpy.morph.morphs.morphchain.MorphChain.y_morph_in" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphchain.MorphChain.y_morph_out">
<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">y_morph_out</span></span><a class="headerlink" href="#diffpy.morph.morphs.morphchain.MorphChain.y_morph_out" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphchain.MorphChain.y_target_in">
<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">y_target_in</span></span><a class="headerlink" href="#diffpy.morph.morphs.morphchain.MorphChain.y_target_in" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphchain.MorphChain.y_target_out">
<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">y_target_out</span></span><a class="headerlink" href="#diffpy.morph.morphs.morphchain.MorphChain.y_target_out" title="Link to this definition"></a></dt>
<dd></dd></dl>
</section>
</dd></dl>
</section>
<section id="module-diffpy.morph.morphs.morphresolution">
<span id="diffpy-morph-morphs-morphresolution-module"></span><h3>diffpy.morph.morphs.morphresolution module<a class="headerlink" href="#module-diffpy.morph.morphs.morphresolution" title="Link to this heading"></a></h3>
<p>Class MorphResolutionDamping – apply resolution broadening to the
morph.</p>
<dl class="py class">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphresolution.MorphResolutionDamping">
<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">diffpy.morph.morphs.morphresolution.</span></span><span class="sig-name descname"><span class="pre">MorphResolutionDamping</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</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/diffpy/morph/morphs/morphresolution.html#MorphResolutionDamping"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#diffpy.morph.morphs.morphresolution.MorphResolutionDamping" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#diffpy.morph.morphs.morph.Morph" title="diffpy.morph.morphs.morph.Morph"><code class="xref py py-class docutils literal notranslate"><span class="pre">Morph</span></code></a></p>
<p>Apply resolution damping and broadening to the morph.</p>
<section id="id5">
<h4>Configuration Variables<a class="headerlink" href="#id5" title="Link to this heading"></a></h4>
<dl class="simple">
<dt>qdamp</dt><dd><p>Peak dampening term.</p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>See the PDFgui manual for how this is used.</p>
<dl class="py method">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphresolution.MorphResolutionDamping.morph">
<span class="sig-name descname"><span class="pre">morph</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x_morph</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y_morph</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x_target</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y_target</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/diffpy/morph/morphs/morphresolution.html#MorphResolutionDamping.morph"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#diffpy.morph.morphs.morphresolution.MorphResolutionDamping.morph" title="Link to this definition"></a></dt>
<dd><p>Apply a resolution damping.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphresolution.MorphResolutionDamping.parnames">
<span class="sig-name descname"><span class="pre">parnames</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['qdamp']</span></span><a class="headerlink" href="#diffpy.morph.morphs.morphresolution.MorphResolutionDamping.parnames" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphresolution.MorphResolutionDamping.summary">
<span class="sig-name descname"><span class="pre">summary</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Apply</span> <span class="pre">resolution</span> <span class="pre">damping</span> <span class="pre">to</span> <span class="pre">the</span> <span class="pre">morph'</span></span><a class="headerlink" href="#diffpy.morph.morphs.morphresolution.MorphResolutionDamping.summary" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphresolution.MorphResolutionDamping.xinlabel">
<span class="sig-name descname"><span class="pre">xinlabel</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'r</span> <span class="pre">(A)'</span></span><a class="headerlink" href="#diffpy.morph.morphs.morphresolution.MorphResolutionDamping.xinlabel" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphresolution.MorphResolutionDamping.xoutlabel">
<span class="sig-name descname"><span class="pre">xoutlabel</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'r</span> <span class="pre">(A)'</span></span><a class="headerlink" href="#diffpy.morph.morphs.morphresolution.MorphResolutionDamping.xoutlabel" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphresolution.MorphResolutionDamping.yinlabel">
<span class="sig-name descname"><span class="pre">yinlabel</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'R</span> <span class="pre">(1/A)'</span></span><a class="headerlink" href="#diffpy.morph.morphs.morphresolution.MorphResolutionDamping.yinlabel" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphresolution.MorphResolutionDamping.youtlabel">
<span class="sig-name descname"><span class="pre">youtlabel</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'R</span> <span class="pre">(1/A)'</span></span><a class="headerlink" href="#diffpy.morph.morphs.morphresolution.MorphResolutionDamping.youtlabel" title="Link to this definition"></a></dt>
<dd></dd></dl>
</section>
</dd></dl>
</section>
<section id="module-diffpy.morph.morphs.morphstretch">
<span id="diffpy-morph-morphs-morphstretch-module"></span><h3>diffpy.morph.morphs.morphstretch module<a class="headerlink" href="#module-diffpy.morph.morphs.morphstretch" title="Link to this heading"></a></h3>
<p>Class MorphStretch – stretch the morph.</p>
<dl class="py class">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphstretch.MorphStretch">
<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">diffpy.morph.morphs.morphstretch.</span></span><span class="sig-name descname"><span class="pre">MorphStretch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</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/diffpy/morph/morphs/morphstretch.html#MorphStretch"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#diffpy.morph.morphs.morphstretch.MorphStretch" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#diffpy.morph.morphs.morph.Morph" title="diffpy.morph.morphs.morph.Morph"><code class="xref py py-class docutils literal notranslate"><span class="pre">Morph</span></code></a></p>
<p>Smear the morph function.</p>
<p>This stretches (broadens) the morph.</p>
<section id="id6">
<h4>Configuration Variables<a class="headerlink" href="#id6" title="Link to this heading"></a></h4>
<dl class="simple">
<dt>stretch</dt><dd><p>The stretch factor to apply to y_morph_in.
This is applied such that a feature at r is moved to r * (1 + stretch).</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphstretch.MorphStretch.morph">
<span class="sig-name descname"><span class="pre">morph</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x_morph</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y_morph</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x_target</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y_target</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/diffpy/morph/morphs/morphstretch.html#MorphStretch.morph"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#diffpy.morph.morphs.morphstretch.MorphStretch.morph" title="Link to this definition"></a></dt>
<dd><p>Resample arrays onto specified grid.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphstretch.MorphStretch.parnames">
<span class="sig-name descname"><span class="pre">parnames</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['stretch']</span></span><a class="headerlink" href="#diffpy.morph.morphs.morphstretch.MorphStretch.parnames" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphstretch.MorphStretch.summary">
<span class="sig-name descname"><span class="pre">summary</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Stretch</span> <span class="pre">morph</span> <span class="pre">by</span> <span class="pre">desired</span> <span class="pre">amount'</span></span><a class="headerlink" href="#diffpy.morph.morphs.morphstretch.MorphStretch.summary" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphstretch.MorphStretch.xinlabel">
<span class="sig-name descname"><span class="pre">xinlabel</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'r</span> <span class="pre">(A)'</span></span><a class="headerlink" href="#diffpy.morph.morphs.morphstretch.MorphStretch.xinlabel" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphstretch.MorphStretch.xoutlabel">
<span class="sig-name descname"><span class="pre">xoutlabel</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'r</span> <span class="pre">(A)'</span></span><a class="headerlink" href="#diffpy.morph.morphs.morphstretch.MorphStretch.xoutlabel" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphstretch.MorphStretch.yinlabel">
<span class="sig-name descname"><span class="pre">yinlabel</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'G</span> <span class="pre">(1/A^2)'</span></span><a class="headerlink" href="#diffpy.morph.morphs.morphstretch.MorphStretch.yinlabel" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphstretch.MorphStretch.youtlabel">
<span class="sig-name descname"><span class="pre">youtlabel</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'G</span> <span class="pre">(1/A^2)'</span></span><a class="headerlink" href="#diffpy.morph.morphs.morphstretch.MorphStretch.youtlabel" title="Link to this definition"></a></dt>
<dd></dd></dl>
</section>
</dd></dl>
</section>
<section id="module-diffpy.morph.morphs.morph">
<span id="diffpy-morph-morphs-morph-module"></span><h3>diffpy.morph.morphs.morph module<a class="headerlink" href="#module-diffpy.morph.morphs.morph" title="Link to this heading"></a></h3>
<p>Morph – base class for defining a morph.</p>
<dl class="py class">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morph.Morph">
<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">diffpy.morph.morphs.morph.</span></span><span class="sig-name descname"><span class="pre">Morph</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</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/diffpy/morph/morphs/morph.html#Morph"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#diffpy.morph.morphs.morph.Morph" 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>Base class for implementing a morph given a target.</p>
<p>Adapted from diffpy.pdfgetx to include two sets of arrays that get passed
through.</p>
<p>Attributes are taken from config when not found locally. The morph may
modify the config dictionary. This is the means by which to communicate
automatically modified attributes.</p>
<section id="class-attributes">
<h4>Class Attributes<a class="headerlink" href="#class-attributes" title="Link to this heading"></a></h4>
<dl class="simple">
<dt>summary</dt><dd><p>Short description of a morph.</p>
</dd>
<dt>xinlabel</dt><dd><p>Descriptive label for the x input array.</p>
</dd>
<dt>yinlabel</dt><dd><p>Descriptive label for the y input array.</p>
</dd>
<dt>xoutlabel</dt><dd><p>Descriptive label for the x output array.</p>
</dd>
<dt>youtlabel</dt><dd><p>Descriptive label for the y output array.</p>
</dd>
<dt>parnames: list</dt><dd><p>Names of configuration variables.</p>
</dd>
</dl>
</section>
<section id="id7">
<h4>Instance Attributes<a class="headerlink" href="#id7" title="Link to this heading"></a></h4>
<dl class="simple">
<dt>config: dict</dt><dd><p>All configuration variables.</p>
</dd>
<dt>x_morph_in</dt><dd><p>Last morph input x data.</p>
</dd>
<dt>y_morph_in</dt><dd><p>Last morph input y data.</p>
</dd>
<dt>x_morph_out</dt><dd><p>Last morph result x data.</p>
</dd>
<dt>y_morph_out</dt><dd><p>Last morph result y data.</p>
</dd>
<dt>x_target_in</dt><dd><p>Last target input x data.</p>
</dd>
<dt>y_target_in</dt><dd><p>Last target input y data.</p>
</dd>
<dt>x_target_out</dt><dd><p>Last target result x data.</p>
</dd>
<dt>y_target_out</dt><dd><p>Last target result y data.</p>
</dd>
</dl>
</section>
<section id="id8">
<h4>Properties<a class="headerlink" href="#id8" title="Link to this heading"></a></h4>
<dl class="simple">
<dt>xy_morph_in</dt><dd><p>Tuple of (x_morph_in, y_morph_in).</p>
</dd>
<dt>xy_morph_out</dt><dd><p>Tuple of (x_morph_out, y_morph_out).</p>
</dd>
<dt>xy_target_in</dt><dd><p>Tuple of (x_target_in, y_target_in).</p>
</dd>
<dt>xy_target_out</dt><dd><p>Tuple of (x_target_out, y_target_out).</p>
</dd>
<dt>xyallout</dt><dd><p>Tuple of (x_morph_out, y_morph_out, x_target_out, y_target_out).</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morph.Morph.applyConfig">
<span class="sig-name descname"><span class="pre">applyConfig</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/diffpy/morph/morphs/morph.html#Morph.applyConfig"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#diffpy.morph.morphs.morph.Morph.applyConfig" title="Link to this definition"></a></dt>
<dd><p>Process any configuration data from a dictionary.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>config</strong> (<em>dict</em>) – Configuration dictionary.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>No return value.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morph.Morph.checkConfig">
<span class="sig-name descname"><span class="pre">checkConfig</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/diffpy/morph/morphs/morph.html#Morph.checkConfig"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#diffpy.morph.morphs.morph.Morph.checkConfig" title="Link to this definition"></a></dt>
<dd><p>Verify data in self.config. No action by default.</p>
<p>To be overridden in a derived class.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morph.Morph.morph">
<span class="sig-name descname"><span class="pre">morph</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x_morph</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y_morph</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x_target</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y_target</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/diffpy/morph/morphs/morph.html#Morph.morph"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#diffpy.morph.morphs.morph.Morph.morph" title="Link to this definition"></a></dt>
<dd><p>Morph arrays morphed or target.</p>
<p>Identity operation.
This method should be overloaded in a derived class.</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>x_morph</strong> – Morphed arrays.</p></li>
<li><p><strong>y_morph</strong> – Morphed arrays.</p></li>
<li><p><strong>x_target</strong> – Target arrays.</p></li>
<li><p><strong>y_target</strong> – Target arrays.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>A tuple of numpy arrays
(x_morph_out, y_morph_out, x_target_out, y_target_out)</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>tuple</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morph.Morph.parnames">
<span class="sig-name descname"><span class="pre">parnames</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">[]</span></span><a class="headerlink" href="#diffpy.morph.morphs.morph.Morph.parnames" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morph.Morph.plotInputs">
<span class="sig-name descname"><span class="pre">plotInputs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">xylabels</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/diffpy/morph/morphs/morph.html#Morph.plotInputs"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#diffpy.morph.morphs.morph.Morph.plotInputs" title="Link to this definition"></a></dt>
<dd><p>Plot input arrays using matplotlib.pyplot.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>xylabels</strong> – Flag for updating x and y axes labels.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>A list of matplotlib line objects.</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>list</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morph.Morph.plotOutputs">
<span class="sig-name descname"><span class="pre">plotOutputs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">xylabels</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">plotargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/diffpy/morph/morphs/morph.html#Morph.plotOutputs"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#diffpy.morph.morphs.morph.Morph.plotOutputs" title="Link to this definition"></a></dt>
<dd><p>Plot output arrays using matplotlib.pyplot.</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>xylabels</strong> (<em>bool</em>) – Flag for updating x and y axes labels.</p></li>
<li><p><strong>plotargs</strong> – Arguments passed to the pylab plot function.
Note that “label” will be ignored.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>A list of matplotlib line objects.</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>list</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morph.Morph.set_extrapolation_info">
<span class="sig-name descname"><span class="pre">set_extrapolation_info</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x_true</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x_extrapolate</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/diffpy/morph/morphs/morph.html#Morph.set_extrapolation_info"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#diffpy.morph.morphs.morph.Morph.set_extrapolation_info" title="Link to this definition"></a></dt>
<dd><p>Set extrapolation information of the concerned morphing
process.</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>x_true</strong> (<em>array</em>) – original x values</p></li>
<li><p><strong>x_extrapolate</strong> (<em>array</em>) – x values after a morphing process</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morph.Morph.summary">
<span class="sig-name descname"><span class="pre">summary</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'identity</span> <span class="pre">transformation'</span></span><a class="headerlink" href="#diffpy.morph.morphs.morph.Morph.summary" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morph.Morph.xinlabel">
<span class="sig-name descname"><span class="pre">xinlabel</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'x'</span></span><a class="headerlink" href="#diffpy.morph.morphs.morph.Morph.xinlabel" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morph.Morph.xoutlabel">
<span class="sig-name descname"><span class="pre">xoutlabel</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'x'</span></span><a class="headerlink" href="#diffpy.morph.morphs.morph.Morph.xoutlabel" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morph.Morph.xy_morph_in">
<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">xy_morph_in</span></span><a class="headerlink" href="#diffpy.morph.morphs.morph.Morph.xy_morph_in" title="Link to this definition"></a></dt>
<dd><p>Return a tuple of morph input arrays</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morph.Morph.xy_morph_out">
<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">xy_morph_out</span></span><a class="headerlink" href="#diffpy.morph.morphs.morph.Morph.xy_morph_out" title="Link to this definition"></a></dt>
<dd><p>Return a tuple of morph output arrays</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morph.Morph.xy_target_in">
<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">xy_target_in</span></span><a class="headerlink" href="#diffpy.morph.morphs.morph.Morph.xy_target_in" title="Link to this definition"></a></dt>
<dd><p>Return a tuple of target input arrays</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morph.Morph.xy_target_out">
<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">xy_target_out</span></span><a class="headerlink" href="#diffpy.morph.morphs.morph.Morph.xy_target_out" title="Link to this definition"></a></dt>
<dd><p>Return a tuple of target output arrays</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morph.Morph.xyallout">
<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">xyallout</span></span><a class="headerlink" href="#diffpy.morph.morphs.morph.Morph.xyallout" title="Link to this definition"></a></dt>
<dd><p>Return a tuple of all output arrays</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morph.Morph.yinlabel">
<span class="sig-name descname"><span class="pre">yinlabel</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'y'</span></span><a class="headerlink" href="#diffpy.morph.morphs.morph.Morph.yinlabel" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morph.Morph.youtlabel">
<span class="sig-name descname"><span class="pre">youtlabel</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'y'</span></span><a class="headerlink" href="#diffpy.morph.morphs.morph.Morph.youtlabel" title="Link to this definition"></a></dt>
<dd></dd></dl>
</section>
</dd></dl>
</section>
<section id="module-diffpy.morph.morphs.morphsqueeze">
<span id="diffpy-morph-morphs-morphsqueeze-module"></span><h3>diffpy.morph.morphs.morphsqueeze module<a class="headerlink" href="#module-diffpy.morph.morphs.morphsqueeze" title="Link to this heading"></a></h3>
<p>Class MorphSqueeze – Apply a polynomial to squeeze the morph
function.</p>
<dl class="py class">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphsqueeze.MorphSqueeze">
<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">diffpy.morph.morphs.morphsqueeze.</span></span><span class="sig-name descname"><span class="pre">MorphSqueeze</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</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/diffpy/morph/morphs/morphsqueeze.html#MorphSqueeze"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#diffpy.morph.morphs.morphsqueeze.MorphSqueeze" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#diffpy.morph.morphs.morph.Morph" title="diffpy.morph.morphs.morph.Morph"><code class="xref py py-class docutils literal notranslate"><span class="pre">Morph</span></code></a></p>
<p>Squeeze the morph function.</p>
<p>This applies a polynomial to squeeze the morph non-linearly.</p>
<section id="id9">
<h4>Configuration Variables<a class="headerlink" href="#id9" title="Link to this heading"></a></h4>
<dl class="simple">
<dt>squeeze<span class="classifier">Dictionary</span></dt><dd><p>The polynomial coefficients {a0, a1, …, an} for the squeeze
function where the polynomial would be of the form
a0 + a1*x + a2*x^2 and so on. The order of the polynomial is
determined by the length of the dictionary.</p>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">returns<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><em>A tuple (x_morph_out, y_morph_out, x_target_out, y_target_out)</em></p></li>
<li><p><em>where the target values remain the same and the morph data is</em></p></li>
<li><p><em>shifted according to the squeeze. The morphed data is returned on</em></p></li>
<li><p><em>the same grid as the unmorphed data.</em></p></li>
</ul>
</dd>
</dl>
<p class="rubric">Example</p>
<p>Import the squeeze morph function:</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">diffpy.morph.morphs.morphsqueeze</span><span class="w"> </span><span class="kn">import</span> <span class="n">MorphSqueeze</span>
</pre></div>
</div>
<p>Provide initial guess for squeezing coefficients:</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">squeeze_coeff</span> <span class="o">=</span> <span class="p">{</span><span class="s2">"a0"</span><span class="p">:</span><span class="mf">0.1</span><span class="p">,</span> <span class="s2">"a1"</span><span class="p">:</span><span class="o">-</span><span class="mf">0.01</span><span class="p">,</span> <span class="s2">"a2"</span><span class="p">:</span><span class="mf">0.005</span><span class="p">}</span>
</pre></div>
</div>
<p>Run the squeeze morph given input morph array (x_morph, y_morph) and target
array (x_target, y_target):</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">morph</span> <span class="o">=</span> <span class="n">MorphSqueeze</span><span class="p">()</span>
<span class="gp">>>> </span><span class="n">morph</span><span class="o">.</span><span class="n">squeeze</span> <span class="o">=</span> <span class="n">squeeze_coeff</span>
<span class="gp">>>> </span><span class="n">x_morph_out</span><span class="p">,</span> <span class="n">y_morph_out</span><span class="p">,</span> <span class="n">x_target_out</span><span class="p">,</span> <span class="n">y_target_out</span> <span class="o">=</span>
<span class="gp">... </span><span class="n">morph</span><span class="p">(</span><span class="n">x_morph</span><span class="p">,</span> <span class="n">y_morph</span><span class="p">,</span> <span class="n">x_target</span><span class="p">,</span> <span class="n">y_target</span><span class="p">)</span>
</pre></div>
</div>
<p>To access parameters from the morph instance:</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">x_morph_in</span> <span class="o">=</span> <span class="n">morph</span><span class="o">.</span><span class="n">x_morph_in</span>
<span class="gp">>>> </span><span class="n">y_morph_in</span> <span class="o">=</span> <span class="n">morph</span><span class="o">.</span><span class="n">y_morph_in</span>
<span class="gp">>>> </span><span class="n">x_target_in</span> <span class="o">=</span> <span class="n">morph</span><span class="o">.</span><span class="n">x_target_in</span>
<span class="gp">>>> </span><span class="n">y_target_in</span> <span class="o">=</span> <span class="n">morph</span><span class="o">.</span><span class="n">y_target_in</span>
<span class="gp">>>> </span><span class="n">squeeze_coeff_out</span> <span class="o">=</span> <span class="n">morph</span><span class="o">.</span><span class="n">squeeze</span>
</pre></div>
</div>
<dl class="py attribute">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphsqueeze.MorphSqueeze.extrap_index_high">
<span class="sig-name descname"><span class="pre">extrap_index_high</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></span><a class="headerlink" href="#diffpy.morph.morphs.morphsqueeze.MorphSqueeze.extrap_index_high" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphsqueeze.MorphSqueeze.extrap_index_low">
<span class="sig-name descname"><span class="pre">extrap_index_low</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></span><a class="headerlink" href="#diffpy.morph.morphs.morphsqueeze.MorphSqueeze.extrap_index_low" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphsqueeze.MorphSqueeze.morph">
<span class="sig-name descname"><span class="pre">morph</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x_morph</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y_morph</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x_target</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y_target</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/diffpy/morph/morphs/morphsqueeze.html#MorphSqueeze.morph"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#diffpy.morph.morphs.morphsqueeze.MorphSqueeze.morph" title="Link to this definition"></a></dt>
<dd><p>Apply a polynomial to squeeze the morph function.</p>
<p>The morphed data is returned on the same grid as the unmorphed
data.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphsqueeze.MorphSqueeze.parnames">
<span class="sig-name descname"><span class="pre">parnames</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['squeeze']</span></span><a class="headerlink" href="#diffpy.morph.morphs.morphsqueeze.MorphSqueeze.parnames" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphsqueeze.MorphSqueeze.squeeze_cutoff_high">
<span class="sig-name descname"><span class="pre">squeeze_cutoff_high</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></span><a class="headerlink" href="#diffpy.morph.morphs.morphsqueeze.MorphSqueeze.squeeze_cutoff_high" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="diffpy.morph.morphs.morphsqueeze.MorphSqueeze.squeeze_cutoff_low">
<span class="sig-name descname"><span class="pre">squeeze_cutoff_low</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></span><a class="headerlink" href="#diffpy.morph.morphs.morphsqueeze.MorphSqueeze.squeeze_cutoff_low" title="Link to this definition"></a></dt>
<dd></dd></dl>