-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathcode.html
More file actions
2440 lines (2279 loc) · 162 KB
/
Copy pathcode.html
File metadata and controls
2440 lines (2279 loc) · 162 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 PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Code — GemPy rc documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: 'rc',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="shortcut icon" href="_static/favicon.ico"/>
<link rel="author" title="About these documents" href="about.html" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="About us" href="about.html" />
<link rel="prev" title="Advance theory" href="_theory/advanced.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head>
<body>
<div class="document">
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo">
<a href="index.html">
<img class="logo" src="_static/./logos/gempy.png" alt="Logo"/>
<h1 class="logo logo-name">GemPy</h1>
</a>
</p>
<p>
<iframe src="https://ghbtns.com/github-btn.html?user=cgre-aachen&repo=gempy&type=star&count=true&size=large&v=2"
allowtransparency="true" frameborder="0" scrolling="0" width="200px" height="35px"></iframe>
</p>
<p>
<a href="https://travis-ci.org/cgre-aachen/gempy">
<img
alt="https://secure.travis-ci.org/cgre-aachen/gempy.svg?branch=master"
src="https://secure.travis-ci.org/cgre-aachen/gempy.svg?branch=master"
/>
</a>
</p>
<h3>Navigation</h3>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="index.html">GemPy</a></li>
<li class="toctree-l1"><a class="reference internal" href="_theory/motivation.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial.html">Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="theory.html">Guide</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Code</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#gempy-front">Gempy Front</a></li>
<li class="toctree-l2"><a class="reference internal" href="#module-data_management">Data Management</a></li>
<li class="toctree-l2"><a class="reference internal" href="#theano-graph">Theano Graph</a></li>
<li class="toctree-l2"><a class="reference internal" href="#module-geophysics">Geophysics</a></li>
<li class="toctree-l2"><a class="reference internal" href="#topology">Topology</a></li>
<li class="toctree-l2"><a class="reference internal" href="#posterior-analysis">Posterior Analysis</a></li>
<li class="toctree-l2"><a class="reference internal" href="#visualization">Visualization</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="about.html">About us</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li>Previous: <a href="_theory/advanced.html" title="previous chapter">Advance theory</a></li>
<li>Next: <a href="about.html" title="next chapter">About us</a></li>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="code">
<h1>Code<a class="headerlink" href="#code" title="Permalink to this headline">¶</a></h1>
<div class="toctree-wrapper compound">
</div>
<div class="section" id="gempy-front">
<h2>Gempy Front<a class="headerlink" href="#gempy-front" title="Permalink to this headline">¶</a></h2>
<span class="target" id="module-gempy_front"></span><p>This file is part of gempy.</p>
<p>gempy is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.</p>
<p>Foobar is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.</p>
<p>You should have received a copy of the GNU General Public License
along with gempy. If not, see <<a class="reference external" href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>>.</p>
<p>Module with classes and methods to perform implicit regional modelling based on
the potential field method.
Tested on Ubuntu 16</p>
<p>Created on 10/10 /2016</p>
<p>@author: Miguel de la Varga</p>
<dl class="function">
<dt id="gempy_front.compute_model">
<code class="descclassname">gempy_front.</code><code class="descname">compute_model</code><span class="sig-paren">(</span><em>interp_data</em>, <em>output=’geology’</em>, <em>u_grade=None</em>, <em>get_potential_at_interfaces=False</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/gempy_front.html#compute_model"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#gempy_front.compute_model" title="Permalink to this definition">¶</a></dt>
<dd><p>Computes the geological model and any extra output given.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>interp_data</strong> (<code class="xref py py-class docutils literal"><span class="pre">gempy.interpolator.InterpolatorData</span></code>) – </li>
<li><strong>output</strong> (<em>{'geology'</em><em>, </em><em>'gravity'</em><em>, </em><em>'gradients'}</em>) – Only if theano functions has not been compiled yet</li>
<li><strong>u_grade</strong> (<em>array-like of {0</em><em>, </em><em>1</em><em>, </em><em>2}</em>) – grade of the polynomial for the universal part of the Kriging interpolations. The value has to
be either 0, 1 or 2 and the length has to be the number of series. By default the value
depends on the number of points given as input to try to avoid singular matrix. NOTE: if during the computation
of the model a singular matrix is returned try to reduce the u_grade of the series.</li>
<li><strong>get_potential_at_interfaces</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.6)"><em>bool</em></a>) – Get potential at interfaces</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><dl class="docutils">
<dt>depending on the chosen out returns different number of solutions:</dt>
<dd><dl class="first last docutils">
<dt>if output is geology:</dt>
<dd><ol class="first last arabic simple">
<li>Lithologies: block and scalar field</li>
<li>Faults: block and scalar field for each faulting plane</li>
</ol>
</dd>
<dt>if output is ‘gravity’:</dt>
<dd><ol class="first last arabic simple">
<li>Weights: block and scalar field</li>
<li>Faults: block and scalar field for each faulting plane</li>
<li>Forward gravity</li>
</ol>
</dd>
<dt>if output is gradients:</dt>
<dd><ol class="first last arabic simple">
<li>Lithologies: block and scalar field</li>
<li>Faults: block and scalar field for each faulting plane</li>
<li>Gradients of scalar field x</li>
<li>Gradients of scalar field y</li>
<li>Gradients of scalar field z</li>
</ol>
</dd>
</dl>
</dd>
</dl>
<p>In addition if get_potential_at_interfaces is True, the value of the potential field at each of
the interfaces is given as well</p>
</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">list of <code class="xref py py-class docutils literal"><span class="pre">_np.array</span></code></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="gempy_front.compute_model_at">
<code class="descclassname">gempy_front.</code><code class="descname">compute_model_at</code><span class="sig-paren">(</span><em>new_grid_array</em>, <em>interp_data</em>, <em>output=’geology’</em>, <em>u_grade=None</em>, <em>get_potential_at_interfaces=False</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/gempy_front.html#compute_model_at"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#gempy_front.compute_model_at" title="Permalink to this definition">¶</a></dt>
<dd><p>This function does the same as <code class="xref py py-func docutils literal"><span class="pre">compute_model()</span></code> plus the addion functionallity of passing a given
array of point where evaluate the model instead of using the <code class="xref py py-class docutils literal"><span class="pre">gempy.data_management.InputData</span></code> grid.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>new_grid_array</strong> (<code class="xref py py-class docutils literal"><span class="pre">_np.array</span></code>) – 2D array with XYZ (columns) coorinates</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><dl class="docutils">
<dt>depending on the chosen out returns different number of solutions:</dt>
<dd><dl class="first last docutils">
<dt>if output is geology:</dt>
<dd><ol class="first last arabic simple">
<li>Lithologies: block and scalar field</li>
<li>Faults: block and scalar field for each faulting plane</li>
</ol>
</dd>
<dt>if output is ‘gravity’:</dt>
<dd><ol class="first last arabic simple">
<li>Weights: block and scalar field</li>
<li>Faults: block and scalar field for each faulting plane</li>
<li>Forward gravity</li>
</ol>
</dd>
<dt>if output is gradients:</dt>
<dd><ol class="first last arabic simple">
<li>Lithologies: block and scalar field</li>
<li>Faults: block and scalar field for each faulting plane</li>
<li>Gradients of scalar field x</li>
<li>Gradients of scalar field y</li>
<li>Gradients of scalar field z</li>
</ol>
</dd>
</dl>
</dd>
</dl>
<p>In addition if get_potential_at_interfaces is True, the value of the potential field at each of
the interfaces is given as well</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">list of <code class="xref py py-class docutils literal"><span class="pre">_np.array</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="gempy_front.create_data">
<code class="descclassname">gempy_front.</code><code class="descname">create_data</code><span class="sig-paren">(</span><em>extent</em>, <em>resolution=(50</em>, <em>50</em>, <em>50)</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/gempy_front.html#create_data"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#gempy_front.create_data" title="Permalink to this definition">¶</a></dt>
<dd><p>Method to create a <code class="xref py py-class docutils literal"><span class="pre">gempy.data_management.InputData</span></code> object. It is analogous to gempy.InputData()</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>extent</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.6)"><em>list</em></a><em> or </em><a class="reference external" href="https://docs.python.org/3/library/array.html#module-array" title="(in Python v3.6)"><em>array</em></a>) – [x_min, x_max, y_min, y_max, z_min, z_max]. Extent for the visualization of data
and default of for the grid class.</li>
<li><strong>resolution</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.6)"><em>list</em></a><em> or </em><a class="reference external" href="https://docs.python.org/3/library/array.html#module-array" title="(in Python v3.6)"><em>array</em></a>) – [nx, ny, nz]. Resolution for the visualization of data
and default of for the grid class.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name" colspan="2">Keyword Arguments:</th></tr>
<tr class="field-even field"><td> </td><td class="field-body"><ul class="first simple">
<li><strong>Resolution</strong> (<em>(</em><em>Optional</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.6)"><em>list</em></a><em>]</em><em>)</em>) – [nx, ny, nz]. Defaults to 50</li>
<li><strong>path_i</strong> – Path to the data bases of interfaces. Default os.getcwd(),</li>
<li><strong>path_f</strong> – Path to the data bases of orientations. Default os.getcwd()</li>
</ul>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal"><span class="pre">gempy.data_management.InputData</span></code></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="gempy_front.create_from_geomodeller_xml">
<code class="descclassname">gempy_front.</code><code class="descname">create_from_geomodeller_xml</code><span class="sig-paren">(</span><em>fp</em>, <em>resolution=(50</em>, <em>50</em>, <em>50)</em>, <em>return_xml=False</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/gempy_front.html#create_from_geomodeller_xml"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#gempy_front.create_from_geomodeller_xml" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates InputData object from a GeoModeller xml file. Automatically extracts and sets model extent, interface
and orientation data as well as the stratigraphic pile.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>fp</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.6)"><em>str</em></a>) – Filepath for the GeoModeller xml file to be read.</li>
<li><strong>resolution</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.6)"><em>tuple</em></a><em>, </em><em>optional</em>) – Tuple containing the number of voxels in dimensions (x,y,z). Defaults to 50.</li>
<li><strong>return_xml</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.6)"><em>bool</em></a><em>, </em><em>optional</em>) – Toggles returning the ReadGeoModellerXML instance to leverage further info from the
xml file (e.g. for stratigraphic pile ordering). Defaults to True.</li>
<li><strong>**kwargs</strong> – Keyword arguments for create_data function.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">gp.data_management.InputData</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="gempy_front.data_to_pickle">
<code class="descclassname">gempy_front.</code><code class="descname">data_to_pickle</code><span class="sig-paren">(</span><em>geo_data</em>, <em>path=False</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/gempy_front.html#data_to_pickle"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#gempy_front.data_to_pickle" title="Permalink to this definition">¶</a></dt>
<dd><p>Save InputData object to a python pickle (serialization of python). Be aware that if the dependencies
versions used to export and import the pickle differ it may give problems</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>geo_data</strong> (<code class="xref py py-class docutils literal"><span class="pre">gempy.data_management.InputData</span></code>) – </li>
<li><strong>path</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.6)"><em>str</em></a>) – path where save the pickle (without .pickle)</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">None</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="gempy_front.export_to_vtk">
<code class="descclassname">gempy_front.</code><code class="descname">export_to_vtk</code><span class="sig-paren">(</span><em>geo_data</em>, <em>path=None</em>, <em>name=None</em>, <em>lith_block=None</em>, <em>vertices=None</em>, <em>simplices=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/gempy_front.html#export_to_vtk"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#gempy_front.export_to_vtk" title="Permalink to this definition">¶</a></dt>
<dd><p>Export data to a vtk file for posterior visualizations</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>geo_data</strong> (<em>gempy.InputData</em>) – All values of a DataManagement object</li>
<li><strong>block</strong> (<em>numpy.array</em>) – 3D array containing the lithology block</li>
<li><strong>path</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.6)"><em>str</em></a>) – path to the location of the vtk</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">None</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="gempy_front.get_data">
<code class="descclassname">gempy_front.</code><code class="descname">get_data</code><span class="sig-paren">(</span><em>geo_data</em>, <em>itype=’all’</em>, <em>numeric=False</em>, <em>verbosity=0</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/gempy_front.html#get_data"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#gempy_front.get_data" title="Permalink to this definition">¶</a></dt>
<dd><p>Method to return the data stored in <code class="xref py py-class docutils literal"><span class="pre">DataFrame</span></code> within a <code class="xref py py-class docutils literal"><span class="pre">gempy.interpolator.InterpolatorData</span></code>
object.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>geo_data</strong> (<code class="xref py py-class docutils literal"><span class="pre">gempy.interpolator.InterpolatorData</span></code>) – </li>
<li><strong>itype</strong> (<em>str {'all'</em><em>, </em><em>'interfaces'</em><em>, </em><em>'orientaions'</em><em>, </em><em>'formations'</em><em>, </em><em>'series'</em><em>, </em><em>'faults'</em><em>, </em><em>'fautls_relations'}</em>) – input
data type to be retrieved.</li>
<li><strong>numeric</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.6)"><em>bool</em></a>) – if True it only returns numberical properties. This may be useful due to memory issues</li>
<li><strong>verbosity</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.6)"><em>int</em></a>) – Number of properties shown</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">pandas.core.frame.DataFrame</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="gempy_front.get_grid">
<code class="descclassname">gempy_front.</code><code class="descname">get_grid</code><span class="sig-paren">(</span><em>geo_data</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/gempy_front.html#get_grid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#gempy_front.get_grid" title="Permalink to this definition">¶</a></dt>
<dd><p>Coordinates can be found in <code class="xref py py-class docutils literal"><span class="pre">gempy.data_management.GridClass.values</span></code></p>
<blockquote>
<div><dl class="docutils">
<dt>Args:</dt>
<dd>geo_data (<code class="xref py py-class docutils literal"><span class="pre">gempy.interpolator.InterpolatorData</span></code>)</dd>
<dt>Returns:</dt>
<dd><code class="xref py py-class docutils literal"><span class="pre">gempy.data_management.GridClass</span></code></dd>
</dl>
</div></blockquote>
</dd></dl>
<dl class="function">
<dt id="gempy_front.get_kriging_parameters">
<code class="descclassname">gempy_front.</code><code class="descname">get_kriging_parameters</code><span class="sig-paren">(</span><em>interp_data</em>, <em>verbose=0</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/gempy_front.html#get_kriging_parameters"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#gempy_front.get_kriging_parameters" title="Permalink to this definition">¶</a></dt>
<dd><p>Print the kringing parameters</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>interp_data</strong> (<code class="xref py py-class docutils literal"><span class="pre">gempy.data_management.InputData</span></code>) – </li>
<li><strong>verbose</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.6)"><em>int</em></a>) – if > 0 print all the shape values as well.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">None</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="gempy_front.get_sequential_pile">
<code class="descclassname">gempy_front.</code><code class="descname">get_sequential_pile</code><span class="sig-paren">(</span><em>geo_data</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/gempy_front.html#get_sequential_pile"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#gempy_front.get_sequential_pile" title="Permalink to this definition">¶</a></dt>
<dd><p>Visualize an interactive stratigraphic pile to move around the formations and the series. IMPORTANT NOTE:
To have the interactive properties it is necessary the use of an interactive backend. (In notebook use:
%matplotlib qt5 or notebook)</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>geo_data</strong> (<code class="xref py py-class docutils literal"><span class="pre">gempy.interpolator.InterpolatorData</span></code>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.pyplot.Figure</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="gempy_front.get_series">
<code class="descclassname">gempy_front.</code><code class="descname">get_series</code><span class="sig-paren">(</span><em>geo_data</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/gempy_front.html#get_series"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#gempy_front.get_series" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>geo_data</strong> (<code class="xref py py-class docutils literal"><span class="pre">gempy.data_management.InputData</span></code>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Return series and formations relations</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-class docutils literal"><span class="pre">DataFrame</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="gempy_front.get_surfaces">
<code class="descclassname">gempy_front.</code><code class="descname">get_surfaces</code><span class="sig-paren">(</span><em>interp_data</em>, <em>potential_lith=None</em>, <em>potential_fault=None</em>, <em>n_formation=’all’</em>, <em>step_size=1</em>, <em>original_scale=True</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/gempy_front.html#get_surfaces"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#gempy_front.get_surfaces" title="Permalink to this definition">¶</a></dt>
<dd><p>Compute vertices and simplices of the interfaces for its vtk visualization and further
analysis</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>interp_data</strong> (<code class="xref py py-class docutils literal"><span class="pre">gempy.data_management.InputData</span></code>) – </li>
<li><strong>potential_lith</strong> (<em>ndarray</em>) – 1D numpy array with the solution of the computation of the model
containing the scalar field of potentials (second row of lith solution)</li>
<li><strong>potential_fault</strong> (<em>ndarray</em>) – 1D numpy array with the solution of the computation of the model
containing the scalar field of the faults (every second row of fault solution)</li>
<li><strong>n_formation</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.6)"><em>int</em></a><em> or </em><em>'all'</em>) – Positive integer with the number of the formation of which the surface is returned.
use method get_formation_number() to get a dictionary back with the values</li>
<li><strong>step_size</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.6)"><em>int</em></a>) – resolution of the method. This is every how many voxels the marching cube method is applied</li>
<li><strong>original_scale</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.6)"><em>bool</em></a>) – choosing if the coordinates of the vertices are given in the original or the rescaled
coordinates</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">vertices, simpleces</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="gempy_front.get_th_fn">
<code class="descclassname">gempy_front.</code><code class="descname">get_th_fn</code><span class="sig-paren">(</span><em>interp_data</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/gempy_front.html#get_th_fn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#gempy_front.get_th_fn" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the compiled theano function</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>interp_data</strong> (<code class="xref py py-class docutils literal"><span class="pre">gempy.data_management.InputData</span></code>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><dl class="docutils">
<dt>Compiled function if C or CUDA which computes the interpolation given the input data</dt>
<dd>(XYZ of dips, dip, azimuth, polarity, XYZ ref interfaces, XYZ rest interfaces)</dd>
</dl>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-class docutils literal"><span class="pre">theano.compile.function_module.Function</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="gempy_front.interactive_df_change_df">
<code class="descclassname">gempy_front.</code><code class="descname">interactive_df_change_df</code><span class="sig-paren">(</span><em>geo_data</em>, <em>only_selected=False</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/gempy_front.html#interactive_df_change_df"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#gempy_front.interactive_df_change_df" title="Permalink to this definition">¶</a></dt>
<dd><p>Confirm and return the changes made to a dataframe using qgrid interactively. To update the
<code class="xref py py-class docutils literal"><span class="pre">gempy.data_management.InputData</span></code> with the modify df use the correspondant set function.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>geo_data</strong> (<code class="xref py py-class docutils literal"><span class="pre">gempy.data_management.InputData</span></code>) – the same <code class="xref py py-class docutils literal"><span class="pre">gempy.data_management.InputData</span></code>
object used to call <code class="xref py py-func docutils literal"><span class="pre">interactive_df_open()</span></code></li>
<li><strong>only_selected</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.6)"><em>bool</em></a>) – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal"><span class="pre">DataFrame</span></code></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="gempy_front.interactive_df_open">
<code class="descclassname">gempy_front.</code><code class="descname">interactive_df_open</code><span class="sig-paren">(</span><em>geo_data</em>, <em>itype</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/gempy_front.html#interactive_df_open"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#gempy_front.interactive_df_open" title="Permalink to this definition">¶</a></dt>
<dd><p>Open the qgrid interactive DataFrame (<a class="reference external" href="http://qgrid.readthedocs.io/en/latest/">http://qgrid.readthedocs.io/en/latest/</a>).
To seve the changes see: <code class="xref py py-func docutils literal"><span class="pre">interactive_df_change_df()</span></code></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>geo_data</strong> (<code class="xref py py-class docutils literal"><span class="pre">gempy.data_management.InputData</span></code>) – </li>
<li><strong>itype</strong> (<em>str {'all'</em><em>, </em><em>'interfaces'</em><em>, </em><em>'orientaions'</em><em>, </em><em>'formations'</em><em>, </em><em>'series'</em><em>, </em><em>'faults'</em><em>, </em><em>'fautls_relations'}</em>) – input
data type to be retrieved.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Interactive DF</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal"><span class="pre">DataFrame</span></code></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="gempy_front.plot_data">
<code class="descclassname">gempy_front.</code><code class="descname">plot_data</code><span class="sig-paren">(</span><em>geo_data</em>, <em>direction=’y’</em>, <em>data_type=’all’</em>, <em>series=’all’</em>, <em>legend_font_size=6</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/gempy_front.html#plot_data"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#gempy_front.plot_data" title="Permalink to this definition">¶</a></dt>
<dd><p>Plot the projection of the raw data (interfaces and orientations) in 2D following a
specific directions</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>direction</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.6)"><em>str</em></a>) – xyz. Caartesian direction to be plotted</li>
<li><strong>series</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.6)"><em>str</em></a>) – series to plot</li>
<li><strong>**kwargs</strong> – seaborn lmplot key arguments. (TODO: adding the link to them)</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">None</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="gempy_front.plot_data_3D">
<code class="descclassname">gempy_front.</code><code class="descname">plot_data_3D</code><span class="sig-paren">(</span><em>geo_data</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/gempy_front.html#plot_data_3D"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#gempy_front.plot_data_3D" title="Permalink to this definition">¶</a></dt>
<dd><p>Plot in vtk all the input data of a model
:param geo_data: Input data of the model
:type geo_data: gempy.DataManagement.InputData</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">None</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="gempy_front.plot_gradient">
<code class="descclassname">gempy_front.</code><code class="descname">plot_gradient</code><span class="sig-paren">(</span><em>geo_data</em>, <em>scalar_field</em>, <em>gx</em>, <em>gy</em>, <em>gz</em>, <em>cell_number</em>, <em>q_stepsize=5</em>, <em>direction=’y’</em>, <em>plot_scalar=True</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/gempy_front.html#plot_gradient"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#gempy_front.plot_gradient" title="Permalink to this definition">¶</a></dt>
<dd><p>Plot the gradient of the scalar field in a given direction.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>geo_data</strong> (<em>gempy.DataManagement.InputData</em>) – Input data of the model</li>
<li><strong>scalar_field</strong> (<em>numpy.array</em>) – scalar field to plot with the gradient</li>
<li><strong>gx</strong> (<em>numpy.array</em>) – gradient in x-direction</li>
<li><strong>gy</strong> (<em>numpy.array</em>) – gradient in y-direction</li>
<li><strong>gz</strong> (<em>numpy.array</em>) – gradient in z-direction</li>
<li><strong>cell_number</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.6)"><em>int</em></a>) – position of the array to plot</li>
<li><strong>q_stepsize</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.6)"><em>int</em></a>) – step size between arrows to indicate gradient</li>
<li><strong>direction</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.6)"><em>str</em></a>) – xyz. Caartesian direction to be plotted</li>
<li><strong>plot_scalar</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.6)"><em>bool</em></a>) – boolean to plot scalar field</li>
<li><strong>**kwargs</strong> – plt.contour kwargs</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">None</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="gempy_front.plot_scalar_field">
<code class="descclassname">gempy_front.</code><code class="descname">plot_scalar_field</code><span class="sig-paren">(</span><em>geo_data</em>, <em>potential_field</em>, <em>cell_number</em>, <em>N=20</em>, <em>direction=’y’</em>, <em>plot_data=True</em>, <em>series=’all’</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/gempy_front.html#plot_scalar_field"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#gempy_front.plot_scalar_field" title="Permalink to this definition">¶</a></dt>
<dd><p>Plot a potential field in a given direction.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>cell_number</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.6)"><em>int</em></a>) – position of the array to plot</li>
<li><strong>potential_field</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.6)"><em>str</em></a>) – name of the potential field (or series) to plot</li>
<li><strong>n_pf</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.6)"><em>int</em></a>) – number of the potential field (or series) to plot</li>
<li><strong>direction</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.6)"><em>str</em></a>) – xyz. Caartesian direction to be plotted</li>
<li><strong>serie</strong> – <em>Deprecated</em></li>
<li><strong>**kwargs</strong> – plt.contour kwargs</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">None</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="gempy_front.plot_section">
<code class="descclassname">gempy_front.</code><code class="descname">plot_section</code><span class="sig-paren">(</span><em>geo_data</em>, <em>block</em>, <em>cell_number</em>, <em>direction=’y’</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/gempy_front.html#plot_section"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#gempy_front.plot_section" title="Permalink to this definition">¶</a></dt>
<dd><p>Plot a section of the block model</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>cell_number</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.6)"><em>int</em></a>) – position of the array to plot</li>
<li><strong>direction</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.6)"><em>str</em></a>) – xyz. Caartesian direction to be plotted</li>
<li><strong>interpolation</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.6)"><em>str</em></a>) – Type of interpolation of plt.imshow. Default ‘none’. Acceptable values are ‘none’</li>
<li><strong>'bilinear'</strong><strong>, </strong><strong>'bicubic'</strong><strong>,</strong> (<em>,</em><em>'nearest'</em><em>,</em>) – </li>
<li><strong>'spline36'</strong><strong>, </strong><strong>'hanning'</strong><strong>, </strong><strong>'hamming'</strong><strong>, </strong><strong>'hermite'</strong><strong>, </strong><strong>'kaiser'</strong><strong>,</strong> (<em>'spline16'</em><em>,</em>) – </li>
<li><strong>'catrom'</strong><strong>, </strong><strong>'gaussian'</strong><strong>, </strong><strong>'bessel'</strong><strong>, </strong><strong>'mitchell'</strong><strong>, </strong><strong>'sinc'</strong><strong>,</strong> (<em>'quadric'</em><em>,</em>) – </li>
<li><strong>'lanczos'</strong> – <a href="#id1"><span class="problematic" id="id2">**</span></a>kwargs: imshow keywargs</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">None</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="gempy_front.plot_surfaces_3D">
<code class="descclassname">gempy_front.</code><code class="descname">plot_surfaces_3D</code><span class="sig-paren">(</span><em>geo_data</em>, <em>vertices_l</em>, <em>simplices_l</em>, <em>alpha=1</em>, <em>plot_data=True</em>, <em>size=(1920</em>, <em>1080)</em>, <em>fullscreen=False</em>, <em>bg_color=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/gempy_front.html#plot_surfaces_3D"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#gempy_front.plot_surfaces_3D" title="Permalink to this definition">¶</a></dt>
<dd><p>Plot in vtk the surfaces. For getting vertices and simplices See gempy.get_surfaces</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>vertices_l</strong> (<em>numpy.array</em>) – 2D array (XYZ) with the coordinates of the points</li>
<li><strong>simplices_l</strong> (<em>numpy.array</em>) – 2D array with the value of the vertices that form every single triangle</li>
<li><strong>formations_names_l</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.6)"><em>list</em></a>) – Name of the formation of the surfaces</li>
<li><strong>formation_numbers_l</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.6)"><em>list</em></a>) – formation_numbers (int)</li>
<li><strong>alpha</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.6)"><em>float</em></a>) – Opacity</li>
<li><strong>plot_data</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.6)"><em>bool</em></a>) – Default True</li>
<li><strong>size</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.6)"><em>tuple</em></a>) – Resolution of the window</li>
<li><strong>fullscreen</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.6)"><em>bool</em></a>) – Launch window in full screen or not</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">None</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="gempy_front.plot_surfaces_3D_real_time">
<code class="descclassname">gempy_front.</code><code class="descname">plot_surfaces_3D_real_time</code><span class="sig-paren">(</span><em>interp_data</em>, <em>vertices_l</em>, <em>simplices_l</em>, <em>alpha=1</em>, <em>plot_data=True</em>, <em>posterior=None</em>, <em>samples=None</em>, <em>size=(1920</em>, <em>1080)</em>, <em>fullscreen=False</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/gempy_front.html#plot_surfaces_3D_real_time"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#gempy_front.plot_surfaces_3D_real_time" title="Permalink to this definition">¶</a></dt>
<dd><p>Plot in vtk the surfaces in real time. Moving the input data will affect the surfaces.
IMPORTANT NOTE it is highly recommended to have the flag fast_run in the theano optimization. Also note that the
time needed to compute each model increases linearly with every potential field (i.e. fault or discontinuity). It
may be better to just modify each potential field individually to increase the speed (See gempy.select_series).</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>vertices_l</strong> (<em>numpy.array</em>) – 2D array (XYZ) with the coordinates of the points</li>
<li><strong>simplices_l</strong> (<em>numpy.array</em>) – 2D array with the value of the vertices that form every single triangle</li>
<li><strong>formations_names_l</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.6)"><em>list</em></a>) – Name of the formation of the surfaces</li>
<li><strong>formation_numbers_l</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.6)"><em>list</em></a>) – formation_numbers (int)</li>
<li><strong>alpha</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.6)"><em>float</em></a>) – Opacity</li>
<li><strong>plot_data</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.6)"><em>bool</em></a>) – Default True</li>
<li><strong>size</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.6)"><em>tuple</em></a>) – Resolution of the window</li>
<li><strong>fullscreen</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.6)"><em>bool</em></a>) – Launch window in full screen or not</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">None</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="gempy_front.plot_topology">
<code class="descclassname">gempy_front.</code><code class="descname">plot_topology</code><span class="sig-paren">(</span><em>geo_data</em>, <em>G</em>, <em>centroids</em>, <em>direction=’y’</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/gempy_front.html#plot_topology"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#gempy_front.plot_topology" title="Permalink to this definition">¶</a></dt>
<dd><p>Plot the topology adjacency graph in 2-D.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>geo_data</strong> (<em>gempy.data_management.InputData</em>) – </li>
<li><strong>G</strong> (<em>skimage.future.graph.rag.RAG</em>) – </li>
<li><strong>centroids</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.6)"><em>dict</em></a>) – Centroid node coordinates as a dictionary with node id’s (int) as keys and (x,y,z) coordinates
as values.</li>
</ul>
</td>
</tr>
</tbody>
</table>
<dl class="docutils">
<dt>Keyword Args</dt>
<dd>direction (str): “x”, “y” or “z” specifying the slice direction for 2-D topology analysis. Default None.</dd>
</dl>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Nothing, it just plots.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="gempy_front.read_pickle">
<code class="descclassname">gempy_front.</code><code class="descname">read_pickle</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/gempy_front.html#read_pickle"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#gempy_front.read_pickle" title="Permalink to this definition">¶</a></dt>
<dd><p>Read InputData object from python pickle.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>path</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.6)"><em>str</em></a>) – path where save the pickle</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><code class="xref py py-class docutils literal"><span class="pre">gempy.data_management.InputData</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="gempy_front.rescale_data">
<code class="descclassname">gempy_front.</code><code class="descname">rescale_data</code><span class="sig-paren">(</span><em>geo_data</em>, <em>rescaling_factor=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/gempy_front.html#rescale_data"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#gempy_front.rescale_data" title="Permalink to this definition">¶</a></dt>
<dd><p>Rescale the data of a <code class="xref py py-class docutils literal"><span class="pre">gempy.data_management.InputData</span></code>
object between 0 and 1 due to stability problem of the float32.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>geo_data</strong> (<code class="xref py py-class docutils literal"><span class="pre">gempy.data_management.InputData</span></code>) – </li>
<li><strong>rescaling_factor</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.6)"><em>float</em></a>) – factor of the rescaling. Default to maximum distance in one the axis</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Rescaled data</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">gempy.data_management.InputData</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="gempy_front.rescale_factor_default">
<code class="descclassname">gempy_front.</code><code class="descname">rescale_factor_default</code><span class="sig-paren">(</span><em>geo_data</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/gempy_front.html#rescale_factor_default"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#gempy_front.rescale_factor_default" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the default rescaling factor for a given geo_data</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>geo_data</strong> (<code class="xref py py-class docutils literal"><span class="pre">gempy.data_management.InputData</span></code>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">rescaling factor</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.6)">float</a></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="gempy_front.select_series">
<code class="descclassname">gempy_front.</code><code class="descname">select_series</code><span class="sig-paren">(</span><em>geo_data</em>, <em>series</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/gempy_front.html#select_series"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#gempy_front.select_series" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the formations of a given serie in string</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>geo_data</strong> (<code class="xref py py-class docutils literal"><span class="pre">gempy.data_management.InputData</span></code>) – </li>
<li><strong>series</strong> (<em>list of int</em><em> or </em><em>list of str</em>) – Subset of series to be selected</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">New object only containing the selected series</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal"><span class="pre">gempy.data_management.InputData</span></code></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="gempy_front.set_formations">
<code class="descclassname">gempy_front.</code><code class="descname">set_formations</code><span class="sig-paren">(</span><em>geo_data</em>, <em>formations=None</em>, <em>formations_order=None</em>, <em>formations_values=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/gempy_front.html#set_formations"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#gempy_front.set_formations" title="Permalink to this definition">¶</a></dt>
<dd><p>Function to order and change the value of the model formations. The values of the formations will be the final
numerical value that each formation will take in the interpolated geological model (lithology block)
:param geo_data:
:type geo_data: <code class="xref py py-class docutils literal"><span class="pre">gempy.data_management.InputData</span></code>
:param formations_order: List with a given order of the formations. Due to the interpolation algorithm</p>
<blockquote>
<div>this order is only relevant to keep consistent the colors of layers and input data. The order ultimately is
determined by the geometric sedimentary order</div></blockquote>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>formations</strong> (<em>list of str</em>) – same as formations order. you can use any</li>
<li><strong>formations_values</strong> (<em>list of floats</em><em> or </em><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.6)"><em>int</em></a>) – values of the formations will be the final</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>numerical value that each formation will take in the interpolated geological model (lithology block)</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">formations dataframe already updated in place</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-class docutils literal"><span class="pre">DataFrame</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="gempy_front.set_grid">
<code class="descclassname">gempy_front.</code><code class="descname">set_grid</code><span class="sig-paren">(</span><em>geo_data</em>, <em>grid</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/gempy_front.html#set_grid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#gempy_front.set_grid" title="Permalink to this definition">¶</a></dt>
<dd><p>Set a new <code class="xref py py-class docutils literal"><span class="pre">gempy.data_management.GridClass</span></code> object into a <code class="xref py py-class docutils literal"><span class="pre">gempy.data_management.InputData</span></code> object.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>geo_data</strong> (<code class="xref py py-class docutils literal"><span class="pre">gempy.data_management.InputData</span></code>) – </li>
<li><strong>grid</strong> (<code class="xref py py-class docutils literal"><span class="pre">gempy.data_management.GridClass</span></code>) – </li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="gempy_front.set_interfaces">
<code class="descclassname">gempy_front.</code><code class="descname">set_interfaces</code><span class="sig-paren">(</span><em>geo_data</em>, <em>interf_dataframe</em>, <em>append=False</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/gempy_front.html#set_interfaces"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#gempy_front.set_interfaces" title="Permalink to this definition">¶</a></dt>
<dd><p>Method to change or append a Dataframe to interfaces in place.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>geo_data</strong> (<code class="xref py py-class docutils literal"><span class="pre">gempy.data_management.InputData</span></code>) – </li>
<li><strong>interf_dataframe</strong> (<code class="xref py py-class docutils literal"><span class="pre">DataFrame</span></code>) – </li>
<li><strong>append</strong> (<em>Bool</em>) – if you want to append the new data frame or substitute it</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="gempy_front.set_interpolation_data">
<code class="descclassname">gempy_front.</code><code class="descname">set_interpolation_data</code><span class="sig-paren">(</span><em>geo_data</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/gempy_front.html#set_interpolation_data"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#gempy_front.set_interpolation_data" title="Permalink to this definition">¶</a></dt>
<dd><dl class="docutils">
<dt>Create a <code class="xref py py-class docutils literal"><span class="pre">gempy.interpolator.InterpolatorData</span></code>. InterpolatorData is a class that contains all the</dt>
<dd>preprocessing operations to prepare the data to compute the model.
Also is the object that has to be manipulated to vary the data without recompile the modeling function.</dd>
</dl>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>geo_data</strong> (<em>gempy.DataManagement.InputData</em>) – All values of a DataManagement object</li>
<li><strong>compile_theano</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.6)"><em>bool</em></a>) – select if the theano function is compiled during the initialization. Default: True</li>
<li><strong>compute_all</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.6)"><em>bool</em></a>) – <p>If true the solution gives back the block model of lithologies, the potential field and
the block model of faults. If False only return the block model of lithologies. This may be important to speed</p>
<blockquote>
<div>up the computation. Default True</div></blockquote>
</li>
<li><strong>u_grade</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.6)"><em>list</em></a>) – grade of the polynomial for the universal part of the Kriging interpolations. The value has to</li>
<li><strong>either 0</strong><strong>, </strong><strong>3</strong><strong> or </strong><strong>9</strong> (<em>be</em>) – </li>
<li><strong>on the number of points given as input to try to avoid singular matrix. NOTE</strong> (<em>depends</em>) – if during the computation</li>
<li><strong>the model a singular matrix is returned try to reduce the u_grade of the series.</strong> (<em>of</em>) – </li>
<li><strong>rescaling_factor</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.6)"><em>float</em></a>) – rescaling factor of the input data to improve the stability when float32 is used. By</li>
<li><strong>the rescaling factor is calculated to obtein values between 0 and 1.</strong> (<em>defaut</em>) – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name" colspan="2">Keyword Arguments:</th></tr>
<tr class="field-even field"><td> </td><td class="field-body"><ul class="first last simple">
<li><strong>dtype</strong> (<em>'str'</em>) – Choosing if using float32 or float64. This is important if is intended to use the GPU</li>
<li><strong>Also InterpolatorClass kwargs</strong> (<em>See</em>) – </li>
</ul>
</td>
</tr>
</tbody>
</table>
<dl class="attribute">
<dt id="gempy_front.geo_data">
<code class="descclassname">gempy_front.</code><code class="descname">geo_data</code><a class="headerlink" href="#gempy_front.geo_data" title="Permalink to this definition">¶</a></dt>
<dd><p>Original gempy.DataManagement.InputData object</p>
</dd></dl>
<dl class="attribute">
<dt id="gempy_front.geo_data_res">
<code class="descclassname">gempy_front.</code><code class="descname">geo_data_res</code><a class="headerlink" href="#gempy_front.geo_data_res" title="Permalink to this definition">¶</a></dt>
<dd><p>Rescaled data. It has the same structure has gempy.InputData</p>
</dd></dl>
<dl class="attribute">
<dt id="gempy_front.interpolator">
<code class="descclassname">gempy_front.</code><code class="descname">interpolator</code><a class="headerlink" href="#gempy_front.interpolator" title="Permalink to this definition">¶</a></dt>
<dd><p>Instance of the gempy.DataManagement.InterpolaorInput.InterpolatorClass. See Also
gempy.DataManagement.InterpolaorInput.InterpolatorClass docs
th_fn: Theano function which compute the interpolation</p>
</dd></dl>
<dl class="attribute">
<dt id="gempy_front.dtype">
<code class="descclassname">gempy_front.</code><code class="descname">dtype</code><a class="headerlink" href="#gempy_front.dtype" title="Permalink to this definition">¶</a></dt>
<dd><p>type of float</p>
</dd></dl>
</dd></dl>
<dl class="function">
<dt id="gempy_front.set_orientation_from_interfaces">
<code class="descclassname">gempy_front.</code><code class="descname">set_orientation_from_interfaces</code><span class="sig-paren">(</span><em>geo_data</em>, <em>indices_array</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/gempy_front.html#set_orientation_from_interfaces"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#gempy_front.set_orientation_from_interfaces" title="Permalink to this definition">¶</a></dt>
<dd><dl class="docutils">
<dt>Create and set orientations from at least 3 points of the <code class="xref py py-attr docutils literal"><span class="pre">gempy.data_management.InputData.interfaces</span></code></dt>
<dd>Dataframe</dd>
</dl>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>geo_data</strong> (<code class="xref py py-class docutils literal"><span class="pre">gempy.data_management.InputData</span></code>) – </li>
<li><strong>indices_array</strong> (<em>array-like</em>) – 1D or 2D array with the pandas indices of the
<code class="xref py py-attr docutils literal"><span class="pre">gempy.data_management.InputData.interfaces</span></code>. If 2D every row of the 2D matrix will be used to create an
orientation</li>
<li><strong>verbose</strong> – </li>
</ul>
</td>
</tr>