Detailed Description

Image class. Implements the interface Interop::Runtime28::IImage.

This class implements only the basic functionality for an image like create, delete and convert. All image processing has to be implemented separately.

The format of an image is described by the class CRxImageFormat. It consist of an image width, height, a pixel type and a data type. The pixel type defines the number and order of color channels, and the data type specifies the data type of each color channel. For example, the pixel type can be RGBA or BGRA and the data type may be unsigned byte (8bit) or unsigned short (16bit). The various pixel types available are defined in Rx::Interop::Runtime28::EPixelType::ID and the data types in Rx::Interop::Runtime28::EDataType::ID. Note that the values of the data type and pixel type defines are identical to the corresponding OpenGL IDs.

All possible pixel and data types are represented by the TPixeltemplate structure. Specializations of this template structure cover all possible combinations of the defined pixel types and data types. The specialization names have the form TPixel_[PixelType]_[Data Type]. For example, the pixel structure for an RGBA unsigned char image is TPixel_RGBA_uc.

The main advantage of using the TPixel_* typedefs to access the pixels of an image is, that you can write template functions that work on many different pixel types. The TPixel structure defines functions to access the various color channels that map to the correct element within a pixel.

The pointer to the image data can be obtained with the function GetDataPtr().

See also: Interop::Runtime28::IImage

Inherits Rx::Interop::Runtime28::IImage.

Inherited by Rx::LFR::CRayImage.

Public Member Functions
	CRxImage ()
	Default constructor. Creates an invalid image without using any memory. More...

	CRxImage (const CRxImage &xImage)
	Copy constructor. Creates a copy of the given image More...

	CRxImage (const CRxImageFormat &xFormat)
	Constructor. Creates a valid image within the given format and allocates memory accordingly. More...

	CRxImage (CRxImage &&xImage)
	Move constructor. More...

virtual	~CRxImage ()
	Destructor. All used memory is freed. More...

void	ConvertCustomType (CRxImage &xTrgImg) const
	Converts this image from a custom data type into the corresponding primitive data type. More...

bool	ConvertType (CRxImage &xImage, Interop::Runtime28::EPixelType::ID ePixelType, Interop::Runtime28::EDataType::ID eDataType) const
	Convert this image to a different type and store result in xImage. More...

void	Create (const CRxImage &xImage)
	Creates a copy of the given image. Only (re)allocates memory if required. More...

void	Create (const CRxImageFormat &xFormat)
	Creates an image of the given format. Only (re)allocates memory if required. More...

void	Create (const CRxImageFormat &xFormat, const void *pvImgData)
	Creates an image of the given format. Only (re)allocates memory if required. Copies the image data into this image. More...

void	Create (CRxImage &&xImage)
	Creates this image by moving the data of the given image into this image. More...

virtual bool	Create (int iWidth, int iHeight, Interop::Runtime28::EPixelType::ID ePixelType, Interop::Runtime28::EDataType::ID eDataType)
	Create an image of given type and size and reserve the appropriate amount of memory. No re-allocation is applied if this is of requested format. More...

virtual bool	Create (int iWidth, int iHeight, Interop::Runtime28::EPixelType::ID ePixelType, Interop::Runtime28::EDataType::ID eDataType, const void *pData)
	Create an image of given type and size and copy the data from the given pointer. No re-allocation is applied if this is of requested format. More...

void	CreateMoniker (const CRxImageFormat &xFormat, void *pvImgData, double dTimestamp=0.0, unsigned uID=0)
	Creates an image of the given format. This copies only the image data pointer. Does not allocate memory. More...

virtual bool	Destroy ()
	Destroys this image if one has been created. Resets all internal variables. More...

virtual unsigned	GetByteCount () const
	Gets the number of bytes of the whole image. More...

virtual int	GetBytesPerPixel () const
	Get number of bytes per pixel. More...

virtual void *	GetDataPtr ()
	Return the pointer to the data array. More...

virtual const void *	GetDataPtr () const
	Return the constant pointer to the data array. More...

const CRxImageFormat &	GetFormat () const
	Gets the image format. More...

unsigned	GetID () const
	Gets the ID of this image. Is used to represent images captured by a camera or read from a sequence. More...

void	GetPixel (TPixel_Bay_BG_c &xPix, int iX, int iY) const

void	GetPixel (TPixel_Bay_BG_d &xPix, int iX, int iY) const

void	GetPixel (TPixel_Bay_BG_f &xPix, int iX, int iY) const

void	GetPixel (TPixel_Bay_BG_i &xPix, int iX, int iY) const

void	GetPixel (TPixel_Bay_BG_s &xPix, int iX, int iY) const

void	GetPixel (TPixel_Bay_BG_uc &xPix, int iX, int iY) const

void	GetPixel (TPixel_Bay_BG_ui &xPix, int iX, int iY) const

void	GetPixel (TPixel_Bay_BG_us &xPix, int iX, int iY) const

void	GetPixel (TPixel_Bay_GB_c &xPix, int iX, int iY) const

void	GetPixel (TPixel_Bay_GB_d &xPix, int iX, int iY) const

void	GetPixel (TPixel_Bay_GB_f &xPix, int iX, int iY) const

void	GetPixel (TPixel_Bay_GB_i &xPix, int iX, int iY) const

void	GetPixel (TPixel_Bay_GB_s &xPix, int iX, int iY) const

void	GetPixel (TPixel_Bay_GB_uc &xPix, int iX, int iY) const

void	GetPixel (TPixel_Bay_GB_ui &xPix, int iX, int iY) const

void	GetPixel (TPixel_Bay_GB_us &xPix, int iX, int iY) const

void	GetPixel (TPixel_Bay_GR_c &xPix, int iX, int iY) const

void	GetPixel (TPixel_Bay_GR_d &xPix, int iX, int iY) const

void	GetPixel (TPixel_Bay_GR_f &xPix, int iX, int iY) const

void	GetPixel (TPixel_Bay_GR_i &xPix, int iX, int iY) const

void	GetPixel (TPixel_Bay_GR_s &xPix, int iX, int iY) const

void	GetPixel (TPixel_Bay_GR_uc &xPix, int iX, int iY) const

void	GetPixel (TPixel_Bay_GR_ui &xPix, int iX, int iY) const

void	GetPixel (TPixel_Bay_GR_us &xPix, int iX, int iY) const

void	GetPixel (TPixel_Bay_RG_c &xPix, int iX, int iY) const

void	GetPixel (TPixel_Bay_RG_d &xPix, int iX, int iY) const

void	GetPixel (TPixel_Bay_RG_f &xPix, int iX, int iY) const

void	GetPixel (TPixel_Bay_RG_i &xPix, int iX, int iY) const

void	GetPixel (TPixel_Bay_RG_s &xPix, int iX, int iY) const

