GUIBRUSHR.core.types.parameter_management_result module

Typed return value of ParameterHandler.read_df_parameters / parameter_management.

Replaces the legacy 11-tuple (mass_vector, scale, rayleigh_species, line_species, line_species_isotope, line_species_complete_name_hr, line_species_complete_name_lr, list_bestpars, list_bestpars_initial_value, list_fixed, list_condensed_molecules) whose positional unpacking at ModelSetup.py:330-340 had the same silent-reorder failure mode as param_array itself.

class GUIBRUSHR.core.types.parameter_management_result.ReadDfParametersResult(mass_vector: List[float], scale: Any, rayleigh_species: List[str], line_species: List[str], line_species_isotope: List[str], line_species_complete_name_hr: List[str], line_species_complete_name_lr: List[str], list_bestpars: List[str], list_bestpars_initial_value: List[float], list_fixed: List[str], list_condensed_molecules: List[str] | None, range_min_vector: Any = (), range_max_vector: Any = ())[source]

Bases: NamedTuple

Named-field view of the legacy 11-tuple returned by ParameterHandler.read_df_parameters.

Stays tuple-compatible (NamedTuple), so existing positional unpackers (the wasp77Ab pin test) keep working unchanged. New callers should use attribute access (result.list_bestpars, result.scale, …) so that any future field reorder fails loudly instead of silently misassigning values.

mass_vector: List[float]

Alias for field number 0

scale: Any

Alias for field number 1

rayleigh_species: List[str]

Alias for field number 2

line_species: List[str]

Alias for field number 3

line_species_isotope: List[str]

Alias for field number 4

line_species_complete_name_hr: List[str]

Alias for field number 5

line_species_complete_name_lr: List[str]

Alias for field number 6

list_bestpars: List[str]

Alias for field number 7

list_bestpars_initial_value: List[float]

Alias for field number 8

list_fixed: List[str]

Alias for field number 9

list_condensed_molecules: List[str] | None

Alias for field number 10

range_min_vector: Any

Alias for field number 11

range_max_vector: Any

Alias for field number 12

class GUIBRUSHR.core.types.parameter_management_result.ParameterManagementResult(registry: ParamRegistry, schema: ChainSchema, rayleigh_species: List[str], line_species: List[str], line_species_isotope: List[str], line_species_complete_name_hr: List[str], line_species_complete_name_lr: List[str], list_fixed: List[str], list_condensed_molecules: List[str] | None, mass_vector: ndarray | None = None)[source]

Bases: object

Bundle of state produced by reading a retrieval’s parameters table.

Variables:

  • registry (GUIBRUSHR.core.types.param_registry.ParamRegistry) – ParamRegistry populated with one slot per name in ConstantVariables.params_list. Slots whose parameter is absent from the parameters table are None.

  • schema (GUIBRUSHR.core.types.chain_schema.ChainSchema) – ChainSchema describing the flat free-parameter sequence (the in_bestpars=1 rows, with multi-parameter expansion already applied). Owns the canonical ordering used by every chain array.

  • rayleigh_species (List[str]) – Names of parameters that Rayleigh-scatter (continuum builders read this).

  • line_species_complete_name_hr, (line_species, line_species_isotope,)

  • line_species_complete_name_lr (List[str]) – Aligned lists describing the molecular line species selected for the radiative transfer setup.

  • list_fixed (List[str]) – Names of parameters that are set but not fitted (in_bestpars=0).

  • list_condensed_molecules (List[str] | None) – Active condensed-species names, or None when none are active.

  • mass_vector (numpy.ndarray | None) – Per-molecule mean masses harvested from the parameters table; only populated by read_df_parameters (None when built from a manual model that does not provide masses).

registry: ParamRegistry
schema: ChainSchema
rayleigh_species: List[str]
line_species: List[str]
line_species_isotope: List[str]
line_species_complete_name_hr: List[str]
line_species_complete_name_lr: List[str]
list_fixed: List[str]
list_condensed_molecules: List[str] | None
mass_vector: ndarray | None = None
__init__(registry: ParamRegistry, schema: ChainSchema, rayleigh_species: List[str], line_species: List[str], line_species_isotope: List[str], line_species_complete_name_hr: List[str], line_species_complete_name_lr: List[str], list_fixed: List[str], list_condensed_molecules: List[str] | None, mass_vector: ndarray | None = None) → None