Namespace aditof. More...

Classes
class	Adsd3500ModeSelector

class	ADSDErrors
	Error codes from the ADSD3500, ADSD3100, ADSD3030 Usage: Included with aditof/camera.h For example: ADSDErrors err; LOG(INFO) << err.GetStringADSD3500(0x0001);. More...

class	Camera
	Manipulates the underlying camera system. More...

struct	CameraDetails
	Describes the properties of a camera. More...

class	DepthSensorInterface
	Provides access to the low level functionality of the camera sensor. This includes sensor configuration as well as analog front end(AFE) configuration. More...

struct	DepthSensorModeDetails
	Describes the type of entire frame that a depth sensor can capture and transmit. More...

struct	DriverConfiguration
	Describes the configuration of the used driver. More...

class	Frame
	Frame of a camera. More...

struct	FrameDataDetails
	Describes the properties of a data that embedded within the frame. More...

struct	FrameDetails
	Describes the properties of a frame. More...

class	FrameHandler
	Handles operations on a frame such as saving it to file and creating a new frame with content read from file. More...

class	Gpio

struct	IntrinsicParameters
	Describes the intrinsic parameters of a camera. More...

struct	Metadata
	Contains all of the metadata components. More...

struct	Point3I_sdk
	Holds the xyz values of a frame. More...

struct	SensorDetails
	Provides details about the device. More...

class	SensorEnumeratorFactory
	Provides the means to construct different types of sensors enumerators. Based on the connection type (on target, USB, Network), different enumerators need to be used. More...

class	SensorEnumeratorInterface
	Can search for sensors and retrieve sensors by category. More...

class	System
	The TOF system that manages the cameras. More...

class	Utils

class	UtilsIni

class	V4lBufferAccessInterface
	Interface for operations on v4l buffer such as enquing and dequeing. More...

Typedefs
typedef std::function< void(Adsd3500Status)>	SensorInterruptCallback
	Callback for sensor interrupts. More...

Enumerations
enum	Adsd3500Status { Adsd3500Status::OK, Adsd3500Status::INVALID_MODE, Adsd3500Status::INVALID_JBLF_FILTER_SIZE, Adsd3500Status::UNSUPPORTED_COMMAND, Adsd3500Status::INVALID_MEMORY_REGION, Adsd3500Status::INVALID_FIRMWARE_CRC, Adsd3500Status::INVALID_IMAGER, Adsd3500Status::INVALID_CCB, Adsd3500Status::FLASH_HEADER_PARSE_ERROR, Adsd3500Status::FLASH_FILE_PARSE_ERROR, Adsd3500Status::SPIM_ERROR, Adsd3500Status::INVALID_CHIPID, Adsd3500Status::IMAGER_COMMUNICATION_ERROR, Adsd3500Status::IMAGER_BOOT_FAILURE, Adsd3500Status::FIRMWARE_UPDATE_COMPLETE, Adsd3500Status::NVM_WRITE_COMPLETE, Adsd3500Status::IMAGER_ERROR, Adsd3500Status::UNKNOWN_ERROR_ID }
	Status of the ADSD3500 sensor. More...

enum	api_Values { API_NOT_DEFINED, FIND_SENSORS, OPEN, START, STOP, GET_AVAILABLE_MODES, GET_MODE_DETAILS, SET_MODE, SET_MODE_BY_INDEX, GET_FRAME, GET_AVAILABLE_CONTROLS, SET_CONTROL, GET_CONTROL, INIT_TARGET_DEPTH_COMPUTE, ADSD3500_READ_CMD, ADSD3500_WRITE_CMD, ADSD3500_READ_PAYLOAD_CMD, ADSD3500_READ_PAYLOAD, ADSD3500_WRITE_PAYLOAD_CMD, ADSD3500_WRITE_PAYLOAD, ADSD3500_GET_STATUS, GET_INTERRUPTS, HANG_UP, GET_DEPTH_COMPUTE_PARAM, SET_DEPTH_COMPUTE_PARAM, SET_SENSOR_CONFIGURATION, GET_INI_ARRAY }

enum	ConnectionType { ConnectionType::ON_TARGET, ConnectionType::USB, ConnectionType::NETWORK, ConnectionType::OFFLINE }
	Types of connections. More...

enum	ImagerType { ImagerType::UNSET, ImagerType::ADSD3100, ImagerType::ADSD3030, ImagerType::ADTF3080 }
	Types of imagers. More...

enum	protocols { PROTOCOL_EXAMPLE, PROTOCOL_COUNT }

enum	Status { Status::OK, Status::BUSY, Status::UNREACHABLE, Status::INVALID_ARGUMENT, Status::UNAVAILABLE, Status::GENERIC_ERROR }
	Status of any operation that the TOF sdk performs. More...

