Skip to article frontmatterSkip to article content
Site not loading correctly?

This may be due to an incorrect BASE_URL configuration. See the MyST Documentation for reference.

Capability index: GeoStack

Layers: GeoStack · GeoNumerics · GeoML · GeoModels.

Every public name in the libraries geostack builds on, each listed once under the shortest module path that exports it, with the first sentence of its docstring. Search this page before writing a loader, a model, a training step or a helper in a script or a notebook: if what you need is here, use it; if it is almost here, extend it where it lives. Regenerate with make capabilities after changing a public API (tests/test_capabilities.py checks it is current).

This page is the GeoStack layer. It imports no other layer.

Listed at pipekit 0.0.2, pipekit-array 0.0.2, pipekit-cycle 0.0.2, pipekit-evaluate 0.0.2, pipekit-experiment 0.0.2, pipekit-jax 0.0.2, pipekit-train 0.0.2, georeader-spaceml 2.4.1, geotoolz-ops 0.10.3, geotoolz-catalog 0.5.1, geotoolz-cloud 0.4.1, geotoolz-patcher 0.10.2, geotoolz-products 0.4.2, xrtoolz 0.0.5, xrtoolz-core 0.0.2, xrtoolz-einx 0.0.1, xrtoolz-grad 0.0.3, xrtoolz-reader 0.0.4, xrtoolz-sklearn 0.0.2.

Upstream: pipekit

Carrier-agnostic operator-graph framework for pipelines.

pipekit

NameKindWhat it does
AssertCallableclassPass-through; raise QCError if predicate(x) is falsy.
AssertDTypeclassPass-through; raise QCError if getattr(x, 'dtype') mismatches.
AssertHasAttributeclassPass-through; raise QCError if attribute missing (or value mismatches).
AssertShapeclassPass-through; raise QCError if getattr(x, 'shape') mismatches.
AsyncMapclassApply op to each item of an iterable inside an async event loop.
BatchedMapclassSplit an iterable into batches and call op on each batch as a list.
BranchclassBinary conditional: run if_true or if_false based on a predicate.
CacheclassMemoise an inner operator by hashing its input and config.
CarrierclassRe-exported from typing.
CarryStateclassBase class for state threaded through a stateful pipeline.
CoalesceclassTry each source in order; return the first output that satisfies is_ok.
ConfigMixinclassAuto-derive get_config() from __init__ parameter names.
ConstclassReturn a fixed value, ignoring any input.
FanoutclassApply each named operator to the same input; return a dict of outputs.
FittableTransformerclassAnything with sklearn-style fit + transform methods.
GraphclassA symbolic operator graph with multiple inputs and outputs.
HistogramclassController that captures simple histograms by key.
IdentityclassExplicit no-op.
InputclassA named entry point into a Graph.
LambdaclassWrap an arbitrary callable as an Operator.
NodeclassA vertex in a Graph.
OperatorclassBase class for pipekit operators.
PredictorclassAnything with a sklearn-style predict method.
ProcessMapclassApply op to each item of an iterable using a process pool.
ProfileclassController that records per-step wall-clock timings.
QCErrorclassRaised when a QC assertion fails.
QuarantineclassNon-raising QC: on failure log and return sentinel; on success pass through.
RetryclassRetry an operator on transient failures with exponential backoff.
SequentialclassApply a list of operators in order, threading the output of each into the next.
ShapeTraceclassLog shape / dtype of each carrier passing through.
SignatureclassImmutable shape + dtype record.
SinkclassApply a side-effecting write and pass the input through unchanged.
SnapshotclassController that captures intermediate carriers by name.
StatefulOperatorclassMarker base for operators whose _apply threads carry-state.
SwitchclassMulti-way dispatch on key(carrier).
TapclassFire a callback on the carrier; return the carrier unchanged.
ThreadMapclassApply op to each item of an iterable using a thread pool.
TryclassRun primary; on caught exceptions run fallback.
allowedfunctionReturn the registered class names ("module.Class" keys).
check_pickleablefunctionReturn the list of forbid_in_yaml-flagged operators inside op.
complementfunctionReturn a predicate that negates predicate.
composefunctionRight-to-left composition (mathematical order).
compose_leftfunctionLeft-to-right composition (pipeline order).
compute_output_signaturefunctionFree-function dispatch to op.compute_output_signature.
dumpsfunctionJSON-encode an operator’s state record.
juxtfunctionReturn a callable that applies each operator to its input and tuples the results.
loadsfunctionDecode an operator from its JSON state record.
loads_sandboxedfunctionLike loads, but reject any class not in the allowlist.
pipefunctionApply operators left-to-right to value.
registerfunctionRegister cls as loadable via loads_sandboxed.
unregisterfunctionRemove cls from the sandboxed loader’s allowlist.

Upstream: pipekit-array

Array API operators (NumPy, JAX, CuPy, PyTorch).

pipekit_array

NameKindWhat it does
ConcatenateAlongclassConcatenate a list-of-arrays along an existing axis via xp.concat.
MeanScalarclassReduce an array to a scalar (or per-axis means) via xp.mean.
StackAlongclassStack a list-of-arrays along a new axis via xp.stack.
array_namespacefunctionReturn the Array API namespace shared by all input arrays.

Upstream: pipekit-cycle

Time-stepping, data assimilation and observation operators.

pipekit_cycle

