areaDetector  3-13
EPICS areaDetector framework
Classes | Macros | Typedefs | Enumerations
NDPluginROIStat.h File Reference
#include <epicsTypes.h>
#include "NDPluginDriver.h"

Go to the source code of this file.

Classes

struct  NDROI
 Structure defining a Region-Of-Interest and Stats. More...
 
class  NDPluginROIStat
 Compute statistics on ROIs in an array. More...
 

Macros

#define NDPluginROIStatFirstString   "ROISTAT_FIRST"
 See .cpp file for documentation. More...
 
#define NDPluginROIStatLastString   "ROISTAT_LAST"
 
#define NDPluginROIStatNameString   "ROISTAT_NAME" /* (asynOctet, r/w) Name of this ROI */
 
#define NDPluginROIStatResetAllString   "ROISTAT_RESETALL" /* (asynInt32, r/w) Reset ROI data for all ROIs. */
 
#define NDPluginROIStatUseString   "ROISTAT_USE" /* (asynInt32, r/w) Use this ROI? */
 
#define NDPluginROIStatResetString   "ROISTAT_RESET" /* (asynInt32, r/w) Reset ROI data. */
 
#define NDPluginROIStatBgdWidthString   "ROISTAT_BGD_WIDTH" /* (asynInt32, r/w) Width of background region when computing net */
 
#define NDPluginROIStatDim0MinString   "ROISTAT_DIM0_MIN" /* (asynInt32, r/w) Starting element of ROI in X dimension */
 
#define NDPluginROIStatDim0SizeString   "ROISTAT_DIM0_SIZE" /* (asynInt32, r/w) Size of ROI in X dimension */
 
#define NDPluginROIStatDim0MaxSizeString   "ROISTAT_DIM0_MAX_SIZE" /* (asynInt32, r/o) Maximum size of ROI in X dimension */
 
#define NDPluginROIStatDim1MinString   "ROISTAT_DIM1_MIN" /* (asynInt32, r/w) Starting element of ROI in Y dimension */
 
#define NDPluginROIStatDim1SizeString   "ROISTAT_DIM1_SIZE" /* (asynInt32, r/w) Size of ROI in Y dimension */
 
#define NDPluginROIStatDim1MaxSizeString   "ROISTAT_DIM1_MAX_SIZE" /* (asynInt32, r/o) Maximum size of ROI in Y dimension */
 
#define NDPluginROIStatDim2MinString   "ROISTAT_DIM2_MIN" /* (asynInt32, r/w) Starting element of ROI in Z dimension */
 
#define NDPluginROIStatDim2SizeString   "ROISTAT_DIM2_SIZE" /* (asynInt32, r/w) Size of ROI in Z dimension */
 
#define NDPluginROIStatDim2MaxSizeString   "ROISTAT_DIM2_MAX_SIZE" /* (asynInt32, r/o) Maximum size of ROI in Z dimension */
 
#define NDPluginROIStatMinValueString   "ROISTAT_MIN_VALUE" /* (asynFloat64, r/o) Minimum counts in any element */
 
#define NDPluginROIStatMaxValueString   "ROISTAT_MAX_VALUE" /* (asynFloat64, r/o) Maximum counts in any element */
 
#define NDPluginROIStatMeanValueString   "ROISTAT_MEAN_VALUE" /* (asynFloat64, r/o) Mean counts of all elements */
 
#define NDPluginROIStatTotalString   "ROISTAT_TOTAL" /* (asynFloat64, r/o) Sum of all elements */
 
#define NDPluginROIStatNetString   "ROISTAT_NET" /* (asynFloat64, r/o) Sum of all elements minus background */
 
#define NDPluginROIStatTSControlString   "ROISTAT_TS_CONTROL" /* (asynInt32, r/w) Erase/start, stop, start */
 
#define NDPluginROIStatTSNumPointsString   "ROISTAT_TS_NUM_POINTS" /* (asynInt32, r/w) Number of time series points to use */
 
#define NDPluginROIStatTSCurrentPointString   "ROISTAT_TS_CURRENT_POINT" /* (asynInt32, r/o) Current point in time series */
 
#define NDPluginROIStatTSAcquiringString   "ROISTAT_TS_ACQUIRING" /* (asynInt32, r/o) Acquiring time series */
 
