Ctrl+K

SBART.template_creation.StellarModel

SBART.template_creation.StellarModel#

Handles the creation of the stellar models

Classes

StellarModel

The StellarModel is responsible for the creation of the stellar template for each sub-Instrument, allowing the user to apply spectral_conditions to select the observations that will be in use for this process.
class StellarModel#

Bases: TemplateFramework

The StellarModel is responsible for the creation of the stellar template for each sub-Instrument, allowing the user to apply spectral_conditions to select the observations that will be in use for this process.

This object supports the following user parameters:

User parameters:

Parameter name

Mandatory

Default Value

Valid Values

Comment

CREATION_MODE

False

Sum

Sum, OBSERVATION

Type of stellar template to create [1]

  • [1] Currently, SBART supports the usage of the following stellar templates:

Note: Also check the User parameters of the parent classes for further customization options of SBART Note: All disk- and user-facing interactions are handled by the parent class

model_type = 'Stellar'#
template_map = {'OBSERVATION': <class 'SBART.template_creation.stellar_templates.OBS_stellar.OBS_Stellar'>, 'Sum': <class 'SBART.template_creation.stellar_templates.sum_stellar.SumStellar'>}#
__init__(root_folder_path, user_configs=None)#

Instantiation of the object:

Parameters:

  • root_folder_path (Union [str, pathlib.Path]) – Path to the folder inside which SBART will store its outputs

  • user_configs (Optional[Dict[str, Any]]) – Dictionary with the keys and values of the user parameters that have been described above

Generate_Model(dataClass, template_configs=None, conditions=None, force_computation=False, store_templates=True)#

Apply the spectral conditions to decide which observations to use. Then, returns to the model generation as defined in the parent implementation.

Parameters:

  • dataClass ([type]) – DataClass with the observations

  • template_configs (dict) – Dictionary with the parameters needed to control the creation of the template. Each one has its own set of requirements

  • conditions (None, Condition) – Either None (to not select the OBS that will be used) or spectral_conditions to restrict the observations in use.

  • force_computation (bool) – If True, recompute the stellar templates, even if they exist on disk. By default False

  • store_templates (bool) – If True [default], store the templates to disk

Notes

  • The conditions that are passed to the StellarModel are only used for the creation of the stellar template. This will not reject observations from the RV extraction

Return type:

None

update_interpol_properties(new_properties)#
get_interpol_modes()#
Return type:

Set[str]

get_orders_to_skip(subInst)#
Return type:

Set[int]

load_templates_from_disk()#

Currently we only have one type of stellar template -> no need for the user to specify it

Parameters:

path (str) – [description]

Return type:

None

property RV_keyword: str#
Return type:

str