NameKindWhat it does
AdjointSpecconstantpipekit_cycle.adjoints.DirectAdjoint | pipekit_cycle.adjo...
AnalysisStepclassCombine forecast state with observations to produce analysis state.
BFNCycleclassBack-and-Forth Nudging over an assimilation window.
BacksolveAdjointclassContinuous adjoint: solve the adjoint ODE backwards (O(1) memory).
CallableForwardclassWrap a plain callable as a forward model.
CallableObsclassArbitrary callable observation operator.
CompositeForwardclassCompose multiple forward models — F_k ∘ … ∘ F_1.
CompositeObsclassCompose multiple observation operators: H_k ∘ … ∘ H_1.
CovarianceLocalizerclassTaper spurious long-range covariances in ensemble methods.
CycleclassApply step_op for n_steps, threading state through each step.
DACycleclassClassic forecast-analysis cycle.
DAStateclassState threaded through a DA cycle.
DirectAdjointclassExact gradients by storing every step of the rollout.
EnsembleCycleclassRun Cycle over a list of ensemble-member carriers.
EnsembleDACycleclassEnsemble-based DA — EnKF, ETKF, LETKF, particle filters, …
EnsembleInflatorclassInflate an analysis ensemble to counter variance underestimation.
ErrorSubspaceclassA propagating low-rank error-covariance factor L (B ≈ L Lᵀ).
ForwardModelclassAdvance a model state forward in time by dt.
IdentityObsclassDirect measurement: H(x) = x.
ImplicitAdjointclassDifferentiate a converged fixed point via the implicit function theorem.
IterationStateclassState threaded through a Recurrence.
IterativeProcessclassAn iterative ensemble inversion / sampling process (EKI, EKS, UKI).
LatentMapclassAn encode/decode pair between full state space and a latent space.
LinearObsclassLinear observation map: H(x) = H @ x.
NeuralForwardclassWrap a neural-emulator operator (e.g. ModelOp) as a ForwardModel.
ObservationNoiseclassAn observation-error model that exposes covariance and sampling.
ObservationOperatorclassMap model state → predicted observations.
RecurrenceclassApply step_op repeatedly until condition_op returns truthy.
RecursiveCheckpointAdjointclassExact gradients with treeverse checkpointing (the recommended default).
ReducedBasisclassMap a reduced control vector to a state increment (with a prior).
ReducedOrderModelclassA Galerkin / POD reduced-order model: encode/decode + latent dynamics.
SmootherCycleclass4D-Var-shaped windowed smoother.
StepSchedulerclassStep-size policy for an IterativeProcess.
SupportsAdjointclassA differentiable component that exposes its adjoint strategy.
TangentLinearModelclassTangent-linear and adjoint of a ForwardModel’s dynamics.
TruncatedAdjointclassBiased gradients: flow stops more than k steps back.
WindowStateclassState threaded through a windowed / smoother cycle.
WindowedCycleclassSliding-window time-stepping over a stream of initial carriers.

Upstream: pipekit-evaluate

Multidimensional evaluation (Unit x Lens x Stage).

pipekit_evaluate

NameKindWhat it does
AxisclassWhich benchmark axis a reference is resolved along.
BenchmarkclassRun the level x rung x complexity cube and score each cell.
BenchmarkReportclassThe collected results of a benchmark run.
CellclassOne cell of the benchmark cube.
CellResultclassThe scored outcome for one cube cell.
EstimateclassA point and/or a posterior produced by an estimator.
EstimatorclassAny rung that maps observations → an :class:Estimate.
OracleclassThe designated reference :class:Estimator for a task (usually rung 2).
PriorclassA minimal prior over task parameters θ.
ReferenceRuleclassResolve the reference source for a rung along a given axis.
ReferenceSourceclassWhere a rung/step’s ground truth comes from.
ScorerclassScore one prediction against one reference.
TaskclassOne benchmark scenario: prior + simulator + obs operator + data.

Upstream: pipekit-experiment

Experiment tracking adapters and a model registry.

pipekit_experiment

NameKindWhat it does
ExperimentTrackerclassLog metrics, parameters, and artifacts from a training run.
InferenceArtifactclassReproducibility snapshot for an inference pipeline.
LocalModelRegistryclassLocal-filesystem model registry.
ModelRegistryclassStore and retrieve trained models by content hash.
RunclassA single execution of a pipeline (training or inference).
RunArtifactsclassNamed artifacts (files, models, plots) attached to a Run.
RunMetricsclassPer-step metric series.
S3ModelRegistryclassfsspec-backed model registry.
TrainingArtifactclassReproducibility snapshot for a training run.

Upstream: pipekit-jax

JAX / Equinox carrier integration for pipekit.

pipekit_jax

NameKindWhat it does
DiffraxForwardModellazyNeeds diffrax.
JaxModelOpclassWrap an eqx.Module as a pipekit.Operator with weight round-trip.
to_diffrax_adjointfunctionMap a pipekit adjoint spec onto a diffrax.AbstractAdjoint.
truncated_scanfunctionjax.lax.scan with gradients truncated to the trailing k steps.

Upstream: pipekit-train

Training pipelines for emulators and amortized inference.

pipekit_train

NameKindWhat it does
CachedDatasetclassDisk- or cloud-backed cache around any TrainingDataset.
CallbackclassPer-step / per-epoch / per-eval hooks.
CheckpointclassSave (model_op, optimizer_state) every N steps; final to a registry.
CompositeclassWeighted sum of Loss components.
EarlyStoppingclassSignal stop when a monitored metric hasn’t improved for N evals.
HyperSweepclassOrchestrate N independent TrainingLoop runs.
IterableDatasetclassGeneric escape hatch — wrap any iterable as a TrainingDataset.
JSONLWriterclassAppend-only JSON Lines metric writer.
KLclassKullback-Leibler divergence between two distributions.
LogToExperimentclassForward metrics / params / artifacts to a pipekit-experiment tracker.
LossclassLoss function — per-batch scalar called by the adapter.
MSEclassMean squared error loss.
MetricWriterclassWhere per-step metrics go when no tracker is attached.
NLLclassNegative log-likelihood for distribution-shaped predictions.
ParameterGridclassCartesian product over named parameter axes.
SimulationDatasetclassYields (parameters, simulator_output) pairs.
SweepCarryStateclassCarry-state for HyperSweep.
SweepResultclassOne trial’s result inside a sweep.
TrainerCarryStateclassCarry-state for TrainingLoop.
TrainingDatasetclassAbstract base — yields (input, target) pairs.
TrainingLoopclassTrain a model_op on a dataset, producing a trained model_op.
ValidationStepclassCompute validation metrics on a held-out dataset.
XarrayWindowDatasetlazyNeeds an optional dependency.

