Camera Calibration data model. More...

#include <Zivid/CameraCalibration.h>

Classes
class	Extrinsics
	Camera Extrinsics. More...
class	Intrinsics
	Camera Intrinsics. More...

Public Types
using	Descendants = std::tuple<CameraCalibration::Extrinsics, CameraCalibration::Intrinsics>

Public Member Functions
	CameraCalibration ()
	Default constructor.
	CameraCalibration (const std::string &fileName)
	Construct CameraCalibration by loading from file.
std::string	serialize () const
	Serialize to a string.
template<typename... Args>
	CameraCalibration (Args &&...args)
	Constructor taking variadic number of arguments.
template<typename... Args>
void	set (Args &&...args)
	Set multiple arguments.
template<typename... Args>
CameraCalibration	copyWith (Args &&...args) const
	Returns a copy of this object with the given argument(s) set to the new value(s)
const Extrinsics &	extrinsics () const
	Get Extrinsics.
Extrinsics &	extrinsics ()
	Get Extrinsics.
CameraCalibration &	set (const Extrinsics &value)
	Set Extrinsics.
const Intrinsics &	intrinsics () const
	Get Intrinsics.
Intrinsics &	intrinsics ()
	Get Intrinsics.
CameraCalibration &	set (const Intrinsics &value)
	Set Intrinsics.
template<typename T, typename std::enable_if< std::is_same< T, CameraCalibration::Extrinsics >::value, int >::type = 0>
const CameraCalibration::Extrinsics &	get () const
template<typename T, typename std::enable_if< std::is_same< T, CameraCalibration::Intrinsics >::value, int >::type = 0>
const CameraCalibration::Intrinsics &	get () const
template<size_t i, typename std::enable_if< i==0, int >::type = 0>
const CameraCalibration::Extrinsics &	get () const
template<size_t i, typename std::enable_if< i==1, int >::type = 0>
const CameraCalibration::Intrinsics &	get () const
template<typename F>
void	forEach (const F &f) const
	Run the given function on each direct member with the value of the member as parameter.
template<typename F>
void	forEach (const F &f)
	Run the given function on each direct member with the value of the member as parameter.
bool	operator== (const CameraCalibration &other) const
	Equality operator.
bool	operator!= (const CameraCalibration &other) const
	Inequality operator.
std::string	toString () const
	Get the value as string.
void	save (const std::string &fileName) const
	Save to the given file.
void	load (const std::string &fileName)
	Load from the given file.

Static Public Member Functions
static CameraCalibration	fromSerialized (const std::string &value)
	Construct a new CameraCalibration instance from a previously serialized string.

Static Public Attributes
static constexpr DataModel::NodeType	nodeType = DataModel::NodeType::group
	The type of this node.
static constexpr const char *	path { "" }
	The full path for this value.
static constexpr const char *	name { "CameraCalibration" }
	The name of this value.
static constexpr const char *	description { R"description(Camera Calibration data model)description" }
	The description for this value.
static constexpr size_t	version { 1 }

Friends
struct	DataModel::Detail::Befriend< CameraCalibration >
std::ostream &	operator<< (std::ostream &stream, const CameraCalibration &value)
	Operator to send the value as string to a stream.

Detailed Description

Camera Calibration data model.

Member Typedef Documentation

◆ Descendants

using Zivid::CameraCalibration::Descendants = std::tuple<CameraCalibration::Extrinsics, CameraCalibration::Intrinsics>

Constructor & Destructor Documentation

◆ CameraCalibration() [1/3]

Zivid::CameraCalibration::CameraCalibration ( )

Default constructor.

◆ CameraCalibration() [2/3]

Zivid::CameraCalibration::CameraCalibration ( const std::string & fileName )

explicit

Construct CameraCalibration by loading from file.

◆ CameraCalibration() [3/3]

template<typename... Args>

Zivid::CameraCalibration::CameraCalibration ( Args &&... args )

inlineexplicit

Constructor taking variadic number of arguments.

One or more descendant types can be provided. All types not provided will be set to their default value. The result is the same as default constructing CameraCalibration then invoking set(args).

The provided arguments must be descendants of CameraCalibration. These types can be provided:

Member Function Documentation

◆ copyWith()

template<typename... Args>

CameraCalibration Zivid::CameraCalibration::copyWith ( Args &&... args ) const

inline

Returns a copy of this object with the given argument(s) set to the new value(s)

Creates a copy of this CameraCalibration object, then invokes set(args) on the copy, and finally returns the copy. This method does not modify the original object.

The provided arguments must be descendants of CameraCalibration. These types can be provided:

◆ extrinsics() [1/2]

Extrinsics & Zivid::CameraCalibration::extrinsics ( )

inline

Get Extrinsics.

◆ extrinsics() [2/2]

const Extrinsics & Zivid::CameraCalibration::extrinsics ( ) const

inline

Get Extrinsics.

◆ forEach() [1/2]

template<typename F>

void Zivid::CameraCalibration::forEach ( const F & f )

