pyampp.gxbox.selector_api

Classes

CoordMode	Coordinate representation used by the GUI center fields.
BoxGeometrySelection	Workflow-relevant box geometry values in the same shape as pyAMPP GUI fields.
SelectorSessionInput	Inputs needed to launch a future standalone map/box selector GUI.
DisplayFovSelection	Observer-plane image FOV used for synthetic image framing and canvas centering.
DisplayFovBoxSelection	Observer-aligned 3D FOV box.
SelectorDialogResult	Accepted result returned by the standalone selector dialog.
GeometrySelectionConsumer	Callback protocol for receiving accepted geometry selections.

Module Contents

class pyampp.gxbox.selector_api.CoordMode

Bases: str, enum.Enum

Coordinate representation used by the GUI center fields.

HPC = 'hpc'

HGC = 'hgc'

HGS = 'hgs'

class pyampp.gxbox.selector_api.BoxGeometrySelection

Workflow-relevant box geometry values in the same shape as pyAMPP GUI fields.

These map directly to the existing PyAmppGUI input widgets: - coord_x / coord_y -> coord_x_edit / coord_y_edit - grid_x / grid_y / grid_z -> grid_*_edit - dx_km -> res_edit (CLI --dx-km)

coord_mode: CoordMode

coord_x: float

coord_y: float

grid_x: int

grid_y: int

grid_z: int

dx_km: float

as_gui_text_fields() → dict[str, str]

Return values formatted for direct assignment to QLineEdit widgets.

class pyampp.gxbox.selector_api.SelectorSessionInput

Inputs needed to launch a future standalone map/box selector GUI.

map_ids and initial_map_id are UI-only state for visualization and are not part of the geometry return contract.

time_iso: str

data_dir: str

geometry: BoxGeometrySelection

fov: DisplayFovSelection | None = None

fov_box: DisplayFovBoxSelection | None = None

square_fov: bool = False

allow_geometry_edit: bool = True

map_ids: tuple[str, Ellipsis] = ()

map_files: dict[str, str] | None = None

refmaps: dict[str, dict[str, Any]] | None = None

base_maps: dict[str, Any] | None = None

base_wcs_header: str | None = None

base_geometry: BoxGeometrySelection | None = None

map_source_mode: str = 'auto'

display_observer_key: str = 'earth'

custom_observer_ephemeris: dict[str, Any] | None = None

custom_observer_label: str | None = None

custom_observer_source: str | None = None

available_observer_keys: tuple[str, Ellipsis] | None = None

observer_availability_notice: str | None = None

initial_map_id: str | None = None

pad_frac: float | None = None

class pyampp.gxbox.selector_api.DisplayFovSelection

Observer-plane image FOV used for synthetic image framing and canvas centering.

This is intentionally separate from the model box geometry. Values are expressed in helioprojective (observer-plane) arcsec, regardless of the red-box input coordinate mode.

center_x_arcsec: float

center_y_arcsec: float

width_arcsec: float

height_arcsec: float

as_gui_text_fields() → dict[str, str]

class pyampp.gxbox.selector_api.DisplayFovBoxSelection

Observer-aligned 3D FOV box.

The x/y footprint matches the image-plane FOV rectangle in helioprojective arcsec. The z extent is stored in observer-centric heliocentric coordinates (Mm) along the line of sight, where larger values are closer to the observer.

center_x_arcsec: float

center_y_arcsec: float

width_arcsec: float

height_arcsec: float

z_min_mm: float

z_max_mm: float

corners_local_mm: tuple[tuple[float, float, float], Ellipsis] | None = None

observer_key: str = 'earth'

classmethod from_display_fov(fov: DisplayFovSelection, z_min_mm: float, z_max_mm: float, *, observer_key: str = 'earth') → DisplayFovBoxSelection

as_observer_metadata(*, square: bool = False) → dict[str, float | str | bool]

class pyampp.gxbox.selector_api.SelectorDialogResult

Accepted result returned by the standalone selector dialog.

geometry: BoxGeometrySelection

fov: DisplayFovSelection | None = None

square_fov: bool = False

class pyampp.gxbox.selector_api.GeometrySelectionConsumer

Bases: Protocol

Callback protocol for receiving accepted geometry selections.

apply_geometry_selection(selection: BoxGeometrySelection) → None

Apply an accepted geometry selection to the host GUI/application.