Rx::LFR::Net::WavefrontCalibration Class Reference

Detailed Description

Provides methods to perform the wavefront calibration. In general a calibration would comprise:

• Initialize the calibrator
• Add images
• Calibrate
• Free

Inherits Rx::Net::NativeInterfaceWrapper< Rx::LFR::CWavefrontCalibration, Rx::LFR::Net::Interfaces::EWavefrontCalibration >.

Public Member Functions
	WavefrontCalibration ()
	Default constructor. More...
	~WavefrontCalibration ()
	Destructor. More...
void	AbortCalibration ()
	This will stop the calibration at the first possible position, which will lead to the best calibration result until then. More...
void	AddImage (Rx::Net::Image^ xSrcImg, System::String^ sComputationSettings)
	Adds an image. If more than one image is added to the calibration, they should all be the same regarding their orientation. Each image is added with their computation settings, which contains a possible ROI. More...
bool	Calibrate (Calibration^ xCalibration)
	Calibrates the Wavefront Parameters, the Aperture Dependent Matching Parameters and the MLA Residual Error Parameters. More...
void	Free ()
	Frees this object. More...
double	GetCalibrationResult (bool bVD)
	Gets the calibration result. More...
virtual System::Object ^	GetInterface (Rx::LFR::Net::Interfaces::EWavefrontCalibration eData)
	Gets the interface. More...
IParameters< Rx::LFR::Net::Params::EWavefrontCalibration > ^	GetParams ()
	Gets the parameters object for Rx.LFR.Net.Params.EWavefrontCalibration parameters. More...
void	Init ()
	Initializes this object. More...

Events
StatusMessageHandler^	StatusMessage [add, remove]
	Event queue for all listeners interested in StatusMessage events. More...

Constructor & Destructor Documentation

WavefrontCalibration()

Rx::LFR::Net::WavefrontCalibration::WavefrontCalibration ( )

inline

Default constructor.

~WavefrontCalibration()

Rx::LFR::Net::WavefrontCalibration::~WavefrontCalibration ( )

inline

Destructor.

Member Function Documentation

AbortCalibration()

void Rx::LFR::Net::WavefrontCalibration::AbortCalibration ( )

inline

This will stop the calibration at the first possible position, which will lead to the best calibration result until then.

AddImage()

void Rx::LFR::Net::WavefrontCalibration::AddImage ( Rx::Net::Image^  xSrcImg, System::String^  sComputationSettings  )

inline

Adds an image. If more than one image is added to the calibration, they should all be the same regarding their orientation. Each image is added with their computation settings, which contains a possible ROI.

Parameters

xSrcImg	[in,out] Source image.
sComputationSettings	[in,out] The computation settings.

Calibrate()

bool Rx::LFR::Net::WavefrontCalibration::Calibrate ( Calibration^  xCalibration )

inline

Calibrates the Wavefront Parameters, the Aperture Dependent Matching Parameters and the MLA Residual Error Parameters.

Parameters

xCalibration

[in,out] The calibration.

Returns

True if the calibration was a success, false if it fails.

Free()

void Rx::LFR::Net::WavefrontCalibration::Free ( )

inline

Frees this object.

GetCalibrationResult()

double Rx::LFR::Net::WavefrontCalibration::GetCalibrationResult ( bool  bVD )

inline

Gets the calibration result.

Parameters

bVD	True to get the VD error else the normalized residual will be returned.

Returns

The calibration result.

GetInterface()

virtual System::Object ^ Rx::Net::NativeInterfaceWrapper< Rx::LFR::CWavefrontCalibration , Rx::LFR::Net::Interfaces::EWavefrontCalibration >::GetInterface ( Rx::LFR::Net::Interfaces::EWavefrontCalibration  eData )

inlinevirtualinherited

Gets the interface.

Returns

The interface.

GetParams()

IParameters<Rx::LFR::Net::Params::EWavefrontCalibration> ^ Rx::LFR::Net::WavefrontCalibration::GetParams ( )

inline

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

Returns

The parameters object.

Init()

void Rx::LFR::Net::WavefrontCalibration::Init ( )

inline

Initializes this object.

Event Documentation

StatusMessage

StatusMessageHandler^ Rx::LFR::Net::WavefrontCalibration::StatusMessage

addremove

Event queue for all listeners interested in StatusMessage events.