Settings Info

Experimental API for querying the capture resolution for a given CameraInfo and Settings combination without capturing. Resides in Zivid::Experimental::SettingsInfo and may change without prior notice.

        %%{init: {'themeVariables': {'fontSize': '18px'}, 'flowchart': {'nodeSpacing': 30, 'rankSpacing': 35}}}%%
flowchart LR
  CameraInfo
  Settings
  Settings2D

  resolutionOp(["resolution()"])
  resolution2DOp(["resolution2D()"])

  Resolution

  CameraInfo -.-> resolutionOp --> Resolution
  Settings -.-> resolutionOp
  CameraInfo -.-> resolution2DOp --> Resolution
  Settings -.-> resolution2DOp
  Settings2D -.-> resolution2DOp

  classDef zividClass fill:#4A8FA4,stroke:#34323D,color:#FFFFFF
  classDef api fill:#91D2C8,stroke:#4A8FA4,color:#000000
  class CameraInfo,Settings,Settings2D,Resolution zividClass
  class resolutionOp,resolution2DOp api

resolution

Returns the 3D capture resolution (height × width) that the camera would produce for the given CameraInfo and Settings.

C++

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.

C#

class SettingsInfo

Public Static Functions

static Zivid::NET::Resolution ^ Resolution (Zivid::NET::CameraInfo ^ cameraInfo, Zivid::NET::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.

Python

See zivid-python.

resolution2D

Returns the 2D capture resolution for a given CameraInfo paired with either Settings (sub-sampled 2D channel of a 3D capture) or Settings2D (pure 2D capture).

C++

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.

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.

C#

class SettingsInfo

Public Static Functions

static Zivid::NET::Resolution ^ Resolution2D (Zivid::NET::CameraInfo ^ cameraInfo, Zivid::NET::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 ImageRGBA 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.

static Zivid::NET::Resolution ^ Resolution2D (Zivid::NET::CameraInfo ^ cameraInfo, Zivid::NET::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.

Python

See zivid-python.