Zivid C++ API 2.13.1+18e79e79-1
Class Hierarchy
This inheritance list is sorted roughly, but not completely, alphabetically:
[detail level 12]
 CZivid::Experimental::Calibration::AccuracyEstimateA dimension accuracy estimate for a specific working volume
 CZivid::Settings2D::AcquisitionSettings for a single acquisition
 CZivid::Settings::AcquisitionSettings for a single acquisition
 CZivid::Settings2D::AcquisitionsList of acquisitions. Note that the Zivid SDK only supports a single acquisition per capture in 2D mode
 CZivid::Settings::AcquisitionsList of Acquisition objects
 CZivid::CameraState::Network::IPV4::AddressCurrent IPv4 address
 CZivid::NetworkConfiguration::IPV4::AddressIPv4 address. Only used in manual mode
 CZivid::CaptureAssistant::SuggestSettingsParameters::AmbientLightFrequencyAdapt 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::ApertureAperture setting for the camera. Specified as an f-number (the ratio of lens focal length to the effective aperture diameter)
 CZivid::Settings::Acquisition::ApertureAperture setting for the camera. Specified as an f-number (the ratio of lens focal length to the effective aperture diameter)
 CZivid::ApplicationManager class for Zivid
 CZivid::Detail::EnvironmentInfo::Platform::CPU::ArchitectureCPU architecture
 CZivid::Array2D< DataFormat >Two-dimensional container of data
 CZivid::Array2D< PixelFormat >
 CZivid::CameraState::AvailableFlag 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::BalanceColor balance settings
 CZivid::Settings::Processing::Color::BalanceColor balance settings
 CZivid::Settings2D::Processing::Color::Balance::BlueDigital gain applied to blue channel
 CZivid::Settings::Processing::Color::Balance::BlueDigital gain applied to blue channel
 CZivid::Settings::RegionOfInterest::BoxRemoves points outside the given three-dimensional box
 CZivid::Settings2D::Acquisition::BrightnessBrightness controls the light output from the projector
 CZivid::Settings::Acquisition::BrightnessBrightness controls the light output from the projector
 CZivid::CameraInterface to one Zivid camera
 CZivid::Experimental::Calibration::CameraCorrectionAn in-field correction that may be written to a camera
 CZivid::CameraInfoInformation about camera model, serial number etc
 CZivid::CameraIntrinsicsInformation about the intrinsic parameters of the camera (OpenCV model)
 CZivid::CameraIntrinsics::CameraMatrixThe camera matrix K (=[fx,0,cx;0,fy,cy;0,0,1])
 CZivid::CameraStateInformation about camera connection state, temperatures, etc
 CZivid::Experimental::Calibration::CameraVerificationAn 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::ClusterRemoves floating points and isolated clusters from the point cloud
 CZivid::Settings2D::Processing::ColorColor settings
 CZivid::Settings2D::Sampling::ColorChoose 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::ColorColor settings
 CZivid::Settings::Sampling::ColorChoose 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::ColorRGBABase< T >
 CZivid::ColorRGBABase< uint8_t >
 CZivid::Detail::EnvironmentInfo::UserToolchain::CompilerInformation about which compiler is being used
 CZivid::ComputeDeviceContains information about the compute device used by Zivid::Application
 CZivid::FrameInfo::SystemInfo::ComputeDeviceCompute device
 CZivid::CameraState::ConnectedFlag 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::ContrastDistortionCorrects 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::CoreCore version
 CZivid::Settings::Processing::Filters::Experimental::ContrastDistortion::CorrectionContrast distortion correction filter
 CZivid::Detail::EnvironmentInfo::Platform::CPUInformation about the CPU
 CZivid::FrameInfo::SystemInfo::CPUCPU
 CZivid::CameraIntrinsics::CameraMatrix::CXX coordinate of the principal point
 CZivid::Detail::EnvironmentInfo::UserToolchain::CxxStandardThe C++ standard being used
 CZivid::CameraIntrinsics::CameraMatrix::CYY coordinate of the principal point
 CZivid::Settings::RegionOfInterest::DepthRemoves 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::DetectionResultA result returned by the detectCalibrationBoard(...) call
 CZivid::Calibration::DetectionResultFiducialMarkersStores the result returned by a detectMarkers(const Frame &frame, const std::vector<int> &markerIds, const MarkerDictionary &markerDictionary) call
 CZivid::Settings::DiagnosticsWhen 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::DistortionThe radial and tangential distortion parameters
 CZivid::CameraState::Temperature::DMDDMD temperature
 CZivid::Settings::Diagnostics::EnabledEnable or disable diagnostics
 CZivid::Settings::Processing::Filters::Cluster::Removal::EnabledEnable or disable cluster removal
 CZivid::Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::EnabledEnable or disable contrast distortion correction
 CZivid::Settings::Processing::Filters::Experimental::ContrastDistortion::Removal::EnabledEnable or disable contrast distortion removal
 CZivid::Settings::Processing::Filters::Hole::Repair::EnabledEnable or disable hole repair
 CZivid::Settings::Processing::Filters::Noise::Removal::EnabledEnable or disable the SNR filter
 CZivid::Settings::Processing::Filters::Noise::Repair::EnabledEnable or disable noise repair
 CZivid::Settings::Processing::Filters::Noise::Suppression::EnabledEnable or disable noise suppression
 CZivid::Settings::Processing::Filters::Outlier::Removal::EnabledEnable or disable the outlier filter
 CZivid::Settings::Processing::Filters::Reflection::Removal::EnabledEnable or disable the reflection filter. Note that this filter is computationally intensive and may affect the frame rate
 CZivid::Settings::Processing::Filters::Smoothing::Gaussian::EnabledEnable or disable the smoothing filter
 CZivid::Settings::RegionOfInterest::Box::EnabledEnable or disable box filter
 CZivid::Settings::RegionOfInterest::Depth::EnabledEnable or disable depth filter
 CZivid::Settings::EngineSet the Zivid Vision Engine to use
 CZivid::Detail::EnvironmentInfoInformation about the current toolchain and platform
 Cstd::exception
 CZivid::Settings::Processing::Color::ExperimentalExperimental color settings. These may be renamed, moved or deleted in the future
 CZivid::Settings::Processing::Filters::ExperimentalExperimental filters. These may be renamed, moved or deleted in the future
 CZivid::Settings2D::Acquisition::ExposureTimeExposure time for the image
 CZivid::Settings::Acquisition::ExposureTimeExposure time for each single image in the measurement. Affects frame rate
 CZivid::Settings::RegionOfInterest::Box::ExtentsTwo points on the normal describing the direction and distance from the plane from which the normal is derived
 CZivid::Settings::Processing::FiltersFilter settings
 CZivid::CameraInfo::FirmwareVersionThe firmware version on the camera
 CZivid::FrameA frame captured by a Zivid camera
 CZivid::Frame2DA 2D frame captured by a Zivid camera
 CZivid::FrameInfoVarious information for a frame
 CZivid::CameraIntrinsics::CameraMatrix::FXFocal length in x
 CZivid::CameraIntrinsics::CameraMatrix::FYFocal length in y
 CZivid::Settings2D::Acquisition::GainAnalog gain in the camera
 CZivid::Settings::Acquisition::GainAnalog gain in the camera
 CZivid::Settings2D::Processing::Color::GammaGamma 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::GammaGamma 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::GaussianGaussian smoothing of the point cloud
 CZivid::CameraState::Temperature::GeneralGeneral temperature
 CZivid::Settings2D::Processing::Color::Balance::GreenDigital gain applied to green channel
 CZivid::Settings::Processing::Color::Balance::GreenDigital gain applied to green channel
 CZivid::Calibration::HandEyeInputBinds together a robot pose and the detection result acquired from the pose
 CZivid::Calibration::HandEyeOutputThe hand-eye calibration result containing the computed pose and reprojection errors for all the input poses
 CZivid::Calibration::HandEyeResidualRepresentaton of the estimated errors of a calibrated hand-eye transform
 CZivid::CameraInfo::HardwareRevisionHardware revision of this camera. This corresponds to the revision string that is printed on the product label
 CDetail::HasValidRange
 CDetail::HasValidSize
 CDetail::HasValidValues
 CZivid::Settings::Processing::Filters::HoleContains filters that can be used to deal with holes in the point cloud
 CZivid::Settings::Processing::Filters::Hole::Repair::HoleSizeRelative 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::IDOperating system name
 CZivid::Detail::EnvironmentInfo::UserToolchain::Compiler::IDThe name of the compiler
 CZivid::Detail::EnvironmentInfo::UserToolchain::StandardLibrary::IDThe name of the standard library implementation
 CZivid::CameraState::InaccessibleReasonIf the camera status is inaccessible, then this enum value will give you the reason
 CZivid::Experimental::Calibration::InfieldCorrectionInputContainer for input-data needed by in-field verification and correction functions
 CZivid::CameraState::Network::IPV4Current IPv4 protocol state
 CZivid::NetworkConfiguration::IPV4IPv4 network configuration
 CDetail::IsOptional
 CZivid::CameraIntrinsics::Distortion::K1First radial distortion term
 CZivid::CameraIntrinsics::Distortion::K2Second radial distortion term
 CZivid::CameraIntrinsics::Distortion::K3Third radial distortion term
 CZivid::CameraState::Temperature::LEDLED temperature
 CZivid::CameraState::Temperature::LensLens temperature
 CZivid::CameraInfo::Revision::MajorMajor hardware revision number. This field is deprecated and may be removed in a future version of the SDK. Please use HardwareRevision instead
 CZivid::Calibration::MarkerDictionaryHolds information about fiducial markers such as ArUco or AprilTag for detection
 CZivid::Calibration::MarkerShapeHolds 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::MaxCaptureTimeCapture 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::MaxNeighborDistanceMaximum 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::MaxSizeBytesThe maximum number of bytes of user data that can be stored in the camera
 CZivid::Settings::Processing::Filters::Cluster::Removal::MinAreaClusters with area below this threshold are removed by the filter. The area is given in mm^2
 CZivid::CameraInfo::Revision::MinorMinor 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::ModeDHCP or manual configuration
 CZivid::Settings::Processing::Color::Experimental::ModeThis setting controls how the color image is computed
 CZivid::Settings::Processing::Filters::Reflection::Removal::ModeThe 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::ModeSetting for upsampling or downsampling the point cloud data by some factor. This operation is performed after all other processing has been completed
 CZivid::CameraInfo::ModelThe model of the camera
 CZivid::FrameInfo::SystemInfo::ComputeDevice::ModelCompute device model
 CZivid::FrameInfo::SystemInfo::CPU::ModelCPU model
 CZivid::CameraInfo::ModelNameThe 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::ModelNameCPU model name
 CZivid::Calibration::MultiCameraOutputThe results from a multi-camera calibration process
 CZivid::Calibration::MultiCameraResidualRepresentation of the estimated errors of a multi-camera calibration
 CZivid::CameraState::NetworkCurrent network state
 CZivid::NetworkConfigurationNetwork configuration of a camera
 CZivid::Settings::Processing::Filters::NoiseContains filters that can be used to clean up a noisy point cloud
 CZivid::FrameInfo::SystemInfo::OperatingSystemOperating system
 CZivid::Detail::EnvironmentInfo::Platform::OSOperation system name and version
 CZivid::Settings::Processing::Filters::OutlierContains a filter that removes points with large Euclidean distance to neighboring points
 CZivid::CameraIntrinsics::Distortion::P1First tangential distortion term
 CZivid::CameraIntrinsics::Distortion::P2Second tangential distortion term
 CZivid::CameraState::Temperature::PCBPCB temperature
 CZivid::Settings2D::Sampling::PixelUse this setting to obtain an image that matches a point cloud captured with the equivalent sampling setting
 CZivid::Settings::Sampling::PixelSet 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::PixelMappingPixel mapping from subsampled to full resolution
 CZivid::Detail::EnvironmentInfo::PlatformInformation about the current platform
 CZivid::Settings::RegionOfInterest::Box::PointAA point such that the vector from PointO to PointA describes the first edge of the parallelogram
 CZivid::Settings::RegionOfInterest::Box::PointBA point such that the vector from PointO to PointB describes the second edge of the parallelogram
 CZivid::PointCloudPoint cloud with x, y, z, RGB color and SNR laid out on a 2D grid
 CZivid::Settings::RegionOfInterest::Box::PointOThe point at the intersection of two adjacent edges defining a parallelogram
 CZivid::PointXYPoint with two coordinates as float
 CZivid::PointXYZPoint with three coordinates as float
 CZivid::PointXYZColorBGRAStruct which contains XYZ point and BGRA color packed together
 CZivid::PointXYZColorRGBAStruct which contains XYZ point and RGBA color packed together
 CZivid::PointXYZWPoint with four coordinates as float
 CZivid::PointZPoint with Z coordinate
 CZivid::Calibration::PoseDescribes 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::ProcessingProcessing related settings
 CZivid::Settings::ProcessingSettings related to processing of a capture, including filters and color balance
 CZivid::Projection::ProjectedImageA 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::RangeSpecify the minimum and maximum Z value that will be included
 CZivid::Settings2D::Processing::Color::Balance::RedDigital gain applied to red channel
 CZivid::Settings::Processing::Color::Balance::RedDigital gain applied to red channel
 CZivid::Settings::Processing::Filters::ReflectionContains a filter that removes points likely introduced by reflections (useful for shiny materials)
 CZivid::Settings::RegionOfInterestRemoves points outside the region of interest
 CZivid::Settings::Processing::Filters::Cluster::RemovalCluster removal filter
 CZivid::Settings::Processing::Filters::Experimental::ContrastDistortion::RemovalContrast distortion removal filter
 CZivid::Settings::Processing::Filters::Noise::RemovalDiscard points with signal-to-noise ratio (SNR) values below a threshold
 CZivid::Settings::Processing::Filters::Outlier::RemovalDiscard point if Euclidean distance to neighboring points is above a threshold
 CZivid::Settings::Processing::Filters::Reflection::RemovalDiscard points likely introduced by reflections (useful for shiny materials)
 CZivid::Settings::Processing::Filters::Hole::RepairFills in point cloud holes by interpolating remaining surrounding points
 CZivid::Settings::Processing::Filters::Noise::RepairGet 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::ResamplingSettings for changing the output resolution of the point cloud
 CZivid::ResolutionClass describing a resolution with a width and a height
 CZivid::CameraInfo::RevisionMajor/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::SamplingSampling settings
 CZivid::Settings::SamplingSampling settings
 CZivid::CameraInfo::SerialNumberThe serial number of the camera
 CZivid::SettingsSettings used when capturing with a Zivid camera
 CZivid::Settings2DSettings used when capturing 2D images with a Zivid camera
 CZivid::Settings::Processing::Filters::Smoothing::Gaussian::SigmaHigher values result in smoother point clouds (Standard deviation of the filter coefficients)
 CZivid::Settings::Processing::Filters::SmoothingSmoothing filters
 CZivid::SNRSignal-to-Noise ratio (SNR)
 CZivid::FrameInfo::SoftwareVersionThe version information for installed software at the time of image capture
 CZivid::Detail::EnvironmentInfo::UserToolchain::StandardLibraryInformation about what standard library implementation is being used
 CZivid::CameraState::StatusThis enum describes the current status of this camera. The enum can have the following values:
 CZivid::Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::StrengthStrength of correction. Higher values give more correction
 CZivid::Settings::Processing::Filters::Hole::Repair::StrictnessLevel 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::SubnetMaskIPv4 subnet mask (for example 255.255.255.0). Only used in manual mode
 CZivid::CaptureAssistant::SuggestSettingsParametersUsed 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::SuppressionReduce 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::SystemInfoInformation about the system that captured this frame
 CZivid::CameraState::TemperatureCurrent temperature(s)
 CZivid::Settings::Processing::Filters::Experimental::ContrastDistortion::Removal::ThresholdThreshold for removal. Higher values remove more points
 CZivid::Settings::Processing::Filters::Noise::Removal::ThresholdDiscard points with signal-to-noise ratio (SNR) below the given value
 CZivid::Settings::Processing::Filters::Outlier::Removal::ThresholdDiscard point if Euclidean distance to neighboring points is above the given value
 CZivid::FrameInfo::TimeStampThe time of frame capture
 CZivid::CameraInfo::UserDataInformation about user data capabilities of the camera
 CZivid::Detail::EnvironmentInfo::UserToolchainInformation about the current toolchain
 CZivid::VectorXYZVector with three coordinates as float
 CZivid::FrameInfo::SystemInfo::ComputeDevice::VendorCompute device vendor
 CZivid::Detail::EnvironmentInfo::Platform::OS::VersionOperating system version
 CZivid::Detail::EnvironmentInfo::UserToolchain::Compiler::VersionThe version of the compiler
 CZivid::Detail::EnvironmentInfo::UserToolchain::StandardLibrary::VersionThe version of the standard library implementation
 CZivid::Visualization::VisualizerSimple visualizer component for point clouds
 CZivid::Detail::EnvironmentInfo::WrapperThe wrapper being used, if any