Upstream: georeader-spaceml

Raster reading and the GeoTensor carrier.

georeader.geotensor

NameKindWhat it does
GeoTensorclassA numpy ndarray subclass with geospatial metadata.
get_rio_options_pathfunction

georeader.read

NameKindWhat it does
apply_anti_aliasingfunctionApply anti-aliasing to data_in assuming it will be downsampled to resolution_dst.
calculate_transform_windowfunctionCalculate the default transform to reproject data to dst_crs with resolution_dst_crs
read_from_boundsfunctionExtract raster data within a geographic bounding box, with optional CRS transformation.
read_from_center_coordsfunctionExtract a rectangular chip from raster data centered on geographic coordinates.
read_from_polygonfunctionExtract raster data within a polygon boundary, supporting complex shapes and masking.
read_from_tilefunctionRead raster data corresponding to a Web Mercator (XYZ) tile for web mapping applications.
read_from_windowfunctionRead raster data from a specified window, with optional padding for out-of-bounds areas.
read_reprojectfunctionReproject raster data to a different CRS, resolution, and/or extent.
read_reproject_likefunctionReads from data_in and reprojects to have the same extent and resolution than data_like.
read_rpcsfunctionThis function georreferences an array using the RPCs.
read_to_crsfunctionChange the crs of data_in to dst_crs.
resizefunctionResample raster data to a different spatial resolution with optional anti-aliasing.
window_from_boundsfunctionCalculate the raster window corresponding to geographic bounds.
window_from_center_coordsfunctionCalculate a raster window of specified size centered on geographic coordinates.
window_from_polygonfunctionCalculate the raster window that contains a polygon in pixel coordinates.
window_from_tilefunctionCalculate the raster window corresponding to a Web Mercator (XYZ) tile.

georeader.save

NameKindWhat it does
save_cogfunctionSave a GeoData object as a Cloud Optimized GeoTIFF (COG).
save_tiled_geotifffunctionSave a GeoData object as a tiled GeoTIFF file.

georeader.rasterio_reader

NameKindWhat it does
RasterioReaderclassLazy file-backed raster reader with geospatial metadata.
get_out_shapefunctionCalculate aspect-preserving output shape.
mask_sas_tokenfunctionMask the signature of an Azure SAS token embedded in a file path.
needs_boundlessfunctionCheck if a read window requires boundless mode.
read_out_shapefunctionRead raster with resampling to target shape.

georeader.mosaic

NameKindWhat it does
spatial_mosaicfunctionCreate a spatial mosaic by filling gaps with data from overlapping rasters.

Upstream: geotoolz-ops

Composable remote-sensing operators on GeoTensor.

geoops

