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

Detailed Description

Provides methods for managing camera calibrations. This includes creating, loading and saving.

Static Public Member Functions

static System::String ^ CreateCalibration (Camera^ xCamera)
 Creates a new calibration and assigns it to the given camera. More...
 
static System::String ^ CreateCalibration (System::String^ sCamHardwareID)
 Creates a new calibration and assigns it to the given camera (defined by hardware ID). More...
 
static System::String ^ CreateCalibration (System::String^ sCamType, System::String^ sCamSerial)
 Creates a new calibration and assigns it to the given camera (defined by type and serial). More...
 
static void CreateDatabase (Camera^ xCamera, bool bForce)
 Creates a calibration database for the given camera. More...
 
static void CreateDatabase (System::String^ sCamHardwareID, bool bForce)
 Creates a calibration database for the given camera (defined by hardware ID). More...
 
static void CreateDatabase (System::String^ sCamType, System::String^ sCamSerial, bool bForce)
 Creates a calibration database for the given camera (defined by type and serial). More...
 
static void DeleteCalibration (System::String^ sGUID)
 Deletes the calibration with the given GUID. More...
 
static array< System::String^> ^ GetCalibrationGUIDs ()
 Gets an array of GUIDs from all calibrations. More...
 
static array< System::String^> ^ GetCalibrationGUIDs (Camera^ xCamera)
 Gets an array of GUIDs from all calibrations of the given camera. More...
 
static void GetCalibrationGUIDs (RX_OUT array< System::String^>^ % asGUIDs)
 Gets an array of GUIDs from all calibrations. More...
 
static void GetCalibrationGUIDs (RX_OUT array< System::String^>^ % asGUIDs, Camera^ xCamera)
 Gets an array of GUIDs from all calibrations of the given camera. More...
 
static System::String ^ GetCameraName (Camera^ xCamera)
 Gets the Raytrix name of the given camera. More...
 
static System::String ^ GetCameraSerial (Camera^ xCamera)
 Gets the Raytrix serial of the given camera. More...
 
static System::String ^ GetDefaultCalibrationGUID (Camera^ xCamera)
 Gets the GUID of the default calibration of the given camera. More...
 
static System::String ^ GetDefaultCalibrationGUID (System::String^ sSerial, System::String^ sDriver)
 Gets the GUID of the default calibration of the given camera defined by the camera serial and the driver name. More...
 
static System::Object ^ GetInterface (Interfaces::ECalibManager eData)
 Gets the interface defined by ELightFieldRuntimeInterface. More...
 
static System::String ^ GetMasterCalibrationGUID (Camera^ xCamera)
 Gets the GUID of the master calibration of the given camera. More...
 
static System::String ^ GetMasterCalibrationGUID (System::String^ sSerial, System::String^ sDriver)
 Gets the GUID of the master calibration of the given camera defined by the camera serial and the driver name. More...
 
static void GetMasterCalibrationGUIDs (RX_OUT array< System::String^>^ % asGUIDs)
 Gets an array of GUIDs from all master calibrations. Each camera has a single master calibration. More...
 
static void GetMetaData (RX_OUT Rx::Net::CalibMetaData^ % xData, System::String^ sGUID)
 Gets the calibration meta data of the given calibration. More...
 
static Rx::Net::CalibMetaDataGetMetaData (System::String^ sGUID)
 Gets the calibration meta data of the given calibration. More...
 
static bool HasDatabase (Camera^ xCamera)
 Queries if there is a calibration database for the given camera. More...
 
static void Initialize ()
 Initializes this calibration manager and reads all calibrations from disk. More...
 
static void Initialize (System::String^ sFolder)
 Initializes this calibration manager and reads all calibrations from disk. More...
 
static void LoadCalibration (Calibration^ xCalib, System::String^ sGUID, bool bLoadGrayImg)
 Loads the calibration with the given GUID. More...
 
static void LoadDefaultCalibration (Calibration^ xCalib, Camera^ xCamera, bool bLoadGrayImg)
 Loads the default calibration of the given camera. More...
 
static void LoadDefaultCalibration (Calibration^ xCalib, System::String^ sCameraSerial, System::String^ sDriverName, bool bLoadGrayImg)
 Loads the default calibration of the given camera defined by the camera serial and the driver name. More...
 
static void PatchCalibration (System::String^ sGUID)
 Patch the calibration given by its GUID, by overwriting required values to valid ones. More...
 
static void SaveCalibration (Calibration^ xCalib, System::String^ sGUID, bool bSaveGrayImg)
 Saves the given calibration to disk. More...
 
static void SetCameraName (Camera^ xCamera, System::String^ sName)
 Sets the Raytrix name of the given camera. Requires Dongle::ERuntimeFeature::Master. More...
 
