Class Hierarchy

This inheritance list is sorted roughly, but not completely, alphabetically:

[detail level 12]

CZivid::Experimental::Calibration::AccuracyEstimate	A dimension accuracy estimate for a specific working volume
CZivid::Settings2D::Acquisition	Settings for a single acquisition
CZivid::Settings::Acquisition	Settings for a single acquisition
CZivid::Settings2D::Acquisitions	List of acquisitions. Note that the Zivid SDK only supports a single acquisition per capture in 2D mode.
CZivid::Settings::Acquisitions	List of Acquisition objects
CZivid::CaptureAssistant::SuggestSettingsParameters::AmbientLightFrequency	Adapt suggested settings to the ambient light frequency. This can be used to avoid artifacts in the point cloud due to AC powered ambient light being mixed in with the camera's projector light
CZivid::Settings2D::Acquisition::Aperture	Aperture setting for the camera. Specified as an f-number (the ratio of lens focal length to the effective aperture diameter).
CZivid::Settings::Acquisition::Aperture	Aperture setting for the camera. Specified as an f-number (the ratio of lens focal length to the effective aperture diameter).
CZivid::Application	Manager class for Zivid
CZivid::Array2D< DataFormat >	Two-dimensional container of data
►CZivid::Array2D< PixelFormat >
CZivid::Image< PixelFormat >	A 2-dimensional image
CZivid::CameraState::Available	Flag if camera is physically connected to the computer, but not connected in software. When the camera is in this state, you can call connect().
CZivid::Settings2D::Processing::Color::Balance	Color balance settings
CZivid::Settings::Processing::Color::Balance	Color balance settings
CZivid::Settings2D::Processing::Color::Balance::Blue	Digital gain applied to blue channel
CZivid::Settings::Processing::Color::Balance::Blue	Digital gain applied to blue channel
CZivid::Settings::RegionOfInterest::Box	Removes the points outside the box
CZivid::Settings2D::Acquisition::Brightness	Brightness controls the light output from the projector
CZivid::Settings::Acquisition::Brightness	Brightness controls the light output from the projector
CZivid::Camera	Interface to one Zivid camera
CZivid::Experimental::Calibration::CameraCorrection	An in-field correction that may be written to a camera
CZivid::CameraInfo	Information about camera model, serial number etc.
CZivid::CameraIntrinsics	Information about the intrinsic parameters of the camera (OpenCV model)
CZivid::CameraIntrinsics::CameraMatrix	The camera matrix K (=[fx,0,cx;0,fy,cy;0,0,1])
CZivid::CameraState	Information about camera connection state, temperatures, etc.
CZivid::Experimental::Calibration::CameraVerification	An assessment of the current dimension trueness of a camera at a specific location
CZivid::Presets::CategoryBase< PresetType >	Preset category. A preset category contains a collection of presets optimized for one scenario or use case.
CZivid::Settings::Processing::Filters::Cluster	Removes floating points and isolated clusters from the point cloud.
CZivid::Settings2D::Processing::Color	Color settings
CZivid::Settings::Processing::Color	Color settings
CZivid::Settings::Sampling::Color	Choose how to sample colors for the pointcloud. The rgb option gives all colors for a regular Zivid camera. The disabled option gives no colors and can allow for faster captures. It is also useful if you want to avoid projecting white light in the subsampling modes under Sampling::Pixel.
CZivid::ColorBGRABase< T >
►CZivid::ColorBGRABase< uint8_t >
CZivid::ColorBGRA	Color with 8-bit blue, green, red and alpha channels
CZivid::ColorRGBABase< T >
►CZivid::ColorRGBABase< uint8_t >
CZivid::ColorRGBA	Color with 8-bit red, green, blue and alpha channels
CZivid::ComputeDevice	Contains information about the compute device used by Zivid::Application.
CZivid::FrameInfo::SystemInfo::ComputeDevice	Compute device
CZivid::CameraState::Connected	Flag if camera is connected in software
CZivid::Settings::Processing::Filters::Experimental::ContrastDistortion	Corrects artifacts that appear when imaging scenes with large texture gradients or high contrast. These artifacts are caused by blurring in the lens. The filter works best when aperture values are chosen such that the camera has quite good focus. The filter also supports removing the points that experience a large correction.
CZivid::FrameInfo::SoftwareVersion::Core	Core version
CZivid::Settings::Processing::Filters::Experimental::ContrastDistortion::Correction	Correction
CZivid::FrameInfo::SystemInfo::CPU	CPU
CZivid::CameraIntrinsics::CameraMatrix::CX	x coordinate of the principal point
CZivid::CameraIntrinsics::CameraMatrix::CY	y coordinate of the principal point
CZivid::Settings::RegionOfInterest::Depth	Removes points that reside outside of a depth range, meaning that their Z coordinate falls above a given maximum or below a given minimum.
CZivid::Calibration::DetectionResult	A result returned by the detectFeaturePoints(...) call
CZivid::Settings::Diagnostics	When Diagnostics is enabled, extra diagnostic information is recorded during capture. This extra information is included when saving the frame to a .zdf file, and will help Zivid's support team to provide better assistance
CZivid::CameraIntrinsics::Distortion	The radial and tangential distortion parameters
CZivid::CameraState::Temperature::DMD	DMD temperature
CZivid::Settings::Diagnostics::Enabled	Enable diagnostics
CZivid::Settings::Processing::Filters::Cluster::Removal::Enabled	Enabled
CZivid::Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Enabled	Enabled
CZivid::Settings::Processing::Filters::Experimental::ContrastDistortion::Removal::Enabled	Enabled
CZivid::Settings::Processing::Filters::Experimental::HoleFilling::Enabled	Enabled
CZivid::Settings::Processing::Filters::Noise::Removal::Enabled	Enable or disable the SNR filter
CZivid::Settings::Processing::Filters::Noise::Repair::Enabled	Enable or disable noise repair
CZivid::Settings::Processing::Filters::Noise::Suppression::Enabled	Enable or disable noise suppression
CZivid::Settings::Processing::Filters::Outlier::Removal::Enabled	Enable or disable the outlier filter
CZivid::Settings::Processing::Filters::Reflection::Removal::Enabled	Enable or disable the reflection filter. Note that this filter is computationally intensive and may affect the frame rate
CZivid::Settings::Processing::Filters::Smoothing::Gaussian::Enabled	Enable or disable the smoothing filter
CZivid::Settings::RegionOfInterest::Box::Enabled	Enabled
CZivid::Settings::RegionOfInterest::Depth::Enabled	Enabled
CZivid::Settings::Experimental::Engine	Set the Zivid Vision Engine to use
►Cstd::exception
CZivid::Exception	A common base class for all Zivid exceptions.
CZivid::Settings::Experimental	Experimental features. These settings may be changed, renamed, moved or deleted in the future.
CZivid::Settings::Processing::Color::Experimental	Experimental color settings. These may be renamed, moved or deleted in the future.
CZivid::Settings::Processing::Filters::Experimental	Experimental filters. These may be renamed, moved or deleted in the future.
CZivid::Settings::Processing::Filters::Reflection::Removal::Experimental	Experimental reflection filter related settings
CZivid::Settings2D::Acquisition::ExposureTime	Exposure time for the image
CZivid::Settings::Acquisition::ExposureTime	Exposure time for each single image in the measurement. Affects frame rate.
CZivid::Settings::RegionOfInterest::Box::Extents	Two points on the normal describing the direction and distance from the plane from which the normal is derived.
CZivid::Settings::Processing::Filters	Filters
CZivid::CameraInfo::FirmwareVersion	The firmware version on the camera
CZivid::Frame	A frame captured by a Zivid camera
CZivid::Frame2D	A 2D frame captured by a Zivid camera
CZivid::FrameInfo	Various information for a frame
CZivid::CameraIntrinsics::CameraMatrix::FX	Focal length in x
CZivid::CameraIntrinsics::CameraMatrix::FY	Focal length in y
CZivid::Settings2D::Acquisition::Gain	Analog gain in the camera
CZivid::Settings::Acquisition::Gain	Analog gain in the camera
CZivid::Settings2D::Processing::Color::Gamma	Gamma applied to the color values. Gamma less than 1 makes the colors brighter, while gamma greater than 1 makes the colors darker.
CZivid::Settings::Processing::Color::Gamma	Gamma applied to the color values. Gamma less than 1 makes the colors brighter, while gamma greater than 1 makes the colors darker.
CZivid::Settings::Processing::Filters::Smoothing::Gaussian	Gaussian smoothing of the point cloud
CZivid::CameraState::Temperature::General	General temperature
CZivid::Settings2D::Processing::Color::Balance::Green	Digital gain applied to green channel
CZivid::Settings::Processing::Color::Balance::Green	Digital gain applied to green channel
CZivid::Calibration::HandEyeInput	Binds together a robot pose and the detection result acquired from the pose
CZivid::Calibration::HandEyeOutput	The hand-eye calibration result containing the computed pose and reprojection errors for all the input poses
CZivid::Calibration::HandEyeResidual	Representaton of the estimated errors of a calibrated hand-eye transform
►CDetail::HasValidRange
CZivid::DataModel::HasValidRange< T >	Check if T has a ValidRange constraint
►CDetail::HasValidSize
CZivid::DataModel::HasValidSize< T >	Check if T has a ValidSize constraint
►CDetail::HasValidValues
CZivid::DataModel::HasValidValues< T >	Check if data model type T has a ValidValues constraint
CZivid::Settings::Processing::Filters::Experimental::HoleFilling	Fills in removed points by interpolating remaining surrounding points.
CZivid::Settings::Processing::Filters::Experimental::HoleFilling::HoleSize	Relative diameter of holes to fill. Increasing this will fill more points, but require more computation time. The maximum allowed hole size scales with distance, so that we allow filling larger holes at greater distances, measured in mm.
CZivid::Experimental::Calibration::InfieldCorrectionInput	Container for input-data needed by in-field verification and correction functions
►CDetail::IsOptional
CZivid::DataModel::IsOptional< T >
CZivid::CameraIntrinsics::Distortion::K1	First radial distortion term
CZivid::CameraIntrinsics::Distortion::K2	Second radial distortion term
CZivid::CameraIntrinsics::Distortion::K3	Third radial distortion term
CZivid::CameraState::Temperature::LED	LED temperature
CZivid::CameraState::Temperature::Lens	Lens temperature
CZivid::CameraInfo::Revision::Major	Major hardware revision number
CZivid::Matrix< T, rowCount, colCount >	A fixed size matrix in row major order
CZivid::Matrix< float, 4, 4 >
CZivid::CaptureAssistant::SuggestSettingsParameters::MaxCaptureTime	Capture time budget. This budget assumes a high-end computer meeting Zivid's recommendations. The actual capture time may differ, based on your computer's performance and (for Zivid 2 and 2+) your network connection speed.
CZivid::Settings::Processing::Filters::Cluster::Removal::MaxNeighborDistance	Maximum normalized distance between neighboring points that are still classified as belonging to the same cluster. The default value (10.0) is optimal for most scenes. On messy scenes turning this setting down helps removing more bad points.
CZivid::CameraInfo::UserData::MaxSizeBytes	The maximum number of bytes of user data that can be stored in the camera
CZivid::Settings::Processing::Filters::Cluster::Removal::MinArea	Clusters with area below this threshold are removed by the filter. The area is given in mm^2.
CZivid::CameraInfo::Revision::Minor	Minor hardware revision number
CZivid::Settings::Processing::Color::Experimental::Mode	This setting controls how the color image is computed
CZivid::Settings::Processing::Filters::Reflection::Removal::Experimental::Mode	The reflection filter has two modes: Local and Global. Local mode preserves more 3D data on thinner objects, generally removes more reflection artifacts and processes faster than the Global filter. The Global filter is generally better at removing outlier points in the point cloud. It is advised to use the Outlier filter together with the Local Reflection filter
CZivid::CameraInfo::Model	The model of the camera
CZivid::FrameInfo::SystemInfo::ComputeDevice::Model	Compute device model
CZivid::FrameInfo::SystemInfo::CPU::Model	CPU model
CZivid::CameraInfo::ModelName	The model name of the camera. This is a user-friendly display name that may contain spaces and special characters. We recommend to use Model instead if you want to programmatically check for camera model.
CZivid::Calibration::MultiCameraOutput	The results from a multi-camera calibration process
CZivid::Calibration::MultiCameraResidual	Representation of the estimated errors of a multi-camera calibration
CZivid::Settings::Processing::Filters::Noise	Contains filters that can be used to clean up a noisy point cloud
CZivid::FrameInfo::SystemInfo::OperatingSystem	Operating system
CZivid::Settings::Processing::Filters::Outlier	Contains a filter that removes points with large Euclidean distance to neighboring points
CZivid::CameraIntrinsics::Distortion::P1	First tangential distortion term
CZivid::CameraIntrinsics::Distortion::P2	Second tangential distortion term
CZivid::CameraState::Temperature::PCB	PCB temperature
CZivid::Settings::Sampling::Pixel	Set whether the full image sensor should be used with white projector light or only specific color channels with corresponding projector light. Using only a specific color channel will subsample pixels and give a smaller resolution
CZivid::Settings::RegionOfInterest::Box::PointA	A point such that the vector from PointO to PointA describes the first edge of the parallelogram
CZivid::Settings::RegionOfInterest::Box::PointB	A point such that the vector from PointO to PointB describes the second edge of the parallelogram
CZivid::PointCloud	Point cloud with x, y, z, RGB color and SNR laid out on a 2D grid
CZivid::Settings::RegionOfInterest::Box::PointO	The point at the intersection of two adjacent edges defining a parallelogram
CZivid::PointXY	Point with two coordinates as float
CZivid::PointXYZ	Point with three coordinates as float
CZivid::PointXYZColorBGRA	Struct which contains XYZ point and BGRA color packed together
CZivid::PointXYZColorRGBA	Struct which contains XYZ point and RGBA color packed together
CZivid::PointXYZW	Point with four coordinates as float
CZivid::PointZ	Point with Z coordinate
CZivid::Calibration::Pose	Describes a robot pose
CZivid::Presets::PresetBase< SettingsType >	Presets are pre-defined settings that are tuned for different camera models to perform optimally under different conditions and use cases.
CZivid::Settings2D::Processing	Processing related settings
CZivid::Settings::Processing	Settings related to processing of a capture, including filters and color balance
CZivid::Experimental::ProjectedImage	A handle to a 2D image being displayed on Zivid camera's projector
CZivid::Range< T >	Class describing a range of values for a given type T
CZivid::Settings::RegionOfInterest::Depth::Range	Specify the minimum and maximum Z value that will be included.
CZivid::Settings2D::Processing::Color::Balance::Red	Digital gain applied to red channel
CZivid::Settings::Processing::Color::Balance::Red	Digital gain applied to red channel
CZivid::Settings::Processing::Filters::Reflection	Contains a filter that removes points likely introduced by reflections (useful for shiny materials)
CZivid::Settings::RegionOfInterest	Removes points outside the region of interest.
CZivid::Settings::Processing::Filters::Cluster::Removal	Removal
CZivid::Settings::Processing::Filters::Experimental::ContrastDistortion::Removal	Removal
CZivid::Settings::Processing::Filters::Noise::Removal	Discard points with signal-to-noise ratio (SNR) values below a threshold
CZivid::Settings::Processing::Filters::Outlier::Removal	Discard point if Euclidean distance to neighboring points is above a threshold
CZivid::Settings::Processing::Filters::Reflection::Removal	Discard points likely introduced by reflections (useful for shiny materials)
CZivid::Settings::Processing::Filters::Noise::Repair	Get better surface coverage by repairing regions of missing data due to noisy points. Consider disabling this filter if you require all points in your point cloud to be of high confidence.
CZivid::Resolution	Class describing a given resolution
CZivid::CameraInfo::Revision	The hardware revision of the camera
CZivid::Settings::Sampling	Sampling group
CZivid::CameraInfo::SerialNumber	The serial number of the camera
CZivid::Settings	Settings used when capturing with a Zivid camera
CZivid::Settings2D	Settings used when capturing 2D images with a Zivid camera
CZivid::Settings::Processing::Filters::Smoothing::Gaussian::Sigma	Higher values result in smoother point clouds (Standard deviation of the filter coefficients)
CZivid::Settings::Processing::Filters::Smoothing	Smoothing filters
CZivid::SNR	Signal-to-Noise ratio (SNR)
CZivid::FrameInfo::SoftwareVersion	The version information for installed software at the time of image capture
CZivid::Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Strength	Higher values gives more correction.
CZivid::Settings::Processing::Filters::Experimental::HoleFilling::Strictness	Level of strictness when considering if a point should be filled. A higher level of strictness requires a missing point to be surrounded by valid points on more sides in order to be filled. Increasing this will fill fewer points, but it will be less likely to fill gaps that are not circular, for example between two edges.
CZivid::CaptureAssistant::SuggestSettingsParameters	Used to specify a constraint on the total capture time for the settings suggested by the Capture Assistant, and optionally specify the ambient light frequency.
CZivid::Settings::Processing::Filters::Noise::Suppression	Reduce noise and outliers in the point cloud. This filter can also be used to reduce ripple effects caused by interreflections. Consider disabling this filter if you need to distinguish very fine details and thus need to avoid any smoothing effects.
CZivid::FrameInfo::SystemInfo	Information about the system that captured this frame
CZivid::CameraState::Temperature	Current temperature(s)
CZivid::Settings::Processing::Filters::Experimental::ContrastDistortion::Removal::Threshold	Higher values remove more points.
CZivid::Settings::Processing::Filters::Noise::Removal::Threshold	Discard points with signal-to-noise ratio (SNR) below the given value
CZivid::Settings::Processing::Filters::Outlier::Removal::Threshold	Discard point if Euclidean distance to neighboring points is above the given value
CZivid::FrameInfo::TimeStamp	The time of frame capture
CZivid::CameraInfo::UserData	Information about user data capabilities of the camera
►CZivid::VectorXYZ	Vector with three coordinates as float
CZivid::NormalXYZ	Normal vector with three coordinates as float
CZivid::FrameInfo::SystemInfo::ComputeDevice::Vendor	Compute device vendor
CZivid::Visualization::Visualizer	Simple visualizer component for point clouds