Raytrix Light Field SDK  4.0
Logo
Public Member Functions | Protected Attributes | Properties | List of all members
Rx::LFR::Net::RayImage Class Reference

Detailed Description

Extends the default image class by a set of meta data and a calibration.

Inherits Rx::Net::NativeWrapperManagedExtender< Rx::LFR::CRayImage, Rx::Net::Image >.

Public Member Functions

 RayImage ()
 Default constructor. Does not allocate image memory. More...
 
void ConvertCustomType (Rx::Net::Image^ xTrgImg)
 Converts this image from a custom data type into the corresponding primitive data type. More...
 
ImageConvertType (InteropNet::Runtime28::EPixelType ePixelType, InteropNet::Runtime28::EDataType eDataType)
 
bool Create (int iWidth, int iHeight, EPixelType ePixelType, EDataType eDataType)
 Prepares memory. More...
 
virtual bool Create (System::Int32 iWidth, System::Int32 iHeight, InteropNet::Runtime28::EPixelType ePixelType, InteropNet::Runtime28::EDataType eDataType)
 Creates a new image and allocates memory necessary for given parameters. More...
 
virtual bool Create (Net::ImageFormat^ xFormat)
 Creates a new image and allocates memory necessary for the given image format. More...
 
virtual bool Destroy ()
 Destroys this image and frees all memory used. More...
 
virtual System::Int32 GetByteCount ()
 Get the number of bytes of the whole image. More...
 
virtual System::Int32 GetBytesPerPixel ()
 Gets the bytes per pixel. More...
 
CalibrationGetCalibration ()
 Gets the calibration. More...
 
virtual void * GetDataPtr ()
 Gets the data pointer. More...
 
Rx::Net::MetaData^ GetMetaData ()
 Gets the meta data. More...
 
Rx::LFR::CRayImageGetNative ()
 Gets the native. More...
 
virtual System::Int32 GetPixelCount ()
 Get the number of pixels. More...
 
virtual void GetSize (System::Int32^ %iWidth, System::Int32^ %iHeight)
 Get width and height of image. More...
 
virtual void GetType (InteropNet::Runtime28::EPixelType% ePixelType, InteropNet::Runtime28::EDataType% eDataType)
 Get pixel and data type of image. More...
 
bool IsOfType (InteropNet::Runtime28::EPixelType ePixelType, InteropNet::Runtime28::EDataType eDataType)
 Test whether image is of a particular pixel and data type. More...
 
bool Normalize ()
 Find minimal and maximal value of image and normalize image to range [0,1]. More...
 
void SetTimestampID (double dTimestamp, unsigned uID)
 Sets the timestamp and the ID of the image. More...
 
void SetZero ()
 

Protected Attributes

Rx::LFR::CRayImagem_pxNativeInstance
 The pointer to the native instance. More...
 

Properties

InteropNet::Runtime28::EDataType DataType [get]
 Gets the type of the data. More...
 
Net::ImageFormat^  Format [get]
 Gets the format of this image. More...
 
System::Int32 Height [get]
 Gets the height of this image in pixels. More...
 
unsigned ID [get, set]
 Gets or sets the ID of this image. More...
 
System::Boolean IsValid [get]
 Flags whether this image is valid or not. More...
 
InteropNet::Runtime28::EPixelType PixelType [get]
 Gets the type of the pixel. More...
 
double Timestamp [get, set]
 Gets or sets the timestamp of the image capture. Is 0.0 if this image has no timestamp. More...
 
System::Int32 Width [get]
 Gets the width of this image in pixels. More...
 

Constructor & Destructor Documentation

Rx::LFR::Net::RayImage::RayImage ( )
inline

Default constructor. Does not allocate image memory.

Member Function Documentation

void Rx::Net::Image::ConvertCustomType ( Rx::Net::Image xTrgImg)
inlineinherited

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.
Image ^ Rx::Net::Image::ConvertType ( InteropNet::Runtime28::EPixelType  ePixelType,
InteropNet::Runtime28::EDataType  eDataType 
)
inherited
bool Rx::InteropNet::Runtime28::IImage::Create ( int  iWidth,
int  iHeight,
EPixelType  ePixelType,
EDataType  eDataType 
)
inherited

Prepares memory.

