areaDetector  3-13
EPICS areaDetector framework
Classes | Macros
NDPluginROI.h File Reference
#include "NDPluginDriver.h"

Go to the source code of this file.

Classes

class  NDPluginROI
 Extract Regions-Of-Interest (ROI) from NDArray data; the plugin can be a source of NDArray callbacks for other plugins, passing these sub-arrays. More...
 

Macros

#define NDPluginROINameString   "NAME" /* (asynOctet, r/w) Name of this ROI */
 
#define NDPluginROIDim0MinString   "DIM0_MIN" /* (asynInt32, r/w) Starting element of ROI in each dimension */
 
#define NDPluginROIDim1MinString   "DIM1_MIN" /* (asynInt32, r/w) Starting element of ROI in each dimension */
 
#define NDPluginROIDim2MinString   "DIM2_MIN" /* (asynInt32, r/w) Starting element of ROI in each dimension */
 
#define NDPluginROIDim0SizeString   "DIM0_SIZE" /* (asynInt32, r/w) Size of ROI in each dimension */
 
#define NDPluginROIDim1SizeString   "DIM1_SIZE" /* (asynInt32, r/w) Size of ROI in each dimension */
 
#define NDPluginROIDim2SizeString   "DIM2_SIZE" /* (asynInt32, r/w) Size of ROI in each dimension */
 
#define NDPluginROIDim0MaxSizeString   "DIM0_MAX_SIZE" /* (asynInt32, r/o) Maximum size of ROI in each dimension */
 
#define NDPluginROIDim1MaxSizeString   "DIM1_MAX_SIZE" /* (asynInt32, r/o) Maximum size of ROI in each dimension */
 
#define NDPluginROIDim2MaxSizeString   "DIM2_MAX_SIZE" /* (asynInt32, r/o) Maximum size of ROI in each dimension */
 
#define NDPluginROIDim0BinString   "DIM0_BIN" /* (asynInt32, r/w) Binning of ROI in each dimension */
 
#define NDPluginROIDim1BinString   "DIM1_BIN" /* (asynInt32, r/w) Binning of ROI in each dimension */
 
#define NDPluginROIDim2BinString   "DIM2_BIN" /* (asynInt32, r/w) Binning of ROI in each dimension */
 
#define NDPluginROIDim0ReverseString   "DIM0_REVERSE" /* (asynInt32, r/w) Reversal of ROI in each dimension */
 
#define NDPluginROIDim1ReverseString   "DIM1_REVERSE" /* (asynInt32, r/w) Reversal of ROI in each dimension */
 
#define NDPluginROIDim2ReverseString   "DIM2_REVERSE" /* (asynInt32, r/w) Reversal of ROI in each dimension */
 
#define NDPluginROIDim0EnableString   "DIM0_ENABLE" /* (asynInt32, r/w) If set then do ROI in this dimension */
 
#define NDPluginROIDim1EnableString   "DIM1_ENABLE" /* (asynInt32, r/w) If set then do ROI in this dimension */
 
#define NDPluginROIDim2EnableString   "DIM2_ENABLE" /* (asynInt32, r/w) If set then do ROI in this dimension */
 
#define NDPluginROIDim0AutoSizeString   "DIM0_AUTO_SIZE" /* (asynInt32, r/w) Automatically set size to max */
 
#define NDPluginROIDim1AutoSizeString   "DIM1_AUTO_SIZE" /* (asynInt32, r/w) Automatically set size to max */
 
#define NDPluginROIDim2AutoSizeString   "DIM2_AUTO_SIZE" /* (asynInt32, r/w) Automatically set size to max */
 
#define NDPluginROIDataTypeString   "ROI_DATA_TYPE" /* (asynInt32, r/w) Data type for ROI. -1 means automatic. */
 
#define NDPluginROIEnableScaleString   "ENABLE_SCALE" /* (asynInt32, r/w) Disable/Enable scaling */
 
#define NDPluginROIScaleString   "SCALE_VALUE" /* (asynFloat64, r/w) Scaling value, used as divisor */
 
#define NDPluginROICollapseDimsString   "COLLAPSE_DIMS" /* (asynInt32, r/w) Collapse dimensions of size 1 */
 
#define FIRST_NDPLUGIN_ROI_PARAM   NDPluginROIName
 

Macro Definition Documentation

◆ FIRST_NDPLUGIN_ROI_PARAM

#define FIRST_NDPLUGIN_ROI_PARAM   NDPluginROIName

◆ NDPluginROICollapseDimsString

#define NDPluginROICollapseDimsString   "COLLAPSE_DIMS" /* (asynInt32, r/w) Collapse dimensions of size 1 */

