Zivid C++ API 2.15.0+5fcc365b-1
Zivid::Experimental::SettingsInfo Namespace Reference

Functions

template<typename T >
defaultValue (const CameraInfo &cameraInfo)
 
template<typename T >
std::set< typename T::ValueType > validValues (const CameraInfo &cameraInfo)
 
template<typename T , typename Ret = Range<typename T::ValueType>>
Ret validRange (const CameraInfo &cameraInfo)
 
ZIVID_CORE_EXPORT Resolution resolution (const CameraInfo &cameraInfo, const Settings &settings)
 Returns the resolution of captured frames according to the provided camera information and settings.
 
ZIVID_CORE_EXPORT Resolution resolution2D (const CameraInfo &cameraInfo, const Settings &settings)
 Returns the resolution of a 2D frame according to the provided camera information and settings.
 
ZIVID_CORE_EXPORT Resolution resolution2D (const CameraInfo &cameraInfo, const Settings2D &settings)
 Returns the resolution of a 2D frame according to the provided camera information and 2D settings.
 

Function Documentation

◆ defaultValue()

template<typename T >
T Zivid::Experimental::SettingsInfo::defaultValue ( const CameraInfo & cameraInfo)

◆ resolution()

ZIVID_CORE_EXPORT Resolution Zivid::Experimental::SettingsInfo::resolution ( const CameraInfo & cameraInfo,
const Settings & settings )

Returns the resolution of captured frames according to the provided camera information and settings.

Note that for a 2D+3D capture, the 2D color image and 3D point cloud may have different resolutions, depending on the pixel sampling and resampling settings used in the Settings and in the Settings::Color. This function returns the resolution of the 3D Point Cloud for the frame, in other words, it returns the resolution of the PointCloud returned from Frame::pointCloud(). See also Frame::frame2D().

If no acquisitions have been specified in the provided settings this function will throw an exception.

◆ resolution2D() [1/2]

ZIVID_CORE_EXPORT Resolution Zivid::Experimental::SettingsInfo::resolution2D ( const CameraInfo & cameraInfo,
const Settings & settings )

Returns the resolution of a 2D frame according to the provided camera information and settings.

Note that for a 2D+3D capture, the 2D color image and 3D point cloud may have different resolutions, depending on the pixel sampling and resampling settings used in the Settings and in the Settings::Color. This function returns the resolution of the 2D Color Image for the 2D frame, in other words, it returns the resolution of the Image returned from Frame2D::imageRGBA(). See also Frame::frame2D().

If no color settings have been specified in the provided settings this function will throw an exception. If no 2D acquisitions have been specified in the provided settings this function will throw an exception.

◆ resolution2D() [2/2]

ZIVID_CORE_EXPORT Resolution Zivid::Experimental::SettingsInfo::resolution2D ( const CameraInfo & cameraInfo,
const Settings2D & settings )

Returns the resolution of a 2D frame according to the provided camera information and 2D settings.

If no acquisitions have been specified in the provided settings this function will throw an exception.

◆ validRange()

template<typename T , typename Ret = Range<typename T::ValueType>>
Ret Zivid::Experimental::SettingsInfo::validRange ( const CameraInfo & cameraInfo)

◆ validValues()

template<typename T >
std::set< typename T::ValueType > Zivid::Experimental::SettingsInfo::validValues ( const CameraInfo & cameraInfo)