inline

Run the given function on each direct member with the value of the member as parameter.

◆ forEach() [2/2]

template<typename F>

void Zivid::CameraCalibration::forEach ( const F & f ) const

inline

Run the given function on each direct member with the value of the member as parameter.

◆ fromSerialized()

CameraCalibration Zivid::CameraCalibration::fromSerialized ( const std::string & value )

staticnodiscard

Construct a new CameraCalibration instance from a previously serialized string.

◆ get() [1/4]

template<typename T, typename std::enable_if< std::is_same< T, CameraCalibration::Extrinsics >::value, int >::type = 0>

const CameraCalibration::Extrinsics & Zivid::CameraCalibration::get ( ) const

inline

◆ get() [2/4]

template<typename T, typename std::enable_if< std::is_same< T, CameraCalibration::Intrinsics >::value, int >::type = 0>

const CameraCalibration::Intrinsics & Zivid::CameraCalibration::get ( ) const

inline

◆ get() [3/4]

template<size_t i, typename std::enable_if< i==0, int >::type = 0>

const CameraCalibration::Extrinsics & Zivid::CameraCalibration::get ( ) const

inline

◆ get() [4/4]

template<size_t i, typename std::enable_if< i==1, int >::type = 0>

const CameraCalibration::Intrinsics & Zivid::CameraCalibration::get ( ) const

inline

◆ intrinsics() [1/2]

Intrinsics & Zivid::CameraCalibration::intrinsics ( )

inline

Get Intrinsics.

◆ intrinsics() [2/2]

const Intrinsics & Zivid::CameraCalibration::intrinsics ( ) const

inline

Get Intrinsics.

◆ load()

void Zivid::CameraCalibration::load ( const std::string & fileName )

Load from the given file.

◆ operator!=()

bool Zivid::CameraCalibration::operator!= ( const CameraCalibration & other ) const

Inequality operator.

◆ operator==()

bool Zivid::CameraCalibration::operator== ( const CameraCalibration & other ) const

Equality operator.

◆ save()

void Zivid::CameraCalibration::save ( const std::string & fileName ) const

Save to the given file.

◆ serialize()

std::string Zivid::CameraCalibration::serialize ( ) const

Serialize to a string.

See also fromSerialized. The returned string is formatted in YAML, and is compatible with the contents of files saved using save.

◆ set() [1/3]

template<typename... Args>

void Zivid::CameraCalibration::set ( Args &&... args )

inline

Set multiple arguments.

The method invokes set(arg) with each of the provided arguments.

The provided arguments must be descendants of CameraCalibration. These types can be provided:

◆ set() [2/3]

CameraCalibration & Zivid::CameraCalibration::set ( const Extrinsics & value )

inline

Set Extrinsics.

◆ set() [3/3]

CameraCalibration & Zivid::CameraCalibration::set ( const Intrinsics & value )

inline

Set Intrinsics.

◆ toString()

std::string Zivid::CameraCalibration::toString ( ) const

Get the value as string.

◆ DataModel::Detail::Befriend< CameraCalibration >

friend struct DataModel::Detail::Befriend< CameraCalibration >

friend

◆ operator<<

std::ostream & operator<<	(	std::ostream &	stream,
		const CameraCalibration &	value )

friend

Operator to send the value as string to a stream.

Member Data Documentation

◆ description

const char* Zivid::CameraCalibration::description { R"description(Camera Calibration data model)description" }

staticconstexpr

The description for this value.

◆ name

const char* Zivid::CameraCalibration::name { "CameraCalibration" }

staticconstexpr

The name of this value.

◆ nodeType

DataModel::NodeType Zivid::CameraCalibration::nodeType = DataModel::NodeType::group

staticconstexpr

The type of this node.

◆ path

const char* Zivid::CameraCalibration::path { "" }

staticconstexpr

The full path for this value.

◆ version

size_t Zivid::CameraCalibration::version { 1 }

staticconstexpr

The documentation for this class was generated from the following file:

Zivid/CameraCalibration.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Descendants

Constructor & Destructor Documentation

◆ CameraCalibration() [1/3]

◆ CameraCalibration() [2/3]

◆ CameraCalibration() [3/3]

Member Function Documentation

◆ copyWith()

◆ extrinsics() [1/2]

◆ extrinsics() [2/2]

◆ forEach() [1/2]

◆ forEach() [2/2]

◆ fromSerialized()

◆ get() [1/4]

◆ get() [2/4]

◆ get() [3/4]

◆ get() [4/4]

◆ intrinsics() [1/2]

◆ intrinsics() [2/2]

◆ load()

◆ operator!=()

◆ operator==()

◆ save()

◆ serialize()

◆ set() [1/3]

◆ set() [2/3]

◆ set() [3/3]

◆ toString()

Friends And Related Symbol Documentation

◆ DataModel::Detail::Befriend< CameraCalibration >

◆ operator<<

Member Data Documentation

◆ description

◆ name

◆ nodeType

◆ path

◆ version