static void SetCameraSerial (Camera^ xCamera, System::String^ sSerial)
 Sets the Raytrix serial of the given camera. Requires Dongle::ERuntimeFeature::Master. More...
 
static void SetMetaData (Rx::Net::CalibMetaData^ xData, System::String^ sGUID)
 Sets the calibration meta data of the given calibration. The meta data of the master calibration cannot be set. More...
 

Protected Member Functions

 CalibrationManager ()
 Default constructor. More...
 
 ~CalibrationManager ()
 Default Destructor. More...
 

Constructor & Destructor Documentation

◆ CalibrationManager()

Rx::LFR::Net::CalibrationManager::CalibrationManager ( )
inlineprotected

Default constructor.

◆ ~CalibrationManager()

Rx::LFR::Net::CalibrationManager::~CalibrationManager ( )
inlineprotected

Default Destructor.

Member Function Documentation

◆ CreateCalibration() [1/3]

static System::String ^ Rx::LFR::Net::CalibrationManager::CreateCalibration ( Camera xCamera)
inlinestatic

Creates a new calibration and assigns it to the given camera.

Requires Dongle::ERuntimeFeature::Save to save this change permanently.

Parameters
xCamera[in] The camera.
Returns
The GUID of the created calibration.

◆ CreateCalibration() [2/3]

static System::String ^ Rx::LFR::Net::CalibrationManager::CreateCalibration ( System::String^  sCamHardwareID)
inlinestatic

Creates a new calibration and assigns it to the given camera (defined by hardware ID).

Requires Dongle::ERuntimeFeature::Save to save this change permanently.

Parameters
sCamHardwareID[in] The camera hardware ID. This is 'TypeA_012' for type A cameras with serial 012.
Returns
The GUID of the created calibration.

◆ CreateCalibration() [3/3]

static System::String ^ Rx::LFR::Net::CalibrationManager::CreateCalibration ( System::String^  sCamType,
System::String^  sCamSerial 
)
inlinestatic

Creates a new calibration and assigns it to the given camera (defined by type and serial).

Requires Dongle::ERuntimeFeature::Save to save this change permanently.

Parameters
sCamType[in] The camera type. This is 'TypeA' for type A cameras.
sCamSerial[in] The camera serial.
Returns
The GUID of the created calibration.

◆ CreateDatabase() [1/3]

static void Rx::LFR::Net::CalibrationManager::CreateDatabase ( Camera xCamera,
bool  bForce 
)
inlinestatic

Creates a calibration database for the given camera.

Requires Dongle::ERuntimeFeature::Master.

Parameters
xCamera[in] The camera.
bForce[in] True to enforce the creation even if the calibration already exists. Otherwise an exception is thrown.

◆ CreateDatabase() [2/3]

static void Rx::LFR::Net::CalibrationManager::CreateDatabase ( System::String^  sCamHardwareID,
bool  bForce 
)
inlinestatic

Creates a calibration database for the given camera (defined by hardware ID).

Requires Dongle::ERuntimeFeature::Master.

Parameters
sCamHardwareID[in] The camera hardware ID. This is 'TypeA_012' for type A cameras with serial 012.
bForce[in] True to enforce the creation even if the calibration already exists. Otherwise an exception is thrown.

◆ CreateDatabase() [3/3]

static void Rx::LFR::Net::CalibrationManager::CreateDatabase ( System::String^  sCamType,
System::String^  sCamSerial,
bool  bForce 
)
inlinestatic

Creates a calibration database for the given camera (defined by type and serial).

Requires Dongle::ERuntimeFeature::Master.

Parameters
sCamType[in] The camera type. This is 'TypeA' for type A cameras.
sCamSerial[in] The camera serial.
bForce[in] True to enforce the creation even if the calibration already exists. Otherwise an exception is thrown.

◆ DeleteCalibration()

static void Rx::LFR::Net::CalibrationManager::DeleteCalibration ( System::String^  sGUID)
inlinestatic

Deletes the calibration with the given GUID.

Requires Dongle::ERuntimeFeature::Save to save this change permanently.

Parameters
sGUID[in] The GUID of the calibration.

◆ GetCalibrationGUIDs() [1/4]

static array<System::String^> ^ Rx::LFR::Net::CalibrationManager::GetCalibrationGUIDs ( )
inlinestatic

Gets an array of GUIDs from all calibrations.

Returns
The GUIDs array.

◆ GetCalibrationGUIDs() [2/4]

static array<System::String^> ^ Rx::LFR::Net::CalibrationManager::GetCalibrationGUIDs ( Camera xCamera)
inlinestatic

Gets an array of GUIDs from all calibrations of the given camera.

Parameters
xCamera[in] The camera.
Returns
The GUIDs array.

◆ GetCalibrationGUIDs() [3/4]

