Namespace aditof. More...

Classes
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...

struct	DepthSensorFrameContent
	Describes the content of a frame. For example: A frame could contain depth and IR data. More...

struct	DepthSensorFrameType
	Describes the type of entire frame that a depth sensor can capture and transmit. 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...

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...

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

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

struct	Point3I
	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...

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

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

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...

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	ConnectionType { ConnectionType::ON_TARGET, ConnectionType::USB, ConnectionType::NETWORK, ConnectionType::OFFLINE }
	Types of connections. More...

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

SDK_API bool	operator== (const FrameDataDetails &lhs, const FrameDataDetails &rhs)
	operator == 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...

SDK_API bool	operator!= (const FrameDetails &lhs, const FrameDetails &rhs)
	operator != 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 std::ostream &	operator<< (std::ostream &os, aditof::Adsd3500Status status)
	operator << which make possible to print out items from aditof::Adsd3500Status enum More...

std::ostream &	operator<< (std::ostream &o, const DepthSensorFrameContent &a)
	prints human readable frame content details

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

Detailed Description

Namespace aditof.

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.

◆ 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.

Definition at line 199 of file camera_definitions.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]

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

operator !=

Parameters

lhs	- LHS FrameDataDetails
rhs	- RHS FrameDataDetails

Returns: bool

◆ operator!=() [2/2]

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

operator !=

Parameters

lhs	- LHS FrameDetails
rhs	- RHS FrameDetails

Returns: bool

◆ operator<<() [1/2]

SDK_API 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&

◆ operator<<() [2/2]

SDK_API 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&

◆ operator==() [1/2]

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

operator ==

Parameters

lhs	- LHS FrameDataDetails
rhs	- RHS FrameDataDetails

Returns: bool

◆ operator==() [2/2]

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

operator ==

Parameters

lhs	- LHS FrameDetails
rhs	- RHS FrameDetails

Returns: bool

Classes

Typedefs

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ Adsd3500Status

◆ ConnectionType

◆ ImagerType

◆ Status

Function Documentation

◆ operator!=() [1/2]

◆ operator!=() [2/2]

◆ operator<<() [1/2]

◆ operator<<() [2/2]

◆ operator==() [1/2]

◆ operator==() [2/2]