# lsdtools.geostats reference
URL: https://lsd.tools/docs/sdk-lsdtools-geostats
Updated: 2026-09-09

SDK distribution **1.0.0**; API contract **1.0**; generator **1.0.0**.

Product source digest: `4ea39055732e8883c03ccfecf12af6ccebd2041a12ce1b843e4a769e200f5ef9`.

Generated from declared public exports and source syntax. Signatures and annotations are declaration spellings; decorators, factories and annotations are never executed. Class members below are declared members; base classes remain explicit. Source docstrings describe their owning implementation; they do not grant app permissions.

```text
Lazy public facade for LSD deterministic geostatistical estimation.

Importing this module does not import NumPy, load native artifacts, initialize
CUDA, or import the product runtime. External packages should use this module
instead of importing ``lsd_geostats_runtime`` directly.
```


## `lsdtools.geostats.AdvancedSearchSpec`

Kind: class. Source: `sdk/src/lsdtools/geostats.py:326`.

Source docstring:

```text
Region and octant controls retained independently of search policy.
```


### `lsdtools.geostats.AdvancedSearchSpec.selected_region`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:329`.

```python
selected_region: Any | None
```


```python
selected_region = None
```


### `lsdtools.geostats.AdvancedSearchSpec.use_octants`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:330`.

```python
use_octants: bool
```


```python
use_octants = False
```


### `lsdtools.geostats.AdvancedSearchSpec.min_per_octant`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:331`.

```python
min_per_octant: int
```


```python
min_per_octant = 0
```


### `lsdtools.geostats.AdvancedSearchSpec.max_per_octant`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:332`.

```python
max_per_octant: int | None
```


```python
max_per_octant = None
```


### `lsdtools.geostats.AdvancedSearchSpec.min_octants`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:333`.

```python
min_octants: int
```


```python
min_octants = 0
```


## `lsdtools.geostats.Backend`

Kind: value. Source: `sdk/src/lsdtools/geostats.py:21`.

```python
Backend = Literal['cpu', 'cuda', 'auto']
```


## `lsdtools.geostats.BlockDiscretizationSpec`

Kind: class. Source: `sdk/src/lsdtools/geostats.py:796`.

Source docstring:

```text
X/Y/Z equal-weight integration counts for cell support.
```


### `lsdtools.geostats.BlockDiscretizationSpec.counts`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:799`.

```python
counts: tuple[int, int, int]
```


```python
counts = (1, 1, 1)
```


## `lsdtools.geostats.CdfSpec`

Kind: value. Source: `sdk/src/lsdtools/geostats.py:616`.

```python
CdfSpec = GaussianCdfSpec | UniformCdfSpec | LogNormalCdfSpec | EmpiricalCdfSpec
```


## `lsdtools.geostats.CompatibilityProfile`

Kind: class. Source: `sdk/src/lsdtools/geostats.py:29`.

Source docstring:

```text
Public names for the two explicit numerical contracts.
```


Declared bases: `str`, `Enum`.

### `lsdtools.geostats.CompatibilityProfile.SGEMS_AR2TECH_2013`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:32`.

```python
SGEMS_AR2TECH_2013 = 'sgems-ar2tech-2013'
```


### `lsdtools.geostats.CompatibilityProfile.LSD_BLOCK_MODEL_V1`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:33`.

```python
LSD_BLOCK_MODEL_V1 = 'lsd-block-model-v1'
```


## `lsdtools.geostats.CovarianceKind`

Kind: class. Source: `sdk/src/lsdtools/geostats.py:253`.

Source docstring:

```text
Nested covariance functions supported by the compatibility profile.
```


Declared bases: `str`, `Enum`.

### `lsdtools.geostats.CovarianceKind.SPHERICAL`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:256`.

```python
SPHERICAL = 'spherical'
```


### `lsdtools.geostats.CovarianceKind.EXPONENTIAL`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:257`.

