Bds::Calibration Class Reference

This class defines a calibration setting. More...

#include <BdsD.h>

Inheritance diagram for Bds::Calibration:

Public Member Functions
	Calibration (BUInt32 id=0, BTimeStamp startTime=BTimeStamp(), BTimeStamp endTime=BTimeStamp(), BString network=BString(), BString station=BString(), BString channel=BString(), BString source=BString(), BString name=BString(), BFloat64 samplingFrequency=0, BFloat64 calibrationFrequency=0, BFloat64 calibrationFactor=0, BString calibrationUnits=BString(), BString calibrationUnitsDesc=BString(), BFloat64 rawCalibrationFrequency=0, BFloat64 rawCalibrationFactor=0, BString rawCalibrationUnits=BString(), BFloat64 depth=0, BFloat64 waterLevel=0, BFloat64 horizontalAngle=0, BFloat64 verticalAngle=0)
const char *	getType () const
BError	setMembers (BDictString &members)
BError	setMember (BString name, BString value)
BError	getMembers (BDictString &members)
BError	getMember (BString name, BString &value)
Public Member Functions inherited from BObj
	BObj ()
virtual	~BObj ()
virtual const char *	getType () const
virtual const BObjMember *	getMembers () const
virtual BError	getMembers (BDictString &members)
virtual BError	getMember (BString name, BString &value)
virtual BError	setMembers (BDictString &members)
virtual BError	setMember (BString name, BString value)
virtual void	membersPrint () const
virtual BString	getDebugString ()

Public Attributes
BUInt32	id
	The ID.
BTimeStamp	startTime
	The Start Time.
BTimeStamp	endTime
	The End Time.
BString	network
	The Network/Organisation Name.
BString	station
	The station.
BString	channel
	The channel.
BString	source
	The source.
BString	name
	The Calibrations name, "Main", "Measured".
BFloat64	samplingFrequency
	The sample rate used in Hz.
BFloat64	calibrationFrequency
	The post response compensation frequency that the CalibrationFactor value is valid for in Hz.
BFloat64	calibrationFactor
	The post response compensation scaling value to apply to the data to normalise data to the units. This is a measured value at the calibration frequency.
BString	calibrationUnits
	The post response compensation measurment SI units such as "m".
BString	calibrationUnitsDesc
	A description of the calibrationUnits.
BFloat64	rawCalibrationFrequency
	The raw data frequency that the CalibrationFactor value is valid for in Hz.
BFloat64	rawCalibrationFactor
	The raw data scaling value to apply to the data to normalise data to the units. This is a measured value at the calibration frequency.
BString	rawCalibrationUnits
	The raw data measurment SI units such as "m".
BFloat64	depth
	The depth of the sensor below ground level in meters.
BFloat64	waterLevel
	Elevation of the water surface in meters for underwater sites, where 0 is sea level.
BFloat64	horizontalAngle
	The Sensors channel placement horizontal angle in degrees clockwise from north.
BFloat64	verticalAngle
	The Sensors channel placement vertical angle in degrees degrees with zero = vertically up.

Detailed Description

This class defines a calibration setting.

Each channel has the core information of a samplingFrequency and a calibrationFactor (scaling factor) associated with it at a particular calibrationFrequency. The calibrationUnits defeines the units of the senor data after all of the Response frequency response's have been applied. Responses could add integration stages that will change the original senor dataors units to the given calibrationUnits. The raw* parameters, if given, are the raw sensor data's parameters before the Responses are applied. This is useful for simple raw data graph ploting etc. There may be additional calibration information such as the depth of the sensor and its positional angles.

Constructor & Destructor Documentation

Calibration()

Bds::Calibration::Calibration	(	BUInt32	id = 0,
		BTimeStamp	startTime = BTimeStamp(),
		BTimeStamp	endTime = BTimeStamp(),
		BString	network = BString(),
		BString	station = BString(),
		BString	channel = BString(),
		BString	source = BString(),
		BString	name = BString(),
		BFloat64	samplingFrequency = 0,
		BFloat64	calibrationFrequency = 0,
		BFloat64	calibrationFactor = 0,
		BString	calibrationUnits = BString(),
		BString	calibrationUnitsDesc = BString(),
		BFloat64	rawCalibrationFrequency = 0,
		BFloat64	rawCalibrationFactor = 0,
		BString	rawCalibrationUnits = BString(),
		BFloat64	depth = 0,
		BFloat64	waterLevel = 0,
		BFloat64	horizontalAngle = 0,
		BFloat64	verticalAngle = 0
	)

Member Function Documentation

getType()

const char * Bds::Calibration::getType ( ) const

virtual

Reimplemented from BObj.

setMembers()

BError Bds::Calibration::setMembers ( BDictString &  members )

virtual

Reimplemented from BObj.

setMember()

BError Bds::Calibration::setMember ( BString  name, BString  value  )

virtual

Reimplemented from BObj.

getMembers()

BError Bds::Calibration::getMembers ( BDictString &  members )

virtual

Reimplemented from BObj.

getMember()

BError Bds::Calibration::getMember ( BString  name, BString &  value  )

virtual

Reimplemented from BObj.

Member Data Documentation

id

BUInt32 Bds::Calibration::id

The ID.

startTime

BTimeStamp Bds::Calibration::startTime

The Start Time.

endTime

BTimeStamp Bds::Calibration::endTime

The End Time.

network

BString Bds::Calibration::network

The Network/Organisation Name.

station

BString Bds::Calibration::station

The station.

channel

BString Bds::Calibration::channel

The channel.

source

BString Bds::Calibration::source

The source.

name

BString Bds::Calibration::name

The Calibrations name, "Main", "Measured".

samplingFrequency

BFloat64 Bds::Calibration::samplingFrequency

The sample rate used in Hz.

calibrationFrequency

BFloat64 Bds::Calibration::calibrationFrequency

The post response compensation frequency that the CalibrationFactor value is valid for in Hz.

calibrationFactor

BFloat64 Bds::Calibration::calibrationFactor

The post response compensation scaling value to apply to the data to normalise data to the units. This is a measured value at the calibration frequency.

calibrationUnits

BString Bds::Calibration::calibrationUnits

The post response compensation measurment SI units such as "m".

calibrationUnitsDesc

BString Bds::Calibration::calibrationUnitsDesc

A description of the calibrationUnits.

rawCalibrationFrequency

BFloat64 Bds::Calibration::rawCalibrationFrequency

The raw data frequency that the CalibrationFactor value is valid for in Hz.

rawCalibrationFactor

BFloat64 Bds::Calibration::rawCalibrationFactor

The raw data scaling value to apply to the data to normalise data to the units. This is a measured value at the calibration frequency.

rawCalibrationUnits

BString Bds::Calibration::rawCalibrationUnits

The raw data measurment SI units such as "m".

depth

BFloat64 Bds::Calibration::depth

The depth of the sensor below ground level in meters.

waterLevel

BFloat64 Bds::Calibration::waterLevel

Elevation of the water surface in meters for underwater sites, where 0 is sea level.

horizontalAngle

BFloat64 Bds::Calibration::horizontalAngle

The Sensors channel placement horizontal angle in degrees clockwise from north.

verticalAngle

BFloat64 Bds::Calibration::verticalAngle

The Sensors channel placement vertical angle in degrees degrees with zero = vertically up.

---

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

• BdsD.h
• BdsD.cc