RBRInstrumentPostprocessing Struct Reference

The instrument post-processing configuration. More...

#include <RBRInstrumentMemory.h>

Collaboration diagram for RBRInstrumentPostprocessing:

Data Fields
RBRInstrumentPostprocessingStatus	status
	The current state of the instrument's post-processing function. More...
RBRInstrumentPostprocessingChannelsList	channels
	Post-processing statistics channel configurations. More...
char	binReference [RBRINSTRUMENT_CHANNEL_LABEL_MAX+1]
	The reference channel for binning. More...
RBRInstrumentPostprocessingBinFilter	binFilter
	How data should be filtered before binning.
float	binSize
	The size of each bin. More...
RBRInstrumentDateTime	tstampMin
	The minimum timestamp value. More...
RBRInstrumentDateTime	tstampMax
	The maximum timestamp value. More...
float	depthMin
	The minimum depth value. More...
float	depthMax
	The maximum depth value. More...
float	dcAlpha
	(dynamic correction) Alpha parameter from Lueck and Picklo equation More...
float	dcTau
	(dynamic correction) Tau parameter from Lueck and Picklo equation (1/beta) More...
float	dcTdelay
	(dynamic correction) Parameter for the time lag correction between marine temperature and conductivity cell temperature More...
float	dcCtCoeff
	(dynamic correction) Parameter for the long term thermal coefficient for the conductivity cell More...

Detailed Description

The instrument post-processing configuration.

See also

RBRInstrument_getPostprocessing()

RBRInstrument_setPostprocessing()

https://docs.rbr-global.com/L3commandreference/commands/memory-and-data-retrieval/postprocessing

Field Documentation

binReference

char RBRInstrumentPostprocessing::binReference[RBRINSTRUMENT_CHANNEL_LABEL_MAX+1]

The reference channel for binning.

If the reference is set to the keyword tstamp, the generated data will be binned by time. Otherwise, if the reference is set to the channel label of a pressure or sea pressure channel, the generated data is binned by depth.

binSize

float RBRInstrumentPostprocessing::binSize

The size of each bin.

When binning by time: specified in milliseconds, with a precision of milliseconds.

When binning by depth: specified in decibars, with a minimum precision of 0.1 dbar.

The bin size can always be set to 0, in which case, no binning is performed.

The bin size may never be negative.

channels

RBRInstrumentPostprocessingChannelsList RBRInstrumentPostprocessing::channels

Post-processing statistics channel configurations.

Functions which receive an RBRInstrumentPostprocessing instance will expect the first RBRInstrumentPostprocessingChannelList.count entries to be populated, and functions which return a RBRInstrumentPostprocessing instance will similarly indicate how many entries are populated.

dcAlpha

float RBRInstrumentPostprocessing::dcAlpha

(dynamic correction) Alpha parameter from Lueck and Picklo equation

Coefficient is unitless (default 0.08)

This parameter is ignored when no dynamic correction channel are selected

dcCtCoeff

float RBRInstrumentPostprocessing::dcCtCoeff

(dynamic correction) Parameter for the long term thermal coefficient for the conductivity cell

Coefficient is in 1/celcius (default 2.4e-4)

This parameter is ignored when no dynamic correction channel are selected

dcTau

float RBRInstrumentPostprocessing::dcTau

(dynamic correction) Tau parameter from Lueck and Picklo equation (1/beta)

Coefficient is unitless (default 8.000)

This parameter is ignored when no dynamic correction channel are selected

dcTdelay

float RBRInstrumentPostprocessing::dcTdelay

(dynamic correction) Parameter for the time lag correction between marine temperature and conductivity cell temperature

Coefficient is in second (default 0.35)

This parameter is ignored when no dynamic correction channel are selected

depthMax

float RBRInstrumentPostprocessing::depthMax

The maximum depth value.

Specified in decibar with a minimum precision of 0.1 dbar.

This parameter is ignored when binning by time.

When binning by depth, all samples with a greater depth are excluded from post-processing input; and if the bin filter is set to RBRINSTRUMENT_POSTPROCESSING_BINFILTER_DESCENTONLY, this serves as the binning origin point.

depthMin

float RBRInstrumentPostprocessing::depthMin

The minimum depth value.

Specified in decibar with a minimum precision of 0.1 dbar.

This parameter is ignored when binning by time.

When binning by depth, all samples with a lesser depth are excluded from post-processing input; and unless the bin filter is set to RBRINSTRUMENT_POSTPROCESSING_BINFILTER_ASCENTONLY, this serves as the binning origin point.

status

RBRInstrumentPostprocessingStatus RBRInstrumentPostprocessing::status

The current state of the instrument's post-processing function.

The corresponding instrument parameter is read-only. This member is used only when reading parameters from the instrument; its value is ignored when sending parameters to the instrument.

tstampMax

RBRInstrumentDateTime RBRInstrumentPostprocessing::tstampMax

The maximum timestamp value.

All samples with a later timestamp are excluded from post-processing input.

tstampMin

RBRInstrumentDateTime RBRInstrumentPostprocessing::tstampMin

The minimum timestamp value.

All samples with an earlier timestamp are excluded from post-processing input. If time binning is used, this serves as the binning origin point.

---

The documentation for this struct was generated from the following file:

• include/RBRInstrumentMemory.h