Time-of-Flight-SDK
Classes | Typedefs | Enumerations | Functions
aditof Namespace Reference

Namespace aditof. More...

Classes

struct  BufferInfo
 Provides extra details for the frame buffer. More...
 
class  Camera
 Manipulates the underlying camera system. More...
 
struct  CameraDetails
 Describes the properties of a camera. More...
 
struct  DepthParameters
 Describes the depth parameters 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...
 
class  Frame
 Frame of a camera. More...
 
struct  FrameDetails
 Describes the properties of a frame. More...
 
struct  IntrinsicParameters
 Describes the intrinsic parameters of a camera. 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  StorageInterface
 Interface for storage of data. For example: EEPROM, Flash, file on disk, etc. More...
 
class  System
 The TOF system that manages the cameras. More...
 
class  TemperatureSensorInterface
 Interface for a temperature sensor. More...
 

Typedefs

typedef std::function< void(Status, Frame *)> FrameUpdateCallback
 Callback for frame updates.
 

Enumerations

enum  FrameDataType {
  FrameDataType::FULL_DATA,
  FrameDataType::DEPTH,
  FrameDataType::IR,
  FrameDataType::RGB
}
 Types of data that a frame can contain. 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  ConnectionType {
  ConnectionType::ON_TARGET,
  ConnectionType::USB,
  ConnectionType::NETWORK
}
 Types of connections. More...
 
enum  CameraType {
  CameraType::AD_96TOF1_EBZ,
  CameraType::AD_FXTOF1_EBZ,
  CameraType::SMART_3D_CAMERA
}
 Types of cameras. More...
 

Functions

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

Detailed Description

Namespace aditof.

Enumeration Type Documentation

◆ CameraType

enum aditof::CameraType
strong

Types of cameras.

Enumerator
AD_96TOF1_EBZ 

AD-96TOF1-EBZ camera.

AD_FXTOF1_EBZ 

AD-FXTOF1-EBZ camera.

SMART_3D_CAMERA 

3D Smart camera

Definition at line 46 of file target_sdk_definitions.h.

◆ ConnectionType

Types of connections.

Enumerator
ON_TARGET 

on the target, direct sysfs access

USB 

connects to target via USB

NETWORK 

connects to target via Network

Definition at line 44 of file connections.h.

◆ FrameDataType

enum aditof::FrameDataType
strong

Types of data that a frame can contain.

Enumerator
FULL_DATA 

Raw information.

DEPTH 

Depth information.

IR 

Infrared information.

RGB 

RGB information.

Definition at line 46 of file frame_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 44 of file status_definitions.h.

Function Documentation

◆ operator!=()

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

operator !=

Parameters
lhs- LHS FrameDetails
rhs- RHS FrameDetails
Returns
bool

◆ operator==()

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

operator ==

Parameters
lhs- LHS FrameDetails
rhs- RHS FrameDetails
Returns
bool