void	GetPixel (TPixel_Bay_RG_uc &xPix, int iX, int iY) const

void	GetPixel (TPixel_Bay_RG_ui &xPix, int iX, int iY) const

void	GetPixel (TPixel_Bay_RG_us &xPix, int iX, int iY) const

void	GetPixel (TPixel_BGR_c &xPix, int iX, int iY) const

void	GetPixel (TPixel_BGR_d &xPix, int iX, int iY) const

void	GetPixel (TPixel_BGR_f &xPix, int iX, int iY) const

void	GetPixel (TPixel_BGR_i &xPix, int iX, int iY) const

void	GetPixel (TPixel_BGR_s &xPix, int iX, int iY) const

void	GetPixel (TPixel_BGR_uc &xPix, int iX, int iY) const

void	GetPixel (TPixel_BGR_ui &xPix, int iX, int iY) const

void	GetPixel (TPixel_BGR_us &xPix, int iX, int iY) const

void	GetPixel (TPixel_BGRA_c &xPix, int iX, int iY) const

void	GetPixel (TPixel_BGRA_d &xPix, int iX, int iY) const

void	GetPixel (TPixel_BGRA_f &xPix, int iX, int iY) const

void	GetPixel (TPixel_BGRA_i &xPix, int iX, int iY) const

void	GetPixel (TPixel_BGRA_s &xPix, int iX, int iY) const

void	GetPixel (TPixel_BGRA_uc &xPix, int iX, int iY) const

void	GetPixel (TPixel_BGRA_ui &xPix, int iX, int iY) const

void	GetPixel (TPixel_BGRA_us &xPix, int iX, int iY) const

void	GetPixel (TPixel_L_c &xPix, int iX, int iY) const

void	GetPixel (TPixel_L_d &xPix, int iX, int iY) const

void	GetPixel (TPixel_L_f &xPix, int iX, int iY) const

void	GetPixel (TPixel_L_i &xPix, int iX, int iY) const

void	GetPixel (TPixel_L_s &xPix, int iX, int iY) const

void	GetPixel (TPixel_L_uc &xPix, int iX, int iY) const

void	GetPixel (TPixel_L_ui &xPix, int iX, int iY) const

void	GetPixel (TPixel_L_us &xPix, int iX, int iY) const

void	GetPixel (TPixel_LA_c &xPix, int iX, int iY) const

void	GetPixel (TPixel_LA_d &xPix, int iX, int iY) const

void	GetPixel (TPixel_LA_f &xPix, int iX, int iY) const

void	GetPixel (TPixel_LA_i &xPix, int iX, int iY) const

void	GetPixel (TPixel_LA_s &xPix, int iX, int iY) const

void	GetPixel (TPixel_LA_uc &xPix, int iX, int iY) const

void	GetPixel (TPixel_LA_ui &xPix, int iX, int iY) const

void	GetPixel (TPixel_LA_us &xPix, int iX, int iY) const

void	GetPixel (TPixel_RGB_c &xPix, int iX, int iY) const

void	GetPixel (TPixel_RGB_d &xPix, int iX, int iY) const

void	GetPixel (TPixel_RGB_f &xPix, int iX, int iY) const

void	GetPixel (TPixel_RGB_i &xPix, int iX, int iY) const

void	GetPixel (TPixel_RGB_s &xPix, int iX, int iY) const

void	GetPixel (TPixel_RGB_uc &xPix, int iX, int iY) const

void	GetPixel (TPixel_RGB_ui &xPix, int iX, int iY) const

void	GetPixel (TPixel_RGB_us &xPix, int iX, int iY) const

void	GetPixel (TPixel_RGBA_c &xPix, int iX, int iY) const

void	GetPixel (TPixel_RGBA_d &xPix, int iX, int iY) const

void	GetPixel (TPixel_RGBA_f &xPix, int iX, int iY) const

void	GetPixel (TPixel_RGBA_i &xPix, int iX, int iY) const

void	GetPixel (TPixel_RGBA_s &xPix, int iX, int iY) const

void	GetPixel (TPixel_RGBA_uc &xPix, int iX, int iY) const

void	GetPixel (TPixel_RGBA_ui &xPix, int iX, int iY) const

void	GetPixel (TPixel_RGBA_us &xPix, int iX, int iY) const

virtual unsigned	GetPixelCount () const
	Gets the number of pixels. More...

virtual void	GetSize (int &iWidth, int &iHeight) const
	Gets the size of the image. More...

double	GetTimestamp () const
	Gets the timestamp of the image capture. Is 0.0 if this image has no timestamp. More...

virtual void	GetType (Interop::Runtime28::EPixelType::ID &ePixelType, Interop::Runtime28::EDataType::ID &eDataType) const
	Gets the type of the image. More...

bool	IsMoniker () const
	Query if this image is a moniker. More...

bool	IsOfType (Interop::Runtime28::EPixelType::ID ePixelType, Interop::Runtime28::EDataType::ID eDataType) const
	Test whether image is of a particular pixel and data type. More...

virtual bool	IsValid () const
	Query if this image is valid. More...

bool	Normalize ()
	Find minimal and maximal value of image and normalize image to range [0,1]. More...

CRxImage &	operator= (const CRxImage &xImage)
	Assignment operator. Copies the contents of the given image. More...

CRxImage &	operator= (CRxImage &&xImage)
	Move assignment operator. More...

bool	Set (const void *pvImgData)
	Copies the content of the given image data into this image. More...

void	SetID (unsigned uID)
	Sets the ID of this image. Is used to represent images captured by a camera or read from a sequence. More...

void	SetPixel (const TPixel_Bay_BG_c &xPix, int iX, int iY)

void	SetPixel (const TPixel_Bay_BG_d &xPix, int iX, int iY)

void	SetPixel (const TPixel_Bay_BG_f &xPix, int iX, int iY)

void	SetPixel (const TPixel_Bay_BG_i &xPix, int iX, int iY)

void	SetPixel (const TPixel_Bay_BG_s &xPix, int iX, int iY)

void	SetPixel (const TPixel_Bay_BG_uc &xPix, int iX, int iY)

void	SetPixel (const TPixel_Bay_BG_ui &xPix, int iX, int iY)

void	SetPixel (const TPixel_Bay_BG_us &xPix, int iX, int iY)

void	SetPixel (const TPixel_Bay_GB_c &xPix, int iX, int iY)

void	SetPixel (const TPixel_Bay_GB_d &xPix, int iX, int iY)

void	SetPixel (const TPixel_Bay_GB_f &xPix, int iX, int iY)

void	SetPixel (const TPixel_Bay_GB_i &xPix, int iX, int iY)

void	SetPixel (const TPixel_Bay_GB_s &xPix, int iX, int iY)

void	SetPixel (const TPixel_Bay_GB_uc &xPix, int iX, int iY)