```python
EXPONENTIAL = 'exponential'
```


### `lsdtools.geostats.CovarianceKind.GAUSSIAN`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:258`.

```python
GAUSSIAN = 'gaussian'
```


## `lsdtools.geostats.CovarianceStructureSpec`

Kind: class. Source: `sdk/src/lsdtools/geostats.py:262`.

Source docstring:

```text
One nested covariance contribution and anisotropy ellipsoid.
```


### `lsdtools.geostats.CovarianceStructureSpec.kind`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:265`.

```python
kind: CovarianceKind
```


### `lsdtools.geostats.CovarianceStructureSpec.contribution`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:266`.

```python
contribution: float
```


### `lsdtools.geostats.CovarianceStructureSpec.ellipsoid`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:267`.

```python
ellipsoid: EllipsoidSpec
```


## `lsdtools.geostats.EllipsoidSpec`

Kind: class. Source: `sdk/src/lsdtools/geostats.py:235`.

Source docstring:

```text
Major/medium/minor ranges and SGeMS azimuth/dip/rake angles.
```


### `lsdtools.geostats.EllipsoidSpec.ranges`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:238`.

```python
ranges: tuple[float, float, float]
```


### `lsdtools.geostats.EllipsoidSpec.angles`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:239`.

```python
angles: tuple[float, float, float]
```


```python
angles = (0.0, 0.0, 0.0)
```


## `lsdtools.geostats.EmpiricalCdfSpec`

Kind: class. Source: `sdk/src/lsdtools/geostats.py:593`.

### `lsdtools.geostats.EmpiricalCdfSpec.reference_values`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:594`.

```python
reference_values: Any
```


### `lsdtools.geostats.EmpiricalCdfSpec.reference_validity`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:595`.

```python
reference_validity: Any
```


```python
reference_validity = None
```


### `lsdtools.geostats.EmpiricalCdfSpec.break_ties`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:596`.

```python
break_ties: bool
```


```python
break_ties = False
```


### `lsdtools.geostats.EmpiricalCdfSpec.lower_tail`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:597`.

```python
lower_tail: TailSpec | None
```


```python
lower_tail = None
```


### `lsdtools.geostats.EmpiricalCdfSpec.upper_tail`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:598`.

```python
upper_tail: TailSpec | None
```


```python
upper_tail = None
```


### `lsdtools.geostats.EmpiricalCdfSpec.conditioning_region`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:599`.

```python
conditioning_region: Any
```


```python
conditioning_region = None
```


## `lsdtools.geostats.ExecutionSpec`

Kind: class. Source: `sdk/src/lsdtools/geostats.py:823`.

Source docstring:

```text
Backend, compatibility, and precision selection for one operation.
```


### `lsdtools.geostats.ExecutionSpec.backend`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:826`.

```python
backend: Backend
```


```python
backend = 'auto'
```


### `lsdtools.geostats.ExecutionSpec.profile`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:827`.

```python
profile: CompatibilityProfile
```


```python
profile = CompatibilityProfile.SGEMS_AR2TECH_2013
```


### `lsdtools.geostats.ExecutionSpec.device`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:828`.

```python
device: int
```


```python
device = 0
```


### `lsdtools.geostats.ExecutionSpec.workers`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:829`.

```python
workers: int | None
```


```python
workers = None
```


### `lsdtools.geostats.ExecutionSpec.precision`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:830`.

```python
precision: PrecisionMode
```


```python
precision = PrecisionMode.PROFILE
```


## `lsdtools.geostats.GaussianCdfSpec`

Kind: class. Source: `sdk/src/lsdtools/geostats.py:521`.

### `lsdtools.geostats.GaussianCdfSpec.mean`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:522`.

```python
mean: float
```


```python
mean = 0.0
```


### `lsdtools.geostats.GaussianCdfSpec.variance`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:523`.

```python
variance: float
```


```python
variance = 1.0
```


