Ctrl+K

SBART.template_creation.stellar_templates.sum_stellar

SBART.template_creation.stellar_templates.sum_stellar#

Classes

SumStellar

This is the usual stellar template, that is constructed by shifting all observations to a common, rest, frame (i.e.
class SumStellar#

Bases: StellarTemplate

This is the usual stellar template, that is constructed by shifting all observations to a common, rest, frame (i.e. by removing their stellar RVs) and computing a mean of all observations. Uncertainties can be propagated either through an analytical formula or by interpolating the original uncertainties of each observation.

User parameters:

This object doesn’t introduce unique user parameters.

Note: Check the User parameters of the parent classes for further customization options of this class

method_name = 'Sum'#
__init__(subInst, user_configs=None, loaded=False)#
Parameters:

  • subInst (str) – sub-Instrument for which the template is going to be created

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

  • loaded (bool) – True if the template was loaded from disk.

create_stellar_template(*args, **kwargs)#

Trigger the start of the creatoin of the stellar template

Parameters:

  • dataClass (DataClass) – Data

  • conditions (spectral_conditions) – Apply conditions over the frames that will be used to create the stellar template

Raises:

StopComputationError – If the computations is triggered by some event

launch_parallel(dataClass)#
add_new_frame_to_template(frame)#

Allow to inject a new observation into a pre-existing model. This base function checks for a match on the different flux corrections and ensures that the loaded Flag is set to False, so that it is possible to update the disk products afterwards.

Parameters:

frame (Frame) – A new frame to inject into the stellar template

Raises:

custom_exceptions.InvalidConfiguration: – If the flux corrections of the Frame do not match those from the stellar template

perform_calculations(in_queue, out_queue, buffer_info, **kwargs)#

Compute the stellar template from the input S2D data. Accesses the data from shared memory arrays!

property RV_keyword: str#
Return type:

str