void	SetPixel (const TPixel_Bay_GB_ui &xPix, int iX, int iY)

void	SetPixel (const TPixel_Bay_GB_us &xPix, int iX, int iY)

void	SetPixel (const TPixel_Bay_GR_c &xPix, int iX, int iY)

void	SetPixel (const TPixel_Bay_GR_d &xPix, int iX, int iY)

void	SetPixel (const TPixel_Bay_GR_f &xPix, int iX, int iY)

void	SetPixel (const TPixel_Bay_GR_i &xPix, int iX, int iY)

void	SetPixel (const TPixel_Bay_GR_s &xPix, int iX, int iY)

void	SetPixel (const TPixel_Bay_GR_uc &xPix, int iX, int iY)

void	SetPixel (const TPixel_Bay_GR_ui &xPix, int iX, int iY)

void	SetPixel (const TPixel_Bay_GR_us &xPix, int iX, int iY)

void	SetPixel (const TPixel_Bay_RG_c &xPix, int iX, int iY)

void	SetPixel (const TPixel_Bay_RG_d &xPix, int iX, int iY)

void	SetPixel (const TPixel_Bay_RG_f &xPix, int iX, int iY)

void	SetPixel (const TPixel_Bay_RG_i &xPix, int iX, int iY)

void	SetPixel (const TPixel_Bay_RG_s &xPix, int iX, int iY)

void	SetPixel (const TPixel_Bay_RG_uc &xPix, int iX, int iY)

void	SetPixel (const TPixel_Bay_RG_ui &xPix, int iX, int iY)

void	SetPixel (const TPixel_Bay_RG_us &xPix, int iX, int iY)

void	SetPixel (const TPixel_BGR_c &xPix, int iX, int iY)

void	SetPixel (const TPixel_BGR_d &xPix, int iX, int iY)

void	SetPixel (const TPixel_BGR_f &xPix, int iX, int iY)

void	SetPixel (const TPixel_BGR_i &xPix, int iX, int iY)

void	SetPixel (const TPixel_BGR_s &xPix, int iX, int iY)

void	SetPixel (const TPixel_BGR_uc &xPix, int iX, int iY)

void	SetPixel (const TPixel_BGR_ui &xPix, int iX, int iY)

void	SetPixel (const TPixel_BGR_us &xPix, int iX, int iY)

void	SetPixel (const TPixel_BGRA_c &xPix, int iX, int iY)

void	SetPixel (const TPixel_BGRA_d &xPix, int iX, int iY)

void	SetPixel (const TPixel_BGRA_f &xPix, int iX, int iY)

void	SetPixel (const TPixel_BGRA_i &xPix, int iX, int iY)

void	SetPixel (const TPixel_BGRA_s &xPix, int iX, int iY)

void	SetPixel (const TPixel_BGRA_uc &xPix, int iX, int iY)

void	SetPixel (const TPixel_BGRA_ui &xPix, int iX, int iY)

void	SetPixel (const TPixel_BGRA_us &xPix, int iX, int iY)

void	SetPixel (const TPixel_L_c &xPix, int iX, int iY)

void	SetPixel (const TPixel_L_d &xPix, int iX, int iY)

void	SetPixel (const TPixel_L_f &xPix, int iX, int iY)

void	SetPixel (const TPixel_L_i &xPix, int iX, int iY)

void	SetPixel (const TPixel_L_s &xPix, int iX, int iY)

void	SetPixel (const TPixel_L_uc &xPix, int iX, int iY)

void	SetPixel (const TPixel_L_ui &xPix, int iX, int iY)

void	SetPixel (const TPixel_L_us &xPix, int iX, int iY)

void	SetPixel (const TPixel_LA_c &xPix, int iX, int iY)

void	SetPixel (const TPixel_LA_d &xPix, int iX, int iY)

void	SetPixel (const TPixel_LA_f &xPix, int iX, int iY)

void	SetPixel (const TPixel_LA_i &xPix, int iX, int iY)

void	SetPixel (const TPixel_LA_s &xPix, int iX, int iY)

void	SetPixel (const TPixel_LA_uc &xPix, int iX, int iY)

void	SetPixel (const TPixel_LA_ui &xPix, int iX, int iY)

void	SetPixel (const TPixel_LA_us &xPix, int iX, int iY)

void	SetPixel (const TPixel_RGB_c &xPix, int iX, int iY)

void	SetPixel (const TPixel_RGB_d &xPix, int iX, int iY)

void	SetPixel (const TPixel_RGB_f &xPix, int iX, int iY)

void	SetPixel (const TPixel_RGB_i &xPix, int iX, int iY)

void	SetPixel (const TPixel_RGB_s &xPix, int iX, int iY)

void	SetPixel (const TPixel_RGB_uc &xPix, int iX, int iY)

void	SetPixel (const TPixel_RGB_ui &xPix, int iX, int iY)

void	SetPixel (const TPixel_RGB_us &xPix, int iX, int iY)

void	SetPixel (const TPixel_RGBA_c &xPix, int iX, int iY)

void	SetPixel (const TPixel_RGBA_d &xPix, int iX, int iY)

void	SetPixel (const TPixel_RGBA_f &xPix, int iX, int iY)

void	SetPixel (const TPixel_RGBA_i &xPix, int iX, int iY)

void	SetPixel (const TPixel_RGBA_s &xPix, int iX, int iY)

void	SetPixel (const TPixel_RGBA_uc &xPix, int iX, int iY)

void	SetPixel (const TPixel_RGBA_ui &xPix, int iX, int iY)

void	SetPixel (const TPixel_RGBA_us &xPix, int iX, int iY)

void	SetROIDefinition (const CRxImageFormat::TInt4 &piROIDefinition)
	Sets the ROI definition. More...

void	SetTimestamp (double dTimestamp)
	Sets the timestamp of the image capture. More...

void	SetTimestampID (double dTimestamp, unsigned uID)
	Sets the timestamp and the ID of the image. More...

void	SetZero ()
	Sets the image data to contain only zeros. More...

void	Swap (CRxImage &xImage)
	Swaps the data between this and the given image. More...

Static Public Member Functions
static bool	ConvertMemory (void pTrgMem, const void pSrcMem, const CRxImageFormat &xTrgFormat, const CRxImageFormat &xSrcFormat)
	Convert the pSrcMem memory to a different type and store result in memory pTrgMem. More...

static bool	ConvertType (CRxImage &xDstImg, const CRxImage &xSrcImg, Interop::Runtime28::EPixelType::ID ePixelType, Interop::Runtime28::EDataType::ID eDataType)
	Convert the pSrcImage to a different type and store result in pDstImage. More...