static void Rx::LFR::Net::CalibrationManager::GetCalibrationGUIDs ( RX_OUT array< System::String^>^ %  asGUIDs)
inlinestatic

Gets an array of GUIDs from all calibrations.

Parameters
asGUIDs[out] The GUIDs array.

◆ GetCalibrationGUIDs() [4/4]

static void Rx::LFR::Net::CalibrationManager::GetCalibrationGUIDs ( RX_OUT array< System::String^>^ %  asGUIDs,
Camera xCamera 
)
inlinestatic

Gets an array of GUIDs from all calibrations of the given camera.

Parameters
asGUIDs[out] The GUIDs array.
xCamera[in] The camera.

◆ GetCameraName()

static System::String ^ Rx::LFR::Net::CalibrationManager::GetCameraName ( Camera xCamera)
inlinestatic

Gets the Raytrix name of the given camera.

Parameters
xCamera[in] The camera.
Returns
The Raytrix camera name.

◆ GetCameraSerial()

static System::String ^ Rx::LFR::Net::CalibrationManager::GetCameraSerial ( Camera xCamera)
inlinestatic

Gets the Raytrix serial of the given camera.

Parameters
xCamera[in] The camera.
Returns
The Raytrix camera serial.

◆ GetDefaultCalibrationGUID() [1/2]

static System::String ^ Rx::LFR::Net::CalibrationManager::GetDefaultCalibrationGUID ( Camera xCamera)
inlinestatic

Gets the GUID of the default calibration of the given camera.

The default calibration is a calibration that has been set as default by calling SetMetaData with a CalibMetaData that has the IsDefaultCalib flag set to true. By default an internal master calibration is the default one.

Parameters
xCamera[in] The camera, from which the callibration GUID is recieved.
Returns
The GUID of the default calibration.

◆ GetDefaultCalibrationGUID() [2/2]

static System::String ^ Rx::LFR::Net::CalibrationManager::GetDefaultCalibrationGUID ( System::String^  sSerial,
System::String^  sDriver 
)
inlinestatic

Gets the GUID of the default calibration of the given camera defined by the camera serial and the driver name.

The default calibration is a calibration that has been set as default by calling SetMetaData with a CalibMetaData that has the IsDefaultCalib flag set to true. By default an internal master calibration is the default one.

Parameters
sSerial[in] The serial of the camera.
sDriver[in] The driver name of the camera.
Returns
The GUID of the default calibration.

◆ GetInterface()

static System::Object ^ Rx::LFR::Net::CalibrationManager::GetInterface ( Interfaces::ECalibManager  eData)
inlinestatic

Gets the interface defined by ELightFieldRuntimeInterface.

Parameters
eDataThe interface type.

◆ GetMasterCalibrationGUID() [1/2]

static System::String ^ Rx::LFR::Net::CalibrationManager::GetMasterCalibrationGUID ( Camera xCamera)
inlinestatic

Gets the GUID of the master calibration of the given camera.

Parameters
xCamera[in] The camera.
Returns
The GUID of the master calibration.

◆ GetMasterCalibrationGUID() [2/2]

static System::String ^ Rx::LFR::Net::CalibrationManager::GetMasterCalibrationGUID ( System::String^  sSerial,
System::String^  sDriver 
)
inlinestatic

Gets the GUID of the master calibration of the given camera defined by the camera serial and the driver name.

Parameters
sSerial[in] The serial of the camera.
sDriver[in] The driver name of the camera.
Returns
The GUID of the master calibration.

◆ GetMasterCalibrationGUIDs()

static void Rx::LFR::Net::CalibrationManager::GetMasterCalibrationGUIDs ( RX_OUT array< System::String^>^ %  asGUIDs)
inlinestatic

Gets an array of GUIDs from all master calibrations. Each camera has a single master calibration.

Parameters
asGUIDs[out] The GUIDs array.

◆ GetMetaData() [1/2]

static void Rx::LFR::Net::CalibrationManager::GetMetaData ( RX_OUT Rx::Net::CalibMetaData^ %  xData,
System::String^  sGUID 
)
inlinestatic

Gets the calibration meta data of the given calibration.

Parameters
xData[out] The meta data.
sGUID[in] The GUID of the calibration.

◆ GetMetaData() [2/2]

static Rx::Net::CalibMetaData ^ Rx::LFR::Net::CalibrationManager::GetMetaData ( System::String^  sGUID)
inlinestatic

Gets the calibration meta data of the given calibration.

Parameters
sGUID[in] The GUID of the calibration.
Returns
The meta data.

◆ HasDatabase()

static bool Rx::LFR::Net::CalibrationManager::HasDatabase ( Camera xCamera)
inlinestatic

Queries if there is a calibration database for the given camera.