Functions
SDK_API bool	operator!= (const FrameDataDetails &lhs, const FrameDataDetails &rhs)
	operator != More...

SDK_API bool	operator!= (const FrameDetails &lhs, const FrameDetails &rhs)
	operator != More...

std::ostream &	operator<< (std::ostream &o, const DepthSensorModeDetails &a)
	prints human readable frame details More...

std::ostream &	operator<< (std::ostream &o, const struct Metadata &meta)
	prints human readable metadata structure More...

SDK_API std::ostream &	operator<< (std::ostream &os, aditof::Adsd3500Status status)
	operator << which make possible to print out items from aditof::Adsd3500Status enum More...

SDK_API std::ostream &	operator<< (std::ostream &os, aditof::Status status)
	operator << which make possible to print out items from aditof::Status enum More...

SDK_API bool	operator== (const FrameDataDetails &lhs, const FrameDataDetails &rhs)
	operator == More...

SDK_API bool	operator== (const FrameDetails &lhs, const FrameDetails &rhs)
	operator == More...

Variables
const std::map< ImagerType, std::string >	ControlValue
	Types of imagers based on ControlValue. More...

const std::map< ImagerType, std::string >	imagerType
	Types of imagers. More...

static const unsigned int	USB_FRAME_HEIGHT = 480

static const unsigned int	USB_FRAME_WIDTH = 640

Detailed Description

Namespace aditof.

Typedef Documentation

◆ SensorInterruptCallback

typedef std::function<void(Adsd3500Status)> aditof::SensorInterruptCallback

Callback for sensor interrupts.

Definition at line 50 of file depth_sensor_interface.h.

Enumeration Type Documentation

◆ Adsd3500Status

enum aditof::Adsd3500Status

strong

Status of the ADSD3500 sensor.

Enumerator
OK	Success.
INVALID_MODE	Invalid mode has been set.
INVALID_JBLF_FILTER_SIZE	Invalid JBLF filter size has been set.
UNSUPPORTED_COMMAND	The command is not supported by the ADSD3500.
INVALID_MEMORY_REGION	Invalid memory region.
INVALID_FIRMWARE_CRC	Invalid firmware CRC.
INVALID_IMAGER	Invalid imager.
INVALID_CCB	Invalid CCB.
FLASH_HEADER_PARSE_ERROR	Flash header parse error.
FLASH_FILE_PARSE_ERROR	Flash file parse error.
SPIM_ERROR	SPIM error.
INVALID_CHIPID	Invalid chip ID.
IMAGER_COMMUNICATION_ERROR	Imager communication error.
IMAGER_BOOT_FAILURE	Imager boot failure.
FIRMWARE_UPDATE_COMPLETE	The firmware update action has completed.
NVM_WRITE_COMPLETE	The write action to the NVM has completed.
IMAGER_ERROR	Imager error.
UNKNOWN_ERROR_ID	Unknown ID read from ADSD3500.

Definition at line 61 of file status_definitions.h.

◆ api_Values

enum aditof::api_Values

Enumerator
API_NOT_DEFINED
FIND_SENSORS
OPEN
START
STOP
GET_AVAILABLE_MODES
GET_MODE_DETAILS
SET_MODE
SET_MODE_BY_INDEX
GET_FRAME
GET_AVAILABLE_CONTROLS
SET_CONTROL
GET_CONTROL
INIT_TARGET_DEPTH_COMPUTE
ADSD3500_READ_CMD
ADSD3500_WRITE_CMD
ADSD3500_READ_PAYLOAD_CMD
ADSD3500_READ_PAYLOAD
ADSD3500_WRITE_PAYLOAD_CMD
ADSD3500_WRITE_PAYLOAD
ADSD3500_GET_STATUS
GET_INTERRUPTS
HANG_UP
GET_DEPTH_COMPUTE_PARAM
SET_DEPTH_COMPUTE_PARAM
SET_SENSOR_CONFIGURATION
GET_INI_ARRAY

Definition at line 39 of file gpio.h.

◆ ConnectionType

enum aditof::ConnectionType

strong

Types of connections.

Enumerator
ON_TARGET	on the target, direct sysfs access
USB	connects to target via USB
NETWORK	connects to target via Network
OFFLINE	connects to a software module, no hardware involved

Definition at line 44 of file connections.h.

◆ ImagerType

enum aditof::ImagerType

strong

Types of imagers.

Enumerator
UNSET	Value for when the type is unset.
ADSD3100	The ADSD3100 imager.
ADSD3030	The ADSD3030 imager.
ADTF3080	The ADTF3080 imager.

Definition at line 200 of file camera_definitions.h.

◆ protocols

enum aditof::protocols

Enumerator
PROTOCOL_EXAMPLE
PROTOCOL_COUNT

Definition at line 69 of file gpio.h.