Protected Member Functions
	CRxImage (const CRxImageFormat &xFormat, IAllocator *pxAllocator)
	Constructor. Creates a valid image within the given format and allocator and allocates memory accordingly. More...

	CRxImage (IAllocator *pxAllocator)
	Constructor. More...

template<class TPix >
TPix &	_GetPixel (int iX, int iY)

template<class TPix >
const TPix &	_GetPixel (int iX, int iY) const

Static Protected Member Functions
template<class TTrgPix , class TSrcPix >
static bool	_Convert (unsigned uPixelCount, TTrgPix pTrgPix, const TSrcPix pSrcPix)

template<class TPix >
static bool	_ConvertSrcSwitch (const void pSrcMem, const CRxImageFormat &xSrcFormat, TPix pTrgPix)

static bool	_ConvertTrgSwitch (void pDstMem, const void pSrcMem, const CRxImageFormat &xDstFormat, const CRxImageFormat &xSrcFormat)

Protected Attributes
bool	m_bIsMoniker
	True if this image is only a moniker for an image data pointer. The memory is not freed in the destructor. More...

double	m_dTimestamp
	The timestamp of the image capture. Is 0.0 if this image has no timestamp. More...

void *	m_pvData
	The actual image data. More...

IAllocator *	m_pxAllocator
	The allocator. More...

unsigned	m_uID
	The image ID. Is used to represent images captured by a camera or read from a sequence. More...

CRxImageFormat	m_xFormat
	The format of this image. More...

Constructor & Destructor Documentation

◆ CRxImage() [1/6]

Rx::CRxImage::CRxImage ( )

Default constructor. Creates an invalid image without using any memory.

◆ CRxImage() [2/6]

Rx::CRxImage::CRxImage ( const CRxImage & xImage )

Copy constructor. Creates a copy of the given image

Parameters

xImage The image to copy.

◆ CRxImage() [3/6]

Rx::CRxImage::CRxImage ( CRxImage && xImage )

Move constructor.

Parameters

xImage [in] The image to move. This is invalid after the call.

◆ CRxImage() [4/6]

Rx::CRxImage::CRxImage ( const CRxImageFormat & xFormat )

Constructor. Creates a valid image within the given format and allocates memory accordingly.

Parameters

xFormat The image format.

◆ ~CRxImage()

virtual Rx::CRxImage::~CRxImage ( )

virtual

Destructor. All used memory is freed.

◆ CRxImage() [5/6]

Rx::CRxImage::CRxImage ( IAllocator * pxAllocator )

explicitprotected

Constructor.

Parameters

pxAllocator [in,out] The allocator for this image. The image will borrow the ownership of the allocator.

◆ CRxImage() [6/6]

Rx::CRxImage::CRxImage	(	const CRxImageFormat &	xFormat,
		IAllocator *	pxAllocator
	)

explicitprotected

Constructor. Creates a valid image within the given format and allocator and allocates memory accordingly.

Parameters

xFormat	The image format.
pxAllocator	[in,out] The allocator for this image. The image will borrow the ownership of the allocator.

Member Function Documentation

◆ _Convert()

template<class TTrgPix , class TSrcPix >

static bool Rx::CRxImage::_Convert	(	unsigned	uPixelCount,
		TTrgPix *	pTrgPix,
		const TSrcPix *	pSrcPix
	)

staticprotected

◆ _ConvertSrcSwitch()

template<class TPix >

static bool Rx::CRxImage::_ConvertSrcSwitch	(	const void *	pSrcMem,
		const CRxImageFormat &	xSrcFormat,
		TPix *	pTrgPix
	)

staticprotected

◆ _ConvertTrgSwitch()

static bool Rx::CRxImage::_ConvertTrgSwitch	(	void *	pDstMem,
		const void *	pSrcMem,
		const CRxImageFormat &	xDstFormat,
		const CRxImageFormat &	xSrcFormat
	)

staticprotected

◆ _GetPixel() [1/2]

template<class TPix >

TPix& Rx::CRxImage::_GetPixel	(	int	iX,
		int	iY
	)

protected

◆ _GetPixel() [2/2]

template<class TPix >

const TPix& Rx::CRxImage::_GetPixel	(	int	iX,
		int	iY
	)		const

protected

◆ ConvertCustomType()

void Rx::CRxImage::ConvertCustomType ( CRxImage & xTrgImg ) const

Converts this image from a custom data type into the corresponding primitive data type.

The following conversion are implemented:

EDataType::Custom_10in16_LSB into EDataType::UShort
EDataType::Custom_12in16_LSB into EDataType::UShort.

Parameters

xTrgImg [out] The target image. This is created within the correct format.

◆ ConvertMemory()

static bool Rx::CRxImage::ConvertMemory	(	void *	pTrgMem,
		const void *	pSrcMem,
		const CRxImageFormat &	xTrgFormat,
		const CRxImageFormat &	xSrcFormat
	)

static

Convert the pSrcMem memory to a different type and store result in memory pTrgMem.

Parameters

pTrgMem	[in] Target memory (must have correct target size).
pSrcMem	Source memory.
xTrgFormat	The target image format.
xSrcFormat	The source image format.

Returns: True if it succeeds, false if it fails.

◆ ConvertType() [1/2]

static bool Rx::CRxImage::ConvertType	(	CRxImage &	xDstImg,
		const CRxImage &	xSrcImg,
		Interop::Runtime28::EPixelType::ID	ePixelType,
		Interop::Runtime28::EDataType::ID	eDataType
	)

static

Convert the pSrcImage to a different type and store result in pDstImage.

Parameters

xDstImg	[in,out] The target image.
xSrcImg	The source image.
ePixelType	The target pixel type.
eDataType	The targer data type.

Returns: False if an error occurred, otherwise true.

◆ ConvertType() [2/2]

bool Rx::CRxImage::ConvertType	(	CRxImage &	xImage,
		Interop::Runtime28::EPixelType::ID	ePixelType,
		Interop::Runtime28::EDataType::ID	eDataType
	)		const

Convert this image to a different type and store result in xImage.

Parameters

xImage	[in,out] The image instance into which to write the result. The size of this image is adapted to this size.
ePixelType	The target pixel type.
eDataType	The target data type.

Returns: False if an error occurred, otherwise true.

◆ Create() [1/6]

void Rx::CRxImage::Create ( const CRxImage & xImage )

Creates a copy of the given image. Only (re)allocates memory if required.

Parameters

xImage The image to copy.

◆ Create() [2/6]

void Rx::CRxImage::Create ( const CRxImageFormat & xFormat )

Creates an image of the given format. Only (re)allocates memory if required.

Parameters

xFormat The image format.

◆ Create() [3/6]

void Rx::CRxImage::Create	(	const CRxImageFormat &	xFormat,
		const void *	pvImgData
	)

Creates an image of the given format. Only (re)allocates memory if required. Copies the image data into this image.

