Raytrix Light Field SDK  5.0
Rx::LFR::Net::Calibration Class Reference

Detailed Description

Defines a single camera or ray image calibration, including a possible gray image.

Inherits Rx::Net::NativeInterfaceWrapper< Rx::LFR::CCalibration, Rx::LFR::Net::Interfaces::ECalib >.

Public Member Functions

 Calibration ()
 Default constructor. Creates an uninitialized calibration. Call SetToDefault to initialize it. More...
 
 Calibration (Rx::LFR::CCalibration &xNative)
 Constructor. More...
 
 ~Calibration ()
 Default Destructor. More...
 
const void * GetCameraFormat ()
 Gets the pointer to the internal camera format. Only for internal purposes. More...
 
Rx::Net::ImageGetGrayImage ()
 Gets the gray image. The gray image is invalid if this calibration has no gray image. More...
 
void GetGridData (RX_OUT array< double, 2 >^ % adLensData2D, bool bMLI)
 Gets the grid data of this calibration. More...
 
virtual System::Object ^ GetInterface (Rx::LFR::Net::Interfaces::ECalib eData)
 Gets the interface. More...
 
IParameters< Rx::LFR::Net::Params::ECalib > ^ GetParams ()
 Gets the parameters object for Rx.LFR.Net.Params.ECalib parameters. More...
 
bool HasGrayImage ()
 Queries if this calibration has a gray image. More...
 
void SaveAsXmlFile (System::String^ sFilename)
 Saves some details of this calibration as a XML file. More...
 
void SaveAsXmlString (RX_OUT System::String^ % sXml)
 Saves some details of this calibration as a XML string. More...
 
void SetCameraFormat (const void *pvData)
 Sets the camera format by using pointer. Only for internal purposes. More...
 
void SetGrayImage (Rx::Net::Image^ xImg)
 Sets the given image as the gray image. This copies the given image into this calibration. More...
 
void SetGrayImage (Rx::Net::Image^ xImg, bool bMove)
 Sets the given image as the gray image. This moves or copies the given image into this calibration. More...
 
void SetToDefault (int iHeightPX, int iWidthPX)
 Sets this calibration to default. All applied parameters are reset. The gray image is not affected. More...
 

Constructor & Destructor Documentation

◆ Calibration() [1/2]

Rx::LFR::Net::Calibration::Calibration ( )
inline

Default constructor. Creates an uninitialized calibration. Call SetToDefault to initialize it.

◆ Calibration() [2/2]

Rx::LFR::Net::Calibration::Calibration ( Rx::LFR::CCalibration xNative)
inline

Constructor.

Wraps the given native instance instead of creating an own instance. The given native instance must be valid for the lifetime of this instance.

Parameters
xNative[in] The native instance to be wrapped by this class.

◆ ~Calibration()

Rx::LFR::Net::Calibration::~Calibration ( )
inline

Default Destructor.

Member Function Documentation

◆ GetCameraFormat()

const void* Rx::LFR::Net::Calibration::GetCameraFormat ( )
inline

Gets the pointer to the internal camera format. Only for internal purposes.

Returns
The pointer to the internal camera format.

◆ GetGrayImage()

Rx::Net::Image ^ Rx::LFR::Net::Calibration::GetGrayImage ( )
inline

Gets the gray image. The gray image is invalid if this calibration has no gray image.

Returns
The gray image.

◆ GetGridData()

void Rx::LFR::Net::Calibration::GetGridData ( RX_OUT array< double, 2 >^ %  adLensData2D,
bool  bMLI 
)
inline

Gets the grid data of this calibration.

The grid data is a 2D vector of lens information. For each lens on the grid exists a four component entry with the following values:

  • 1. X position of the lens center given in pixels on the PXA
  • 2. Y position of the lens center given in pixels on the PXA
  • 3. The effective radius of the lens
  • 4. The lens type of the lens.
Parameters
adLensData2D[out] The 2D lens information vector.
bMLI[in] True to get the MLI grid. False to get the MLA grid.

◆ GetInterface()

virtual System::Object ^ Rx::Net::NativeInterfaceWrapper< Rx::LFR::CCalibration , Rx::LFR::Net::Interfaces::ECalib >::GetInterface ( Rx::LFR::Net::Interfaces::ECalib  eData)
inlinevirtualinherited

Gets the interface.

Returns
The interface.

◆ GetParams()

IParameters<Rx::LFR::Net::Params::ECalib> ^ Rx::LFR::Net::Calibration::GetParams ( )
inline

Gets the parameters object for Rx.LFR.Net.Params.ECalib parameters.

Returns
The parameters object.

◆ HasGrayImage()

bool Rx::LFR::Net::Calibration::HasGrayImage ( )
inline

Queries if this calibration has a gray image.

Returns
True if this calibration has a gray image, false if not.

◆ SaveAsXmlFile()

void Rx::LFR::Net::Calibration::SaveAsXmlFile ( System::String^  sFilename)
inline

Saves some details of this calibration as a XML file.

Parameters
sFilename[in] The file name.

◆ SaveAsXmlString()

void Rx::LFR::Net::Calibration::SaveAsXmlString ( RX_OUT System::String^ %  sXml)
inline

Saves some details of this calibration as a XML string.

Parameters
sXml[out] The XML string.

◆ SetCameraFormat()

void Rx::LFR::Net::Calibration::SetCameraFormat ( const void *  pvData)
inline

Sets the camera format by using pointer. Only for internal purposes.

Parameters
pvData[in] The pointer to the camera format to set.

◆ SetGrayImage() [1/2]

void Rx::LFR::Net::Calibration::SetGrayImage ( Rx::Net::Image xImg)
inline

Sets the given image as the gray image. This copies the given image into this calibration.

Parameters
xImg[in] The gray image.

◆ SetGrayImage() [2/2]

void Rx::LFR::Net::Calibration::SetGrayImage ( Rx::Net::Image xImg,
bool  bMove 
)
inline

Sets the given image as the gray image. This moves or copies the given image into this calibration.

Parameters
xImg[in] The gray image. Is invalid after this call if bMove is true.
bMove[in] True to move the image; false to copy the image.

◆ SetToDefault()

void Rx::LFR::Net::Calibration::SetToDefault ( int  iHeightPX,
int  iWidthPX 
)
inline

Sets this calibration to default. All applied parameters are reset. The gray image is not affected.

Parameters
iHeightPXThe height of the camera sensor in pixels.
iWidthPXThe width of the camera sensor in pixels.