#define NDPluginROIStatTSMinValueString   "ROISTAT_TS_MIN_VALUE" /* (asynFloat64Array, r/o) Series of minimum counts */
 
#define NDPluginROIStatTSMaxValueString   "ROISTAT_TS_MAX_VALUE" /* (asynFloat64Array, r/o) Series of maximum counts */
 
#define NDPluginROIStatTSMeanValueString   "ROISTAT_TS_MEAN_VALUE" /* (asynFloat64Array, r/o) Series of mean counts */
 
#define NDPluginROIStatTSTotalString   "ROISTAT_TS_TOTAL" /* (asynFloat64Array, r/o) Series of total */
 
#define NDPluginROIStatTSNetString   "ROISTAT_TS_NET" /* (asynFloat64Array, r/o) Series of net */
 
#define NDPluginROIStatTSTimestampString   "ROISTAT_TS_TIMESTAMP" /* (asynFloat64Array, r/o) Series of timestamps */
 
#define FIRST_NDPLUGIN_ROISTAT_PARAM   NDPluginROIStatFirst
 

Typedefs

typedef struct NDROI NDROI_t
 Structure defining a Region-Of-Interest and Stats. More...
 

Enumerations

enum  NDPluginROIStatTSType {
  TSMinValue , TSMaxValue , TSMeanValue , TSTotal ,
  TSNet , TSTimestamp , MAX_TIME_SERIES_TYPES
}
 
enum  NDPluginROIStatsTSControl_t {
  TSEraseStart , TSStart , TSStop , TSRead ,
  TSErase
}
 

Macro Definition Documentation

◆ FIRST_NDPLUGIN_ROISTAT_PARAM

#define FIRST_NDPLUGIN_ROISTAT_PARAM   NDPluginROIStatFirst

◆ NDPluginROIStatBgdWidthString

#define NDPluginROIStatBgdWidthString   "ROISTAT_BGD_WIDTH" /* (asynInt32, r/w) Width of background region when computing net */

◆ NDPluginROIStatDim0MaxSizeString

#define NDPluginROIStatDim0MaxSizeString   "ROISTAT_DIM0_MAX_SIZE" /* (asynInt32, r/o) Maximum size of ROI in X dimension */

◆ NDPluginROIStatDim0MinString

#define NDPluginROIStatDim0MinString   "ROISTAT_DIM0_MIN" /* (asynInt32, r/w) Starting element of ROI in X dimension */

◆ NDPluginROIStatDim0SizeString

#define NDPluginROIStatDim0SizeString   "ROISTAT_DIM0_SIZE" /* (asynInt32, r/w) Size of ROI in X dimension */

◆ NDPluginROIStatDim1MaxSizeString

#define NDPluginROIStatDim1MaxSizeString   "ROISTAT_DIM1_MAX_SIZE" /* (asynInt32, r/o) Maximum size of ROI in Y dimension */

◆ NDPluginROIStatDim1MinString

#define NDPluginROIStatDim1MinString   "ROISTAT_DIM1_MIN" /* (asynInt32, r/w) Starting element of ROI in Y dimension */

◆ NDPluginROIStatDim1SizeString

#define NDPluginROIStatDim1SizeString   "ROISTAT_DIM1_SIZE" /* (asynInt32, r/w) Size of ROI in Y dimension */

◆ NDPluginROIStatDim2MaxSizeString

#define NDPluginROIStatDim2MaxSizeString   "ROISTAT_DIM2_MAX_SIZE" /* (asynInt32, r/o) Maximum size of ROI in Z dimension */

◆ NDPluginROIStatDim2MinString

#define NDPluginROIStatDim2MinString   "ROISTAT_DIM2_MIN" /* (asynInt32, r/w) Starting element of ROI in Z dimension */

◆ NDPluginROIStatDim2SizeString

#define NDPluginROIStatDim2SizeString   "ROISTAT_DIM2_SIZE" /* (asynInt32, r/w) Size of ROI in Z dimension */

◆ NDPluginROIStatFirstString

#define NDPluginROIStatFirstString   "ROISTAT_FIRST"

See .cpp file for documentation.

◆ NDPluginROIStatLastString

#define NDPluginROIStatLastString   "ROISTAT_LAST"

