swarmpal.toolboxes.dsecs.processes

Classes

Preprocess	Prepare data for input to DSECS analysis
Analysis	Run the DSECS analysis

Functions

_get_dsecs_active_subtrees(datatree, output_dataset)

Returns the relevant subtrees (i.e. Alpha, Charlie)

Module Contents

class swarmpal.toolboxes.dsecs.processes.Preprocess(config: dict | None = None, active_tree: str = '/', inplace: bool = True)

Bases: swarmpal.io.PalProcess

Prepare data for input to DSECS analysis

property process_name

set_config(dataset_alpha: str = 'SW_OPER_MAGA_LR_1B', dataset_charlie: str = 'SW_OPER_MAGC_LR_1B', output_dataset: str = 'DSECS_output')

_call(datatree)

static _append_apex_coords(ds)

static _spherical_geocentric_to_geodetic(lat, lon, rad)

Convert from geocentric coordinates to geodetic lat/lon and height

Parameters:

• lat (array_like) – Geocentric latitude (degrees)

• lon (array_like) – Geocentric longitude (degrees)

• rad (array_like) – Geocentric radius (metres)

Returns:

• lat (ndarray) – Geodetic latitude (degrees)

• lon (ndarray) – Geodetic longitude (degrees)

• alt (ndarray) – Geodetic altitude (metres)

static _calc_apex_coords(date, lat, lon, rad)

Calculate Apex coordinates

Parameters:

• date (datetime) – Epoch date to use for Apex calculations

• lat (array_like) – Geocentric latitude (degrees)

• lon (array_like) – Geocentric longitude (degrees)

• rad (array_like) – Geocentric radius (metres)

Returns:

• mlat (ndarray) – Mangnetic apex latitude (degrees)

• mlon (ndarray) – Magnetic apex longitude (degrees)

swarmpal.toolboxes.dsecs.processes._get_dsecs_active_subtrees(datatree, output_dataset)

Returns the relevant subtrees (i.e. Alpha, Charlie)

class swarmpal.toolboxes.dsecs.processes.Analysis(config: dict | None = None, active_tree: str = '/', inplace: bool = True)

Bases: swarmpal.io.PalProcess

Run the DSECS analysis

property process_name

set_config(output_dataset: str = 'DSECS_output')

_call(datatree)