## `lsdtools.geostats.GeostatsServiceUnavailable`

Kind: class. Source: `sdk/src/lsdtools/geostats.py:88`.

```python
GeostatsServiceUnavailable(self, detail: str | None=None) -> None
```


Source docstring:

```text
The installed product lacks a compatible geostatistics runtime.
```


Declared bases: `RuntimeError`.

### `lsdtools.geostats.GeostatsServiceUnavailable.__init__`

Kind: method. Source: `sdk/src/lsdtools/geostats.py:91`.

```python
__init__(self, detail: str | None=None) -> None
```


```python
detail: str | None
self: (unannotated)
```


## `lsdtools.geostats.IDENTITY_AXES`

Kind: value. Source: `sdk/src/lsdtools/geostats.py:22`.

```python
IDENTITY_AXES = ((1.0, 0.0, 0.0), (0.0, 1.0, 0.0), (0.0, 0.0, 1.0))
```


## `lsdtools.geostats.LogNormalCdfSpec`

Kind: class. Source: `sdk/src/lsdtools/geostats.py:553`.

Source docstring:

```text
Installed arithmetic-space mean/variance parameterization.
```


### `lsdtools.geostats.LogNormalCdfSpec.mean`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:556`.

```python
mean: float
```


```python
mean = 1.0
```


### `lsdtools.geostats.LogNormalCdfSpec.variance`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:557`.

```python
variance: float
```


```python
variance = 1.0
```


### `lsdtools.geostats.LogNormalCdfSpec.from_log_parameters`

Kind: method. Source: `sdk/src/lsdtools/geostats.py:574`.

```python
from_log_parameters(cls, log_mean: float, log_variance: float) -> 'LogNormalCdfSpec'
```


```python
cls: (unannotated)
log_mean: float
log_variance: float
```


## `lsdtools.geostats.NeighborhoodSpec`

Kind: class. Source: `sdk/src/lsdtools/geostats.py:368`.

Source docstring:

```text
Deterministic search policy separated from estimator arithmetic.
```


### `lsdtools.geostats.NeighborhoodSpec.ellipsoid`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:371`.

```python
ellipsoid: EllipsoidSpec
```


### `lsdtools.geostats.NeighborhoodSpec.min_neighbors`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:372`.

```python
min_neighbors: int
```


```python
min_neighbors = 1
```


### `lsdtools.geostats.NeighborhoodSpec.max_neighbors`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:373`.

```python
max_neighbors: int
```


```python
max_neighbors = 12
```


### `lsdtools.geostats.NeighborhoodSpec.geometry_mode`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:374`.

```python
geometry_mode: Literal['auto', 'regular-grid', 'point-set', 'stratigraphic']
```


```python
geometry_mode = 'auto'
```


### `lsdtools.geostats.NeighborhoodSpec.order`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:380`.

```python
order: Literal['profile', 'distance', 'covariance']
```


```python
order = 'profile'
```


### `lsdtools.geostats.NeighborhoodSpec.boundary`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:381`.

```python
boundary: Literal['profile', 'inclusive', 'exclusive']
```


```python
boundary = 'profile'
```


### `lsdtools.geostats.NeighborhoodSpec.advanced`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:386`.

```python
advanced: AdvancedSearchSpec | None
```


```python
advanced = None
```


### `lsdtools.geostats.NeighborhoodSpec.planner`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:387`.

```python
planner: Literal['reference', 'kdtree2']
```


```python
planner = 'reference'
```


## `lsdtools.geostats.NumericalProvenance`

Kind: class. Source: `sdk/src/lsdtools/geostats.py:875`.

Source docstring:

```text
Complete execution identity for version-two numerical operations.
```


### `lsdtools.geostats.NumericalProvenance.operation`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:878`.

```python
operation: str
```


### `lsdtools.geostats.NumericalProvenance.operation_version`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:879`.

```python
operation_version: str
```


### `lsdtools.geostats.NumericalProvenance.profile`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:880`.

