File MIES_AnalysisFunctionPrototypes.ipf

AFP Analysis functions prototypes to be called during data acquisition

See also

MIES_AnalysisFunctions.ipf

Functions

variable AFP_ANALYSIS_FUNC_V1(string device, variable eventType, wave DAQDataWave, variable headStage)

Deprecated:

Use AFP_ANALYSIS_FUNC_V3() instead

Parameters:

  • device – device

  • eventType – eventType, one of EVENT_TYPE_ANALYSIS_FUNCTIONS, always compare eventType with the constants, never use the current numerical value directly

  • DAQDataWave – data wave (locked to prevent changes using SetWaveLock)

  • headStage – active headstage index

Returns:

ignored

variable AFP_ANALYSIS_FUNC_V2(string device, variable eventType, wave DAQDataWave, variable headStage, variable realDataLength)

Deprecated:

Use AFP_ANALYSIS_FUNC_V3() instead

Parameters:

  • device – device

  • eventType – eventType, one of EVENT_TYPE_ANALYSIS_FUNCTIONS, always compare eventType with the constants, never use the current numerical value directly

  • DAQDataWave – data wave (locked to prevent changes using SetWaveLock)

  • headStage – active headstage index

  • realDataLength – number of rows in DAQDataWave with data, the total number of rows in DAQDataWave might be higher due to alignment requirements of the data acquisition hardware. NaN for PRE_DAQ_EVENT events.

Returns:

see AnalysisFunction_V3DescriptionTable

variable AFP_ANALYSIS_FUNC_V3(string device, AnalysisFunction_V3 *s)
Parameters:

  • device – device

  • s – analysis event structure

Returns:

see AnalysisFunction_V3DescriptionTable

string AFP_PARAM_GETTER_V3()

Prototype function for the user supplied parameter getter functions.

string AFP_PARAM_HELP_GETTER_V3(string name)

Prototype function for the user supplied parameter help functions.

string AFP_PARAM_CHECK_V1(string name, string params)

Prototype function for the user supplied parameter check function (legacy signature)

string AFP_PARAM_CHECK_V2(string name, CheckParametersStruct *s)

Prototype function for the user supplied parameter check function.