Parameters
xCamera[in] The camera.
Returns
True if a database for the given camera exists, false if not.

◆ Initialize() [1/2]

static void Rx::LFR::Net::CalibrationManager::Initialize ( )
inlinestatic

Initializes this calibration manager and reads all calibrations from disk.

You don't need to call this method. It's called automatically on the first access. But you can call it if you want to change the calibration folder or if you want to initialize this class at a certain time.

◆ Initialize() [2/2]

static void Rx::LFR::Net::CalibrationManager::Initialize ( System::String^  sFolder)
inlinestatic

Initializes this calibration manager and reads all calibrations from disk.

You don't need to call this method. It's called automatically on the first access. But you can call it if you want to change the calibration folder or if you want to initialize this class at a certain time.

Parameters
sFolder[in] The folder that holds the calibrations. If empty, the default folder is used.

◆ LoadCalibration()

static void Rx::LFR::Net::CalibrationManager::LoadCalibration ( Calibration xCalib,
System::String^  sGUID,
bool  bLoadGrayImg 
)
inlinestatic

Loads the calibration with the given GUID.

Parameters
xCalib[out] The loaded calibration.
sGUID[in] The GUID of the calibration.
bLoadGrayImg[in] True to load the gray image from disk. The image is invalid if there isn't a gray image. False to keep the gray image of the given calibration.

◆ LoadDefaultCalibration() [1/2]

static void Rx::LFR::Net::CalibrationManager::LoadDefaultCalibration ( Calibration xCalib,
Camera xCamera,
bool  bLoadGrayImg 
)
inlinestatic

Loads the default calibration of the given camera.

The default calibration is a calibration that has been set as default by calling SetMetaData with a CalibMetaData that has the IsDefaultCalib flag set to true. By default an internal master calibration is the default one.

Parameters
xCalib[out] The loaded calibration.
xCamera[in] The camera.
bLoadGrayImg[in] True to load the gray image from disk. The image is invalid if there isn't a gray image. False to keep the gray image of the given calibration.

◆ LoadDefaultCalibration() [2/2]

static void Rx::LFR::Net::CalibrationManager::LoadDefaultCalibration ( Calibration xCalib,
System::String^  sCameraSerial,
System::String^  sDriverName,
bool  bLoadGrayImg 
)
inlinestatic

Loads the default calibration of the given camera defined by the camera serial and the driver name.

The default calibration is a calibration that has been set as default by calling SetMetaData with a CalibMetaData that has the IsDefaultCalib flag set to true. By default an internal master calibration is the default one.

Parameters
xCalib[out] The loaded calibration.
sCameraSerial[in] The camera serial.
sDriverName[in] The driver name.
bLoadGrayImg[in] True to load the gray image from disk. The image is invalid if there isn't a gray image. False to keep the gray image of the given calibration.

◆ PatchCalibration()

static void Rx::LFR::Net::CalibrationManager::PatchCalibration ( System::String^  sGUID)
inlinestatic

Patch the calibration given by its GUID, by overwriting required values to valid ones.

Requires Dongle::ERuntimeFeature::Save to save this change permanently.

Parameters
sGUID[in] The GUID of the calibration.

◆ SaveCalibration()

static void Rx::LFR::Net::CalibrationManager::SaveCalibration ( Calibration xCalib,
System::String^  sGUID,
bool  bSaveGrayImg 
)
inlinestatic

Saves the given calibration to disk.

Requires Dongle::ERuntimeFeature::Save to save this change permanently.

Parameters
xCalib[in] The calibration.
sGUID[in] The GUID of the calibration.
bSaveGrayImg[in] True to save the gray image to disk. Throws an exception if the gray image is invalid. False to keep the current gray image.

◆ SetCameraName()

static void Rx::LFR::Net::CalibrationManager::SetCameraName ( Camera xCamera,
System::String^  sName 
)
inlinestatic

Sets the Raytrix name of the given camera. Requires Dongle::ERuntimeFeature::Master.

Parameters
xCamera[in] The camera.
sName[in] The name.

◆ SetCameraSerial()

static void Rx::LFR::Net::CalibrationManager::SetCameraSerial ( Camera xCamera,
System::String^  sSerial 
)
inlinestatic

Sets the Raytrix serial of the given camera. Requires Dongle::ERuntimeFeature::Master.

Parameters
xCamera[in] The camera.
sSerial[in] The name.

◆ SetMetaData()

static void Rx::LFR::Net::CalibrationManager::SetMetaData ( Rx::Net::CalibMetaData xData,
System::String^  sGUID 
)
inlinestatic

Sets the calibration meta data of the given calibration. The meta data of the master calibration cannot be set.

Requires Dongle::ERuntimeFeature::Save to save this change permanently.

Parameters
xData[in] The meta data.
sGUID[in] The GUID of the calibration.