NameKindWhat it does
ARVIclassAtmospherically Resistant Vegetation Index — Kaufman & Tanre 1992.
AdaptiveWindowBackgroundclassPer-pixel local mean and diagonal variance over a square window.
AltitudeMaskclassBuild a boolean mask from DEM elevation bounds.
AnnotatePointsclassDraw circular point markers into a display GeoTensor.
AnnotatePolygonsclassRasterize polygon outlines into a display GeoTensor.
AntimeridianSplitclassSplit a geographic swath at a longitude wrap.
AppendIndexclassRun an index operator and concatenate its output back as a new band.
ApplyAdaptiveMFclassApply a matched filter against per-pixel local window statistics.
ApplyClusterMFclassApply a matched filter dispatched by per-pixel cluster label.
ApplyColormapclassMap a single-band raster to a four-band RGBA GeoTensor.
ApplyDiscreteColormapclassMap integer categories to a four-band RGBA GeoTensor.
ApplyMaskclassApply a boolean mask to the carrier, filling True pixels.
ApplySRFclassConvolve hyperspectral bands to target Gaussian-SRF multispectral bands.
AsinhScaleclassInverse-hyperbolic-sine scaling.
AtmosphericHazeclassAdd a sampled haze term following an inverse fourth-power spectrum.
BAIS2classBurned Area Index for Sentinel-2 — Filipponi 2018.
BAPCompositeclassBest Available Pixel compositing from quality-score metadata.
BBoxMaskclassRasterize an axis-aligned bounding box into a boolean mask.
BSIclassBare Soil Index — Rikimaru et al. 2002.
BTFromRadianceclassConvert thermal at-sensor radiance to brightness temperature (Kelvin).
BandDropoutclassFill each band independently with probability p.
BandJitterclassPermute bands within explicitly configured groups.
BandMathclassEvaluate a restricted arithmetic expression over named bands.
BandRatioclassSimple two-band ratio numerator / (denominator + eps).
BilateralDenoiseclassEdge-aware denoise using a range-weighted Gaussian.
BlendMatchedclassWeighted mean across N aligned tensors.
BlobDOGclassBlob detection via Difference of Gaussian.
BlobDoHclassBlob detection via Determinant of Hessian.
BlobLoGclassBlob detection via Laplacian of Gaussian.
BowtieCorrectionclassRemove whiskbroom bowtie overlap by resampling each scan along track.
BrightnessJitterclassScale reflectance values by a sampled scalar or per-band factor.
BufferMaskclassRadially expand True pixels in a mask by a Euclidean buffer.
CHWtoHWCclassReorder a (..., C, H, W) cube to channels-last (..., H, W, C).
CIRIclassCirrus Reflectance Index — Sentinel-2 B10 passthrough.
CLAHEclassContrast-Limited Adaptive Histogram Equalization.
CannyclassCanny edge detection returning a boolean edge map.
ChanVeseclassActive-contour segmentation via :func:skimage.segmentation.chan_vese.
ClayMineralsclassClay Minerals ratio — Sabins 1999 / Crowley et al. 1989.
CleanMaskclassRemove small objects, fill small holes, then close the mask.
CloseMaskclassClose (dilate then erode) a boolean mask.
CloudFreeCompositeclassPer-pixel mean over frames where the cloud mask is false.
CloudSEN12classPlaceholder for the optional ML-based CloudSEN12 detector.
ColumnEnhancementclassConvenience trace-gas column-enhancement matched-filter composite.
ColumnToMassclassConvert column enhancement units (ppm m / mol m^-2 / kg m^-2).
CombineMasksclassCombine boolean masks on one pixel grid with or, and or xor.
CompositeclassBuild a multi-band composite by arbitrary band reference.
ComputeSZAclassCompute the solar zenith angle (degrees) for a location and UTC datetime.
ContinuumRemovalclassHull-quotient continuum removal along the band axis.
ContrastJitterclassScale deviations from the per-band spatial mean.
CornerHarrisclassHarris corner response plus peak selection as point features.
CountryMaskclassRasterize Natural Earth country polygons selected by ISO A3 code.
CropToclassCrop a GeoTensor to a target spatial shape.
CropToBoundsclassCrop a GeoTensor to a geographic bounding box.
CrossSectionalFluxclassEstimate cross-sectional flux at downwind transects.
CutMixclassPaste a random rectangle from a pool donor on the input’s pixel grid.
DNToRadianceclassConvert DN to at-sensor radiance.
DNToReflectanceclassConvert DN to TOA / surface reflectance via a linear affine decode.
DOS1classApply a Chavez (1988) Dark-Object Subtraction (DOS1) approximation.
DecodeBitmaskclassUnpack a QA bitmask into named boolean mask layers.
DenoisePCAclassReconstruct a multi-band raster from its top PCA components.
DespeckleFrostclassFrost (1982) adaptive exponential-kernel speckle filter.
DespeckleLeeclassLee (1980) local-statistics speckle filter.
DespeckleRefinedLeeclassRefined-Lee speckle filter approximation.
DestripeColumnclassSubtract per-column (or per-row) offsets from striped imagery.
DetectionThresholdclassGaussian false-alarm score threshold.
DilateMaskclassDilate a boolean mask over its trailing spatial axes.
DistanceMaskclassMask pixels by their distance from a geometry (True = drop).
EVIclassEnhanced Vegetation Index — Huete et al. 2002.
EVI2classTwo-band Enhanced Vegetation Index — Jiang et al. 2008.
EarthSunDistanceCorrectionclassCompute the Earth–Sun distance d (in AU) for an acquisition date.
EinxclassApply any einx operation to the carrier, geo-aware.
ErodeMaskclassErode a boolean mask over its trailing spatial axes.
EstimateCovEmpiricalclassEstimate an empirical covariance operator.
EstimateCovLowRankclassEstimate a low-rank-plus-Tikhonov covariance operator.
EstimateCovShrunkclassEstimate a diagonal-target shrinkage covariance operator.
EstimateMeanclassEstimate a spectral background mean vector from a cube.
ExpandLabelsclassGrow label regions by a fixed pixel distance without overlap.
FalseColorclassBuild a NIR-red-green false-colour composite.
FelzenszwalbclassGraph-based segmentation via :func:skimage.segmentation.felzenszwalb.
FindContoursclassExtract iso-value contours as LineString geometries.
GCIclassGreen Chlorophyll Index — Gitelson et al. 2003.
GMMClusterBackgroundclassEstimate clustered background statistics with a NumPy GMM backend.
GammaclassPower-law gamma correction.
GammaCorrectclassApply display gamma correction.
GapFillIDWclassFill NaNs with inverse-distance weighted finite neighbours.
GapFillInpaintBiharmonicclassSmoothly inpaint NaN gaps with a biharmonic-style fill.
GapFillLaplacianclassFill NaNs by solving a discrete Laplace equation.
GapFillNearestclassFill NaNs from the nearest finite neighbour.
GaussianDenoiseclassGaussian smoother over the trailing two spatial axes.
GaussianNoiseclassAdd zero-mean Gaussian sensor noise.
GeoTensorEstimatorclassMarshall a scikit-learn estimator to and from GeoTensor-shaped data.
GeoreferenceclassGeoreference swath data using a georeader GLT GeoTensor.
GeostationaryParallaxCorrectclassShift pixels from apparent geostationary view position to nadir.
HOGclassHistogram of Oriented Gradients descriptor.
HWCtoCHWclassReorder a channels-last (..., H, W, C) array to (..., C, H, W).
HillshadeclassCompute a single-band uint8 hillshade from a DEM.
HistogramMatchclassMatch a GeoTensor histogram to a reference GeoTensor.
HistogramStretchclassPer-band percentile stretch into out_range for visualisation.
HoughCirclesclassDetect circles with the circular Hough transform.
HoughLinesclassDetect prominent straight lines with the Hough transform.
IMEEstimateclassIntegrated Mass Enhancement (IME) flux estimator.
IntegratedIrradianceclassCompute band-integrated TOA solar irradiance from an SRF table.
InvertMaskclassInvert a boolean mask element-wise.
IronOxideclassIron Oxide ratio — Segal 1982 / Sabins 1999.
LabelConnectedComponentsclassConvert a binary mask into an int32 connected-component label map.
LandMaskclassRasterize Natural Earth land polygons into a boolean mask.
LandsatQA_PIXELclassLandsat Collection-2 QA_PIXEL mask preset.
LinearTargetFromObsclassFinite-difference tangent-linear target from an observation model.
LoadFromEEclassLoad an Earth Engine image into a :class:GeoTensor.
LoadFromSTACclassLoad a raster asset from a STAC item by asset key.
LogScaleclassLogarithmic scaling with an epsilon offset for zeros.
MNDWIclassModified Normalized Difference Water Index — Xu 2006.
MNFclassMinimum Noise Fraction transform (Green et al. 1988), with its inverse.
MODISStateQAclassMODIS state_1km (or state_500m) QA mask preset.
MarkBoundariesclassOverlay segmentation boundaries on an image for visual inspection.
MaskCirrusclassReturn True where a QA band marks cirrus pixels.
MaskCloudShadowclassReturn True where a QA band marks cloud-shadow pixels.
MaskCloudsclassReturn True where a QA band marks cloud-contaminated pixels.
MaskInvalidclassMark invalid (nodata) pixels: True = invalid, drop it.
MaskNMSclassMask-IoU non-maximum suppression over a stack of instance masks.
MaskNoDataclassReturn True where pixels are no-data by QA value or carrier fill value.
MaskSaturatedclassReturn True where pixels are at or above a saturation value.
MaskSnowclassReturn True where a QA band marks snow or ice pixels.
MaskWaterclassReturn True where a QA band marks water pixels.
MatchedFilterclassPer-pixel matched-filter score map.
MatchedFilterPixelclassSingle-pixel matched-filter score.
MatchedFilterSNRclassTheoretical detection SNR amplitude * sqrt(t^T Sigma^-1 t).
MaxNDVICompositeclassPick the frame with maximum NDVI per pixel and return its band values.
MedianCompositeclassPer-pixel median across a stack of co-registered GeoTensors.
MedianDenoiseclassMedian filter over the trailing two spatial axes.
MergeNearbyInstancesclassMerge instance labels whose bboxes are close and partially overlap.
MinCloudCompositeclassPick each pixel from the scene with the lowest global cloud coverage.
MinMaxScalerclassPer-band min-max scaling into an arbitrary output range.
MinMaxStretchclassLinear contrast stretch into [0, 1].
ModelOpclassWrap any callable as an Operator.
MomentMatchingclassDestripe by matching every column’s mean and std to a reference.
MosaicclassMosaic multiple GeoTensors onto a single grid.
MultiscaleBasicFeaturesclassGeneral-purpose multiscale feature stack.
NBRclassNormalized Burn Ratio — Key & Benson 2006.
NBR2classNormalized Burn Ratio 2 — USGS Landsat product.
NDBIclassNormalized Difference Built-up Index — Zha et al. 2003.
NDMIclassNormalized Difference Moisture Index — Gao 1996.
NDSIclassNormalized Difference Snow Index — Hall et al. 1995.
NDVIclassNormalized Difference Vegetation Index — Rouse et al. 1974.
NDWIclassNormalized Difference Water Index — McFeeters 1996.
NLMeansclassLightweight non-local-means-style denoiser.
NonlinearTargetFromObsclassFinite-amplitude target from a callable observation model.
NormalizeclassFixed-stats per-band z-score normaliser.
NormalizedDifferenceclassGeneric normalized-difference index (a - b) / (a + b + eps).
OceanMaskclassRasterize Natural Earth ocean polygons into a boolean mask.
OmniCloudMaskclassPlaceholder for the optional ML-based OmniCloudMask detector.
OpenMaskclassOpen (erode then dilate) a boolean mask.
OpticalFlowILKclassDense per-pixel displacement via iterative Lucas-Kanade optical flow.
OpticalFlowTVL1classDense per-pixel displacement via TV-L1 optical flow.
OutlierMaskclassFlag global outliers with a MAD or z-score threshold.
OverlayclassBlend background and foreground GeoTensors on the same grid.
PadToclassPad a GeoTensor up to a target spatial shape.
PeakLocalMaxclassFind local maxima and return point features with pixel scores.
PerBandReduceclassReduce each band over its spatial extent to one scalar, ignoring nodata.
PerBandStatsclassCompute NaN-aware per-band statistics and cache them.
PercentileClipclassPer-band robust contrast stretch using percentile thresholds.
PhaseAlignclassSub-pixel image registration via phase cross-correlation.
PixelwiseGMMclassGaussian mixture convenience operator.
PixelwiseIPCAclassStreaming IncrementalPCA convenience operator.
PixelwiseIsolationForestclassPixel-wise IsolationForest anomaly-score convenience operator.
PixelwiseIterativeImputerclassPixel-wise IterativeImputer convenience operator.
PixelwiseKMeansclassPixel-wise KMeans label convenience operator.
PixelwiseKNNImputerclassPixel-wise KNNImputer convenience operator.
PixelwiseLocalOutlierFactorclassPixel-wise LocalOutlierFactor convenience operator.
PixelwiseMiniBatchKMeansclassStreaming MiniBatchKMeans convenience operator.
PixelwiseNMFclassPixel-wise NMF convenience operator.
PixelwiseOneClassSVMclassPixel-wise OneClassSVM anomaly-score convenience operator.
PixelwisePCAclassPixel-wise PCA convenience operator.
PlumeColumnStatsclassPer-instance in-mask vs background statistics of a column field.
PlumeContoursclassConnected-component labelling of a plume mask.
PlumeFootprintclassVectorize a plume mask into polygons with per-plume metadata.
PlumeMaskclassBinary plume mask from a single-band score or enhancement map.
PlumeQNDFeaturesclassPer-instance Quantile-Normality-Deviation features for plume QA.
PlumeShapeFilterclassDrop instance labels that fail a fiber-shape morphology gate.
PointCloudToRasterclassRasterize a point cloud onto a target grid.
PointsToRasterclassBin a vector cube of point measurements onto a target raster grid.
PolygonMaskclassRasterize a shapely geometry or GeoDataFrame into a boolean mask.
PowerScaleclassNon-negative power scaling.
ProfileLineclassSample values along a line between two pixel coordinates.
QuickshiftclassMode-seeking superpixels via :func:skimage.segmentation.quickshift.
RANSACclassRobust model fitting via :func:skimage.measure.ransac.
RGBRecipeclassBuild a display RGB from three band expressions with fixed stretches.
RadianceToDNclassConvert at-sensor radiance back to raw DN — inverse of DNToRadiance.
RadianceToReflectanceclassConvert at-sensor radiance to TOA reflectance with solar geometry.
RandomCropclassRandomly crop a spatial window and update the transform.
RandomFlipclassRandomly flip a GeoTensor horizontally and/or vertically.
RandomRotate90classRandomly rotate by 90, 180, or 270 degrees.
RandomShiftclassRandomly shift a fixed-size spatial window in pixel units.
RandomWalkerclassSeeded segmentation via :func:skimage.segmentation.random_walker.
RasterToPointCloudclassSample raster values onto each node of a point cloud.
RasterToPointsclassExtract raster values at a vector cube of points.
RasterToRasterLikeclassAlign one raster onto another’s CRS + grid in a single op.
RasterizeclassRasterize geometries onto the input GeoTensor’s grid.
RasterizeLikeclassRasterize geometries onto a stored reference grid.
ReadBoundsclassRead all pixels intersecting a geographic bounding box.
ReadCenterCoordsclassRead a fixed-shape window centred on map coordinates.
ReadHDFclassRead a dataset from an HDF4/HDF-EOS or HDF5 file, local or remote.
ReadNetCDFclassRead a variable from a NetCDF-3 / NetCDF-4 file, local or remote.
ReadPolygonclassRead all pixels intersecting a polygon.
ReadReprojectLikeclassRead a source and reproject it onto another raster’s grid.
ReadTileclassRead a single web-map tile and reproject it to a target CRS.
ReadToCRSclassRead a source and reproject it to a target CRS.
ReadWindowclassRead a pixel-space rectangular window from a raster source.
ReflectanceToRadianceclassConvert TOA reflectance back to at-sensor radiance — inverse of RadianceToReflectance.
RegionPropsclassExtract a GeoDataFrame of per-region statistics from a label map.
RemoveSmallHolesclassFill enclosed False components up to max_hole_area_px pixels.
RemoveSmallObjectsclassRemove connected True components smaller than min_area_px pixels.
ReorderBandsclassReorder bands by integer index or band name.
ReplaceOutliersclassReplace outliers with median, NaN, or nearest-neighbour interpolation.
ReprojectclassReproject a GeoTensor to a destination CRS (and optional resolution).
ReprojectLikeclassReproject a GeoTensor onto another GeoTensor’s CRS + grid.
ResampleclassResample a GeoTensor to a target spatial resolution.
ResampleLikeclassResample a GeoTensor onto another GeoTensor’s spatial grid.
ResizeclassResize a GeoTensor to a target spatial shape.
RobustScalerclassPer-band median / IQR scaling (robust to outliers).
S2CloudlessclassPlaceholder for the optional ML-based s2cloudless mask.
S2QA60classSentinel-2 L1C QA60 cloud + cirrus mask preset.
S2SCLclassSentinel-2 L2A SCL preset that masks the requested targets classes.
SAVIclassSoil-Adjusted Vegetation Index — Huete 1988.
SBMPclassSingle-band multi-pass Sentinel-2 SWIR ratio retrieval.
SCLclassSentinel-2 L2A Scene Classification Layer class IDs.
SCL_CLOUDSconstantfrozenset({<SCL.CLOUD_MEDIUM_PROBABILITY: 8>, <SCL.CLOUD_...
SCL_CLOUDS_AND_INVALIDconstantfrozenset({<SCL.NO_DATA: 0>, <SCL.SATURATED_OR_DEFECTIVE:...
SCL_INVALIDconstantfrozenset({<SCL.NO_DATA: 0>, <SCL.SATURATED_OR_DEFECTIVE:...
SCL_LANDconstantfrozenset({<SCL.VEGETATION: 4>, <SCL.NOT_VEGETATED: 5>})
SCL_WATERconstantfrozenset({<SCL.WATER: 6>})
SENSOR_QA_REGISTRYconstant{'s2_qa60': {'cloud': {'bits': (10,)}, 'cirrus': {'bits':...
SLICclassSLIC superpixels via :func:skimage.segmentation.slic.
SWIRCompositeclassBuild a SWIR2-NIR-red composite.
SegmentStitchclassAssemble indexed sensor segments into one contiguous GeoTensor.
SelectBandsclassSelect bands by integer index or band name along the band axis.
ShadedReliefclassApply an elevation colormap and modulate RGB with hillshade.
ShannonEntropyclassCompute Shannon entropy of the input image.
SimpleAtmosphericCorrectionclassDispatch simple BOA approximations; currently supports method='dos1'.
SimulatedCloudsclassOverlay a smooth synthetic cloud field onto reflectance imagery.
SkeletonLengthclassLongest path through the skeleton of a binary mask.
SklearnOpclassUniversal adapter for scikit-learn-compatible estimators on GeoTensors.
SlidingWindowclassSplit a GeoTensor into overlapping sliding-window tiles.
SlopeMaskclassBuild a boolean mask from DEM slope bounds in degrees.
SpatialPoolclassDownsample the spatial grid by integer factors, updating the transform.
SpeckleNoiseclassApply multiplicative Gaussian speckle noise, useful for SAR.
SpectralBinningclassAggregate source bands into wavelength-centered bins.
SpectralSmoothingclassSmooth spectra along the band axis.
SplitBandsclassSplit a multiband GeoTensor into one single-band GeoTensor per band.
StackBandsclassConcatenate carriers along the band axis.
StackMatchedclassConcatenate aligned tensors along the band axis.
StandardScalerclassPer-band z-score normalisation.
StitchclassStitch georeferenced tiles back into one GeoTensor.
StreamingBackgroundclassAggregate mean/covariance across an iterable of cubes.
StretchToUint8classPercentile-stretch display data to uint8.
StructureTensorclassLocal structure-tensor eigenvalue stack.
SunAngleJitterclassRescale TOA reflectance for a simulated solar-zenith change.
ThresholdclassBinary mask of the pixels strictly above a global threshold.
TileclassSplit a GeoTensor into spatial tiles.
ToFloat32classCast the carrier’s values to float32.
TrueColorclassBuild an RGB composite from explicit red, green, and blue band refs.
ValidateMFInputsclassFail-fast pass-through validator for matched-filter inputs.
VectorToRasterAggclassRasterize a vector layer with an aggregation policy for overlaps.
VectorizeclassVectorize non-zero regions of a mask GeoTensor into polygons.
WatershedclassWatershed segmentation via :func:skimage.segmentation.watershed.
WindAdvectionConeclassMask likely downwind plume extent from a source and wind vector.
WriteCOGclassWrite a :class:GeoTensor as a validated Cloud-Optimized GeoTIFF.
WriteGeoTIFFclassWrite a :class:GeoTensor as a tiled GeoTIFF (no overviews).
WriteZarrclassWrite a :class:GeoTensor to a Zarr store with spatial metadata.
ZeroOneclassScale the current scene extent into [0, 1].
dNBRclassDifferenced Normalized Burn Ratio — Key & Benson 2006.
kNDVIclassKernel NDVI — Camps-Valls et al. 2021.

Upstream: geotoolz-catalog

Spatiotemporal catalog over geospatial files.

geocatalog

NameKindWhat it does
GeoCatalogclassA queryable spatiotemporal index over geospatial files.
GeoSliceclassA bounded request for data — produced by samplers, consumed by loaders.
intersectfunctionCross-catalog AND — rows from left paired with overlapping rows in right.
open_catalogfunctionOpen a GeoParquet artifact as a GeoCatalog.
queryfunctionFilter catalog by space + time and return the matching rows.
unionfunctionCross-catalog OR — concatenate left and right into one catalog.

Upstream: geotoolz-cloud

Cloud object storage and batched async COG reads.

Upstream: geotoolz-patcher

Four-axis patcher: split, run per patch, stitch.

geopatcher

NameKindWhat it does
AsyncFieldclassAsync mirror of Field — concurrent select over remote tiles.
AsyncSpatialPatcherclassAsync mirror of SpatialPatcher over an AsyncField.
DomainclassMetadata view of a field — bounds, CRS, no I/O.
FieldclassA substrate the Patcher reads patches out of.
PatchclassA single patch produced by a SpatialPatcher.
RasterFieldclassWrap a sync GeoData (a RasterioReader, a GeoTensor, …) as a Field.
SpatialPatcherclassThe four-axis spatial Patcher.
SpatioTemporalPatchclassA patch carrying both a spatial and a temporal anchor.
SpatioTemporalPatcherclassComposition of a spatial and a temporal Patcher.
TemporalPatchclassA single patch produced by a TemporalPatcher.
TemporalPatcherclassFour-axis temporal Patcher.

Upstream: geotoolz-products

Readers for Earth-observation data products.

geoproducts

NameKindWhat it does
ProductReaderclassABC for georeader-compatible product readers.
stackfunctionStack readers’ bands on the grid of readers[like].

Upstream: xrtoolz

Composable operators for Earth System Data Cubes.

xrtoolz

NameKindWhat it does
ApplyToEachclassRe-instantiate a prototype operator per value and merge results.
AugmentclassRun an inner Operator and merge its output back into the input.
OperatorclassRe-exported from xrcore.
SignatureclassRe-exported from xrcore.

Upstream: xrtoolz-core

xarray-aware Operator base and Signature descriptor.

Upstream: xrtoolz-einx

Labeled named-tensor algebra bridging xarray and einx.

xreinx

NameKindWhat it does
BatchMatmulclassBatched matrix multiply: contract dim within shared batch dims.
CoordMismatchclassShared dims have unequal coords and align=False.
EinsumclassNamed-tensor Einstein summation over one or more DataArrays.
EinxBridgeErrorclassBase for all :mod:xreinx errors.
MatmulclassContract two DataArrays over a shared dimension (matrix multiply).
OuterclassOuter product of two DataArrays over their disjoint dims.
PatternErrorclassPattern is malformed or references dims not on the inputs.
RearrangeclassReshape / transpose a DataArray by a named-tensor pattern.
ReduceclassReduce a DataArray over named axes with a chosen reduction.
RepeatclassBroadcast / tile a DataArray along new named axes.
batch_matmulfunctionmatmul along dim broadcast over shared batch_dims.
einsumfunctionLabeled einx einsum (contraction) over named dims.
matmulfunctionContract a and b along the shared dim.
outerfunctionOuter product.
pack_datasetfunctionStack named variables of a Dataset along a new dim.
rearrangefunctionLabeled einx rearrange (reshape / transpose / merge / split).
reducefunctionReduce over named axes (axes on the input slot, absent from output).
repeatfunctionBroadcast / tile along new named axes.
unpack_datasetfunctionSplit a ‘variable’-style dim back into a Dataset.

Upstream: xrtoolz-grad

Finite-difference calculus on labeled xarray grids.

xrgrad

NameKindWhat it does
EARTH_RADIUSconstant6371000.0
GRAVITYconstant9.80665
OMEGAconstant7.2921159e-05
curlfunction2-D scalar curl ∂v/∂x − ∂u/∂y (vertical component of ∇×F).
divergencefunctionDivergence ∇·F of a vector field stored as Dataset variables.
gradientfunctionGradient ∇da under the given geometry.
grid_metrics_from_coordsfunctionDerive (volume_metrics, face_metrics) from a Dataset’s coords.
laplacianfunctionLaplacian Δf = ∇·∇f.
partialfunctionPartial derivative ∂ᵒʳᵈᵉʳda/∂<dim>ᵒʳᵈᵉʳ under the given geometry.

Upstream: xrtoolz-reader

Authenticated archive readers (CMEMS, CDS, AEMET).

xrreader

NameKindWhat it does
AEMETCredentialsclassAPI key for AEMET OpenData.
AemetArchiveclassAppend-only local mirror of AEMET station observations.
AemetAuthErrorclassMissing or rejected API key.
AemetErrorclassAny AEMET-level failure (auth, rate limit, bad envelope, 5xx).
AemetRateLimitErrorclassQuota exhausted even after backoff.
AemetSourceclassAdapter for AEMET OpenData observation endpoints.
ArchiveCoverageclassPer-station span of what the archive already holds for a preset.
BBoxclassAxis-aligned lon/lat bounding box.
CATALOGconstant{'glorys12.daily': CatalogEntry(source='cmems', dataset_i...
CDSCredentialsclassURL / key pair for the Climate Data Store.
CDSFormProfileclassShape of a CDS retrieve() form for a dataset family.
CDSInsituArchiveclassAppend-only local mirror of a CDS in-situ preset.
CDSSourceclassAdapter around the cdsapi Python client.
CMEMSCredentialsclassUsername / password pair for Copernicus Marine.
CMEMSSourceclassAdapter around the copernicusmarine Python client.
CatalogEntryclassShort-name-to-source mapping with optional request defaults.
DataSourceclassAbstract interface implemented by every adapter.
DatasetInfoclassStatic description of a remote dataset.
DatasetKindclassDiscriminator for how a dataset is laid out once materialized.
DepthRangeclassContinuous depth window (positive-down, metres).
INSITUconstantCDSFormProfile(family='insitu-land', format_key='data_for...
IssueclassSingle validation finding.
LocalL2SourceclassOpen satellite L2 product files from the local filesystem.
PressureLevelsclassDiscrete pressure levels in hPa (CDS-style).
REANALYSISconstantCDSFormProfile(family='reanalysis', format_key='format', ...
REGISTRYconstant{'sst': Variable(name='sst', standard_name='sea_surface_t...
RequestclassCanonical request payload consumed by data adapters.
SeverityclassTwo-level severity for validation issues.
StationclassOne fixed observation station.
StationCollectionclassImmutable collection of :class:Station with set-like filters.
TimeRangeclassInclusive time window, optionally with a target sampling frequency.
ValidationReportclassAggregate validation result with convenience accessors.
VariableclassCF-aware variable descriptor used across adapters and validators.
all_entriesfunctionReturn a shallow copy of the unified catalog.
apply_cf_attrsfunctionStamp CF attributes from variable onto da.
describefunctionLook up a :class:DatasetInfo by short name.
load_aemetfunctionLoad AEMET credentials, or None if none could be found.
load_cdsfunctionLoad CDS credentials, or None if none could be found.
load_cmemsfunctionLoad CMEMS credentials, or None if none could be found.
open_emit_ch4_l2bfunctionOpen an EMIT L2B CH4 enhancement scene as a flat CF Dataset.
open_ghgsat_ch4_l2functionOpen a GHGSat per-plume NetCDF as a flat CF Dataset.
open_tropomi_ch4_l2functionFlatten a TROPOMI CH4 L2 granule into one CF Dataset.
registerfunctionAdd variable to :data:REGISTRY (keyed on :attr:Variable.name).
resolvefunctionReturn a :class:Variable given an instance or its canonical name.
subset_bboxfunctionKeep points whose (lon, lat) fall inside a bounding box.
subset_timefunctionRestrict a dataset to the time range [time_min, time_max].
subset_wherefunctionKeep points where variable is in [min_val, max_val].
validate_datasetfunctionValidate multiple variables in a dataset.
validate_variablefunctionValidate a single :class:xarray.DataArray against a :class:Variable.

Upstream: xrtoolz-sklearn

scikit-learn to xarray bridge (XarrayEstimator, SklearnOp).

xrsklearn

NameKindWhat it does
MissingKindfunctionRe-exported from typing.
NanPolicyfunctionRe-exported from typing.
SklearnOpclassLayer-1 operator that delegates sklearn marshalling to XarrayEstimator.
TreeModefunctionRe-exported from typing.
XarrayEstimatorclassWrap an sklearn estimator so it operates on xarray inputs.