areaDetector  3-13
EPICS areaDetector framework
Classes | Macros | Typedefs | Enumerations | Variables
NDArray.h File Reference
#include <set>
#include <epicsMutex.h>
#include <epicsTime.h>
#include <ellLib.h>
#include "NDAttribute.h"
#include "NDAttributeList.h"
#include "Codec.h"

Go to the source code of this file.

Classes

struct  NDDimension
 Structure defining a dimension of an NDArray. More...
 
struct  NDArrayInfo
 Structure returned by NDArray::getInfo. More...
 
class  NDArray
 N-dimensional array class; each array has a set of dimensions, a data type, pointer to data, and optional attributes. More...
 
class  freeListElement
 
class  NDArrayPool
 The NDArrayPool class manages a free list (pool) of NDArray objects. More...
 

Macros

#define ND_ARRAY_MAX_DIMS   10
 NDArray.h. More...
 

Typedefs

typedef void *(* MallocFunc_t) (size_t size)
 
typedef void(* FreeFunc_t) (void *ptr)
 
typedef struct NDDimension NDDimension_t
 Structure defining a dimension of an NDArray. More...
 
typedef struct NDArrayInfo NDArrayInfo_t
 Structure returned by NDArray::getInfo. More...
 

Enumerations

enum  NDColorMode_t {
  NDColorModeMono , NDColorModeBayer , NDColorModeRGB1 , NDColorModeRGB2 ,
  NDColorModeRGB3 , NDColorModeYUV444 , NDColorModeYUV422 , NDColorModeYUV411
}
 Enumeration of color modes for NDArray attribute "colorMode". More...
 
enum  NDBayerPattern_t { NDBayerRGGB = 0 , NDBayerGBRG = 1 , NDBayerGRBG = 2 , NDBayerBGGR = 3 }
 Enumeration of Bayer patterns for NDArray attribute "bayerPattern". More...
 

Variables

MallocFunc_t defaultFrameMalloc
 
FreeFunc_t defaultFrameFree
 

Macro Definition Documentation

◆ ND_ARRAY_MAX_DIMS

#define ND_ARRAY_MAX_DIMS   10

NDArray.h.

N-dimensional array definition

Mark Rivers University of Chicago May 10, 2008 The maximum number of dimensions in an NDArray

Typedef Documentation

◆ FreeFunc_t

typedef void(* FreeFunc_t) (void *ptr)

◆ MallocFunc_t

typedef void*(* MallocFunc_t) (size_t size)

◆ NDArrayInfo_t

typedef struct NDArrayInfo NDArrayInfo_t

Structure returned by NDArray::getInfo.

◆ NDDimension_t

typedef struct NDDimension NDDimension_t

Structure defining a dimension of an NDArray.

Enumeration Type Documentation

◆ NDBayerPattern_t

Enumeration of Bayer patterns for NDArray attribute "bayerPattern".

This value is only meaningful if colorMode is NDColorModeBayer. This value is needed because the Bayer pattern will change when reading out a subset of the chip, for example if the X or Y offset values are not even numbers

Enumerator
NDBayerRGGB 

First line RGRG, second line GBGB...

NDBayerGBRG 

First line GBGB, second line RGRG...

NDBayerGRBG 

First line GRGR, second line BGBG...

NDBayerBGGR 

First line BGBG, second line GRGR...

◆ NDColorMode_t

Enumeration of color modes for NDArray attribute "colorMode".

Enumerator
NDColorModeMono 

Monochromatic image.

NDColorModeBayer 

Bayer pattern image, 1 value per pixel but with color filter on detector.

NDColorModeRGB1 

RGB image with pixel color interleave, data array is [3, NX, NY].

NDColorModeRGB2 

RGB image with row color interleave, data array is [NX, 3, NY]

NDColorModeRGB3 

RGB image with plane color interleave, data array is [NX, NY, 3]

NDColorModeYUV444 

YUV image, 3 bytes encodes 1 RGB pixel.

NDColorModeYUV422 

YUV image, 4 bytes encodes 2 RGB pixel.

NDColorModeYUV411 

YUV image, 6 bytes encodes 4 RGB pixels.

Variable Documentation

◆ defaultFrameFree

FreeFunc_t defaultFrameFree
extern

◆ defaultFrameMalloc

MallocFunc_t defaultFrameMalloc
extern