Structure defining a dimension of an NDArray. More...

#include <NDArray.h>

Public Attributes
size_t	size
	The number of elements in this dimension of the array. More...

size_t	offset
	The offset relative to the origin of the original data source (detector, for example). More...

int	binning
	The binning (pixel summation, 1=no binning) relative to original data source (detector, for example) The offset value is cumulative, so if a plugin such as NDPluginROI performs binning, the binning is expressed relative to the pixels in the detector and not to the possibly binned pixels passed to NDPluginROI. More...

int	reverse
	The orientation (0=normal, 1=reversed) relative to the original data source (detector, for example) This value is cumulative, so if a plugin such as NDPluginROI reverses the data, the value must reflect the orientation relative to the original detector, and not to the possibly reversed data passed to NDPluginROI. More...

Detailed Description

Structure defining a dimension of an NDArray.

Member Data Documentation

◆ binning

int NDDimension::binning

The binning (pixel summation, 1=no binning) relative to original data source (detector, for example) The offset value is cumulative, so if a plugin such as NDPluginROI performs binning, the binning is expressed relative to the pixels in the detector and not to the possibly binned pixels passed to NDPluginROI.

◆ offset

size_t NDDimension::offset

The offset relative to the origin of the original data source (detector, for example).

If a selected region of the detector is being read, then this value may be > 0. The offset value is specified in unbinned pixels, and in the default orientation, not reversed. The offset value is cumulative, so if a plugin such as NDPluginROI further selects a subregion, the offset is relative to the first element in the detector, and not to the first element of the region passed to NDPluginROI.

◆ reverse

int NDDimension::reverse

The orientation (0=normal, 1=reversed) relative to the original data source (detector, for example) This value is cumulative, so if a plugin such as NDPluginROI reverses the data, the value must reflect the orientation relative to the original detector, and not to the possibly reversed data passed to NDPluginROI.

◆ size

size_t NDDimension::size

The number of elements in this dimension of the array.

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