gdas.epower.excess_power

gdas.epower. excess_power ( ts_data , band = None , fmin = 0 , fmax = None , impulse = False , make_plot = False , max_duration = None , nchans = 256 , output = None , psd_estimation = 'median-mean' , segment_length = 60 , segment_stride = 30 , station = 'station-name' , tile_fap = 1e-07 , verbose = True , window_fraction = 0 , wtype = 'tukey' ) [source]

Perform excess-power search analysis on magnetic field data. This method will produce a bunch of time-frequency plots for every tile duration and bandwidth analysed as well as a XML file identifying all the triggers found in the selected data within the user-defined time range.

Parameters
ts_data TimeSeries

Time Series from magnetic field data

segment_length float

Length of each segment in seconds

segment_stride float

Separation between 2 consecutive segments in seconds

psd_estimation string

Average method

window_fraction float

Withening window fraction

tile_fap float

Tile false alarm probability threshold in Gaussian noise.

nchans int

Total number of channels

band float

Channel bandwidth

fmin float

Lowest frequency of the filter bank.

fmax float

Highest frequency of the filter bank

Examples

The program can be ran as an executable by using the gdas command line as follows:

gdas excesspower --station fribourg01 \
     --start-time 2018-06-15-09 --end-time 2018-06-15-10 \
     --data-path ../GNOMEDrive/gnome/serverdata/ \
     --tile-fap 1e-7 --output trigger_map