Parameters
iWidthThe width.
iHeightThe height.
ePixelTypeIdentifier for the image type.
eDataTypeIdentifier for the data type.
Returns
True if it succeeds, false if it fails.
virtual bool Rx::Net::Image::Create ( System::Int32  iWidth,
System::Int32  iHeight,
InteropNet::Runtime28::EPixelType  ePixelType,
InteropNet::Runtime28::EDataType  eDataType 
)
virtualinherited

Creates a new image and allocates memory necessary for given parameters.

If an image has been created before, the old image and all used memory is freed before creating the new image.

Parameters
iWidthZero-based index of the width.
iHeightZero-based index of the height.
ePixelTypeType of the image.
eDataTypeType of the data.
Returns
True if it succeeds, false if it fails.
virtual bool Rx::Net::Image::Create ( Net::ImageFormat xFormat)
virtualinherited

Creates a new image and allocates memory necessary for the given image format.

If an image has been created before, the old image and all used memory is freed before creating the new image.

Parameters
xFormat[in] The image format.
Returns
True if it succeeds, false if it fails.
virtual bool Rx::Net::Image::Destroy ( )
virtualinherited

Destroys this image and frees all memory used.

Returns
True if it succeeds, false if it fails.

Implements Rx::InteropNet::Runtime28::IImage.

virtual System::Int32 Rx::Net::Image::GetByteCount ( )
inlinevirtualinherited

Get the number of bytes of the whole image.

virtual System::Int32 Rx::Net::Image::GetBytesPerPixel ( )
virtualinherited

Gets the bytes per pixel.

Returns
The bytes per pixel.

Implements Rx::InteropNet::Runtime28::IImage.

Calibration ^ Rx::LFR::Net::RayImage::GetCalibration ( )
inline

Gets the calibration.

Returns
The calibration.
virtual void* Rx::Net::Image::GetDataPtr ( )
virtualinherited

Gets the data pointer.

Returns
null if it fails, else the data pointer.

Implements Rx::InteropNet::Runtime28::IImage.

Rx::Net::MetaData ^ Rx::LFR::Net::RayImage::GetMetaData ( )
inline

Gets the meta data.

Returns
The meta data.

Gets the native.

Returns
The native.
virtual System::Int32 Rx::Net::Image::GetPixelCount ( )
inlinevirtualinherited

Get the number of pixels.

virtual void Rx::Net::Image::GetSize ( System::Int32^ %  iWidth,
System::Int32^ %  iHeight 
)
inlinevirtualinherited

Get width and height of image.

virtual void Rx::Net::Image::GetType ( InteropNet::Runtime28::EPixelType ePixelType,
InteropNet::Runtime28::EDataType eDataType 
)
inlinevirtualinherited

Get pixel and data type of image.

bool Rx::Net::Image::IsOfType ( InteropNet::Runtime28::EPixelType  ePixelType,
InteropNet::Runtime28::EDataType  eDataType 
)
inlineinherited

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

bool Rx::Net::Image::Normalize ( )
inlineinherited

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

Attention
Is currently only implemented for pixel type TPixel_L_f.
void Rx::Net::Image::SetTimestampID ( double  dTimestamp,
unsigned  uID 
)
inlineinherited

Sets the timestamp and the ID of the image.

Parameters
dTimestampThe timestamp.
uIDThe ID.
void Rx::Net::Image::SetZero ( )
inlineinherited

Member Data Documentation

The pointer to the native instance.

Property Documentation

InteropNet:: Runtime28:: EDataType Rx::Net::Image::DataType
getinherited

Gets the type of the data.

Net:: ImageFormat^ Rx::Net::Image::Format
getinherited

Gets the format of this image.

System:: Int32 Rx::Net::Image::Height
getinherited

Gets the height of this image in pixels.

unsigned Rx::Net::Image::ID
getsetinherited

Gets or sets the ID of this image.

System:: Boolean Rx::Net::Image::IsValid
getinherited

Flags whether this image is valid or not.

An image is valid if memory has been allocated.

InteropNet:: Runtime28:: EPixelType Rx::Net::Image::PixelType
getinherited

Gets the type of the pixel.

double Rx::Net::Image::Timestamp
getsetinherited

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

System:: Int32 Rx::Net::Image::Width
getinherited

Gets the width of this image in pixels.