Class cuvis::Calibration

ClassList > cuvis > Calibration

#include <cuvis.hpp>

Public Functions

Type	Name
	Calibration (std::filesystem::path const & path) Create a calibration from factory path.
	Calibration (SessionFile const & session) Create a calibration from session file.
	Calibration (CUVIS_CALIB handle) Expert: Create a wrapper class around a handle. This only allowed once per handle, otherwise the handle could be freed before all instances of the wrapper class are deleted. This can be useful if a previously a handle has been copied and now should be wrapped at another place in a program. Most of the time this is not necesarry and the wrapper class can be copied just as well.
std::vector< capabilities_t >	get_capabilities (CUVIS_OPERATION_MODE mode) const get calibration capabilities
int_t	get_component_count () const get number of components
CUVIS_COMPONENT_INFO	get_component_info (int_t id) const get a components information
CUVIS_CALIB	get_handle () const Expert: Return the current handle of the wrapper class.
CUVIS_CALIB	get_handle_copy () const Expert: Create a copy of the current handle of the wrapper class and return it. This handle needs to be also freed before the resource will be released by the sdk.
std::string	get_id () const get the calibration id
CalibrationInfo	get_info () const get calibration infos

Detailed Description

central calibration Class

Public Functions Documentation

function Calibration [1/3]

Create a calibration from factory path.

cuvis::Calibration::Calibration (
    std::filesystem::path const & path
)

The calibration is created from a factory path, containing the license and calibration file "init.daq" as well as further calibration files (e.g. SpRad.cu3).

The calibration is lazy-loading, i.e. the AcquisitionContext and the ProcessingContext will only be initialized, when explicitly called.

Note:

do not load multiple calibration instances of the same camera

Parameters:

path The path to the factory directory

function Calibration [2/3]

Create a calibration from session file.

cuvis::Calibration::Calibration (
    SessionFile  const & session
)

Create a calibration from an existion session file.

The calibration is lazy-loading, i.e. the AcquisitionContext and the ProcessingContext will only be initialized, when explicitly called.

When you create a processing context from the calibration cerated with this function, you won't have the references from the session file set. Use cuvis_proc_cont_create_from_session_file to load a processing context where the referenecs are taken from the session file.

Note:

do not load multiple calibration instances of the same camera

Parameters:

session The session file

function Calibration [3/3]

Expert: Create a wrapper class around a handle. This only allowed once per handle, otherwise the handle could be freed before all instances of the wrapper class are deleted. This can be useful if a previously a handle has been copied and now should be wrapped at another place in a program. Most of the time this is not necesarry and the wrapper class can be copied just as well.

cuvis::Calibration::Calibration (
    CUVIS_CALIB handle
)

function get_capabilities

get calibration capabilities

std::vector< capabilities_t > cuvis::Calibration::get_capabilities (
    CUVIS_OPERATION_MODE mode
) const

Parameters:

mode Operation mode of the camera see also cuvis_operation_mode_t

function get_component_count

get number of components

int_t cuvis::Calibration::get_component_count () const

function get_component_info

get a components information

CUVIS_COMPONENT_INFO cuvis::Calibration::get_component_info (
    int_t id
) const

function get_handle

Expert: Return the current handle of the wrapper class.

CUVIS_CALIB cuvis::Calibration::get_handle () const

function get_handle_copy

Expert: Create a copy of the current handle of the wrapper class and return it. This handle needs to be also freed before the resource will be released by the sdk.

CUVIS_CALIB cuvis::Calibration::get_handle_copy () const

function get_id

get the calibration id

std::string cuvis::Calibration::get_id () const

function get_info

get calibration infos

CalibrationInfo cuvis::Calibration::get_info () const

The documentation for this class was generated from the following file cuvis.cpp/interface/cuvis.hpp