Parameters

xFormat	The image format.
pvImgData	Pointer to the image data.

◆ Create() [4/6]

void Rx::CRxImage::Create ( CRxImage && xImage )

Creates this image by moving the data of the given image into this image.

Parameters

xImage [in,out] The image to move. Is invalid after this call.

◆ Create() [5/6]

virtual bool Rx::CRxImage::Create	(	int	iWidth,
		int	iHeight,
		Interop::Runtime28::EPixelType::ID	ePixelType,
		Interop::Runtime28::EDataType::ID	eDataType
	)

virtual

Create an image of given type and size and reserve the appropriate amount of memory. No re-allocation is applied if this is of requested format.

Parameters

iWidth	The width of image.
iHeight	The height of the image.
ePixelType	The pixel type.
eDataType	The data type.

Returns: True if it succeeds, false if it fails.

Implements Rx::Interop::Runtime28::IImage.

◆ Create() [6/6]

virtual bool Rx::CRxImage::Create	(	int	iWidth,
		int	iHeight,
		Interop::Runtime28::EPixelType::ID	ePixelType,
		Interop::Runtime28::EDataType::ID	eDataType,
		const void *	pData
	)

virtual

Create an image of given type and size and copy the data from the given pointer. No re-allocation is applied if this is of requested format.

Parameters

iWidth	Width of image.
iHeight	Height.
ePixelType	Type of the pixel.
eDataType	Type of the data.
pData	The data.

Returns: True if it succeeds, false if it fails.

Implements Rx::Interop::Runtime28::IImage.

◆ CreateMoniker()

void Rx::CRxImage::CreateMoniker	(	const CRxImageFormat &	xFormat,
		void *	pvImgData,
		double	dTimestamp = `0.0`,
		unsigned	uID = `0`
	)

Creates an image of the given format. This copies only the image data pointer. Does not allocate memory.

An images created with this method does never free the memory behind the pointer. The pointer responsibility stays with the caller.

Parameters

xFormat	The image format.
pvImgData	The image data pointer.
dTimestamp	(Optional) The timestamp of the image capture.
uID	(Optional) The image ID.

◆ Destroy()

virtual bool Rx::CRxImage::Destroy ( )

virtual

Destroys this image if one has been created. Resets all internal variables.

Returns: True if it succeeds, false if it fails.

Implements Rx::Interop::Runtime28::IImage.

◆ GetByteCount()

virtual unsigned Rx::CRxImage::GetByteCount ( ) const

inlinevirtual

Gets the number of bytes of the whole image.

Returns: The byte count.

Implements Rx::Interop::Runtime28::IImage.

◆ GetBytesPerPixel()

virtual int Rx::CRxImage::GetBytesPerPixel ( ) const

inlinevirtual

Get number of bytes per pixel.

Returns: The bytes per pixel.

Implements Rx::Interop::Runtime28::IImage.

◆ GetDataPtr() [1/2]

virtual void* Rx::CRxImage::GetDataPtr ( )

inlinevirtual

Return the pointer to the data array.

Returns: Null if it fails, else the data pointer.

Implements Rx::Interop::Runtime28::IImage.

◆ GetDataPtr() [2/2]

virtual const void* Rx::CRxImage::GetDataPtr ( ) const

inlinevirtual

Return the constant pointer to the data array.

Returns: Null if it fails, else the data pointer.

Implements Rx::Interop::Runtime28::IImage.

◆ GetFormat()

const CRxImageFormat& Rx::CRxImage::GetFormat ( ) const

inline

Gets the image format.

Returns: The format.

◆ GetID()

unsigned Rx::CRxImage::GetID ( ) const

inline

Gets the ID of this image. Is used to represent images captured by a camera or read from a sequence.

Returns: The ID of this image.

◆ GetPixel() [1/80]

