This class defines a seismic Response characteristic. More...

#include <BdsD.h>

Inheritance diagram for Bds::Response:

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.

BTimeStamp	startTime
	The start time when ret response is valid from.

BTimeStamp	endTime
	The end time the response is valid to.

BString	network
	The Network/Organisation Name.

BString	station
	The station.

BString	channel
	The channel.

BString	source
	The source.

BUInt32	stage
	The stage (0, 1, 2, 3, ...). 0 is a special overall response sometimes used.

BString	name
	The response name. (Anti-Aliasing filter, Digitiser, post filter etc)

BString	type
	The type of response (PoleZero, FIR, FAP, Polynomial or blank if no frequency response)

PoleZero	poleZeros
	The PoleZeros.

BArray< Fap >	faps
	The FAP Frequency/Amplitude/Phase table.

Fir	fir
	The FIR filters coefficients.

Polynomial	polynomial
	The polynomial response.

BFloat64	gain
	Overall gain at gainFrequency.

BFloat64	gainFrequency
	Frequency that gain is valid for.

BString	stageType
	The stage type: A - Analog (rad/sec), B - Analog (Hz), C - Composite, D - Digital.

BFloat64	decimation
	Decimation factor performed post filter.

BFloat64	decimationOffset
	Decimation sample offset.

BFloat64	decimationDelay
	Decimation delay in seconds.

BFloat64	decimationCorr
	Decimation correction performed.

BString	symmetry
	Symmetry for FIR coefficients (A = asymmetric, B = symmetric[odd], C = symmetric[even])

BString	description
	Misc description.

BInt32	measured
	Boolean if response was a measured response.

BFloat64	sampleRate
	The stage's sample rate.

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.

BString	inputUnitsDesc
	The input units description.

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.

BString	outputUnitsDesc
	The output units description.

Detailed Description

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.

Constructor & Destructor Documentation

◆ Response()

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()`
	)

Member Data Documentation

◆ id

BUInt32 Bds::Response::id

The ID.

◆ startTime

BTimeStamp Bds::Response::startTime

The start time when ret response is valid from.

◆ endTime

BTimeStamp Bds::Response::endTime

The end time the response is valid to.

◆ network

BString Bds::Response::network

The Network/Organisation Name.

◆ station

BString Bds::Response::station

The station.

◆ channel

BString Bds::Response::channel

The channel.

◆ source

BString Bds::Response::source

The source.

◆ stage

BUInt32 Bds::Response::stage

The stage (0, 1, 2, 3, ...). 0 is a special overall response sometimes used.

◆ name

BString Bds::Response::name

The response name. (Anti-Aliasing filter, Digitiser, post filter etc)

◆ type

BString Bds::Response::type

The type of response (PoleZero, FIR, FAP, Polynomial or blank if no frequency response)

◆ poleZeros

PoleZero Bds::Response::poleZeros

The PoleZeros.

◆ faps

BArray<Fap > Bds::Response::faps

The FAP Frequency/Amplitude/Phase table.

◆ fir

Fir Bds::Response::fir

The FIR filters coefficients.

◆ polynomial

Polynomial Bds::Response::polynomial

The polynomial response.

◆ gain

BFloat64 Bds::Response::gain

Overall gain at gainFrequency.

◆ gainFrequency

BFloat64 Bds::Response::gainFrequency

Frequency that gain is valid for.

◆ stageType

BString Bds::Response::stageType

The stage type: A - Analog (rad/sec), B - Analog (Hz), C - Composite, D - Digital.

◆ decimation

BFloat64 Bds::Response::decimation

Decimation factor performed post filter.

◆ decimationOffset

BFloat64 Bds::Response::decimationOffset

Decimation sample offset.

◆ decimationDelay

BFloat64 Bds::Response::decimationDelay

Decimation delay in seconds.

◆ decimationCorr

BFloat64 Bds::Response::decimationCorr

Decimation correction performed.

◆ symmetry

BString Bds::Response::symmetry

Symmetry for FIR coefficients (A = asymmetric, B = symmetric[odd], C = symmetric[even])

◆ description

BString Bds::Response::description

Misc description.

◆ measured

BInt32 Bds::Response::measured

Boolean if response was a measured response.

◆ sampleRate

BFloat64 Bds::Response::sampleRate

The stage's sample rate.

◆ inputUnits

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.

◆ inputUnitsDesc

BString Bds::Response::inputUnitsDesc

The input units description.

◆ outputUnits

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.

◆ outputUnitsDesc

BString Bds::Response::outputUnitsDesc

The output units description.

The documentation for this class was generated from the following files:

Account

Public Member Functions

Public Attributes