LibMultiSense
LibMultiSense Documentation
MultiSenseTypes.hh File Reference

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

#include <stdint.h>
#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

class  crl::multisense::DirectedStream
 Class used to request that MultiSense data be sent to a 3rd-party stream destination (UDP port), currently supported only by CRL's Monocular IP Camera. More...
 
class  crl::multisense::HeaderBase
 Base Header class for sensor callbacks. More...
 
class  crl::multisense::image::Header
 Class containing image Header information common to all image types. More...
 
class  crl::multisense::image::Config
 Class used to store a specific camera configuration. More...
 
class  crl::multisense::image::Calibration
 Class used For querying/setting camera calibration. More...
 
class  crl::multisense::image::Calibration::Data
 Class to store camera calibration matrices. More...
 
class  crl::multisense::image::SensorCalibration
 Class to store sensor gains used to perform a DC level adjustment to calibrate the left imager to the right imager. More...
 
class  crl::multisense::image::Histogram
 Class which stores a image histogram from a camera image. More...
 
class  crl::multisense::lidar::Header
 Class which stores Header information for a lidar scan. More...
 
class  crl::multisense::lidar::Calibration
 Class used to store a laser calibration. More...
 
class  crl::multisense::lighting::Config
 Class used to store a specific lighting configuration. More...
 
class  crl::multisense::lighting::SensorStatus
 A external sensor status. More...
 
class  crl::multisense::pps::Header
 Class containing Header information for a PPS event. More...
 
class  crl::multisense::imu::Sample
 Class containing a single IMU sample. More...
 
class  crl::multisense::imu::Header
 Class containing Header information for an IMU callback. More...
 
class  crl::multisense::imu::Info
 Class containing detailed information for the IMU. More...
 
struct  crl::multisense::imu::Info::RateEntry
 Class containing a one valid IMU rate configuration. More...
 
struct  crl::multisense::imu::Info::RangeEntry
 Class containing a one valid IMU range configuration. More...
 
class  crl::multisense::imu::Config
 Class used to store a specific IMU configuration. More...
 
class  crl::multisense::system::DeviceMode
 Class used query the device modes for a given sensor. More...
 
class  crl::multisense::system::VersionInfo
 Class containing version info for a specific sensor. More...
 
class  crl::multisense::system::PcbInfo
 Class used to store PCB information for the various circuit boards in a sensor. More...
 
class  crl::multisense::system::DeviceInfo
 Class used to store device information specific to a sensor. More...
 
class  crl::multisense::system::NetworkConfig
 Class containing the network configuration for a specific sensor. More...
 
class  crl::multisense::system::StatusMessage
 Class containing status information for a particular device. More...
 
class  crl::multisense::system::ExternalCalibration
 A external calibration associated with the MultiSense. More...
 

Namespaces

 crl
 
 crl::multisense
 
 crl::multisense::image
 
 crl::multisense::lidar
 
 crl::multisense::lighting
 
 crl::multisense::pps
 
 crl::multisense::imu
 
 crl::multisense::system
 

Macros

#define CRL_CONSTEXPR   const
 
#define MULTISENSE_API
 

Typedefs

typedef uint32_t crl::multisense::VersionType
 Sensor version typedef used to store a given version number. More...
 
typedef int32_t crl::multisense::Status
 General status typdef used as a return value for get/set crl::multisense::Channel methods. More...
 
typedef uint32_t crl::multisense::DataSource
 Data sources typedef representing the various data sources available from sensors in the MultiSense-S line. More...
 
typedef uint32_t crl::multisense::TriggerSource
 
typedef void(* crl::multisense::image::Callback) (const Header &header, void *userDataP)
 Function pointer for receiving callbacks of image data. More...
 
typedef uint32_t crl::multisense::lidar::RangeType
 The type of a single laser range measurement. More...
 
typedef uint32_t crl::multisense::lidar::IntensityType
 The type of a single laser intensity measurement. More...
 
typedef void(* crl::multisense::lidar::Callback) (const Header &header, void *userDataP)
 Function pointer for receiving callbacks of lidar data. More...
 
typedef void(* crl::multisense::pps::Callback) (const Header &header, void *userDataP)
 Function pointer for receiving callbacks for PPS events. More...
 