void Rx::CRxImage::GetPixel	(	TPixel_Bay_BG_c &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [2/80]

void Rx::CRxImage::GetPixel	(	TPixel_Bay_BG_d &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [3/80]

void Rx::CRxImage::GetPixel	(	TPixel_Bay_BG_f &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [4/80]

void Rx::CRxImage::GetPixel	(	TPixel_Bay_BG_i &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [5/80]

void Rx::CRxImage::GetPixel	(	TPixel_Bay_BG_s &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [6/80]

void Rx::CRxImage::GetPixel	(	TPixel_Bay_BG_uc &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [7/80]

void Rx::CRxImage::GetPixel	(	TPixel_Bay_BG_ui &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [8/80]

void Rx::CRxImage::GetPixel	(	TPixel_Bay_BG_us &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [9/80]

void Rx::CRxImage::GetPixel	(	TPixel_Bay_GB_c &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [10/80]

void Rx::CRxImage::GetPixel	(	TPixel_Bay_GB_d &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [11/80]

void Rx::CRxImage::GetPixel	(	TPixel_Bay_GB_f &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [12/80]

void Rx::CRxImage::GetPixel	(	TPixel_Bay_GB_i &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [13/80]

void Rx::CRxImage::GetPixel	(	TPixel_Bay_GB_s &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [14/80]

void Rx::CRxImage::GetPixel	(	TPixel_Bay_GB_uc &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [15/80]

void Rx::CRxImage::GetPixel	(	TPixel_Bay_GB_ui &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [16/80]

void Rx::CRxImage::GetPixel	(	TPixel_Bay_GB_us &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [17/80]

void Rx::CRxImage::GetPixel	(	TPixel_Bay_GR_c &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [18/80]

void Rx::CRxImage::GetPixel	(	TPixel_Bay_GR_d &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [19/80]

void Rx::CRxImage::GetPixel	(	TPixel_Bay_GR_f &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [20/80]

void Rx::CRxImage::GetPixel	(	TPixel_Bay_GR_i &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [21/80]

void Rx::CRxImage::GetPixel	(	TPixel_Bay_GR_s &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [22/80]

void Rx::CRxImage::GetPixel	(	TPixel_Bay_GR_uc &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [23/80]

void Rx::CRxImage::GetPixel	(	TPixel_Bay_GR_ui &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [24/80]

void Rx::CRxImage::GetPixel	(	TPixel_Bay_GR_us &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [25/80]

void Rx::CRxImage::GetPixel	(	TPixel_Bay_RG_c &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [26/80]

void Rx::CRxImage::GetPixel	(	TPixel_Bay_RG_d &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [27/80]

void Rx::CRxImage::GetPixel	(	TPixel_Bay_RG_f &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [28/80]

void Rx::CRxImage::GetPixel	(	TPixel_Bay_RG_i &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [29/80]

void Rx::CRxImage::GetPixel	(	TPixel_Bay_RG_s &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [30/80]

void Rx::CRxImage::GetPixel	(	TPixel_Bay_RG_uc &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [31/80]

void Rx::CRxImage::GetPixel	(	TPixel_Bay_RG_ui &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [32/80]

void Rx::CRxImage::GetPixel	(	TPixel_Bay_RG_us &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [33/80]

void Rx::CRxImage::GetPixel	(	TPixel_BGR_c &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [34/80]

void Rx::CRxImage::GetPixel	(	TPixel_BGR_d &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [35/80]

void Rx::CRxImage::GetPixel	(	TPixel_BGR_f &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [36/80]

void Rx::CRxImage::GetPixel	(	TPixel_BGR_i &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [37/80]

void Rx::CRxImage::GetPixel	(	TPixel_BGR_s &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [38/80]

void Rx::CRxImage::GetPixel	(	TPixel_BGR_uc &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [39/80]

void Rx::CRxImage::GetPixel	(	TPixel_BGR_ui &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [40/80]

void Rx::CRxImage::GetPixel	(	TPixel_BGR_us &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [41/80]

void Rx::CRxImage::GetPixel	(	TPixel_BGRA_c &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [42/80]

void Rx::CRxImage::GetPixel	(	TPixel_BGRA_d &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [43/80]

void Rx::CRxImage::GetPixel	(	TPixel_BGRA_f &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [44/80]

void Rx::CRxImage::GetPixel	(	TPixel_BGRA_i &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [45/80]

void Rx::CRxImage::GetPixel	(	TPixel_BGRA_s &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [46/80]

void Rx::CRxImage::GetPixel	(	TPixel_BGRA_uc &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [47/80]

void Rx::CRxImage::GetPixel	(	TPixel_BGRA_ui &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [48/80]

void Rx::CRxImage::GetPixel	(	TPixel_BGRA_us &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [49/80]

void Rx::CRxImage::GetPixel	(	TPixel_L_c &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [50/80]

void Rx::CRxImage::GetPixel	(	TPixel_L_d &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [51/80]

void Rx::CRxImage::GetPixel	(	TPixel_L_f &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [52/80]

void Rx::CRxImage::GetPixel	(	TPixel_L_i &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [53/80]

void Rx::CRxImage::GetPixel	(	TPixel_L_s &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [54/80]

void Rx::CRxImage::GetPixel	(	TPixel_L_uc &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [55/80]

void Rx::CRxImage::GetPixel	(	TPixel_L_ui &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [56/80]

void Rx::CRxImage::GetPixel	(	TPixel_L_us &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [57/80]

void Rx::CRxImage::GetPixel	(	TPixel_LA_c &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [58/80]

void Rx::CRxImage::GetPixel	(	TPixel_LA_d &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [59/80]

void Rx::CRxImage::GetPixel	(	TPixel_LA_f &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [60/80]

void Rx::CRxImage::GetPixel	(	TPixel_LA_i &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [61/80]

void Rx::CRxImage::GetPixel	(	TPixel_LA_s &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [62/80]

void Rx::CRxImage::GetPixel	(	TPixel_LA_uc &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [63/80]

void Rx::CRxImage::GetPixel	(	TPixel_LA_ui &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [64/80]

void Rx::CRxImage::GetPixel	(	TPixel_LA_us &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [65/80]

void Rx::CRxImage::GetPixel	(	TPixel_RGB_c &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [66/80]

void Rx::CRxImage::GetPixel	(	TPixel_RGB_d &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [67/80]

void Rx::CRxImage::GetPixel	(	TPixel_RGB_f &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [68/80]

void Rx::CRxImage::GetPixel	(	TPixel_RGB_i &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [69/80]

void Rx::CRxImage::GetPixel	(	TPixel_RGB_s &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [70/80]

void Rx::CRxImage::GetPixel	(	TPixel_RGB_uc &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [71/80]

void Rx::CRxImage::GetPixel	(	TPixel_RGB_ui &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [72/80]

void Rx::CRxImage::GetPixel	(	TPixel_RGB_us &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [73/80]

void Rx::CRxImage::GetPixel	(	TPixel_RGBA_c &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [74/80]

void Rx::CRxImage::GetPixel	(	TPixel_RGBA_d &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [75/80]

void Rx::CRxImage::GetPixel	(	TPixel_RGBA_f &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [76/80]

void Rx::CRxImage::GetPixel	(	TPixel_RGBA_i &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [77/80]

void Rx::CRxImage::GetPixel	(	TPixel_RGBA_s &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [78/80]

void Rx::CRxImage::GetPixel	(	TPixel_RGBA_uc &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [79/80]

void Rx::CRxImage::GetPixel	(	TPixel_RGBA_ui &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixel() [80/80]

void Rx::CRxImage::GetPixel	(	TPixel_RGBA_us &	xPix,
		int	iX,
		int	iY
	)		const

◆ GetPixelCount()

virtual unsigned Rx::CRxImage::GetPixelCount ( ) const

inlinevirtual

Gets the number of pixels.

Returns: The pixel count.

Implements Rx::Interop::Runtime28::IImage.

◆ GetSize()

virtual void Rx::CRxImage::GetSize	(	int &	iWidth,
		int &	iHeight
	)		const

inlinevirtual

Gets the size of the image.

Parameters

iWidth	[out] The width.
iHeight	[out] The height.

Implements Rx::Interop::Runtime28::IImage.

◆ GetTimestamp()

double Rx::CRxImage::GetTimestamp ( ) const

inline

Gets the timestamp of the image capture. Is 0.0 if this image has no timestamp.

Returns: The timestamp.

◆ GetType()

virtual void Rx::CRxImage::GetType	(	Interop::Runtime28::EPixelType::ID &	ePixelType,
		Interop::Runtime28::EDataType::ID &	eDataType
	)		const

inlinevirtual

Gets the type of the image.

Parameters

ePixelType	[out] The pixel type.
eDataType	[out] The data type.

Implements Rx::Interop::Runtime28::IImage.

◆ IsMoniker()

bool Rx::CRxImage::IsMoniker ( ) const

inline

Query if this image is a moniker.

A moniker holds an image data pointer but is not responsible for the memory. Thus, destroying an image moniker does not free the memory.

Returns: True if this image is a moniker, false if not.

◆ IsOfType()

bool Rx::CRxImage::IsOfType	(	Interop::Runtime28::EPixelType::ID	ePixelType,
		Interop::Runtime28::EDataType::ID	eDataType
	)		const

inline

Test whether image is of a particular pixel and data type.

Parameters

ePixelType	The pixel type.
eDataType	The data type.

Returns: True if of type, false if not.

◆ IsValid()

virtual bool Rx::CRxImage::IsValid ( ) const

inlinevirtual

Query if this image is valid.

Returns: True if valid, false if not.

Implements Rx::Interop::Runtime28::IImage.

◆ Normalize()

bool Rx::CRxImage::Normalize ( )

Find minimal and maximal value of image and normalize image to range [0,1].

Is currently only implemented for pixel type TPixel_L_f.

Returns: True if it succeeds, false if it fails.

◆ operator=() [1/2]

CRxImage& Rx::CRxImage::operator= ( const CRxImage & xImage )

Assignment operator. Copies the contents of the given image.

Parameters

xImage The image.

Returns: A shallow copy of this object.

◆ operator=() [2/2]

CRxImage& Rx::CRxImage::operator= ( CRxImage && xImage )

Move assignment operator.

Parameters

xImage [in] The image to move. This is invalid after the call.

Returns: A shallow copy of this object.

◆ Set()

bool Rx::CRxImage::Set ( const void * pvImgData )

Copies the content of the given image data into this image.

Expects that the image formats of the given data pointer and this image are identical.

Parameters

pvImgData The image data to copy.

Returns: True if it succeeds, false if it fails.

◆ SetID()

void Rx::CRxImage::SetID ( unsigned uID )

inline

Sets the ID of this image. Is used to represent images captured by a camera or read from a sequence.

Parameters

uID The ID.

◆ SetPixel() [1/80]

void Rx::CRxImage::SetPixel	(	const TPixel_Bay_BG_c &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [2/80]

void Rx::CRxImage::SetPixel	(	const TPixel_Bay_BG_d &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [3/80]

void Rx::CRxImage::SetPixel	(	const TPixel_Bay_BG_f &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [4/80]

void Rx::CRxImage::SetPixel	(	const TPixel_Bay_BG_i &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [5/80]

void Rx::CRxImage::SetPixel	(	const TPixel_Bay_BG_s &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [6/80]

void Rx::CRxImage::SetPixel	(	const TPixel_Bay_BG_uc &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [7/80]

void Rx::CRxImage::SetPixel	(	const TPixel_Bay_BG_ui &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [8/80]

void Rx::CRxImage::SetPixel	(	const TPixel_Bay_BG_us &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [9/80]

void Rx::CRxImage::SetPixel	(	const TPixel_Bay_GB_c &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [10/80]

void Rx::CRxImage::SetPixel	(	const TPixel_Bay_GB_d &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [11/80]

void Rx::CRxImage::SetPixel	(	const TPixel_Bay_GB_f &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [12/80]

void Rx::CRxImage::SetPixel	(	const TPixel_Bay_GB_i &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [13/80]

void Rx::CRxImage::SetPixel	(	const TPixel_Bay_GB_s &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [14/80]

void Rx::CRxImage::SetPixel	(	const TPixel_Bay_GB_uc &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [15/80]

void Rx::CRxImage::SetPixel	(	const TPixel_Bay_GB_ui &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [16/80]

void Rx::CRxImage::SetPixel	(	const TPixel_Bay_GB_us &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [17/80]

void Rx::CRxImage::SetPixel	(	const TPixel_Bay_GR_c &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [18/80]

void Rx::CRxImage::SetPixel	(	const TPixel_Bay_GR_d &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [19/80]

void Rx::CRxImage::SetPixel	(	const TPixel_Bay_GR_f &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [20/80]

void Rx::CRxImage::SetPixel	(	const TPixel_Bay_GR_i &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [21/80]

void Rx::CRxImage::SetPixel	(	const TPixel_Bay_GR_s &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [22/80]

void Rx::CRxImage::SetPixel	(	const TPixel_Bay_GR_uc &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [23/80]

void Rx::CRxImage::SetPixel	(	const TPixel_Bay_GR_ui &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [24/80]

void Rx::CRxImage::SetPixel	(	const TPixel_Bay_GR_us &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [25/80]

void Rx::CRxImage::SetPixel	(	const TPixel_Bay_RG_c &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [26/80]

void Rx::CRxImage::SetPixel	(	const TPixel_Bay_RG_d &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [27/80]

void Rx::CRxImage::SetPixel	(	const TPixel_Bay_RG_f &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [28/80]

void Rx::CRxImage::SetPixel	(	const TPixel_Bay_RG_i &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [29/80]

void Rx::CRxImage::SetPixel	(	const TPixel_Bay_RG_s &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [30/80]

void Rx::CRxImage::SetPixel	(	const TPixel_Bay_RG_uc &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [31/80]

void Rx::CRxImage::SetPixel	(	const TPixel_Bay_RG_ui &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [32/80]

void Rx::CRxImage::SetPixel	(	const TPixel_Bay_RG_us &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [33/80]

void Rx::CRxImage::SetPixel	(	const TPixel_BGR_c &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [34/80]

void Rx::CRxImage::SetPixel	(	const TPixel_BGR_d &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [35/80]

void Rx::CRxImage::SetPixel	(	const TPixel_BGR_f &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [36/80]

void Rx::CRxImage::SetPixel	(	const TPixel_BGR_i &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [37/80]

void Rx::CRxImage::SetPixel	(	const TPixel_BGR_s &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [38/80]

void Rx::CRxImage::SetPixel	(	const TPixel_BGR_uc &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [39/80]

void Rx::CRxImage::SetPixel	(	const TPixel_BGR_ui &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [40/80]

void Rx::CRxImage::SetPixel	(	const TPixel_BGR_us &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [41/80]

void Rx::CRxImage::SetPixel	(	const TPixel_BGRA_c &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [42/80]

void Rx::CRxImage::SetPixel	(	const TPixel_BGRA_d &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [43/80]

void Rx::CRxImage::SetPixel	(	const TPixel_BGRA_f &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [44/80]

void Rx::CRxImage::SetPixel	(	const TPixel_BGRA_i &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [45/80]

void Rx::CRxImage::SetPixel	(	const TPixel_BGRA_s &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [46/80]

void Rx::CRxImage::SetPixel	(	const TPixel_BGRA_uc &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [47/80]

void Rx::CRxImage::SetPixel	(	const TPixel_BGRA_ui &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [48/80]

void Rx::CRxImage::SetPixel	(	const TPixel_BGRA_us &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [49/80]

void Rx::CRxImage::SetPixel	(	const TPixel_L_c &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [50/80]

void Rx::CRxImage::SetPixel	(	const TPixel_L_d &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [51/80]

void Rx::CRxImage::SetPixel	(	const TPixel_L_f &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [52/80]

void Rx::CRxImage::SetPixel	(	const TPixel_L_i &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [53/80]

void Rx::CRxImage::SetPixel	(	const TPixel_L_s &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [54/80]

void Rx::CRxImage::SetPixel	(	const TPixel_L_uc &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [55/80]

void Rx::CRxImage::SetPixel	(	const TPixel_L_ui &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [56/80]

void Rx::CRxImage::SetPixel	(	const TPixel_L_us &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [57/80]

void Rx::CRxImage::SetPixel	(	const TPixel_LA_c &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [58/80]

void Rx::CRxImage::SetPixel	(	const TPixel_LA_d &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [59/80]

void Rx::CRxImage::SetPixel	(	const TPixel_LA_f &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [60/80]

void Rx::CRxImage::SetPixel	(	const TPixel_LA_i &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [61/80]

void Rx::CRxImage::SetPixel	(	const TPixel_LA_s &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [62/80]

void Rx::CRxImage::SetPixel	(	const TPixel_LA_uc &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [63/80]

void Rx::CRxImage::SetPixel	(	const TPixel_LA_ui &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [64/80]

void Rx::CRxImage::SetPixel	(	const TPixel_LA_us &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [65/80]

void Rx::CRxImage::SetPixel	(	const TPixel_RGB_c &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [66/80]

void Rx::CRxImage::SetPixel	(	const TPixel_RGB_d &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [67/80]

void Rx::CRxImage::SetPixel	(	const TPixel_RGB_f &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [68/80]

void Rx::CRxImage::SetPixel	(	const TPixel_RGB_i &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [69/80]

void Rx::CRxImage::SetPixel	(	const TPixel_RGB_s &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [70/80]

void Rx::CRxImage::SetPixel	(	const TPixel_RGB_uc &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [71/80]

void Rx::CRxImage::SetPixel	(	const TPixel_RGB_ui &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [72/80]

void Rx::CRxImage::SetPixel	(	const TPixel_RGB_us &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [73/80]

void Rx::CRxImage::SetPixel	(	const TPixel_RGBA_c &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [74/80]

void Rx::CRxImage::SetPixel	(	const TPixel_RGBA_d &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [75/80]

void Rx::CRxImage::SetPixel	(	const TPixel_RGBA_f &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [76/80]

void Rx::CRxImage::SetPixel	(	const TPixel_RGBA_i &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [77/80]

void Rx::CRxImage::SetPixel	(	const TPixel_RGBA_s &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [78/80]

void Rx::CRxImage::SetPixel	(	const TPixel_RGBA_uc &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [79/80]

void Rx::CRxImage::SetPixel	(	const TPixel_RGBA_ui &	xPix,
		int	iX,
		int	iY
	)

◆ SetPixel() [80/80]

void Rx::CRxImage::SetPixel	(	const TPixel_RGBA_us &	xPix,
		int	iX,
		int	iY
	)

◆ SetROIDefinition()

void Rx::CRxImage::SetROIDefinition ( const CRxImageFormat::TInt4 & piROIDefinition )

inline

Sets the ROI definition.

Parameters

piROIDefinition The ROI definition.

◆ SetTimestamp()

void Rx::CRxImage::SetTimestamp ( double dTimestamp )

inline

Sets the timestamp of the image capture.

Parameters

dTimestamp The timestamp.

◆ SetTimestampID()

void Rx::CRxImage::SetTimestampID	(	double	dTimestamp,
		unsigned	uID
	)

inline

Sets the timestamp and the ID of the image.

Parameters

dTimestamp	The timestamp.
uID	The ID. Is used to represent images captured by a camera or read from a sequence.

◆ SetZero()

void Rx::CRxImage::SetZero ( )

Sets the image data to contain only zeros.

◆ Swap()

void Rx::CRxImage::Swap ( CRxImage & xImage )

Swaps the data between this and the given image.

Parameters

xImage [in,out] The image to swap with.

Member Data Documentation

◆ m_bIsMoniker

bool Rx::CRxImage::m_bIsMoniker

protected

True if this image is only a moniker for an image data pointer. The memory is not freed in the destructor.

◆ m_dTimestamp

double Rx::CRxImage::m_dTimestamp

protected

The timestamp of the image capture. Is 0.0 if this image has no timestamp.

◆ m_pvData

void* Rx::CRxImage::m_pvData

protected

The actual image data.

◆ m_pxAllocator

IAllocator* Rx::CRxImage::m_pxAllocator

protected

The allocator.

◆ m_uID

unsigned Rx::CRxImage::m_uID

protected

The image ID. Is used to represent images captured by a camera or read from a sequence.

◆ m_xFormat

CRxImageFormat Rx::CRxImage::m_xFormat

protected

The format of this image.

Detailed Description

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ CRxImage() [1/6]

◆ CRxImage() [2/6]

◆ CRxImage() [3/6]

◆ CRxImage() [4/6]

◆ ~CRxImage()

◆ CRxImage() [5/6]

◆ CRxImage() [6/6]

Member Function Documentation

◆ _Convert()

◆ _ConvertSrcSwitch()

◆ _ConvertTrgSwitch()

◆ _GetPixel() [1/2]

◆ _GetPixel() [2/2]

◆ ConvertCustomType()

◆ ConvertMemory()

◆ ConvertType() [1/2]

◆ ConvertType() [2/2]

◆ Create() [1/6]

◆ Create() [2/6]

◆ Create() [3/6]

◆ Create() [4/6]

◆ Create() [5/6]

◆ Create() [6/6]

◆ CreateMoniker()

◆ Destroy()

◆ GetByteCount()

◆ GetBytesPerPixel()

◆ GetDataPtr() [1/2]

◆ GetDataPtr() [2/2]

◆ GetFormat()

◆ GetID()

◆ GetPixel() [1/80]

◆ GetPixel() [2/80]

◆ GetPixel() [3/80]

◆ GetPixel() [4/80]

◆ GetPixel() [5/80]

◆ GetPixel() [6/80]

◆ GetPixel() [7/80]

◆ GetPixel() [8/80]

◆ GetPixel() [9/80]

◆ GetPixel() [10/80]

◆ GetPixel() [11/80]

◆ GetPixel() [12/80]

◆ GetPixel() [13/80]

◆ GetPixel() [14/80]

◆ GetPixel() [15/80]

◆ GetPixel() [16/80]

◆ GetPixel() [17/80]

◆ GetPixel() [18/80]

◆ GetPixel() [19/80]

◆ GetPixel() [20/80]

◆ GetPixel() [21/80]

◆ GetPixel() [22/80]

◆ GetPixel() [23/80]

◆ GetPixel() [24/80]

◆ GetPixel() [25/80]

◆ GetPixel() [26/80]

◆ GetPixel() [27/80]

◆ GetPixel() [28/80]

◆ GetPixel() [29/80]

◆ GetPixel() [30/80]

◆ GetPixel() [31/80]

◆ GetPixel() [32/80]

◆ GetPixel() [33/80]

◆ GetPixel() [34/80]

◆ GetPixel() [35/80]

◆ GetPixel() [36/80]

◆ GetPixel() [37/80]

◆ GetPixel() [38/80]

◆ GetPixel() [39/80]

◆ GetPixel() [40/80]

◆ GetPixel() [41/80]

◆ GetPixel() [42/80]