#include <FrAdcDataNPS.hh>
|
template<typename DescriptionType , typename FrSEType > |
static void | structDescription (DescriptionType &Desc) |
|
◆ bias_type
◆ channelGroup_type
◆ channelNumber_type
◆ comment_type
◆ dataValid_type
◆ fShift_type
◆ name_type
◆ nBits_type
◆ sampleRate_type
◆ slope_type
◆ timeOffsetN_type
◆ timeOffsetS_type
◆ units_type
◆ FrAdcDataNPS() [1/3]
FrAdcDataNPS::FrAdcDataNPS |
( |
| ) |
|
|
protected |
◆ FrAdcDataNPS() [2/3]
◆ FrAdcDataNPS() [3/3]
FrAdcDataNPS::FrAdcDataNPS |
( |
const Previous::FrAdcData & |
Source, |
|
|
Common::IStream * |
Stream |
|
) |
| |
|
protected |
◆ AppendComment()
void FrAdcDataNPS::AppendComment |
( |
const std::string & |
comment | ) |
|
|
inline |
Extend the comment associated with the FrAdcData structure.
◆ bytes()
Number of bytes needed to write this structure.
- Parameters
-
[in] | Stream | The stream from which to the object is being read or written. |
- Returns
- The number of bytes need to read or write this object.
◆ GetBias()
DC bias on channel.
- Returns
- DC bias on channel.
◆ GetChannelGroup()
◆ GetChannelNumber()
◆ GetComment()
const std::string & FrAdcDataNPS::GetComment |
( |
| ) |
const |
|
inline |
A brief description of the FrAdcData structure.
- Returns
- A brief description of the FrAdcData structure
◆ GetDataValid()
INT_2U FrAdcDataNPS::GetDataValid |
( |
| ) |
const |
|
inline |
Retrieve the overRange value.
- Returns
- The value of the overRange field.
◆ GetFShift()
The frequency in the original data corresponding to 0 Hz.
- Returns
- The frequency in the original data corresponding to 0 Hz.
◆ GetName()
const std::string & FrAdcDataNPS::GetName |
( |
| ) |
const |
Return the name associate with the FrAdcData structure.
- Returns
- The name associated with the FrAdcData structure
◆ GetNBits()
Tne number of bits in the A/D output.
- Returns
- Tne number of bits in the A/D output.
◆ GetSampleRate()
The data acquisition rate.
- Returns
- The data acquisition rate.
◆ GetSlope()
ADC calibration units per count.
- Returns
- ADC calibration units per count.
◆ GetTimeOffsetN()
The offset of the first sample relative to the frame start time.
- Returns
- The offset of the first sample relative to the frame start time.
◆ GetTimeOffsetS()
The offset of the first sample relative to the frame start time.
- Returns
- The offset of the first sample relative to the frame start time.
◆ GetUnits()
STRING FrAdcDataNPS::GetUnits |
( |
| ) |
const |
|
inline |
The units used in the ADC calibration.
- Returns
- The units used in the ADC calibration
◆ operator==()
bool FrAdcDataNPS::operator== |
( |
const FrAdcDataNPS & |
RHS | ) |
const |
|
inlineprotected |
◆ SetBias()
void FrAdcDataNPS::SetBias |
( |
REAL_4 |
Value | ) |
|
|
inline |
Establish the value of the bias field.
- Parameters
-
[in] | Value | The desired value of the bias field. |
◆ SetDataValid()
void FrAdcDataNPS::SetDataValid |
( |
INT_2U |
flag | ) |
|
|
inline |
Establish the value of the dataValid field.
- Parameters
-
[in] | flag | The desired value of the overRange field. |
◆ SetSlope()
void FrAdcDataNPS::SetSlope |
( |
REAL_4 |
Value | ) |
|
|
inline |
Establish the value of the slope field.
- Parameters
-
[in] | Value | The desired value of the slope field. |
◆ SetTimeOffset()
void FrAdcDataNPS::SetTimeOffset |
( |
INT_4U |
Seconds, |
|
|
INT_4U |
Nanoseconds |
|
) |
| |
|
inline |
Establish the value of the timeOffset field.
- Parameters
-
[in] | Seconds | The value for the timeOffsetS field. |
[in] | Nanoseconds | The value for the timeOffsetN field. |
◆ structDescription()
template<typename DescriptionType , typename FrSEType >
void FrAdcDataNPS::structDescription |
( |
DescriptionType & |
Desc | ) |
|
|
inlinestaticprotected |
◆ write()
void FrameCPP::Version_4::FrAdcDataNPS::write |
( |
Common::OStream & |
Stream | ) |
const |
|
protected |
Write contents to the stream.
◆ bias
bias_type FrameCPP::Version_4::FrAdcDataNPS::bias |
|
protected |
DC bias on channel (Units @ ADC counts = 0)
◆ channelGroup
Channel grouping number containing ADC.
- Note
- This variable is determined by the site and must be unique over all detectors.
◆ channelNumber
Channel number
- Note
- This variable is determined by the site and must be unique over all detectors.
◆ comment
◆ dataValid
Data valid flag
- Note
- dataValid = 0 -> ADC ddata valid; dataValid != 0 -> ADC data suspect/not valid
◆ DEFAULT_BIAS
◆ DEFAULT_DATA_VALID
◆ DEFAULT_FSHIFT
◆ DEFAULT_SLOPE
◆ DEFAULT_TIME_OFFSET_N
◆ DEFAULT_TIME_OFFSET_S
◆ fShift
The frequency (in HZ) in the original data that corresponds to zero Hz in the heterodyned series.
- Note
- In the heterodyning process the real time series in multiplied by cos[2pi fShift(t-to) + phase] to get the real part and by -sin[2pi fShift(t-t(0)) + phase] to get the imaginary part of the resulting complex time series. The time origin t(0) is the beginning of the frame.
◆ name
name_type FrameCPP::Version_4::FrAdcDataNPS::name |
|
protected |
Channel name – must be unique with the frame.
◆ nBits
nBits_type FrameCPP::Version_4::FrAdcDataNPS::nBits |
|
protected |
Number of bits in A/D output.
◆ sampleRate
Data acquisition rate, samples per second.
◆ slope
slope_type FrameCPP::Version_4::FrAdcDataNPS::slope |
|
protected |
ADC calibration: input units/count.
◆ timeOffsetN
For Triggered data lasting less than one frame, integer residual nanoseconds start time relative to frame start
◆ timeOffsetS
For Triggered data lasting less than one frame, integer seconds start time relative to frame start
◆ units
units_type FrameCPP::Version_4::FrAdcDataNPS::units |
|
protected |
ADC calibration: input units for slope If dimensionless, then units == <NONE>, in CAPITALS (without <...>).
The documentation for this class was generated from the following files: