| 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::CameraState::Network::IPV4::Address | Current IPv4 address |
| CZivid::NetworkConfiguration::IPV4::Address | IPv4 address. Only used in manual mode |
| 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::Detail::EnvironmentInfo::Platform::CPU::Architecture | CPU architecture |
| 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 and is available for use, but not connected in software. This corresponds to the Status enums available or firmwareUpdateRequired. Zivid recommends to use the Status enum instead of this bool |
| 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 points outside the given three-dimensional 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::Settings2D::Sampling::Color | Choose how to sample colors for the 2D image. The rgb option gives an image with full colors. The grayscale option gives a grayscale (r=g=b) image, which can be acquired faster than full colors |
| CZivid::Settings::Processing::Color | Color settings |
| CZivid::Settings::Sampling::Color | Choose how to sample colors for the point cloud. The rgb option gives a 2D image with full colors. The grayscale option gives a grayscale (r=g=b) 2D image, which can be acquired faster than full colors. The disabled option gives no colors and can allow for even faster captures |
| 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::ColorSRGB | Color with 8-bit red, green, blue and alpha channels in the sRGB color space |
| CZivid::Detail::EnvironmentInfo::UserToolchain::Compiler | Information about which compiler is being used |
| 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. This bool is true when the Status value is connected. Zivid recommends to use the Status enum instead of this bool |
| 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 | Contrast distortion correction filter |
| CZivid::Detail::EnvironmentInfo::Platform::CPU | Information about the CPU |
| CZivid::FrameInfo::SystemInfo::CPU | CPU |
| CZivid::CameraIntrinsics::CameraMatrix::CX | X coordinate of the principal point |
| CZivid::Detail::EnvironmentInfo::UserToolchain::CxxStandard | The C++ standard being used |
| 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 detectCalibrationBoard(...) call |
| CZivid::Calibration::DetectionResultFiducialMarkers | Stores the result returned by a detectMarkers(const Frame &frame, const std::vector<int> &markerIds, const MarkerDictionary &markerDictionary) call |
| CZivid::Settings::Diagnostics | When Diagnostics is enabled, additional diagnostic data is recorded during capture and included when saving the frame to a .zdf file. This enables Zivid's Customer Success team to provide better assistance and more thorough troubleshooting |
| CZivid::CameraIntrinsics::Distortion | The radial and tangential distortion parameters |
| CZivid::CameraState::Temperature::DMD | DMD temperature |
| CZivid::Settings::Diagnostics::Enabled | Enable or disable diagnostics |
| CZivid::Settings::Processing::Filters::Cluster::Removal::Enabled | Enable or disable cluster removal |
| CZivid::Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Enabled | Enable or disable contrast distortion correction |
| CZivid::Settings::Processing::Filters::Experimental::ContrastDistortion::Removal::Enabled | Enable or disable contrast distortion removal |
| CZivid::Settings::Processing::Filters::Hole::Repair::Enabled | Enable or disable hole repair |
| 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 | Enable or disable box filter |
| CZivid::Settings::RegionOfInterest::Depth::Enabled | Enable or disable depth filter |
| CZivid::Settings::Engine | Set the Zivid Vision Engine to use |
| CZivid::Detail::EnvironmentInfo | Information about the current toolchain and platform |
| ►Cstd::exception | |
| CZivid::Exception | A common base class for all Zivid exceptions |
| 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::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 | Filter settings |
| 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 |
| CZivid::CameraInfo::HardwareRevision | Hardware revision of this camera. This corresponds to the revision string that is printed on the product label |
| ►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::Hole | Contains filters that can be used to deal with holes in the point cloud |
| CZivid::Settings::Processing::Filters::Hole::Repair::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::Detail::EnvironmentInfo::Platform::OS::ID | Operating system name |
| CZivid::Detail::EnvironmentInfo::UserToolchain::Compiler::ID | The name of the compiler |
| CZivid::Detail::EnvironmentInfo::UserToolchain::StandardLibrary::ID | The name of the standard library implementation |
| CZivid::CameraState::InaccessibleReason | If the camera status is inaccessible, then this enum value will give you the reason |
| CZivid::Experimental::Calibration::InfieldCorrectionInput | Container for input-data needed by in-field verification and correction functions |
| CZivid::CameraState::Network::IPV4 | Current IPv4 protocol state |
| CZivid::NetworkConfiguration::IPV4 | IPv4 network configuration |
| ►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. This field is deprecated and may be removed in a future version of the SDK. Please use HardwareRevision instead |
| CZivid::Calibration::MarkerDictionary | Holds information about fiducial markers such as ArUco or AprilTag for detection |
| CZivid::Calibration::MarkerShape | Holds physical (3D) and image (2D) properties of a detected fiducial marker |
| 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 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. This field is deprecated and may be removed in a future version of the SDK. Please use HardwareRevision instead |
| CZivid::NetworkConfiguration::IPV4::Mode | DHCP or manual configuration |
| CZivid::Settings::Processing::Color::Experimental::Mode | This setting controls how the color image is computed |
| CZivid::Settings::Processing::Filters::Reflection::Removal::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 and Cluster filter together with the Local Reflection filter |
| CZivid::Settings::Processing::Resampling::Mode | Setting for upsampling or downsampling the point cloud data by some factor. This operation is performed after all other processing has been completed |
| 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::Detail::EnvironmentInfo::Platform::CPU::ModelName | CPU model name |
| 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::CameraState::Network | Current network state |
| CZivid::NetworkConfiguration | Network configuration of a camera |
| 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::Detail::EnvironmentInfo::Platform::OS | Operation system name and version |
| 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::Settings2D::Sampling::Pixel | Use this setting to obtain an image that matches a point cloud captured with the equivalent sampling setting |
| 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::Experimental::PixelMapping | Pixel mapping from subsampled to full resolution |
| CZivid::Detail::EnvironmentInfo::Platform | Information about the current platform |
| 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::Projection::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 | Cluster removal filter |
| CZivid::Settings::Processing::Filters::Experimental::ContrastDistortion::Removal | Contrast distortion removal filter |
| 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::Hole::Repair | Fills in point cloud holes by interpolating remaining surrounding points |
| 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::Settings::Processing::Resampling | Settings for changing the output resolution of the point cloud |
| CZivid::Resolution | Class describing a resolution with a width and a height |
| CZivid::CameraInfo::Revision | Major/Minor hardware revision number. This field is deprecated and may be removed in a future version of the SDK. Please use HardwareRevision instead |
| CZivid::Settings2D::Sampling | Sampling settings |
| CZivid::Settings::Sampling | Sampling settings |
| 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::Detail::EnvironmentInfo::UserToolchain::StandardLibrary | Information about what standard library implementation is being used |
| CZivid::CameraState::Status | This enum describes the current status of this camera. The enum can have the following values: |
| CZivid::Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Strength | Strength of correction. Higher values give more correction |
| CZivid::Settings::Processing::Filters::Hole::Repair::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::NetworkConfiguration::IPV4::SubnetMask | IPv4 subnet mask (for example 255.255.255.0). Only used in manual mode |
| 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 | Threshold for removal. 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::Detail::EnvironmentInfo::UserToolchain | Information about the current toolchain |
| ►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::Detail::EnvironmentInfo::Platform::OS::Version | Operating system version |
| CZivid::Detail::EnvironmentInfo::UserToolchain::Compiler::Version | The version of the compiler |
| CZivid::Detail::EnvironmentInfo::UserToolchain::StandardLibrary::Version | The version of the standard library implementation |
| CZivid::Visualization::Visualizer | Simple visualizer component for point clouds |
| CZivid::Detail::EnvironmentInfo::Wrapper | The wrapper being used, if any |
1.11.0