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