◆ Status

enum aditof::Status

strong

Status of any operation that the TOF sdk performs.

Enumerator
OK	Success.
BUSY	Device or resource is busy.
UNREACHABLE	Device or resource is unreachable.
INVALID_ARGUMENT	Invalid arguments provided.
UNAVAILABLE	The requested action or resource is unavailable.
GENERIC_ERROR	An error occured but there are no details available.

Definition at line 48 of file status_definitions.h.

Function Documentation

◆ operator!=() [1/2]

bool aditof::operator!=	(	const FrameDataDetails &	lhs,
		const FrameDataDetails &	rhs
	)

operator !=

Parameters

lhs	- LHS FrameDataDetails
rhs	- RHS FrameDataDetails

Returns: bool

Definition at line 41 of file frame_operations.cpp.

◆ operator!=() [2/2]

bool aditof::operator!=	(	const FrameDetails &	lhs,
		const FrameDetails &	rhs
	)

operator !=

Parameters

lhs	- LHS FrameDetails
rhs	- RHS FrameDetails

Returns: bool

Definition at line 50 of file frame_operations.cpp.

◆ operator<<() [1/4]

std::ostream& aditof::operator<<	(	std::ostream &	o,
		const DepthSensorModeDetails &	a
	)

inline

prints human readable frame details

Definition at line 181 of file sensor_definitions.h.

◆ operator<<() [2/4]

std::ostream& aditof::operator<<	(	std::ostream &	o,
		const struct Metadata &	meta
	)

inline

prints human readable metadata structure

Definition at line 262 of file frame_definitions.h.

◆ operator<<() [3/4]

std::ostream & aditof::operator<<	(	std::ostream &	os,
		aditof::Adsd3500Status	status
	)

operator << which make possible to print out items from aditof::Adsd3500Status enum

Parameters

os	- output streamm
status	- an item of type aditof::Adsd3500Status

Returns: std::ostream&

Definition at line 62 of file status_definitions.cpp.

◆ operator<<() [4/4]

std::ostream & aditof::operator<<	(	std::ostream &	os,
		aditof::Status	status
	)

operator << which make possible to print out items from aditof::Status enum

Parameters

os	- output streamm
status	- an item of type aditof::Status

Returns: std::ostream&

Definition at line 36 of file status_definitions.cpp.

◆ operator==() [1/2]

bool aditof::operator==	(	const FrameDataDetails &	lhs,
		const FrameDataDetails &	rhs
	)

operator ==

Parameters

lhs	- LHS FrameDataDetails
rhs	- RHS FrameDataDetails

Returns: bool

Definition at line 36 of file frame_operations.cpp.

◆ operator==() [2/2]

bool aditof::operator==	(	const FrameDetails &	lhs,
		const FrameDetails &	rhs
	)

operator ==

Parameters

lhs	- LHS FrameDetails
rhs	- RHS FrameDetails

Returns: bool

Definition at line 45 of file frame_operations.cpp.

Variable Documentation

◆ ControlValue

const std::map<ImagerType, std::string> aditof::ControlValue

Initial value:

{
    {ImagerType::ADSD3100, "1"},
    {ImagerType::ADSD3030, "2"},
    {ImagerType::ADTF3080, "3"}}

Types of imagers based on ControlValue.

Definition at line 211 of file camera_definitions.h.

◆ imagerType

const std::map<ImagerType, std::string> aditof::imagerType

Initial value:

{
    {ImagerType::ADSD3100, "adsd3100"},
    {ImagerType::ADSD3030, "adsd3030"},
    {ImagerType::ADTF3080, "adtf3080"}}

Types of imagers.

Definition at line 218 of file camera_definitions.h.

◆ USB_FRAME_HEIGHT

const unsigned int aditof::USB_FRAME_HEIGHT = 480

static

Definition at line 41 of file usb_depth_sensor.h.

◆ USB_FRAME_WIDTH

const unsigned int aditof::USB_FRAME_WIDTH = 640

static

Definition at line 40 of file usb_depth_sensor.h.

Classes

Typedefs

Enumerations

Functions

Variables

Detailed Description

Typedef Documentation

◆ SensorInterruptCallback

Enumeration Type Documentation

◆ Adsd3500Status

◆ api_Values

◆ ConnectionType

◆ ImagerType

◆ protocols

◆ Status

Function Documentation

◆ operator!=() [1/2]

◆ operator!=() [2/2]

◆ operator<<() [1/4]

◆ operator<<() [2/4]

◆ operator<<() [3/4]

◆ operator<<() [4/4]

◆ operator==() [1/2]

◆ operator==() [2/2]

Variable Documentation

◆ ControlValue

◆ imagerType

◆ USB_FRAME_HEIGHT

◆ USB_FRAME_WIDTH