Writes the application details to the meta data.
[in,out] Name of the application.
[in,out] The application version.
Updates the meta data from a calibration meta data instance.
[in,out] Information describing the calib meta.
Updates the meta data from a camera instance.
[in,out] The camera.
Updates the meta data from a CUDA compute instance.
[in,out] The CUDA compute instance.
Destructor.
Default constructor. Does not allocate image memory.
Extends the default image class by a set of meta data and a calibration.
Gets the total number of devices.
The device count.
Gets IDevice with given ID.
Zero-based ID of the device.
null if it fails, else the device.
Releases the driver DLLs and destroys all cameras.
Searches for all cameras.
[in] Full path to device driver files.
The found cameras.
Searches for the first cameras.
The found cameras.
Sets a string that activates a find filter in the FindCameras method.
By default the FindCameras method searches for all cameras (empty string). If you want to find only cameras of a
certain type you can provide a filter here.
Examples:
- Find only type A cameras: "TypeA"
- Find only type A and type D cameras: "TypeA;TypeD".
[in] The filter string.
The callback wrapper.
Event queue for all listeners interested in StatusMessage events.
Default constructor.
A camera server.
Move assignment operator.
[in,out]The camera server.
The instance.
Removes the given status message callback function.
Does nothing if the given function pointer has not been added to the list of callbacks.
The callback function to remove.
Adds the given status message callback function to the internal list of callbacks.
Adding the same function pointer twice will only update the given context pointer. This prevents multiple adds of the
same callback function.
The callback function.
[in] The callback context. Can be any pointer that is passed to the callback function.
Gets the total number of devices.
The device count.
Gets IDevice with given ID.
Zero-based ID of the device.
null if it fails, else the device.
Releases the driver DLLs and destroys all cameras.
Searches for all cameras.
(Optional) Full path to device driver files.
The number of found cameras.
Sets a string that activates a find filter in the FindCameras method.
By default the FindCameras method searches for all cameras (empty string). If you want to find only cameras of a
certain type you can provide a filter here.
Examples:
- Find only type A cameras: "TypeA"
- Find only type A and type D cameras: "TypeA;TypeD"
The filter string.
Destructor.
Move constructor.
[in,out]The camera server instance.
Default constructor.
The camera server.
The parameters access class.
The callback wrapper.
Event queue for all listeners interested in StatusMessage events.
Gets the parameters access interface.
The parameters access interface.
Enables the selected test models for the calibration.
[in,out] List of identifiers for the test models.
Removes the models of the object given by its object id from the calibration set. Changes the result information
related to this object id. You can receive the information of an object by calling
Rx::LFR::CApiLF::RxMetricCalibGetAddImageResult.
Identifier for the object.
Project 2D points into another space defined by eSpace.
[in,out] The matrix points 2D.
[in,out] The depth image.
[in,out] The matrix of 3D points.
The target space.
Finds ellipses in the given image.
An ellipses is structured as follows:
- Center X
- Center Y
- First Direction X
- First Direction Y
- Second Direction X
- Second Direction Y
- First Radius
- Second Radius.
[in] The refocused image.
[out] The corresponding calibration.
[in,out] The matrix of all point ellipses.
Loads a '.rxcalib' file from file system, containing a calibrated system.
[in,out] Filename of the calibration file.
[in,out] The loaded calibration.
Save the converged calibration result.
The filename must end with '.rxcalib'.
[in,out] Filename of the file.
Loads planar model data and returns the list of all image object ids.
[in,out] Filename of the .calib data.
[in,out] List of identifiers for all image objects.
Save planar model to file system.
[in,out] Filename of the .calib file.
Evaluate the metric calibration data set.
[in,out] A vector containing the number of points in each area. The scene is divided into 12
parts and is sorted as follows
| Index| Area |
|-----:|:----------------------|
| 0 | Left Down Front |
| 1 | Left Down Middle |
| 2 | Left Down Back |
| 3 | Left Up Front |
| 4 | Left Up Middle |
| 5 | Left Up Back |
| 6 | Right Down Front |
| 7 | Right Down Middle |
| 8 | Right Down Back |
| 9 | Right Up Front |
| 10 | Right Up Middle |
| 11 | Right Up Back |.
Evaluated the calibration result. That is, the error function of the calibration is executed once with the current
parameter settings and mean residual, mean euclidean distance, min euclidean distance, max euclidean distance and the
standard deviation. Note that this function also projects all test points of all test models to object space.
The calibration result contains:
- The mean residual
- The mean euclidean distance
- The minimum euclidean distance
- The maximum euclidean distance
- The standard deviation
- The percentage error of the longest path found in the model.
[in,out] The metric calibration result.
Gets the refocused image which can be kept after adding the image to the metric calibration.
Identifier of the object.
[in,out] The refocus image.
Gets the result of adding an image to the metric calibration.
The add image result contains:
- The object id
- The number of found model points (planar model points)
- The number of accepted model points (test model points)
- A flag indicating whether an exception has been thrown
- The list of all planar model ids.
- The list of all test model ids
- The list of all result texts.
Identifier of the object.
[in,out] The result.
Get all valid object ids from the metric calibration.
[in,out] List of all valid object ids.
Gets all point ellipses found in the input image. When the model id is set to -1 all unfiltered ellipses are returned.
An ellipses is structured as follows:
- Center X
- Center Y
- First Direction X
- First Direction Y
- Second Direction X
- Second Direction Y
- First Radius
- Second Radius.
The model identifier.
A filter specifying the model type and which point from this model type.
[in,out] Target image format.
[in,out] The matrix of the point ellipses.
Gets a mapping from planar model ids to the corresponding test model id. A planar model id can point to no or more test
model ids.
[in,out] List of planar model ids to test model ids.
Gets point connections.
The point connections are only created when the Box-Calibration is performed and can only be get for test models.
The test model identifier.
The point type such as which projection space.
[in,out] The matrix of all points in the connections.
Get specific points from a model.
The model identifier.
A filter specifying the model type and which point from this model type.
The point type such as which projection space.
[in,out] The matrix of all points.
Reset the input calibration to nominal values.
[in,out] The calibration.
Apply the computed metric calibration to the input calibration.
[in,out] The calibration.
Performs the metric calibration. The input calibration remains untouched.
[in] The initial calibration. Remains untouched.
If false, the calibration stops after applying the initial calibration.
The result of the calibration.
Adds an image and the corresponding calibration to the metric calibration.
The data in the metric calibration is structured as follows:
- The input image: An image of a dot target can be processed.
- The dots on the image are found and transformed to an planar model (This is nearly unfiltered data).
- The planar model is transformed into an test model. (This is a filtered planar model and is used as calibration
basis).
One Image can result in x planar models. Planar models can result in Y test models. Whereby Y <= X.
The ID of the newly created image object is returned. With this object id all other information can be extracted from
the metric calibration using GetAddImageResult, such as number of planar and test models.
[in,out] The depth image.
[in,out] The total focus image.
[in,out] The calibration.
The image object id.
Frees any data stored in metric calibration subsystem.
Initializes the metric calibration.
The type of the metric calibration. (Plane or Box).
[in,out] The CUDA device that runs the algorithms.
Destructor.
Default constructor.
The metric calibration class.
Move assignment operator.
[in,out] The metric calibration.
The instance.
Removes the given status message callback function.
Does nothing if the given function pointer has not been added to the list of callbacks.
The callback function to remove.
Adds the given status message callback function to the internal list of callbacks.
Adding the same function pointer twice will only update the given context pointer. This prevents multiple adds of the
same callback function.
The callback function.
[in] The callback context. Can be any pointer that is passed to the callback function.
Enables the selected test models for the calibration.
List of identifiers for the test models.
Removes the models of the object given by its object id from the calibration set. Changes the result information
related to this object id. You can receive the information of an object by calling
Rx::LFR::CApiLF::RxMetricCalibGetAddImageResult.
Identifier for the object.
Project 2D points into another space defined by eSpace.
The matrix points 2D.
[in,out] The depth image.
[in,out] The matrix of 3D points.
The target space.
Finds ellipses in the given image.
An ellipses is structured as follows:
- Center X
- Center Y
- First Direction X
- First Direction Y
- Second Direction X
- Second Direction Y
- First Radius
- Second Radius.
[in] The refocused image.
[out] The corresponding calibration.
[in,out] The matrix of all point ellipses.
Loads a '.rxcalib' file from file system, containing a calibrated system.
Filename of the calibration file.
[in,out] The loaded calibration.
Save the converged calibration result.
The filename must end with '.rxcalib'.
Filename of the file.
Loads planar model data and returns the list of all image object ids.
Filename of the .calib data.
[in,out] List of identifiers for all image objects.
Save planar model to file system.
Filename of the .calib file.
Evaluate the metric calibration data set.
[in,out] A vector containing the number of points in each area. The scene is divided into 12
parts and is sorted as follows
| Index| Area |
|-----:|:----------------------|
| 0 | Left Down Front |
| 1 | Left Down Middle |
| 2 | Left Down Back |
| 3 | Left Up Front |
| 4 | Left Up Middle |
| 5 | Left Up Back |
| 6 | Right Down Front |
| 7 | Right Down Middle |
| 8 | Right Down Back |
| 9 | Right Up Front |
| 10 | Right Up Middle |
| 11 | Right Up Back |.
Evaluated the calibration result. That is, the error function of the calibration is executed once with the current
parameter settings and mean residual, mean euclidean distance, min euclidean distance, max euclidean distance and the
standard deviation. Note that this function also projects all test points of all test models to object space.
The calibration result contains:
- The mean residual
- The mean euclidean distance
- The minimum euclidean distance
- The maximum euclidean distance
- The standard deviation
- The percentage error of the longest path found in the model.
[in,out] The metric calibration result.
Gets the refocused image which can be kept after adding the image to the metric calibration.
Identifier of the object.
[in,out] The refocus image.
Gets the result of adding an image to the metric calibration.
The add image result contains:
- The object id
- The number of found model points (planar model points)
- The number of accepted model points (test model points)
- A flag indicating whether an exception has been thrown
- The list of all planar model ids.
- The list of all test model ids
- The list of all result texts.
Identifier of the object.
[in,out] The result.
Get all valid object ids from the metric calibration.
[in,out] List of all valid object ids.
Gets all point ellipses found in the input image. When the model id is set to -1 all unfiltered ellipses are returned.
An ellipses is structured as follows:
- Center X
- Center Y
- First Direction X
- First Direction Y
- Second Direction X
- Second Direction Y
- First Radius
- Second Radius.
The model identifier.
A filter specifying the model type and which point from this model type.
Target image format.
[in,out] The matrix of the point ellipses.
Gets a mapping from planar model ids to the corresponding test model id. A planar model id can point to no or more test
model ids.
[in,out] List of planar model ids to test model ids.
Gets point connections.
The point connections are only created when the Box-Calibration is performed and can only be get for test models.
The test model identifier.
The point type such as which projection space.
[in,out] The matrix of all points in the connections.
Get specific points from a model.
The model identifier.
A filter specifying the model type and which point from this model type.
The point type such as which projection space.
[in,out] The matrix of all points.
Reset the input calibration to nominal values.
[in,out] The calibration.
Apply the computed metric calibration to the input calibration.
[in,out] The calibration.
Performs the metric calibration. The input calibration remains untouched.
[in] The initial calibration. Remains untouched.
If false, the calibration stops after applying the initial calibration.
The result of the calibration.
Adds an image and the corresponding calibration to the metric calibration.
The data in the metric calibration is structured as follows:
- The input image: An image of a dot target can be processed.
- The dots on the image are found and transformed to an planar model (This is nearly unfiltered data).
- The planar model is transformed into an test model. (This is a filtered planar model and is used as calibration
basis).
One Image can result in x planar models. Planar models can result in Y test models. Whereby Y <= X.
The ID of the newly created image object is returned. With this object id all other information can be extracted from
the metric calibration using GetAddImageResult, such as number of planar and test models.
The depth image.
The total focus image.
The calibration.
The image object id.
Frees any data stored in metric calibration subsystem.
Initializes the metric calibration.
The type of the metric calibration. (Plane or Box).
The CUDA device that runs the algorithms.
Destructor.
Move constructor.
[in,out] The metric calibration.
Default constructor.
The metric calibration class.
Finalizes an instance of the CRxMetricCalibResult class.
Initializes a new instance of the CRxMetricCalibResult class.
Raytrix Main Lens description class.
Finalizes an instance of the CRxMainLens class.
Initializes a new instance of the CRxMainLens class.
Raytrix Main Lens description class.
Defines an alias representing the type of the elements in this array.
\addtogroup RxCore_Tools
*
@{
A 2D integer array.
Destructor.
Default constructor.
Capture gray image class.
This class captures images from a given camera and processes them to an image that can be used as the gray image of a
calibration. This class requires a CUDA device.
Move assignment operator.
[in,out] The other instance.
The instance.
Destructor.
Move constructor.
[in,out] The other instance.
Default constructor.
Provides methods for calibrating the MLA and the MLI grid of a given ray image.
The parameters access class.
Gets the parameters access interface.
The parameters access interface.
Sets an average (median or mean) of all computed MLA to sensor distance based on all images added to the MLA calibrator,
to the input camera format. The set MLA to sensor distance can be scaled using the fMlaScaleFactor (Identity = 1.0) in
the parameters struct.
[in,out] The light field camera calibration.
Computes the Lens type offsets based on this images.
[in,out] The raw image.
Computes the Lens type offsets based on this images.
[in,out] The raw image.
Initializes the MLA calibration.
The callback wrapper.
Event queue for all listeners interested in StatusMessage events.
Destructor.
Default constructor.
The metric calibration class.
Removes the given status message callback function.
Does nothing if the given function pointer has not been added to the list of callbacks.
The callback function to remove.
Adds the given status message callback function to the internal list of callbacks.
Adding the same function pointer twice will only update the given context pointer. This prevents multiple adds of the
same callback function.
The callback function.
[in] The callback context. Can be any pointer that is passed to the callback function.
Sets an average (median or mean) of all computed MLA to sensor distance based on all images added to the MLA calibrator,
to the input camera format. The set MLA to sensor distance can be scaled using the fMlaScaleFactor (Identity = 1.0) in
the parameters struct.
[in,out] The light field camera calibration.
Computes the Lens type offsets based on this images.
[in,out] The raw image.
Computes the Lens type offsets based on this images.
[in,out] The raw image.
[in,out] The calibration.
Initializes the MLA calibration.
Destructor.
Move constructor.
[in,out] The MLA calibrator.
Default constructor.
The metric calibration class.
Gets the interface defined by ELightFieldRuntimeInterface.
The interface type.
Gets the Raytrix serial of the given camera.
[in] The camera.
The Raytrix camera serial.
Gets the Raytrix name of the given camera.
[in] The camera.
The Raytrix camera name.
Sets the Raytrix serial of the given camera. Requires Dongle::ERuntimeFeature::Master.
[in] The camera.
[in] The name.
Sets the Raytrix name of the given camera. Requires Dongle::ERuntimeFeature::Master.
[in] The camera.
[in] The name.
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.
[in] The meta data.
[in] The GUID of the calibration.
Gets the calibration meta data of the given calibration.
[out] The meta data.
[in] The GUID of the calibration.
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.
[in] The serial of the camera.
[in] The driver name of the camera.
The GUID of the default calibration.
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.
[in] The camera.
The GUID of the default calibration.
Gets the GUID of the master calibration of the given camera defined by the camera serial and the driver name.
[in] The serial of the camera.
[in] The driver name of the camera.
The GUID of the master calibration.
Gets the GUID of the master calibration of the given camera.
[in] The camera.
The GUID of the master calibration.
Gets an array of GUIDs from all master calibrations. Each camera has a single master calibration.
[out] The GUIDs array.
Gets an array of GUIDs from all calibrations of the given camera.
[out] The GUIDs array.
[in] The camera.
Gets an array of GUIDs from all calibrations.
[out] The GUIDs array.
Saves the given calibration to disk.
Requires Dongle::ERuntimeFeature::Save to save this change permanently.
[in] The calibration.
[in] The GUID of the calibration.
True to save the gray image to disk. Throws an exception if the gray image is invalid. False to
keep the current gray image.
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.
[out] The loaded calibration.
[in] The camera serial.
[in] The driver name.
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.
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.
[out] The loaded calibration.
[in] The camera.
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.
Loads the calibration with the given GUID.
[out] The loaded calibration.
[in] The GUID of the calibration.
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.
Deletes the calibration with the given GUID.
Requires Dongle::ERuntimeFeature::Save to save this change permanently.
[in] The GUID of the calibration.
Creates a new calibration and assigns it to the given camera (defined by hardware ID).
Requires Dongle::ERuntimeFeature::Save to save this change permanently.
[in] The camera hardware ID. This is 'TypeA_012' for type A cameras with serial 012.
The GUID of the created calibration.
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.
[in] The camera type. This is 'TypeA' for type A cameras.
[in] The camera serial.
The GUID of the created calibration.
Creates a new calibration and assigns it to the given camera.
Requires Dongle::ERuntimeFeature::Save to save this change permanently.
[in] The camera.
The GUID of the created calibration.
Creates a calibration database for the given camera (defined by hardware ID).
Requires Dongle::ERuntimeFeature::Master.
[in] The camera hardware ID. This is 'TypeA_012' for type A cameras with serial 012.
True to enforce the creation even if the calibration already exists. Otherwise an exception is
thrown.
Creates a calibration database for the given camera (defined by type and serial).
Requires Dongle::ERuntimeFeature::Master.
[in] The camera type. This is 'TypeA' for type A cameras.
[in] The camera serial.
True to enforce the creation even if the calibration already exists. Otherwise an exception is
thrown.
Creates a calibration database for the given camera.
Requires Dongle::ERuntimeFeature::Master.
The camera.
True to enforce the creation even if the calibration already exists. Otherwise an exception is
thrown.
Queries if there is a calibration database for the given camera.
The camera.
True if a database for the given camera exists, false if not.
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.
[in] The folder that holds the calibrations. If empty, the default folder is used.
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.
Destructor.
Default constructor.
Provides methods for managing camera calibrations. This includes creating, loading and saving.
Gets the interface defined by ECalibrationManagerInterface.
The interface type.
Gets the Raytrix serial of the given camera.
The camera.
The Raytrix camera serial.
Gets the Raytrix name of the given camera.
The camera.
The Raytrix camera name.
Sets the Raytrix serial of the given camera. Requires Dongle::ERuntimeFeature::Master.
The camera.
The name.
Sets the Raytrix name of the given camera. Requires Dongle::ERuntimeFeature::Master.
The camera.
The name.
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.
The meta data.
The GUID of the calibration.
Gets the calibration meta data of the given calibration.
[out] The meta data.
The GUID of the calibration.
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 CRxCalibMetaData
that has the IsDefaultCalib flag set to true. By default an internal master calibration is the default one.
The serial of the camera.
The driver name of the camera.
The GUID of the default calibration.
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 CRxCalibMetaData
that has the IsDefaultCalib flag set to true. By default an internal master calibration is the default one.
The camera.
The GUID of the default calibration.
Gets the GUID of the master calibration of the given camera defined by the camera serial and the driver name.
[in] The serial of the camera.
[in] The driver name of the camera.
The GUID of the master calibration.
Gets the GUID of the master calibration of the given camera.
The camera.
The GUID of the master calibration.
Gets an array of GUIDs from all master calibrations. Each camera has a single master calibration.
[out] The GUIDs array.
Gets an array of GUIDs from all calibrations of the given camera.
[out] The GUIDs array.
The camera.
Gets an array of GUIDs from all calibrations.
[out] The GUIDs array.
Saves the given calibration to disk.
Requires Dongle::ERuntimeFeature::Save to save this change permanently.
The calibration.
The GUID of the calibration.
True to save the gray image to disk. Throws an exception if the gray image is invalid. False to
keep the current gray image.
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 CRxCalibMetaData
that has the IsDefaultCalib flag set to true. By default an internal master calibration is the default one.
[out] The loaded calibration.
The camera serial.
The driver name.
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.
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 CRxCalibMetaData
that has the IsDefaultCalib flag set to true. By default an internal master calibration is the default one.
[out] The loaded calibration.
The camera.
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.
Loads the calibration with the given GUID.
[out] The loaded calibration.
The GUID of the calibration.
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.
Deletes the calibration with the given GUID.
Requires Dongle::ERuntimeFeature::Save to save this change permanently.
The GUID of the calibration.
Creates a new calibration and assigns it to the given camera (defined by hardware ID).
Requires Dongle::ERuntimeFeature::Save to save this change permanently.
The camera hardware ID. This is 'TypeA_012' for type A cameras with serial 012.
The GUID of the created calibration.
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.
The camera type. This is 'TypeA' for type A cameras.
The camera serial.
The GUID of the created calibration.
Creates a new calibration and assigns it to the given camera.
Requires Dongle::ERuntimeFeature::Save to save this change permanently.
The camera.
The GUID of the created calibration.
Creates a calibration database for the given camera (defined by hardware ID).
Requires Dongle::ERuntimeFeature::Master.
The camera hardware ID. This is 'TypeA_012' for type A cameras with serial 012.
True to enforce the creation even if the calibration already exists. Otherwise an exception
is thrown.
Creates a calibration database for the given camera (defined by type and serial).
Requires Dongle::ERuntimeFeature::Master.
The camera type. This is 'TypeA' for type A cameras.
The camera serial.
True to enforce the creation even if the calibration already exists. Otherwise an exception is
thrown.
Creates a calibration database for the given camera.
Requires Dongle::ERuntimeFeature::Master.
The camera.
True to enforce the creation even if the calibration already exists. Otherwise an exception is
thrown.
Queries if the there is a calibration database for the given camera.
The camera.
True if a database for the given camera exists, false if not.
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.
The folder that holds the calibrations. If empty, the default folder is used.
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.
Provides methods for managing camera calibrations. This includes creating, loading and saving.
Gets the interface defined by Interfaces::ELightFieldRuntime.
The interface type.
Null if it fails, else the interface.
Decodes both given input keys into the given output keys using the USB dongle.
[out] The first output key.
[out] The second output key.
The first input key.
The second input key.
Gets application details.
[in,out] Name of the application.
[in,out] The application version.
Sets application details.
[in,out] Name of the sx application.
[in,out] The application version.
Get the IDs of the attached dongle.
[Out] The hardware dongle ID.
[Out] The Raytrix dongle ID.
Queries if the given features are supported by your dongle. Returns always false if called before Authenticate.
A OR-ed list of Rx::Net::ERuntimeFeature to query.
True if all features are supported, false if not.
Queries if the given feature is supported by your dongle. Returns always false if called before Authenticate.
The feature ID to query.
True if the feature is supported, false if not.
Finalizes the Light Field Runtime. Frees the memory used by this class. Finalizes also the Cuda device but does not
finalize other classes.
This function is NOT called automatically. You have to call this method at the end of you application.
Gets the release date of this Light Field Runtime. Does not need to be authenticated to get the release date.
The release date.
Gets the release date of this Light Field Runtime. Does not need to be authenticated to get the release date.
[out] The release day.
[out] The release month.
[out] The release year.
Queries if a USB dongle is authenticated with the Light Field Runtime.
True if authenticated, false if not.
Authenticates the attached USB dongle with the Light Field Runtime.
An exception is thrown in the following cases:
* There is no USB dongle attached to the system.
* This version of the Light Field Runtime is not supported by the dongle license.
* The dongle license does not include the SDK feature.
Provides methods for authenticating with the Light Field Runtime and for querying LFR parameters.
Gets the interface defined by ELightFieldRuntimeInterface.
The interface type.
Null if it fails, else the interface.
Decodes both given input keys into the given output keys using the USB dongle.
[out] The first output key.
[out] The second output key.
The first input key.
The second input key.
Get the IDs of the attached dongle.
[Out] The hardware dongle ID.
[Out] The Raytrix dongle ID.
Queries if the given features are supported by your dongle. Returns always false if called before Authenticate.
A OR-ed list of Dongle::ERuntimeFeature::ID to query.
True if all features are supported, false if not.
Queries if the given feature is supported by your dongle. Returns always false if called before Authenticate.
The feature ID to query.
True if the feature is supported, false if not.
Finalizes the Light Field Runtime. Frees the memory used by this class. Finalizes also the Cuda device but does not
finalize other classes.
This function is NOT called automatically. You have to call this method at the end of you application.
Gets application details.
[in,out] Name of the application.
[in,out] The application version.
Sets application details.
Name of the sx application.
The application version.
Gets the release date of this Light Field Runtime. Does not need to be authenticated to get the release date.
[out] The release day.
[out] The release month.
[out] The release year.
Queries if a USB dongle is authenticated with the Light Field Runtime.
True if authenticated, false if not.
Authenticates the attached USB dongle with the Light Field Runtime.
An exception is thrown in the following cases:
* There is no USB dongle attached to the system.
* This version of the Light Field Runtime is not supported by the dongle license.
* The dongle license does not include the SDK feature.
[in] (Optional) Pointer to internal data. The passed pointer is stored in this class and must be
available for the lifetime of this class and is deleted by calling End. Should be null.
Provides methods for authenticating with the Light Field Runtime and for querying LFR parameters.
Gets the interface defined by Interface::ECuda.
The interface type.
Null if it fails, else the interface.
Finalizes CUDA. This finalizes all CUDA devices.
Forces an immediate garbage collection of temporary CUDA memory.
Gets the installed CUDA driver version. Returns 0 if there is no CUDA driver installed.
The driver version.
Gets the installed CUDA runtime version.
The runtime version.
Gets a certain CUDA device.
The index of the CUDA device. Must be in the range of [0, GetDeviceCount() - 1].
The CUDA device.
Gets the number of available CUDA devices in your system.
The number of available CUDA devices.
Enumerates and stores all CUDA devices.
The number of available CUDA devices.
Provides information about the CUDA hardware in your system and enables access to available CUDA devices.
Gets the interface defined by Interfaces::ECuda.
The interface type.
Null if it fails, else the interface.
Finalizes CUDA. This finalizes all CUDA devices.
Forces an immediate garbage collection of temporary CUDA memory.
Gets the installed CUDA driver version. Returns 0 if there is no CUDA driver installed.
The driver version.
Gets the installed CUDA runtime version.
The runtime version.
Gets a certain CUDA device.
The index of the CUDA device. Must be in the range of [0, GetDeviceCount() - 1].
The CUDA device.
Gets the number of available CUDA devices in your system.
The number of available CUDA devices.
Enumerates and stores all CUDA devices.
The number of available CUDA devices.
Provides information about the CUDA hardware in your system and enables access to available CUDA devices.
Gets the interface defined by ERayFileReaderInterface.
The interface type.
Null if it fails, else the interface.
Reads from the given gray image file.
Requires an authenticated dongle (Rx::LFR::Net::LightFieldRuntime::Authenticate).
[in] The complete file path.
[out] The read gray image.
Reads from the given ray file. Reads the raw image, the calibration (with gray image) and the meta data.
Requires an authenticated dongle (Rx::LFR::Net::LightFieldRuntime::Authenticate).
[in] The complete file path.
[out] The read ray image.
Destructor.
Default constructor.
Provides methods for reading a ray image from a ray file.
Gets the interface defined by Interfaces::ERayFileReader.
The interface type.
Null if it fails, else the interface.
Reads from the given gray image file.
Requires an authenticated dongle (Rx::LFR::CLightFieldRuntime::Authenticate).
The file name.
[out] The read gray image.
Reads from the given ray file. Reads the raw image, the calibration (with gray image) and the meta data.
Requires an authenticated dongle (Rx::LFR::CLightFieldRuntime::Authenticate).
The file name.
[out] The read ray image.
Provides methods for reading a ray image from a ray file.
Gets the interface defined by Interfaces::ERayFileReader.
The interface type.
Null if it fails, else the interface.
Writes the given gray image to the given file.
Requires an authenticated dongle (Rx::LFR::Net::LightFieldRuntime::Authenticate).
[in] The completet file path.
[in] The gray image.
Writes the given ray image to the given file.
Requires an authenticated dongle (Rx::LFR::Net::LightFieldRuntime::Authenticate) with the Rx::Net::ERuntimeFeature::Save
feature.
[in] The complete file path.
[in] The ray image.
[in] The calibration of the ray image.
[in] The meta data. This gets updated while writing.
Writes the given ray image to the given file.
Requires an authenticated dongle (Rx::LFR::Net::LightFieldRuntime::Authenticate) with the Rx::Net::ERuntimeFeature::Save
feature.
[in] The complete file path.
[in] The ray image.
[in] The calibration of the ray image.
Writes the given ray image to the given file.
Requires an authenticated dongle (Rx::LFR::Net::LightFieldRuntime::Authenticate) with the Rx::Net::ERuntimeFeature::Save
feature.
[in] The completet file path.
[in] The ray image.
[in] The calibration of the ray image.
[in] The meta data. This gets updated while writing.
Writes the given ray image to the given file.
Requires an authenticated dongle (Rx::LFR::Net::LightFieldRuntime::Authenticate) with the Rx::Net::ERuntimeFeature::Save
feature.
[in] The complete file path.
[in] The ray image.
[in] The calibration of the ray image.
Writes the given ray image to the given file but overwrites the meta data by the given one.
Requires an authenticated dongle (Rx::LFR::Net::LightFieldRuntime::Authenticate) with the Rx::Net::ERuntimeFeature::Save
feature.
[in] The complete file path.
[in] The ray image.
[in] The meta data.
Writes the given ray image to the given file.
Requires an authenticated dongle (Rx::LFR::Net::LightFieldRuntime::Authenticate) with the Rx::Net::ERuntimeFeature::Save
feature.
[in] The complete file path.
[in] The ray image.
Destructor.
Default constructor.
Provides methods for writing a ray image to a ray file.
Gets the interface defined by ERayFileWriterInterface.
The interface type.
Null if it fails, else the interface.
Writes the given gray image to the given file.
Requires an authenticated dongle (Rx::LFR::CLightFieldRuntime::Authenticate).
The file.
The gray image.
Writes the given ray image to the given file.
Requires an authenticated dongle (Rx::LFR::CLightFieldRuntime::Authenticate) with the Rx::Dongle::ERuntimeFeature::Save
feature.
The file.
The ray image.
The calibration of the ray image.
[in,out] The meta data. This gets updated while writing.
Writes the given ray image to the given file.
Requires an authenticated dongle (Rx::LFR::CLightFieldRuntime::Authenticate) with the Rx::Dongle::ERuntimeFeature::Save
feature.
The file.
The ray image.
The calibration of the ray image.
Writes the given ray image to the given file but overwrites the meta data by the given one.
Requires an authenticated dongle (Rx::LFR::CLightFieldRuntime::Authenticate) with the Rx::Dongle::ERuntimeFeature::Save
feature.
The file.
The ray image.
[in,out] The meta data. This gets updated while writing.
Writes the given ray image to the given file.
Requires an authenticated dongle (Rx::LFR::CLightFieldRuntime::Authenticate) with the Rx::Dongle::ERuntimeFeature::Save
feature.
The file.
[in,out] The ray image. The meta data gets updated while writing.
Provides methods for writing a ray image to a ray file.
Gets the double shot mode of the opened sequence. Is 0 if the sequence wasn't recorded in double shot mode.
The double shot mode.
Gets the file size in bytes.
The file size.
Gets the current frame index.
The frame index.
Gets the size of a frame in bytes.
The frame size.
Gets the number of frames in the opened sequence.
The frame count.
Gets the current number of used buffer slots.
The used frame buffer count.
Queries if a file has been opened.
True if open, false if not.
Sets the current frame index.
The new frame index.
Moves the current frame index by the given number forward or backward.
The number of frames to move the current index.
Closes the opened sequence file and stops the background buffer thread.
Reads the frame at the current frame index. Reads the frame from buffer if already buffered.
[out] The frame.
Reads the first frame including the meta data and the calibration. This starts the background buffer thread.
[out] The ray image.
Opens the given ray sequence for reading.
Requires an authenticated dongle (Rx::LFR::Net::LightFieldRuntime::Authenticate).
[in] The complete file path.
Number of frames to buffer. Must NOT be zero. Default is 2.
Destructor. Closes the file if opened.
Default constructor.
Provides methods for reading a ray sequence from a rays file.
Move assignment operator.
[in,out]The sequence file reader instance.
The instance.
Gets the double shot mode of the opened sequence. Is 0 if the sequence wasn't recorded in double shot mode.
The double shot mode.
Gets the file size in bytes.
The file size.
Gets the current frame index.
The frame index.
Gets the size of a frame in bytes.
The frame size.
Gets the number of frames in the opened sequence.
The frame count.
Gets the current number of used buffer slots.
The used frame buffer count.
Queries if a file has been opened.
True if open, false if not.
Sets the current frame index.
The new frame index.
Moves the current frame index by the given number forward or backward.
The number of frames to move the current index.
Closes the opened sequence file and stops the background buffer thread.
Reads the frame at the current frame index. Reads the frame from buffer if already buffered.
To read the first frame, you have to call StartReading after calling Open.
[out] The frame.
Reads the first frame including the meta data and the calibration. This starts the background buffer thread.
[out] The ray image.
Opens the given ray sequence for reading.
To read the first frame, you have to call StartReading. Then you can call ReadFrame to read frame by frame.
Requires an authenticated dongle (Rx::LFR::CLightFieldRuntime::Authenticate).
The file name.
(Optional) Number of frames to buffer. Must NOT be zero.
Destructor. Closes the file if opened.
Move constructor.
[in,out] The sequence file reader instance.
Default constructor.
Provides methods for reading a ray sequence from a rays file.
Clears the stack and frees the memory used by this stack. The memory is reallocated by calling AddImage.
Clears the stack by resetting the internal counter to zero.
Gets the stacked image if the stacking has been finished.
The stacked image.
Queries if the stack is complete. This is the case if the stack is full.
True if complete, false if not.
Adds an image to the stack. The image is uploaded to the CUDA device and processed.
[in] The image to add.
Adds an image to the stack. The image is uploaded to the CUDA device and processed.
[in] The image to add.
Sets the stacking operation. Resets the stacking result if changed.
The stacking operation.
Sets the maximum number of image on the stack. Resets the stacking result if changed.
The maximum number of images.
Sets the CUDA device that allocates the memory required for the stack operation and that runs the algorithm.
The CUDA device.
Destructor.
Default constructor.
Provides information about the CUDA hardware in your system and enables access to available CUDA devices.
Move assignment operator.
[in,out] The image stacking instance.
The instance.
Clears the stack and frees the memory used by this stack. The memory is reallocated by calling AddImage.
Clears the stack by resetting the internal counter to zero.
Gets the stacked image if the stacking has been finished.
The stacked image.
Queries if the stack is complete. This is the case if the stack is full.
True if complete, false if not.
Adds an image to the stack. The image is uploaded to the CUDA device and processed.
[in] The image to add.
Adds an image to the stack. The image is uploaded to the CUDA device and processed.
[in] The image to add.
Sets the stacking operation. Resets the stacking result if changed.
The stacking operation.
Sets the maximum number of image on the stack. Resets the stacking result if changed.
The maximum number of images.
Sets the CUDA device that allocates the memory required for the stack operation and that runs the algorithm.
The CUDA device.
Destructor.
Move constructor.
[in,out] The image stacking instance.
Default constructor.
Provides methods for stacking images within a given mode using a CUDA device.
The image captured wrapper.
Executes the native image captured action.
The captured image.
The index of the camera in the camera server.
[in,out] The context registered with the callback.
Event queue for all listeners interested in CamImageAvailable events.
Enables or disables a callback during automatic grid calibration via RxGridCalibrateMli, RxGridCalibrateMla and
RxGridCalibrateMaster.
True to enable, false to disable.
Automatically calibrates the MLA rotation steps and the MLA reflection. Requires master dongle feature.
Returns false if estimation has been failed because of wrong exposure or aperture configuration.
Automatically calibrates MLA grid. Requires master dongle feature.
Returns false if estimation has been failed because of wrong exposure or aperture configuration.
Automatically calibrates MLI grid.
Returns false if estimation has been failed because of wrong exposure or aperture configuration.
Removes the computation filter mask image set by Rx::LFR::Net::ApiLF::RxSetComputationFilterMask.
Sets the computation filter mask image.
This image is used to reduce the number of lenses used for depth estimation (Rx::LFR::Net::ApiLF::RxDepthRay).
It must have the same dimension as the raw image and a pixel type of Rx::Interop::Runtime28::EPixelType::Lum and a data
type of Rx::Interop::Runtime28::EDataType::UByte.
Each lens of the raw image has a lens center that can be rounded to a pixel. If this pixel has the value 255 in the
filter mask image, the corresponding lens is used. If this pixel has another value, the lens is not used.
[in,out] The complete file path of the computation filter mask image to load.
Sets the computation filter mask image.
This image is used to reduce the number of lenses used for depth estimation (Rx::LFR::Net::ApiLF::RxDepthRay).
It must have the same dimension as the raw image and a pixel type of Rx::Interop::Runtime28::EPixelType::Lum and a data
type of Rx::Interop::Runtime28::EDataType::UByte.
Each lens of the raw image has a lens center that can be rounded to a pixel. If this pixel has the value 255 in the
filter mask image, the corresponding lens is used. If this pixel has another value, the lens is not used.
The computation filter mask image.
Saves the depth values of the current Depth3D image to the given file as a point list.
The formats available are:
ASCII:
- .txt -- one point per row as plain text (default when no other extension matches, .txt is appended to filename)
- .xyz -- conform to the 'xyz' file standard (augments txt format with small header)
Binary:
- .pcd -- the 'Point Cloud Data' format, see http://pointclouds.org/documentation/tutorials/pcd_file_format.php.
[in,out] If non-null, complete file path.
True to save the point list in virtual depth units instead of metric units.
The crop left perc.
The crop right perc.
The crop top perc.
The crop bottom perc.
Saves the depth values of the current Depth3D image to the given file as a point list.
The formats available are:
ASCII:
- .txt -- one point per row as plain text (default when no other extension matches, .txt is appended to filename)
- .xyz -- conform to the 'xyz' file standard (augments txt format with small header)
Binary:
- .pcd -- the 'Point Cloud Data' format, see http://pointclouds.org/documentation/tutorials/pcd_file_format.php.
[in,out] The complete file path.
True to save the point list in virtual depth units instead of metric units.
Saves the 3D mesh provided by image 'Depth3D' to binary STL format. This requires a valid image computed by
Rx::LFR::Net::ApiLF::RxDepth3D. Triangles with a depth-variation larger than 'dMaxEdgeLength' for at least one vertex pair
are not added to the mesh.
[in,out] The complete file path.
True to save the mesh in virtual depth units instead of metric units.
Limit for depth-variation in vertices. -1 = infinity.
the percentage of the cropping on the left side.
the percentage of the cropping on the right side.
the percentage of the cropping on the top side.
the percentage of the cropping on the bottom side.
Saves the 3D mesh provided by image 'Depth3D' to binary STL format. This requires a valid image computed by
Rx::LFR::Net::ApiLF::RxDepth3D. Triangles with a depth-variation larger than 'dMaxEdgeLength' for at least one vertex pair
are not added to the mesh.
[in,out] The complete file path.
True to save the mesh in virtual depth units instead of metric units.
Limit for depth-variation in vertices. -1 = infinity.
Colorizes the depth map created by Rx::LFR::Net::ApiLF::RxDepthMap.The result is stored in the image with the ID
Rx::LFR::Net::EImage::Depth3D.
The space.
Object space depth 3D.
This creates a RGBA float image which maps each pixel in the view camera to a 3D position in object space. The R
channel is the X coordinate, the G channel is the Y coordinate and the B channel is the Z coordinate. The Z coordinate
is relative to the global coordinate system which typically coincides with the light field camera sensor. All
coordinate values are given in millimeters.
The image is stored in the image with the ID Rx::LFR::Net::EImage::Depth3D.
Creates a depth map from the ray depth image created by Rx::LFR::Net::ApiLF::RxDepthRay.
The space.
Estimates the depth of the bound ray image and stores the result in the image with the ID Rx::LFR::Net::EImage::DepthRay.
Creates a multi view image and stores the result in the image with the ID
Rx::LFR::Net::EImage::Multiview_ViewCamera.
Focus on a depth surface.
In principle, each pixel of the result image can be focused individually. The function
Rx::LFR::Net::ApiLF::RxTotalFocus makes this property available by focusing the ray image to the depth surface given in
the internal depth image related to the target space that is selected. To calculate the depth image you have to call
Rx::LFR::Net::ApiLF::RxDepthRay first and next Rx::LFR::Net::ApiLF::RxDepthMap, or by a user defined image set with
Rx::LFR::Net::ApiLF::RxSetImage.
When setting a depth image with Rx::LFR::Net::ApiLF::RxSetImage it need not have the same dimensions as the resultant
image. The given depth map is implicitly scaled to the size of the resultant refocused image.
If the size of the given depth map image is 1x1 pixel, the depth encoded for that pixel is applied to all focused
pixel. The depth image has to be of pixel type Rx::Interop::Runtime28::EPixelType::Lum and data type
Rx::Interop::Runtime28::EDataType::UByte. The pixel value range of [0,255] is mapped to [0,1] for the interpretation as
depth.
\attention The result is written to the internal image related to the given space. The size of this resultant image is
set in relation to the ray image size via the parameter Rx::LFR::Net::Params::EApiLF::Focus_ImageDivisor.
The space.
Focus image to a plane perpendicular to the optical axis, i.e. parallel to the image plane.
This focuses to a plane perpendicular to the optical axis. To change the focal plane, use parameter
Rx::LFR::Net::Params::EApiLF::Focus_RelativeFocusPlane. A relative focus value of zero refocuses to the plane furthest away
from the viewer and a value of 1 would focus to a plane that passes through the object side focal point of the
recording lens.
The result is written to the internal image with ID Rx::LFR::Net::EImage::RefocusBasic. The size of this resultant
image is set in relation to the ray image size via the parameter Rx::LFR::Net::Params::EApiLF::Focus_ImageDivisor.
Show a lens grid overlay on the raw ray image.
The result is written to the internal image with ID Rx::LFR::Net::EImage::Grid.
Pre Process a ray image with a minimal Set of preprocessing parameter.
This function does the same preprocessing as Rx::LFR::Net::ApiLF::RxPreProcess but all preprocessing flags with exception of
debayering are deactivated.
Pre-Process a ray image.
The ray image that is bound with RxRayBind() is a raw lightfield image. Before this ray image can be used by the actual
processing algorithms, it has to be adjusted by applying a rectification of a possible radial distortion and by
adjusting its brightness and color with respect to a gray image.
Unlocks the CUDA Mutex.
Locks the CUDA Mutex.
If the mutex is locked, the timeout defines the time in ms until a Rx::Net::RxException is thrown.
True if it succeeds, false if it fails.
Projects the given source depth value into the given target space.
The source depth in millimeter or virtual depths.
The source space.
True if the source depth is given in virtual depths. Is ignored if the source space isn't virtual.
The target space.
True if the target depth should be given in virtual depths. Is ignored if the target space isn't
virtual.
The resultant target depth in millimeter or virtual depths.
Projects an array of points from the given source space into the given target space.
[out] The array of projected points.
[in,out] The array of points to project.
The target space.
The source space.
True if all projections succeeded, false if at least one projection failed (out of sensor or image projection).
Calculates the histogram of the image with the given eImgID and stores the histogram data in the given array. This
array must be large enough to hold 4 * 256 numbers. The number of calculated channels is returned in uChannels.
The image ID.
[out] A reference of Rx::CRxArrayUInt where the histogram will be stored.
[out] The number of channels.
Finds the minimum and maximum value of the given eImgID
The image ID.
The channel.
[out] The minimum value.
[out] The maximum value.
Resize an image.
[out] The target image to store the result.
[in] The image that is to be resized.
[in] The image size divider. For example, if iDivder = 2, then the resultant image size is half the
original size.
Gets device pointer pitch, which is the width in bytes of the allocation. Given a row and column of an array element of
type T, the address is computed as:
T* pElement = (T*)((char*)BaseAddress + Row * pitch) + Column;
Internal image ID. This is not a ray image handle.
The image device pointer pitch.
Get the device pointer of an internal image.
This function returns the image device pointer of an internal image. The available internal image IDs are listed in
Rx::LFR::Net::EImage.
Internal image ID. This is not a ray image handle.
[out] On return contains the internal image's device pointer.
Get the image format of an internal image.
This function returns the image format of an internal image without copying the actual image from the CUDA device to
host memory. The available internal image IDs are listed in Rx::LFR::Net::EImage.
Internal image ID. This is not a ray image handle.
[out] On return contains the internal image's format.
Frees memory used by image defined by eImgID This invalidates the image.
Identifier for the image.
Test whether an internal image is valid.
The available internal image IDs are listed in Rx::LFR::Net::EImage.
Internal image ID. This is not a ray image handle.
true if the image is valid, false otherwise.
Set an internal image.
The available internal image IDs are listed in Rx::LFR::Net::EImage.
A new ray image can be set with eImgID set to Rx::LFR::Net::EImage::Raw and a new gray image with Rx::LFR::Net::EImage::Gray.
RxSetImage copies the image data into the currently bound ray image and to the CUDA device. For the new ray image to be
used in calculations you must call Rx::LFR::Net::ApiLF::RxPreProcess after setting the ray and the gray image.
You can also circumvent the internal preprocessing of the ray image by writing directly the processed ray image to the
CUDA device with Rx::LFR::Net::EImage::Processed_Normalized. However, this will not change the Rx::LFR::Net::EImage::Raw or
Rx::LFR::Net::EImage::Gray images currently bound.
Internal image ID. This is not a ray image handle.
[in,out] The image to copy into the specified internal image.
Set an internal image.
The available internal image IDs are listed in Rx::LFR::Net::EImage.
A new ray image can be set with eImgID set to Rx::LFR::Net::EImage::Raw and a new gray image with Rx::LFR::Net::EImage::Gray.
RxSetImage copies the image data into the currently bound ray image and to the CUDA device. For the new ray image to be
used in calculations you must call Rx::LFR::Net::ApiLF::RxPreProcess after setting the ray and the gray image.
You can also circumvent the internal preprocessing of the ray image by writing directly the processed ray image to the
CUDA device with Rx::LFR::Net::EImage::Processed_Normalized. However, this will not change the Rx::LFR::Net::EImage::Raw or
Rx::LFR::Net::EImage::Gray images currently bound.
Internal image ID. This is not a ray image handle.
[in,out] The image to copy into the specified internal image.
Get an internal image.
The available internal image IDs are listed in Rx::LFR::Net::EImage.
Internal image ID. This is not a ray image handle.
[out] On return contains a copy of the specified internal image.
If true, a new image is created in pImage. Otherwise, it is ensured that pImage refers to an image
the same size and type as the respective internal image, and then the internal image is copied.
Get an internal image.
The available internal image IDs are listed in Rx::LFR::Net::EImage.
Internal image ID. This is not a ray image handle.
[out] On return contains a copy of the specified internal image.
Convert a Rx::CRxImage to a new pixel and data type.
[out] Destination image.
[in,out] Reference to the image.
Pixel type of the converted image.
Data type of the converted image.
Resets all parameters to their default value.
Loads all writable API parameter from file. Its mandatory to bind a light field image before.
[in,out] The complete file path.
Saves all writable API parameter to file. Its mandatory to bind a light field image before.
[in,out] The complete file path.
Get the Properties of a parameter.
The parameter ID.
[out] On return contains the parameter string representation.
[out] On return contains the parameter ReadAccess flag.
[out] On return contains the parameter WriteAccess flag.
[out] On return contains the parameter DataType.
Get the string representation of a parameter.
The parameter ID.
[out] On return contains the parameter string representation.
Get the value range of an array parameter and the min and max allowed number of elements in the array.
The ID of the parameter.
[out] The min number of values allowed in the array.
[out] The max number of values allowed in the array.
[out] The min allowed value of the parameter.
[out] The max allowed value of the parameter.
Get the value range of an array parameter and the min and max allowed number of elements in the array.
The ID of the parameter.
[out] The min number of values allowed in the array.
[out] The max number of values allowed in the array.
[out] The min allowed value of the parameter.
[out] The max allowed value of the parameter.
Get the value range of a parameter.
The ID of the parameter.
[out] The min allowed value of the parameter.
[out] The max allowed value of the parameter.
Get the value range of a parameter.
The ID of the parameter.
[out] The min allowed value of the parameter.
[out] The max allowed value of the parameter.
Gets the value of a parameter.
The ID of the parameter.
[out] The value of the parameter.
Gets the value of a parameter.
The ID of the parameter.
[out] The value of the parameter.
Gets the value of a parameter.
The ID of the parameter.
[out] The value of the parameter.
Gets the value of a parameter.
The ID of the parameter.
[out] The value of the parameter.
Gets the value of a parameter.
The ID of the parameter.
[out] The value of the parameter.
Gets the value of a parameter.
The ID of the parameter.
[out] The value of the parameter.
Sets the value of a parameter.
The ID of the parameter.
[in] The value of the parameter.
Sets the value of a parameter.
The ID of the parameter.
[in] The value of the parameter.
Sets the value of a parameter.
The ID of the parameter.
[in] The value of the parameter.
Sets the value of a parameter.
The ID of the parameter.
[in] The value of the parameter.
Sets the value of a parameter.
The ID of the parameter.
[in] The value of the parameter.
Sets the value of a parameter.
The ID of the parameter.
[in] The value of the parameter.
Get the Properties of a parameter.
The parameter ID.
[out] On return contains the parameter string representation.
[out] On return contains the parameter ReadAccess flag.
[out] On return contains the parameter WriteAccess flag.
[out] On return contains the parameter DataType.
Get the string representation of a parameter.
The parameter ID.
[out] On return contains the parameter string representation.
Get the value range of an array parameter and the min and max allowed number of elements in the array.
The ID of the parameter.
[out] The min number of values allowed in the array.
[out] The max number of values allowed in the array.
[out] The min allowed value of the parameter.
[out] The max allowed value of the parameter.
Get the value range of an array parameter and the min and max allowed number of elements in the array.
The ID of the parameter.
[out] The min number of values allowed in the array.
[out] The max number of values allowed in the array.
[out] The min allowed value of the parameter.
[out] The max allowed value of the parameter.
Get the value range of a parameter.
The ID of the parameter.
[out] The min allowed value of the parameter.
[out] The max allowed value of the parameter.
Get the value range of a parameter.
The ID of the parameter.
[out] The min allowed value of the parameter.
[out] The max allowed value of the parameter.
Gets the value of a parameter.
The ID of the parameter.
[out] The value of the parameter.
Gets the value of a parameter.
The ID of the parameter.
[out] The value of the parameter.
Gets the value of a parameter.
The ID of the parameter.
[out] The value of the parameter.
Gets the value of a parameter.
The ID of the parameter.
[out] The value of the parameter.
Gets the value of a parameter.
The ID of the parameter.
[out] The value of the parameter.
Gets the value of a parameter.
The ID of the parameter.
[out] The value of the parameter.
Sets the value of a parameter.
The ID of the parameter.
[in] The value of the parameter.
Sets the value of a parameter.
The ID of the parameter.
[in] The value of the parameter.
Sets the value of a parameter.
The ID of the parameter.
[in] The value of the parameter.
Sets the value of a parameter.
The ID of the parameter.
[in] The value of the parameter.
Sets the value of a parameter.
The ID of the parameter.
[in] The value of the parameter.
Sets the value of a parameter.
The ID of the parameter.
[in] The value of the parameter.
Get the Properties of a parameter.
The parameter ID.
[out] On return contains the parameter string representation.
[out] On return contains the parameter ReadAccess flag.
[out] On return contains the parameter WriteAccess flag.
[out] On return contains the parameter DataType.
Get the string representation of a parameter.
The parameter ID.
[out] On return contains the parameter string representation.
Get the value range of a parameter.
The ID of the parameter.
[out] The min allowed value of the parameter.
[out] The max allowed value of the parameter.
Gets the value of a parameter.
The ID of the parameter.
[out] The value of the parameter.
Sets the value of a parameter.
The ID of the parameter.
[in] The value of the parameter.
Store the threads current OpenGL context. The context can be retrieved with RxGlGetContext() and released with
RxGlReleaseContext.
Releases the OpenGL context owned by the calling thread.
Another thread can get the released context via Rx::LFR::Net::ApiLF::RxGlGetContext. If the calling thread hasn't a valid
context this function will do nothing and only returns.
Assigns the OpenGL context created by Rx::LFR::Net::ApiLF::RxCudaSelectDevice to the calling thread.
Before assigning a context, the thread that has the context currently must release it via
Rx::LFR::Net::ApiLF::RxGlReleaseContext().
Get the OpenGl texture ID corresponding to given parameter eImgID. The content of this texture can be updated with the
Rx::LFR::Net::ApiLF::RxGlUpdateTex function.
The image ID.
The identifier for the OpenGL texture.
Get the OpenGl texture ID corresponding to given parameter eImgID. The content of this texture can be updated with the
Rx::LFR::Net::ApiLF::RxGlUpdateTex function.
The image ID.
[out] Identifier for the OpenGL texture.
Copy CUDA result images to OpenGL textures.
The internal image IDs that can be used with this function are those declared in Rx::LFR::Net::EImage. Combining a
number of image IDs by OR, updates all the related textures.
Internal image ID. A number of internal image IDs can be combined with OR operation.
Flag, whether to create mipmaps or not.
Copy CUDA result images to OpenGL textures.
The internal image IDs that can be used with this function are those declared in Rx::LFR::Net::EImage. Combining a
number of image IDs by OR, updates all the related textures.
Internal image ID. A number of internal image IDs can be combined with OR operation.
Get OpenGL version of current OpenGL rendering context.
This function only return a meaningful result if it is called within an active OpenGL rendering context.
[out] On return contains the OpenGL major version.
[out] On return contains the OpenGL minor version.
Get the doubleshot mode used when recording the given sequence.
The ray sequence id.
The doubleshot mode.
Move the frame index relative to the current position in the ray sequence.
The ray sequence id.
The number of frames to move. Negative values move frame index backward.
Set the current frame index of ray sequence.
The ray sequence id.
The frame index.
Get current frame index of ray sequence.
The ray sequence id.
The frame index on return.
Get the total file size of the ray sequence in bytes.
The ray sequence id.
[out] Contains the total size of the ray sequence in bytes.
Get number of frames in ray sequence.
Number of frames.
Get number of frames in ray sequence.
The ray sequence id.
The number of frames.
Get number of frame buffers in use.
The ray sequence id.
The number of frames in use in the frame buffer.
Write currently bound ray image to currently bound ray sequence.
This function appends the currently bound ray image to the bound ray sequence.
To automatically write frames captured from a camera device to the bound ray sequence, set the parameter
Rx::LFR::Net::Params::EApiLF::RaySeq_AutoStoreCamFrames to 1.
Read a frame from the currently bound ray sequence.
A ray sequence in read mode must have been bound beforehand.
This function reads the current frame from the ray sequence and advanced the frame pointer by one frame.The ray image
is read into the currently bound ray image and the image is automatically copied onto the CUDA device. This means that
the function Rx::LFR::Net::ApiLF::RxRaySeqGetFrameIndex returns a frame index higher than before after calling
Rx::LFR::Net::ApiLF::RxRaySeqRead.
Unbind a ray sequence. If a ray sequence in write mode is unbound, the currently bound ray image stays bound. No more
images can be written to the ray sequence once it has been unbound, however, the ray sequence has not been closed. It
can be bound again to write further ray images to it.
If a ray sequence in read mode is unbound, the currently bound ray image stays bound. The ray image is therefore also
not removed from memory.
You will have to unbind the ray image and then delete it to free all memory.
The ray sequence ID of the ray sequence to unbind.
Determines if a sequence is bound for reading to the API.
True if a sequence in read mode is bound, false if not.
Bind a ray sequence for use by other API functions.
Only one ray sequence for reading and one ray sequence for writing can be bound at a time. When a ray sequence is bound
for reading, then any currently bound ray image is unbound, a new prototype ray image of the format of the ray sequence
is created and bound and the first image of the ray sequence is loaded into the bound ray image.The ID of the newly
created ray image is returned. No new ray image can be bound until the ray sequence is unbound using
Rx::LFR::Net::ApiLF::RxRaySeqUnbind .If a camera capture is started while a ray sequence is bound for reading, the ray sequence is
automatically unbound. While a camera is in capture mode, no ray sequence can be bound for reading.
When a ray sequence is bound for writing a ray image must already be bound. If the ray sequence is empty up to now, the
ray sequence is created for the currently bound image type and only ray images of the same format can be written to the
ray sequence.Also only ray images of the same format can be bound while the ray sequence is bound. If the ray sequence
already contains images, it can only be bound if the currently bound ray image format is of the same format as the ray
sequence. If a ray sequence in write mode is bound and camera capture is started the ray sequence is also unbound if
the image formats do not agree.To capture frames from a camera, first start the camera capture, then bind the ray
sequence in write mode and set the parameter Rx::LFR::Net::Params::EApiLF::RaySeq_AutoStoreCamFrames to 1. The value returned is the
ray image ID of the currently bound ray image.
The id of the ray sequence.
the currently bound ray image handle.
Close a ray sequence.
Closing a ray sequence also unbinds the corresponding ray image. The ray sequence ID becomes invalid once the ray
sequence has been closed.
The id of the ray sequence.
The number of frames written (if sequence was in write mode).
Open a ray sequence. Depending on the mode a ray sequence can be opened for reading or writing.
Returns the ray sequence handle.
[in,out] The complete file path of the ray sequence.
The ray sequence mode. This is a combination of elements of ERaySeqMode .
The number of frame buffers used for buffered writing/reading.
The ray sequence id. This id is used in other functions to reference the ray sequence.
Set meta data of a ray image.
The meta data class CRxMetaData can contain any number of meta data elements of types unsigned, double and
Rx::CRxString. You can get, set and add elements to the meta data instance and store this together with the ray image.
The ray image handle.
[in] The ray image meta data to set.
Get meta data of a ray image.
The meta data class Rx::Net::MetaData can contain any number of meta data elements of types unsigned, double and string
You can get, set and add elements to the meta data instance and store this together with the ray image.
The ray image handle.
The ray image meta data.
Get the meta data of the bound ray image.
The meta data class Rx::Net::MetaData can contain any number of meta data elements of types unsigned, double and string
You can get, set and add elements to the meta data instance and store this together with the ray image.
The ray image meta data.
Get the ray image.
If Create is true, the necessary memory for the image is created with a call to Rx::Interop::Runtime28::IImage::Create,
otherwise it is expected that pRawImage is already allocated with the correct amount of memory.
The ray image handle.
[out] Pointer to an IImage interface.
Flag whether to create image.
Get the ray image as Rx::CRxImage instance.
The ray image handle.
The raw image.
Gets the frame ID of the bound light field image. Used when working with sequences or cameras.
The frame ID.
Gets the frame ID of the given light field image. Used when working with sequences or cameras.
The ID of the light field image created by calling RxRayLoad, RxRaySeqBind or RxCamBind.
The frame ID.
Gets the image timestamp of the bound light field image. Is 0 if the image hasn't a valid timestamp. You can use this
timestamp and the timestamp of another camera or sequence frame to determine the time between them.
The timestamp.
Gets the image timestamp of the given light field image. Is 0 if the image hasn't a valid timestamp. You can use this
timestamp and the timestamp of another camera or sequence frame to determine the time between them.
The ID of the light field image created by calling RxRayLoad, RxRaySeqBind or RxCamBind.
The timestamp.
Get the image format of a ray image.
The ray image handle.
The image format of the ray image.
Unbind the currently bound ray image.
If no ray image is bound the function does nothing. If a ray sequence or a camera is bound, the function throws an
exception.
Bind a ray image to perform computations on.
The ID of the light field image that is to be used for calculations.
Gets the pointer to the internal camera format.
The pointer to the internal camera format.
Get the calibration data of the given ray image as XML string.
The ID of the ray image whose calibration data is to be saved.
[out] On successful return contains the XML string.
Save calibration data of ray image in XML format.
The ID of the ray image whose calibration data is to be saved.
[in,out] The the complete file path under which to save the data.
Saves the bound light field image to the given file.
This augments the meta data with information from the current light field environment and saves them along the image
data. These information contain the current algorithm parameter.
[in,out] The complete file path.
True to update the current meta data so that they are available in the next call to
RxRayGetMetaData; false to update a COPY of the current meta data so that they are NOT
available in the next call to RxRayGetMetaData.
Saves the given light field image to the given file.
This augments the meta data with information from the current light field environment and saves them along the image
data. These information contain the current algorithm parameter.
The ID of the light field image created by calling RxRayLoad, RxRaySeqBind or RxCamBind.
[in,out] The complete file path.
True to update the current meta data so that they are available in the next call to
RxRayGetMetaData; false to update a COPY of the current meta data so that they are NOT
available in the next call to RxRayGetMetaData.
Delete the image with the given ID.
If the ray image referenced by \p uRayHandle is currently bound by a previous call to Rx::LFR::Net::ApiLF::RxRayBind or
Rx::LFR::Net::ApiLF::RxCamStartCapture, the image is not deleted and an exception is thrown.
The handle of the ray image to delete.
Load a ray image.
[in,out] The complete file path of the ray image.
The ray image handle of the ray image.
Create a new ray image.
The allowed pixel types of ray images are
- Rx::Interop::Runtime28::EPixelType::RGBA
- Rx::Interop::Runtime28::EPixelType::Lum
- Rx::Interop::Runtime28::EPixelType::LumA
- Rx::Interop::Runtime28::EPixelType::BayerBG
- Rx::Interop::Runtime28::EPixelType::BayerGB
- Rx::Interop::Runtime28::EPixelType::BayerGR
- Rx::Interop::Runtime28::EPixelType::BayerRG.
Returns the ray handle, which you can use in:
- Rx::LFR::Net::ApiLF::RxRayDelete
- Rx::LFR::Net::ApiLF::RxRaySave
- Rx::LFR::Net::ApiLF::RxRayCalibSaveXML
- Rx::LFR::Net::ApiLF::RxRayCalibXmlGet
- Rx::LFR::Net::ApiLF::RxRayBind
- Rx::LFR::Net::ApiLF::RxRayGetFormat
- Rx::LFR::Net::ApiLF::RxRayGetRaw
- Rx::LFR::Net::ApiLF::RxRayGetMetaData
- Rx::LFR::Net::ApiLF::RxRaySetMetaData.
[in] The ray image format.
The ray image handle of the ray image.
Get set of available values for parameter of type unsigned.
The camera parameter.
[out] The list of available values.
Get the parameter range of a camera parameter of type double from the currently bound camera.
The camera parameter. Allowed parameters from Rx::InteropNet::Runtime30::Camera::EProperty are:
- Rx::InteropNet::Runtime30::Camera::EProperty::TapBalance
- Rx::InteropNet::Runtime30::Camera::EProperty::Gain
- Rx::InteropNet::Runtime30::Camera::EProperty::GainRed
- Rx::InteropNet::Runtime30::Camera::EProperty::GainGreen
- Rx::InteropNet::Runtime30::Camera::EProperty::GainBlue.
[out] On return the minimal parameter value.
[out] On return the maximal parameter value.
Get the parameter range of a camera parameter of type unsignedinteger from the currently bound camera.
The camera parameter. Allowed parameters from Rx::InteropNet::Runtime30::Camera::EProperty are:
- Rx::InteropNet::Runtime30::Camera::EProperty::IsColor
- Rx::InteropNet::Runtime30::Camera::EProperty::IsBayer
- Rx::InteropNet::Runtime30::Camera::EProperty::PIVMode
- Rx::InteropNet::Runtime30::Camera::EProperty::IsOpen
- Rx::InteropNet::Runtime30::Camera::EProperty::IsCapturing
- Rx::InteropNet::Runtime30::Camera::EProperty::TriggerMode
- Rx::InteropNet::Runtime30::Camera::EProperty::ExternalTriggerMode.
[out] On return the minimal parameter value.
[out] On return the maximal parameter value.
Get a set of available values for a parameter of type unsigned integer.
The zero-based camera index.
The camera parameter.
[out] The list of available values.
Get the parameter range of a camera parameter of type double.
The zero-based camera index.
The camera parameter. Allowed parameters from Rx::InteropNet::Runtime30::Camera::EProperty are:
- Rx::InteropNet::Runtime30::Camera::EProperty::TapBalance
- Rx::InteropNet::Runtime30::Camera::EProperty::Gain
- Rx::InteropNet::Runtime30::Camera::EProperty::GainRed
- Rx::InteropNet::Runtime30::Camera::EProperty::GainGreen
- Rx::InteropNet::Runtime30::Camera::EProperty::GainBlue.
[out] On return the minimal parameter value.
[out] On return the maximal parameter value.
Get the parameter range of a camera parameter of type unsigned integer.
The zero-based camera index.
The camera parameter. Allowed parameters from Rx::InteropNet::Runtime30::Camera::EProperty are:
- Rx::InteropNet::Runtime30::Camera::EProperty::IsColor
- Rx::InteropNet::Runtime30::Camera::EProperty::IsBayer
- Rx::InteropNet::Runtime30::Camera::EProperty::PIVMode
- Rx::InteropNet::Runtime30::Camera::EProperty::IsOpen
- Rx::InteropNet::Runtime30::Camera::EProperty::IsCapturing
- Rx::InteropNet::Runtime30::Camera::EProperty::TriggerMode
- Rx::InteropNet::Runtime30::Camera::EProperty::ExternalTriggerMode.
[out] On return the minimal parameter value.
[out] On return the maximal parameter value.
Set a camera property of type double.
Not all parameters may be supported by all Raytrix cameras.
If the parameter referenced by \a ePar does not relate to an double parameter an System::Exception is thrown.
The camera parameter. Allowed parameters from Rx::InteropNet::Runtime30::Camera::EProperty are:
- Rx::InteropNet::Runtime30::Camera::EProperty::Exposure
- Rx::InteropNet::Runtime30::Camera::EProperty::TapBalance
- Rx::InteropNet::Runtime30::Camera::EProperty::Gain
- Rx::InteropNet::Runtime30::Camera::EProperty::GainRed
- Rx::InteropNet::Runtime30::Camera::EProperty::GainGreen
- Rx::InteropNet::Runtime30::Camera::EProperty::GainBlue
- Rx::InteropNet::Runtime30::Camera::EProperty::FramesPerSecond
- Rx::InteropNet::Runtime30::Camera::EProperty::Focus
- Rx::InteropNet::Runtime30::Camera::EProperty::Iris
- Rx::InteropNet::Runtime30::Camera::EProperty::StrobeLength1
- Rx::InteropNet::Runtime30::Camera::EProperty::StrobeLength2
- Rx::InteropNet::Runtime30::Camera::EProperty::StrobeDelay1
- Rx::InteropNet::Runtime30::Camera::EProperty::StrobeDelay2.
The double value.
Set a camera property of type unsigned integer from the currently bound camera.
Not all parameters may be supported by all Raytrix cameras.
If the parameter referenced by ePar does not relate to an unsigned integer parameter an System::Exception is
thrown.
The camera parameter. Allowed parameters from Rx::InteropNet::Runtime30::Camera::EProperty are:
- Rx::InteropNet::Runtime30::Camera::EProperty::Func_CalibMainLens
- Rx::InteropNet::Runtime30::Camera::EProperty::PIVMode
- Rx::InteropNet::Runtime30::Camera::EProperty::TriggerMode
- Rx::InteropNet::Runtime30::Camera::EProperty::ExternalTriggerMode
- Rx::InteropNet::Runtime30::Camera::EProperty::GlobalStart
- Rx::InteropNet::Runtime30::Camera::EProperty::StrobeOn.
The unsigned integer value.
Set a camera property of type Rx::CRxString from the currently bound camera.
Not all parameters may be supported by all Raytrix cameras.
If the parameter referenced by \a ePar does not relate to an unsigned integer parameter an System::Exception
is thrown.
The camera parameter. Allowed parameters from Rx::InteropNet::Runtime30::Camera::EProperty are:
- Rx::InteropNet::Runtime30::Camera::EProperty::TapBalanceMode
- Rx::InteropNet::Runtime30::Camera::EProperty::SourceImageFolder.
[in] The string value.
Set a camera property of type double.
Not all parameters may be supported by all Raytrix cameras.
If the parameter referenced by ePar does not relate to an double parameter an System::Exception is thrown.
The zero-based camera index.
The camera parameter. Allowed parameters from Rx::InteropNet::Runtime30::Camera::EProperty are:
- Rx::InteropNet::Runtime30::Camera::EProperty::Exposure
- Rx::InteropNet::Runtime30::Camera::EProperty::TapBalance
- Rx::InteropNet::Runtime30::Camera::EProperty::Gain
- Rx::InteropNet::Runtime30::Camera::EProperty::GainRed
- Rx::InteropNet::Runtime30::Camera::EProperty::GainGreen
- Rx::InteropNet::Runtime30::Camera::EProperty::GainBlue
- Rx::InteropNet::Runtime30::Camera::EProperty::FramesPerSecond
- Rx::InteropNet::Runtime30::Camera::EProperty::Focus
- Rx::InteropNet::Runtime30::Camera::EProperty::Iris
- Rx::InteropNet::Runtime30::Camera::EProperty::StrobeLength1
- Rx::InteropNet::Runtime30::Camera::EProperty::StrobeLength2
- Rx::InteropNet::Runtime30::Camera::EProperty::StrobeDelay1
- Rx::InteropNet::Runtime30::Camera::EProperty::StrobeDelay2.
The double value.
Set a camera property of type unsigned integer.
Not all parameters may be supported by all Raytrix cameras.
If the parameter referenced by \a ePar does not relate to an unsigned integer parameter an System::Exception
is thrown.
The zero-based camera index.
The camera parameter. Allowed parameters from Rx::InteropNet::Runtime30::Camera::EProperty are:
- Rx::InteropNet::Runtime30::Camera::EProperty::Func_CalibMainLens
- Rx::InteropNet::Runtime30::Camera::EProperty::PIVMode
- Rx::InteropNet::Runtime30::Camera::EProperty::TriggerMode
- Rx::InteropNet::Runtime30::Camera::EProperty::ExternalTriggerMode
- Rx::InteropNet::Runtime30::Camera::EProperty::GlobalStart
- Rx::InteropNet::Runtime30::Camera::EProperty::StrobeOn.
The unsigned integer value.
Set a camera property of type Rx::CRxString.
Not all parameters may be supported by all Raytrix cameras.
If the parameter referenced by ePar does not relate to an unsigned integer parameter an System::Exception is
thrown.
The zero-based camera index.
The camera parameter. Allowed parameters from Rx::InteropNet::Runtime30::Camera::EProperty are:
- Rx::InteropNet::Runtime30::Camera::EProperty::TapBalanceMode
- Rx::InteropNet::Runtime30::Camera::EProperty::SourceImageFolder.
[in] The returned String value.
Get camera parameter of type Rx::CRxArrayString.
Not all parameters may be supported by all Raytrix cameras.
If the parameter referenced by ePar does not relate to an string-array parameter an System::Exception is
thrown.
The camera parameter.
[out] The returned string array value.
Get camera parameter of type double from the currently bound camera.
Not all parameters may be supported by all Raytrix cameras.
If the parameter referenced by ePar does not relate to an double parameter an System::Exception is thrown.
thrown.
The camera parameter ID. Allowed parameters from Rx::InteropNet::Runtime30::Camera::EProperty are:
- Rx::InteropNet::Runtime30::Camera::EProperty::Exposure
- Rx::InteropNet::Runtime30::Camera::EProperty::TapBalance
- Rx::InteropNet::Runtime30::Camera::EProperty::Gain
- Rx::InteropNet::Runtime30::Camera::EProperty::GainRed
- Rx::InteropNet::Runtime30::Camera::EProperty::GainGreen
- Rx::InteropNet::Runtime30::Camera::EProperty::GainBlue
- Rx::InteropNet::Runtime30::Camera::EProperty::FramesPerSecond
- Rx::InteropNet::Runtime30::Camera::EProperty::ActualFramesPerSecond
- Rx::InteropNet::Runtime30::Camera::EProperty::Focus
- Rx::InteropNet::Runtime30::Camera::EProperty::Iris
- Rx::InteropNet::Runtime30::Camera::EProperty::Temperature.
- Rx::InteropNet::Runtime30::Camera::EProperty::StrobeLength1
- Rx::InteropNet::Runtime30::Camera::EProperty::StrobeLength2
- Rx::InteropNet::Runtime30::Camera::EProperty::StrobeDelay1
- Rx::InteropNet::Runtime30::Camera::EProperty::StrobeDelay2.
[out] The returned double value.
Get a camera parameter of type unsigned integer from the currently bound camera.
Not all parameters may be supported by all Raytrix cameras.
If the parameter referenced by ePar does not relate to an unsigned integer parameter an System::Exception is
thrown.
The camera parameter. Allowed parameters from Rx::InteropNet::Runtime30::Camera::EProperty are:
- Rx::InteropNet::Runtime30::Camera::EProperty::IsColor
- Rx::InteropNet::Runtime30::Camera::EProperty::IsBayer
- Rx::InteropNet::Runtime30::Camera::EProperty::Width
- Rx::InteropNet::Runtime30::Camera::EProperty::Height
- Rx::InteropNet::Runtime30::Camera::EProperty::OffsetX
- Rx::InteropNet::Runtime30::Camera::EProperty::OffsetY
- Rx::InteropNet::Runtime30::Camera::EProperty::Func_CalibMainLens
- Rx::InteropNet::Runtime30::Camera::EProperty::PIVMode
- Rx::InteropNet::Runtime30::Camera::EProperty::IsOpen
- Rx::InteropNet::Runtime30::Camera::EProperty::IsCapturing
- Rx::InteropNet::Runtime30::Camera::EProperty::TriggerMode
- Rx::InteropNet::Runtime30::Camera::EProperty::ExternalTriggerMode.
- Rx::InteropNet::Runtime30::Camera::EProperty::HasIPConfig
- Rx::InteropNet::Runtime30::Camera::EProperty::GlobalStart
- Rx::InteropNet::Runtime30::Camera::EProperty::StrobeOn.
[out] The returned unsigned integer value.
Get a camera parameter of type Rx::CRxString from the currently bound camera.
Not all parameters may be supported by all Raytrix cameras.
If the parameter referenced by ePar does not relate to a string parameter an System::Exception is thrown.
The camera parameter. Allowed parameters from Rx::InteropNet::Runtime30::Camera::EProperty are:
- Rx::InteropNet::Runtime30::Camera::EProperty::DriverName
- Rx::InteropNet::Runtime30::Camera::EProperty::InternalModelName
- Rx::InteropNet::Runtime30::Camera::EProperty::RaytrixModelName
- Rx::InteropNet::Runtime30::Camera::EProperty::HardwareId
- Rx::InteropNet::Runtime30::Camera::EProperty::Serial
- Rx::InteropNet::Runtime30::Camera::EProperty::TapBalanceMode
- Rx::InteropNet::Runtime30::Camera::EProperty::SourceImageFolder.
[out] The returned string value.
Get camera parameter of type Rx::CRxArrayString.
Not all parameters may be supported by all Raytrix cameras.
If the parameter referenced by ePar does not relate to a string-array parameter an System::Exception is thrown.
The zero-based camera index.
The camera parameter.
[out] The returned double value.
Get camera parameter of type double
Not all parameters may be supported by all Raytrix cameras.
If the parameter referenced by ePar does not relate to an double parameter an System::Exception is thrown.
The zero-based camera index.
The camera parameter. Allowed parameters from Rx::InteropNet::Runtime30::Camera::EProperty are:
- Rx::InteropNet::Runtime30::Camera::EProperty::Exposure
- Rx::InteropNet::Runtime30::Camera::EProperty::TapBalance
- Rx::InteropNet::Runtime30::Camera::EProperty::Gain
- Rx::InteropNet::Runtime30::Camera::EProperty::GainRed
- Rx::InteropNet::Runtime30::Camera::EProperty::GainGreen
- Rx::InteropNet::Runtime30::Camera::EProperty::GainBlue
- Rx::InteropNet::Runtime30::Camera::EProperty::FramesPerSecond
- Rx::InteropNet::Runtime30::Camera::EProperty::ActualFramesPerSecond
- Rx::InteropNet::Runtime30::Camera::EProperty::Focus
- Rx::InteropNet::Runtime30::Camera::EProperty::Iris
- Rx::InteropNet::Runtime30::Camera::EProperty::Temperature
- Rx::InteropNet::Runtime30::Camera::EProperty::StrobeLength1
- Rx::InteropNet::Runtime30::Camera::EProperty::StrobeLength2
- Rx::InteropNet::Runtime30::Camera::EProperty::StrobeDelay1
- Rx::InteropNet::Runtime30::Camera::EProperty::StrobeDelay2.
[out] The returned double value.
Get a camera parameter of type unsigned integer.
Not all parameters may be supported by all Raytrix cameras.
If the parameter referenced by ePar does not relate to an unsigned integer parameter an System::Exception is
thrown.
The zero-based camera index.
The camera parameter ID. Allowed parameters from Rx::InteropNet::Runtime30::Camera::EProperty are:
- Rx::InteropNet::Runtime30::Camera::EProperty::IsColor
- Rx::InteropNet::Runtime30::Camera::EProperty::IsBayer
- Rx::InteropNet::Runtime30::Camera::EProperty::Width
- Rx::InteropNet::Runtime30::Camera::EProperty::Height
- Rx::InteropNet::Runtime30::Camera::EProperty::OffsetX
- Rx::InteropNet::Runtime30::Camera::EProperty::OffsetY
- Rx::InteropNet::Runtime30::Camera::EProperty::Func_CalibMainLens
- Rx::InteropNet::Runtime30::Camera::EProperty::PIVMode
- Rx::InteropNet::Runtime30::Camera::EProperty::IsOpen
- Rx::InteropNet::Runtime30::Camera::EProperty::IsCapturing
- Rx::InteropNet::Runtime30::Camera::EProperty::TriggerMode
- Rx::InteropNet::Runtime30::Camera::EProperty::ExternalTriggerMode
- Rx::InteropNet::Runtime30::Camera::EProperty::HasIPConfig
- Rx::InteropNet::Runtime30::Camera::EProperty::GlobalStart
- Rx::InteropNet::Runtime30::Camera::EProperty::StrobeOn.
[out] The returned unsigned integer value.
Get a camera parameter of type Rx::CRxString.
Not all parameters may be supported by all Raytrix cameras.
If the parameter referenced by ePar does not relate to a string parameter a System::Exception is thrown.
The zero-based camera index.
The camera parameter. Allowed parameters from Rx::InteropNet::Runtime30::Camera::EProperty are:
- Rx::InteropNet::Runtime30::Camera::EProperty::DriverName
- Rx::InteropNet::Runtime30::Camera::EProperty::ModelName
- Rx::InteropNet::Runtime30::Camera::EProperty::HardwareId
- Rx::InteropNet::Runtime30::Camera::EProperty::Serial
- Rx::InteropNet::Runtime30::Camera::EProperty::TapBalanceMode
- Rx::InteropNet::Runtime30::Camera::EProperty::SourceImageFolder.
[out] The returned string value.
Test whether a camera parameter is supported by the currently bound camera.
All camera and camera calibration parameters can be tested with this function. Use this function to test whether
certain parameters are available or not. For example, the parameters: Rx::InteropNet::Runtime30::Camera::EProperty::Focus, Rx::InteropNet::Runtime30::Camera::EProperty::Iris,
Rx::InteropNet::Runtime30::Camera::EProperty::Func_CalibMainLens are only available if a camera is attached that allows the direct control of the main lens.
The camera parameter.
On return indicates whether the parameter ePar is supported or not.
Test whether a camera parameter is supported by the given camera.
All camera and camera calibration parameters can be tested with this function. Use this function to test whether
certain parameters are available or not. For example, the parameters: Rx::InteropNet::Runtime30::Camera::EProperty::Focus, Rx::InteropNet::Runtime30::Camera::EProperty::Iris,
Rx::InteropNet::Runtime30::Camera::EProperty::Func_CalibMainLens are only available if a camera is attached that allows the direct control of the main lens.
The camera parameter ID.
The zero-based camera index.
True if the parameter is supported, otherwise false.
Assign the gray image of the calibration with the given GUID to the bound calibration. This copies the gray image.
[in] The unique identifier of the calibration with the gray image to copy.
true to load gray image.
Bind gray image of calibration to API and use this image as gray image too. Now you can calibrate a calibration without
using a camera.
This function returns the image ID of the bound gray image in uImgID.
After using this image, you have to delete it to free the memory by calling Rx::LFR::Net::ApiLF::RxRayDelete.
[out] Image ID of the bound gray image.
[in] The GUID of the calibration.
Sets calibration data to the last applied calibration.
[in] Information describing the calibration.
Sets Rx::Net::CalibMetaData for calibration with given GUID sGUID.
Only certain parameters will be considered. The GUID, camera serial and camera type cannot be set.
[in] The calibration data.
[in] The GUID of the calibration.
Gets the last applied calibration data.
[out] Information describing the calibration.
Gets Rx::Net::CalibMetaData for calibration with given GUID sGUID.
[out] The calibration data.
[in] The GUID of the calibration.
Gets a string which contains the GUID of the master calibration of this camera.
[out] String of GUID.
Zero-based index of the camera.
Gets a string array which contains GUIDs of all master calibration on this computer.
[out] string array of GUIDS.
Gets an array<string> which contains unique IDs of all calibration for camera with given index uCamIdx.
[out] Array of GUIDs.
Zero-based index of the camera.
Gets an array<string> which contains GUIDs of all calibration on this computer.
[out] array of GUIDS.
Gets calibration (The camera calibration) from current bound image and saves it to current calibration. Also saves
database to disk.
There must be a bound image before calling this function.
Gets (The camera calibration) from current bound image and saves it to the calibration defined by GUID sxGUID Also
saves database to disk.
There must be a bound image before calling this function.
[in] GUID of the calibration which should be saved.
Applies the currently bound camera calibration to the current bound image in API. Also updates to the computational
class.
There must be a bound image before calling this function.
If true, the current gray image is replaced by the one from the given calibration.
Applies the camera calibration defined by GUID sxGUID to the currently bound image in API. Also updates the
computational class.
[in] GUID of the calibration which should be applied to bound image.
If true, the current gray image is replaced by the one from the given calibration.
Deletes camera calibration with GUID sxGUID.
If there is no calibration database for given parameters, an System::Exception is thrown.
[in] The GUID of the calibration to delete.
Creates a new calibration and returns the GUID of the newly created calibration.
The GUID of the newly created calibration.
Creates a new calibration and returns the GUID of the newly created calibration.
id of a camera.
The GUID of the newly created calibration.
Creates a new calibration and returns the GUID of the newly created calibration.
[in] Unique identifier for the new calibration.
The GUID of the newly created calibration.
Creates a new calibration database for camera with name sxCamHardwareId.
If a calibration database for this camera already exists, a new one will only be created if bForce is true Otherwise a
System::Exception is thrown.
[in] Type of the camera.
Flags whether to overwrite an existing database or not.
Creates a new calibration database for camera with ID uCamIdx
If a calibration database for this camera already exists, a new one will only be created if bForce is true.
Otherwise a System::Exception is thrown.
Zero-based index of the camera.
Flags whether to overwrite an existing database or not.
Creates a new calibration database for bound camera.
If a calibration database for this camera already exists, a new one will only be created if bForce is true Otherwise a
System::Exception is thrown.
Flags whether to overwrite an existing database or not.
Retrieve a single image from the currently bound camera.
This function only returns after an image has been retrieved by the camera and is available on the CUDA device. The
camera image is retrieved into the image referenced by the ray image handle returned by the function
Rx::LFR::Net::ApiLF::RxCamBind. It is also automatically copied onto the CUDA device, so that all processing of the light field
image can be done purely on the CUDA device without repeated copying of the light-field image from host to device
memory.
true if an image was available, false otherwise.
Triggers capturing of a single image of the currently bound camera. The image can be retrieved by calling
Rx::LFR::Net::ApiLF::RxCamRetrieveImage.
Suspend capturing images.
This function stops the data transfer between camera and computer but keeps all other capture settings.
True to suspend camera capture and false to restart camera capture.
Stops capturing of the currently bound camera. If the camera is not in capture mode, the function simply returns
without error.
Prepares the currently bound camera for capturing images. If the currently bound camera is already in capture mode,
then the function throws an exception.
Calling this function does not actually capture any images but prepares the camera for capturing images.The
function also reads the calibration data of the currently bound camera from the path set as sxCalibPath in
Rx::LFR::Net::ApiLF::RxInit.
Unbinds a currently bound camera. If the bound camera is still capturing images, the capturing is stopped and then the
camera is unbound.
Binds the given camera to the returned API image ID. Call RxCamUnBind to unbind the bound camera. Only one camera can
be bound. Calling Rx::LFR::Net::ApiLF::RxCamBind with another camera index results in an System::Exception.
The internal ray image with ID returned by this function is not deleted from memory when camera is unbound. It has to
be deleted explicitly using Rx::LFR::Net::ApiLF::RxRayDelete when it is no longer needed.
Zero-based index of the camera.
The ray image handle of the image into which camera images are captured.
Closes the given camera. If the given camera is currently bound, the camera is unbound before closing. Also, if the
camera is in capture mode, the capturing is stopped before unbinding.
The zero-based index of the camera to close.
Opens the given camera. Camera settings can only be accessed after a camera has been opened. The first call to open
initializes the camera too.
If initialization fails, an System::Exception is thrown that holds the reason of failure.
The zero-based index of the camera to open.
Register available cameras.
This functions registers all cameras that are currently available. Only registered cameras can be used by the Raytrix
API. This function can be called repeatedly to update the list of available cameras. This function has to be called
before any other API camera function.
Return free and total amount of memory on the selected CUDA device.
[out] On return contains the amount of free memory in bytes.
[out] On return contains the amount of total memory in bytes.
Select a CUDA device.
This function must be called once and only once per process. The selected CUDA device cannot be changed during runtime.
Use the functions Rx::LFR::Net::ApiLF::RxCudaDeviceCount and Rx::LFR::Net::ApiLF::RxCudaDeviceProp to obtain information about the
installed CUDA devices and then select the most appropriate CUDA device with this function. If iDevice is set to -1,
the first appropriate CUDA device is selected.
To exchange image data generated by CUDA directly with an OpenGL rendering context on the same device, bUseGL has to be
set to true and the CUDA device has to support OpenGL 3.0 or higher. Note that CUDA/DirectX interop. is currently not
supported.
For further details on CUDA/OpenGL interop.
The zero-based CUDA device ID or -1 for automatic selection.
Flag indicating whether to initialize CUDA for OpenGL interop. or not.
Get the name and the compute capability major and minor version for a CUDA device.
Zero-based ID of the CUDA device.
[out] On return contains the name of the CUDA device.
[out] On return contains the major version of the CUDA device compute capability.
[out] On return contains the minor version of the CUDA device compute capability.
Returns the number of CUDA devices installed.
The number of CUDA devices.
Get the IDs of an attached dongle.
[in] On return contains the hardware dongle ID.
[in] On return contains the Raytrix dongle ID.
Test whether the Dongle offers a given feature.
Not all functions of this API are necessarily available. This depends on the currently active license, which is defined
by the Raytrix dongle attached to the system.
The feature to check for availability.
true if the feature is available, false otherwise.
Test whether the Dongle offers the given features.
Not all functions of this API are necessarily available. This depends on the currently active license, which is defined
by the Raytrix dongle attached to the system. To check whether a set of features is available you can OR the
corresponding feature IDs. The feature IDs are available through defines all starting with
Rx::Dongle::ERuntimeFeature::ID. For example, to test for the features multiview and 3D evaluation call:
if(Rx::LFR::Net::ApiLF::RxHasFeature(Rx::Dongle::ERuntimeFeature::SDK | Rx::Dongle::ERuntimeFeature::RxLive)){...}
A OR-ed list of Rx::Dongle::ERuntimeFeature::ID to check for availability.
true if the feature is available, false otherwise.
Sets details about the application that uses this runtime currently. Saving a ray file will write this details into the
meta data of the file.
[in] The application name.
[in] The application version.
Gets the release date of this version of the Raytrix Light Field Runtime. Can be called without initializing the API.
The release date.
Close any open cameras and free all memory allocated on CUDA device and in host memory.
Make sure to call this function before ending your program. Otherwise the CUDA device memory will fill up with repeated
execution of the software.
Initialize the Raytrix API.
Before any light field images can be loaded, recorded or processed a CUDA device has to be chosen using the function
Rx::LFR::Net::ApiLF::RxCudaSelectDevice.To access Raytrix cameras you first have to call Rx::LFR::Net::ApiLF::RxCamRegister.
After executing Rx::LFR::Net::ApiLF::RxInit neither a CUDA device is selected nor a camera device initialized.
If set to false only functionality that does not rely on CUDA can be used.
[in] The absolute path to the camera driver DLLs (RaytrixCamera_*.dll).
[in] The absolute path to the camera calibration directories.
Initialize the Raytrix API.
Before any light field images can be loaded, recorded or processed a CUDA device has to be chosen using the function
Rx::LFR::Net::ApiLF::RxCudaSelectDevice.To access Raytrix cameras you first have to call Rx::LFR::Net::ApiLF::RxCamRegister.
After executing Rx::LFR::Net::ApiLF::RxInit neither a CUDA device is selected nor a camera device initialized.
[in] If set to false only functionality that does not rely on CUDA can be used.
[in] The absolute path to the camera driver DLLs (RaytrixCamera_*.dll).
Initialize the Raytrix API.
Before any light field images can be loaded, recorded or processed a CUDA device has to be chosen using the function
Rx::LFR::Net::ApiLF::RxCudaSelectDevice.To access Raytrix cameras you first have to call Rx::LFR::Net::ApiLF::RxCamRegister.
After executing Rx::LFR::Net::ApiLF::RxInit neither a CUDA device is selected nor a camera device initialized.
The callback wrapper.
Event queue for all listeners interested in StatusMessage events.
Gets the interface defined by the given interface ID.
The interface ID.
Null if it fails, else the interface.
Gets the interface defined by the given interface ID.
The interface ID.
Null if it fails, else the interface.
API LF class.
Native handler of image captured events.
The captured image.
The index of the camera in the camera server.
[in,out] The context registered with the callback.
Handler of image captured events.
The index of the camera in the camera server.
Removes the computation filter mask image set by Rx::LFR::CApiLF::RxSetComputationFilterMask.
Sets the computation filter mask image.
This image is used to reduce the number of lenses used for depth estimation (Rx::LFR::CApiLF::RxDepthRay).
It must have the same dimension as the raw image and a pixel type of Rx::Interop::Runtime28::EPixelType::Lum and a data
type of Rx::Interop::Runtime28::EDataType::UByte.
Each lens of the raw image has a lens center that can be rounded to a pixel. If this pixel has the value 255 in the
filter mask image, the corresponding lens is used. If this pixel has another value, the lens is not used.
The complete file path of the computation filter mask image to load.
Sets the computation filter mask image.
This image is used to reduce the number of lenses used for depth estimation (Rx::LFR::CApiLF::RxDepthRay).
It must have the same dimension as the raw image and a pixel type of Rx::Interop::Runtime28::EPixelType::Lum and a data
type of Rx::Interop::Runtime28::EDataType::UByte.
Each lens of the raw image has a lens center that can be rounded to a pixel. If this pixel has the value 255 in the
filter mask image, the corresponding lens is used. If this pixel has another value, the lens is not used.
The computation filter mask image.
Saves the depth values of the current Depth3D image to the given file as a point list.
The formats available are:
ASCII:
- .txt -- one point per row as plain text (default when no other extension matches, .txt is appended to filename)
- .xyz -- conform to the 'xyz' file standard (augments txt format with small header)
Binary:
- .pcd -- the 'Point Cloud Data' format, see http://pointclouds.org/documentation/tutorials/pcd_file_format.php.
The complete file path.
True to save the point list in virtual depth units instead of metric units.
The crop left perc.
The crop right perc.
The crop top perc.
The crop bottom perc.
Saves the depth values of the current Depth3D image to the given file as a point list.
The formats available are:
ASCII:
- .txt -- one point per row as plain text (default when no other extension matches, .txt is appended to filename)
- .xyz -- conform to the 'xyz' file standard (augments txt format with small header)
Binary:
- .pcd -- the 'Point Cloud Data' format, see http://pointclouds.org/documentation/tutorials/pcd_file_format.php.
The complete file path.
True to save the point list in virtual depth units instead of metric units.
Saves the 3D mesh provided by image 'Depth3D' to binary STL format. This requires a valid image computed by
Rx::LFR::CApiLF::RxDepth3D. Triangles with a depth-variation larger than 'dMaxEdgeLength' for at least one vertex pair are
not added to the mesh.
The complete file path.
True to save the mesh in virtual depth uni
ts instead of metric units.
Limit for depth-variation in vertices. -1 = infinity.
the percentage of the cropping on the left side.
the percentage of the cropping on the right side.
the percentage of the cropping on the top side.
the percentage of the cropping on the bottom side.
Saves the 3D mesh provided by image 'Depth3D' to binary STL format. This requires a valid image computed by
Rx::LFR::CApiLF::RxDepth3D. Triangles with a depth-variation larger than 'dMaxEdgeLength' for at least one vertex pair are
not added to the mesh.
The complete file path.
True to save the mesh in virtual depth units instead of metric units.
(Optional) Limit for depth-variation in vertices. -1 = infinity.
Colorizes the depth map created by Rx::LFR::CApiLF::RxDepthMap.The result is stored in the image with the ID
LFR::EImage::Depth3D.
The space.
Object space depth 3D.
This creates a RGBA float image which maps each pixel in the view camera to a 3D position in object space. The R
channel is the X coordinate, the G channel is the Y coordinate and the B channel is the Z coordinate. The Z coordinate
is relative to the global coordinate system which typically coincides with the light field camera sensor. All
coordinate values are given in millimeters.
The image is stored in the image with the ID LFR::EImage::Depth3D.
Creates a depth map from the ray depth image created by Rx::LFR::CApiLF::RxDepthRay.
The space.
Estimates the depth of the bound ray image and stores the result in the image with the ID LFR::EImage::DepthRay.
Creates a multi view image and stores the result in the image with the ID LFR::EImage::Multiview_ViewCamera.
Focus on a depth surface.
In principle, each pixel of the result image can be focused individually. The function Rx::LFR::CApiLF::RxTotalFocus
makes this property available by focusing the ray image to the depth surface given in the internal depth image related
to the target space that is selected. To calculate the depth image you have to call Rx::LFR::CApiLF::RxDepthRay first
and next Rx::LFR::CApiLF::RxDepthMap, or by a user defined image set with Rx::LFR::CApiLF::RxSetImage.
When setting a depth image with Rx::LFR::CApiLF::RxSetImage it need not have the same dimensions as the resultant
image. The given depth map is implicitly scaled to the size of the resultant refocused image.
If the size of the given depth map image is 1x1 pixel, the depth encoded for that pixel is applied to all focused
pixel. The depth image has to be of pixel type Rx::Interop::Runtime28::EPixelType::Lum and data type
Rx::Interop::Runtime28::EDataType::UByte. The pixel value range of [0,255] is mapped to [0,1] for the interpretation as
depth.
\attention The result is written to the internal image related to the given space. The size of this resultant image is
set in relation to the ray image size via the parameter Rx::LFR::Params::EApiLF::Focus_ImageDivisor.
The space.
Focus image to a plane perpendicular to the optical axis, i.e. parallel to the image plane.
This focuses to a plane perpendicular to the optical axis. To change the focal plane, use parameter
Rx::LFR::Params::EApiLF::Focus_RelativeFocusPlane. A relative focus value of zero refocuses to the plane furthest away from the
viewer and a value of 1 would focus to a plane that passes through the object side focal point of the recording lens.
The result is written to the internal image with ID LFR::EImage::RefocusBasic. The size of this resultant image is set
in relation to the ray image size via the parameter Rx::LFR::Params::EApiLF::Focus_ImageDivisor.
Show a lens grid overlay on the raw ray image.
The result is written to the internal image with ID LFR::EImage::Grid.
Pre Process a ray image with a minimal Set of preprocessing parameter.
This function does the same preprocessing as Rx::LFR::CApiLF::RxPreProcess but all preprocessing flags with exception of
debayering are deactivated.
Pre-Process a ray image.
The ray image that is bound with RxRayBind() is a raw lightfield image. Before this ray image can be used by the actual
processing algorithms, it has to be adjusted by applying a rectification of a possible radial distortion and by
adjusting its brightness and color with respect to a gray image.
Enables or disables a callback during automatic grid calibration via RxGridCalibrateMli, RxGridCalibrateMla and
RxGridCalibrateMaster.
True to enable, false to disable.
Automatically calibrates the MLA rotation steps and the MLA reflection. Requires master dongle feature.
Returns false if estimation has been failed because of wrong exposure or aperture configuration.
Automatically calibrates MLA grid. Requires master dongle feature.
Returns false if estimation has been failed because of wrong exposure or aperture configuration.
Automatically calibrates MLI grid.
Returns false if estimation has been failed because of wrong exposure or aperture configuration.
Unlocks the CUDA Mutex.
Locks the CUDA Mutex.
If the mutex is locked, the timeout defines the time in ms until a Rx::CRxException is
thrown.
True if it succeeds, false if it fails.
Projects the given source depth value into the given target space.
The source depth in millimeter or virtual depths.
The source space.
True if the source depth is given in virtual depths. Is ignored if the source space isn't virtual.
The target space.
True if the target depth should be given in virtual depths. Is ignored if the target space isn't virtual.
The resultant target depth in millimeter or virtual depths.
Projects an array of points from the given source space into the given target space.
[out] The array of projected points.
The array of points to project.
The target space.
The source space.
True if all projections succeeded, false if at least one projection failed (out of sensor or image projection).
Calculates the histogram of the image with the given eImgID and stores the histogram data in the given array.
This array must be large enough to hold 4 * 256 numbers. The number of calculated channels is returned in uChannels.
The image ID.
[out] A reference of Rx::CRxArrayUInt where the histogram will be stored.
[out] The number of channels.
Finds the minimum and maximum value of the given eImgID
The image ID.
The channel.
[out] The minimum value.
[out] The maximum value.
Resize an image.
[out] The target image to store the result.
[in] The image that is to be resized.
[in] The image size divider. For example, if iDivder = 2, then the resultant image size is half the
original size.
Gets device pointer pitch, which is the width in bytes of the allocation. Given a row and column of an array element of
type T, the address is computed as:
T* pElement = (T*)((char*)BaseAddress + Row * pitch) + Column;
Internal image ID. This is not a ray image handle.
The image device pointer pitch.
Get the device pointer of an internal image.
This function returns the image device pointer of an internal image. The available internal image IDs are listed in
Rx::LFR::CApiLF::EImgID.
Internal image ID. This is not a ray image handle.
[out] On return contains the internal image's device pointer.
Get the image format of an internal image.
This function returns the image format of an internal image without copying the actual image from the CUDA device to
host memory.
The available internal image IDs are listed in Rx::LFR::CApiLF::EImgID.
Internal image ID. This is not a ray image handle.
[out] On return contains the internal image's format.
Frees memory used by the image defined in eImgID. This invalidates the image.
The image ID.
Test whether an internal image is valid.
The available internal image IDs are listed in Rx::LFR::CApiLF::EImgID.
Internal image ID. This is not a ray image handle.
true if the image is valid, false otherwise.
Set an internal image.
The available internal image IDs are listed in Rx::LFR::CApiLF::EImgID.
A new ray image can be set with eImgID set to LFR::EImage::Raw and a new gray image with
LFR::EImage::Gray. RxSetImage copies the image data into the currently bound ray image and to the CUDA
device.
For the new ray image to be used in calculations you must call Rx::LFR::CApiLF::RxPreProcess after setting the ray and the
gray image.
You can also circumvent the internal preprocessing of the ray image by writing directly the processed ray image to the
CUDA device with LFR::EImage::Processed_Normalized. However, this will not change the
LFR::EImage::Raw or LFR::EImage::Gray images currently bound.
Internal image ID. This is not a ray image handle.
The image to copy into the specified internal image.
Set an internal image.
The available internal image IDs are listed in Rx::LFR::CApiLF::EImgID.
A new ray image can be set with eImgID set to LFR::EImage::Raw and a new gray image with LFR::EImage::Gray.
RxSetImage copies the image data into the currently bound ray image and to the CUDA device. For the new ray image to be
used in calculations you must call Rx::LFR::CApiLF::RxPreProcess after setting the ray and the gray image.
You can also circumvent the internal preprocessing of the ray image by writing directly the processed ray image to the
CUDA device with LFR::EImage::Processed_Normalized. However, this will not change the LFR::EImage::Raw or
LFR::EImage::Gray images currently bound.
Internal image ID. This is not a ray image handle.
The image to copy into the specified internal image.
Get an internal image.
The available internal image IDs are listed in Rx::LFR::CApiLF::EImgID.
Internal image ID. This is not a ray image handle.
[out] On return contains a copy of the specified internal image.
If true, a new image is created in pImage. Otherwise, it is ensured that pImage refers to an image
the same size and type as the respective internal image, and then the internal image is copied.
Get an internal image.
The available internal image IDs are listed in Rx::LFR::CApiLF::EImgID.
Internal image ID. This is not a ray image handle.
[out] On return contains a copy of the specified internal image.
Convert a Rx::CRxImage to a new pixel and data type.
[out] Destination image.
Reference to the image.
Pixel type of the converted image.
Data type of the converted image.
if true, memory for the destination image is created by this function.
Convert a Rx::CRxImage to a new pixel and data type.
[out] Destination image.
Reference to the image.
Pixel type of the converted image.
Data type of the converted image.
Resets all parameters to their default value.
Loads all writable API parameter from file. Its mandatory to bind a light field image before.
The filename.
Saves all writable API parameter to file. Its mandatory to bind a light field image before.
The filename.
Get the Properties of a parameter.
The parameter ID.
[out] On return contains the parameter string representation.
[out] On return contains the parameter ReadAccess flag.
[out] On return contains the parameter WriteAccess flag.
[out] On return contains the parameter DataType.
Get the string representation of a parameter.
The parameter ID.
[out] On return contains the parameter string representation.
Get the value range of an array parameter and the min and max allowed number of elements in the array.
The ID of the parameter.
[out] The min number of values allowed in the array.
[out] The max number of values allowed in the array.
[out] The min allowed value of the parameter.
[out] The max allowed value of the parameter.
Get the value range of an array parameter and the min and max allowed number of elements in the array.
The ID of the parameter.
[out] The min number of values allowed in the array.
[out] The max number of values allowed in the array.
[out] The min allowed value of the parameter.
[out] The max allowed value of the parameter.
Get the value range of a parameter.
The ID of the parameter.
[out] The min allowed value of the parameter.
[out] The max allowed value of the parameter.
Get the value range of a parameter.
The ID of the parameter.
[out] The min allowed value of the parameter.
[out] The max allowed value of the parameter.
Gets the value of a parameter.
The ID of the parameter.
[out] The value of the parameter.
Gets the value of a parameter.
The ID of the parameter.
[out] The value of the parameter.
Gets the value of a parameter.
The ID of the parameter.
[out] The value of the parameter.
Gets the value of a parameter.
The ID of the parameter.
[out] The value of the parameter.
Gets the value of a parameter.
The ID of the parameter.
[out] The value of the parameter.
Gets the value of a parameter.
The ID of the parameter.
[out] The value of the parameter.
Sets the value of a parameter.
The ID of the parameter.
[in] The value of the parameter.
Sets the value of a parameter.
The ID of the parameter.
[in] The value of the parameter.
Sets the value of a parameter.
The ID of the parameter.
[in] The value of the parameter.
Sets the value of a parameter.
The ID of the parameter.
[in] The value of the parameter.
Sets the value of a parameter.
The ID of the parameter.
[in] The value of the parameter.
Sets the value of a parameter.
The ID of the parameter.
[in] The value of the parameter.
Get the Properties of a parameter.
The parameter ID.
[out] On return contains the parameter string representation.
[out] On return contains the parameter ReadAccess flag.
[out] On return contains the parameter WriteAccess flag.
[out] On return contains the parameter DataType.
Get the string representation of a parameter.
The parameter ID.
[out] On return contains the parameter string representation.
Get the value range of an array parameter and the min and max allowed number of elements in the array.
The ID of the parameter.
[out] The min number of values allowed in the array.
[out] The max number of values allowed in the array.
[out] The min allowed value of the parameter.
[out] The max allowed value of the parameter.
Get the value range of an array parameter and the min and max allowed number of elements in the array.
The ID of the parameter.
[out] The min number of values allowed in the array.
[out] The max number of values allowed in the array.
[out] The min allowed value of the parameter.
[out] The max allowed value of the parameter.
Get the value range of a parameter.
The ID of the parameter.
[out] The min allowed value of the parameter.
[out] The max allowed value of the parameter.
Get the value range of a parameter.
The ID of the parameter.
[out] The min allowed value of the parameter.
[out] The max allowed value of the parameter.
Gets the value of a parameter.
The ID of the parameter.
[out] The value of the parameter.
Gets the value of a parameter.
The ID of the parameter.
[out] The value of the parameter.
Gets the value of a parameter.
The ID of the parameter.
[out] The value of the parameter.
Gets the value of a parameter.
The ID of the parameter.
[out] The value of the parameter.
Gets the value of a parameter.
The ID of the parameter.
[out] The value of the parameter.
Gets the value of a parameter.
The ID of the parameter.
[out] The value of the parameter.
Sets the value of a parameter.
The ID of the parameter.
[in] The value of the parameter.
Sets the value of a parameter.
The ID of the parameter.
[in] The value of the parameter.
Sets the value of a parameter.
The ID of the parameter.
[in] The value of the parameter.
Sets the value of a parameter.
The ID of the parameter.
[in] The value of the parameter.
Sets the value of a parameter.
The ID of the parameter.
[in] The value of the parameter.
Sets the value of a parameter.
The ID of the parameter.
[in] The value of the parameter.
Get the Properties of a parameter.
The parameter ID.
[out] On return contains the parameter string representation.
[out] On return contains the parameter ReadAccess flag.
[out] On return contains the parameter WriteAccess flag.
[out] On return contains the parameter DataType.
Get the string representation of a parameter.
The parameter ID.
[out] On return contains the parameter string representation.
Get the value range of a parameter.
The ID of the parameter.
[out] The min allowed value of the parameter.
[out] The max allowed value of the parameter.
Gets the value of a parameter.
The ID of the parameter.
[out] The value of the parameter.
Sets the value of a parameter.
The ID of the parameter.
[in] The value of the parameter.
Store the threads current OpenGL context. The context can be retrieved with RxGlGetContext() and released with
RxGlReleaseContext.
Releases the OpenGL context owned by the calling thread.
Another thread can get the released context via Rx::LFR::CApiLF::RxGlGetContext. If the calling thread hasn't a valid context
this function will do nothing and only returns.
Assigns the OpenGL context created by Rx::LFR::CApiLF::RxCudaSelectDevice to the calling thread.
Before assigning a context, the thread that has the context currently must release it via
Rx::LFR::CApiLF::RxGlReleaseContext().
Get the OpenGL texture ID corresponding to given parameter eImgID The content of this texture can be updated
with the Rx::LFR::CApiLF::RxGlUpdateTex function.
The image ID.
The identifier for the OpenGL texture.
Get the OpenGL texture ID corresponding to given parameter eImgID The content of this texture can be updated
with the Rx::LFR::CApiLF::RxGlUpdateTex function.
The image ID.
[out] Identifier for the OpenGL texture.
Copy CUDA result images to OpenGL textures.
The internal image IDs that can be used with this function are those declared in Rx::LFR::CApiLF::EImgID. Combining a number
of image IDs by OR, updates all the related textures.
Internal image ID. A number of internal image IDs can be combined with OR operation.
(optional) the create mipmaps flag.
Get OpenGL version of current OpenGL rendering context.
This function only return a meaningful result if it is called within an active OpenGL rendering context.
[out] On return contains the OpenGL major version.
[out] On return contains the OpenGL minor version.
Get the doubleshot mode used when recording the given sequence.
The ray sequence id.
The doubleshot mode.
Move the frame index relative to the current position in the ray sequence.
The ray sequence id.
The number of frames to move. Negative values move frame index backward.
Set the current frame index of ray sequence.
The ray sequence id.
The frame index.
Get current frame index of ray sequence.
The ray sequence id.
The frame index on return.
Get the total file size of the ray sequence in bytes.
The ray sequence id.
[out] Contains the total size of the ray sequence in bytes.
Get number of frames in ray sequence that is currently bound in read mode.
Number of frames.
Receive ray sequence frame count.
Identifier for the ray sequence.
Number of frames.
Get number of frame buffers in use.
The ray sequence id.
The number of frames in use in the frame buffer.
Write currently bound ray image to currently bound ray sequence.
This function appends the currently bound ray image to the bound ray sequence.
To automatically write frames captured from a camera device to the bound ray sequence, set the parameter
Rx::LFR::Params::EApiLF::RaySeq_AutoStoreCamFrames to 1.
Read a frame from the currently bound ray sequence.
A ray sequence in read mode must have been bound beforehand.
This function reads the current frame from the ray sequence and advanced the frame pointer by one frame.The ray image
is read into the currently bound ray image and the image is automatically copied onto the CUDA device. This means that
the function Rx::LFR::CApiLF::RxRaySeqGetFrameIndex returns a frame index higher than before after calling
Rx::LFR::CApiLF::RxRaySeqRead.
Unbind a ray sequence. If a ray sequence in write mode is unbound, the currently bound ray image stays bound. No more
images can be written to the ray sequence once it has been unbound, however, the ray sequence has not been closed. It
can be bound again to write further ray images to it.
If a ray sequence in read mode is unbound, the currently bound ray image stays bound. The ray image is therefore also
not removed from memory.
You will have to unbind the ray image and then delete it to free all memory.
The ray sequence ID of the ray sequence to unbind.
Determines if a sequence is bound for reading to the API.
True if a sequence in read mode is bound, false if not.
Bind a ray sequence for use by other API functions.
Only one ray sequence for reading and one ray sequence for writing can be bound at a time. When a ray sequence is bound
for reading, then any currently bound ray image is unbound, a new prototype ray image of the format of the ray sequence
is created and bound and the first image of the ray sequence is loaded into the bound ray image.The ID of the newly
created ray image is returned. No new ray image can be bound until the ray sequence is unbound using
Rx::LFR::CApiLF::RxRaySeqUnbind .If a camera capture is started while a ray sequence is bound for reading, the ray sequence is
automatically unbound. While a camera is in capture mode, no ray sequence can be bound for reading.
When a ray sequence is bound for writing a ray image must already be bound. If the ray sequence is empty up to now, the
ray sequence is created for the currently bound image type and only ray images of the same format can be written to the
ray sequence.Also only ray images of the same format can be bound while the ray sequence is bound. If the ray sequence
already contains images, it can only be bound if the currently bound ray image format is of the same format as the ray
sequence. If a ray sequence in write mode is bound and camera capture is started the ray sequence is also unbound if
the image formats do not agree.To capture frames from a camera, first start the camera capture, then bind the ray
sequence in write mode and set the parameter Rx::LFR::Params::EApiLF::RaySeq_AutoStoreCamFrames to 1. The value returned is the
ray image ID of the currently bound ray image.
The id of the ray sequence.
the currently bound ray image handle.
Close a ray sequence.
Closing a ray sequence also unbinds the corresponding ray image. The ray sequence ID becomes invalid once the ray
sequence has been closed.
The id of the ray sequence.
The number of frames written (if sequence was in write mode).
Open a ray sequence. Depending on the mode a ray sequence can be opened for reading or writing.
Returns the ray sequence handle.
The complete file path to the ray sequence.
The ray sequence mode. This is a combination of elements of Rx::ERaySeqMode .
The number of frame buffers used for buffered writing/reading.
The ray sequence id. This id is used in other functions to reference the ray sequence.
Set meta data of a ray image.
The meta data class CRxMetaData can contain any number of meta data elements of types unsigned, double and
Rx::CRxString. You can get, set and add elements to the meta data instance and store this together with the ray image.
The ray image handle.
The ray image meta data to set.
Get the meta data of the bound ray image.
The meta data class CRxMetaData can contain any number of meta data elements of types unsigned, double and
Rx::CRxString. You can get, set and add elements to the meta data instance and store this together with the ray image.
[out] Contains the ray image meta data on return.
Get meta data of a ray image.
The meta data class CRxMetaData can contain any number of meta data elements of types unsigned, double and
Rx::CRxString. You can get, set and add elements to the meta data instance and store this together with the ray image.
[out] Contains the ray image meta data on return.
The ray image handle.
Get the ray image.
If Create is true, the necessary memory for the image is created with a call to
Rx::Interop::Runtime28::IImage::Create, otherwise it is expected that pRawImage is already allocated with the correct
amount of memory.
The ray image handle.
[out] Pointer to an IImage interface.
Flag whether to create image.
Get the ray image as Rx::CRxImage instance.
The ray image handle.
[out] On return contains the ray image.
Gets the frame ID of the bound light field image. Used when working with sequences or cameras.
The frame ID.
Gets the frame ID of the given light field image. Used when working with sequences or cameras.
The ID of the light field image created by calling RxRayLoad, RxRaySeqBind or RxCamBind.
The frame ID.
Gets the image timestamp of the bound light field image. Is 0 if the image hasn't a valid timestamp. You can use this
timestamp and the timestamp of another camera or sequence frame to determine the time between them.
The timestamp.
Gets the image timestamp of the given light field image. Is 0 if the image hasn't a valid timestamp. You can use this
timestamp and the timestamp of another camera or sequence frame to determine the time between them.
The ID of the light field image created by calling RxRayLoad, RxRaySeqBind or RxCamBind.
The timestamp.
Get the image format of a ray image.
The ray image handle.
[out] On return contains the image format of the ray image.
Unbind the currently bound ray image.
If no ray image is bound the function does nothing. If a ray sequence or a camera is bound, the function throws an
exception.
Bind a ray image to perform computations on.
The ID of the light field image that is to be used for calculations.
Gets the pointer to the internal camera format.
The pointer to the internal camera format.
Get the calibration data of the given ray image as XML string.
The ID of the ray image whose calibration data is to be saved.
[out] On successful return contains the XML string.
Save calibration data of ray image in XML format.
The ID of the ray image whose calibration data is to be saved.
The complete file path under which to save the data.
Saves the bound light field image to the given file.
This augments the meta data with information from the current light field environment and saves them along the image
data. These information contain the current algorithm parameter.
The complete file path.
True to update the current meta data so that they are available in the next call to
RxRayGetMetaData; false to update a COPY of the current meta data so that they are NOT
available in the next call to RxRayGetMetaData.
Saves the given light field image to the given file.
This augments the meta data with information from the current light field environment and saves them along the image
data. These information contain the current algorithm parameter.
The ID of the light field image created by calling RxRayLoad, RxRaySeqBind or RxCamBind.
The complete file path.
True to update the current meta data so that they are available in the next call to
RxRayGetMetaData; false to update a COPY of the current meta data so that they are NOT
available in the next call to RxRayGetMetaData.
Delete the image with the given ID.
If the ray image referenced by \p uRayHandle is currently bound by a previous call to Rx::LFR::CApiLF::RxRayBind or
Rx::LFR::CApiLF::RxCamStartCapture, the image is not deleted and an exception is thrown.
The handle of the ray image to delete.
Load a ray image.
The ray image filename.
The ray image handle of the ray image.
Create a new ray image.
The allowed pixel types of ray images are
- Rx::Interop::Runtime28::EPixelType::RGB
- Rx::Interop::Runtime28::EPixelType::RGBA
- Rx::Interop::Runtime28::EPixelType::BGR
- Rx::Interop::Runtime28::EPixelType::BGRA
- Rx::Interop::Runtime28::EPixelType::Lum
- Rx::Interop::Runtime28::EPixelType::LumA
- Rx::Interop::Runtime28::EPixelType::BayerBG
- Rx::Interop::Runtime28::EPixelType::BayerGB
- Rx::Interop::Runtime28::EPixelType::BayerGR
- Rx::Interop::Runtime28::EPixelType::BayerRG
- Rx::Interop::Runtime28::EPixelType::YUV420P.
Returns the ray handle, which you can use in:
- Rx::LFR::CApiLF::RxRayDelete
- Rx::LFR::CApiLF::RxRaySave
- Rx::LFR::CApiLF::RxRayCalibSaveXML
- Rx::LFR::CApiLF::RxRayCalibXmlGet
- Rx::LFR::CApiLF::RxRayBind
- Rx::LFR::CApiLF::RxRayGetFormat
- Rx::LFR::CApiLF::RxRayGetRaw
- Rx::LFR::CApiLF::RxRayGetMetaData
- Rx::LFR::CApiLF::RxRaySetMetaData.
The ray image format.
The ray image handle of the ray image.
Get set of available values for parameter of type unsigned.
The camera parameter.
[out] The list of available values.
Get the parameter range of a camera parameter of type double from the currently bound camera.
The camera parameter. Allowed parameters from Rx::Interop::Runtime30::Camera::EProperty are:
- Camera
- Rx::Interop::Runtime30::Camera::EProperty::TapBalance
- Rx::Interop::Runtime30::Camera::EProperty::Gain
- Rx::Interop::Runtime30::Camera::EProperty::GainRed
- Rx::Interop::Runtime30::Camera::EProperty::GainGreen
- Rx::Interop::Runtime30::Camera::EProperty::GainBlue.
[out] On return the minimal parameter value.
[out] On return the maximal parameter value.
Get the parameter range of a camera parameter of type unsignedinteger from the currently bound camera.
The camera parameter. Allowed parameters from Rx::Interop::Runtime30::Camera::EProperty are:
- Camera
- Rx::Interop::Runtime30::Camera::EProperty::IsColor
- Rx::Interop::Runtime30::Camera::EProperty::IsBayer
- Rx::Interop::Runtime30::Camera::EProperty::PIVMode
- Rx::Interop::Runtime30::Camera::EProperty::IsOpen
- Rx::Interop::Runtime30::Camera::EProperty::IsCapturing
- Rx::Interop::Runtime30::Camera::EProperty::TriggerMode
- Rx::Interop::Runtime30::Camera::EProperty::ExternalTriggerMode.
[out] On return the minimal parameter value.
[out] On return the maximal parameter value.
Get a set of available values for a parameter of type unsigned integer
The zero-based camera index.
The camera parameter.
[out] The list of available values.
Get the parameter range of a camera parameter of type double
The zero-based camera index.
The camera parameter. Allowed parameters from Rx::Interop::Runtime30::Camera::EProperty are:
- Camera
- Rx::Interop::Runtime30::Camera::EProperty::TapBalance
- Rx::Interop::Runtime30::Camera::EProperty::Gain
- Rx::Interop::Runtime30::Camera::EProperty::GainRed
- Rx::Interop::Runtime30::Camera::EProperty::GainGreen
- Rx::Interop::Runtime30::Camera::EProperty::GainBlue.
[out] On return the minimal parameter value.
[out] On return the maximal parameter value.
Get the parameter range of a camera parameter of type unsigned integer.
The zero-based camera index.
The camera parameter. Allowed parameters from Rx::Interop::Runtime30::Camera::EProperty are:
- Camera
- Rx::Interop::Runtime30::Camera::EProperty::IsColor
- Rx::Interop::Runtime30::Camera::EProperty::IsBayer
- Rx::Interop::Runtime30::Camera::EProperty::PIVMode
- Rx::Interop::Runtime30::Camera::EProperty::IsOpen
- Rx::Interop::Runtime30::Camera::EProperty::IsCapturing
- Rx::Interop::Runtime30::Camera::EProperty::TriggerMode
- Rx::Interop::Runtime30::Camera::EProperty::ExternalTriggerMode.
[out] On return the minimal parameter value.
[out] On return the maximal parameter value.
Set a camera property of type double
Not all parameters may be supported by all Raytrix cameras.
If the parameter referenced by \a ePar does not relate to an double parameter an Rx::CRxException is thrown.
The camera parameter. Allowed parameters from Rx::Interop::Runtime30::Camera::EProperty are:
- Camera
- Rx::Interop::Runtime30::Camera::EProperty::Exposure
- Rx::Interop::Runtime30::Camera::EProperty::TapBalance
- Rx::Interop::Runtime30::Camera::EProperty::Gain
- Rx::Interop::Runtime30::Camera::EProperty::GainRed
- Rx::Interop::Runtime30::Camera::EProperty::GainGreen
- Rx::Interop::Runtime30::Camera::EProperty::GainBlue
- Rx::Interop::Runtime30::Camera::EProperty::FramesPerSecond
- Rx::Interop::Runtime30::Camera::EProperty::Focus
- Rx::Interop::Runtime30::Camera::EProperty::Iris
- Rx::Interop::Runtime30::Camera::EProperty::StrobeLength1
- Rx::Interop::Runtime30::Camera::EProperty::StrobeLength2
- Rx::Interop::Runtime30::Camera::EProperty::StrobeDelay1
- Rx::Interop::Runtime30::Camera::EProperty::StrobeDelay2
The double value.
Set a camera property of type unsigned integer from the currently bound camera.
Not all parameters may be supported by all Raytrix cameras.
If the parameter referenced by ePar does not relate to an unsigned integer parameter an Rx::CRxException is
thrown.
The camera parameter. Allowed parameters from Rx::Interop::Runtime30::Camera::EProperty are:
- Camera
- Rx::Interop::Runtime30::Camera::EProperty::Func_CalibMainLens
- Rx::Interop::Runtime30::Camera::EProperty::PIVMode
- Rx::Interop::Runtime30::Camera::EProperty::TriggerMode
- Rx::Interop::Runtime30::Camera::EProperty::ExternalTriggerMode
- Rx::Interop::Runtime30::Camera::EProperty::GlobalStart
- Rx::Interop::Runtime30::Camera::EProperty::StrobeOn
The unsigned integer value.
Set a camera property of type Rx::CRxString from the currently bound camera.
Not all parameters may be supported by all Raytrix cameras.
If the parameter referenced by \a ePar does not relate to an unsigned integer parameter an Rx::CRxException
is thrown.
The camera parameter. Allowed parameters from Rx::Interop::Runtime30::Camera::EProperty are:
- Camera
- Rx::Interop::Runtime30::Camera::EProperty::TapBalanceMode
- Rx::Interop::Runtime30::Camera::EProperty::SourceImageFolder.
The string value.
Set a camera property of type double.
Not all parameters may be supported by all Raytrix cameras.
If the parameter referenced by ePar does not relate to an double parameter an Rx::CRxException is thrown.
The zero-based camera index.
The camera parameter. Allowed parameters from Rx::Interop::Runtime30::Camera::EProperty are:
- Camera
- Rx::Interop::Runtime30::Camera::EProperty::Exposure
- Rx::Interop::Runtime30::Camera::EProperty::TapBalance
- Rx::Interop::Runtime30::Camera::EProperty::Gain
- Rx::Interop::Runtime30::Camera::EProperty::GainRed
- Rx::Interop::Runtime30::Camera::EProperty::GainGreen
- Rx::Interop::Runtime30::Camera::EProperty::GainBlue
- Rx::Interop::Runtime30::Camera::EProperty::FramesPerSecond
- Rx::Interop::Runtime30::Camera::EProperty::Focus
- Rx::Interop::Runtime30::Camera::EProperty::Iris
- Rx::Interop::Runtime30::Camera::EProperty::StrobeLength1
- Rx::Interop::Runtime30::Camera::EProperty::StrobeLength2
- Rx::Interop::Runtime30::Camera::EProperty::StrobeDelay1
- Rx::Interop::Runtime30::Camera::EProperty::StrobeDelay2
The double value.
Set a camera property of type unsigned integer.
Not all parameters may be supported by all Raytrix cameras.
If the parameter referenced by \a ePar does not relate to an unsigned integer parameter an Rx::CRxException
is thrown.
The zero-based camera index.
The camera parameter. Allowed parameters from Rx::Interop::Runtime30::Camera::EProperty are:
- Camera
- Rx::Interop::Runtime30::Camera::EProperty::Func_CalibMainLens
- Rx::Interop::Runtime30::Camera::EProperty::PIVMode
- Rx::Interop::Runtime30::Camera::EProperty::TriggerMode
- Rx::Interop::Runtime30::Camera::EProperty::ExternalTriggerMode
- Rx::Interop::Runtime30::Camera::EProperty::GlobalStart
- Rx::Interop::Runtime30::Camera::EProperty::StrobeOn
The unsigned integer value.
Set a camera property of type Rx::CRxString.
Not all parameters may be supported by all Raytrix cameras.
If the parameter referenced by ePar does not relate to an unsigned integer parameter an Rx::CRxException is
thrown.
The zero-based camera index.
The camera parameter. Allowed parameters from Rx::Interop::Runtime30::Camera::EProperty are:
- Camera
- Rx::Interop::Runtime30::Camera::EProperty::TapBalanceMode
- Rx::Interop::Runtime30::Camera::EProperty::SourceImageFolder.
The string value.
Get camera parameter of type Rx::CRxArrayString.
Not all parameters may be supported by all Raytrix cameras.
If the parameter referenced by ePar does not relate to an string-array parameter an Rx::CRxException is
thrown.
The camera parameter.
[out] The returned Rx::CRxArrayString value.
Get camera parameter of type double from the currently bound camera.
Not all parameters may be supported by all Raytrix cameras.
If the parameter referenced by ePar does not relate to an double parameter an Rx::CRxException is thrown.
thrown.
The camera parameter ID. Allowed parameters from Rx::Interop::Runtime30::Camera::EProperty are:
- Camera
- Rx::Interop::Runtime30::Camera::EProperty::Exposure
- Rx::Interop::Runtime30::Camera::EProperty::TapBalance
- Rx::Interop::Runtime30::Camera::EProperty::Gain
- Rx::Interop::Runtime30::Camera::EProperty::GainRed
- Rx::Interop::Runtime30::Camera::EProperty::GainGreen
- Rx::Interop::Runtime30::Camera::EProperty::GainBlue
- Rx::Interop::Runtime30::Camera::EProperty::FramesPerSecond
- Rx::Interop::Runtime30::Camera::EProperty::ActualFramesPerSecond
- Rx::Interop::Runtime30::Camera::EProperty::Focus
- Rx::Interop::Runtime30::Camera::EProperty::Iris
- Rx::Interop::Runtime30::Camera::EProperty::Temperature.
- Rx::Interop::Runtime30::Camera::EProperty::StrobeLength1
- Rx::Interop::Runtime30::Camera::EProperty::StrobeLength2
- Rx::Interop::Runtime30::Camera::EProperty::StrobeDelay1
- Rx::Interop::Runtime30::Camera::EProperty::StrobeDelay2
[out] The returned double value.
Get a camera parameter of type unsigned integer from the currently bound camera.
Not all parameters may be supported by all Raytrix cameras.
If the parameter referenced by ePar does not relate to an unsigned integer parameter anRx::CRxException is
thrown.
The camera parameter. Allowed parameters from Rx::Interop::Runtime30::Camera::EProperty are:
- Rx::Interop::Runtime30::Camera::EProperty::IsColor
- Rx::Interop::Runtime30::Camera::EProperty::IsBayer
- Rx::Interop::Runtime30::Camera::EProperty::Width
- Rx::Interop::Runtime30::Camera::EProperty::Height
- Rx::Interop::Runtime30::Camera::EProperty::OffsetX
- Rx::Interop::Runtime30::Camera::EProperty::OffsetY
- Rx::Interop::Runtime30::Camera::EProperty::Func_CalibMainLens
- Rx::Interop::Runtime30::Camera::EProperty::PIVMode
- Rx::Interop::Runtime30::Camera::EProperty::IsOpen
- Rx::Interop::Runtime30::Camera::EProperty::IsCapturing
- Rx::Interop::Runtime30::Camera::EProperty::TriggerMode
- Rx::Interop::Runtime30::Camera::EProperty::ExternalTriggerMode.
- Rx::Interop::Runtime30::Camera::EProperty::HasIPConfig
- Rx::Interop::Runtime30::Camera::EProperty::GlobalStart
- Rx::Interop::Runtime30::Camera::EProperty::StrobeOn
[out] The returned unsigned integer value.
Get a camera parameter of type Rx::CRxString from the currently bound camera.
Not all parameters may be supported by all Raytrix cameras.
If the parameter referenced by ePar does not relate to a string parameter an Rx::CRxException is
thrown.
The camera parameter. Allowed parameters from Rx::Interop::Runtime30::Camera::EProperty are:
- Rx::Interop::Runtime30::Camera::EProperty::DriverName
- Rx::Interop::Runtime30::Camera::EProperty::RaytrixModelName
- Rx::Interop::Runtime30::Camera::EProperty::InternalModelName
- Rx::Interop::Runtime30::Camera::EProperty::HardwareId
- Rx::Interop::Runtime30::Camera::EProperty::Serial
- Rx::Interop::Runtime30::Camera::EProperty::TapBalanceMode
- Rx::Interop::Runtime30::Camera::EProperty::SourceImageFolder.
[out] The returned string value.
Get camera parameter of type Rx::CRxArrayString.
Not all parameters may be supported by all Raytrix cameras.
If the parameter referenced by ePar does not relate to a string-array parameter an Rx::CRxException is thrown.
The zero-based camera index.
The camera parameter.
[out] The returned value.
Get camera parameter of type double
Not all parameters may be supported by all Raytrix cameras.
If the parameter referenced by ePar does not relate to an double parameter an Rx::CRxException is thrown.
The zero-based camera index.
The camera parameter. Allowed parameters from Rx::Interop::Runtime30::Camera::EProperty are:
- Camera
- Rx::Interop::Runtime30::Camera::EProperty::Exposure
- Rx::Interop::Runtime30::Camera::EProperty::TapBalance
- Rx::Interop::Runtime30::Camera::EProperty::Gain
- Rx::Interop::Runtime30::Camera::EProperty::GainRed
- Rx::Interop::Runtime30::Camera::EProperty::GainGreen
- Rx::Interop::Runtime30::Camera::EProperty::GainBlue
- Rx::Interop::Runtime30::Camera::EProperty::FramesPerSecond
- Rx::Interop::Runtime30::Camera::EProperty::ActualFramesPerSecond
- Rx::Interop::Runtime30::Camera::EProperty::Focus
- Rx::Interop::Runtime30::Camera::EProperty::Iris
- Rx::Interop::Runtime30::Camera::EProperty::Temperature
- Rx::Interop::Runtime30::Camera::EProperty::StrobeLength1
- Rx::Interop::Runtime30::Camera::EProperty::StrobeLength2
- Rx::Interop::Runtime30::Camera::EProperty::StrobeDelay1
- Rx::Interop::Runtime30::Camera::EProperty::StrobeDelay2
[out] The returned double value.
Get a camera parameter of type unsigned integer.
Not all parameters may be supported by all Raytrix cameras.
If the parameter referenced by ePar does not relate to an unsigned integer parameter an Rx::CRxException is
thrown.
The zero-based camera index.
The camera parameter ID. Allowed parameters from Rx::Interop::Runtime30::Camera::EProperty are:
- Camera
- Rx::Interop::Runtime30::Camera::EProperty::IsColor
- Rx::Interop::Runtime30::Camera::EProperty::IsBayer
- Rx::Interop::Runtime30::Camera::EProperty::Width
- Rx::Interop::Runtime30::Camera::EProperty::Height
- Rx::Interop::Runtime30::Camera::EProperty::OffsetX
- Rx::Interop::Runtime30::Camera::EProperty::OffsetY
- Rx::Interop::Runtime30::Camera::EProperty::Func_CalibMainLens
- Rx::Interop::Runtime30::Camera::EProperty::PIVMode
- Rx::Interop::Runtime30::Camera::EProperty::IsOpen
- Rx::Interop::Runtime30::Camera::EProperty::IsCapturing
- Rx::Interop::Runtime30::Camera::EProperty::TriggerMode
- Rx::Interop::Runtime30::Camera::EProperty::ExternalTriggerMode
- Rx::Interop::Runtime30::Camera::EProperty::HasIPConfig
- Rx::Interop::Runtime30::Camera::EProperty::GlobalStart
- Rx::Interop::Runtime30::Camera::EProperty::StrobeOn
[out] The returned unsigned integer value.
Get a camera parameter of type Rx::CRxString.
Not all parameters may be supported by all Raytrix cameras.
If the parameter referenced by ePar does not relate to a string parameter a Rx::CRxException is thrown.
The zero-based camera index.
The camera parameter. Allowed parameters from Rx::Interop::Runtime30::Camera::EProperty are:
- Rx::Interop::Runtime30::Camera::EProperty::DriverName
- Rx::Interop::Runtime30::Camera::EProperty::RaytrixModelName
- Rx::Interop::Runtime30::Camera::EProperty::InternalModelName
- Rx::Interop::Runtime30::Camera::EProperty::HardwareId
- Rx::Interop::Runtime30::Camera::EProperty::Serial
- Rx::Interop::Runtime30::Camera::EProperty::TapBalanceMode
- Rx::Interop::Runtime30::Camera::EProperty::SourceImageFolder.
[out] The returned string value.
Test whether a camera parameter is supported by the currently bound camera.
All camera and camera calibration parameters can be tested with this function. Use this function to test whether
certain parameters are available or not. For example, the parameters: Rx::Interop::Runtime30::Camera::EProperty::Focus, Rx::Interop::Runtime30::Camera::EProperty::Iris,
Rx::Interop::Runtime30::Camera::EProperty::Func_CalibMainLens are only available if a camera is attached that allows the direct control of the
main lens.
The camera parameter.
True if the parameter is supported, otherwise false.
Test whether a camera parameter is supported by the given camera.
All camera and camera calibration parameters can be tested with this function. Use this function to test whether
certain parameters are available or not. For example, the parameters: Rx::Interop::Runtime30::Camera::EProperty::Focus, Rx::Interop::Runtime30::Camera::EProperty::Iris,
Rx::Interop::Runtime30::Camera::EProperty::Func_CalibMainLens are only available if a camera is attached that allows the direct control of the
main lens.
The camera parameter ID.
The camera index.
True if the parameter is supported, otherwise false.
Assign the gray image of the calibration with the given GUID to the bound calibration. This copies the gray image.
The unique identifier of the calibration with the gray image to copy.
true to load gray image.
Bind gray image of calibration to API and use this image as gray image too. Now you can calibrate a calibration without
using a camera.
This function returns the image ID of the bound gray image in uRayHandle.
After using this image, you have to delete it to free the memory by calling Rx::LFR::CApiLF::RxRayDelete.
[out] Image ID of the bound gray image.
The GUID of the calibration.
Sets calibration data to the last applied calibration.
Information describing the calibration.
Sets Rx::CRxCalibMetaData for calibration with given GUID sxGUID.
Only certain parameters will be considered. The GUID, camera serial and camera type cannot be set.
The calibration data.
The GUID of the calibration.
Gets the last applied calibration data.
[out] Information describing the calibration.
Gets Rx::CRxCalibMetaData for calibration with given GUID sxGUID.
[out] The calibration data.
The GUID of the calibration.
Gets a Rx::CRxString which contains the GUID of the master calibration of this camera.
[out] Rx::CRxString of GUID.
Zero-based index of the camera.
Gets a Rx::CRxArrayString which contains GUIDs of all master calibration on this computer.
[out] Rx::CRxArrayString of GUIDS.
Gets a Rx::CRxArrayString which contains unique IDs of all calibration for camera with given index uCamIdx.
[out] Rx::CRxArrayString of GUIDs.
Zero-based index of the camera.
Gets a Rx::CRxArrayString which contains GUIDs of all calibration on this computer.
[out] Rx::CRxArrayString of GUIDS.
Gets calibration (The camera calibration) from current bound image and saves it to current calibration. Also saves
database to disk.
There must be a bound image before calling this function.
Gets (The camera calibration) from current bound image and saves it to the calibration defined by GUID sxGUID Also
saves database to disk.
There must be a bound image before calling this function.
GUID of the calibration which should be saved.
Applies the currently bound camera calibration to the current bound image in API. Also updates to the computational
class.
There must be a bound image before calling this function.
If true, the current gray image is replaced by the one from the given calibration.
Applies the camera calibration defined by GUID sxGUID to the currently bound image in API. Also updates the
computational class.
GUID of the calibration which should be applied to bound image.
If true, the current gray image is replaced by the one from the given calibration.
Deletes camera calibration with GUID sxGUID
If there is no calibration database for given parameters, an Rx::CRxException is thrown.
The GUID of the calibration to delete.
Creates a new calibration and returns the GUID of the newly created calibration in sxNewGUID.
[in] Unique identifier for the new calibration.
Creates a new calibration and returns the GUID of the newly created calibration in sxNewGUID.
[in] Unique identifier for the new calibration.
[in] id of a camera.
Creates a new calibration and returns the GUID of the newly created calibration in sxNewGUID.
[in] Unique identifier for the new calibration.
Hardware id of the camera.
Creates a new calibration database for camera with name sxCamHardwareId.
If a calibration database for this camera already exists, a new one will only be created if bForce is true Otherwise a
Rx::CRxException is thrown.
Type of the camera.
Flags whether to overwrite an existing database or not.
Creates a new calibration database for camera with ID uCamIdx
If a calibration database for this camera already exists, a new one will only be created if bForce is true.
Otherwise a Rx::CRxException is thrown.
Zero-based index of the camera.
Flags whether to overwrite an existing database or not.
Creates a new calibration database for bound camera.
If a calibration database for this camera already exists, a new one will only be created if bForce is true Otherwise a
Rx::CRxException is thrown.
Flags whether to overwrite an existing database or not.
Remove the image callback function.
Register a callback function which is called when a new image is available.
The callback function pointer.
[in,out] The void pointer of the Context.
Retrieve a single image from the currently bound camera.
This function only returns after an image has been retrieved by the camera and is available on the CUDA device. The
camera image is retrieved into the image referenced by the ray image handle returned by the function
Rx::LFR::CApiLF::RxCamBind. It is also automatically copied onto the CUDA device, so that all processing of the light field
image can be done purely on the CUDA device without repeated copying of the light-field image from host to device
memory.
true if an image was available, false otherwise.
Triggers capturing of a single image of the currently bound camera. The image can be retrieved by calling
Rx::LFR::CApiLF::RxCamRetrieveImage.
Suspend capturing images.
This function stops the data transfer between camera and computer but keeps all other capture settings.
True to suspend camera capture and false to restart camera capture.
Stops capturing of the currently bound camera. If the camera is not in capture mode, the function simply returns
without error.
Prepares the currently bound camera for capturing images. If the currently bound camera is already in capture mode,
then the function throws an exception.
Calling this function does not actually capture any images but prepares the camera for capturing images.The
function also reads the calibration data of the currently bound camera from the path set as sxCalibPath in
Rx::LFR::CApiLF::RxInit.
Unbinds a currently bound camera. If the bound camera is still capturing images, the capturing is stopped and then the
camera is unbound.
Binds the given camera to the returned API image ID. Call RxCamUnBind to unbind the bound camera. Only one camera can
be bound. Calling Rx::LFR::CApiLF::RxCamBind with another camera index results in an Rx::CRxException.
The internal ray image with ID returned by this function is not deleted from memory when camera is unbound. It has to
be deleted explicitly using Rx::LFR::CApiLF::RxRayDelete when it is no longer needed.
Zero-based index of the camera.
The ray image handle of the image into which camera images are captured.
Closes the given camera. If the given camera is currently bound, the camera is unbound before closing. Also, if the
camera is in capture mode, the capturing is stopped before unbinding.
The zero-based index of the camera to close.
Opens the given camera. Camera settings can only be accessed after a camera has been opened. The first call to open
initializes the camera too.
If initialization fails, an Rx::CRxException is thrown that holds the reason of failure.
The zero-based index of the camera to open.
Register available cameras.
This functions registers all cameras that are currently available. Only registered cameras can be used by the Raytrix
API. This function can be called repeatedly to update the list of available cameras. This function has to be called
after Rx::LFR::CApiLF::RxCamDriverInit and before any other API camera functions.
Return free and total amount of memory on the selected CUDA device.
[out] On return contains the amount of free memory in bytes.
[out] On return contains the amount of total memory in bytes.
Select a CUDA device.
This function must be called once and only once per process. The selected CUDA device cannot be changed during runtime.
Use the functions Rx::LFR::CApiLF::RxCudaDeviceCount and Rx::LFR::CApiLF::RxCudaDeviceProp to obtain information about the
installed CUDA devices and then select the most appropriate CUDA device with this function. If iDevice is set to -1,
the first appropriate CUDA device is selected.
To exchange image data generated by CUDA directly with an OpenGL rendering context on the same device, bUseGL has to be
set to true and the CUDA device has to support OpenGL 3.0 or higher. Note that CUDA/DirectX interop. is currently not
supported.
For further details on CUDA/OpenGL interop.
(Optional) The zero-based CUDA device ID or -1 for automatic selection.
(Optional) Flag indicating whether to initialize CUDA for OpenGL interop. or not.
Get the name and the compute capability major and minor version for a CUDA device.
Zero-based ID of the CUDA device.
[out] On return contains the name of the CUDA device.
[out] On return contains the major version of the CUDA device compute capability.
[out] On return contains the minor version of the CUDA device compute capability.
Returns the number of CUDA devices installed.
The number of CUDA devices.
Get the IDs of an attached dongle.
[in] On return contains the hardware dongle ID.
[in] On return contains the Raytrix dongle ID.
Test whether the Dongle offers a given feature.
Not all functions of this API are necessarily available. This depends on the currently active license, which is defined
by the Raytrix dongle attached to the system.
The feature to check for availability.
true if the feature is available, false otherwise.
Test whether the Dongle offers the given features.
Not all functions of this API are necessarily available. This depends on the currently active license, which is defined
by the Raytrix dongle attached to the system. To check whether a set of features is available you can OR the
corresponding feature IDs. The feature IDs are available through defines all starting with
Rx::Dongle::ERuntimeFeature::ID. For example, to test for the features multiview and 3D evaluation call:
if(Rx::LFR::Net::ApiLF::RxHasFeature(Rx::Dongle::ERuntimeFeature::SDK | Rx::Dongle::ERuntimeFeature::RxLive)){...}
A OR-ed list of Rx::Dongle::ERuntimeFeature::ID to check for availability.
true if the feature is available, false otherwise.
Sets details about the application that uses this runtime currently. Saving a ray file will write this details into the
meta data of the file.
The application name.
The application version.
Gets the release date of this version of the Raytrix Light Field Runtime. Can be called without initializing the API.
[out] The release day.
[out] The release month.
[out] The release year.
Removes a registered message callback function.
The function.
[in] If non-null, the context.
Registers a status message callback Function. This function will be called when a new Status Message is fired.
The callback function.
[in] A Context Pointer which is forwarded to the callback function call.
Gets the interface defined by the given interface ID.
The interface ID.
Null if it fails, else the interface.
Close any open cameras and free all memory allocated on CUDA device and in host memory.
Make sure to call this function before ending your program. Otherwise the CUDA device memory will fill up with repeated
execution of the software.
Initialize the Raytrix API.
Before any light field images can be loaded, recorded or processed a CUDA device has to be chosen using the function
Rx::LFR::CApiLF::RxCudaSelectDevice.To access Raytrix cameras you first have to call Rx::LFR::CApiLF::RxCamDriverInit and
Rx::LFR::CApiLF::RxCamRegister.
After executing Rx::LFR::CApiLF::RxInit neither a CUDA device is selected nor a camera device initialized.
(Optional) If set to false only functionality that does not rely on CUDA can be used.
(Optional) The absolute path to the camera driver DLLs (Rx.CameraNet.Type*.dll).
(Optional) The absolute path to the camera calibration directories.
[in,out] (Optional) Reserved. Must be zero.
ApiLF.
\copybrief Rx::Dongle::ERuntimeFeature
Halcon feature.
High resolution particle detector feature.
Super resolution feature.
Master feature.
Double Shot feature, required for PIV Shots.
RxLive feature
Metric Calibration feature.
Flow feature. All functions that a required for evaluating optical flow.
Distributor demo.
Save images. All functions that save a light field image are only available if this feature is enabled.
SDK feature. This feature must be enabled to allow SDK usage.
Calibration. All functions that modify the calibration of a light field or a Raytrix camera are only available if this feature is enabled.
Not used anymore (Former Calculate 3D depth).
Not used anymore (Former Focus on surface).
Not used anymore (Former Multiview feature).
Test whether a dongle is present. Check with RxHasFeature().
The parameters access class.
Sets the CUDA device for the super resolution algorithm.
If no CUDA device is set then the CPU implementation of the super resolution algorithm is used.
The CUDA device.
Add image to the super resolution algorithm.
[out] The super resolved image.
Add image to the super resolution algorithm.
[in] The image.
Destructor.
Default constructor.
Move assignment operator.
[in,out] The super resolution instance.
The instance.
Sets the CUDA device for the super resolution algorithm.
If no CUDA device is set then the CPU implementation of the super resolution algorithm is used.
The CUDA device.
Executes the super resolution.
[out] The super resolved image.
Add image to the super resolution algorithm.
[in] The image.
Destructor.
Move constructor.
[in,out] The super resolution instance.
Default constructor.
Provides methods to perform super resolution.
The wait event.
Gets the wait event.
Null if it fails, else the wait event.
Waits for the not empty event.
Zero-based index of the milliseconds.
True if it succeeds, false if it fails.
Waits for the not empty event.
True if it succeeds, false if it fails.
Gets the overwrite enabled flag.
The overwrite enabled flag.
Gets the maximum queue size.
The maximum queue size.
Gets the free size. This is the maximum queue size minus the current queue size.
The free size.
Gets the current queue size.
The current queue size.
Query if this queue is empty.
True if empty, false if not.
Moves the first image out of the queue. This resets the not-empty-event if the queue is now empty which would cause the
waiting using the WaitForNotEmpty function.
[out] The first image of the queue.
True if it succeeds, false if the queue is empty.
Moves the given image at the end of the queue. This signals the not-empty-event which would end the waiting at the
WaitForNotEmpty function.
[in,out] The image to move into the queue. May be invalid after this call.
True if it succeeds, false if the queue is full and overwrite is disabled.
Copies a const image into the image queue.
The const image.
True if it succeeds, false if it fails.
Clears this object to its blank/initial state.
Sets the maximum queue size and clears the queue.
The maximum queue size.
True to enable overwriting of the oldest queue element if the queue is full on MoveIn.
Destructor.
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.
[in] The native instance to be wrapped by this class.
Default constructor.
Defines an image queue.
Move assignment operator.
[in,out]The image queue instance.
The instance.
Gets the windows handle of the not empty event. This can be used in functions like WaitForSingleObject.
The not empty event handle.
Waits.
(Optional) The maximal waiting time in milliseconds. if iMilliseconds is set to -1 the time is
set to infinite.
True if it succeeds, false if it fails.
Gets the overwrite enabled flag.
The overwrite enabled flag.
Gets the maximum queue size.
The maximum queue size.
Gets the free size. This is the maximum queue size minus the current queue size.
The free size.
Gets the current queue size.
The current queue size.
Query if this queue is empty.
True if empty, false if not.
Moves the first image out of the queue. This resets the not-empty-event if the queue is now empty.
[out] The first image of the queue.
True if it succeeds, false if the queue is empty.
Moves the given image at the end of the queue. This signals the not-empty-event.
[in,out] The image to move into the queue. May be invalid after this call.
True if it succeeds, false if the queue is full and overwrite is disabled.
Clears this object to its blank/initial state.
Sets the maximum queue size and clears the queue.
The maximum queue size.
True to enable overwriting of the oldest queue element if the queue is full on MoveIn.
Destructor.
Move constructor.
[in,out] The native image queue.
Default constructor.
A bounded queue that uses the move semantics and that is thread safe.
The value type. This type requires a move constructor and a move assignment operator.
The parameters access class.
Gets the parameters access interface.
The parameters access interface.
Gets the interface of the CUDA compute class determined by the Interfaces::CudaCompute enum.
The interface enum.
Null if no interface is implemented yet, else the interface object.
Creates the image format of the refocus and the total focus image. This considers the Focus_ImageDivisor parameter.
The raw image format.
True to force landscape. Otherwise the calibration is used.
The image format.
Resize the given source image and store the result in the given target image using the given divisor.
[in] The target image. This must not be a moniker. It's created inside.
[in] The source image.
The divisor. A value of 2 means that the target image is half the source size.
Calculates the minimum and the maximum value in the given image.
The image ID. The image must be of type float.
The channel of each pixel that is used to get the values.
[out] The minimum.
[out] The maximum.
Calculates the histogram of the image with the given image ID and stores the histogram data in the given array. The
number of calculated channels is returned in uChannels.
The image ID.
[out] The histogram.
[out] The number of channels.
Calculates the multi view image.
Result image:
- EImage::Multiview
Required images:
- EImage::DepthRay
- EImage::Processed_Normalized
Influencing parameters:
- ECCPar::Multiview_Type
- ECCPar::Multiview_EyeSeparation
- ECCPar::Depth_ConsistencyCheck
- ECCPar::Depth_Fill_Enabled
- ECCPar::Depth_Fill_IterCnt
- ECCPar::Depth_Fill_IterSize
- ECCPar::Depth_Fill_Complete
- ECCPar::Depth_Fill_ShrinkRangePX
- ECCPar::Depth_Fill_Filter_Enabled
- ECCPar::Depth_Fill_Bilateral_Enabled
- ECCPar::Depth_Fill_Bilateral_Edge
- ECCPar::Depth_Fill_Bilateral_Range
- ECCPar::Depth_Fill_Bilateral_FilterRadius.
Focus on a depth surface.
In principle, each pixel of the result image can be focused individually. This function makes this property available
by focusing the ray image to the depth surface given in the internal depth image related to the given space.
Result image:
- EImage::TotalFocus_View_Virtual (if eSpace == LF::ESpace::View_Virtual) or
- EImage::TotalFocus_View_Object_Pinhole (if eSpace == LF::ESpace::View_Object_Pinhole)
Required images:
- EImage::Processed_Normalized
- EImage::DepthMap_View_Virtual (if eSpace == LF::ESpace::View_Virtual) or
- EImage::DepthMap_View_Object_Pinhole (if eSpace == LF::ESpace::View_Object_Pinhole)
Influencing parameters:
- ECCPar::Focus_RelativeFocusPlane
- ECCPar::Focus_DepthBlendingScale
- ECCPar::Depth_MinVirtualDepth
- ECCPar::Depth_MaxVirtualDepth.
The space. This is LF::ESpace::View_Virtual or LF::ESpace::View_Object_Pinhole.
Calculates the colored depth map image.
Result image:
- EImage::DepthMapColored_View_Virtual (if eSpace == LF::ESpace::View_Virtual) or
- EImage::DepthMapColored_View_Object_Pinhole (if eSpace == LF::ESpace::View_Object_Pinhole)
Required images:
- EImage::DepthMap_View_Virtual (if eSpace == LF::ESpace::View_Virtual) or
- EImage::Depth3D (if eSpace == LF::ESpace::View_Object_Pinhole)
Influencing parameters:
- ECCPar::DepthMap_Color_Mode
- ECCPar::DepthMap_Color_Max
- ECCPar::DepthMap_Color_Min
- ECCPar::DepthMap_Color_Map.
The space. This is LF::ESpace::View_Virtual or LF::ESpace::View_Object_Pinhole.
Calculates the depth 3D image.
This creates a RGBA float image which maps each pixel in the view camera to a 3D position in object space. The R
channel is the X coordinate, the G channel is the Y coordinate and the B channel is the Z coordinate. The Z coordinate
is relative to the global coordinate system which typically coincides with the light field camera sensor. All
coordinate values are given in millimeters. The A channel is the Z coordinate in virtual depths.
Result image:
- EImage::Depth3D
Required images:
- EImage::DepthMap_View_Object_Pinhole
Influencing parameters:
- none.
Calculates the depth map image. This image can be filled to produce a complete filled depth map.
Result image:
- EImage::DepthMap_View_Virtual (if eSpace == LF::ESpace::View_Virtual) or
- EImage::DepthMap_View_Object_Pinhole (if eSpace == LF::ESpace::View_Object_Pinhole)
Required images:
- EImage::DepthRay
Influencing parameters:
- ECCPar::Depth_ConsistencyCheck
- ECCPar::Depth_Fill_Enabled
- ECCPar::Depth_Fill_IterCnt
- ECCPar::Depth_Fill_IterSize
- ECCPar::Depth_Fill_Complete
- ECCPar::Depth_Fill_ShrinkRangePX
- ECCPar::Depth_Fill_Filter_Enabled
- ECCPar::Depth_Fill_Bilateral_Enabled
- ECCPar::Depth_Fill_Bilateral_Edge
- ECCPar::Depth_Fill_Bilateral_Range
- ECCPar::Depth_Fill_Bilateral_FilterRadius.
The space. This is LF::ESpace::View_Virtual or LF::ESpace::View_Object_Pinhole.
Estimates the depth of the current raw image and creates the ray depth image.
Result image:
- EImage::DepthRay
Required images:
- EImage::Processed_Normalized
Influencing parameters:
- ECCPar::PreProc_Sharp1_Enable
- ECCPar::PreProc_Sharp1_OnlyCalc
- ECCPar::PreProc_Sharp1_BlurStdDev
- ECCPar::PreProc_Sharp1_Factor
- ECCPar::Depth_SparseLensSet
- ECCPar::Depth_NearResolutionLevel
- ECCPar::Depth_PatchDiameter
- ECCPar::Depth_PatchStride
- ECCPar::Depth_MinVirtualDepth
- ECCPar::Depth_MaxVirtualDepth
- ECCPar::Depth_MinCorrelation
- ECCPar::Depth_MinStdDeviation
- ECCPar::Depth_LensFilterMask.
Focus image to a plane perpendicular to the optical axis, i.e. parallel to the image plane.
This focuses to a plane perpendicular to the optical axis. You can change the relative focal plane. A relative focus
value of zero refocuses to the plane furthest away from the viewer and a value of 1 would focus to a plane that passes
through the object side focal point of the recording lens.
Result image:
- EImage::RefocusBasic
Required images:
- EImage::Processed_Normalized
Influencing parameters:
- ECCPar::Focus_RelativeFocusPlane
- ECCPar::Depth_MinVirtualDepth
- ECCPar::Depth_MaxVirtualDepth.
Pre-Process a ray image with a minimal set of preprocessing parameters.
Result image:
- EImage::GridData
Required images:
- EImage::Raw
Influencing parameters:
- ECCPar::PreProc_Demosaic_R
- ECCPar::PreProc_Demosaic_G
- ECCPar::PreProc_Demosaic_B.
Calculates the grid image. This is the raw or the gray image with an overlay that shows the current grid calibration.
Result image:
- EImage::Grid
Required images:
- EImage::Raw or EImage::Gray
Influencing parameters:
- ECCPar::Grid_DrawOnGrayImage
- ECCPar::Grid_DrawMlaGrid.
Pre-Process a ray image. This can apply denoise, brightness and sharpness adjustments.
Result image:
- EImage::Processed_Normalized
Required images:
- EImage::Raw
- EImage::Gray (optional)
Influencing parameters:
- ECCPar::PreProc_Demosaic_Enable
- ECCPar::PreProc_Demosaic_R
- ECCPar::PreProc_Demosaic_G
- ECCPar::PreProc_Demosaic_B
- ECCPar::PreProc_DenoiseNLM_Enable
- ECCPar::PreProc_DenoiseNLM_FilterDia
- ECCPar::PreProc_DenoiseNLM_NoiseLevel
- ECCPar::PreProc_DenoiseNLM_BlendFactor
- ECCPar::PreProc_Std_Enable
- ECCPar::PreProc_Std_Gradation
- ECCPar::PreProc_Sharp1_Enable
- ECCPar::PreProc_Sharp1_OnlyCalc
- ECCPar::PreProc_Sharp1_BlurStdDev
- ECCPar::PreProc_Sharp1_Factor.
Reinitializes the depth database.
This can be useful when calling Compute_DepthMap after changing the ray depth image manually.
Removes the computation filter mask set by SetComputationFilterMask.
Sets the computation filter mask image.
This image is used to reduce the number of lenses used for depth estimation.
It must have the same dimension as the raw image and a pixel type of Rx::InteropNet::Runtime28::EPixelType::Lum and a
data type of Rx::InteropNet::Runtime28::EDataType::UByte. Otherwise the image is converted.
Each lens of the raw image has a lens center that can be rounded to a pixel. If this pixel has the value 255 in the
filter mask image, the corresponding lens is used. If this pixel has another value, the lens is not used.
[in] The complete image file path.
Sets the computation filter mask image.
This image is used to reduce the number of lenses used for depth estimation.
It must have the same dimension as the raw image and a pixel type of Rx::InteropNet::Runtime28::EPixelType::Lum and a
data type of Rx::InteropNet::Runtime28::EDataType::UByte. Otherwise the image is converted.
Each lens of the raw image has a lens center that can be rounded to a pixel. If this pixel has the value 255 in the
filter mask image, the corresponding lens is used. If this pixel has another value, the lens is not used.
[in] The computation filter mask image.
Uploads the given image as the new raw image of all computations.
[in] The source image.
Applies the given calibration to the algorithms. This must be done every time the calibration changes.
[in] The calibration.
True to upload the gray image of the calibration to CUDA. False to use the current gray image
even if it is invalid.
Applies the given ray image.
This uploads the raw and the gray image to the CUDA device and applies the calibration and the parameters from the meta
data to the CUDA algorithms.
The ray image.
Gets the CUDA device that has been set by calling SetCudaDevice. Throws an exception if not set yet.
The CUDA device.
Sets the CUDA device that allocates the memory required for the operations and that runs the algorithms.
[in] The CUDA device.
Destructor.
Constructor that wraps the given native instance. Disposing does NOT destroy the native instance.
[in] The native instance to wrap by this class.
Default constructor.
Provides methods for using a CUDA device as the computation unit of the LFR.
Gets the image format of the image defined by the given ID.
The image ID.
The image format.
Updates the OpenGL texture of the image defined by the given ID.
This copies the image into the texture and creates a valid texture ID if the texture has not been created before. The
calling thread must own the OpenGL context that owns the texture.
The image ID.
[in] The OpenGlInterop class.
Updates the OpenGL texture of the image defined by the given ID.
This copies the image into the texture and creates a valid texture ID if the texture has not been created before. The
calling thread must own the OpenGL context that owns the texture.
The image ID.
[in] The OpenGlInterop class.
True to create mipmaps of the texture.
Destructor.
Constructor.
[in,out] If non-null, the pointer to the native representation.
A CUDA data textures.
Gets device pointer pitch, which is the width in bytes of the allocation. Given a row and column of an array element of
type T, the address is computed as:
T* pElement = (T*)((char*)BaseAddress + Row * pitch) + Column;
The image ID.
The device pointer pitch.
// Host code:
// Assuming the image in this example is of type luminance, float (TPixel_L_f).
char* pcBaseAdress = (char*) GetImageDevicePointer(EImage::DepthRay);
size_t nPitch = GetDevicePointerPitch(EImage::DepthRay);
// CUDA code:
// Get the pointer of the pixel on the CUDA device, at row 10 and column 42.
Rx::TPixel_L_f* tPixel = (((Rx::TPixel_L_f*) (pcBaseAdress + 10 * nPitch)) + 42);
Gets the CUDA device pointer to the data of the image defined by the given ID.
The pointer maps to the memory on a CUDA device and cannot be used on the host.
The image ID.
The image device pointer.
Frees the memory used by all images. This invalidates all images.
Frees memory used by image defined by eImgID. This invalidates the image.
The image ID.
Gets the image format of the image defined by the given ID.
The image ID.
The image format.
Query if the image with the given image ID is valid.
The image ID.
True if valid, false if not.
Downloads the image with the given image ID.
The image ID.
[in,out] If non-null, the image.
Uploads the image with the given image ID.
The image ID.
[in,out] If non-null, the image.
Destructor.
Constructor.
[in,out] If non-null, the pointer to the native representation.
A CUDA data images.
Gets the OpenGL version.
[out] The major part of the version.
[out] The minor part of the version.
Deletes the stored context (if it has been created by CreateContextSharedWithCurrent).
Releases the OpenGL context. Changes the calling thread's current rendering context so it's no longer current. This
method does not delete the stored OpenGL context.
Makes the stored OpenGL rendering context the calling thread's current rendering context.
Returns true if the calling thread hadn't the context BEFORE the call.
Creates an OpenGL context that is shared with the current OpenGL context. This requires a current OpenGL context.
Stores the current OpenGL context. Throws an exception if the calling thread hasn't a current OpenGL context.
Query if this object has a valid OpenGL context stored.
True if OpenGL context stored, false if not.
Destroys all OpenGL textures.
Attention: An OpenGL context must be stored before by calling StoreCurrentContext.
Destroys the OpenGL texture of the image defined by the given ID.
Attention: An OpenGL context must be stored before by calling StoreCurrentContext.
The image ID.
Gets the OpenGL texture ID of the image defined by the given ID.
If the desired texture has not been created yet, the returned texture ID is 0.
Attention: An OpenGL context must be stored before by calling StoreCurrentContext.
The image ID.
The texture ID or 0.
Destructor.
Default constructor.
Provides methods for using OpenGL contexts and textures.
Tests whether image is of a particular pixel and data type.
The pixel type.
The data type.
True if of type, false if not.
Gets pixel and data type of image.
[out] The pixel type.
[out] The data type.
Gets pixel and data type of image.
[out] The pixel type.
[out] The data type.
Gets width and height of image.
[out] The width.
[out] The height.
Returns the pointer to the data array.
Null if it fails, else the data pointer.
Returns the constant pointer to the data array.
Null if it fails, else the data pointer.
Gets the image format.
The format.
Gets the number of bytes of the whole image.
The byte count.
Gets the number of pixels.
The pixel count.
Gets number of bytes per pixel.
The bytes per pixel.
Tests whether data pointer is not zero.
True if valid, false if not.
Sets internal data pointer to given data pointer.
The data pointer.
Sets internal data pointer to zero and reset image format data.
True if it succeeds, false if it fails.
Sets image format to image format of given image and set internal data pointer to data pointer of given image.
The image.
Sets the internal image format to the given format and the internal data pointer to given data pointer.
The image format.
(Optional) The data pointer.
Sets image format to given type and size and set internal data pointer to given data pointer.
The width.
The weight.
The pixel type.
The data type.
(Optional) The data pointer.
Sets image format to given type and size and set internal data pointer to given data pointer.
The width.
The weight.
The pixel type.
The data type.
The data pointer.
True if it succeeds, false if it fails.
Sets image format data to given type and size. No memory is allocated and internal data pointer is set to zero.
The width.
The weight.
The pixel type.
The data type.
True if it succeeds, false if it fails.
Creates an image moniker for given image.
The image.
True if it succeeds, false if it fails.
Move assignment operator.
[in] The moniker to move. Is invalid after this call.
A shallow copy of this object.
Assignment operator.
The moniker.
A shallow copy of this CRxImageMoniker.
Destructor.
Sets the internal image format to the given format and the internal data pointer to given data pointer.
The image format.
(Optional) The image data pointer.
Move constructor.
[in] The moniker to move. Is invalid after this call.
Constructor.
The moniker.
Default constructor.
\addtogroup RxCore_Image Image classes
*
@{
Image moniker class. Implements the interface Interop::Runtime28::IImage but does not allocate memory.
This class implements the basic functionality for an image, but does not create its own memory block. Instead, it can
hold the pointer to an image memory block created by some other means. This class therefore does not free the memory
the data pointer points to, when it is deleted.
The callback wrapper.
Event queue for all listeners interested in StatusMessage events.
Saves a volume.
[in] The full pathname of the volume.
Adds an depth image from space 5 to the depth correction volume.
[in] The depth image.
[in] The calibration.
Initializes this object.
[in] The minimum position.
[in] The maximum position.
[in] The dimensions.
Destructor.
Default constructor.
The depth correction volume creator implementation.
Saves the volume.
Filename of the volume.
Gets the volume.
[out] The volume.
Removes the given status message callback function.
Does nothing if the given function pointer has not been added to the list of callbacks.
The callback function to remove.
Adds the given status message callback function to the internal list of callbacks.
Adding the same function pointer twice will only update the given context pointer. This prevents multiple adds of the
same callback function.
The callback function.
[in] The callback context. Can be any pointer that is passed to the callback function.
Adds an depth image from space 5 to the depth correction volume.
[in] The depth image.
[in] The calibration.
Initializes this object.
[in] The minimum position.
[in] The maximum position.
[in] The dimensions.
Destructor.
Move constructor.
[in,out] The depth correction volume.
Default constructor.
The depth correction volume class.
Loads a depth correction volume described by the given filepath and than attaches it to the given calibration.
The given camera sends capture events while capturing images. You have to ensure that you don't process this images.
The best way to ensure this, is to remove your callback function from the camera before calling this method.
[out] The resultant gray image. Is created inside if its invalid before.
[in] The camera to capture images from. The camera is stopped after this function.
Destructor.
Default constructor.
Capture gray image class.
This class captures images from a given camera and processes them to an image that can be used as the gray image of a
calibration. This class requires a CUDA device.
Destructor.
Default constructor.
An attacher of depth volumes to cameras.
Saves the 3D point list provided by the given 3D depth image to ASCII XYZ format.
[in] The complete file path.
[in,out] The 3D depth image. Must be of type RGBA float.
True to save the mesh in virtual depth units instead of metric units.
[in,out] Pointer to 4 double values defining a mesh crop in X and Y. The values must be given
in percentage of the image dimension in the order: Left, Right, Top, Bottom.
Saves the 3D point list provided by the given 3D depth image to ASCII XYZ format.
[in] The complete file path.
[in,out] The 3D depth image. Must be of type RGBA float.
True to save the mesh in virtual depth units instead of metric units.
Saves the 3D point list provided by the given 3D depth image to ASCII XYZ format.
[in] The complete file path.
[in,out] The 3D depth image. Must be of type RGBA float.
Saves the 3D point list provided by the given 3D depth image to ASCII XYZ format.
[in] The complete file path.
[in,out] The 3D depth image. Must be of type RGBA float.
True to save the mesh in virtual depth units instead of metric units.
[in,out] Pointer to 4 double values defining a mesh crop in X and Y. The values must be given
in percentage of the image dimension in the order: Left, Right, Top, Bottom.
Saves the 3D point list provided by the given 3D depth image to ASCII XYZ format.
[in] The complete file path.
[in,out] The 3D depth image. Must be of type RGBA float.
True to save the mesh in virtual depth units instead of metric units.
Saves the 3D point list provided by the given 3D depth image to ASCII XYZ format.
[in] The complete file path.
[in,out] The 3D depth image. Must be of type RGBA float.
Saves the 3D point list provided by the given 3D depth image to binary PCD format.
Point Cloud Data: http://pointclouds.org/documentation/tutorials/pcd_file_format.php.
[in] The complete file path.
[in,out] The total focus image used as color values for each point in the data. Must be of type
RGBA unsigned char or luminance unsigned char.
[in,out] The 3D depth image. Must be of type RGBA float.
True to save the mesh in virtual depth units instead of metric units.
[in,out] Pointer to 4 double values defining a mesh crop in X and Y. The values must be given
in percentage of the image dimension in the order: Left, Right, Top, Bottom.
Saves the 3D point list provided by the given 3D depth image to binary PCD format.
Point Cloud Data: http://pointclouds.org/documentation/tutorials/pcd_file_format.php.
[in] The complete file path.
[in,out] The 3D depth image. Must be of type RGBA float.
True to save the mesh in virtual depth units instead of metric units.
[in,out] Pointer to 4 double values defining a mesh crop in X and Y. The values must be given
in percentage of the image dimension in the order: Left, Right, Top, Bottom.
Saves the 3D point list provided by the given 3D depth image to binary PCD format.
Point Cloud Data: http://pointclouds.org/documentation/tutorials/pcd_file_format.php.
[in] The complete file path.
[in,out] The total focus image used as color values for each point in the data. Must be of type
RGBA unsigned char or luminance unsigned char.
[in,out] The 3D depth image. Must be of type RGBA float.
True to save the mesh in virtual depth units instead of metric units.
Saves the 3D point list provided by the given 3D depth image to binary PCD format.
Point Cloud Data: http://pointclouds.org/documentation/tutorials/pcd_file_format.php.
[in] The complete file path.
[in,out] The 3D depth image. Must be of type RGBA float.
True to save the mesh in virtual depth units instead of metric units.
Saves the 3D point list provided by the given 3D depth image to binary PCD format.
Point Cloud Data: http://pointclouds.org/documentation/tutorials/pcd_file_format.php.
[in] The complete file path.
[in,out] The total focus image used as color values for each point in the data. Must be of type
RGBA unsigned char or luminance unsigned char.
[in,out] The 3D depth image. Must be of type RGBA float.
Saves the 3D point list provided by the given 3D depth image to binary PCD format.
Point Cloud Data: http://pointclouds.org/documentation/tutorials/pcd_file_format.php.
[in] The complete file path.
[in,out] The 3D depth image. Must be of type RGBA float.
Saves the 3D mesh provided by the given 3D depth image to binary PLY format.
[in] The complete file path.
[in,out] The total focus image used as color values for each vertex in the mesh. Must be of
type RGBA unsigned char or luminance unsigned char.
[in,out] The 3D depth image. Must be of type RGBA float.
True to save the mesh in virtual depth units instead of metric units.
[in,out] Pointer to 6 double values defining a mesh crop in X, Y and Z. The first 4 double
values must be given in percentage of the image dimension in the order: Left, Right, Top,
Bottom. The next 2 values must be given as absolute depth values in the order: Minimum,
Maximum. If both values are 0, no depth crop is applied.
Saves the 3D mesh provided by the given 3D depth image to binary PLY format.
[in] The completet file path.
[in,out] The total focus image used as color values for each vertex in the mesh. Must be of
type RGBA unsigned char or luminance unsigned char.
[in,out] The 3D depth image. Must be of type RGBA float.
True to save the mesh in virtual depth units instead of metric units.
Saves the 3D mesh provided by the given 3D depth image to binary PLY format.
[in] The completet file path.
[in,out] The total focus image used as color values for each vertex in the mesh. Must be of
type RGBA unsigned char or luminance unsigned char.
[in,out] The 3D depth image. Must be of type RGBA float.
Saves the 3D mesh provided by the given 3D depth image to binary STL format.
[in] The complete file path.
[in,out] The 3D depth image. Must be of type RGBA float.
True to save the mesh in virtual depth units instead of metric units.
Vertices with a depth-variation larger than this value for at least one vertex pair are not
added to the mesh.
[in,out] (Optional) Pointer to 4 double values defining a mesh crop in X and Y. The values must
be given in percentage of the image dimension in the order: Left, Right, Top, Bottom.
Saves the 3D mesh provided by the given 3D depth image to binary STL format.
[in] The complete file path.
[in,out] The 3D depth image. Must be of type RGBA float.
True to save the mesh in virtual depth units instead of metric units.
Vertices with a depth-variation larger than this value for at least one vertex pair are not
added to the mesh.
Saves the 3D mesh provided by the given 3D depth image to binary STL format.
[in] The complete file path.
[in,out] The 3D depth image. Must be of type RGBA float.
Defines a single camera or ray image calibration, including a possible gray image.
Move assignment operator.
[in,out] The exporter.
The instance.
Saves the 3D point list provided by the given 3D depth image to ASCII TXT format.
The file name.
The 3D depth image. Must be of type RGBA float.
True to save the mesh in virtual depth units instead of metric units.
(Optional) Pointer to 4 double values defining a mesh crop in X and Y. The values must be given
in percentage of the image dimension in the order: Left, Right, Top, Bottom.
Saves the 3D point list provided by the given 3D depth image to ASCII XYZ format.
The file name.
The 3D depth image. Must be of type RGBA float.
True to save the mesh in virtual depth units instead of metric units.
(Optional) Pointer to 4 double values defining a mesh crop in X and Y. The values must be given
in percentage of the image dimension in the order: Left, Right, Top, Bottom.
Saves the 3D point list provided by the given 3D depth image to binary PCD format.
Point Cloud Data: http://pointclouds.org/documentation/tutorials/pcd_file_format.php.
The file name.
The total focus image used as color values for each point in the data. Must be of type RGBA
unsigned char or luminance unsigned char.
The 3D depth image. Must be of type RGBA float.
True to save the mesh in virtual depth units instead of metric units.
(Optional) Pointer to 4 double values defining a mesh crop in X and Y. The values must be given
in percentage of the image dimension in the order: Left, Right, Top, Bottom.
Saves the 3D point list provided by the given 3D depth image to binary PCD format.
Point Cloud Data: http://pointclouds.org/documentation/tutorials/pcd_file_format.php.
The file name.
The 3D depth image. Must be of type RGBA float.
True to save the mesh in virtual depth units instead of metric units.
(Optional) Pointer to 4 double values defining a mesh crop in X and Y. The values must be given
in percentage of the image dimension in the order: Left, Right, Top, Bottom.
Saves the 3D mesh provided by the given 3D depth image to binary PLY format.
The file name.
The total focus image used as color values for each vertex in the mesh. Must be of type RGBA
unsigned char or luminance unsigned char.
The 3D depth image. Must be of type RGBA float.
True to save the mesh in virtual depth units instead of metric units.
(Optional) Pointer to 6 double values defining a mesh crop in X, Y and Z. The first 4 double
values must be given in percentage of the image dimension in the order: Left, Right, Top,
Bottom. The next 2 values must be given as absolute depth values in the order: Minimum,
Maximum. If both values are 0, no depth crop is applied.
Saves the 3D mesh provided by the given 3D depth image to binary STL format.
The file name.
The 3D depth image. Must be of type RGBA float.
True to save the mesh in virtual depth units instead of metric units.
Vertices with a depth-variation larger than this value for at least one vertex pair are not
added to the mesh.
(Optional) Pointer to 4 double values defining a mesh crop in X and Y. The values must be given
in percentage of the image dimension in the order: Left, Right, Top, Bottom.
Destructor.
Move constructor.
[in,out] The exporter.
Default constructor.
An export.
Move assignment operator.
[in,out] The cuda compute instance.
The instance.
Gets the cuda compute interface.
The interface type.
Null if it fails, else the interface.
Gets the cuda compute interface.
The interface type.
Null if it fails, else the interface.
Creates the image format of the refocus and the total focus image. This considers the Focus_ImageDivisor parameter.
The raw image format.
True to force landscape. Otherwise the calibration is used.
The image format.
Resize the given source image and store the result in the given target image using the given divisor.
[in] The target image. This must not be a moniker. It's created inside.
The source image.
The divisor. A value of 2 means that the target image is half the source size.
Calculates the minimum and the maximum value in the given image.
The image ID. The image must be of type float.
The channel of each pixel that is used to get the values.
[out] The minimum.
[out] The maximum.
Calculates the histogram of the image with the given image ID and stores the histogram data in the given array. This
array must be large enough to hold 4 * 256 numbers. The number of calculated channels is returned in uChannels.
The image ID.
[out] The histogram.
[out] The number of channels.
Calculates the multi view image.
Result image:
- EImage::Multiview
Required images:
- EImage::DepthRay
- EImage::Processed_Normalized
Influencing parameters:
- ECCPar::Multiview_Type
- ECCPar::Multiview_EyeSeparation
- ECCPar::Depth_ConsistencyCheck
- ECCPar::Depth_Fill_Enabled
- ECCPar::Depth_Fill_IterCnt
- ECCPar::Depth_Fill_IterSize
- ECCPar::Depth_Fill_Complete
- ECCPar::Depth_Fill_ShrinkRangePX
- ECCPar::Depth_Fill_Filter_Enabled
- ECCPar::Depth_Fill_Bilateral_Enabled
- ECCPar::Depth_Fill_Bilateral_Edge
- ECCPar::Depth_Fill_Bilateral_Range
- ECCPar::Depth_Fill_Bilateral_FilterRadius.
Focus on a depth surface.
In principle, each pixel of the result image can be focused individually. This function makes this property available
by focusing the ray image to the depth surface given in the internal depth image related to the given space.
Result image:
- EImage::TotalFocus_View_Virtual (if eSpace == LF::ESpace::View_Virtual) or
- EImage::TotalFocus_View_Object_Pinhole (if eSpace == LF::ESpace::View_Object_Pinhole)
Required images:
- EImage::Processed_Normalized
- EImage::DepthMap_View_Virtual (if eSpace == LF::ESpace::View_Virtual) or
- EImage::DepthMap_View_Object_Pinhole (if eSpace == LF::ESpace::View_Object_Pinhole)
Influencing parameters:
- ECCPar::Focus_RelativeFocusPlane
- ECCPar::Focus_DepthBlendingScale
- ECCPar::Depth_MinVirtualDepth
- ECCPar::Depth_MaxVirtualDepth.
(Optional) The space. This is LF::ESpace::View_Virtual or LF::ESpace::View_Object_Pinhole.
Calculates the colored depth map image.
Result image:
- EImage::DepthMapColored_View_Virtual (if eSpace == LF::ESpace::View_Virtual) or
- EImage::DepthMapColored_View_Object_Pinhole (if eSpace == LF::ESpace::View_Object_Pinhole)
Required images:
- EImage::DepthMap_View_Virtual (if eSpace == LF::ESpace::View_Virtual) or
- EImage::Depth3D (if eSpace == LF::ESpace::View_Object_Pinhole)
Influencing parameters:
- ECCPar::DepthMap_Color_Mode
- ECCPar::DepthMap_Color_Max
- ECCPar::DepthMap_Color_Min
- ECCPar::DepthMap_Color_Map.
(Optional) The space. This is LF::ESpace::View_Virtual or LF::ESpace::View_Object_Pinhole.
Calculates the depth 3D image.
This creates a RGBA float image which maps each pixel in the view camera to a 3D position in object space. The R
channel is the X coordinate, the G channel is the Y coordinate and the B channel is the Z coordinate. The Z coordinate
is relative to the global coordinate system which typically coincides with the light field camera sensor. All
coordinate values are given in millimeters. The A channel is the Z coordinate in virtual depths.
Result image:
- EImage::Depth3D
Required images:
- EImage::DepthMap_View_Object_Pinhole
Influencing parameters:
- none.
Calculates the depth map image. This image can be filled to produce a complete filled depth map.
Result image:
- EImage::DepthMap_View_Virtual (if eSpace == LF::ESpace::View_Virtual) or
- EImage::DepthMap_View_Object_Pinhole (if eSpace == LF::ESpace::View_Object_Pinhole)
Required images:
- EImage::DepthRay
Influencing parameters:
- ECCPar::Depth_ConsistencyCheck
- ECCPar::Depth_Fill_Enabled
- ECCPar::Depth_Fill_IterCnt
- ECCPar::Depth_Fill_IterSize
- ECCPar::Depth_Fill_Complete
- ECCPar::Depth_Fill_ShrinkRangePX
- ECCPar::Depth_Fill_Filter_Enabled
- ECCPar::Depth_Fill_Bilateral_Enabled
- ECCPar::Depth_Fill_Bilateral_Edge
- ECCPar::Depth_Fill_Bilateral_Range
- ECCPar::Depth_Fill_Bilateral_FilterRadius.
(Optional) The space. This is LF::ESpace::View_Virtual or LF::ESpace::View_Object_Pinhole.
Estimates the depth of the current raw image and creates the ray depth image.
Result image:
- EImage::DepthRay
Required images:
- EImage::Processed_Normalized
Influencing parameters:
- ECCPar::PreProc_Sharp1_Enable
- ECCPar::PreProc_Sharp1_OnlyCalc
- ECCPar::PreProc_Sharp1_BlurStdDev
- ECCPar::PreProc_Sharp1_Factor
- ECCPar::Depth_SparseLensSet
- ECCPar::Depth_NearResolutionLevel
- ECCPar::Depth_PatchDiameter
- ECCPar::Depth_PatchStride
- ECCPar::Depth_MinVirtualDepth
- ECCPar::Depth_MaxVirtualDepth
- ECCPar::Depth_MinCorrelation
- ECCPar::Depth_MinStdDeviation
- ECCPar::Depth_LensFilterMask.
Focus image to a plane perpendicular to the optical axis, i.e. parallel to the image plane.
This focuses to a plane perpendicular to the optical axis. You can change the relative focal plane. A relative focus
value of zero refocuses to the plane furthest away from the viewer and a value of 1 would focus to a plane that passes
through the object side focal point of the recording lens.
Result image:
- EImage::RefocusBasic
Required images:
- EImage::Processed_Normalized
Influencing parameters:
- ECCPar::Focus_RelativeFocusPlane
- ECCPar::Depth_MinVirtualDepth
- ECCPar::Depth_MaxVirtualDepth.
Pre-Process a ray image with a minimal set of preprocessing parameters.
Result image:
- EImage::GridData
Required images:
- EImage::Raw
Influencing parameters:
- ECCPar::PreProc_Demosaic_R
- ECCPar::PreProc_Demosaic_G
- ECCPar::PreProc_Demosaic_B.
Calculates the grid image. This is the raw or the gray image with an overlay that shows the current grid calibration.
Result image:
- EImage::Grid
Required images:
- EImage::Raw or EImage::Gray
Influencing parameters:
- ECCPar::Grid_DrawOnGrayImage
- ECCPar::Grid_DrawMlaGrid.
Pre-Process a ray image. This can apply denoise, brightness and sharpness adjustments.
Result image:
- EImage::Processed_Normalized
Required images:
- EImage::Raw
- EImage::Gray (optional)
Influencing parameters:
- ECCPar::PreProc_Demosaic_Enable
- ECCPar::PreProc_Demosaic_R
- ECCPar::PreProc_Demosaic_G
- ECCPar::PreProc_Demosaic_B
- ECCPar::PreProc_DenoiseNLM_Enable
- ECCPar::PreProc_DenoiseNLM_FilterDia
- ECCPar::PreProc_DenoiseNLM_NoiseLevel
- ECCPar::PreProc_DenoiseNLM_BlendFactor
- ECCPar::PreProc_Std_Enable
- ECCPar::PreProc_Std_Gradation
- ECCPar::PreProc_Sharp1_Enable
- ECCPar::PreProc_Sharp1_OnlyCalc
- ECCPar::PreProc_Sharp1_BlurStdDev
- ECCPar::PreProc_Sharp1_Factor.
Reinitializes the depth database.
This can be useful when calling Compute_DepthMap after changing the ray depth image manually.
Removes the computation filter mask set by SetComputationFilterMask.
Sets the computation filter mask image.
This image is used to reduce the number of lenses used for depth estimation.
It must have the same dimension as the raw image and a pixel type of Rx::Interop::Runtime28::EPixelType::Lum and a data
type of Rx::Interop::Runtime28::EDataType::UByte. Otherwise the image is converted.
Each lens of the raw image has a lens center that can be rounded to a pixel. If this pixel has the value 255 in the
filter mask image, the corresponding lens is used. If this pixel has another value, the lens is not used.
The image file to load.
Sets the computation filter mask image.
This image is used to reduce the number of lenses used for depth estimation.
It must have the same dimension as the raw image and a pixel type of Rx::Interop::Runtime28::EPixelType::Lum and a data
type of Rx::Interop::Runtime28::EDataType::UByte. Otherwise the image is converted.
Each lens of the raw image has a lens center that can be rounded to a pixel. If this pixel has the value 255 in the
filter mask image, the corresponding lens is used. If this pixel has another value, the lens is not used.
The computation filter mask image.
Uploads the given image as the new raw image of all computations.
The source image.
Applies the given calibration to the algorithms. This must be done every time the calibration changes.
The calibration.
(Optional) True to upload the gray image of the calibration to CUDA. False to use the current
gray image even if it is invalid.
Applies the given ray image.
This uploads the raw and the gray image to the CUDA device and applies the calibration and the parameters from the meta
data to the CUDA algorithms.
The ray image.
Gets the CUDA device that has been set by calling SetCudaDevice. Throws an exception if not set yet.
The CUDA device.
Sets the CUDA device that allocates the memory required for the operations and that runs the algorithms.
The CUDA device.
Destructor.
Move constructor.
[in,out] The CUDA compute instance.
Default constructor.
Provides methods for using a CUDA device as the computation unit of the LFR.
Gets the image format of the image defined by the given ID.
The image ID.
The image format.
Updates the OpenGL texture of the image defined by the given ID.
This copies the image into the texture and creates a valid texture ID if the texture has not been created before. The
calling thread must own the OpenGL context that owns the texture.
The image ID.
[in] The OpenGlInterop class.
(optional) True to create mipmaps of the texture.
CUDA data: Textures.
Gets device pointer pitch.
The image ID.
The device pointer pitch.
Gets the CUDA device pointer to the data of the image defined by the given ID.
The pointer maps to the memory on a CUDA device and cannot be used on the host.
The image ID.
The image device pointer.
Frees the memory used by all images. This invalidates all images.
Frees memory used by image defined by eImgID. This invalidates the image.
The image ID.
Gets the image format of the image defined by the given ID.
The image ID.
The image format.
CUDA data: Images.
Move assignment operator.
[in,out] The openGl instance.
The instance.
Gets the OpenGL version.
[out] The major part of the version.
[out] The minor part of the version.
Deletes the stored context (if it has been created by CreateContextSharedWithCurrent).
Releases the OpenGL context. Changes the calling thread's current rendering context so it's no longer current. This
method does not delete the stored OpenGL context.
Makes the stored OpenGL rendering context the calling thread's current rendering context.
Returns true if the calling thread hadn't the context BEFORE the call.
Creates an OpenGL context that is shared with the current OpenGL context. This requires a current OpenGL context.
Stores the current OpenGL context. Throws an exception if the calling thread hasn't a current OpenGL context.
Query if this object has a valid OpenGL context stored.
True if OpenGL context stored, false if not.
Destroys all OpenGL textures.
Attention: An OpenGL context must be stored before by calling StoreCurrentContext.
Destroys the OpenGL texture of the image defined by the given ID.
Attention: An OpenGL context must be stored before by calling StoreCurrentContext.
The image ID.
Gets the OpenGL texture ID of the image defined by the given ID.
If the desired texture has not been created yet, the returned texture ID is 0.
Attention: An OpenGL context must be stored before by calling StoreCurrentContext.
The image ID.
The texture ID or 0.
Destructor.
Move constructor.
[in,out] The open gl interop instance.
Default constructor.
Provides methods for using OpenGL contexts and textures.
The parameters access class.
Sets the CUDA device for the high resolution particle detector.
The CUDA device.
Gets found high resolution particle.
[out] The high resolution particle array.
Detect particles.
[in] The image.
Detect particles.
The complete file path of the sequence file.
Initializes this object.
The calibration.
Destructor.
Default constructor.
The confidence.
Track ID.
The high resolved image.
The unused raw positions.
All the raw position of the particles used and unused.
The 3d ellipses origin of the high resolution particle.
An high resolution particle
The virtual space position in millimeters of the z coordinate.
The virtual space position in millimeters of the y coordinate.
The virtual space position in millimeters of the x coordinate.
An ellipses 3D.
The semi-major axis radius.
The semi-minor axis radius.
The second axis direction y position.
The second axis direction x position.
The first axis direction x position.
The first axis direction x position.
The center y position.
The center x position.
An ellipses 2D.
Move assignment operator.
[in,out] The high resolution particle detection instance.
The instance.
Sets the CUDA device for the high resolution particle detector.
The CUDA device.
Gets high resolution particle tracks.
[in,out] The tracks.
Gets found tracks.
[in,out] The tracks.
Gets found high resolution particle.
[out] The high resolution particle array.
Gets found ellipses.
[out] The ellipses array.
Gets found ellipses.
[out] The ellipses array.
Gets an image.
0 = Foreground image.
1 = Blurred foreground image.
[out] The image.
Image Type
Filter tracks.
Detect particles.
[in] The image.
Detect particles.
Filename of the sequence file.
Calculates the background.
Adds an image to background.
The image.
Initializes this object.
The calibration.
Destructor.
Move constructor.
[in,out] The high resolution particle detection instance.
Default constructor.
Provides methods to perform high resolution particle detection.
Gets the number of direction changes.
True to get the changes in X direction
The direction changes.
Gets the maximal x spread of the track.
The maximal x spread in mm.
Gets the last particle of this track.
Last particle in track.
Gets the length of the track.
The length.
Adds the particle to the track;
[in] The high resolution particle.
Move Constructor.
The start image.
[in] The high resolution particles.
Default constructor.
Resets this object.
The maximal y coordinate of this track.
The maximal x coordinate of this track.
The minimal y coordinate of this track.
The minimal x coordinate of this track.
The average motion between two particles in pixels regarding the y coordinate.
The average motion between two particles in pixels regarding the x coordinate.
The average motion between two particles in millimeters regarding the z coordinate.
The average motion between two particles in millimeters regarding the y coordinate.
The average motion between two particles in millimeters regarding the x coordinate.
The average euclidean motion distance in mm between two particles.
The confidence.
The start image of this track.
True if this track has ended.
The high resolved image.
The high resolution particles.
A high resolution particle track consists of high resolution particles and a combined high resolution particle image.
Move assignment operator.
The high resolution particle. This particle is invalid afterwards.
A high resolution particle.
Move Constructor.
[in] A high resolution particle.
Default constructor.
Resets the high resolution particle.
The image number.
Track ID.
The moved euclidean distance in pixels.
The moved distance in pixels of the y coordinate.
The moved distance in pixels of the x coordinate.
The moved euclidean distance in mm.
The moved distance in millimeters of the z coordinate related to the previous position.
The moved distance in millimeters of the y coordinate related to the previous position.
The moved distance in millimeters of the x coordinate related to the previous position.
The unused raw positions 3D.
The used raw positions 3D.
All the raw position of the particles used and unused. x,y = 2D position and z = lens type
The virtual view in pixels y coordinate.
The virtual view in pixels x coordinate.
The virtual space position in millimeters of the z coordinate.
The virtual space position in millimeters of the y coordinate.
The virtual space position in millimeters of the x coordinate.
A flag indicating if the particle is virtual or real.
The standard deviation of color.
The mean color value.
The confidence.
The high resolved image.
An high resolution particle.
Resets the 3D ellipses.
The virtual space position in millimeters of the z coordinate.
The virtual space position in millimeters of the y coordinate.
The virtual space position in millimeters of the x coordinate.
An 3D ellipses, that inherits all properties of a 2D ellipses and extends it with a 3D position.
Resets the 2D ellipses.
The semi-major axis radius.
The semi-minor axis radius.
The second axis direction y position.
The second axis direction x position.
The first axis direction x position.
The first axis direction x position.
The center y position.
The center x position.
An 2D ellipses.
The parameters access class.
Gets the parameters access interface.
The parameters access interface.
The callback wrapper.
Event queue for all listeners interested in StatusMessage events.
Captures images from the given camera and combines them to a single gray image using the given CUDA device.
The given camera sends capture events while capturing images. You have to ensure that you don't process this images.
The best way to ensure this, is to remove your callback function from the camera before calling this method.
[out] The resultant gray image. Is created inside if its invalid before.
[in] The camera to capture images from. The camera is stopped after this function.
[in] The CUDA device.
Destructor.
Default constructor.
Capture gray image class.
This class captures images from a given camera and processes them to an image that can be used as the gray image of a
calibration. This class requires a CUDA device.
Gets the internal serial of the camera
Gets the camera index. This is the index in the list of cameras in the camera server.
Gets the format of the images captured by this camera.
Gets the name of the driver.
Query if this camera is open.
Gets the interface of the CUDA compute class determined by the ECudaComputeInterface enum.
The interface enum.
Null if no interface is implemented yet, else the interface object.
Gets the possible values of an integer property.
The property.
[out] The values.
Gets the propertyrange of the given arguments.
The property.
[in,out] Zero-based index of the minimum.
[in,out] Zero-based index of the maximum.
Gets the propertyrange of the given arguments.
The property.
[in,out] The minimum.
[in,out] The maximum.
Sets the value of a string property.
The property.
[in,out] The string value.
Sets a property.
The property.
The value.
Sets a property.
The property.
Zero-based index of the value.
Gets the value of a string property.
The property.
[out] The string value.
Gets a property.
The property.
[in,out] The value.
Gets a property.
The property.
[in,out] Zero-based index of the value.
Queries if a property is available.
The property.
True if a property is available, false if not.
Triggers this object.
Suspend capture.
true to suspend.
Stops a capture.
Starts the camera. The given trigger mode determines when the camera captures images.
The trigger mode.
Starts a capture.
Closes the camera. Does nothing if not open.
Opens the camera.
The image captured wrapper.
Executes the native image captured action.
The captured image.
The index of the camera in the camera server.
[in,out] The context registered with the callback.
Native handler of image captured events.
The captured image.
The index of the camera in the camera server.
[in,out] The context registered with the callback.
Event queue for all listeners interested in ImageCaptured events.
Handler of image captured events.
The captured image.
The index of the camera in the camera server.
Destructor.
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.
[in] The native instance to be wrapped by this class.
Default constructor.
A camera.
Gets the IP configuration.
[in,out] The IP camera IP.
[in,out] The IP camera sub net.
[in,out] The IP camera gateway.
Gets the IP configuration.
[in,out] The IP camera IP.
[in,out] The IP camera sub net.
[in,out] The camera MAC address.
Get the IP configuration.
[in,out] The IP camera IP.
[in,out] The IP camera sub net.
[in,out] The IP camera gateway.
[in,out] The persistent.
[in,out] The DHCP.
[in,out] The camera MAC address.
Sets the IP configuration.
[in,out] The IP camera IP.
[in,out] The camera sub net.
[in,out] The camera gateway.
true if this object is persistent.
The IP code.
Sets the IP configuration.
[in,out] The IP camera IP.
[in,out] The camera sub net.
The IP code.
Uploads the image with the given image ID.
The IP code.
Gets the force valid IP.
The IP code.
Destructor.
Constructor.
[in,out] If non-null, the pointer to the native representation.
The IP Camera.
CUDA data: Images.
The MAC.
Inequality operator.
The other MAC.
True if the parameters are not considered equivalent.
Equality operator.
The other MAC.
True if the parameters are considered equivalent.
Array indexer operator.
The index for the part of the MAC to be returned.
The value of the MAC tupel at the requested index.
Array indexer operator.
The index for the part of the MAC to be returned.
The value of the MAC tupel at the requested index.
Convert this CRxMAC into a string representation.
This CRxMAC as a CRxString.
Gets the reference to the unsigned __int64 member that contains the MAC address.
The reference.
Gets the MAC represented as an unsigned __int64 value. To be interpreted in the way, that the first byte is oriented to
the right:
0xAA BB CC DD EE FF --> This would be FF:EE:DD:CC:BB:AA.
The IP value.
Sets the given unsigned __int64 as new MAC. Interpreted in the way, that the first byte is oriented to the right:
0xAA BB CC DD EE FF --> This would be FF:EE:DD:CC:BB:AA.
The MAC to set.
Sets the given string as new MAC. See comment for CRxMAC(const CRxMAC& xMAC).
The MAC class.
Copy constructor.
The MAC class.
Constructor with a CRxString as initialization. Expected is a string with hex values separated by ":".
Example: CRxString xIP = "DE:AD:BE:EF:AA:BB";
The MAC.
Constructor with unsigned as MAC initialization. Interpreted in the way, that the first byte is oriented to the right:
0xAA BB CC DD EE FF --> This would be FF:EE:DD:CC:BB:AA.
The MAC.
Default constructor.
The subnetmask.
Array indexer operator.
The index of the requested part of the subnetmask.
The value of the subnetmask tupel at the requested index.
Array indexer operator.
The index of the requested part of the subnetmask.
The value of the subnetmask tupel at the requested index.
Query if this CRxIPv4Subnetmask is valid.
True if valid, false if not.
Convert this CRxIPv4Subnetmask into a string representation.
Example: "192.168.0.1"
This CRxIPv4Subnetmask as a CRxString.
Gets the IP address with each of the 4 parts in a unsigned char.
Example for 255.255.0.0 would be:
ucSub1 = 255;
ucSub2 = 255;
ucSub3 = 0;
ucSub4 = 0;
The first part of the subnetmask.
The second part of the subnetmask.
The third part of the subnetmask.
The fourth part of the subnetmask.
Gets the reference to the subnet unsigned int member.
The reference.
Gets the subnetmask represented as an unsigned value. To be interpreted in the way, that the first byte is oriented to
the right: 0x00 00 FF FF <-- This would be 255.255.0.0.
The subnetmask value.
Like the constructor with the same arguments:
Constructor with single unsigned char values as arguments for initialization of the Subnetmask.
Example for 255.255.0.0 would be:
ucSub1 = 255;
ucSub2 = 255;
ucSub3 = 0;
ucSub4 = 0;
The first part of the subnetmask.
The second part of the subnetmask.
The third part of the subnetmask.
The fourth part of the subnetmask.
Sets the given unsigned as new Subnetmask.
Interpreted in the way, that the first byte is oriented to the right:
0x00 00 FF FF -- This would be 255.255.0.0
The subnetmask to set.
Sets the given string as new subnetmask.
See comment for CRxIPv4Subnetmask().
The Subnetmask to set.
Copy constructor.
The subnetmask class.
Constructor with a CRxString as initialization.
Expected is a string with unsigned values separated by ".".
Example:
CRxString xIP = "255.255.0.0";
The subnetmask.
Constructor with single unsigned char values as arguments for initialization of the Subnetmask.
Example for 255.255.0.0 would be:
ucSub1 = 255;
ucSub2 = 255;
ucSub3 = 0;
ucSub4 = 0;
The first part of the subnetmask.
The second part of the subnetmask.
The third part of the subnetmask.
The fourth part of the subnetmask.
Constructor with unsigned as initialization.
Interpreted in the way, that the first byte is oriented to the right:
0x00 00 FF FF -- This would be 255.255.0.0
The Subnetmask.
Default constructor.
The IP.
Array indexer operator.
The index for the part of the IP to be requested.
The value of the IP tupel at the requested index.
Array indexer operator.
The index for the part of the IP to be requested.
The value of the IP tupel at the requested index.
Query if this CRxIPv4 is valid.
True if valid, false if not.
Convert this CRxIPv4 into a string representation.
This CRxIPv4 as a CRxString.
Gets the IP address with each of the 4 parts in a unsigned char.
Example for 10.0.0.1 would be:
ucIP1 = 10;
ucIP2 = 0;
ucIP3 = 0;
ucIP4 = 1;
[in,out] The first part.
[in,out] The second part.
[in,out] The third part.
[in,out] The fourth part.
Gets the reference to the unsigned int member that contains the IP address.
The reference.
Gets the IP represented as an unsigned value.
To be interpreted in the way, that the first byte is oriented to the right:
0x01 00 00 0A -- This would be 10.0.0.1
The IP value.
Sets the IP with single unsigned char values.
Example for 10.0.0.1 would be:
ucIP1 = 10;
ucIP2 = 0;
ucIP3 = 0;
ucIP4 = 1;
The first part of the IP.
The second part of the IP.
The third part of the IP.
The fourth part of the IP.
Sets the given unsigned as new IP.
Interpreted in the way, that the first byte is oriented to the right:
0x01 00 00 0A -- This would be 10.0.0.1
The IP to set.
Sets the given string as new IP.
See comment for CRxIPv4().
The IP class.
Copy constructor.
The IP class.
Constructor with a CRxString as initialization.
Expected is a string with unsigned values separated by ".".
Example:
CRxString xIP = "10.0.0.1";
The IP.
Constructor with single unsigned char values as arguments for initialization of the IP.
Example for 10.0.0.1 would be:
ucIP1 = 10;
ucIP2 = 0;
ucIP3 = 0;
ucIP4 = 1;
The first part of the IP.
The second part of the IP.
The third part of the IP.
The fourth part of the IP.
Constructor with unsigned as IP initialization.
Interpreted in the way, that the first byte is oriented to the right:
0x01 00 00 0A -- This would be 10.0.0.1
The IP.
Default constructor.
Exception for signaling a missing calibration database.
Exception for signaling errno errors.
Exception for signaling operating system errors.
Exception for signaling out of memory errors.
Exception for signaling file not found errors.
Executes the get IP configuration operation.
Excpected Device State:
- Any
[in,out] The camera IP.
[in,out] The camera subnet.
[in,out] The camera gateway.
[in,out] The is persistent.
[in,out] The is dhcp.
[in,out] The camera MAC.
Executes the set IP configuration operation.
Should be succesful in Discovered or Initialized State.
Throws RxCameraException. (!)
Excpected Device State:
The camera IP.
The camera subnet.
The camera gateway.
true if this INativeDeviceIPv4Do is persistent.
.
Executes the set IP configuration operation.
Should be succesful in Discovered or Initialized State.
Throws RxCameraException.
.
Provides functions for GigE Devices to change their GigE specific properties.
Move assignment operator.
[in,out] The exporter.
The instance.
Removes the given status message callback function.
Does nothing if the given function pointer has not been added to the list of callbacks.
The callback function to remove.
Adds the given status message callback function to the internal list of callbacks.
Adding the same function pointer twice will only update the given context pointer. This prevents multiple adds of the
same callback function.
The callback function.
[in] The callback context. Can be any pointer that is passed to the callback function.
Captures images from the given camera and combines them to a single gray image using the given CUDA device.
The given camera sends capture events while capturing images. You have to ensure that you don't process this images.
The best way to ensure this, is to remove your callback function from the camera before calling this method.
[out] The resultant gray image. Is created inside if its invalid before.
[in] The camera to capture images from. The camera is stopped after this function.
The CUDA device.
Destructor.
Move constructor.
[in,out] The capture gray image instance.
Default constructor.
Capture gray image class.
This class captures images from a given camera and processes them to an image that can be used as the gray image of a
calibration. This class requires a CUDA device.
The parameters access class.
Gets the parameters access interface.
The parameters access interface.
Unlocks this CUDA device. Does nothing if not locked by the calling thread.
Locks this CUDA device. This waits until locked or until the timeout has been expired.
Timeout in milliseconds. -1 will wait infinetly.
True if it succeeds, false on timeout.
Makes this CUDA device current for the calling thread.
Gets the ID of this CUDA device.
The internal CUDA device ID.
Queries if this CUDA device supports the given compute capability.
The major part of the compute capability version.
The minor part of the compute capability version.
True if this CUDA device supports the given compute capability, false if not.
Gets the compute capability of this CUDA device. The minimum compute capability is 2.0.
[out] The major part of the compute capability version.
[out] The minor part of the compute capability version.
Queries the free and the total amount of available device memory in bytes.
[out] Free device memory in bytes.
[out] Total device memory in bytes.
Destructor.
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.
[in] The native instance to be wrapped by this class.
Provides methods for interacting with a certain CUDA device.
Move assignment operator.
[in,out] The cuda device instance.
The instance.
Unlocks this CUDA device. Does nothing if not locked by the calling thread.
Locks this CUDA device. This waits until locked or until the timeout has been expired.
(optional) Timeout in milliseconds. -1 will wait infinetly.
True if it succeeds, false on timeout.
Makes this CUDA device current for the calling thread.
Gets the ID of this CUDA device.
The internal CUDA device ID.
Queries if this CUDA device supports the given compute capability.
The major part of the compute capability version.
The minor part of the compute capability version.
True if this CUDA device supports the given compute capability, false if not.
Gets the compute capability of this CUDA device. The minimum compute capability is 3.0.
[out] The major part of the compute capability version.
[out] The minor part of the compute capability version.
Queries the free and the total amount of available device memory in bytes.
[out] Free device memory in bytes.
[out] Total device memory in bytes.
Destructor.
Move constructor.
[in,out] The cuda device instance.
Constructor. Only for internal purposes.
[out] The implementation class.
Provides methods for interacting with a certain CUDA device.
Queries if StartWriting has been called.
True if writing, false if not.
Queries if a file has been opened.
True if open, false if not.
Gets the double shot mode that has been passed in StartWriting.
The double shot mode.
Gets the current file size in bytes.
The file size.
Gets the size of a frame in bytes.
The frame size.
Gets the current number of frames in the opened sequence.
The frame count.
Gets the current number of used buffer slots.
The used frame buffer count.
Gets the frame format that has been passed in StartWriting.
The frame format.
Closes the opened sequence file and stops the background buffer thread.
The number of frames written.
Writes the given frame at the current frame index.
[in] The frame.
Writes the given frame at the current frame index.
[in] The frame.
Starts the write process. This starts the background buffer thread.
[in] The frame format.
[in] The calibration.
[in] The meta data.
The double shot mode.
Opens the given ray sequence for writing.
Requires an authenticated dongle (Rx::LFR::Net::LightFieldRuntime::Authenticate) with the
Rx::Dongle::ERuntimeFeature::Save feature.
[in] The complete file path.
Number of frames to buffer. Must NOT be zero. Default is 2.
Destructor. Closes the opened file.
Default constructor.
Provides methods for writing frames into a sequence in a rays file.
Gets or sets the timestamp of the image capture. Is 0.0 if this image has no timestamp.
Gets the ID of this image.
Gets the format of this image.
Gets the type of the data.
Gets the type of the pixel.
Gets the height of this image in pixels.
Gets the width of this image in pixels.
Flags whether this image is valid or not.
An image is valid if memory has been allocated.
Gets bytes per pixel.
The bytes per pixel.
Creates the image.
The new image.
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.
[in] The native instance to be wrapped by this class.
Default constructor.
\addtogroup RxNET_Image
*
@{
Const Image class.
Gets the calibration.
The calibration.
Gets the meta data.
The meta data.
Default constructor. Does not allocate image memory.
Extends the default image class by a set of meta data and a calibration.
The parameters access class.
Gets the parameters object.
The parameters object.
Saves some details of this calibration as a XML string.
[out] The XML string.
Saves some details of this calibration as a XML file.
[in] The file name.
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.
[out] The 2D lens information vector.
True to get the MLI grid. False to get the MLA grid.
Projects from the given pixel position in the raw image with the given standard depth through the micro lenses into
virtual space.
[in,out] The X coordinate of the target point in virtual space in mm.
[in,out] The Y coordinate of the target point in virtual space in mm.
[in,out] The Z coordinate of the target point in virtual space in mm.
The X coordinate of the source point in pixels in raw image format.
The Y coordinate of the target point in pixels in raw image format.
The Z coordinate of the target point in standard depths (Between 0.5 and 1.0)
Projects the given 3D point given in virtual space in sensor frame in millimeters through all suitable micro lenses.
[out] The projected points. This array contains three entries per projected
point. The first and the second entry are the X and the Y coordinates of
the projected point given in pixels in the raw image. The third entry is
the corresponding lens type.
The X coordinate of the source point in virtual space in millimeters.
The Y coordinate of the source point in virtual space in millimeters.
The Z coordinate of the source point in virtual space in millimeters.
The radius given in lens units that is used to find the suitable micro
lenses. A radius of 2 or 3 lens units is recommended.
Zero-based index of the minimum allowed distance to lens border in pixels.
Projects the given 3D point given in virtual space in sensor frame in millimeters through all suitable micro lenses.
[out] The projected points. This array contains three entries per projected point. The first
and the second entry are the X and the Y coordinates of the projected point given in pixels in
the raw image. The third entry is the corresponding lens type.
The X coordinate of the source point in virtual space in millimeters.
The Y coordinate of the source point in virtual space in millimeters.
The Z coordinate of the source point in virtual space in millimeters.
The radius given in lens units that is used to find the suitable micro lenses. A radius of 2 or
3 lens units is recommended.
Projects an array of points from the given source space into the given target space.
[out] The array of projected points.
[in] The array of points to project.
The target space.
The source space.
[in] The image format of the source and/or target space. Only required if the space is a
view. This parameter limits this function to allow only projections from an image format to the
same image format.
True if all projections succeeded, false if at least one projection failed (out of sensor or image).
Projects the given source depth value into the given target space.
The source depth value in millimeter or virtual depths.
The source space.
True if the source depth value is given in virtual depths. Is ignored if the source space isn't
virtual.
The target space.
True if the target depth value should be given in virtual depths. Is ignored if the target space
isn't virtual.
The resultant target depth value in millimeter or virtual depths.
Sets the given image as the gray image. This moves or copies the given image into this calibration.
[in,out] The gray image. Is invalid after this call if bMove is true.
True to move the image; false to copy the image.
Sets the given image as the gray image. This copies the given image into this calibration.
[in] The gray image.
Gets the gray image. The gray image is invalid if this calibration has no gray image.
The gray image.
Queries if this calibration has a gray image.
True if this calibration has a gray image, false if not.
Gets the pointer to the internal camera format. Only for internal purposes.
The pointer to the internal camera format.
Sets the camera format by pointer. Only for internal purposes.
[in] The pointer to the camera format to set.
Sets this calibration to default. All applied parameters are reset. The gray image is not affected.
The height of the camera sensor in pixels.
The width of the camera sensor in pixels.
Destructor. Frees all used memory including the gray image.
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.
[in] The native instance to be wrapped by this class.
Default constructor. Creates an uninitialized calibration. Call SetToDefault to initialize it.
Defines a single camera or ray image calibration, including a possible gray image.
Internal pointer to the calibration.
Internal pointer to the meta data.
Gets the calibration.
The calibration.
Gets the calibration.
The calibration.
Gets the meta data.
The meta data.
Gets the meta data.
The meta data.
Move assignment operator.
[in,out] The ray file to move. Is invalid after this call.
This instance.
Destructor. Frees all used memory.
Move constructor.
[in,out] The ray file to move. Is invalid after this call.
Default constructor. Does not allocate image memory.
Extends the default CRxImage class by a set of meta data and a calibration.
Writes the application details to the meta data.
Name of the application.
The application version.
Updates the meta data from a calibration meta data instance.
Information describing the calib meta.
Updates the meta data from a camera instance.
[in,out] The camera.
Updates the meta data from a CUDA compute instance.
The CUDA compute instance.
Move assignment operator.
[in,out]The meta data.
The instance.
Destructor. Frees all used memory.
Move constructor.
[in,out] The meta data.
Default constructor. Does not allocate image memory.
The LFR Meta Data class
True if this CRxCalibMetaData describes a master calibration.
true if this CRxCalibData is the default calibration.
For electronically controllable lenses, this is the data value which reflects the aperture setting. This value may not
be the f-number.
For electronically controllable lenses, this is the data value which reflects the focus setting. This value may not be
the focus distance in millimeters.
The main lens information.
The description.
The caption.
The camera hardware id comprised of the internal camera type and the internal camera serial.
The camera type.
The camera serial.
The unique identifier.
Finalizes an instance of the CRxCalibData class.
Initializes a new instance of the CRxCalibData class.
Raytrix Calibration Data description class.
Maximal aperture of the main lens.
Minimal aperture of the main lens.
Maximal focal length of the main lens in millimeters.
Minimal focal length of the main lens in millimeters.
The comment.
A string describing the type of the main lens.
The vendor of the main lens. E.g. "Canon", "Nikon".
Finalizes an instance of the CRxMainLens class.
Initializes a new instance of the CRxMainLens class.
Raytrix Main Lens description class.
Move assignment operator.
[in,out]The camera instance.
The instance.
Gets the camera interface.
The interface type.
Null if it fails, else the interface.
Gets the camera interface.
The interface type.
Null if it fails, else the interface.
Gets the possible values of an integer property.
The property.
[out] The values.
Gets the property value range of the given property of type int.
[in] The property in question.
[out] The minimum value for given property.
[out] The maximum value for given property.
Gets the property value range of the given property of type float.
[in] The property in question.
[out] The minimum value for given property.
[out] The maximum value for given property.
Sets the value of a string property.
The property.
The string value.
Sets a property value of type int.
[in] The property to be changed.
[in] The value to be set.
Sets a property value of type float.
[in] The property to be changed.
[in] The value to be set.
Gets the value of a string property.
The property.
[out] The string value.
Gets a property value of type int.
[in] The property in question.
[out] The return value.
Gets a property value of type float.
[in] The property in question.
[out] The return value.
Queries if a property is available.
[in] The property in question.
True if the property is available, false if not.
Triggers the camera.
Suspends the camera.
True to suspend, false to unsuspend.
Stops the camera.
Starts the camera. The given trigger mode determines when the camera captures images.
The trigger mode.
Starts the camera. The configured trigger mode determines when the camera captures images.
Closes the device and finalizes the communication. Does nothing if not open.
Opens the device and prepares the communication.
Gets the camera index. This is the index in the list of cameras in the camera server.
The index.
Gets the internal serial string. Is only available after the camera has been initialized.
The internal serial.
Gets the driver name, e.g. "TypeA".
The driver name.
Query if this camera is open.
True if open, false if not.
Gets the format of the images captured by this camera.
The image format.
Removes the given callback function from the list of image captured callbacks. Does nothing if it's not in the list.
The callback function to remove.
Adds the given callback function with the given context to the list of image captured callbacks.
If the given callback function is already in the list, only the context is updated to the given one.
The callback function. Must not be null.
[in] The context pointer. Can be null.
Destructor.
Move constructor.
[in,out]The camera instance.
Constructor.
A camera.
The internal data.
Gets the pointer to the internal data.
The pointer.
Gets the pointer to the internal data.
The pointer.
Copies the content of the given source memory into this array. Sets the size of this array to the size of the memory.
The source memory.
Sets the internal memory to zeros.
Clears the array.
Set the size of this array to the given number of elements.
Number of elements.
Set the size of this array to the given number of elements.
Number of elements.
Query if this object is valid. Returns always true.
True if valid, false if not.
Gets the number of elements in this array.
The length.
Gets the size of a single value in this array.
The element size.
Gets the pointer to the internal data.
The pointer.
Gets the pointer to the internal data.
The pointer.
Array indexer operator.
The index.
The indexed value.
Array indexer operator.
The index.
The indexed value.
Assignment operator.
The array to copy.
This array.
Destructor. Removes all elements from this array.
Copy constructor. Creates a copy of the given array.
The array to copy.
Constructor. Creates a new array with the given number of initialized elements.
The number of elements.
The initial value of each element in this array.
Constructor. Creates a new array with the given number of uninitialized elements.
The number of elements.
Default constructor. Creates an empty array.
Defines an alias representing the type of the elements in this array.
\addtogroup RxCore_Tools
*
An array of integers.
Possible return codes for devices.
Something unexpected happened.
Everything has to be restarted. It is a bitwise | of the previous 2
A camera power reset is needed. This also means you have to reenumerate.
The reenumeration of cameras is needed.
The nothing additional needed, all fine.
\brief
\copybrief Rx::Interop::Runtime30::Camera::EProperty
The position of the strobe signal given in percentage of the strobe length. A value of 0 % establishes the earliest position. A value of 100 % establishes the latest position. A value of 50 % means that the strobe pulse is located in the middle of the exposure period. This parameter refers to the middle of the strobe pulse (unsigned,[0,100],RW).
The length of the strobe signal given in percentage of the camera exposure time. A value of 50 % means that the duration of the strobe pulse is half the duration of the exposure period. (unsigned,[0,100],RW).
Enable (1) or disable (0) the strobe output channel of the frame grabber. Only available in external trigger mode (unsigned,[0,1],RW).
Mode of the external trigger. The supported modes are listed in Rx::Interop::Runtime30::Canera::EExternalTriggerMode
Read mode of image files of the virtual camera
The current source image folder of the virtual camera
A string representing the camera link port ID of the grabber or the camera link camera. Example: "EURESYS#Euresys Grablink Full#0".
DEPRICATED: The identifier of the grabber board.
Property for getting and setting the board topology.
Property for getting and setting PIV mode. [unsigned] [0,1]
Property for getting and setting IrisValue.
Property for getting and setting Iris.
Property for getting and setting Focus.
Property for getting availability of a software controllable main lens.
Property for getting and setting auto gain mode of camera.
Property for getting and setting auto exposure mode of camera.
Property for getting and setting auto luminance mode of camera.
Property for getting and setting the bit depth of the acquisition image.
Property for getting and setting image height. This is the height of acquisition image, not of image sensor.
Property for getting and setting image width. This is the width of acquisition image, not of image sensor.
Property for getting and setting y offset of image. This is the y coordinate on sensor where the image starts.
Property for getting and setting x offset of image. This is the x coordinate on sensor where the image starts.
Property for getting and setting TapBalanceMode.
Property for getting and setting TapBalance.
Property for getting and setting blue gain value of camera.
Property for getting and setting green gain value of camera.
Property for getting and setting red gain value of camera.
Property for getting and setting global gain value of camera.
Property for getting and setting the number of video buffers.
Property for getting and setting PixelClock for IDS Cameras.
Property for getting current acquisition frame rate.
Property for getting and setting frame rate of camera.
Property for getting and setting exposure of camera.
The Camera is suspended
Property for getting and setting the video mode. The supported modes are listed in Rx::Interop::Runtime30::Canera::EriggerMode
The Camera is a bayer camera
The Camera is a color camera
The Camera is capturing
The Camera is opened
The Camera is connected
The Camera is initialized
Unique hardware ID.
Raytrix camera type name. E.g. 'TypeD' or 'TypeE'.
Property for getting temperature of camera.
Get the Raytrix camera model name.
Get the Raytrix camera model name.
The firmware version of the hardware.
The internal serial nr. of the hardware.
The name the hardware reports as its own.
\brief
\copybrief Rx::Interop::Runtime30::Camera::ETriggerMode
The camera waits for an external trigger signal and records a single frame using the current exposure settings.
The camera captures a single frame triggered by the software.
The camera triggers new frames itself continuously.
Three State enum for return codes or other usage.
Steffens, 29.10.2013.
True.
False.
The unknown state.
Move assignment operator.
[in,out]The sequence file writer instance.
The instance.
Queries if StartWriting has been called.
True if writing, false if not.
Queries if a file has been opened.
True if open, false if not.
Gets the double shot mode that has been passed in StartWriting.
The double shot mode.
Gets the current file size in bytes.
The file size.
Gets the size of a frame in bytes.
The frame size.
Gets the current number of frames in the opened sequence.
The frame count.
Gets the current number of used buffer slots.
The used frame buffer count.
Gets the frame format that has been passed in StartWriting.
The frame format.
Closes the opened sequence file and stops the background buffer thread.
The number of frames written.
Writes the given frame at the current frame index.
The frame.
Starts the write process. This starts the background buffer thread.
The frame format.
The calibration.
[in,out] The meta data.
The double shot mode.
Opens the given ray sequence for writing.
Requires an authenticated dongle (Rx::LFR::CLightFieldRuntime::Authenticate) with the Rx::Dongle::ERuntimeFeature::Save
feature.
The file name.
(Optional) Number of frames to buffer. Must NOT be zero.
Destructor. Closes the opened file.
Move constructor.
[in,out]The sequence file writer instance.
Default constructor.
Provides methods for writing frames into a sequence in a rays file.
Move assignment operator.
[in,out] The calibration instance.
The instance.
Saves some details of this calibration as a XML string.
[out] The XML string.
Saves some details of this calibration as a XML file.
The file name.
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.
[out] The 2D lens information vector.
True to get the MLI grid. False to get the MLA grid.
Projects from the given pixel position in the raw image with the given standard depth through the micro lenses into
virtual space.
[in,out] The X coordinate of the target point in virtual space in mm.
[in,out] The Y coordinate of the target point in virtual space in mm.
[in,out] The Z coordinate of the target point in virtual space in mm.
The X coordinate of the source point in pixels in raw image format.
The Y coordinate of the target point in pixels in raw image format.
The Z coordinate of the target point in standard depths (Between 0.5 and 1.0)
Projects the given 3D point given in virtual space in sensor frame in millimeters through all suitable micro lenses.
[out] The projected points. This array contains three entries per projected
point. The first and the second entry are the X and the Y coordinates of
the projected point given in pixels in the raw image. The third entry is
the corresponding lens type.
The X coordinate of the source point in virtual space in millimeters.
The Y coordinate of the source point in virtual space in millimeters.
The Z coordinate of the source point in virtual space in millimeters.
The radius given in lens units that is used to find the suitable micro
lenses. A radius of 2 or 3 lens units is recommended.
The minimal allowed distance to lens border in pixels.
Projects the given 3D point given in virtual space in sensor frame in millimeters through all suitable micro lenses.
[out] The projected points. This array contains three entries per projected point. The first
and the second entry are the X and the Y coordinates of the projected point given in pixels in
the raw image. The third entry is the corresponding lens type.
The X coordinate of the source point in virtual space in millimeters.
The Y coordinate of the source point in virtual space in millimeters.
The Z coordinate of the source point in virtual space in millimeters.
The radius given in lens units that is used to find the suitable micro lenses. A radius of 2 or
3 lens units is recommended.
Projects an array of points from the given source space into the given target space.
[out] The array of projected points.
The array of points to project.
The target space.
The source space.
The image format of the source and/or target space. Only required if the space is a view. This
parameter limits this function to allow only projections from an image format to the same image
format.
True if all projections succeeded, false if at least one projection failed (out of sensor or image).
Projects the given source depth value into the given target space.
The source depth value in millimeter or virtual depths.
The source space.
True if the source depth value is given in virtual depths. Is ignored if the source space isn't
virtual.
The target space.
True if the target depth value should be given in virtual depths. Is ignored if the target space
isn't virtual.
The resultant target depth value in millimeter or virtual depths.
Sets the depth correction volume. This moves the given mapping into this calibration.
[in] The mapping is invalid after this call.
Gets the depth correction volume.
The depth correction volume.
Gets the depth correction volume.
The depth correction volume.
Query if this object has a depth correction volume.
True if there is a depth correction volume, false if not.
Sets the given image as the gray image. This moves the given image into this calibration.
The gray image. Is invalid after this call.
Sets the given image as the gray image. This copies the given image into this calibration.
The gray image.
Sets the given image as the gray image. This copies the given image into this calibration.
The image.
Gets the gray image. The gray image is invalid if this calibration has no gray image.
The gray image.
Gets the gray image. The gray image is invalid if this calibration has no gray image.
The gray image.
Queries if this calibration has a gray image.
True if this calibration has a gray image, false if not.
Gets the pointer to the internal camera format. Only for internal purposes.
The pointer to the internal camera format.
Sets the camera format by pointer. Only for internal purposes.
[in] The pointer to the camera format to set.
Sets this calibration to default. All applied parameters are reset. The gray image is not affected.
The height of the camera sensor in pixels.
The width of the camera sensor in pixels.
Destructor. Frees all used memory including the gray image.
Move constructor.
[in,out]The calibration instance.
Default constructor. Creates an uninitialized calibration. Call SetToDefault to initialize it.
Defines a single camera or ray image calibration, including a possible gray image.
Possible spaces used in the projection system.
Full pathname of the file.
The cell size in z direction.
The cell size in y direction.
The cell size in x direction.
The dimension z component.
The dimension y component.
The dimension x component.
The max position z component.
The max position y component.
The max position x component.
The min position z component.
The min position y component.
The min position x component.
The depth correction volume data.
Sets the mapping to zero zero.
Function call operator.
The position of the x cell.
The position of the y cell.
The position of the z cell.
The result of the operation.
Return the pointer to the mapping data.
Null if it fails, else the data pointer.
Return the constant pointer to the mapping data.
Null if it fails, else the data pointer.
Gets the number of bytes of the mapping volume.
The byte count.
Query if this mapping volume is valid.
True if valid, false if not.
Destroys this mapping volume if one has been created. Resets all internal variables.
True if it succeeds, false if it fails.
Maps the given point to another point.
[out] The point x coordinate.
[out] The point y coordinate.
[out] The point z coordinate.
True if it succeeds, false if it fails.
Query if this object contains the given fPointX.
The point x coordinate.
The point y coordinate.
The point z coordinate.
True if the object is in this collection, false if not.
Create a mapping of given size and reserve the appropriate amount of memory.
The min position X.
The min position Y.
The min position Z.
The max position X.
The max position Y.
The max position Z.
The X dimension.
The Y dimension.
The Z dimension.
Information describing the mapping volume.
True if it succeeds, false if it fails.
Creates this mapping by moving the data of the given mapping into this mapping.
[in,out] The mapping to move. Is invalid after this call.
Creates a copy of the given mapping. Only (re)allocates memory if required.
The mapping to copy.
Copies the content of the given mapping data into this mapping.
The mapping volume data to copy.
True if it succeeds, false if it fails.
Move assignment operator.
[in] The mapping to move. This is invalid after the call.
A shallow copy of this object.
Assignment operator. Copies the contents of the given mapping.
The mapping.
A shallow copy of this object.
Destructor. All used memory is freed.
Move constructor.
[in] The mapping to move. This is invalid after the call.
Copy constructor. Creates a copy of the given image.
The mapping to copy.
Default constructor. Creates an invalid mapping without using any memory.
\addtogroup RxCore_Mapping
*
The mapping 3D. Uses a 3D volume to map a 3d Point to another 3d Point.
Dimension X
Min Position *_________________
/| /
/ | /|
/__|______________/ |Dimension Y
| | | |
| |______________|_|
| / | /
Dimension Z | / |/
|/________________* MaxPosition.
Particle tracking callbacks
Adds an element into the respective parameter map.
If an element already exists in the map it gets overwritten.
The name of the element.
The group of the element.
The value of the element.
Query if metadata has element with label sxLabel.
The Label.
True if element, false if not.
Gets all information about the given element.
[in] The name of the element.
[out] The type of the element.
[out] The group of the element.
Gets all information about the given element.
The index of the element.
[out] The name of the element.
[out] The type of the element.
[out] The group of the element.
Gets the element count.
The element count.
Clears this object to its blank/initial state.
Assignment operator.
The data.
A shallow copy of this object.
Destructor.
Copy constructor.
The data.
Default constructor.
\addtogroup RxCore_Tools
*
@{
Handles a collection of meta data of different types.
Values that represent value data types.
Array of strings. Is 'Rx::CRxArrayString' in C++ and 'string[]' in .NET.
Array of double precision floating points. Is 'Rx::CRxArrayDouble' in C++ and 'double[]' in .NET.
Array of unsigned integers. Is 'Rx::CRxArrayUInt' in C++ and 'uint[]' in .NET.
String data type. Is 'Rx::CRxString' in C++ and 'string' in .NET.
Undefined.
No trigger mode.
No property. No feature.
The internal data.
Gets the pointer to the internal data.
The pointer.
Gets the pointer to the internal data.
The pointer.
Copies the content of the given source memory into this array. Sets the size of this array to the size of the memory.
The source memory.
Sets the internal memory to zeros.
Clears the array.
Set the size of this array to the given number of elements.
Number of elements.
Set the size of this array to the given number of elements.
Number of elements.
Query if this object is valid. Returns always true.
True if valid, false if not.
Gets the number of elements in this array.
The length.
Gets the size of a single value in this array.
The element size.
Gets the pointer to the internal data.
The pointer.
Gets the pointer to the internal data.
The pointer.
Array indexer operator.
The index.
The indexed value.
Array indexer operator.
The index.
The indexed value.
Assignment operator.
The array to copy.
This array.
Destructor. Removes all elements from this array.
Copy constructor. Creates a copy of the given array.
The array to copy.
Constructor. Creates a new array by splitting the given string at each occurrence of the given separator.
The string to split.
The split separator.
Constructor. Creates a new array with the given number of initialized elements.
The number of elements.
The initial value of each element in this array.
Constructor. Creates a new array with the given number of uninitialized elements.
The number of elements.
Default constructor. Creates an empty array.
Defines an alias representing the type of the elements in this array.
\addtogroup RxCore_Tools
*
An array of strings.
The internal data.
Gets the pointer to the internal data.
The pointer.
Gets the pointer to the internal data.
The pointer.
Copies the content of the given source memory into this array. Sets the size of this array to the size of the memory.
The source memory.
Sets the internal memory to zeros.
Clears the array.
Set the size of this array to the given number of elements.
Number of elements.
Set the size of this array to the given number of elements.
Number of elements.
Query if this object is valid. Returns always true.
True if valid, false if not.
Gets the number of elements in this array.
The length.
Gets the size of a single value in this array.
The element size.
Gets the pointer to the internal data.
The pointer.
Gets the pointer to the internal data.
The pointer.
Array indexer operator.
The index.
The indexed value.
Array indexer operator.
The index.
The indexed value.
Assignment operator.
The array to copy.
This array.
Destructor. Removes all elements from this array.
Copy constructor. Creates a copy of the given array.
The array to copy.
Constructor. Creates a new array with the given number of initialized elements.
The number of elements.
The initial value of each element in this array.
Constructor. Creates a new array with the given number of uninitialized elements.
The number of elements.
Default constructor. Creates an empty array.
Defines an alias representing the type of the elements in this array.
\addtogroup RxCore_Tools
*
An array of unsigned integers.
ParticleTracking callback for reporting progress of processed tasks. The 'uProgressType' describes the type of
progress as
0 : Staring algorithm
1 : Report of progress in per mill provided in 'iValue'
2 : Algorithm finished. Task has not necessarily been finished yet (i.e. no FinishCallback)
Return 'true' to signal task to cancel computation.
The UID of the task is as returned by asynchronous functions. Unused for synchronous calls.
Progress type.
Value of progress.
Identifier of failed task.
Callback context (pointer to owner).
ParticleTracking callback for delivering estimation result to caller in case of asynchronous calls to
PerformParticleTracking_Async and IncrementalParticleTracking_Async.
Only used for asynchronous calls.
The UID of the task is as returned by asynchronous functions.
Particle array result.
Identifier of failed task.
Callback context (pointer to owner).
ParticleTracking callback for reporting the successful completion of a task.
Only used for asynchronous calls.
The UID of the task is as returned by asynchronous functions.
Identifier of failed task.
Callback context (pointer to owner).
ParticleTracking callback for error report from task execution. A failed task indicates that a requested operation
could not be processed successfully. E.g. calling an estimation for a time index that has no corresponding image in
used sequence results in 'image not found' error.
Only used for asynchronous calls.
The UID of the task is as returned by asynchronous functions.
PerformParticleTracking_Async(const Rx::CRxString& sSequenceFilename);
ComputeBgImages_Async(const Rx::CRxString& sSequenceFilename);
IncrementalParticleTracking_Async(Rx::LFR::CRayImage& xRayImage);
Excpetion describing fail state.
Identifier of failed task.
Callback context (pointer to owner).
Callback for error report from worker module. Failed modules indicate a critical error in the processing chain of
the main process. The systems needs to be cleared and re-initialized.
Excpetion describing fail state.
Callback context (pointer to owner).
The type of the function pointer of image captured callbacks.
The type of the function pointer of all status message callbacks.
The internal data.
Gets the pointer to the internal data.
The pointer.
Gets the pointer to the internal data.
The pointer.
Copies the content of the given source memory into this array. Sets the size of this array to the size of the memory.
The source memory.
Sets the internal memory to zeros.
Clears the array.
Set the size of this array to the given number of elements.
Number of elements.
Set the size of this array to the given number of elements.
Number of elements.
Query if this object is valid. Returns always true.
True if valid, false if not.
Gets the number of elements in this array.
The length.
Gets the size of a single value in this array.
The element size.
Gets the pointer to the internal data.
The pointer.
Gets the pointer to the internal data.
The pointer.
Array indexer operator.
The index.
The indexed value.
Array indexer operator.
The index.
The indexed value.
Assignment operator.
The array to copy.
This array.
Destructor. Removes all elements from this array.
Copy constructor. Creates a copy of the given array.
The array to copy.
Constructor. Creates a new array with the given number of initialized elements.
The number of elements.
The initial value of each element in this array.
Constructor. Creates a new array with the given number of uninitialized elements.
The number of elements.
Default constructor. Creates an empty array.
Defines an alias representing the type of the elements in this array.
\addtogroup RxCore_Tools
*
An array of SParticle structs.
Equality operator (tests iTimeIndex and iTrackUID).
The particle.
True if the parameters are considered equivalent.
Array providing involved 2D particles by position and size. I.e. components
(i,0) : position of particle i in image x-axis in PX on pxa
(i,1) : position of particle i in image y-axis in PX on pxa
(i,2) : radius.
The average luminance over all 2D particles. Determined in blob matching not from pixel array.
Quality measure for 3D particle in [0..1]. Determined by depth, match-count and re-projection error.
Maximal angle between all lens baselines during matching. Values in [0...pi/2].
\leq 0.8 indicates instable 3D position.
Maximum of re-projection errors to all 2D features.
Estimated 3D particle position in MM in global object space.
Unique identifier for track corresponding to this. Track might have length 1, i.e. only this particle.
Time index of image this was detected in. Index in image sequence if applicable, else count over estimations.
Representation for particles estimated in Rx.Flow algorithms. Provides 3D position, quality information,
time track ID and involved 2D particles (position and size).
The internal data.
Gets the pointer to the internal data.
The pointer.
Gets the pointer to the internal data.
The pointer.
Copies the content of the given source memory into this array. Sets the size of this array to the size of the memory.
The source memory.
Sets the internal memory to zeros.
Clears the array.
Set the size of this array to the given number of elements.
Number of elements.
Set the size of this array to the given number of elements.
Number of elements.
Query if this object is valid. Returns always true.
True if valid, false if not.
Gets the number of elements in this array.
The length.
Gets the size of a single value in this array.
The element size.
Gets the pointer to the internal data.
The pointer.
Gets the pointer to the internal data.
The pointer.
Array indexer operator.
The index.
The indexed value.
Array indexer operator.
The index.
The indexed value.
Assignment operator.
The array to copy.
This array.
Destructor. Removes all elements from this array.
Copy constructor. Creates a copy of the given array.
The array to copy.
Constructor. Creates a new array with the given number of initialized elements.
The number of elements.
The initial value of each element in this array.
Constructor. Creates a new array with the given number of uninitialized elements.
The number of elements.
Default constructor. Creates an empty array.
Defines an alias representing the type of the elements in this array.
\addtogroup RxCore_Tools
*
An array of doubles.
Defines an alias representing the type of the elements in this array.
\addtogroup RxCore_Tools
*
@{
A 2D double array.
Destructor.
Gets the pointer to the memory block.
The pointer to memory.
Copies the memory block described by pMemory into this memory block. This memory block is automatically resized. The
function throws an exception if the element sizes of the given memory block does not agree with the element size of
this memory block.
[in] The memory to copy into this memory block.
Reset all values in the memory block. The actual value the elements in the memory block are reset to depends on the
implementation.
Deletes this memory block.
Resizes the memory block to the given number of elements. The size of an element is fixed by the implementation and can
be read out with the function GetElementSize().
The amount of rows to allocate.
The amount of columns to allocate.
Creates a new memory block of nRows times nCols elements. The size of an element is fixed by the implementation and can
be read out with the function GetElementSize().
The amount of rows to allocate.
The amount of columns to allocate.
Common 2D memory interface.
Destructor.
Query if this object is valid. This function returns also true if the object itself is valid but the memory block has
size zero.
True if valid, false if not.
Gets the pointer to memory.
The pointer to memory.
Gets the number of elements in the memory block. The total number of bytes allocated by the memory block is given by
the nRows times nCols times the element size.
[out] The number of rows.
[out] The number of columns.
Gets the element size. The memory block is made up of blocks of the given number of bytes. The function Length()
returns the number of elements in the memory block, where each element is of the size given in GetElementSize(). For
example, an array of 10 doubles has element size 8 and length 10.
The element size in bytes.
Interface for 2D memory read operations.
True if this image is only a moniker for an image data pointer.
The timestamp of the image capture. Is 0.0 if this image has no timestamp.
The image ID.
The image data.
The image format.
Swaps the data between this and the given image.
[in,out] The image to swap with.
Find minimal and maximal value of image and normalize image to range [0,1].
Is currently only implemented for pixel type TPixel_L_f.
True if it succeeds, false if it fails.
Test whether image is of a particular pixel and data type.
The pixel type.
The data type.
True if of type, false if not.
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.
[out] The target image. This is created within the correct format.
Convert the pSrcMem memory to a different type and store result in memory pTrgMem.
[in] Target memory (must have correct target size).
Source memory.
The target image format.
The source image format.
True if it succeeds, false if it fails.
Convert the pSrcImage to a different type and store result in pDstImage.
[in,out] Pointer to target image interface.
Pointer to source image interface.
The target pixel type.
The targer data type.
If true, the memory for the target image is created.
False if an error occurred, otherwise true.
Convert this image to a different type and store result in xImage.
[in,out] The image instance into which to write the result. The size of this image is adapted to
this size.
The target pixel type.
The target data type.
False if an error occurred, otherwise true.
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.
True if this image is a moniker, false if not.
Sets the timestamp and the ID of the image.
The timestamp.
The ID.
Sets the timestamp of the image capture.
The timestamp.
Gets the timestamp of the image capture. Is 0.0 if this image has no timestamp.
The timestamp.
Sets the ID of this image.
The ID.
Gets the ID of this image.
The ID of this image.
Gets the image format.
The format.
Return the pointer to the data array.
Null if it fails, else the data pointer.
Return the constant pointer to the data array.
Null if it fails, else the data pointer.
Gets the type of the image.
[out] The pixel type.
[out] The data type.
Gets the size of the image.
[out] The width.
[out] The height.
Gets the number of bytes of the whole image.
The byte count.
Gets the number of pixels.
The pixel count.
Get number of bytes per pixel.
The bytes per pixel.
Query if this image is valid.
True if valid, false if not.
Destroys this image if one has been created. Resets all internal variables.
True if it succeeds, false if it fails.
Creates copy of the given image. No re-allocation is applied if image is of requested format.
The image.
True if it succeeds, false if it fails.
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.
Width of image.
Height.
Type of the pixel.
Type of the data.
The data.
True if it succeeds, false if it fails.
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.
The width of image.
The height of the image.
The pixel type.
The data type.
True if it succeeds, false if it fails.
Creates this image by moving the data of the given image into this image.
[in,out] The image to move. Is invalid after this call.
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.
The image format.
The image data pointer.
(Optional) The timestamp of the image capture.
(Optional) The image ID.
Creates a copy of the given image. Only (re)allocates memory if required.
The image to copy.
Creates an image of the given format. Only (re)allocates memory if required. Copies the image data into this image.
The image format.
Pointer to the image data.
Creates an image of the given format. Only (re)allocates memory if required.
The image format.
Sets the image data to contain only zeros.
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.
The image data to copy.
True if it succeeds, false if it fails.
Move assignment operator.
[in] The image to move. This is invalid after the call.
A shallow copy of this object.
Assignment operator. Copies the contents of the given image.
The image.
A shallow copy of this object.
Destructor. All used memory is freed.
Constructor. Creates a valid image within the given format and allocates memory accordingly.
The image format.
Move constructor.
[in] The image to move. This is invalid after the call.
Copy constructor. Creates a copy of the given image
The image to copy.
Default constructor. Creates an invalid image without using any memory.
\addtogroup RxCore_Image
*
@{
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().
Returns true if the data type of this image format is one of the custom (non primitive) data types.
True if the data type is custom, false if not.
Gets the total number of bytes allocated by images that are of this image format.
The number of byte.
Gets the pixel count.
The pixel count.
Gets the bytes per pixel.
The bytes per pixel.
Gets the bit depth. This is the number of bits per channel.
The bit depth.
Gets the bytes per channel.
The bytes per channel.
Gets the component count.
The component count.
Query if this CRxImageFormat is bayer pixel type.
True if bayer pixel type, false if not.
Inequality operator.
Describes the format to use.
True if the parameters are not considered equivalent.
Equality operator.
Describes the format to use.
True if the parameters are considered equivalent.
Converts the given data type to a string.
The data type.
The data type as a string.
Converts the given pixel type to a string.
The pixel type.
The pixel type as a string.
Convert this CRxImageFormat into a string representation.
This CRxImageFormat as a std::string.
Resets this CRxImageFormat.
Destructor.
Constructor that creates an image format that is equal to the image format of the given image interface.
The image interface pointer.
Default constructor.
Constructor. Defines only the width and the height.
The width in pixels.
The height in pixels.
Default constructor.
\addtogroup RxCore_Image
*
@{
Image format descriptor.
Gets the data pointer.
Null if it fails, else the data pointer.
Gets the data pointer.
Null if it fails, else the data pointer.
Gets the type of this image.
[out] Type of the pixel.
[out] Type of the data.
Gets the size of this image.
[out] The width.
[out] The height.
Gets the byte count.
The byte count.
Gets the pixel count.
The pixel count.
Gets the bytes per pixel.
The bytes per pixel.
Test whether this image exists.
True if valid, false if not.
Destroy image.
True if it succeeds, false if it fails.
Create image from given image.
The image.
True if it succeeds, false if it fails.
Create an image of given type and size and copy the data from the given pointer.
Zero-based index of the width.
Zero-based index of the height.
Type of the pixel.
Type of the data.
The data.
True if it succeeds, false if it fails.
Create an image of given type and size and reserve the appropriate amount of memory. We can use as input types enums as
they stay compatible between module versions even if the enum declarations have different numbers of entries.
Zero-based index of the width.
Zero-based index of the height.
Type of the pixel.
Type of the data.
True if it succeeds, false if it fails.
\addtogroup RxCore_Image
*
@{
Interface supported by Raytrix images.
The image pixel types..
Planar YUV with 4:2:0 chroma subsampling
1 Channel per pixel (Bayer pattern GBRG)
1 Channel per pixel (Bayer pattern GRBG)
1 Channel per pixel (Bayer pattern BGGR)
1 Channel per pixel (Bayer pattern RGGB)
2 Channels per pixel (Luminance, Alpha)
1 Channel per pixel (Luminance)
4 Channels per pixel (Blue, Green, Red, Alpha)
3 Channels per pixel (Blue, Green, Red)
4 Channels per pixel (Red, Green, Blue, Alpha)
3 Channels per pixel (Red, Green, Blue)
The image data types.
Double.
Double precision floating point data type. Is 'double' in C++ and .NET.
Float.
32 bit unsigned.
Unsigned integer data type. Is 'unsigned' in C++ and .NET.
32 bit signed.
16 bit unsigned.
16 bit signed.
8 bit unsigned.
8 bit signed.
Each pixel has a size of 12 bit. It should be converted into 16 bit.
Each pixel has a size of 10 bit. It should be converted into 16 bit.
The upper 12 bits of a 16 bit unsigned short are used. The lower 4 bits are unused (zero).
The lower 12 bits of a 16 bit unsigned short are used. The upper 4 bits are unused (zero).
The upper 10 bits of a 16 bit unsigned short are used. The lower 6 bits are unused (zero).
The lower 10 bits of a 16 bit unsigned short are used. The upper 6 bits are unused (zero).
The main parameter enum of the Raytrix ApiLF.
Exports all exportable parameter to the given string by calling GetValue for each parameter.
[out] The XML string.
Exports all exportable parameter to file.
[in] The complete file path.
Import from meta data. If a class supports this functionality this class must implement this function. If a class does
not implement this function nothing happens.
[in,out] the meta data.
Imports the parameter stored in the given XML string and applies each by calling SetValue.
[in] The XML string.
Imports the parameter stored in the given file and applies each by calling SetValue.
[in] The complete file path.
Gets the name of the given group ID.
The group ID.
Empty string if the name is missing, else the group name.
Gets the value of the given parameter.
The parameter ID.
[out] The value.
Gets the value of the given parameter.
The parameter ID.
[out] The value.
Gets the value of the given parameter.
The parameter ID.
[out] The value.
Gets the value of the given parameter.
The parameter ID.
[out] The value.
Gets the value of the given parameter.
The parameter ID.
[out] The value.
Gets the value of the given parameter.
The parameter ID.
[out] The value.
Sets the value of the given parameter.
The parameter ID.
[in] The value.
Sets the value of the given parameter.
The parameter ID.
[in] The value.
Sets the value of the given parameter.
The parameter ID.
[in] The value.
Sets the value of the given parameter.
The parameter ID.
[in] The value.
Sets the value of the given parameter.
The parameter ID.
The value.
Sets the value of the given parameter.
The parameter ID.
The value.
Sets all parameters to their initial or their default value.
True to reset to initial, false to reset to default. False is default.
Sets the parameter described by the given parameter ID to its initial or its default value.
The parameter ID.
True to reset to initial, false to reset to default. False is default.
Gets some parts of the parameter definition.
The parameter ID.
[out] The parameter name.
[out] The GUID of the parameter.
[out] True if the parameter is readable.
[out] True if the parameter is writable.
[out] The data type of the parameter.
Gets some parts of the parameter definition.
The parameter ID.
[out] The parameter name.
[out] The GUID of the parameter.
Gets the valid range of the value that can be set to the given array parameter.
The parameter ID.
[out] The minimum array length.
[out] The maximum array length.
[out] The minimum value of each array element.
[out] The maximum value of each array element.
Gets the valid range of the value that can be set to the given array parameter.
The parameter ID.
[out] The minimum array length.
[out] The maximum array length.
[out] The minimum value of each array element.
[out] The maximum value of each array element.
Gets the valid range of the value that can be set to the given non-array parameter.
The parameter ID.
[out] The minimum value.
[out] The maximum value.
Gets the valid range of the value that can be set to the given non-array parameter.
The parameter ID.
[out] The minimum value.
[out] The maximum value.
Queries if the given value is a valid value for the given parameter ID. This tests the data type and possible
constraints.
The parameter ID.
[in] The value.
True if the value is valid, false if not.
Queries if the given value is a valid value for the given parameter ID. This tests the data type and possible
constraints.
The parameter ID.
[in] The value.
True if the value is valid, false if not.
Queries if the given value is a valid value for the given parameter ID. This tests the data type and possible
constraints.
The parameter ID.
[in] The value.
True if the value is valid, false if not.
Queries if the given value is a valid value for the given parameter ID. This tests the data type and possible
constraints.
The parameter ID.
[in] The value.
True if the value is valid, false if not.
Queries if the given value is a valid value for the given parameter ID. This tests the data type and possible
constraints.
The parameter ID.
The value.
True if the value is valid, false if not.
Queries if the given value is a valid value for the given parameter ID. This tests the data type and possible
constraints.
The parameter ID.
The value.
True if the value is valid, false if not.
Interface for accessing (setting and getting) parameter values of a certain class.
Possible spaces used in the projection system.
Values projected into the object space but depths are given relative to the reference plane
This view is a orthographic projection of the object space. X and Y are given in pixels. Z is given in millimeters.
The pinhole object view is the object space from the perspective of a pinhole camera. X and Y are given in pixels. Z is given in millimeters in the sensor frame of the pinhole camera.
The virtual view is a orthographic projection of the virtual space. X and Y are given in pixels. Z is given in millimeters.
The object space is the space captured by the light field camera and is given in the global frame of the projection system.
The virtual space is a space inside the light field camera and is given in the light field camera's sensor frame.
Enumeratives indicating stage of progress report. I.e. 2D image processing, 3D estimation etc.
Ray sequence file modes. These enums can be used as a bit mask to combine various modes.
A ray sequence opened for writing
A ray sequence opened for reading
Empty ray sequence mode
Values that represent EStatusMsg.
Progress step delay stopped.
Progress step delayed. Delay time in seconds given by iValue.
Process is finished.
Increment the progress by the number passed in iValue.
The new value of the progress is passed in the iValue parameter.
The number of steps in the process is passed in the iValue parameter.
A message containing warnings.
A message containing fatal information.
A message containing exception information.
A message containing assertions.
A message containing error information.
A message containing brief information.
A message containing information.
Debug message.
Undefined.
Values that represent EStatusMsgGrp.
Defines the Message group Progress --> Can be used to set a progress bar correctly.
Defines the Message group Text.
Undefined.
Values that represent EStatusMsgSrc.
.
An enum constant representing the MLA calibrator option.
A stage of the master calibration has been entered.
The root mean square error of an grid calibration iteration has been calculated.
An iteration step of a grid calibration stage has been started.
A stage of the grid calibration has been entered.
Message originates from the metric calibration.
Message originates from the metric calibration.
Message originates from the metric calibration.
Message originates from the metric calibration.
Message originates from an application.
Message originates from an algorithm.
Message originates from camera.
Message originates from camera.
API Gray image capturing message.
Message originates from the API.
Undefined.
Values that represent EMetricCalibPointType.
The first entry is the virtual depth, the second is the mm depth in space 4 in the global coordinate system and the last value in the vector is the euclidean distance of the test model point to the ground truth model point after calibration.
2D Point placed in the sensor coordinate system and z in virtual depth.
Model point in object space.
Point projected on the plane.
Point placed in the object coordinate system in mm.
2D Point placed in the global coordinate system in mm.
2D Point placed in the sensor coordinate system in mm.
3D Point placed in the sensor coordinate system in mm.
Index of points.
Values that represent EMetricCalibPointFilter.
These enums are to be used as a filter when getting points from the metric calibration.
All points from the test model that lie on the y-axis.
All points from the test model that lie on the x-axis.
All points from the test model but those that lie on the axes.
All points from the test model.
All points from the planar model with an accomplished depth calculation.
All points from the planar model.
Values that represent EMetricCalibResult.
The calibration has been set to its initial values.
The calibration aborted because an error occurred.
The calibration aborted because an user interrupt.
The calibration aborted because the data was insufficient.
The calibration aborted after too many iteration. This threshold can be set via: EMetricCalib::CalibrationIterationCount.
The calibration diverged.
The calibration has successfully converged.
None.
Values that represent EMetricCalibType.
The calibration based on a calibration setup that demands straight dot target images that are moved along the z-axis with known steps.
The calibration based on a calibration setup that demands tilted dot target images that reach over a large part of the depth range.
None.
Values that represent EImgStack.
Increases the exposure rate by adding all images and clamp them on maximum intensity values.
Noise reduction by averaging the input images.
No stacking.
Values that represent EImage.
Depth map mapping image. This is created by RxDepth3D(). See the documentation of this function.
Depth color result image for view camera.
Depth color result image for virtual space.
Depth result image.
Depth image in virtual space.
Multiview image. This is the output of the multi view algorithm and always from the perspective of the pinhole object view.
Total Focus result image.
Total Focus image of virtual space.
Basic refocus image. This is the output of the basic refocus algorithm and always from the perspective of the orthographic virtual view.
Processed ray image.
Processed ray image. Raw image after applying all pre process algorithms such as debayer etc.
Raw image containing the MLI/MLA calibration as a drawn overlay.
Raw depth image without fusion.
Gray image generated by MLI calibration.
Raw image captured by camera.
No image.
Values that represent particle tracking interfaces.
Values that represent high resolution particle detector interfaces.
Values that represent super resolution interfaces.
Values that represent ray depth processing interfaces.
Values that represent Depth Correction Creator interfaces.
Values that represent MLA calibration interfaces.
Values that represent ApiLF interfaces.
Values that represent light field runtime interfaces.
Values that represent metric calibration interfaces.
Values that represent image stacking interfaces.
Values that represent grid calibration interfaces.
Values that represent Export interfaces.
Values that represent capture gray image interfaces.
Values that represent param cache interfaces.
Values that represent images processing unit interfaces.
Values that represent Cuda compute interfaces.
Access to CUDA textures: The interface is ICudaDataTextures.
Access to CUDA images: The interface is ICudaDataImages.
Values that represent OpenGlInterop interfaces.
Values that represent Cuda device interfaces.
Values that represent Cuda interfaces.
Values that represent calibration manager interfaces.
Values that represent calibration interfaces.
Values that represent camera server interfaces.
Values that represent camera interfaces.
Access to IP camera functions: The interface is IIPCamera.
Values that represent sequence file writer interfaces.
Values that represent sequence file reader interfaces.
Values that represent ray file writer interfaces.
Values that represent ray file reader interfaces.
Values that represent parameter interfaces.
Values that represent image queue interfaces.
Values that represent particle tracking parameter.
The maximum epipolar line distance constraint for 2D particle grouping.
1U : Time matching only for succeeding image pairs (1 to 2 ; 3 to 4 ...).
The time delta for velocity estimation (in PIV mode the double-shoot delay).
Set 1U to use radius and scale of particles for time matching instead of nearest neighbor.
0-based stop index for BG image computation.
0-based start index for BG image computation.
1U to use background image subtraction. An BG image has to be available.
1U to use processed image instead of raw image for particle detection.
The maximum particles per lens constraint for 2D particle detection. Lenses with more 2D particles are not used in 3D estimation.
The maximum particle radius constraint for 2D particle detection. [0.1 ... 20]
The minimum particle radius constraint for 2D particle detection. [0.1 ... 20]
The particle density setting used in 2D particle detection. Trade off between uniqueness of particles and runtime.
0U : only few particles in whole image. Exhaustive computational effort for moderate or higher particle count
1U : only single particles in each lens. Exhaustive computational effort for high particle count
2U : multiple particles per lens over large parts of the image. Least effort, possible multi detection of particles
1U to use lens type near, 0U to omit.
1U to use lens type middle, 0U to omit.
1U to use lens type far, 0U to omit.
Maximum y-component in image region to process (Region of Interest). 0U to use full image height.
Maximum x-component in image region to process (Region of Interest). 0U to use full image width.
Minimum y-component in image region to process (Region of Interest).
Minimum x-component in image region to process (Region of Interest).
0-based frame index in sequence to stop processing.
0-based frame index in sequence to start processing.
Base filename for temporary particle data swap.
Number of processes used for 2D particle detection and time tracking.
Values that represent parameter groups.
The high resolution particle detector parameter group
The Super resolution parameter group.
The particle tracking parameter group.
The Mla calibration parameter group.
The light field camera.
Gray image capturing properties.
Metric calibration parameter group.
MLA parameter group.
Projection parameter group.
Grid calibration parameter group.
Grid display parameter group.
Focus evaluation parameter group.
Depth Path algorithm.
Depth evaluation parameter group.
PreProcessing parameter group.
Ray sequence parameters.
Ray image parameter group.
Camera capture parameter group.
Camera parameter group.
CUDA parameter group.
Values that represent high resolution particle detector parameters.
Super Resolution: Min lens border distance. (unsigned,[0,-]:3,RW)
Super Resolution: The upper bound for source patches of lens type 3, that are used for super resolution regarding virtual depth. (double,[0.0,100.0]:100.0,RW)
Super Resolution: The lower bound for source patches of lens type 3, that are used for super resolution regarding virtual depth. (double,[0.0,100.0]:3.8,RW)
Super Resolution: The upper bound for source patches of lens type 2, that are used for super resolution regarding virtual depth. (double,[0.0,100.0]:4.0,RW)
Super Resolution: The lower bound for source patches of lens type 2, that are used for super resolution regarding virtual depth. (double,[0.0,100.0]:2.0,RW)
Super Resolution: The upper bound for source patches of lens type 1, that are used for super resolution regarding virtual depth. (double,[0.0,100.0]:3.0,RW)
Super Resolution: The lower bound for source patches of lens type 1, that are used for super resolution regarding virtual depth. (double,[0.0,100.0]:1.0,RW)
The number of iterations of the super resolution algorithm. (unsigned,[1,200]:1, RW).
Super Resolution: The radius of the source patch.(unsigned,[2,-]:6, RW)
Super Resolution: The upscaling factor. (unsigned,[2,20]:2, RW).
Depth correlation patch size (unsigned,[2,5]:5,RW).
Depth: Minimal standard deviation of correlation patch (double,[0.0,1.0]:0.01,RW).
Depth: Minimal correlation threshold (double,[0.0,1.0]:0.90,RW).
Feature detector: Size of the patch image.(unsigned,[1,-]:10,RW)
Feature detector:
Half window size to cluster maxima. Maxima within window around active pixel are considered to be the same maximum.
(unsigned,[1,-]:2,RW)
Feature detector: Half window size to determine maximum ratio.(unsigned,[1,-]:2,RW)
Feature detector: Ratio of pixels that have to be smaller pixel value to accept position as maximum. Evaluation area is given by uiHalfWinsizeMinMaxRatio (double,[0,-]:0.8,RW).
Values that represent super resolution parameters.
An enum constant representing the optical flow algorithm option. (enum,[Rx::EOpticalFlowType]:Rx::EOpticalFlowType::Farneback,RW).
Radius of the temporal search area. Where 0 sets the algorithm to automatic mode. (unsigned,[0,-]:0, RW).
The number of iterations of the super resolution algorithm. (unsigned,[1,200]:20, RW).
The super resolution scale. (unsigned,[2,20]:3, RW).
The main parameter enum of the Raytrix ApiLF.
Number of images to stack (unsigned,[1,1000]:4, RW).
Image stacking enabled (unsigned,[0,1]:0, RW).
Automatically store frames captured from a camera into the bound ray sequence in write mode (unsigned,[0,1]:0,RW).
Number of cameras available (unsigned,-:-,RO).
Values that represent MLA calibration parameters.
Full base pathname of the debug output files. (string,[-,-]:-,RW)
true to write debug data to DebugOutputPath (unsigned, [0,1]:0, RW).
true to use the median for the offset calculation (Within the algorithm and the final end outcome), false to use mean (unsigned, [0,1]:1, RW).
true to use linear interpolation for reference depth (unsigned, [0,1]:1, RW).
The MLA scale factor. (double,[0.0,1.0]:1.0,RW)
The pixel step in which the ROI should be sampled.(unsigned, [1,-]:1, RW).
The inner part in percentage that should be used to calibrate the MLA. (unsigned, [0,100]:95, RW).
If the error reached its stop criterion the calibration is aborted. (double,[0.0,1.0]:1e-6,RW).
Number of calibration iterations (unsigned,[1,-]:5,RW).
A lens filter mask to disable (1) or enable (0) certain lens types during depth estimation (unsigned[12],[0,1]:0,RW).
True to use a polynomial fit to find the best correlation between two match points.(unsigned, [0,1]:1, RW).
Maximum virtual depth for depth estimation (double,[2.0,100.0]:15.0,RW).
Minimum virtual depth for depth estimation (double,[2.0,100.0]:2.0,RW).
The minimum variance. (double,[0.0,1.0]:0.0,RW).
Minimal correlation threshold (double,[0.0,1.0]:0.88,RW).
Number of paths per depth path job. Values: (unsigned,[1,2]:1,RW).
Correlation patch stride (unsigned,[1,5]:2,RW).
Correlation patch radius (unsigned,[2,5]:3,RW).
Values that represent Cuda device parameters.
PCI bus ID of the device (unsigned,-:-,RO).
Specified whether there is a run time limit on kernels (unsigned,-:-,RO).
The clock frequency of the CUDA device in kilohertz (double,-:-,RO).
CUDA device is a Tesla device using a TCC driver (unsigned,-:-,RO).
CUDA device can execute kernels concurrently (unsigned,-:-,RO).
CUDA device maximum 2D array texture size y-dimension (unsigned,-:-,RO).
CUDA device maximum 2D array texture size x-dimension (unsigned,-:-,RO).
CUDA device maximum 2D texture size y-dimension (unsigned,-:-,RO).
CUDA device maximum 2D texture size x-dimension (unsigned,-:-,RO).
CUDA device compute mode (unsigned,-:-,RO).
CUDA device number of processors (unsigned,-:-,RO).
CUDA device concurrent memory copy and kernel execution (unsigned,-:-,RO).
CUDA device maximal number of threads per block (unsigned,-:-,RO).
CUDA device memory pitch in MB (double,-:-,RO).
CUDA device warp size (unsigned,-:-,RO).
CUDA device registers per block (unsigned,-:-,RO).
CUDA device total constant memory in MB (double,-:-,RO).
CUDA device total global memory in MB (double,-:-,RO).
The compute capability minor version (unsigned,-:-,RO).
The compute capability major version (unsigned,-:-,RO).
The device ID of the selected CUDA device (unsigned,-:-,RO).
The name of the CUDA device (string,-:-,RO).
Values that represent capture gray image parameters.
The delay in seconds between each image of the gray image capturing routine (unsigned,[0,-]:0,RW).
The number of image the actual gray image is averaged from. (unsigned, [1,-]:5,RW).
Values that represent metric calibration parameter.
The export path for the additional output. (string,[-,-]:-,RW).
The known Z-Distance of the Dot-Target starting with 0 and following from that with relative steps (double,[0.000000,-]:0.000000,RW).
The result of the last metric calibration (enum,EMetricCalibResult:None,RO).
Initial total focus distance (unsigned,-:500.0,RW).
Initial focal length (double,-:100.0,RW).
Distance of points in the model (double,[0.0,-]:2.0,RW).
Register the metric calibration callback function (unsigned,[0,1]:0,RO).
Common part threshold (double,[0.0,1.0]:0.5,RW).
Max value for depth histogram (double,[TestModelFilter_Hist3dVirtDepthMin,-]:11,RW).
Min value for depth histogram (double,[0,-]:2.0,RW).
Depth histogram bin count -> same for vertical (unsigned,[0,-]:20,RW).
Horizontal histogram bin count -> same for vertical (unsigned,[0,-]:15,RW).
Depth threshold for test model filter (double,[0.0,1.0]:0.25,RW).
Maximal number of point outliers that can be filtered. Test models with more outliers points are not filtered. (double,[0.0,1.0]:0.1,RW).
Smooth radius for test model filter (unsigned,[0,1]:3,RW).
Number of calibration iterations (unsigned,[0,1]:50,RW).
Flag for data output. This comprises information of the added images and their resultant models (planar and test). The calibration log, depth (intermediate) images and image sequence. (unsigned,[0,1]:0,RW).
Flag for axial distortion (unsigned,[0,1]:1,RW).
Flag for depth distortion (unsigned,[0,1]:1,RW).
Flag for radial distortion (unsigned,[0,1]:1,RW).
Flag for radial distortion const (unsigned,[0,1]:0,RW).
Flag for distortion center (unsigned,[0,1]:1,RW).
Flag for calibration of MLA to sensor distance (unsigned,[0,1]:1,RW).
Flag for calibration of principal point (unsigned,[0,1]:1,RW).
Flag for calibration of optical axis (unsigned,[0,1]:1,RW).
flag for calibration of the focal length (unsigned,[0,1]:1,RW).
Store the refocused image (unsigned,[0,1]:0,RW).
Values that represent calibration parameters.
Minimal mm in object space that allow a full refocus without gaps. The parameter MLA_FocusRangeMinVD describes the absolute minimal virtual depth but is affected by the current calibration. The affected value is returned by this parameter. (double,[-,-]:-,RO).
Minimal virtual depth that allow a full refocus without gaps. The parameter MLA_FocusRangeMinVD describes the absolute minimal virtual depth but is affected by the current calibration. The affected value is returned by this parameter (double,[-,-]:0.0,RO).
Is true if this MLI has been calibrated automatically. The manual MLI parameters aren't used (unsigned,[0,1]:0,RO).
Is true if this MLI has been calibrated manually or automatically (unsigned,[0,1]:0,RO).
The MLA lens border in pixels. The effectively usable micro lens diameter is the micro lens diameter minus twice this border (double,[0.0,-]:-,RW).
The MLA lens gap in pixels. The micro lens diameter is the micro lens pitch minus this gap (double,[0.0,-]:0.0,RW).
The MLI border in lens units. This Values defines the region of interest in various algorithms (double,[0.0,1000.0]:1.0,RW).
The MLI rotation in radians from sensor frame to MLA frame (double,[0.0,-]:0.0,RW).
The MLI center in pixels on sensor frame (double[2],[0.0,-]:-,RW).
The MLI center in pixels on PXA (double[2],[0.0,-]:0.0,RW).
The MLI micro lens pitch in Pixel. This is the distance between neighboring micro lens centers (double,[0.0,-]:0.0,RW).
The orthogonal distance between the micro-lenses of type 1 to the sensor. This may be different for each micro lens type. The values are given in millimeters (MM). This parameter describes the Length of 1VD in MM.(double,[> 0,-]:-,RW)
Is true if this MLA has been calibrated automatically. (unsigned,[0,1]:0,RO).
The orthogonal distance between a micro-lens's optical center and the sensor. This may be different for each micro lens type. The values are given in millimeters. (double[12],[0.0,-]:-,RO).
The normalized offsets of lens type 0 and 2 to lens type 1. To calculate the Mla to sensor distances in MM for 0, 1 or 2:
double dMlaToSensorDistance0MM = (1 + vdLensTypeOffsetsToLensType1VD.x) * dSensorDistanceToLensType1MM;
double dMlaToSensorDistance1MM = dSensorDistanceToLensType1MM;
double dMlaToSensorDistance2MM = (1 + vdLensTypeOffsetsToLensType1VD.y) * dSensorDistanceToLensType1MM;
(double[2],[0,-]:-,RW)
The nominal orthogonal distance between the micro-lenses of type 1 to the sensor. This may be different for each micro lens type. The values are given in millimeters (MM). This parameter describes the Length of 1VD in MM. (double,[> 0,-]:-,RW)
Is true if the camera's MLA to sensor distance has been configured and must not be changed. Must be set after configuration of the true nominal MLA to sensor distances of the physical MLA. Setting this property copies the nominal MLA to sensor distance to calibrated MLA to sensor distance. (unsigned,[0,1]:0,RW).
The nominal orthogonal distance between a micro-lens's optical center and the sensor. This may be different for each micro lens type. The values are given in millimeters (double[12],[0.0,-]:-,RO).
Maximal virtual depth values until where the corresponding micro lens type gives in-focus images (double[12],[0.0,-]:(3.0,4.0,100.0),RW).
Minimal virtual depth values from where on the corresponding micro lens type gives in-focus images.(double[12],[0.0,-]:(1.0,2.8,3.8),RW).
Number of micro lens types on the MLA (unsigned,[0,12]:-,RW).
If true the MLA frame Y-axis is inverted with the respect to the standard orientation (unsigned,[0,1]:0,RW).
If true the MLA frame X-axis is inverted with the respect to the standard orientation (unsigned,[0,1]:0,RW).
Number of 90 degree CCW rotation steps of the MLA, with respect to the standard orientation. (unsigned,[0,3]:0,RW).
The nominal MLA center in pixels on screen frame (double[2],[-,-]:-,RW).
The nominal MLA center in pixels on PXA (double[2],[-,-]:(0.0,0.0),RW).
The nominal MLA lens pitch in pixels. This is the distance between neighboring micro lens centers. The nominal lens pitch serves as an initial start for further more precise calibrations. This sets the automatically computed homography (double,[0.0,-]:23.0,RW).
This parameter allows the adjusting of the reference plane position, by translating the reference plane along its z axis relative to the TCP origin. (double,[-,-]:-,RW).
This parameter allows the setting of the reference to global transformation with 3 points picked in the reference plane to be. (double[9],[-,-]:-,WO).
This describes the transformation from the global frame to the reference frame: The first three entries are the translation and the following nine entries are the rotation (row wise) (double[12],[-1.0,1.0]:(0.0,0.0,0.0,1.0,0.0,0.0,0.0,1.0,0.0,0.0,0.0,1.0),RW).
This describes the transformation from the global frame to the sensor frame: The first three entries are the translation and the following nine entries are the rotation (row wise) (double[12],[-1.0,1.0]:(0.0,0.0,0.0,1.0,0.0,0.0,0.0,1.0,0.0,0.0,0.0,1.0),RW).
The extended frustum of the virtual camera given in 6 coordinates: 1 = bottom/left/near, 2 = top/right/near, 3 = bottom/left/far, 4 = top/right/far, 5 = bottom/left/furthest, 6 = top/right/furthest (double[18],-:-,RO).
The rotation of the virtual camera about its z-axis in degrees in a CCW sense (double,[0.0,360.0]:0.0,RO).
The virtual sensor size factor. This determines the size of the virtual camera's sensor with respect to the plenoptic camera's physical sensor size.
The virtual camera's sensor size is equal to this factor times the plenoptic camera's sensor size (double,[0.1,1000]:1.0,RW).
Set the Sensor Scaling mode for the virtual Camera. Has to be one of the values defined in EVirtCamSensorScaling (enum,[Rx::CamFormat::EVirtCamSensorScaling]:VirtCam_Sensor_Scale_InnerRect,RW).
Disables (0) / Enables (1) the Landscape Mode for the virtual Camera (unsigned,[0,1]:1,RW).
The zoom factor. A zoom factor of zero sets the viewing frustum to that of the main lens (double,[-2.0,2,0]:0.0,RW).
Offset of image center of virtual camera in plane perpendicular to z-axis of main lens from center of main lens in millimeters (double[2],-:(0.0,0.0),RW).
The sensors pixel size in mm. (double,[0.0,1.0]:0.09,RW).
The sensor offset in millimeters. This is the vector from the center of the total sensor which is the origin of ordinates to the center of the actual sensor size in the sensor frame (double[2],[0,-]:(0.0,0.0),RW).
The sensor size in millimeters that corresponds to the size of image that is stored with this format (double[2], [0,-]:[image width,image height],RW).
The size of the camera sensor. This is always the complete sensor size, even if the image only shows part of the whole original sensor image (double[2],[0,-]:[image width,image height] RW).
The nominal magnification described by the used main lens (double,[0,1e9]: 0.38196601125010515179541316563436, RW).
The nominal total focus distance in millimeters. This is the distance from the sensor plane to the focus plane (double,[-,-]:500.0,RW).
The nominal main lens's focal length in millimeters (double,[0.1,1e5]:100.0,RW).
The magnification described by the used main lens (double,[0,1e9]: 0.38196601125010515179541316563436, RW).
The total focus distance in millimeters. This is the distance from the sensor plane to the focus plane (double,[-,-]:500.0,RW).
The main lens's focal length in millimeters (double,[0.1,1e5]:100.0,RW).
An enum constant representing the light field collimation plane in MM in the reference frame (double,[-,-]:[4 projected into the object space in the reference frame],RW).
An enum constant representing the light field collimation plane in VD (double,[-,-]:4,RW).
Is true if the camera has been metric calibrated (unsigned,[0,1]:0,RO).
Is true if the camera has been master calibrated. Must be set after master calibration (unsigned,[0,1]:0,RW).
Type of the viewing frustum in space 2 (enum,[Rx::CamFormat::EViewingFrustumSpace2Type]:ViewFrustSpc2Type_Orthographic,RW).
Values that represent CUDA compute parameters.
Specifies the color map used to color the depth map (enum,[EColorMap]:EColorMap::Perceptually_Uniform_Rainbow,RW).
The maximum color value given in millimeters in reference frame (double,[-,-]:10,RW).
The minimum color value given in millimeters in reference frame (double,[-,-]:0,RW).
The color mode (enum,[EColorMode]:EColorMode::Manual,RW).
If set to 1U, the grid is drawn with MLA calibration instead of MLI calibration (unsigned,[0,1]:0,RW).
If set to 1U, the grid is drawn on the gray image (unsigned,[0,1]:0,RW).
Multiview eye separation (double,[1.0,20.0]:10.0,RW).
Multiview type (enum,[Rx::EMultiView]:Rx::EMultiView::RedCyan,RW).
This scale is used to blend the colored depth image with the focus image (double,[0.0,1.0]:0.0,RW).
Focus value for refocusing onto a plane (double,[0.0,1.0]:0.1,RW).
Result image size division factor (double,[0.0,-]:2.0,RW).
Shrinks the depth map 'contour' by removing all valid depths that are in this range (given in pixels) of an invalid depth value. A value of 0 means no shrink (unsigned,[0,100]:0,RW).
When the color difference of two compared pixels exceeds this threshold, the pixel is skipped. The difference is referred to normalized values where 1 would be a difference of 255 luminance values.
The algorithm used for depth filling. (0) is the default depth filling algorithm. (1) is the slower depth fill algorithm that considers more image information. (unsigned,[0,1]:0,RW).
Flag to indicate whether the first 3 iterations of the filling algorithm should perform an implicit filtering (unsigned,[0,1]:1,RW).
Bilateral filter range distance threshold (double,[1.0,20.0]:5.0,RW).
Bilateral filter edge threshold (double,[0.01,0.2]:0.05,RW).
Bilateral filter radius (unsigned,[1,20]:5,RW).
Flag whether bilateral filtering of depth map is enabled (unsigned,[0,1]:1,RW).
Flag to indicate whether the remaining unknown depth areas are to be filled after the iterations (unsigned,[0,1],0,RW).
Size of unknown depth border filled per iteration in pixels (unsigned,[1,100]:4,RW).
Number of iterations used for filling the depth map (unsigned,[0,20]:2,RW).
Flag whether filling of depth map is enabled (unsigned,[0,1]:1,RW).
Depth correction A (double,[,]:0,RW).
The algorithm used for depth estimation. (0) is the default depth path algorithm. (1) is the slower ray cast algorithm (unsigned,[0,1]:0,RW).
Enable (1) or disable (0) a depth consistency check while creating the depth map. This check should always be enabled (unsigned,[0,1]:1,RW).
A lens filter mask to disable (1) or enable (0) certain lens types during depth estimation (unsigned[12],[0,1]:0,RW).
Correlation patch stride (unsigned,[1,5]:2,RW).
Correlation patch radius (unsigned,[2,5]:3,RW).
Minimal correlation threshold (double,[0.0,1.0]:0.90,RW).
Minimal standard deviation of correlation patch (double,[0.0,1.0]:0.01,RW).
Flag whether to use a sparse set of micro lenses to calculate depth (unsigned,[0,1]:0,RW).
The resolution level for near objects. The higher the number the finer the depth resolution for near objects (unsigned,[2,5]:3,RW).
Maximum virtual depth for depth estimation (double,[2.0,100.0]:15.0,RW).
Minimum virtual depth for depth estimation (double,[2.0,100.0]:2.0,RW).
Result image size divisor for depth evaluation (double,[2.0,20.0]:4.0,RW).
The data type of all resultant images. Supported data types are UByte (unsigned char) and UShort (unsigned short). If set to Void, the data type is the same as the input raw image. (enum,[Rx::Interop::Runtime28::EDataType]:UShort,RW).
Blending factor (double,[0.0,0.3]:0.2,RW).
Noise level (double,[0.01,2.0]:0.1,RW).
Denoise filter diameter in pixels (unsigned,[2,8]:4,RW).
Enable Non-Local-Means denoising of raw image (unsigned,[0,1]:0,RW).
Blue balance (double,[0.0,1.0]:1.0,RW).
Green balance (double,[0.0,1.0]:1.0,RW).
Red balance (double,[0.0,1.0]:1.0,RW).
Enable demosaic balance parameters (unsigned,[0,1]:0,RW).
Use sharpness only for depth calculation (not for output image) (unsigned,[0,1]:1,RW).
Sharpness Algo1: Mixing factor of blurred image with original image as pixel * factor + blurred * (1 - factor) (double,[-2.0,3.0]:1.5,RW).
Sharpness Algo1: Standard deviation of Gauss blurred image (double, [0.0,10.0]:2.5,RW).
Enable sharpness algorithm 1: unsharp masking (unsigned,[0,1]:1,RW).
Set of points in range [0,1] describing the gradation curve. Attention: Only two points are allowed at the moment (double[],[0.0,1.0]:(0.0,0.0,1.0,1.0), RW).
Standard preprocessing: contrast scale (double,[0.0,2.0]:0.0,RW).
Standard preprocessing: contrast center (double,[0.0,1.0]:0.5,RW).
Standard preprocessing: brightness gain (double,[0.0,1e5]:1.0,RW).
Enable Standard Preprocessing of ray image (unsigned,[0,1]:0,RW).
Query if this exception or one of its inner exceptions contains an exception of the given GUID.
[in] The GUID of the exception to look for.
True if this exception or one of its inner exceptions contains an exception of the given GUID, false if not.
Gets the inner exception if one is available. Otherwise nullptr is returned.
The inner exception.
Gets the line.
The line number.
Gets the file name.
The file name.
Gets the function name.
The function name.
Gets the name of this exception.
The name of this exception.
Gets the unique identifier of this exception. This is not guaranteed to be the GUID of this exception type.
The unique identifier.
Gets message text.
Null if it fails, else the message text.
Gets the most inner exception.
The most inner exception. If there is no inner exception, this exception is returned.
Convert this exception into a string representation.
True to include all inner exceptions.
This exception as a string.
Convert this exception into a string representation.
This exception as a string.
Sets additional exception data.
Sets the given exception as the inner exception.
The exception.
Sets the GUID of this exception. This is not guaranteed to be the GUID of this exception type.
Unique identifier.
Virtual destructor.
Constructor.
The message string.
The file.
The function.
The line.
The inner exception.
Constructor.
The message string.
The file.
The function.
The line.
The inner exception.
Constructor.
The message string.
The file.
The function.
The line.
Raytrix exception base class. All exceptions are based on this class.
The exception pointer.
Query if this object is valid.
True if valid, false if not.
Gets the exception pointer.
Null if it fails, else the exception pointer.
Destructor. Deletes the assigned exception.
Move assignment operator.
[in,out] The exception safe pointer to move.
A moved version of the given pointer.
Copy Constructor. Creates a copy of the given exception.
The exception to copy.
Copy Constructor. Creates a copy of the given exception.
The exception to copy.
Move constructor.
[in,out] The exception safe pointer to move.
Copy constructor. Creates a copy of the exception provided by the given pointer.
The exception safe pointer to copy.
Default constructor.
Container for an Interop::Runtime31::IException pointer that simplifies copying of exceptions.
Defines an alias representing the exception interface of RxRuntime 3.1.
Makes a deep copy of this object.
Null if it fails, else a copy of this object.
Query if this exception or one of its inner exceptions contains an exception of the given GUID.
[in] The GUID of the exception to look for.
True if this exception or one of its inner exceptions contains an exception of the given GUID, false if not.
Gets the inner exception if one is available. Otherwise null is returned.
The inner exception.
Gets the unique identifier of this exception. This is not guaranteed to be the GUID of this exception type.
The unique identifier.
Gets the name of this exception.
The name of this exception.
Gets the line.
The line number.
Gets the file name.
The file name.
Gets the function name.
The function name.
Gets message text.
The message text.
Interface class of all exceptions used since RxRuntime 3.1.
Defines an alias representing the exception interface of RxRuntime 3.0.
The inner exception.
Sets an inner exception. Frees currently assigned inner exception.
[in] The inner exception.
Returns the inner exception and yields responsibility.
The inner exception.
Copies this exception. This has to be implemented in each exception type.
A copy of this exception.
Copy this exception to given target Destination.
[in,out] If non-null, target for the.
Gets the inner exception.
Null if there is no inner exception, else the inner exception.
Query if this exception or one of its inner exceptions has the given GUID.
[in] The GUID of the exception to look for.
True if this exception or one of its inner exceptions has the given GUID, false if not.
Gets the unique identifier of the type of this exception.
The type unique identifier.
Gets the name of this exception.
The name of this exception.
Gets the line.
The line number.
Gets the file name.
The file name.
Gets the function name.
The function name.
Gets the information string.
The information string.
Convert this CRxExceptionEx into a string representation.
This CRxExceptionEx as a string.
Destructor.
copy Constructor.
[in] The exception to copy.
Default constructor.
Interface for basic exception.
Defines an alias representing the GUID interface of RxRuntime 3.0.
Convert this CGuid into a string representation.
String buffer. Must be of size 40.
Inequality operator.
The reference GUID.
True if the parameters are not considered equivalent.
Equality operator.
The reference GUID.
True if the parameters are considered equivalent.
Assignment operator. Throws an std::exception if the string parsing failed.
"{XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX}" or "{XXXXXXXX - XXXX - XXXX - XXXX - XXXXXXXXXXXX}".
A new GUID.
Constructor.
"{XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX}" or "{XXXXXXXX - XXXX - XXXX - XXXX - XXXXXXXXXXXX}".
Default constructor.
Unique identifier.
The line in the source code file
The name of the function
The source code file name
Convert this CCodeLocation into a string representation.
This CCodeLocation as a CRxString.
Gets the line in the source code file.
The line in the source code file.
Gets the name of the function.
The name of the function.
Gets the source code file name.
The source code file name.
Constructor.
The source code file name.
The name of the function.
The line in the source code file.
Default constructor.
Holds information about a certain code location. These information are:
- The source code file name
- The name of the function
- The line in the source code file.
Converts the given string into an unsigned integer value.
[in] The string.
[iout] The unsinged integer.
The unsigned integer.
Converts the given string into an integer value.
[in] The string.
[out] The integer.
The integer.
Finalizes this object. Frees both pointer.
Initializes this object. Creates both pointer.
Assumes that this CRxString represents a file name and splits it in path, name and extension.
[out] The directory path.
[out] Name of file without extension.
[out] Extension of file.
Assigns a new value to the string, replacing its current contents.
Copies the first nNumChars characters from the array of characters pointed by pcData.
Pointer to an array of characters.
Number of characters to copy.
Replaces all occurrences of pcOld by pcNew and returns the resulting CRxString.
String which should be replaced.
This string is used as the replacement.
The replaced CRxString.
Determines whether the end of this string instance matches the specified string.
The string to compare to the substring at the end of this instance.
True if value matches the end of this instance; otherwise, false.
Query if this CRxString contains the given sxString.
The CRxString to test for containment.
True if this string contains the given sString, false if not.
Query if this CRxString contains the given pcString.
The string to test for containment.
true if this string contains the given pcString, false if not.
Searches this string for the content specified in either pcString or sxString, and returns the position of the first
occurrence in this string.
When nStartIdx is specified the search only includes characters on or after position nStartIdx, ignoring any possible
occurrences in previous locations.
String to be searched for in this string. The entire content of str must be matched in some part of
the string to be considered a match.
(optional) Position of the first character in the string to be taken into consideration for
possible matches. A value of 0 means that the entire string is considered.
The position of the first occurrence in the string of the searched content. If the content is not found, the member
value CRxString::npos is returned.
Searches the string for the first character that matches any of the characters specified in its arguments.
When nCount is specified, the search only includes characters at or after position nCount, ignoring any possible
occurrences before nCount.
String containing the characters to search for in this string.
(optional) Position of the first character in the string to be taken into consideration for
possible matches.
(optional) Length of sequence of characters to search for.
The position of the first occurrence in the string of any of the characters searched for. If the content is not found,
the member value CRxString::npos is returned.
Returns a newly constructed CRxString object with its value initialized to a copy of a substring of this object.
The substring is the portion of the object that starts at character position nStartIdx and spans nCount characters (or
until the end of the string, whichever comes first).
Position of the first character to be copied as a substring. If this is equal to the string length,
the function returns an empty string.
(Optional) Number of characters to include in the substring (if the string is shorter, as many
characters as possible are used). A value of -1 indicates all characters until the end of the
string.
A string object with a substring of this object.
Converts this hexadecimal string with 16 chars to a 8 byte double variable.
The double value.
Convert a 8 byte double variable into a hexadecimal string representation with 16 chars.
The double value.
The hexadecimal string.
Converts this CRxString to an unsigned int.
This CRxString as an unsigned int.
Converts this CRxString to an int.
This CRxString as an int.
Converts this CRxString to a c string.
This CRxString as a const char*.
Query if this object is valid.
True if valid, false if not.
Gets the pointer to memory.
The pointer to memory.
Gets the length of this CRxString. This is the number of characters.
The length of this CRxString.
Gets the size in bytes of an element of a string, which is always 1.
The element size.
Less-than comparison operator.
The string to compare with.
True if the first parameter is less than the second.
Gets the nIndex-th character from string.
The index.
The indexed character.
Appends the given double to this CRxString.
The double.
The concatenation of this CRxString with dValue.
Appends the given float to this CRxString.
The float.
The concatenation of this CRxString with fValue.
Appends the given size_t element to the string.
The value.
This string object.
Appends the given size_t element to the string.
The value.
This string object.
Appends the given unsigned integer to this CRxString.
The unsigned integer.
The concatenation of this CRxString with uValue.
Appends the given __int64 element to the string.
The value.
This string object.
Appends the given string to this CRxString.
The string.
The concatenation of this CRxString with sxString.
Appends the given string to this CRxString.
The string.
The concatenation of this CRxString with pcString.
Appends the given double to this CRxString.
The double.
The concatenation of this CRxString with dValue.
Appends the given float to this CRxString.
The float.
The concatenation of this CRxString with fValue.
Addition assignment operator.
The unsigned __int64 value.
The concatenation of this CRxString with nValue.
Appends the given unsigned integer to this CRxString.
The unsigned integer.
The concatenation of this CRxString with uValue.
Appends the given integer to this CRxString.
The integer.
The concatenation of this CRxString with iValue.
Appends the given integer to this CRxString.
The integer.
The concatenation of this CRxString with iValue.
Appends the given string to this CRxString.
The string.
The concatenation of this CRxString with sxString.
Appends the given string to this CRxString.
The string.
The concatenation of this CRxString with pcString.
Inequality operator.
The string.
True if the parameters are not considered equivalent.
Inequality operator.
The string.
True if the parameters are not considered equivalent.
Equality operator.
The string.
True if the parameters are considered equivalent.
Equality operator.
The string.
True if the parameters are considered equivalent.
Assignment operator.
Source memory.
A CRxString consisting of pSrcMem interpreted as character array.
Move assignment operator.
[in,out] The Raytrix string. Is invalid after this call.
A shallow copy of this object.
Assignment operator.
The Raytrix string.
A CRxString consisting of Raytrix string sxString.
Assignment operator.
The string.
A CRxString consisting of string pcString.
Assignment operator.
The character.
A CRxString consisting of character cChar.
Destructor.
Creates a CRxString consisting of pSrcMem interpreted as character array.
Source memory.
Move constructor.
[in,out] The Raytrix string. Is invalid after this call.
Copy constructor.
The Raytrix string.
Creates a CRxString consisting of string pcString.
The string.
Creates a CRxString consisting of character cChar.
The character.
Default constructor.
npos is a static member constant value with the greatest possible value for an element of type size_t.
This value, when used as the value for a length parameter in string's member functions, means "until the end
of the string".
As a return value, it is usually used to indicate no matches.
This constant is defined with a value of -1, which because size_t is an unsigned integral type, it is the largest
possible representable value for this type.
Basic character string operations.
Raytrix string format precision.
Destructor.
Gets the pointer to the memory block.
The pointer to memory.
Copies the memory block described by pMemory into this memory block. This memory block is automatically resized. The
function throws an exception if the element sizes of the given memory block does not agree with the element size of
this memory block.
[in] The memory to copy into this memory block.
Reset all values in the memory block. The actual value the elements in the memory block are reset to depends on the
implementation.
Deletes this memory block.
Resizes the memory block to the given number of elements. The size of an element is fixed by the implementation and can
be read out with the function GetElementSize().
The new number of elements stored in the memory block.
Creates a new memory block of \a nElementCount elements. The size of an element is fixed by the implementation and can
be read out with the function GetElementSize().
The new number of elements stored in the memory block.
Common memory interface.
Destructor.
Query if this object is valid. This function returns also true if the object itself is valid but the memory block has
size zero.
True if valid, false if not.
Gets the pointer to memory.
The pointer to memory.
Gets the number of elements in the memory block. The total number of bytes allocated by the memory block is given by
the length times the element size.
The size in bytes.
Gets the element size. The memory block is made up of blocks of the given number of bytes. The function Length()
returns the number of elements in the memory block, where each element is of the size given in GetElementSize(). For
example, an array of 10 doubles has element size 8 and length 10.
The element size in bytes.
Interface for memory read operations.