BdsApi
2.2.6
This is the Blacknest BDS API.
|
This class defines a calibration setting. More...
#include <BdsD.h>
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(), BFloat64 depth=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) |
![]() | |
BObj () | |
virtual | ~BObj () |
virtual const char * | getType () const |
virtual const BObjMember * | getMembers () 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 frequency that the CalibrationFactor value is valid for in Hz. More... | |
BFloat64 | calibrationFactor |
The 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 measurment SI units such as "m". More... | |
BFloat64 | depth |
The depth of the sensor below ground level in meters. 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... | |
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.
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() , |
||
BFloat64 | depth = 0 , |
||
BFloat64 | horizontalAngle = 0 , |
||
BFloat64 | verticalAngle = 0 |
||
) |
Reimplemented from BObj.
|
virtual |
Reimplemented from BObj.
BString Bds::Calibration::getType | ( | ) |
|
virtual |
Reimplemented from BObj.
BFloat64 Bds::Calibration::calibrationFactor |
The scaling value to apply to the data to normalise data to the units. This is a measured value at the calibration frequency.
BFloat64 Bds::Calibration::calibrationFrequency |
The frequency that the CalibrationFactor value is valid for in Hz.
BString Bds::Calibration::calibrationUnits |
The measurment SI units such as "m".
BString Bds::Calibration::channel |
The channel.
BFloat64 Bds::Calibration::depth |
The depth of the sensor below ground level in meters.
BTimeStamp Bds::Calibration::endTime |
The End Time.
BFloat64 Bds::Calibration::horizontalAngle |
The Sensors channel placement horizontal angle in degrees clockwise from north.
BUInt32 Bds::Calibration::id |
The ID.
BString Bds::Calibration::name |
The Calibrations name, "Main", "Measured".
BString Bds::Calibration::network |
The Network/Organisation Name.
BFloat64 Bds::Calibration::samplingFrequency |
The sample rate used in Hz.
BString Bds::Calibration::source |
The source.
BTimeStamp Bds::Calibration::startTime |
The Start Time.
BString Bds::Calibration::station |
The station.
BFloat64 Bds::Calibration::verticalAngle |
The Sensors channel placement vertical angle in degrees degrees with zero = vertically up.