```python
profile: CompatibilityProfile
```


### `lsdtools.geostats.NumericalProvenance.requested_backend`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:881`.

```python
requested_backend: Backend
```


### `lsdtools.geostats.NumericalProvenance.executed_backend`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:882`.

```python
executed_backend: Literal['cpu', 'cuda']
```


### `lsdtools.geostats.NumericalProvenance.provider`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:883`.

```python
provider: str
```


### `lsdtools.geostats.NumericalProvenance.provider_version`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:884`.

```python
provider_version: str
```


### `lsdtools.geostats.NumericalProvenance.deterministic_order`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:885`.

```python
deterministic_order: str
```


### `lsdtools.geostats.NumericalProvenance.precision_contract`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:886`.

```python
precision_contract: str
```


### `lsdtools.geostats.NumericalProvenance.input_fingerprint`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:887`.

```python
input_fingerprint: str
```


### `lsdtools.geostats.NumericalProvenance.parameter_fingerprint`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:888`.

```python
parameter_fingerprint: str
```


### `lsdtools.geostats.NumericalProvenance.plan_fingerprints`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:889`.

```python
plan_fingerprints: tuple[str, ...]
```


### `lsdtools.geostats.NumericalProvenance.migration_manifest_sha256`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:890`.

```python
migration_manifest_sha256: str
```


### `lsdtools.geostats.NumericalProvenance.fallback_reason`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:891`.

```python
fallback_reason: str | None
```


### `lsdtools.geostats.NumericalProvenance.device`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:892`.

```python
device: int
```


### `lsdtools.geostats.NumericalProvenance.workers`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:893`.

```python
workers: int | None
```


### `lsdtools.geostats.NumericalProvenance.schema_version`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:894`.

```python
schema_version: Literal['lsd-geostats-provenance-v2']
```


```python
schema_version = 'lsd-geostats-provenance-v2'
```


## `lsdtools.geostats.PrecisionMode`

Kind: class. Source: `sdk/src/lsdtools/geostats.py:36`.

Source docstring:

```text
Requested arithmetic precision; profile defaults remain explicit.
```


Declared bases: `str`, `Enum`.

### `lsdtools.geostats.PrecisionMode.PROFILE`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:39`.

```python
PROFILE = 'profile'
```


### `lsdtools.geostats.PrecisionMode.FLOAT32`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:40`.

```python
FLOAT32 = 'float32'
```


### `lsdtools.geostats.PrecisionMode.FLOAT64`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:41`.

```python
FLOAT64 = 'float64'
```


## `lsdtools.geostats.RegularGridSpec`

Kind: class. Source: `sdk/src/lsdtools/geostats.py:755`.

Source docstring:

```text
Exact regular grid; origin is the center of cell ``(0, 0, 0)``.
```


### `lsdtools.geostats.RegularGridSpec.dimensions`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:758`.

```python
dimensions: tuple[int, int, int]
```


### `lsdtools.geostats.RegularGridSpec.origin`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:759`.

```python
origin: tuple[float, float, float]
```


### `lsdtools.geostats.RegularGridSpec.spacing`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:760`.

```python
spacing: tuple[float, float, float]
```


### `lsdtools.geostats.RegularGridSpec.orientation_axes`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:761`.

```python
orientation_axes: tuple[tuple[float, float, float], ...]
```


```python
orientation_axes = IDENTITY_AXES
```


### `lsdtools.geostats.RegularGridSpec.ordering`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:762`.

```python
ordering: Literal['x-fastest']
```


```python
ordering = 'x-fastest'
```


## `lsdtools.geostats.RngEngine`

Kind: class. Source: `sdk/src/lsdtools/geostats.py:51`.

Source docstring:

```text
Versioned random engines used by reproducible numerical plans.
```


Declared bases: `str`, `Enum`.

### `lsdtools.geostats.RngEngine.SGEMS_BOOST_MT11213B`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:54`.

