int MX370x__TransducerSetOffset ( struct MSXE370x__doubleArrayParam pdOffsetArray,
xsd__unsignedLong  ulOption1,
xsd__unsignedLong  ulOption2,
xsd__unsignedLong  ulOption3,
xsd__unsignedLong  ulOption4,
struct MX370x__Response Response 
)


This function permits to set an offset (reference point) to the measured value.

To disable (reset) a channel offset, set the corresponding channel value to 0.0.

Example: To set a reference point to a transducer in a particular position:

  • Reset the offset by setting all channel offset to 0 (pdOffsetArray).
  • Run a sequence with the transducer at the position you want to be 0 (reference point). Save the acquired values to put them into pdOffsetArray.
  • Stop the acquisition.
  • Run MX370x__TransducerSetOffset function to set the offset with the pdOffsetArray previously saved.
  • In the next sequence, position will be 0.

Remark : This function cannot be used when an acquisition is running

For more information see SetOffset sample.

Parameters:
[in] pdOffsetArray : array with each offsets for transducers (channel 0 to channel 15)
[in] ulOption1 : Reserved
[in] ulOption2 : Reserved
[in] ulOption3 : Reserved
[in] ulOption4 : Reserved
[out] Response :
iReturnValue : Error value

  • 0: success
  • -1: means an system error occurred
  • -2: driver status error, acquisition is running
  • -100: transducerSetOffset kernel function error
  • <> 0: error
Returns:
  • 0: SOAP_OK
  • <> 0: See SOAP error