◆ NDPluginROIDataTypeString

#define NDPluginROIDataTypeString   "ROI_DATA_TYPE" /* (asynInt32, r/w) Data type for ROI. -1 means automatic. */

◆ NDPluginROIDim0AutoSizeString

#define NDPluginROIDim0AutoSizeString   "DIM0_AUTO_SIZE" /* (asynInt32, r/w) Automatically set size to max */

◆ NDPluginROIDim0BinString

#define NDPluginROIDim0BinString   "DIM0_BIN" /* (asynInt32, r/w) Binning of ROI in each dimension */

◆ NDPluginROIDim0EnableString

#define NDPluginROIDim0EnableString   "DIM0_ENABLE" /* (asynInt32, r/w) If set then do ROI in this dimension */

◆ NDPluginROIDim0MaxSizeString

#define NDPluginROIDim0MaxSizeString   "DIM0_MAX_SIZE" /* (asynInt32, r/o) Maximum size of ROI in each dimension */

◆ NDPluginROIDim0MinString

#define NDPluginROIDim0MinString   "DIM0_MIN" /* (asynInt32, r/w) Starting element of ROI in each dimension */

◆ NDPluginROIDim0ReverseString

#define NDPluginROIDim0ReverseString   "DIM0_REVERSE" /* (asynInt32, r/w) Reversal of ROI in each dimension */

◆ NDPluginROIDim0SizeString

#define NDPluginROIDim0SizeString   "DIM0_SIZE" /* (asynInt32, r/w) Size of ROI in each dimension */

◆ NDPluginROIDim1AutoSizeString

#define NDPluginROIDim1AutoSizeString   "DIM1_AUTO_SIZE" /* (asynInt32, r/w) Automatically set size to max */

◆ NDPluginROIDim1BinString

#define NDPluginROIDim1BinString   "DIM1_BIN" /* (asynInt32, r/w) Binning of ROI in each dimension */

◆ NDPluginROIDim1EnableString

#define NDPluginROIDim1EnableString   "DIM1_ENABLE" /* (asynInt32, r/w) If set then do ROI in this dimension */

◆ NDPluginROIDim1MaxSizeString

#define NDPluginROIDim1MaxSizeString   "DIM1_MAX_SIZE" /* (asynInt32, r/o) Maximum size of ROI in each dimension */

◆ NDPluginROIDim1MinString

#define NDPluginROIDim1MinString   "DIM1_MIN" /* (asynInt32, r/w) Starting element of ROI in each dimension */

◆ NDPluginROIDim1ReverseString

#define NDPluginROIDim1ReverseString   "DIM1_REVERSE" /* (asynInt32, r/w) Reversal of ROI in each dimension */

◆ NDPluginROIDim1SizeString

#define NDPluginROIDim1SizeString   "DIM1_SIZE" /* (asynInt32, r/w) Size of ROI in each dimension */

◆ NDPluginROIDim2AutoSizeString

#define NDPluginROIDim2AutoSizeString   "DIM2_AUTO_SIZE" /* (asynInt32, r/w) Automatically set size to max */

◆ NDPluginROIDim2BinString

#define NDPluginROIDim2BinString   "DIM2_BIN" /* (asynInt32, r/w) Binning of ROI in each dimension */

◆ NDPluginROIDim2EnableString

#define NDPluginROIDim2EnableString   "DIM2_ENABLE" /* (asynInt32, r/w) If set then do ROI in this dimension */

◆ NDPluginROIDim2MaxSizeString

#define NDPluginROIDim2MaxSizeString   "DIM2_MAX_SIZE" /* (asynInt32, r/o) Maximum size of ROI in each dimension */

◆ NDPluginROIDim2MinString

#define NDPluginROIDim2MinString   "DIM2_MIN" /* (asynInt32, r/w) Starting element of ROI in each dimension */

◆ NDPluginROIDim2ReverseString

#define NDPluginROIDim2ReverseString   "DIM2_REVERSE" /* (asynInt32, r/w) Reversal of ROI in each dimension */

◆ NDPluginROIDim2SizeString

#define NDPluginROIDim2SizeString   "DIM2_SIZE" /* (asynInt32, r/w) Size of ROI in each dimension */

◆ NDPluginROIEnableScaleString

#define NDPluginROIEnableScaleString   "ENABLE_SCALE" /* (asynInt32, r/w) Disable/Enable scaling */

◆ NDPluginROINameString

#define NDPluginROINameString   "NAME" /* (asynOctet, r/w) Name of this ROI */

◆ NDPluginROIScaleString

#define NDPluginROIScaleString   "SCALE_VALUE" /* (asynFloat64, r/w) Scaling value, used as divisor */