GUIBRUSHR.Retrieval.ModelCalculation.Classes.Retrieval module

Retrieval class for astronomical data processing and model calculations.

This module contains the Retrieval class which handles the initialization and configuration of retrieval parameters for astronomical observations.

class GUIBRUSHR.Retrieval.ModelCalculation.Classes.Retrieval.Retrieval(scale, chemistry=None, ecc_opi=None, tell_rm_method=None, model_reprocessing=None, format_temperature=None, table_output_file=None, maxsteps=None, order_sel=None, id_process=None, path_results=None, retrieval_model=None, manual_model_obj=None, total_nights=0, total_hr_instruments=0, standardize_PCA='From pkl', mask_phase_enabled=False, mask_night_index=None, min_phase=None, max_phase=None, mask_inside_range=False, transit_limit_mode='T14')[source]

Bases: object

A class to handle retrieval parameters and configuration for astronomical data processing.

This class manages various parameters related to atmospheric retrieval models, including chemistry settings, temperature formatting, telluric removal methods, and output configurations.

__init__(scale, chemistry=None, ecc_opi=None, tell_rm_method=None, model_reprocessing=None, format_temperature=None, table_output_file=None, maxsteps=None, order_sel=None, id_process=None, path_results=None, retrieval_model=None, manual_model_obj=None, total_nights=0, total_hr_instruments=0, standardize_PCA='From pkl', mask_phase_enabled=False, mask_night_index=None, min_phase=None, max_phase=None, mask_inside_range=False, transit_limit_mode='T14')[source]

Initialize the Retrieval object with configuration parameters.

Parameters:

  • scale – Scale vector parameters for the retrieval process

  • chemistry – Chemistry configuration for atmospheric modeling

  • ecc_opi – Eccentricity and orbital parameters information

  • tell_rm_method – Method for telluric removal

  • model_reprocessing – Model reprocessing configuration

  • format_temperature – Temperature formatting settings

  • table_output_file – Output file path for tabulated results

  • maxsteps – Maximum number of steps for the retrieval algorithm

  • order_sel – Order selection parameters

  • id_process – Process identifier

  • path_results – Path where results will be stored

  • retrieval_model – The retrieval model to be used

  • manual_model_obj – Manual model object containing pre-configured parameters

  • standardize_PCA – PCA standardization mode (default: “From pkl”)

  • total_nights – Total number of observation nights (default: 0)

  • total_hr_instruments – Total number of HR instruments used (default: 0)

  • mask_phase_enabled – Flag indicating whether to apply a mask to the phase data (default: False)

  • mask_night_index – Index of the night to be masked (default: None)

  • min_phase – Minimum phase value to be masked (default: None)

  • max_phase – Maximum phase value to be masked (default: None)

  • mask_inside_range – Flag indicating whether to mask data inside the specified phase range (default: False)