eomatch.preview.preview_matchup

eomatch.preview.preview_matchup#

eomatch.preview.preview_matchup(matchup: Matchup, output_path: str | None = None, collection_read_args: dict | None = None, max_pixels: int = 512, context: EOMatchContext | None = None) → Figure[source]#

Generate a side-by-side preview image for a matchup.

Convenience wrapper around BuildMUPreview. Reads each product using preview-optimised defaults (see BuildMUPreview) and returns a matplotlib.figure.Figure with one panel per sensor.

Example usage:

from eomatch.preview import preview_matchup

fig = preview_matchup(matchup)
fig = preview_matchup(matchup, output_path="preview.png", max_pixels=256)
Parameters:

  • matchup – matchup object whose products will be previewed.

  • output_path – optional path at which to save the figure.

  • collection_read_args – per-collection call-time overrides (same semantics as BuildMUPreview.run()).

  • max_pixels – maximum pixel extent in either spatial dimension after downsampling.

  • context – optional Context supplying the preview.read config; defaults to the package default config.

Returns:

matplotlib Figure.