```python
SGEMS_BOOST_MT11213B = 'sgems-boost-mt11213b-msvc10-v1'
```


### `lsdtools.geostats.RngEngine.WINDOWS_CRT_RAND`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:55`.

```python
WINDOWS_CRT_RAND = 'windows-crt-rand-v1'
```


### `lsdtools.geostats.RngEngine.LSD_PHILOX`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:56`.

```python
LSD_PHILOX = 'lsd-philox4x32-10-v1'
```


## `lsdtools.geostats.RngSpec`

Kind: class. Source: `sdk/src/lsdtools/geostats.py:431`.

Source docstring:

```text
Named random engine, external seed, and independent stream.
```


### `lsdtools.geostats.RngSpec.engine`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:434`.

```python
engine: RngEngine
```


### `lsdtools.geostats.RngSpec.seed`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:435`.

```python
seed: int
```


### `lsdtools.geostats.RngSpec.stream`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:436`.

```python
stream: int
```


```python
stream = 0
```


### `lsdtools.geostats.RngSpec.normalized_seed`

Kind: method. Source: `sdk/src/lsdtools/geostats.py:479`.

```python
normalized_seed(self) -> int
```


```python
self: (unannotated)
```


## `lsdtools.geostats.SearchSpec`

Kind: class. Source: `sdk/src/lsdtools/geostats.py:211`.

Source docstring:

```text
Version-one ellipsoid and deterministic neighborhood-size settings.
```


### `lsdtools.geostats.SearchSpec.ranges`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:214`.

```python
ranges: tuple[float, float, float]
```


```python
ranges = (1.0, 1.0, 1.0)
```


### `lsdtools.geostats.SearchSpec.angles`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:215`.

```python
angles: tuple[float, float, float]
```


```python
angles = (0.0, 0.0, 0.0)
```


### `lsdtools.geostats.SearchSpec.min_neighbors`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:216`.

```python
min_neighbors: int
```


```python
min_neighbors = 1
```


### `lsdtools.geostats.SearchSpec.max_neighbors`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:217`.

```python
max_neighbors: int
```


```python
max_neighbors = 12
```


## `lsdtools.geostats.SequentialPathMode`

Kind: class. Source: `sdk/src/lsdtools/geostats.py:59`.

Source docstring:

```text
How realization paths are initialized and reused.
```


Declared bases: `str`, `Enum`.

### `lsdtools.geostats.SequentialPathMode.RESHUFFLE_PREVIOUS`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:62`.

```python
RESHUFFLE_PREVIOUS = 'reshuffle-previous'
```


### `lsdtools.geostats.SequentialPathMode.RESET_EACH_REALIZATION`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:63`.

```python
RESET_EACH_REALIZATION = 'reset-each-realization'
```


### `lsdtools.geostats.SequentialPathMode.REUSE_SINGLE_PATH`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:64`.

```python
REUSE_SINGLE_PATH = 'reuse-single-path'
```


## `lsdtools.geostats.SupportBatch`

Kind: class. Source: `sdk/src/lsdtools/geostats.py:708`.

Source docstring:

```text
Point or cell supports in observable source-row order.

Array values remain engine-neutral ``Any`` objects until a numerical
operation is called. The runtime copies them into immutable storage.
```


### `lsdtools.geostats.SupportBatch.kind`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:715`.

```python
kind: SupportKind
```


### `lsdtools.geostats.SupportBatch.centers`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:716`.

```python
centers: Any
```


### `lsdtools.geostats.SupportBatch.row_ids`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:717`.

```python
row_ids: Any
```


### `lsdtools.geostats.SupportBatch.edge_lengths`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:718`.

```python
edge_lengths: Any | None
```


```python
edge_lengths = None
```


### `lsdtools.geostats.SupportBatch.orientation_axes`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:719`.

```python
orientation_axes: tuple[tuple[float, float, float], ...] | None
```


