Toggle navigation sidebar
Toggle in-page Table of Contents
WARNING! THIS PACKAGE IS IN ACTIVE DEVELOPMENT AND IS NOT YET STABLE!
SwarmPAL
SwarmPAL
Getting Started
Installation
Quickstart
Acknowledgements
Contributing
Changelog
Toolbox Introductions
FAC: Field-aligned currents (WIP)
DSECS: Dipolar Spherical Elementary Current Systems
TFA: Time-Frequency Analysis
TFA Toolbox (old form)
Intro to the TFA tool and the Wavelet Transform
Using the TFA toolbox
Analysis of Swarm HR data (50 Hz sampling rate)
Analysis of Swarm Electric Field data
Analysis of Ground Station data
For developers
PAL-flavoured Datatree
Data I/O (old)
API
swarmpal.io
swarmpal.toolboxes.fac
swarmpal.toolboxes.dsecs
swarmpal.toolboxes.tfa
repository
open issue
Index
A
|
C
|
D
|
E
|
F
|
G
|
I
|
M
|
O
|
P
|
Q
|
R
|
S
|
T
|
V
|
W
|
X
A
active_component (swarmpal.toolboxes.tfa.processes.Preprocess property)
active_tree (swarmpal.io.PalProcess property)
(swarmpal.toolboxes.dsecs.processes.Analysis property)
(swarmpal.toolboxes.dsecs.processes.Preprocess property)
(swarmpal.toolboxes.fac.processes.FAC_singlesat property)
(swarmpal.toolboxes.tfa.processes.Clean property)
(swarmpal.toolboxes.tfa.processes.Filter property)
(swarmpal.toolboxes.tfa.processes.Preprocess property)
(swarmpal.toolboxes.tfa.processes.WaveDetection property)
(swarmpal.toolboxes.tfa.processes.Wavelet property)
active_variable (swarmpal.toolboxes.tfa.processes.Preprocess property)
Analysis (class in swarmpal.toolboxes.dsecs.processes)
analysis_window (swarmpal.io.ExternalData property)
(swarmpal.io.MagExternalData property)
(swarmpal.io.PalDataItem property)
(swarmpal.toolboxes.tfa.tfa_processor.TfaInput property)
(swarmpal.toolboxes.tfa.tfa_processor.TfaProcessor property)
analyze() (swarmpal.toolboxes.dsecs.dsecs_algorithms.dsecsdata method)
append_array() (swarmpal.io.ExternalData method)
(swarmpal.io.MagExternalData method)
(swarmpal.toolboxes.tfa.tfa_processor.TfaInput method)
append_params() (swarmpal.toolboxes.tfa.tfa_processor.Cleaning method)
(swarmpal.toolboxes.tfa.tfa_processor.Filtering method)
(swarmpal.toolboxes.tfa.tfa_processor.TFA_Process method)
(swarmpal.toolboxes.tfa.tfa_processor.Wavelet method)
apply() (swarmpal.io.PalDataTreeAccessor method)
(swarmpal.toolboxes.tfa.tfa_processor.Cleaning method)
(swarmpal.toolboxes.tfa.tfa_processor.Filtering method)
(swarmpal.toolboxes.tfa.tfa_processor.TFA_Process method)
(swarmpal.toolboxes.tfa.tfa_processor.TfaProcessor method)
(swarmpal.toolboxes.tfa.tfa_processor.Wavelet method)
C
calculate_magnitude() (swarmpal.toolboxes.tfa.tfa_processor.TfaInput method)
Clean (class in swarmpal.toolboxes.tfa.processes)
Cleaning (class in swarmpal.toolboxes.tfa.tfa_processor)
COLLECTION (swarmpal.toolboxes.tfa.tfa_processor.TfaInput attribute)
COLLECTIONS (swarmpal.io.ExternalData attribute)
(swarmpal.io.MagExternalData attribute)
(swarmpal.toolboxes.tfa.tfa_processor.TfaInput attribute)
config (swarmpal.io.PalProcess property)
(swarmpal.toolboxes.dsecs.processes.Analysis property)
(swarmpal.toolboxes.dsecs.processes.Preprocess property)
(swarmpal.toolboxes.fac.processes.FAC_singlesat property)
(swarmpal.toolboxes.tfa.processes.Clean property)
(swarmpal.toolboxes.tfa.processes.Filter property)
(swarmpal.toolboxes.tfa.processes.Preprocess property)
(swarmpal.toolboxes.tfa.processes.WaveDetection property)
(swarmpal.toolboxes.tfa.processes.Wavelet property)
constant_cadence() (in module swarmpal.toolboxes.tfa.tfalib)
convert_to_mfa() (swarmpal.toolboxes.tfa.tfa_processor.TfaInput method)
create() (swarmpal.toolboxes.dsecs.dsecs_algorithms.dsecsgrid method)
(swarmpal.toolboxes.dsecs.dsecs_algorithms.grid1D method)
(swarmpal.toolboxes.dsecs.dsecs_algorithms.grid2D method)
create_paldata() (in module swarmpal.io)
create_segment_index() (swarmpal.toolboxes.tfa.tfa_processor.TfaProcessor method)
D
dataset_name (swarmpal.io.PalDataItem property)
datatree (swarmpal.io.PalDataItem property)
DEFAULTS (swarmpal.io.ExternalData attribute)
(swarmpal.io.MagExternalData attribute)
(swarmpal.toolboxes.tfa.tfa_processor.TfaInput attribute)
dsecsdata (class in swarmpal.toolboxes.dsecs.dsecs_algorithms)
dsecsgrid (class in swarmpal.toolboxes.dsecs.dsecs_algorithms)
dump() (swarmpal.toolboxes.dsecs.dsecs_algorithms.dsecsdata method)
E
ExternalData (class in swarmpal.io)
F
FAC_singlesat (class in swarmpal.toolboxes.fac.processes)
fetch_data() (swarmpal.io.ViresDataFetcher method)
Filter (class in swarmpal.toolboxes.tfa.processes)
filter() (in module swarmpal.toolboxes.tfa.tfalib)
Filtering (class in swarmpal.toolboxes.tfa.tfa_processor)
FindPole() (swarmpal.toolboxes.dsecs.dsecs_algorithms.dsecsgrid method)
fit1D_cf() (swarmpal.toolboxes.dsecs.dsecs_algorithms.dsecsdata method)
fit1D_df() (swarmpal.toolboxes.dsecs.dsecs_algorithms.dsecsdata method)
fit2D_cf() (swarmpal.toolboxes.dsecs.dsecs_algorithms.dsecsdata method)
fit2D_df() (swarmpal.toolboxes.dsecs.dsecs_algorithms.dsecsdata method)
flag_cleaning() (swarmpal.toolboxes.tfa.tfa_processor.TfaInput method)
FLAGNAME (swarmpal.toolboxes.tfa.tfa_processor.TfaInput attribute)
from_file() (swarmpal.io.PalDataItem static method)
from_hapi() (swarmpal.io.PalDataItem static method)
from_manual() (swarmpal.io.PalDataItem static method)
from_vires() (swarmpal.io.PalDataItem static method)
G
get_array() (swarmpal.io.ExternalData method)
(swarmpal.io.MagExternalData method)
(swarmpal.toolboxes.tfa.tfa_processor.TfaInput method)
get_eq() (in module swarmpal.toolboxes.dsecs.aux_tools)
get_exclusion_zone() (in module swarmpal.toolboxes.dsecs.dsecs_algorithms)
get_segment_inds_and_lims() (swarmpal.toolboxes.tfa.tfa_processor.TfaProcessor method)
getLocalDipoleFPtrack1D() (in module swarmpal.toolboxes.dsecs.dsecs_algorithms)
getLocalDipoleFPtrack2D() (in module swarmpal.toolboxes.dsecs.dsecs_algorithms)
getUnitVectors() (in module swarmpal.toolboxes.dsecs.dsecs_algorithms)
grid1D (class in swarmpal.toolboxes.dsecs.dsecs_algorithms)
grid2D (class in swarmpal.toolboxes.dsecs.dsecs_algorithms)
I
image() (swarmpal.toolboxes.tfa.tfa_processor.TfaProcessor method)
initialise() (swarmpal.io.ExternalData method)
(swarmpal.io.MagExternalData method)
(swarmpal.io.PalDataItem method)
(swarmpal.toolboxes.tfa.tfa_processor.TfaInput method)
input_data (swarmpal.toolboxes.tfa.tfa_processor.TfaProcessor attribute)
interp_nans() (swarmpal.toolboxes.tfa.tfa_processor.TfaProcessor method)
isotime2num() (in module swarmpal.toolboxes.tfa.tfa_processor)
M
mag_transform_dsecs() (in module swarmpal.toolboxes.dsecs.dsecs_algorithms)
MagExternalData (class in swarmpal.io)
magn() (in module swarmpal.toolboxes.tfa.tfalib)
magnetic_model_name (swarmpal.io.ExternalData property)
(swarmpal.io.MagExternalData property)
(swarmpal.io.PalDataTreeAccessor property)
(swarmpal.toolboxes.tfa.tfa_processor.TfaInput property)
magnetic_model_names (swarmpal.io.PalDataTreeAccessor property)
magnetic_models (swarmpal.io.PalDataItem property)
magnetic_residual() (swarmpal.io.PalDataTreeAccessor method)
MAX_FLAG_VAL (swarmpal.toolboxes.tfa.tfa_processor.TfaInput attribute)
mfa() (in module swarmpal.toolboxes.tfa.tfalib)
module
swarmpal.io
swarmpal.toolboxes.dsecs.aux_tools
swarmpal.toolboxes.dsecs.dsecs_algorithms
swarmpal.toolboxes.dsecs.processes
swarmpal.toolboxes.fac.processes
swarmpal.toolboxes.tfa.processes
swarmpal.toolboxes.tfa.tfa_processor
swarmpal.toolboxes.tfa.tfalib
morlet_wave() (in module swarmpal.toolboxes.tfa.tfalib)
moving_mean_and_stdev() (in module swarmpal.toolboxes.tfa.tfalib)
moving_q25_and_q75() (in module swarmpal.toolboxes.tfa.tfalib)
O
outliers() (in module swarmpal.toolboxes.tfa.tfalib)
P
pal_meta (swarmpal.io.PalDataTreeAccessor property)
PalData (class in swarmpal.io)
PalDataItem (class in swarmpal.io)
PalDataTreeAccessor (class in swarmpal.io)
PalFacDataTreeAccessor (class in swarmpal.toolboxes.fac.processes)
PalProcess (class in swarmpal.io)
parameters (swarmpal.io.ViresDataFetcher property)
params (swarmpal.toolboxes.tfa.tfa_processor.Cleaning attribute)
(swarmpal.toolboxes.tfa.tfa_processor.Filtering attribute)
(swarmpal.toolboxes.tfa.tfa_processor.TFA_Process attribute)
(swarmpal.toolboxes.tfa.tfa_processor.TfaProcessor attribute)
(swarmpal.toolboxes.tfa.tfa_processor.Wavelet attribute)
plotAUX() (swarmpal.toolboxes.tfa.tfa_processor.TfaProcessor method)
plotI() (swarmpal.toolboxes.tfa.tfa_processor.TfaProcessor method)
plotX() (swarmpal.toolboxes.tfa.tfa_processor.TfaProcessor method)
populate() (swarmpal.toolboxes.dsecs.dsecs_algorithms.dsecsdata method)
Preprocess (class in swarmpal.toolboxes.dsecs.processes)
(class in swarmpal.toolboxes.tfa.processes)
process_name (swarmpal.io.PalProcess property)
(swarmpal.toolboxes.dsecs.processes.Analysis property)
(swarmpal.toolboxes.dsecs.processes.Preprocess property)
(swarmpal.toolboxes.fac.processes.FAC_singlesat property)
(swarmpal.toolboxes.tfa.processes.Clean property)
(swarmpal.toolboxes.tfa.processes.Filter property)
(swarmpal.toolboxes.tfa.processes.Preprocess property)
(swarmpal.toolboxes.tfa.processes.WaveDetection property)
(swarmpal.toolboxes.tfa.processes.Wavelet property)
Q
quicklook() (swarmpal.toolboxes.fac.processes.PalFacDataTreeAccessor method)
R
REMOVE_CHAOS (swarmpal.toolboxes.tfa.tfa_processor.TfaInput attribute)
S
SAMPLING_TIME (swarmpal.toolboxes.tfa.tfa_processor.TfaInput attribute)
SECS_1D_CurlFree_magnetic() (in module swarmpal.toolboxes.dsecs.dsecs_algorithms)
SECS_1D_CurlFree_vector() (in module swarmpal.toolboxes.dsecs.dsecs_algorithms)
SECS_1D_DivFree_magnetic() (in module swarmpal.toolboxes.dsecs.dsecs_algorithms)
SECS_1D_DivFree_vector() (in module swarmpal.toolboxes.dsecs.dsecs_algorithms)
secs_2d_curlFree_antisym_lineintegral() (in module swarmpal.toolboxes.dsecs.dsecs_algorithms)
SECS_2D_CurlFree_antisym_magnetic() (in module swarmpal.toolboxes.dsecs.dsecs_algorithms)
SECS_2D_CurlFree_antisym_vector() (in module swarmpal.toolboxes.dsecs.dsecs_algorithms)
SECS_2D_DivFree_magnetic() (in module swarmpal.toolboxes.dsecs.dsecs_algorithms)
SECS_2D_DivFree_vector() (in module swarmpal.toolboxes.dsecs.dsecs_algorithms)
segment_index (swarmpal.toolboxes.tfa.tfa_processor.TfaProcessor attribute)
set_config() (swarmpal.io.PalProcess method)
(swarmpal.toolboxes.dsecs.processes.Analysis method)
(swarmpal.toolboxes.dsecs.processes.Preprocess method)
(swarmpal.toolboxes.fac.processes.FAC_singlesat method)
(swarmpal.toolboxes.tfa.processes.Clean method)
(swarmpal.toolboxes.tfa.processes.Filter method)
(swarmpal.toolboxes.tfa.processes.Preprocess method)
(swarmpal.toolboxes.tfa.processes.WaveDetection method)
(swarmpal.toolboxes.tfa.processes.Wavelet method)
set_inputs() (swarmpal.io.PalData method)
source (swarmpal.io.ExternalData property)
(swarmpal.io.MagExternalData property)
(swarmpal.toolboxes.tfa.tfa_processor.TfaInput property)
sph2sph() (in module swarmpal.toolboxes.dsecs.aux_tools)
sub_FindLongestNonZero() (in module swarmpal.toolboxes.dsecs.aux_tools)
sub_inversion() (in module swarmpal.toolboxes.dsecs.aux_tools)
sub_LonInterp() (in module swarmpal.toolboxes.dsecs.aux_tools)
sub_points_along_fieldline() (in module swarmpal.toolboxes.dsecs.aux_tools)
sub_Swarm_grids() (in module swarmpal.toolboxes.dsecs.aux_tools)
sub_Swarm_grids_1D() (in module swarmpal.toolboxes.dsecs.aux_tools)
subtract_chaos() (swarmpal.toolboxes.tfa.tfa_processor.TfaInput method)
swarmpal.io
module
swarmpal.toolboxes.dsecs.aux_tools
module
swarmpal.toolboxes.dsecs.dsecs_algorithms
module
swarmpal.toolboxes.dsecs.processes
module
swarmpal.toolboxes.fac.processes
module
swarmpal.toolboxes.tfa.processes
module
swarmpal.toolboxes.tfa.tfa_processor
module
swarmpal.toolboxes.tfa.tfalib
module
T
TFA_Process (class in swarmpal.toolboxes.tfa.tfa_processor)
TfaInput (class in swarmpal.toolboxes.tfa.tfa_processor)
TfaProcessor (class in swarmpal.toolboxes.tfa.tfa_processor)
TIME_LIMS (swarmpal.toolboxes.tfa.tfa_processor.TfaInput attribute)
to_file() (swarmpal.io.ExternalData method)
(swarmpal.io.MagExternalData method)
(swarmpal.toolboxes.tfa.tfa_processor.TfaInput method)
trim_data() (in module swarmpal.toolboxes.dsecs.dsecs_algorithms)
V
VARNAME (swarmpal.toolboxes.tfa.tfa_processor.TfaInput attribute)
VIRES_URL (swarmpal.io.ViresDataFetcher attribute)
ViresDataFetcher (class in swarmpal.io)
W
wave_detection() (swarmpal.toolboxes.tfa.tfa_processor.TfaProcessor method)
wave_index() (swarmpal.toolboxes.tfa.tfa_processor.TfaProcessor method)
WaveDetection (class in swarmpal.toolboxes.tfa.processes)
Wavelet (class in swarmpal.toolboxes.tfa.processes)
(class in swarmpal.toolboxes.tfa.tfa_processor)
wavelet_normalize() (in module swarmpal.toolboxes.tfa.tfalib)
wavelet_scales() (in module swarmpal.toolboxes.tfa.tfalib)
wavelet_transform() (in module swarmpal.toolboxes.tfa.tfalib)
X
X_label (swarmpal.toolboxes.tfa.tfa_processor.TfaProcessor attribute)
X_name (swarmpal.toolboxes.tfa.tfa_processor.TfaProcessor attribute)
xarray (swarmpal.io.ExternalData property)
(swarmpal.io.MagExternalData property)
(swarmpal.io.PalDataItem property)
(swarmpal.toolboxes.tfa.tfa_processor.TfaInput property)