swarmpal.toolboxes.fac.processes

swarmpal.toolboxes.fac.processes#

Classes#

FAC_single_sat

Provides the process for the classic single-satellite FAC algorithm

PalFacDataTreeAccessor

Module Contents#

class swarmpal.toolboxes.fac.processes.FAC_single_sat(config: dict | None = None, active_tree: str = '/', inplace: bool = True)[source]#

Bases: swarmpal.io.PalProcess

Provides the process for the classic single-satellite FAC algorithm

property process_name#
set_config(dataset: str = 'SW_OPER_MAGA_LR_1B', model_varname: str = 'B_NEC_CHAOS', measurement_varname: str = 'B_NEC', inclination_limit: float = 30, time_jump_limit: int = 1, include_auxiliaries: bool = True, output_dataset: str = 'PAL_FAC_single_sat') → None[source]#

Configures the process

Parameters:

  • dataset (str, optional) – Dataset to use, by default “SW_OPER_MAGA_LR_1B”

  • model_varname (str, optional) – Name of the magnetic model predictions, by default “B_NEC_Model”

  • measurement_varname (str, optional) – Name of the measurements, by default “B_NEC”

  • inclination_limit (float, optional) – Limit of inclination for FAC validity (in degrees), by default 30

  • time_jump_limit (int, optional) – Maximum allowable time step in data for FAC validity (in seconds), by default 1

  • include_auxiliaries (bool, optional) – Whether to include e.g. Latitude, Longitude, Flags, etc, by default True

  • output_dataset (str) – Sets the name of the dataset in the data tree that TFA processes will write results to, by default “PAL_FAC_singlesat”

_call(datatree)[source]#
_validate()[source]#
_get_time(dataset)[source]#
_get_positions(dataset)[source]#
_get_B_res(dataset)[source]#
_get_B_model(dataset)[source]#
_append_aux(ds_in, ds_out)[source]#

Extract auxiliary information from inputs and add to output dataset

class swarmpal.toolboxes.fac.processes.PalFacDataTreeAccessor(datatree)[source]#
_datatree#
quicklook()[source]#
Contents