areaDetector  3-5-0
EPICS areaDetector framework
Public Attributes | List of all members
NDArrayInfo Struct Reference

Structure returned by NDArray::getInfo. More...

#include <NDArray.h>

Public Attributes

size_t nElements
 The total number of elements in the array. More...
 
int bytesPerElement
 The number of bytes per element in the array. More...
 
size_t totalBytes
 The total number of bytes required to hold the array; this may be less than NDArray::dataSize. More...
 
NDColorMode_t colorMode
 The color mode. More...
 
int xDim
 The array index which is the X dimension. More...
 
int yDim
 The array index which is the Y dimension. More...
 
int colorDim
 The array index which is the color dimension. More...
 
size_t xSize
 The X size of the array. More...
 
size_t ySize
 The Y size of the array. More...
 
size_t colorSize
 The color size of the array. More...
 
size_t xStride
 The number of array elements between X values. More...
 
size_t yStride
 The number of array elements between Y values. More...
 
size_t colorStride
 The number of array elements between color values. More...
 

Detailed Description

Structure returned by NDArray::getInfo.

Member Data Documentation

◆ bytesPerElement

int NDArrayInfo::bytesPerElement

The number of bytes per element in the array.

◆ colorDim

int NDArrayInfo::colorDim

The array index which is the color dimension.

◆ colorMode

NDColorMode_t NDArrayInfo::colorMode

The color mode.

◆ colorSize

size_t NDArrayInfo::colorSize

The color size of the array.

◆ colorStride

size_t NDArrayInfo::colorStride

The number of array elements between color values.

◆ nElements

size_t NDArrayInfo::nElements

The total number of elements in the array.

◆ totalBytes

size_t NDArrayInfo::totalBytes

The total number of bytes required to hold the array; this may be less than NDArray::dataSize.

The following are mostly useful for color images (RGB1, RGB2, RGB3)

◆ xDim

int NDArrayInfo::xDim

The array index which is the X dimension.

◆ xSize

size_t NDArrayInfo::xSize

The X size of the array.

◆ xStride

size_t NDArrayInfo::xStride

The number of array elements between X values.

◆ yDim

int NDArrayInfo::yDim

The array index which is the Y dimension.

◆ ySize

size_t NDArrayInfo::ySize

The Y size of the array.

◆ yStride

size_t NDArrayInfo::yStride

The number of array elements between Y values.


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