LibMultiSense
LibMultiSense Documentation
MultiSenseTypes.hh File Reference
#include <array>
#include <chrono>
#include <cstdint>
#include <map>
#include <memory>
#include <optional>
#include <stdexcept>
#include <string>
#include <vector>
Include dependency graph for MultiSenseTypes.hh:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  multisense::CameraCalibration
 
struct  multisense::StereoCalibration
 
struct  multisense::Image
 Represents a single image plus metadata. More...
 
struct  multisense::ImageFrame
 A frame containing multiple images (indexed by DataSource). More...
 
struct  multisense::ImuSample
 A single IMU sample from the camera. More...
 
struct  multisense::ImuSample::Measurement
 A generic measurement for a 3-axis IMU. More...
 
struct  multisense::ImuFrame
 A collection of IMU samples from the camera. More...
 
struct  multisense::ImuRate
 A sample rate, and what impact it has on bandwidth. More...
 
struct  multisense::ImuRange
 The range for each sensor along with the corresponding sampling resolution. More...
 
struct  multisense::MultiSenseConfig
 Complete configuration object for configuring the MultiSense. More...
 
struct  multisense::MultiSenseConfig::StereoConfig
 Stereo specific configuration. More...
 
struct  multisense::MultiSenseConfig::ManualExposureConfig
 Manual exposure specific configuration. More...
 
struct  multisense::MultiSenseConfig::AutoExposureRoiConfig
 Auto-exposure Region-of-Interest (ROI) specific configuration. More...
 
struct  multisense::MultiSenseConfig::AutoExposureConfig
 Auto-exposure specific configuration. More...
 
struct  multisense::MultiSenseConfig::ManualWhiteBalanceConfig
 Manual white balance specific configuration. More...
 
struct  multisense::MultiSenseConfig::AutoWhiteBalanceConfig
 Auto white balance specific configuration. More...
 
struct  multisense::MultiSenseConfig::ImageConfig
 Image specific configuration. More...
 
struct  multisense::MultiSenseConfig::AuxConfig
 Image specific configuration for the Aux imager. More...
 
struct  multisense::MultiSenseConfig::TimeConfig
 Config for time-based controls. More...
 
struct  multisense::MultiSenseConfig::NetworkTransmissionConfig
 Config for transmitting packets from the MultiSense to the host. More...
 
struct  multisense::MultiSenseConfig::ImuConfig
 Config for the IMU sensor. More...
 
struct  multisense::MultiSenseConfig::ImuConfig::OperatingMode
 Config for a specific IMU operating mode. More...
 
struct  multisense::MultiSenseConfig::LightingConfig
 Lighting configuration for the camera. More...
 
struct  multisense::MultiSenseConfig::LightingConfig::InternalConfig
 Lighting config for lights integrated into the MultiSense. More...
 
struct  multisense::MultiSenseConfig::LightingConfig::ExternalConfig
 Lighting config for lights driven by GPIO outputs from the MultiSense. More...
 
struct  multisense::MultiSenseStatus
 Consolidated status information which can be queried on demand from the MultiSense. More...
 
struct  multisense::MultiSenseStatus::PtpStatus
 
struct  multisense::MultiSenseStatus::CameraStatus
 
struct  multisense::MultiSenseStatus::TemperatureStatus
 
struct  multisense::MultiSenseStatus::PowerStatus
 
struct  multisense::MultiSenseStatus::ClientNetworkStatus
 
struct  multisense::MultiSenseStatus::TimeStatus
 
struct  multisense::MultiSenseInfo
 Static status info for the MultiSense. More...
 
struct  multisense::MultiSenseInfo::NetworkInfo
 The network configuration for the MultiSense. More...
 
struct  multisense::MultiSenseInfo::DeviceInfo
 The Device information associated with the MultiSense. More...
 
struct  multisense::MultiSenseInfo::DeviceInfo::PcbInfo
 Info for the PCBs contained in the unit. More...
 
struct  multisense::MultiSenseInfo::Version
 Convenience wrapper for a version number See https://semver.org/. More...
 
struct  multisense::MultiSenseInfo::SensorVersion
 Version information for the MultiSense. More...
 
struct  multisense::MultiSenseInfo::SupportedOperatingMode
 A valid operating mode for the MultiSense. More...
 
struct  multisense::MultiSenseInfo::ImuInfo
 Information about the IMU onboard the MultiSense. More...
 
struct  multisense::MultiSenseInfo::ImuInfo::Source
 Info about the available IMU configurations. More...
 

Namespaces

 multisense
 

Macros

#define MULTISENSE_API
 

Typedefs

using multisense::TimeT = std::chrono::time_point< std::chrono::system_clock, std::chrono::nanoseconds >
 

Enumerations

enum  multisense::Status : uint8_t {
  multisense::Status::UNKNOWN, multisense::Status::OK, multisense::Status::TIMEOUT, multisense::Status::INTERNAL_ERROR,
  multisense::Status::FAILED, multisense::Status::UNSUPPORTED, multisense::Status::EXCEPTION, multisense::Status::UNINITIALIZED,
  multisense::Status::INCOMPLETE_APPLICATION
}
 
enum  multisense::DataSource : uint16_t {
  multisense::DataSource::UNKNOWN, multisense::DataSource::ALL, multisense::DataSource::LEFT_MONO_RAW, multisense::DataSource::RIGHT_MONO_RAW,
  multisense::DataSource::LEFT_MONO_COMPRESSED, multisense::DataSource::RIGHT_MONO_COMPRESSED, multisense::DataSource::LEFT_RECTIFIED_RAW, multisense::DataSource::RIGHT_RECTIFIED_RAW,
  multisense::DataSource::LEFT_RECTIFIED_COMPRESSED, multisense::DataSource::RIGHT_RECTIFIED_COMPRESSED, multisense::DataSource::LEFT_DISPARITY_RAW, multisense::DataSource::LEFT_DISPARITY_COMPRESSED,
  multisense::DataSource::AUX_COMPRESSED, multisense::DataSource::AUX_RECTIFIED_COMPRESSED, multisense::DataSource::AUX_LUMA_RAW, multisense::DataSource::AUX_LUMA_RECTIFIED_RAW,
  multisense::DataSource::AUX_CHROMA_RAW, multisense::DataSource::AUX_CHROMA_RECTIFIED_RAW, multisense::DataSource::AUX_RAW, multisense::DataSource::AUX_RECTIFIED_RAW,
  multisense::DataSource::COST_RAW, multisense::DataSource::IMU
}
 Identifies which camera or data source the image is from. More...
 
enum  multisense::ColorImageEncoding : uint16_t { multisense::ColorImageEncoding::NONE, multisense::ColorImageEncoding::YCBCR420 }
 

Detailed Description

Copyright 2013-2025 Carnegie Robotics, LLC 4501 Hatfield Street, Pittsburgh, PA 15201 http://www.carnegierobotics.com

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  • Neither the name of the Carnegie Robotics, LLC nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL CARNEGIE ROBOTICS, LLC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Significant history (date, user, job code, action): 2024-12-24, malva.nosp@m.rado.nosp@m.@carn.nosp@m.egie.nosp@m.robot.nosp@m.ics..nosp@m.com, IRAD, Created file.

Definition in file MultiSenseTypes.hh.

Macro Definition Documentation

◆ MULTISENSE_API

#define MULTISENSE_API

Definition at line 57 of file MultiSenseTypes.hh.