/
gempy.core.grid_modules.grid_types.CenteredGrid.html
254 lines (204 loc) · 14.4 KB
/
gempy.core.grid_modules.grid_types.CenteredGrid.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>gempy.core.grid_modules.grid_types.CenteredGrid — GemPy 2.2.8 documentation</title>
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../../_static/gallery.css" />
<link rel="stylesheet" type="text/css" href="../../_static/gallery-binder.css" />
<link rel="stylesheet" type="text/css" href="../../_static/gallery-dataframe.css" />
<link rel="stylesheet" type="text/css" href="../../_static/gallery-rendered-html.css" />
<script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
<script src="../../_static/jquery.js"></script>
<script src="../../_static/underscore.js"></script>
<script src="../../_static/doctools.js"></script>
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="shortcut icon" href="../../_static/favicon.ico"/>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<link rel="next" title="gempy.core.data_modules.geometric_data.SurfacePoints" href="../gempy.core.data_modules.geometric_data.SurfacePoints.html" />
<link rel="prev" title="gempy.core.grid_modules.grid_types.Sections" href="gempy.core.grid_modules.grid_types.Sections.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="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="gempy-core-grid-modules-grid-types-centeredgrid">
<h1>gempy.core.grid_modules.grid_types.CenteredGrid<a class="headerlink" href="#gempy-core-grid-modules-grid-types-centeredgrid" title="Permalink to this headline">¶</a></h1>
<dl class="py class">
<dt id="gempy.core.grid_modules.grid_types.CenteredGrid">
<em class="property">class </em><code class="sig-prename descclassname">gempy.core.grid_modules.grid_types.</code><code class="sig-name descname">CenteredGrid</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">centers</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">radius</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">resolution</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/gempy/core/grid_modules/grid_types.html#CenteredGrid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#gempy.core.grid_modules.grid_types.CenteredGrid" title="Permalink to this definition">¶</a></dt>
<dd><p>Logarithmic spaced grid.</p>
<p class="rubric">Examples using CenteredGrid</p>
<div class="sphx-glr-clear"></div><p class="rubric">Methods</p>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#gempy.core.grid_modules.grid_types.CenteredGrid.__init__" title="gempy.core.grid_modules.grid_types.CenteredGrid.__init__"><code class="xref py py-obj docutils literal notranslate"><span class="pre">__init__</span></code></a>([centers, radius, resolution])</p></td>
<td><p>Initialize self.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#gempy.core.grid_modules.grid_types.CenteredGrid.create_irregular_grid_kernel" title="gempy.core.grid_modules.grid_types.CenteredGrid.create_irregular_grid_kernel"><code class="xref py py-obj docutils literal notranslate"><span class="pre">create_irregular_grid_kernel</span></code></a>(resolution, radius)</p></td>
<td><p>Create an isometric grid kernel (centered at 0)</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#gempy.core.grid_modules.grid_types.CenteredGrid.set_centered_grid" title="gempy.core.grid_modules.grid_types.CenteredGrid.set_centered_grid"><code class="xref py py-obj docutils literal notranslate"><span class="pre">set_centered_grid</span></code></a>(centers[, kernel_centers])</p></td>
<td><p>Main method of the class, set the XYZ values around centers using a kernel.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#gempy.core.grid_modules.grid_types.CenteredGrid.set_centered_kernel" title="gempy.core.grid_modules.grid_types.CenteredGrid.set_centered_kernel"><code class="xref py py-obj docutils literal notranslate"><span class="pre">set_centered_kernel</span></code></a>(resolution, radius)</p></td>
<td><p>Set a centered</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">set_tz_kernel</span></code>(**kwargs)</p></td>
<td><p></p></td>
</tr>
</tbody>
</table>
<dl class="py method">
<dt id="gempy.core.grid_modules.grid_types.CenteredGrid.__init__">
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">centers</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">radius</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">resolution</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/gempy/core/grid_modules/grid_types.html#CenteredGrid.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#gempy.core.grid_modules.grid_types.CenteredGrid.__init__" title="Permalink to this definition">¶</a></dt>
<dd><p>Initialize self. See help(type(self)) for accurate signature.</p>
</dd></dl>
<dl class="py method">
<dt id="gempy.core.grid_modules.grid_types.CenteredGrid.create_irregular_grid_kernel">
<em class="property">static </em><code class="sig-name descname">create_irregular_grid_kernel</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">resolution</span></em>, <em class="sig-param"><span class="n">radius</span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/gempy/core/grid_modules/grid_types.html#CenteredGrid.create_irregular_grid_kernel"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#gempy.core.grid_modules.grid_types.CenteredGrid.create_irregular_grid_kernel" title="Permalink to this definition">¶</a></dt>
<dd><p>Create an isometric grid kernel (centered at 0)</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>resolution</strong> – [s0] (numpy.ndarray[int]): [nx, ny, nz</p></li>
<li><p><strong>radius</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.9)"><em>float</em></a>) – Maximum distance of the kernel</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>center of the voxel, left edge of each voxel (for xyz), right edge of each voxel (for xyz).</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.9)">tuple</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="gempy.core.grid_modules.grid_types.CenteredGrid.set_centered_kernel">
<code class="sig-name descname">set_centered_kernel</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">resolution</span></em>, <em class="sig-param"><span class="n">radius</span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/gempy/core/grid_modules/grid_types.html#CenteredGrid.set_centered_kernel"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#gempy.core.grid_modules.grid_types.CenteredGrid.set_centered_kernel" title="Permalink to this definition">¶</a></dt>
<dd><p>Set a centered</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>resolution</strong> – [s0] (numpy.ndarray[int]): [nx, ny, nz</p></li>
<li><p><strong>radius</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.9)"><em>float</em></a>) – Maximum distance of the kernel</p></li>
</ul>
</dd>
</dl>
<p>Returns:</p>
</dd></dl>
<dl class="py method">
<dt id="gempy.core.grid_modules.grid_types.CenteredGrid.set_centered_grid">
<code class="sig-name descname">set_centered_grid</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">centers</span></em>, <em class="sig-param"><span class="n">kernel_centers</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/gempy/core/grid_modules/grid_types.html#CenteredGrid.set_centered_grid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#gempy.core.grid_modules.grid_types.CenteredGrid.set_centered_grid" title="Permalink to this definition">¶</a></dt>
<dd><p>Main method of the class, set the XYZ values around centers using a kernel.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>centers</strong> (<em>np.array</em>) – XYZ array with the centers of where we want to create a grid around</p></li>
<li><p><strong>kernel_centers</strong> (<em>Optional</em><em>[</em><em>np.array</em><em>]</em>) – center of the voxels of a desired kernel.</p></li>
<li><p><strong>**kwargs</strong> – <ul>
<li><p>resolution: [s0] (numpy.ndarray[int]): [nx, ny, nz</p></li>
<li><p>radius (float): Maximum distance of the kernel</p></li>
</ul>
</p></li>
</ul>
</dd>
</dl>
<p>Returns:</p>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
<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"/>
</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 class="badge" 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>
<li class="toctree-l1"><a class="reference internal" href="../../index.html">About</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../projects.html">Additional projects</a></li>
</ul>
<p class="caption"><span class="caption-text">Getting started</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../getting_started/index.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/index.html">GemPy Tutorials</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../examples/index.html">Examples</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../integrations/index.html">Integrations</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../../code.html">Code</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../../code.html#gempy-api">GemPy API</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../code.html#model">Model</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../code.html#plot">Plot</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../code.html#data">Data</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="../../code.html#grids">Grids</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../code.html#geometric-data">Geometric Data</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../code.html#interpolator">Interpolator</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../code.html#solution">Solution</a></li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../../index.html">Documentation overview</a><ul>
<li><a href="../../code.html">Code</a><ul>
<li>Previous: <a href="gempy.core.grid_modules.grid_types.Sections.html" title="previous chapter">gempy.core.grid_modules.grid_types.Sections</a></li>
<li>Next: <a href="../gempy.core.data_modules.geometric_data.SurfacePoints.html" title="next chapter">gempy.core.data_modules.geometric_data.SurfacePoints</a></li>
</ul></li>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
©2017-2021, CGRE-Aachen Team.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 3.4.3</a>
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
<a href="../../_sources/Data/Grid/gempy.core.grid_modules.grid_types.CenteredGrid.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>