SBART.data_objects.RV_outputs#
Store the RV_cube
of all the available sub-Instruments (for which SBART
computed RVs)
Classes
Manages the |
- class RV_holder#
Bases:
BASE
Manages the
RV_cube
that therv_calculation
routines produce.The goal of this class is to provide a simple user-interface to access the RV outputs of all sub-Instruments, and provide centralized trigger for data storage routines.
Note
This class is never created by the user, but it can be retrieved/returned from some functions.
Note
It is possible to load the RV results from disk by using:
find_RVoutputs()
- __init__(subInsts, output_keys, storage_path)#
- update_output_keys(keys)#
- remove_subInstrument_data(subInst)#
- Return type:
None
- add_RV_cube(subInst, RV_cube, is_merged=False)#
Store a new RV cube inside the holder
- Parameters:
subInst (str) – sub-Instrument that generated the data
RV_cube (
RV_cube
) – RV cube with the datais_merged (bool, optional) – if True, the RVs were computed by merging the skipped orders of each sub-Inst, by default False
- Return type:
NoReturn
- get_orders_to_skip(subInst)#
Retrieve the orders that were skipped for the calculation of RVs :type subInst:
str
:param subInst: Name of the sub-Instrument, or ‘merged’. Tis refers to how we selected the orders to be :type subInst: str :param discarded. If sub-Instrument: :param then we forced the same orders inside each individual dataSet. If: :param ‘merged’ the orders were forced to be the same across the entire data that was loaded!:- Returns:
List of orders that was skipped
- Return type:
List[int]
- Raises:
InvalidConfiguration – [description]
NoComputedRVsError – [description]
- get_stored_subInsts(merged)#
Get a list of the subInsts that have available RV cubes inside this object
- Parameters:
merged (bool) – If True, check for the “viable” instruments in the “merged” category
- Returns:
List of the subInstruments that have RVs stored in this object
- Return type:
subInst_list
- get_RV_cube(subInst, merged)#
Return a RV cube for the given subInstrument. The selected cybe is the one that was created when considering (or not) a merged set of orders to skip for the RV extraction
- Parameters:
subInst (str) – desired SubInstrument
merged (bool) – Return the cube that was created when considering (if True) or not (if False) a combined set of orders to skip (across all subInstruments)
- Returns:
cube – RV_cube object for the given configuration
- Return type:
- Raises:
InvalidConfiguration – If the subInst has no valid data
NoComputedRVsError – If there is no RV cube stored for the configurations requested by the user
- store_computed_RVs_to_disk(dataClassProxy, which_subInst)#
- Return type:
None
- store_complete_timeseries()#
Store, inside a single txt file, the RV timeseries from all loaded observations!
- Parameters:
storage_path (str) – [description]
- Return type:
None
- generate_new_cube(dataClassProxy, subInst, is_merged, has_orderwise_rvs)#
- trigger_data_storage(*args, **kwargs)#
- Return type:
NoReturn
- classmethod load_from_disk(high_level_path, load_full_flags=False, load_work_pkgs=False, SBART_version=None, only_load_type=None)#