Skip to content

Bulk Analyses Sensor Translation

Module: spectralbridge.bulk.analyses.sensor_translation.

Hierarchical synthetic MicaSense-to-Landsat translation analysis.

API glossary ยท Workflow / scientific context

Signatures and documentation below are collected from the current source. Advanced objects are not newly declared stable by inclusion here.

Audience: advanced.

SensorTranslationPaths dataclass

SensorTranslationPaths(directory: Path)

Resolve pooled, balanced and grouped sensor-fit artifacts beneath a bulk run.

pixel_pooled property

pixel_pooled: Path

per_flightline property

per_flightline: Path

per_site property

per_site: Path

flightline_balanced property

flightline_balanced: Path

site_balanced property

site_balanced: Path

metadata property

metadata: Path

Audience: public. Also exported as spectralbridge.bulk.analyses.run_sensor_translation, spectralbridge.bulk.run_sensor_translation.

run_sensor_translation

run_sensor_translation(con: DuckDBPyConnection, paths: BulkAnalysisPaths, *, analysis_run_id: str, minimum_reflectance: float, translation_pairs: tuple[TranslationPair, ...] | None = None, reuse_existing: bool = True) -> dict[str, Any]

Run pooled, grouped, and equal-replicate sensor regressions.

Parameters:

Name Type Description Default
con DuckDBPyConnection

Open DuckDB connection prepared by the bulk workflow with the required catalog and observation views; the caller owns its lifetime.

required
paths BulkAnalysisPaths

BulkAnalysisPaths instance selecting isolated catalog, database, analysis and report locations.

required
analysis_run_id str

Provenance identifier written into generated tables and restart metadata for this run.

required
minimum_reflectance float

Lower screening bound in the stored reflectance units; used for regression validity, not automatic unit conversion.

required
translation_pairs tuple[TranslationPair, ...] | None

Explicit registered source-to-target relationships to analyze; None uses the selected registry/profile defaults.

None
reuse_existing bool

Reuse valid analysis outputs when their recorded inputs match, rather than recomputing them.

True

Returns:

Type Description
dict[str, Any]

Status, pair/candidate counts and paths to pooled, balanced, per-flightline/per-site fits and candidate coefficients.

See Also

spectralbridge.pipelines.bulk.run_bulk_pipeline : Related source-derived API contract.

Explicitly exported constants and type aliases

These values describe package metadata, schemas or configuration; they are not observations from a production dataset.

Name Source expression
REQUIRED_INPUT_TABLES ('bulk_observations',)
REQUIRED_PROVENANCE_COLUMNS ('bulk_source_id', 'bulk_flightline_id', 'bulk_site')