Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[GitHub source](https://github.com/SeequentEvo/evo-python-sdk/blob/main/packages/evo-compute/src/evo/compute/tasks/common/search.py)
::: evo.compute.tasks.common.search.SearchNeighborhood
[GitHub source](https://github.com/SeequentEvo/evo-python-sdk/blob/main/packages/evo-compute/src/evo/compute/tasks/geostatistics/search.py)
::: evo.compute.tasks.geostatistics.search.SearchNeighborhood
options:
show_labels: false
Original file line number Diff line number Diff line change
Expand Up @@ -92,13 +92,13 @@ <h2 id="evo.compute.tasks.geostatistics.break_ties.BreakTiesParameters" class="d
<p>Parameters for the break-ties task.</p>
<p>Defines all inputs needed to run a break-ties spatial tie-breaking task.</p>
<p>Example::</p>
<pre><code>&gt;&gt;&gt; from evo.compute.tasks import run, SearchNeighborhood, Ellipsoid, EllipsoidRanges, Target
<pre><code>&gt;&gt;&gt; from evo.compute.tasks import run, SimpleSearchNeighborhood, Ellipsoid, EllipsoidRanges, Target
&gt;&gt;&gt; from evo.compute.tasks.geostatistics.break_ties import BreakTiesParameters
&gt;&gt;&gt;
&gt;&gt;&gt; params = BreakTiesParameters(
... source=pointset.attributes["grade"],
... target=Target.new_attribute(pointset, "grade_tiebroken"),
... neighborhood=SearchNeighborhood(
... neighborhood=SimpleSearchNeighborhood(
... ellipsoid=Ellipsoid(ranges=EllipsoidRanges(200, 150, 100)),
... max_samples=20,
... ),
Expand Down Expand Up @@ -173,7 +173,7 @@ <h3 id="evo.compute.tasks.geostatistics.break_ties.BreakTiesParameters.neighborh


</h3>
<div class="doc-signature highlight"><pre><span></span><code><span class="n">neighborhood</span><span class="p">:</span> <span class="n">SearchNeighborhood</span>
<div class="doc-signature highlight"><pre><span></span><code><span class="n">neighborhood</span><span class="p">:</span> <span class="n">SimpleSearchNeighborhood</span>
</code></pre></div>

<div class="doc doc-contents ">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ <h2 id="evo.compute.tasks.geostatistics.conditional_turning_bands.ConditionalTur
... target=grid,
... distribution=distribution_object,
... variogram_model=variogram,
... neighborhood=SearchNeighborhood(
... neighborhood=SimpleSearchNeighborhood(
... ellipsoid=Ellipsoid(ranges=EllipsoidRanges(70, 70, 5)),
... max_samples=40,
... ),
Expand Down Expand Up @@ -237,7 +237,7 @@ <h3 id="evo.compute.tasks.geostatistics.conditional_turning_bands.ConditionalTur


</h3>
<div class="doc-signature highlight"><pre><span></span><code><span class="n">neighborhood</span><span class="p">:</span> <span class="n">SearchNeighborhood</span>
<div class="doc-signature highlight"><pre><span></span><code><span class="n">neighborhood</span><span class="p">:</span> <span class="n">SimpleSearchNeighborhood</span>
</code></pre></div>

<div class="doc doc-contents ">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,7 @@ <h3 id="evo.compute.tasks.geostatistics.conditioned_simulator.ConSimParameters.n


</h3>
<div class="doc-signature highlight"><pre><span></span><code><span class="n">neighborhood</span><span class="p">:</span> <span class="n">SearchNeighborhood</span>
<div class="doc-signature highlight"><pre><span></span><code><span class="n">neighborhood</span><span class="p">:</span> <span class="n">SimpleSearchNeighborhood</span>
</code></pre></div>

<div class="doc doc-contents ">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
</a>
</li>
<li class="nav-item">
<a rel="next" href="../simulation-report/SimReportContext.html" class="nav-link">
<a rel="next" href="SimpleSearchNeighborhood.html" class="nav-link">
Next <i class="fa fa-arrow-right"></i>
</a>
</li>
Expand All @@ -61,7 +61,7 @@
<div id="toc-collapse" class="navbar-collapse collapse card bg-body-tertiary">
<ul class="nav flex-column">

<li class="nav-item" data-bs-level="2"><a href="#evo.compute.tasks.common.search.SearchNeighborhood" class="nav-link">SearchNeighborhood</a>
<li class="nav-item" data-bs-level="2"><a href="#evo.compute.tasks.geostatistics.search.SearchNeighborhood" class="nav-link">SearchNeighborhood</a>
<ul class="nav flex-column">
</ul>
</li>
Expand All @@ -70,16 +70,16 @@
</div></div>
<div class="col-md-9" role="main">

<p><a href="https://github.com/SeequentEvo/evo-python-sdk/blob/main/packages/evo-compute/src/evo/compute/tasks/common/search.py">GitHub source</a>
<p><a href="https://github.com/SeequentEvo/evo-python-sdk/blob/main/packages/evo-compute/src/evo/compute/tasks/geostatistics/search.py">GitHub source</a>
</p>


<div class="doc doc-object doc-class">



<h2 id="evo.compute.tasks.common.search.SearchNeighborhood" class="doc doc-heading">
<span class="doc doc-object-name doc-class-name">evo.compute.tasks.common.search.SearchNeighborhood</span>
<h2 id="evo.compute.tasks.geostatistics.search.SearchNeighborhood" class="doc doc-heading">
<span class="doc doc-object-name doc-class-name">evo.compute.tasks.geostatistics.search.SearchNeighborhood</span>


</h2>
Expand All @@ -89,16 +89,10 @@ <h2 id="evo.compute.tasks.common.search.SearchNeighborhood" class="doc doc-headi



<p>Search neighborhood parameters for geostatistical operations.</p>
<p>Defines how to find nearby samples when performing spatial interpolation
or estimation. Used by kriging, simulation, and other geostatistical tasks.</p>
<p>The search neighborhood is defined by an ellipsoid (spatial extent and
orientation) and constraints on the number of samples to use.</p>
<p>Kriging, IDW, KNN and declustering can further limit the samples by octant,
quadrant and drillhole (<code>max_samples_per_drillhole</code> and <code>max_drillholes</code>).
Kriging additionally supports <code>min_drillholes</code> and non-global
<code>drillhole_limit_scope</code>. The other tasks do not support these limits and
refuse a neighborhood that sets them.</p>
<p>Extended search neighborhood with octant, quadrant, and drillhole controls.</p>
<p>Extends :class:<code>SimpleSearchNeighborhood</code> with sector (octant / quadrant)
and drillhole quotas for estimation and declustering tasks (Kriging, IDW,
KNN, and Declustering).</p>
<p>Example::</p>
<pre><code>&gt;&gt;&gt; search = SearchNeighborhood(
... ellipsoid=Ellipsoid(
Expand Down Expand Up @@ -141,73 +135,7 @@ <h2 id="evo.compute.tasks.common.search.SearchNeighborhood" class="doc doc-headi



<h3 id="evo.compute.tasks.common.search.SearchNeighborhood.ellipsoid" class="doc doc-heading">
<span class="doc doc-object-name doc-attribute-name">ellipsoid</span>


</h3>
<div class="doc-signature highlight"><pre><span></span><code><span class="n">ellipsoid</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
<span class="n">Ellipsoid</span><span class="p">,</span>
<span class="n">PlainValidator</span><span class="p">(</span><span class="n">_validate_ellipsoid</span><span class="p">),</span>
<span class="n">PlainSerializer</span><span class="p">(</span><span class="n">_serialize_ellipsoid</span><span class="p">),</span>
<span class="n">WithJsonSchema</span><span class="p">(</span><span class="n">_ELLIPSOID_JSON_SCHEMA</span><span class="p">),</span>
<span class="p">]</span>
</code></pre></div>

<div class="doc doc-contents ">

<p>The ellipsoid defining the spatial extent to search for samples.</p>

</div>

</div>

<div class="doc doc-object doc-attribute">



<h3 id="evo.compute.tasks.common.search.SearchNeighborhood.max_samples" class="doc doc-heading">
<span class="doc doc-object-name doc-attribute-name">max_samples</span>


</h3>
<div class="doc-signature highlight"><pre><span></span><code><span class="n">max_samples</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="n">Field</span><span class="p">(</span><span class="n">ge</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
</code></pre></div>

<div class="doc doc-contents ">

<p>The maximum number of samples to use for each evaluation point.</p>

</div>

</div>

<div class="doc doc-object doc-attribute">



<h3 id="evo.compute.tasks.common.search.SearchNeighborhood.min_samples" class="doc doc-heading">
<span class="doc doc-object-name doc-attribute-name">min_samples</span>


</h3>
<div class="doc-signature highlight"><pre><span></span><code><span class="n">min_samples</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="n">Field</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="n">ge</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
</code></pre></div>

<div class="doc doc-contents ">

<p>The minimum number of samples required, between 1 and <code>max_samples</code>.</p>
<p>If fewer are found, the point may be skipped.</p>

</div>

</div>

<div class="doc doc-object doc-attribute">



<h3 id="evo.compute.tasks.common.search.SearchNeighborhood.max_empty_octants" class="doc doc-heading">
<h3 id="evo.compute.tasks.geostatistics.search.SearchNeighborhood.max_empty_octants" class="doc doc-heading">
<span class="doc doc-object-name doc-attribute-name">max_empty_octants</span>


Expand All @@ -228,7 +156,7 @@ <h3 id="evo.compute.tasks.common.search.SearchNeighborhood.max_empty_octants" cl



<h3 id="evo.compute.tasks.common.search.SearchNeighborhood.max_samples_per_octant" class="doc doc-heading">
<h3 id="evo.compute.tasks.geostatistics.search.SearchNeighborhood.max_samples_per_octant" class="doc doc-heading">
<span class="doc doc-object-name doc-attribute-name">max_samples_per_octant</span>


Expand All @@ -248,7 +176,7 @@ <h3 id="evo.compute.tasks.common.search.SearchNeighborhood.max_samples_per_octan



<h3 id="evo.compute.tasks.common.search.SearchNeighborhood.max_empty_quadrants" class="doc doc-heading">
<h3 id="evo.compute.tasks.geostatistics.search.SearchNeighborhood.max_empty_quadrants" class="doc doc-heading">
<span class="doc doc-object-name doc-attribute-name">max_empty_quadrants</span>


Expand All @@ -269,7 +197,7 @@ <h3 id="evo.compute.tasks.common.search.SearchNeighborhood.max_empty_quadrants"



<h3 id="evo.compute.tasks.common.search.SearchNeighborhood.max_samples_per_quadrant" class="doc doc-heading">
<h3 id="evo.compute.tasks.geostatistics.search.SearchNeighborhood.max_samples_per_quadrant" class="doc doc-heading">
<span class="doc doc-object-name doc-attribute-name">max_samples_per_quadrant</span>


Expand All @@ -289,7 +217,7 @@ <h3 id="evo.compute.tasks.common.search.SearchNeighborhood.max_samples_per_quadr



<h3 id="evo.compute.tasks.common.search.SearchNeighborhood.max_samples_per_drillhole" class="doc doc-heading">
<h3 id="evo.compute.tasks.geostatistics.search.SearchNeighborhood.max_samples_per_drillhole" class="doc doc-heading">
<span class="doc doc-object-name doc-attribute-name">max_samples_per_drillhole</span>


Expand All @@ -309,7 +237,7 @@ <h3 id="evo.compute.tasks.common.search.SearchNeighborhood.max_samples_per_drill



<h3 id="evo.compute.tasks.common.search.SearchNeighborhood.max_drillholes" class="doc doc-heading">
<h3 id="evo.compute.tasks.geostatistics.search.SearchNeighborhood.max_drillholes" class="doc doc-heading">
<span class="doc doc-object-name doc-attribute-name">max_drillholes</span>


Expand All @@ -331,7 +259,7 @@ <h3 id="evo.compute.tasks.common.search.SearchNeighborhood.max_drillholes" class



<h3 id="evo.compute.tasks.common.search.SearchNeighborhood.min_drillholes" class="doc doc-heading">
<h3 id="evo.compute.tasks.geostatistics.search.SearchNeighborhood.min_drillholes" class="doc doc-heading">
<span class="doc doc-object-name doc-attribute-name">min_drillholes</span>


Expand All @@ -344,8 +272,7 @@ <h3 id="evo.compute.tasks.common.search.SearchNeighborhood.min_drillholes" class
<div class="doc doc-contents ">

<p>The minimum number of distinct drillholes required per estimate.</p>
<p>Omitted (disabled) when <code>None</code> or <code>0</code>. Currently supported only by kriging
and requires a downhole intervals source object.</p>
<p>Omitted (disabled) when <code>None</code> or <code>0</code>. Requires a downhole intervals source object.</p>

</div>

Expand All @@ -355,7 +282,7 @@ <h3 id="evo.compute.tasks.common.search.SearchNeighborhood.min_drillholes" class



<h3 id="evo.compute.tasks.common.search.SearchNeighborhood.drillhole_limit_scope" class="doc doc-heading">
<h3 id="evo.compute.tasks.geostatistics.search.SearchNeighborhood.drillhole_limit_scope" class="doc doc-heading">
<span class="doc doc-object-name doc-attribute-name">drillhole_limit_scope</span>


Expand All @@ -368,8 +295,8 @@ <h3 id="evo.compute.tasks.common.search.SearchNeighborhood.drillhole_limit_scope
<p>Scope at which <code>max_samples_per_drillhole</code> is applied.</p>
<p><code>"global"</code> (or <code>None</code>) applies <code>max_samples_per_drillhole</code> across the whole
neighborhood and is omitted on the wire. <code>"quadrant"</code> and <code>"octant"</code> apply
<code>max_samples_per_drillhole</code> within each sector, require <code>max_samples_per_drillhole</code>
to be set, and are currently supported only by kriging.</p>
<code>max_samples_per_drillhole</code> within each sector and require <code>max_samples_per_drillhole</code>
to be set.</p>

</div>

Expand All @@ -379,7 +306,7 @@ <h3 id="evo.compute.tasks.common.search.SearchNeighborhood.drillhole_limit_scope



<h3 id="evo.compute.tasks.common.search.SearchNeighborhood.max_drillholes_per_estimate" class="doc doc-heading">
<h3 id="evo.compute.tasks.geostatistics.search.SearchNeighborhood.max_drillholes_per_estimate" class="doc doc-heading">
<span class="doc doc-object-name doc-attribute-name">max_drillholes_per_estimate</span>


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@

<ul class="nav navbar-nav ms-md-auto">
<li class="nav-item">
<a rel="prev" href="../search/SearchNeighborhood.html" class="nav-link">
<a rel="prev" href="../search/SimpleSearchNeighborhood.html" class="nav-link">
<i class="fa fa-arrow-left"></i> Previous
</a>
</li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ <h2 id="evo.compute.tasks.geostatistics.simulation_report.SimulationReportParame
... block_simulations=grid.attributes["block_sims"],
... block_simulations_normal_score=grid.attributes["block_sims_ns"],
... variogram_model=variogram_url,
... neighborhood=SearchNeighborhood(...),
... neighborhood=SimpleSearchNeighborhood(...),
... number_of_simulations=50,
... random_seed=38239342,
... )
Expand Down Expand Up @@ -297,7 +297,7 @@ <h3 id="evo.compute.tasks.geostatistics.simulation_report.SimulationReportParame


</h3>
<div class="doc-signature highlight"><pre><span></span><code><span class="n">neighborhood</span><span class="p">:</span> <span class="n">SearchNeighborhood</span>
<div class="doc-signature highlight"><pre><span></span><code><span class="n">neighborhood</span><span class="p">:</span> <span class="n">SimpleSearchNeighborhood</span>
</code></pre></div>

<div class="doc doc-contents ">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,28 @@ <h3 id="evo.objects.typed.types.Ellipsoid.rotation" class="doc doc-heading">



<div class="doc doc-object doc-function">


<h3 id="evo.objects.typed.types.Ellipsoid.from_dict" class="doc doc-heading">
<span class="doc doc-object-name doc-function-name">from_dict</span>


</h3>
<div class="doc-signature highlight"><pre><span></span><code><span class="nf">from_dict</span><span class="p">(</span><span class="n">data</span><span class="p">:</span> <span class="n">Mapping</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="n">Ellipsoid</span>
</code></pre></div>

<div class="doc doc-contents ">

<p>Construct an :class:<code>Ellipsoid</code> from a wire-shaped mapping.</p>
<p>Accepts <code>ellipsoid_ranges</code> (or <code>ranges</code>) and an optional <code>rotation</code>
mapping whose omitted angles default to <code>0</code>.</p>


</div>

</div>

<div class="doc doc-object doc-function">


Expand Down
2 changes: 1 addition & 1 deletion packages/evo-compute/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ authors = [

dependencies = [
"evo-blockmodels[utils]>=0.10.0",
"evo-objects[utils,blockmodels]>=0.7.0",
"evo-objects[utils,blockmodels]>=0.7.1",
"evo-sdk-common>=0.6.0",
"pydantic>=2",
"typing_extensions>=4.0",
Expand Down
2 changes: 2 additions & 0 deletions packages/evo-compute/src/evo/compute/tasks/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@
FilterCondition,
Rotation,
SearchNeighborhood,
SimpleSearchNeighborhood,
Source,
Target,
UpdateAttribute,
Expand Down Expand Up @@ -187,6 +188,7 @@ async def run(
"LocationWiseResult",
"Rotation",
"SearchNeighborhood",
"SimpleSearchNeighborhood",
"Source",
"Target",
"TaskResultList",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
from .filters import AllOfFilter, AnyOfFilter, Filter, FilterCondition, FilterExpression, FilterOperator
from .results import TaskAttribute, TaskResultList, TaskTarget
from .runner import TaskRegistry, TaskRunner, TParams, TResult, TResultModel, run_tasks
from .search import SearchNeighborhood
from .search import SearchNeighborhood, SimpleSearchNeighborhood
from .source_target import (
AnySourceAttribute,
AnyTargetAttribute,
Expand Down Expand Up @@ -47,6 +47,7 @@
"GeoscienceObjectReference",
"Rotation",
"SearchNeighborhood",
"SimpleSearchNeighborhood",
"Source",
"TParams",
"TResult",
Expand Down
Loading