Package for processing traces from a directory.

Package traces

traces.tracesMain	Main functionality: provide a processing of traces.
traces.tracesParam	Parameters for the package.
traces.tracesGetParam	Get the parameters.
traces.tracesDictOfTraces	Make the dictionaries of traces before processing.
traces.tracesGeneratorPath	Generators of traces and their informations.
traces.tracesTestParam	Test the validity of parameters.
traces.tracesTreatment	General methods for the processing.
traces.tracesDefineTreatments	Define the treatment of the traces.
traces.tracesFunctions	Provides some functions for the processing of traces.
traces.tracesWriter	Classes and methods to save the traces.
traces.tracesUtil	Some tools for the package.
traces.tracesExceptions	Classes of exceptions for the package.

Overview of the Package traces

General workflow

The package traces provides some tools in order to extract traces from a directory and treat them:

General specification

Given:

• A ‘LoadDirectory’.
• A component.
• A set of stations.
• A set of dates.
• A new sampling rate.
• A ‘SaveDirectory’.

Make:

1. Extract all the traces from the ‘LoadDirectory’ whose correspond to the component, the set of dates and the set of stations.
2. For each station and each day, built a trace whose duration is one day by agglomerating the stub of traces (If values are not defined, they are replaced by zero).
3. Make the treatment of the day-traces before resampling (should be defined by the users).
4. Make the resampling of the day-traces.
5. Make the treatment of the day-traces after resampling (should be defined by the users).
6. Save the day-traces in the ‘SaveDirectory’ with architecture: SaveDirectory -> Component -> Year -> Day -> Station.

Optional functionality:

Before processing the traces, for each day, dictionaries (python type) are made (serialize with cPickle) and contains all necessary metadatas (station, starttime, frequency, component, etc..) for all the traces for ordering and make the processing.

If this operation have been already done, you can skip it by setting to False of a boolean parameter in the module traces.tracesParam.

Note

Very useful if only the treatment is changed.

Main restrictions of the specification

• Traces durations: Take only account traces whose duration is less than a day. For example, if a trace have a duration of 2 days, only the first day is take account.
• Traces date: The day associated to a trace is the day corresponding to the second sampling of the trace.
• Traces frequencies: If, for a given day and a given station, there are traces with différents frequencies, keep only the traces that have the same frequency as the longest traces (the longest duration).
• Traces overlapping: If, for a given day and a given station, two traces are overlapping, take trace with the oldest starttime for the overlapping section.

General architecture

Architecture of modules (prefix “traces” is omitted):

• CHANGE the modules traces.tracesParam and traces.tracesDefineTreatments in order to set the parameters and define personalized treatments.
• LAUNCH with python the module traces.tracesMain for processing a set of traces in a directory.
• ADD new treatements in the module traces.tracesFunctions and then provides new functionalities for the module traces.tracesDefineTreatments.
• REQUIRE python2.7, numpy, scipy (scientific libraries) and obspy (seismology library).

See also the tutorial