libfreenect2 Namespace Reference

Namespaces
namespace	vision

Classes
struct	CalibrationData
	Self-contained factory calibration snapshot for recording and replay. More...
class	CalibrationProfile
	Versioned user calibration for conventional depth-to-color geometry. More...
struct	CalibrationQualityMetrics
	Aggregate validation measurements retained in a canonical profile. More...
class	CpuPacketPipeline
	Pipeline with CPU depth processing. More...
class	CudaKdePacketPipeline
class	CudaPacketPipeline
struct	DepthCalibrationRoi
	Pixel rectangle used to measure a planar calibration target. More...
struct	DepthCalibrationSample
	One known-distance observation from one decoded depth frame. More...
struct	DepthCorrectionProfile
	Opt-in linear correction for decoded depth measurements in millimeters. More...
struct	DepthRoiStatistics
	Robust statistics for valid depth pixels in one frame and ROI. More...
struct	DeviceRuntimeStatistics
	Thread-safe snapshot of one device object's runtime health. More...
class	DumpPacketPipeline
class	Frame
	Frame format and metadata. More...
class	FrameListener
	Callback interface to receive new frames. More...
class	Freenect2
	Library context to find and open devices. More...
class	Freenect2Device
	Device control. More...
class	Freenect2Replay
	Library context to create and open replay devices. More...
struct	LedSettings
class	Logger
	Provide interfaces to receive log messages. More...
class	MetalPacketPipeline
	Pipeline with Metal GPU depth processing (Apple platforms). More...
class	OpenCLKdePacketPipeline
class	OpenCLPacketPipeline
	Pipeline with OpenCL depth processing. More...
class	OpenGLPacketPipeline
	Pipeline with OpenGL depth processing. More...
class	PacketPipeline
	Base class for other pipeline classes. More...
struct	PacketPipelineConfig
	Per-pipeline color decoder policy. More...
struct	ProjectiveCameraModel
	Resolution, pinhole intrinsics, and distortion for one camera. More...
class	ProjectiveRegistration
	Conventional extrinsic/projective depth registration. More...
struct	ProjectiveRegistrationOptions
class	RecordingWriter
	Bounded, thread-safe writer for raw Kinect recording directories. More...
class	Registration
	Combine frames of depth and color camera. More...
struct	ReplayOptions
	Options for manifest-directory replay. More...
struct	RigidTransform
	Rigid transform with row-major rotation and translation in meters. More...
struct	StreamRuntimeStatistics
	Lifetime counters and most recent metadata for one decoded stream. More...
class	SyncMultiFrameListener
	Collect multiple types of frames. More...
class	TimestampAlignedFrameListener
	Collect timestamp-aligned combinations of multiple frame types. More...

Typedefs
typedef std::map< Frame::Type, Frame * >	FrameMap
	Storage of multiple different types of frames.

Enumerations
enum class	DistortionModel : uint32_t { None = 0 , BrownConrady5 = 1 , Rational8 = 2 }
	Distortion conventions supported by conventional projective calibration. More...