```python
orientation_axes = None
```


### `lsdtools.geostats.SupportBatch.topology_fingerprint`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:720`.

```python
topology_fingerprint: str | None
```


```python
topology_fingerprint = None
```


### `lsdtools.geostats.SupportBatch.ordering`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:721`.

```python
ordering: Literal['source-row']
```


```python
ordering = 'source-row'
```


## `lsdtools.geostats.SupportKind`

Kind: class. Source: `sdk/src/lsdtools/geostats.py:44`.

Source docstring:

```text
Physical support carried by one bounded operation batch.
```


Declared bases: `str`, `Enum`.

### `lsdtools.geostats.SupportKind.POINT`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:47`.

```python
POINT = 'point'
```


### `lsdtools.geostats.SupportKind.CELL`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:48`.

```python
CELL = 'cell'
```


## `lsdtools.geostats.TailKind`

Kind: class. Source: `sdk/src/lsdtools/geostats.py:67`.

Source docstring:

```text
Empirical distribution tail functions exposed by SGeMS.
```


Declared bases: `str`, `Enum`.

### `lsdtools.geostats.TailKind.NONE`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:70`.

```python
NONE = 'none'
```


### `lsdtools.geostats.TailKind.POWER`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:71`.

```python
POWER = 'power'
```


### `lsdtools.geostats.TailKind.EXPONENTIAL`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:72`.

```python
EXPONENTIAL = 'exponential'
```


### `lsdtools.geostats.TailKind.HYPERBOLIC`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:73`.

```python
HYPERBOLIC = 'hyperbolic'
```


## `lsdtools.geostats.TailSpec`

Kind: class. Source: `sdk/src/lsdtools/geostats.py:489`.

Source docstring:

```text
Tail mode; endpoint-dependent clamps are applied by the runtime.
```


### `lsdtools.geostats.TailSpec.kind`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:492`.

```python
kind: TailKind
```


### `lsdtools.geostats.TailSpec.extreme`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:493`.

```python
extreme: float | None
```


```python
extreme = None
```


### `lsdtools.geostats.TailSpec.omega`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:494`.

```python
omega: float | None
```


```python
omega = None
```


## `lsdtools.geostats.UniformCdfSpec`

Kind: class. Source: `sdk/src/lsdtools/geostats.py:537`.

### `lsdtools.geostats.UniformCdfSpec.minimum`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:538`.

```python
minimum: float
```


```python
minimum = 0.0
```


### `lsdtools.geostats.UniformCdfSpec.maximum`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:539`.

```python
maximum: float
```


```python
maximum = 1.0
```


## `lsdtools.geostats.VariogramSpec`

Kind: class. Source: `sdk/src/lsdtools/geostats.py:289`.

Source docstring:

```text
Nugget plus ordered nested covariance structures.
```


### `lsdtools.geostats.VariogramSpec.nugget`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:292`.

```python
nugget: float
```


```python
nugget = 0.0
```


### `lsdtools.geostats.VariogramSpec.structures`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:293`.

```python
structures: tuple[CovarianceStructureSpec, ...]
```


```python
structures = ()
```


## `lsdtools.geostats.WindowBoundary`

Kind: class. Source: `sdk/src/lsdtools/geostats.py:82`.

Declared bases: `str`, `Enum`.

### `lsdtools.geostats.WindowBoundary.TRUNCATE`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:83`.

```python
TRUNCATE = 'truncate'
```


### `lsdtools.geostats.WindowBoundary.INVALID`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:84`.

```python
INVALID = 'invalid'
```


### `lsdtools.geostats.WindowBoundary.WRAP`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:85`.

```python
WRAP = 'wrap'
```


## `lsdtools.geostats.WindowGeometry`

Kind: class. Source: `sdk/src/lsdtools/geostats.py:76`.

Declared bases: `str`, `Enum`.

### `lsdtools.geostats.WindowGeometry.RECTANGULAR`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:77`.

