BdsApi  3.0.12
This is the Blacknest BDS API.
Public Member Functions | Public Attributes | List of all members
Bds::Calibration Class Reference

This class defines a calibration setting. More...

#include <BdsD.h>

Inheritance diagram for Bds::Calibration:
BObj

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)
 
BString getType ()
 
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 BObjMembergetMembers () const
 
virtual void membersPrint () const
 
virtual BString getDebugString ()
 

Public Attributes

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

Detailed Description

This class defines a calibration setting.

Each channel has a samplingFrequency and a calibrationFactor (scaling factor) associated with it at a particular calibrationFrequency. 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

◆ getMember()

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

Reimplemented from BObj.

◆ getMembers()

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

Reimplemented from BObj.

◆ getType()

BString Bds::Calibration::getType ( )

◆ setMember()

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

Reimplemented from BObj.

◆ setMembers()

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

Reimplemented from BObj.

Member Data Documentation

◆ 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.

◆ calibrationFrequency

BFloat64 Bds::Calibration::calibrationFrequency

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

◆ 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.

◆ channel

BString Bds::Calibration::channel

The channel.

◆ depth

BFloat64 Bds::Calibration::depth

The depth of the sensor below ground level in meters.

◆ endTime

BTimeStamp Bds::Calibration::endTime

The End Time.

◆ horizontalAngle

BFloat64 Bds::Calibration::horizontalAngle

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

◆ id

BUInt32 Bds::Calibration::id

The ID.

◆ name

BString Bds::Calibration::name

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

◆ network

BString Bds::Calibration::network

The Network/Organisation Name.

◆ 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.

◆ rawCalibrationFrequency

BFloat64 Bds::Calibration::rawCalibrationFrequency

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

◆ rawCalibrationUnits

BString Bds::Calibration::rawCalibrationUnits

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

◆ samplingFrequency

BFloat64 Bds::Calibration::samplingFrequency

The sample rate used in Hz.

◆ source

BString Bds::Calibration::source

The source.

◆ startTime

BTimeStamp Bds::Calibration::startTime

The Start Time.

◆ station

BString Bds::Calibration::station

The station.

◆ verticalAngle

BFloat64 Bds::Calibration::verticalAngle

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

◆ waterLevel

BFloat64 Bds::Calibration::waterLevel

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


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