enum	ColorSettingCommandType {   COLOR_SETTING_SET_EXPOSURE_MODE = 0 , COLOR_SETTING_SET_INTEGRATION_TIME = 1 , COLOR_SETTING_GET_INTEGRATION_TIME = 2 , COLOR_SETTING_SET_WHITE_BALANCE_MODE = 10 ,   COLOR_SETTING_SET_RED_CHANNEL_GAIN = 11 , COLOR_SETTING_SET_GREEN_CHANNEL_GAIN = 12 , COLOR_SETTING_SET_BLUE_CHANNEL_GAIN = 13 , COLOR_SETTING_GET_RED_CHANNEL_GAIN = 14 ,   COLOR_SETTING_GET_GREEN_CHANNEL_GAIN = 15 , COLOR_SETTING_GET_BLUE_CHANNEL_GAIN = 16 , COLOR_SETTING_SET_EXPOSURE_TIME_MS = 17 , COLOR_SETTING_GET_EXPOSURE_TIME_MS = 18 ,   COLOR_SETTING_SET_DIGITAL_GAIN = 19 , COLOR_SETTING_GET_DIGITAL_GAIN = 20 , COLOR_SETTING_SET_ANALOG_GAIN = 21 , COLOR_SETTING_GET_ANALOG_GAIN = 22 ,   COLOR_SETTING_SET_EXPOSURE_COMPENSATION = 23 , COLOR_SETTING_GET_EXPOSURE_COMPENSATION = 24 , COLOR_SETTING_SET_ACS = 25 , COLOR_SETTING_GET_ACS = 26 ,   COLOR_SETTING_SET_EXPOSURE_METERING_MODE = 27 , COLOR_SETTING_SET_EXPOSURE_METERING_ZONES = 28 , COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_0_WEIGHT = 29 , COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_1_WEIGHT = 30 ,   COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_2_WEIGHT = 31 , COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_3_WEIGHT = 32 , COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_4_WEIGHT = 33 , COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_5_WEIGHT = 34 ,   COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_6_WEIGHT = 35 , COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_7_WEIGHT = 36 , COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_8_WEIGHT = 37 , COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_9_WEIGHT = 38 ,   COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_10_WEIGHT = 39 , COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_11_WEIGHT = 40 , COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_12_WEIGHT = 41 , COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_13_WEIGHT = 42 ,   COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_14_WEIGHT = 43 , COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_15_WEIGHT = 44 , COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_16_WEIGHT = 45 , COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_17_WEIGHT = 46 ,   COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_18_WEIGHT = 47 , COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_19_WEIGHT = 48 , COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_20_WEIGHT = 49 , COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_21_WEIGHT = 50 ,   COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_22_WEIGHT = 51 , COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_23_WEIGHT = 52 , COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_24_WEIGHT = 53 , COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_25_WEIGHT = 54 ,   COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_26_WEIGHT = 55 , COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_27_WEIGHT = 56 , COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_28_WEIGHT = 57 , COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_29_WEIGHT = 58 ,   COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_30_WEIGHT = 59 , COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_31_WEIGHT = 60 , COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_32_WEIGHT = 61 , COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_33_WEIGHT = 62 ,   COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_34_WEIGHT = 63 , COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_35_WEIGHT = 64 , COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_36_WEIGHT = 65 , COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_37_WEIGHT = 66 ,   COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_38_WEIGHT = 67 , COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_39_WEIGHT = 68 , COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_40_WEIGHT = 69 , COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_41_WEIGHT = 70 ,   COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_42_WEIGHT = 71 , COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_43_WEIGHT = 72 , COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_44_WEIGHT = 73 , COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_45_WEIGHT = 74 ,   COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_46_WEIGHT = 75 , COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_47_WEIGHT = 76 , COLOR_SETTING_SET_MAX_ANALOG_GAIN_CAP = 77 , COLOR_SETTING_SET_MAX_DIGITAL_GAIN_CAP = 78 ,   COLOR_SETTING_SET_FLICKER_FREE_FREQUENCY = 79 , COLOR_SETTING_GET_EXPOSURE_MODE = 80 , COLOR_SETTING_GET_WHITE_BALANCE_MODE = 81 , COLOR_SETTING_SET_FRAME_RATE = 82 ,   COLOR_SETTING_GET_FRAME_RATE = 83 }
enum	DeviceState {   DeviceCreated , DeviceOpen , DeviceStreaming , DeviceDisconnected ,   DeviceError , DeviceClosed }
	Observable device lifecycle state. More...
enum class	RegistrationRasterization : uint32_t { Nearest = 0 , FourNeighborSplat = 1 }

Functions
bool	computeDepthRoiStatistics (const Frame &depth, const DepthCalibrationRoi &roi, DepthRoiStatistics &statistics, std::string *error=0)
	Compute the median and median absolute deviation for one decoded depth frame.
bool	fitDepthCorrectionProfile (const std::vector< DepthCalibrationSample > &samples, DepthCorrectionProfile &profile, std::string *error=0)
	Fit an offset-only profile for one distance or a linear profile for two or more.
std::string	getVersion ()
	Runtime identity of the loaded library.
uint32_t	getApiVersion ()
std::string	getBuildRevision ()
Logger *	createConsoleLogger (Logger::Level level)
	Allocate a Logger instance that outputs log to standard input/output.
Logger *	createConsoleLoggerWithDefaultLevel ()
	Default is Info, or overridden by environment variable LIBFREENECT2_LOGGER_LEVEL.
Logger *	getGlobalLogger ()
	Get the pointer to the current logger.
void	setGlobalLogger (Logger *logger)
	Set the logger for all log output in this library.
PacketPipeline *	createPacketPipeline (const std::string &name, int device_id=-1)
	Construct a compiled pipeline by canonical name, or return NULL.
PacketPipeline *	createPacketPipeline (const std::string &name, const PacketPipelineConfig &config, int device_id=-1)
PacketPipeline *	createDefaultPacketPipeline ()
	Construct the environment-selected/default pipeline.
PacketPipeline *	createDefaultPacketPipeline (const PacketPipelineConfig &config)
std::vector< std::string >	getCompiledPacketPipelines ()
	Canonical names of pipelines compiled into this library.
std::vector< std::string >	getAvailablePacketPipelines ()
	Canonical names of compiled pipelines usable on this machine.

Enumeration Type Documentation