typedef void(* crl::multisense::imu::Callback) (const Header &header, void *userDataP)
 Function pointer for receiving callbacks for IMU data. More...
 

Variables

static CRL_CONSTEXPR Status crl::multisense::Status_Ok = 0
 
static CRL_CONSTEXPR Status crl::multisense::Status_TimedOut = -1
 
static CRL_CONSTEXPR Status crl::multisense::Status_Error = -2
 
static CRL_CONSTEXPR Status crl::multisense::Status_Failed = -3
 
static CRL_CONSTEXPR Status crl::multisense::Status_Unsupported = -4
 
static CRL_CONSTEXPR Status crl::multisense::Status_Unknown = -5
 
static CRL_CONSTEXPR Status crl::multisense::Status_Exception = -6
 
static CRL_CONSTEXPR DataSource crl::multisense::Source_Unknown = 0
 
static CRL_CONSTEXPR DataSource crl::multisense::Source_All = 0xffffffff
 
static CRL_CONSTEXPR DataSource crl::multisense::Source_Raw_Left = (1<<0)
 
static CRL_CONSTEXPR DataSource crl::multisense::Source_Raw_Right = (1<<1)
 
static CRL_CONSTEXPR DataSource crl::multisense::Source_Luma_Left = (1<<2)
 
static CRL_CONSTEXPR DataSource crl::multisense::Source_Luma_Right = (1<<3)
 
static CRL_CONSTEXPR DataSource crl::multisense::Source_Luma_Rectified_Left = (1<<4)
 
static CRL_CONSTEXPR DataSource crl::multisense::Source_Luma_Rectified_Right = (1<<5)
 
static CRL_CONSTEXPR DataSource crl::multisense::Source_Chroma_Left = (1<<6)
 
static CRL_CONSTEXPR DataSource crl::multisense::Source_Chroma_Right = (1<<7)
 
static CRL_CONSTEXPR DataSource crl::multisense::Source_Disparity = (1<<10)
 
static CRL_CONSTEXPR DataSource crl::multisense::Source_Disparity_Left = (1<<10)
 
static CRL_CONSTEXPR DataSource crl::multisense::Source_Disparity_Right = (1<<11)
 
static CRL_CONSTEXPR DataSource crl::multisense::Source_Disparity_Cost = (1<<12)
 
static CRL_CONSTEXPR DataSource crl::multisense::Source_Jpeg_Left = (1<<16)
 
static CRL_CONSTEXPR DataSource crl::multisense::Source_Rgb_Left = (1<<17)
 
static CRL_CONSTEXPR DataSource crl::multisense::Source_Lidar_Scan = (1<<24)
 
static CRL_CONSTEXPR DataSource crl::multisense::Source_Imu = (1<<25)
 
static CRL_CONSTEXPR DataSource crl::multisense::Source_Pps = (1<<26)
 
static CRL_CONSTEXPR TriggerSource crl::multisense::Trigger_Internal = 0
 Default internal trigger source. More...
 
static CRL_CONSTEXPR TriggerSource crl::multisense::Trigger_External = 1
 External OPTO_RX trigger input. More...
 
static CRL_CONSTEXPR uint32_t crl::multisense::lighting::MAX_LIGHTS = 8
 The maximum number of lights for a given sensor. More...
 
static CRL_CONSTEXPR float crl::multisense::lighting::MAX_DUTY_CYCLE = 100.0
 The maximum duty cycle for adjusting light intensity. More...
 
static CRL_CONSTEXPR float crl::multisense::lighting::MAX_AMBIENT_LIGHTING = 100.0
 The maxmimum value of the ambient light sensor. More...
 

Detailed Description

Copyright 2013 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): 2013-05-06, ekrat.nosp@m.zer@.nosp@m.carne.nosp@m.gier.nosp@m.oboti.nosp@m.cs.c.nosp@m.om, PR1044, Created file.

Definition in file MultiSenseTypes.hh.

Macro Definition Documentation

#define CRL_CONSTEXPR   const

Definition at line 52 of file MultiSenseTypes.hh.

#define MULTISENSE_API

Definition at line 65 of file MultiSenseTypes.hh.