Previous topic

Module tracesDictOfTraces

Next topic

Module tracesTestParam

This Page

Generators of traces and their informations.

Module tracesGeneratorPath

traces.tracesGeneratorPath

Provide classes of generators in order to get the trace to be treated. This define a hierarchy of classes:

Inheritance diagram of generatorDatePathFileDictOfTraces, generatorDateDictOfTracesOneComponent, generatorPathSaveStationListFilesStationOneDay, generatorOneDatePathSaveStationListFilesStationOneDay, generatorArrayBeTreatFrequenceAndPathSave

An instance of the class generatorArrayBeTreatFrequenceAndPathSave provides a generator of all necessary informations for processing a trace and save it.

class traces.tracesGeneratorPath.generatorDatePathFileDictOfTraces(**kwargs)

A generator

Generate, for each date:

  • the date
  • the file path of the dictionary of traces.
Attributes :
PathDirDictsOfTraces: str

Defined in the module traces.tracesGetParam

PrefixNameFileDictsOfTraces: str

Defined in the module traces.tracesGetParam

class traces.tracesGeneratorPath.generatorDateDictOfTracesOneComponent(**kwargs)

A generator

Generate, for each date:

  • the date
  • the dictionary of traces for one component
Base class:

generatorDatePathFileDictOfTraces Inherits all attibutes of the base class.

Attributes :
ComponentStation: str

Defined in the module traces.tracesGetParam

class traces.tracesGeneratorPath.generatorPathSaveStationListFilesStationOneDay(**kwargs)

A generator

Generate, for each date and each station:

  • the date
  • the station
  • the path file to save the treatment
  • the list of couples (file, index of a trace in the file), i.e. all the pieces of trace for the date and the station.

Note

Base class:

generatorDateDictOfTracesOneComponent Inherits all attibutes of the base class.

Attributes :
ListOfStations: list

Defined in the module traces.tracesGetParam

class traces.tracesGeneratorPath.generatorOneDatePathSaveStationListFilesStationOneDay(**kwargs)

A generator

Base class:generatorPathSaveStationListFilesStationOneDay Inherits all attributes of the base class.

Filter the value of the generator generatorPathSaveStationListFilesStationOneDay. Yield the same value as the generator generatorPathSaveStationListFilesStationOneDay excepted yield None instead of the date if the date will be identical at the next generation.

See also the class traces.tracesUtil.LastNewValueGeneratorOfListIndex in the module doubletUtil use for filtering.

class traces.tracesGeneratorPath.generatorArrayBeTreatFrequenceAndPathSave(**kwargs)

A generator

Generate, for each date and each station:

  • the date
  • the trace to treated
  • the frequency of the sampling
  • the path file to save the treatment
Base class:

generatorOneDatePathSaveStationListFilesStationOneDay Inherits all attibutes of the base class.

Attributes :
station: str

The name of a station.

ListFileStationCompoOneDayWithIndex: list

The list of couples (file, index of the trace), all the pieces of trace for the date and the station.

Frequency: float

The frequency of the longest piece of trace among pieces of traces defined by ListFileStationCompoOneDayWithIndex.

TraceToTreated: numpy array

Contains all the pieces of the trace for a date and a station, otherwise the value is zero. There is also a time correction (induced by the difference between the startime and the sampling rate).

DurationTraceSave:int

Number of points of the array to treat.


Whisper project: FP7 ERC Advanced grant 227507 (WHISPER).
Codes are develop for the Whisper project (Seismic ambient noise).
If you use this code, specify it is provide by: Whisper project FP7 ERC Advanced grant 227507 (WHISPER).
Author: Xavier Briand. For questions, send email to xav.briand.whisper@gmail.com with subject begin exactly with [whisper].