◆ NDPluginROIStatMaxValueString

#define NDPluginROIStatMaxValueString   "ROISTAT_MAX_VALUE" /* (asynFloat64, r/o) Maximum counts in any element */

◆ NDPluginROIStatMeanValueString

#define NDPluginROIStatMeanValueString   "ROISTAT_MEAN_VALUE" /* (asynFloat64, r/o) Mean counts of all elements */

◆ NDPluginROIStatMinValueString

#define NDPluginROIStatMinValueString   "ROISTAT_MIN_VALUE" /* (asynFloat64, r/o) Minimum counts in any element */

◆ NDPluginROIStatNameString

#define NDPluginROIStatNameString   "ROISTAT_NAME" /* (asynOctet, r/w) Name of this ROI */

◆ NDPluginROIStatNetString

#define NDPluginROIStatNetString   "ROISTAT_NET" /* (asynFloat64, r/o) Sum of all elements minus background */

◆ NDPluginROIStatResetAllString

#define NDPluginROIStatResetAllString   "ROISTAT_RESETALL" /* (asynInt32, r/w) Reset ROI data for all ROIs. */

◆ NDPluginROIStatResetString

#define NDPluginROIStatResetString   "ROISTAT_RESET" /* (asynInt32, r/w) Reset ROI data. */

◆ NDPluginROIStatTotalString

#define NDPluginROIStatTotalString   "ROISTAT_TOTAL" /* (asynFloat64, r/o) Sum of all elements */

◆ NDPluginROIStatTSAcquiringString

#define NDPluginROIStatTSAcquiringString   "ROISTAT_TS_ACQUIRING" /* (asynInt32, r/o) Acquiring time series */

◆ NDPluginROIStatTSControlString

#define NDPluginROIStatTSControlString   "ROISTAT_TS_CONTROL" /* (asynInt32, r/w) Erase/start, stop, start */

◆ NDPluginROIStatTSCurrentPointString

#define NDPluginROIStatTSCurrentPointString   "ROISTAT_TS_CURRENT_POINT" /* (asynInt32, r/o) Current point in time series */

◆ NDPluginROIStatTSMaxValueString

#define NDPluginROIStatTSMaxValueString   "ROISTAT_TS_MAX_VALUE" /* (asynFloat64Array, r/o) Series of maximum counts */

◆ NDPluginROIStatTSMeanValueString

#define NDPluginROIStatTSMeanValueString   "ROISTAT_TS_MEAN_VALUE" /* (asynFloat64Array, r/o) Series of mean counts */

◆ NDPluginROIStatTSMinValueString

#define NDPluginROIStatTSMinValueString   "ROISTAT_TS_MIN_VALUE" /* (asynFloat64Array, r/o) Series of minimum counts */

◆ NDPluginROIStatTSNetString

#define NDPluginROIStatTSNetString   "ROISTAT_TS_NET" /* (asynFloat64Array, r/o) Series of net */

◆ NDPluginROIStatTSNumPointsString

#define NDPluginROIStatTSNumPointsString   "ROISTAT_TS_NUM_POINTS" /* (asynInt32, r/w) Number of time series points to use */

◆ NDPluginROIStatTSTimestampString

#define NDPluginROIStatTSTimestampString   "ROISTAT_TS_TIMESTAMP" /* (asynFloat64Array, r/o) Series of timestamps */

◆ NDPluginROIStatTSTotalString

#define NDPluginROIStatTSTotalString   "ROISTAT_TS_TOTAL" /* (asynFloat64Array, r/o) Series of total */

◆ NDPluginROIStatUseString

#define NDPluginROIStatUseString   "ROISTAT_USE" /* (asynInt32, r/w) Use this ROI? */

Typedef Documentation

◆ NDROI_t

typedef struct NDROI NDROI_t

Structure defining a Region-Of-Interest and Stats.

Enumeration Type Documentation

◆ NDPluginROIStatsTSControl_t

Enumerator
TSEraseStart 
TSStart 
TSStop 
TSRead 
TSErase 

◆ NDPluginROIStatTSType

Enumerator
TSMinValue 
TSMaxValue 
TSMeanValue 
TSTotal 
TSNet 
TSTimestamp 
MAX_TIME_SERIES_TYPES