data.edit.mentor.generate.spikefilter

data.edit.mentor.generate.spikefilter generates suggested mentor edits based on a series of spike detection algorithms applied to data. These are configured by spikefilter.conf. For example a standard neph filter may consist of a filter that invalidates any data that is out of a physically reasonable range, a filter based on the residual of a Kalman filter's prediction of backscattering, and then one on another filter's prediction of total scattering. Each successive filter only sees data that has passed all preceding filters, so the later a filter is the more “clean” data it sees. In the prior example any one of the steps flagging a time as being a spike results in both total and backscattering for that time being removed.

Command Line Usage

data.edit.mentor.generate.spikefilter station start end

Arguments

start and end

The time specifiers edits to be generated. Start is inclusive while end is exclusive, so all edits intersecting within the half open interval [start,end) will be returned. Any convertible time format is accepted.

station

The station identifier code. For example 'brw'. Case insensitive.

Output

Output is a series of suggested edits (one per line) of form:

start,end,record,type,params,modified,author,notes

start and end

The start and end of this edit in epoch time. If the field is null (zero length), then that parameter does not apply, so a null start with a valid end indicates all data up until (but excluding) the end time. Likewise a null end but a defined start is all data including and after the start. Both being defined is the half-open interval of time [start,end). Both null defines all time.

record

Record type this edit is applied to, may be null to apply to all records. May not contain more than one record type (that is represented by multiple lines).

type and params

Edit type and parameters, see data.edit.mentor for types and parameters.

modified

Time when this edit was last modified. Generally the current time.

author

String (initials) of the author of this edit. Generally “AUTO”.

notes

Notes about this edit.

Example Usage

data.edit.mentor.generate.spikefilter sgp 2008:10 2008:20