BdsApi 3.1.4
This is the Blacknest BDS API.
|
This class defines a seismic Response characteristic. More...
#include <BdsD.h>
Public Member Functions | |
Response (BUInt32 id=0, BTimeStamp startTime=BTimeStamp(), BTimeStamp endTime=BTimeStamp(), BString network=BString(), BString station=BString(), BString channel=BString(), BString source=BString(), BUInt32 stage=0, BString name=BString(), BString type=BString(), PoleZero poleZeros=PoleZero(), BArray< Fap > faps=BArray< Fap >(), Fir fir=Fir(), Polynomial polynomial=Polynomial(), BFloat64 gain=0, BFloat64 gainFrequency=0, BString stageType=BString(), BFloat64 decimation=0, BFloat64 decimationOffset=0, BFloat64 decimationDelay=0, BFloat64 decimationCorr=0, BString symmetry=BString(), BString description=BString(), BInt32 measured=0, BFloat64 sampleRate=0, BString inputUnits=BString(), BString inputUnitsDesc=BString(), BString outputUnits=BString(), BString outputUnitsDesc=BString()) | |
Public Attributes | |
BUInt32 | id |
The ID. More... | |
BTimeStamp | startTime |
The start time when ret response is valid from. More... | |
BTimeStamp | endTime |
The end time the response is valid to. More... | |
BString | network |
The Network/Organisation Name. More... | |
BString | station |
The station. More... | |
BString | channel |
The channel. More... | |
BString | source |
The source. More... | |
BUInt32 | stage |
The stage (0, 1, 2, 3, ...). 0 is a special overall response sometimes used. More... | |
BString | name |
The response name. (Anti-Aliasing filter, Digitiser, post filter etc) More... | |
BString | type |
The type of response (PoleZero, FIR, FAP, Polynomial or blank if no frequency response) More... | |
PoleZero | poleZeros |
The PoleZeros. More... | |
BArray< Fap > | faps |
The FAP Frequency/Amplitude/Phase table. More... | |
Fir | fir |
The FIR filters coefficients. More... | |
Polynomial | polynomial |
The polynomial response. More... | |
BFloat64 | gain |
Overall gain at gainFrequency. More... | |
BFloat64 | gainFrequency |
Frequency that gain is valid for. More... | |
BString | stageType |
The stage type: A - Analog (rad/sec), B - Analog (Hz), C - Composite, D - Digital. More... | |
BFloat64 | decimation |
Decimation factor performed post filter. More... | |
BFloat64 | decimationOffset |
Decimation sample offset. More... | |
BFloat64 | decimationDelay |
Decimation delay in seconds. More... | |
BFloat64 | decimationCorr |
Decimation correction performed. More... | |
BString | symmetry |
Symmetry for FIR coefficients (A = asymmetric, B = symmetric[odd], C = symmetric[even]) More... | |
BString | description |
Misc description. More... | |
BInt32 | measured |
Boolean if response was a measured response. More... | |
BFloat64 | sampleRate |
The stage's sample rate. More... | |
BString | inputUnits |
The units of the data as input from the perspective of data acquisition. After correcting data for this response, these would be the resulting units. More... | |
BString | inputUnitsDesc |
The input units description. More... | |
BString | outputUnits |
The units of the data as output from the perspective of data acquisition. These would be the units of the data prior to correcting for this response. More... | |
BString | outputUnitsDesc |
The output units description. More... | |
This class defines a seismic Response characteristic.
For each seismic channel there is a frequency response characteristic. There can be multiple stages in a channels frequency response, this response data describes one of those stages frequencies responses. The stage parameter defines which stage it is for (1, 2, 3, ...) Stage 0 is reserved to store an overall channel response for special puposes. A response can be in the form of an array of poles and zeros, a FAP array, a set of FIR coefficients or a Polynomial. This object contains Metadata for other responce characteristics as defined in various seismic Response formats. In general this extra Metadata is simply passed through the BDS and is used when exporting Metadat in different formats. Note that the actual response data is stored in a database Blob and the poleZeros, faps, fir or polynomial fields are filled in based upon the Response type.
Bds::Response::Response | ( | BUInt32 | id = 0 , |
BTimeStamp | startTime = BTimeStamp() , |
||
BTimeStamp | endTime = BTimeStamp() , |
||
BString | network = BString() , |
||
BString | station = BString() , |
||
BString | channel = BString() , |
||
BString | source = BString() , |
||
BUInt32 | stage = 0 , |
||
BString | name = BString() , |
||
BString | type = BString() , |
||
PoleZero | poleZeros = PoleZero() , |
||
BArray< Fap > | faps = BArray<Fap >() , |
||
Fir | fir = Fir() , |
||
Polynomial | polynomial = Polynomial() , |
||
BFloat64 | gain = 0 , |
||
BFloat64 | gainFrequency = 0 , |
||
BString | stageType = BString() , |
||
BFloat64 | decimation = 0 , |
||
BFloat64 | decimationOffset = 0 , |
||
BFloat64 | decimationDelay = 0 , |
||
BFloat64 | decimationCorr = 0 , |
||
BString | symmetry = BString() , |
||
BString | description = BString() , |
||
BInt32 | measured = 0 , |
||
BFloat64 | sampleRate = 0 , |
||
BString | inputUnits = BString() , |
||
BString | inputUnitsDesc = BString() , |
||
BString | outputUnits = BString() , |
||
BString | outputUnitsDesc = BString() |
||
) |
BUInt32 Bds::Response::id |
The ID.
BTimeStamp Bds::Response::startTime |
The start time when ret response is valid from.
BTimeStamp Bds::Response::endTime |
The end time the response is valid to.
BString Bds::Response::network |
The Network/Organisation Name.
BString Bds::Response::station |
The station.
BString Bds::Response::channel |
The channel.
BString Bds::Response::source |
The source.
BUInt32 Bds::Response::stage |
The stage (0, 1, 2, 3, ...). 0 is a special overall response sometimes used.
BString Bds::Response::type |
The type of response (PoleZero, FIR, FAP, Polynomial or blank if no frequency response)
PoleZero Bds::Response::poleZeros |
The PoleZeros.
Fir Bds::Response::fir |
The FIR filters coefficients.
Polynomial Bds::Response::polynomial |
The polynomial response.
BFloat64 Bds::Response::gain |
Overall gain at gainFrequency.
BFloat64 Bds::Response::gainFrequency |
Frequency that gain is valid for.
BString Bds::Response::stageType |
The stage type: A - Analog (rad/sec), B - Analog (Hz), C - Composite, D - Digital.
BFloat64 Bds::Response::decimation |
Decimation factor performed post filter.
BFloat64 Bds::Response::decimationOffset |
Decimation sample offset.
BFloat64 Bds::Response::decimationDelay |
Decimation delay in seconds.
BFloat64 Bds::Response::decimationCorr |
Decimation correction performed.
BString Bds::Response::symmetry |
Symmetry for FIR coefficients (A = asymmetric, B = symmetric[odd], C = symmetric[even])
BString Bds::Response::description |
Misc description.
BInt32 Bds::Response::measured |
Boolean if response was a measured response.
BFloat64 Bds::Response::sampleRate |
The stage's sample rate.
BString Bds::Response::inputUnits |
The units of the data as input from the perspective of data acquisition. After correcting data for this response, these would be the resulting units.
BString Bds::Response::inputUnitsDesc |
The input units description.
BString Bds::Response::outputUnits |
The units of the data as output from the perspective of data acquisition. These would be the units of the data prior to correcting for this response.
BString Bds::Response::outputUnitsDesc |
The output units description.