```python
RECTANGULAR = 'rectangular'
```


### `lsdtools.geostats.WindowGeometry.ELLIPSOID`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:78`.

```python
ELLIPSOID = 'ellipsoid'
```


### `lsdtools.geostats.WindowGeometry.EXPLICIT`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:79`.

```python
EXPLICIT = 'explicit'
```


## `lsdtools.geostats.WindowSpec`

Kind: class. Source: `sdk/src/lsdtools/geostats.py:625`.

Source docstring:

```text
Grid-relative neighborhood shared by filters and window reductions.
```


### `lsdtools.geostats.WindowSpec.geometry`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:628`.

```python
geometry: WindowGeometry
```


### `lsdtools.geostats.WindowSpec.half_size`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:629`.

```python
half_size: tuple[int, int, int] | None
```


```python
half_size = None
```


### `lsdtools.geostats.WindowSpec.ellipsoid`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:630`.

```python
ellipsoid: EllipsoidSpec | None
```


```python
ellipsoid = None
```


### `lsdtools.geostats.WindowSpec.offsets`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:631`.

```python
offsets: Any
```


```python
offsets = None
```


### `lsdtools.geostats.WindowSpec.weights`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:632`.

```python
weights: Any
```


```python
weights = None
```


### `lsdtools.geostats.WindowSpec.boundary`

Kind: attribute. Source: `sdk/src/lsdtools/geostats.py:633`.

```python
boundary: WindowBoundary
```


```python
boundary = WindowBoundary.TRUNCATE
```


## `lsdtools.geostats.capabilities`

Kind: function. Source: `sdk/src/lsdtools/geostats.py:1027`.

```python
capabilities() -> dict[str, Any]
```


Source docstring:

```text
Describe the installed runtime; missing optional service is data.
```


## `lsdtools.geostats.compile_cdf`

Kind: function. Source: `sdk/src/lsdtools/geostats.py:1085`.

```python
compile_cdf(value: CdfSpec) -> Any
```


```python
value: CdfSpec
```


Source docstring:

```text
Compile a continuous CDF through the installed runtime.
```


## `lsdtools.geostats.compile_variogram`

Kind: function. Source: `sdk/src/lsdtools/geostats.py:1066`.

```python
compile_variogram(value: VariogramSpec, *, profile: CompatibilityProfile | str=CompatibilityProfile.SGEMS_AR2TECH_2013) -> Any
```


```python
profile: CompatibilityProfile | str
value: VariogramSpec
```


Source docstring:

```text
Compile covariance and anisotropy under an explicit profile.
```


## `lsdtools.geostats.execute_registration`

Kind: function. Source: `sdk/src/lsdtools/geostats.py:1200`.

```python
execute_registration(operation: str, *, inputs: Mapping[str, Any], parameters: Mapping[str, Any] | None=None, execution: ExecutionSpec | None=None) -> Any
```


```python
execution: ExecutionSpec | None
inputs: Mapping[str, Any]
operation: str
parameters: Mapping[str, Any] | None
```


Source docstring:

```text
Execute normalized mappings through a registration-specific adapter.
```


## `lsdtools.geostats.inverse_distance`

Kind: function. Source: `sdk/src/lsdtools/geostats.py:1266`.

```python
inverse_distance(sample_points: Any, sample_values: Any, target_points: Any, *, sample_validity: Any=None, search: SearchSpec | None=None, power: float=2.0, coincidence_tolerance: float=0.0, backend: Backend='auto', profile: CompatibilityProfile | str=CompatibilityProfile.SGEMS_AR2TECH_2013, device: int=0, workers: int | None=None) -> Any
```


```python
backend: Backend
coincidence_tolerance: float
device: int
power: float
profile: CompatibilityProfile | str
sample_points: Any
sample_validity: Any
sample_values: Any
search: SearchSpec | None
target_points: Any
workers: int | None
```


Source docstring:

