CalibrationProfile Class Reference

Versioned user calibration for conventional depth-to-color geometry. More...

#include <libfreenect2/calibration_profile.h>

Public Member Functions
	CalibrationProfile ()
	CalibrationProfile (const CalibrationProfile &other)
	CalibrationProfile (CalibrationProfile &&other) noexcept
CalibrationProfile &	operator= (const CalibrationProfile &other)
CalibrationProfile &	operator= (CalibrationProfile &&other) noexcept
	~CalibrationProfile ()
uint32_t	schemaVersion () const
const std::string &	serial () const
const std::string &	firmware () const
void	setDeviceIdentity (const std::string &serial, const std::string &firmware)
const ProjectiveCameraModel &	colorCamera () const
const ProjectiveCameraModel &	irCamera () const
const RigidTransform &	depthToColor () const
void	setColorCamera (const ProjectiveCameraModel &camera)
void	setIrCamera (const ProjectiveCameraModel &camera)
void	setDepthToColor (const RigidTransform &transform)
bool	hasDepthCorrection () const
const DepthCorrectionProfile &	depthCorrection () const
void	setDepthCorrection (const DepthCorrectionProfile &correction)
void	clearDepthCorrection ()
bool	hasQualityMetrics () const
const CalibrationQualityMetrics &	qualityMetrics () const
void	setQualityMetrics (const CalibrationQualityMetrics &quality)
void	clearQualityMetrics ()
const std::string &	createdUtc () const
const std::string &	toolVersion () const
const std::string &	jobSha256 () const
void	setProvenance (const std::string &created_utc, const std::string &tool_version, const std::string &job_sha256)
bool	isValid (std::string *error=nullptr) const
bool	matchesDevice (const std::string &serial, const std::string &firmware, bool allow_serial_mismatch, std::string *warning=nullptr, std::string *error=nullptr) const
	Check binding identity.
bool	save (const std::string &path, std::string *error=nullptr) const

Static Public Member Functions
static bool	load (const std::string &path, CalibrationProfile &profile, std::string *error=nullptr)

Detailed Description

Versioned user calibration for conventional depth-to-color geometry.

A moved-from profile may only be assigned to, copied from, or destroyed; copying from one yields a default-constructed profile. Other member functions require an object that has not been moved from.

Constructor & Destructor Documentation

CalibrationProfile() [1/3]

CalibrationProfile

(

)

Referenced by CalibrationProfile(), CalibrationProfile(), load(), operator=(), and operator=().

CalibrationProfile() [2/3]

CalibrationProfile

(

const CalibrationProfile &

other

)

References CalibrationProfile().

CalibrationProfile() [3/3]

CalibrationProfile ( CalibrationProfile && other )

noexcept

References CalibrationProfile().

~CalibrationProfile()

~CalibrationProfile

(

)

Member Function Documentation

operator=() [1/2]

CalibrationProfile & operator=

(

const CalibrationProfile &

other

)

References CalibrationProfile().

operator=() [2/2]

CalibrationProfile & operator= ( CalibrationProfile && other )

noexcept

References CalibrationProfile().

schemaVersion()

uint32_t schemaVersion

(

)

const

serial()

const std::string & serial

(

)

const

Referenced by matchesDevice(), and setDeviceIdentity().

firmware()

const std::string & firmware

(

)

const

Referenced by matchesDevice(), and setDeviceIdentity().

setDeviceIdentity()

void setDeviceIdentity	(	const std::string &	serial,
		const std::string &	firmware )

References firmware(), and serial().

colorCamera()

const ProjectiveCameraModel & colorCamera

(

)

const

irCamera()

const ProjectiveCameraModel & irCamera

(

)

const

depthToColor()

const RigidTransform & depthToColor

(

)

const

setColorCamera()

void setColorCamera

(

const ProjectiveCameraModel &

camera

)

setIrCamera()

void setIrCamera

(

const ProjectiveCameraModel &

camera

)

setDepthToColor()

void setDepthToColor

(

const RigidTransform &

transform

)

hasDepthCorrection()

bool hasDepthCorrection

(

)

const

depthCorrection()

const DepthCorrectionProfile & depthCorrection

(

)

const

setDepthCorrection()

void setDepthCorrection

(

const DepthCorrectionProfile &

correction

)

clearDepthCorrection()

void clearDepthCorrection

(

)

hasQualityMetrics()

bool hasQualityMetrics

(

)

const

qualityMetrics()

const CalibrationQualityMetrics & qualityMetrics

(

)

const

setQualityMetrics()

void setQualityMetrics

(

const CalibrationQualityMetrics &

quality

)

clearQualityMetrics()

void clearQualityMetrics

(

)

createdUtc()

const std::string & createdUtc

(

)

const

toolVersion()

const std::string & toolVersion

(

)

const

jobSha256()

const std::string & jobSha256

(

)

const

setProvenance()

void setProvenance	(	const std::string &	created_utc,
		const std::string &	tool_version,
		const std::string &	job_sha256 )

isValid()

bool isValid

(

std::string *

error = nullptr

)

const

matchesDevice()

bool matchesDevice	(	const std::string &	serial,
		const std::string &	firmware,
		bool	allow_serial_mismatch,
		std::string *	warning = nullptr,
		std::string *	error = nullptr ) const

Check binding identity.

Firmware mismatches are returned as warnings.

References firmware(), and serial().

save()

bool save	(	const std::string &	path,
		std::string *	error = nullptr ) const

load()

bool load ( const std::string & path, CalibrationProfile & profile, std::string * error = nullptr )

static

References CalibrationProfile().