GUIBRUSHR.GUI.DataInterface.DataInterface module

GUIBRUSHR.GUI.DataInterface.DataInterface.get_target_list(path_targets_folder: Path) → array[source]

Get a list of all target directories in the specified folder.

Parameters:

path_targets_folder (Path) – Path to the targets folder

Returns:

Array of target names, or [“None”] if no targets found

Return type:

array

GUIBRUSHR.GUI.DataInterface.DataInterface.get_target_info(path_targets_folder: Path, target: str, rad_mode: str = 'Transmission') → Target[source]

Read and parse target information from YAML file.

Parameters:

  • path_targets_folder (Path) – Path to the targets folder

  • target (str) – Target identifier

  • rad_mode (str, optional) – Radiation mode. Defaults to “Transmission”

Returns:

Target object containing parsed information

Return type:

Target

GUIBRUSHR.GUI.DataInterface.DataInterface.get_list_cross_corr_models(path_targets_folder: Path, target: str, rad_mode: str) → Dict[str, Path][source]

Get dictionary of cross-correlation models for a target.

Parameters:

  • path_targets_folder (Path) – Path to the targets folder

  • target (str) – Target identifier

  • rad_mode (str) – Radiation mode

Returns:

Dictionary mapping model names to their paths,

or {“None”: “None”} if no models are found

Return type:

Dict[str, Path]

GUIBRUSHR.GUI.DataInterface.DataInterface.get_target_instruments(path_targets_folder: Path, target: str, resolution: str, rad_mode: str, calling_file_name: str) → List[str][source]

Get list of instruments available for a target at specified resolution.

Parameters:

  • path_targets_folder (Path) – Path to the targets folder

  • target (str) – Target identifier

  • resolution (str) – Resolution type (e.g., “HR” or “LR”)

  • rad_mode (str) – Radiation mode

  • calling_file_name (str) – Name of the calling function (for logging purposes)

Returns:

List of instrument names, or [“None”] if no instruments found

Return type:

List[str]

GUIBRUSHR.GUI.DataInterface.DataInterface.get_target_nights(path_targets: Path, target: str, rad_mode: str, instrument: str, simulated) → str[source]

Get list of observation nights for a target and instrument.

Parameters:

  • path_targets (Path) – Path to the targets folder

  • target (str) – Target identifier

  • rad_mode (str) – Radiation mode

  • instrument (str) – Instrument identifier

  • simulated (bool) – Whether to include simulated nights

Returns:

Comma-separated list of nights, or “None” if no nights found

Return type:

str

GUIBRUSHR.GUI.DataInterface.DataInterface.insert_target_catalog(path_target: Path, target_id: str, radius, mass, gravity, t_eq, stellar_radius, stellar_mass, p0, hjd0, period, vsys, limph_T14, limph_T12, limph_T23, kp, ks, ecc, t14, t12, t23, opi=1.57, stellar_teff=0, ra=0, dec=0, a_Rs_ratio=0, projected_obliquity=0, inclination=0, v_sini=0) → None[source]

Create a new target catalog entry with associated directories.

Parameters:

  • path_target (Path) – Base path for targets

  • target_id (str) – Target identifier

  • radius – Radius in Jupiter radii

  • mass – Mass in Jupiter masses

  • gravity – Surface gravity in cm/s²

  • t_eq – Equilibrium temperature in Kelvin

  • stellar_radius – Stellar radius in solar radii

  • stellar_mass – Stellar mass in solar masses

  • p0 – Reference pressure in log10(bar)

  • hjd0 – Reference HJD in days

  • period – Orbital period in days

  • vsys – Systemic velocity in km/s

  • limph_T14 – Phase limit in hours for T14 transit

  • limph_T12 – Phase limit in hours for T12 transit

  • limph_T23 – Phase limit in hours for T23 transit

  • kp – Planet Semi-amplitude in km/s

  • ks – Star Semi-amplitude in km/s

  • ecc – Eccentricity

  • t14 – Total transit duration in hours for T14 transit

  • t12 – Total transit duration in hours for T12 transit

  • t23 – Total transit duration in hours for T23 transit

  • opi – Periastron argument in radians. Defaults to 1.57

  • stellar_teff – Stellar effective temperature in Kelvin. Defaults to 0

  • ra – Right ascension in degrees. Defaults to 0

  • dec – Declination in degrees. Defaults to 0

  • a_Rs_ratio – Semi-major axis to stellar radius ratio. Defaults to 0

  • projected_obliquity – Projected stellar obliquity in degrees. Defaults to 0

  • inclination – Orbital inclination in degrees. Defaults to 0

  • v_sini – Projected stellar rotational velocity in km/s. Defaults to 0

GUIBRUSHR.GUI.DataInterface.DataInterface.insert_night_in_target(path_target: Path, target_id: str, rad_mode: str, instrument: str, night: str) → Path[source]

Create a new night directory for a target and instrument.

Parameters:

  • path_target (Path) – Base path for targets

  • target_id (str) – Target identifier

  • rad_mode (str) – Radiation mode

  • instrument (str) – Instrument identifier

  • night (str) – Night identifier

Returns:

Path to the created night directory

Return type:

Path

GUIBRUSHR.GUI.DataInterface.DataInterface.insert_instrument_lr_in_target(path_target: Path, target_id: str, rad_mode: str, instrument: str) → Path[source]

Create a new instrument directory for a target.

Parameters:

  • path_target (Path) – Base path for targets

  • target_id (str) – Target identifier

  • rad_mode (str) – Radiation mode

  • instrument (str) – Instrument identifier

Returns:

Path to the created instrument directory

Return type:

Path