Bulk Harmonized¶

Module: spectralbridge.bulk.harmonized.

Explicit boundary for intentionally building a pixel-level bulk dataset.

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: public. Also exported as spectralbridge.build_harmonized_dataset, spectralbridge.bulk.build_harmonized_dataset.

build_harmonized_dataset ¶

build_harmonized_dataset(input_path: str | Path, output_dir: str | Path, **kwargs: Any) -> dict[str, Any]

Build the legacy combined pixel dataset as an explicit requested product.

Parameters:

Name	Type	Description	Default
`input_path`	`str \| Path`	Existing source tree or merged Parquet to inventory; input products are read in place.	required
`output_dir`	`str \| Path`	Directory for generated products; bulk outputs must be outside the read-only input tree.	required
`kwargs`	`Any`	Additional keyword options forwarded to run_bulk_pipeline; materialize_observations is controlled by this builder and must not be supplied.	`{}`

Returns:

Type	Description
`dict[str, Any]`	Bulk workflow result including the explicitly materialized combined pixel dataset and provenance paths.

Raises:

Type	Description
`TypeError`	If unsupported keyword options are supplied.

Notes

This compatibility builder currently produces the established combined Parquet through the bulk pipeline. It is deliberately separate from normal analysis so no caller can create a pixel-scale copy by accepting defaults. A future dedicated partitioned/Zarr builder can replace this implementation without changing the analysis contract.