```text
Estimate one or more fields using deterministic inverse distance.
```


## `lsdtools.geostats.nearest_neighbor`

Kind: function. Source: `sdk/src/lsdtools/geostats.py:1234`.

```python
nearest_neighbor(sample_points: Any, sample_values: Any, target_points: Any, *, sample_validity: Any=None, search: SearchSpec | None=None, backend: Backend='auto', profile: CompatibilityProfile | str=CompatibilityProfile.SGEMS_AR2TECH_2013, device: int=0, workers: int | None=None) -> Any
```


```python
backend: Backend
device: int
profile: CompatibilityProfile | str
sample_points: Any
sample_validity: Any
sample_values: Any
search: SearchSpec | None
target_points: Any
workers: int | None
```


Source docstring:

```text
Estimate one or more fields using deterministic nearest neighbors.
```


## `lsdtools.geostats.plan_candidates`

Kind: function. Source: `sdk/src/lsdtools/geostats.py:1142`.

```python
plan_candidates(samples: SupportBatch | Any, targets: SupportBatch | Any, *, search: NeighborhoodSpec, covariance_program: Any=None, sample_validity: Any=None, target_validity: Any=None, sample_geometry: RegularGridSpec | Any=None, target_geometry: RegularGridSpec | Any=None, same_nodes: bool=False, profile: CompatibilityProfile | str=CompatibilityProfile.SGEMS_AR2TECH_2013) -> Any
```


```python
covariance_program: Any
profile: CompatibilityProfile | str
same_nodes: bool
sample_geometry: RegularGridSpec | Any
sample_validity: Any
samples: SupportBatch | Any
search: NeighborhoodSpec
target_geometry: RegularGridSpec | Any
target_validity: Any
targets: SupportBatch | Any
```


Source docstring:

```text
Freeze pre-truncation candidates for sequential simulations.
```


## `lsdtools.geostats.plan_neighborhoods`

Kind: function. Source: `sdk/src/lsdtools/geostats.py:1103`.

```python
plan_neighborhoods(samples: SupportBatch | Any, targets: SupportBatch | Any, *, search: NeighborhoodSpec, covariance_program: Any=None, sample_validity: Any=None, target_validity: Any=None, sample_geometry: RegularGridSpec | Any=None, target_geometry: RegularGridSpec | Any=None, same_nodes: bool=False, profile: CompatibilityProfile | str=CompatibilityProfile.SGEMS_AR2TECH_2013) -> Any
```


```python
covariance_program: Any
profile: CompatibilityProfile | str
same_nodes: bool
sample_geometry: RegularGridSpec | Any
sample_validity: Any
samples: SupportBatch | Any
search: NeighborhoodSpec
target_geometry: RegularGridSpec | Any
target_validity: Any
targets: SupportBatch | Any
```


Source docstring:

```text
Build the immutable search plan consumed by reference algorithms.
```


## `lsdtools.geostats.prepare_regular_grid`

Kind: function. Source: `sdk/src/lsdtools/geostats.py:1056`.

```python
prepare_regular_grid(value: RegularGridSpec) -> Any
```


```python
value: RegularGridSpec
```


Source docstring:

```text
Compile canonical X-fastest regular-grid geometry.
```


## `lsdtools.geostats.prepare_support`

Kind: function. Source: `sdk/src/lsdtools/geostats.py:1046`.

```python
prepare_support(value: SupportBatch) -> Any
```


```python
value: SupportBatch
```


Source docstring:

```text
Compile point/cell support without importing the runtime eagerly.
```


## `lsdtools.geostats.reference_operation`

Kind: function. Source: `sdk/src/lsdtools/geostats.py:1181`.

```python
reference_operation(operation: str, /, *args: Any, **kwargs: Any) -> Any
```


```python
args: Any
kwargs: Any
operation: str
```


Source docstring:

```text
Invoke one migrated CPU reference through the stable SDK boundary.
```