hfl Namespace Reference

Classes
class	CameraCommander
	Implements the camera configuration and setup. More...
struct	PointCloudReturn
	HFL110DCU v1 frame struct. More...
struct	UdpPacketHeader
	HFL110DCU v1 ethernet packet header struct. More...
struct	CameraIntrinsics
	HFL110DCU v1 ethernet extrinsics struct. More...
struct	CameraExtrinsics
	HFL110DCU v1 ethernet extrinsics struct. More...
struct	UdpFrame
	HFL110DCU v1 ethernet frame struct. More...
struct	objGeo
	HFL110DCU v1 object geometry. More...
struct	objKin
	HFL110DCU v1 object kinematics. More...
struct	objState
	HFL110DCU v1 object state. More...
struct	objDyn
	HFL110DCU v1 object dynamic property. More...
struct	hflObj
	HFL110DCU v1 ethernet object struct. More...
class	HFL110DCU
	Implements the HFL110DCU camera image parsing and publishing. More...
class	BaseHFL110DCU
	Base class for the HFL110DCU cameras. More...
class	Frame
	Handles camera's frame data. More...
class	HflInterface
	Base class for all of the HFL cameras. More...
struct	PixelReturn
	Data structure for pixel returns. More...
class	Pixel
	Storages and handles the pixel data component. More...

Typedefs
using	Attribs_map = std::map< std::string, float >
	Mode parameters map. More...
using	Configs_map = std::map< std::string, Attribs_map >
	Camera modes map. More...
using	Setups_map = std::map< std::string, Configs_map >
	HFL cameras map. More...
using	Regs_bits_vec = std::vector< std::pair< std::string, int > >
	Register bit's values vector. More...
using	Registers_map = std::map< std::string, Regs_bits_vec >
	Cameras registers map. More...
using	Row = uint16_t
	Row number data type. More...
using	Col = uint16_t
	Column number data type. More...
using	Slice = std::vector< uint16_t >
	Pixel's Slice data type. More...

Enumerations
enum	commander_states { state_probe = 0 , state_init , state_done , state_error }
	Commander states enum. More...
enum	error_codes { no_error = 0 , frame_socket_error , object_socket_error , lut_socket_error }
	Error Codes. More...
enum	udp_port_types { frame_data , object_data , lut_data }
	UDP ports types. More...
enum	num_bits { eight_bit = 0 , ten_bit , twelve_bit , fourteen_bit }
	Number of Bits. More...

Variables
const uint16_t	FRAME_ROWS { 32 }
	Default frame rows. More...
const uint16_t	FRAME_COLUMNS { 128 }
	Default frame cols. More...
const uint16_t	PIXEL_RETURNS { 1 }
	Default frame cols. More...
const uint16_t	PIXEL_SLICES { 128 }
	Default frame cols. More...
const uint32_t	WORDS_PER_PACKET { 0x168 }
	Default words per UDP packet. More...
const uint8_t	INTENSITY_BITS { 5 }
	Default bits used for intensity. More...
const uint8_t	RANGE_BITS { 8 }
	Default bits used for range. More...
const uint8_t	RANGE_PRECISION_BITS { 6 }
	Default bits used for range presicion. More...
const uint8_t	INTENSITY_PUBLISH_BITS { 12 }
	Default bits used for intensity publishing. More...
const char	FRAME_ID [] = "hfl110dcu"
	Default frame ID. More...
const char	CAMERA_INTRINSICS [] = "min000000"
	Default camera intrinsics. More...
const uint32_t	EXPECTED_ADDRESS { 0xffffffff }
	Default expected memory address. More...
const Configs_map	REGS_OFFSET_ADDRS
	HFL cameras register addresses. More...
const Setups_map	CAMERA_MODELS
	HFL cameras memory maps and parameters. More...
const Registers_map	MODE_REGISTERS
	HFL cameras mode registers. More...

Typedef Documentation

Attribs_map

using hfl::Attribs_map = typedef std::map<std::string, float>

Mode parameters map.

Col

using hfl::Col = typedef uint16_t

Column number data type.

Configs_map

using hfl::Configs_map = typedef std::map<std::string, Attribs_map>

Camera modes map.

Registers_map

using hfl::Registers_map = typedef std::map<std::string, Regs_bits_vec>

Cameras registers map.

Regs_bits_vec

using hfl::Regs_bits_vec = typedef std::vector<std::pair<std::string, int> >

Register bit's values vector.

Row

using hfl::Row = typedef uint16_t

Row number data type.

Setups_map

using hfl::Setups_map = typedef std::map<std::string, Configs_map>

HFL cameras map.

Slice

using hfl::Slice = typedef std::vector<uint16_t>

Pixel's Slice data type.

Enumeration Type Documentation

commander_states

enum hfl::commander_states

Commander states enum.

Enumerator
state_probe
state_init
state_done
state_error

error_codes

enum hfl::error_codes

Error Codes.

Enumerator
no_error
frame_socket_error
object_socket_error
lut_socket_error

num_bits

enum hfl::num_bits

Number of Bits.

Enumerator
eight_bit
ten_bit
twelve_bit
fourteen_bit

udp_port_types

enum hfl::udp_port_types

UDP ports types.

Enumerator
frame_data
object_data
lut_data

Variable Documentation

CAMERA_INTRINSICS

const char hfl::CAMERA_INTRINSICS[] = "min000000"

Default camera intrinsics.

CAMERA_MODELS

const Setups_map hfl::CAMERA_MODELS

Initial value:

=
{
  { "hfl110dcuv1",
    {
      { "RI",
        {
          { "start_address", 0x00000000 }
        }
      }
    }
  }
  
}

HFL cameras memory maps and parameters.

EXPECTED_ADDRESS

const uint32_t hfl::EXPECTED_ADDRESS { 0xffffffff }

Default expected memory address.

FRAME_COLUMNS

const uint16_t hfl::FRAME_COLUMNS { 128 }

Default frame cols.

FRAME_ID

const char hfl::FRAME_ID[] = "hfl110dcu"

Default frame ID.

FRAME_ROWS

const uint16_t hfl::FRAME_ROWS { 32 }

Default frame rows.

INTENSITY_BITS

const uint8_t hfl::INTENSITY_BITS { 5 }

Default bits used for intensity.

INTENSITY_PUBLISH_BITS

const uint8_t hfl::INTENSITY_PUBLISH_BITS { 12 }

Default bits used for intensity publishing.

MODE_REGISTERS

const Registers_map hfl::MODE_REGISTERS

Initial value:

=
{
  { "hfl110dcuv1",
    {
        
    }
  }
}

HFL cameras mode registers.

PIXEL_RETURNS

const uint16_t hfl::PIXEL_RETURNS { 1 }

Default frame cols.

PIXEL_SLICES

const uint16_t hfl::PIXEL_SLICES { 128 }

Default frame cols.

RANGE_BITS

const uint8_t hfl::RANGE_BITS { 8 }

Default bits used for range.

RANGE_PRECISION_BITS

const uint8_t hfl::RANGE_PRECISION_BITS { 6 }

Default bits used for range presicion.

REGS_OFFSET_ADDRS

const Configs_map hfl::REGS_OFFSET_ADDRS

Initial value:

{
  { "hfl110dcu", {} }
}

HFL cameras register addresses.

WORDS_PER_PACKET

const uint32_t hfl::WORDS_PER_PACKET { 0x168 }

Default words per UDP packet.