DistortionModel

enum class DistortionModel : uint32_t

strong

Distortion conventions supported by conventional projective calibration.

Enumerator
None
BrownConrady5
Rational8

ColorSettingCommandType

enum ColorSettingCommandType

Enumerator
COLOR_SETTING_SET_EXPOSURE_MODE
COLOR_SETTING_SET_INTEGRATION_TIME
COLOR_SETTING_GET_INTEGRATION_TIME
COLOR_SETTING_SET_WHITE_BALANCE_MODE
COLOR_SETTING_SET_RED_CHANNEL_GAIN
COLOR_SETTING_SET_GREEN_CHANNEL_GAIN
COLOR_SETTING_SET_BLUE_CHANNEL_GAIN
COLOR_SETTING_GET_RED_CHANNEL_GAIN
COLOR_SETTING_GET_GREEN_CHANNEL_GAIN
COLOR_SETTING_GET_BLUE_CHANNEL_GAIN
COLOR_SETTING_SET_EXPOSURE_TIME_MS
COLOR_SETTING_GET_EXPOSURE_TIME_MS
COLOR_SETTING_SET_DIGITAL_GAIN
COLOR_SETTING_GET_DIGITAL_GAIN
COLOR_SETTING_SET_ANALOG_GAIN
COLOR_SETTING_GET_ANALOG_GAIN
COLOR_SETTING_SET_EXPOSURE_COMPENSATION
COLOR_SETTING_GET_EXPOSURE_COMPENSATION
COLOR_SETTING_SET_ACS
COLOR_SETTING_GET_ACS
COLOR_SETTING_SET_EXPOSURE_METERING_MODE
COLOR_SETTING_SET_EXPOSURE_METERING_ZONES
COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_0_WEIGHT
COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_1_WEIGHT
COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_2_WEIGHT
COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_3_WEIGHT
COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_4_WEIGHT
COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_5_WEIGHT
COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_6_WEIGHT
COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_7_WEIGHT
COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_8_WEIGHT
COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_9_WEIGHT
COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_10_WEIGHT
COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_11_WEIGHT
COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_12_WEIGHT
COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_13_WEIGHT
COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_14_WEIGHT
COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_15_WEIGHT
COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_16_WEIGHT
COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_17_WEIGHT
COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_18_WEIGHT
COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_19_WEIGHT
COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_20_WEIGHT
COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_21_WEIGHT
COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_22_WEIGHT
COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_23_WEIGHT
COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_24_WEIGHT
COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_25_WEIGHT
COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_26_WEIGHT
COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_27_WEIGHT
COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_28_WEIGHT
COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_29_WEIGHT
COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_30_WEIGHT
COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_31_WEIGHT
COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_32_WEIGHT
COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_33_WEIGHT
COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_34_WEIGHT
COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_35_WEIGHT
COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_36_WEIGHT
COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_37_WEIGHT
COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_38_WEIGHT
COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_39_WEIGHT
COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_40_WEIGHT
COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_41_WEIGHT
COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_42_WEIGHT
COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_43_WEIGHT
COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_44_WEIGHT
COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_45_WEIGHT
COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_46_WEIGHT
COLOR_SETTING_SET_EXPOSURE_METERING_ZONE_47_WEIGHT
COLOR_SETTING_SET_MAX_ANALOG_GAIN_CAP
COLOR_SETTING_SET_MAX_DIGITAL_GAIN_CAP
COLOR_SETTING_SET_FLICKER_FREE_FREQUENCY
COLOR_SETTING_GET_EXPOSURE_MODE
COLOR_SETTING_GET_WHITE_BALANCE_MODE
COLOR_SETTING_SET_FRAME_RATE
COLOR_SETTING_GET_FRAME_RATE

RegistrationRasterization

enum class RegistrationRasterization : uint32_t

strong

Enumerator
Nearest
FourNeighborSplat

Function Documentation

computeDepthRoiStatistics()

bool computeDepthRoiStatistics	(	const Frame &	depth,
		const DepthCalibrationRoi &	roi,
		DepthRoiStatistics &	statistics,
		std::string *	error = 0 )

Compute the median and median absolute deviation for one decoded depth frame.

fitDepthCorrectionProfile()

bool fitDepthCorrectionProfile	(	const std::vector< DepthCalibrationSample > &	samples,
		DepthCorrectionProfile &	profile,
		std::string *	error = 0 )

Fit an offset-only profile for one distance or a linear profile for two or more.

getVersion()

std::string getVersion

(

)

Runtime identity of the loaded library.

getApiVersion()

uint32_t getApiVersion

(

)

getBuildRevision()

std::string getBuildRevision

(

)