The radial and tangential distortion parameters. More...

#include <Zivid/CameraIntrinsics.h>

Classes
class	K1
	First radial distortion term. More...

class	K2
	Second radial distortion term. More...

class	K3
	Third radial distortion term. More...

class	P1
	First tangential distortion term. More...

class	P2
	Second tangential distortion term. More...

Public Types
using	Descendants = std::tuple< CameraIntrinsics::Distortion::K1, CameraIntrinsics::Distortion::K2, CameraIntrinsics::Distortion::K3, CameraIntrinsics::Distortion::P1, CameraIntrinsics::Distortion::P2 >

Public Member Functions
	Distortion ()
	Default constructor.

template<typename... Args>
	Distortion (Args &&...args)
	Constructor taking variadic number of arguments.

template<typename... Args>
void	set (Args &&...args)
	Set multiple arguments.

template<typename... Args>
Distortion	copyWith (Args &&...args) const
	Returns a copy of this object with the given argument(s) set to the new value(s)

const K1 &	k1 () const
	Get K1.

K1 &	k1 ()
	Get K1.

Distortion &	set (const K1 &value)
	Set K1.

const K2 &	k2 () const
	Get K2.

K2 &	k2 ()
	Get K2.

Distortion &	set (const K2 &value)
	Set K2.

const K3 &	k3 () const
	Get K3.

K3 &	k3 ()
	Get K3.

Distortion &	set (const K3 &value)
	Set K3.

const P1 &	p1 () const
	Get P1.

P1 &	p1 ()
	Get P1.

Distortion &	set (const P1 &value)
	Set P1.

const P2 &	p2 () const
	Get P2.

P2 &	p2 ()
	Get P2.

Distortion &	set (const P2 &value)
	Set P2.

template<typename T , typename std::enable_if< std::is_same< T, CameraIntrinsics::Distortion::K1 >::value, int >::type = 0>
const CameraIntrinsics::Distortion::K1 &	get () const

template<typename T , typename std::enable_if< std::is_same< T, CameraIntrinsics::Distortion::K2 >::value, int >::type = 0>
const CameraIntrinsics::Distortion::K2 &	get () const

template<typename T , typename std::enable_if< std::is_same< T, CameraIntrinsics::Distortion::K3 >::value, int >::type = 0>
const CameraIntrinsics::Distortion::K3 &	get () const

template<typename T , typename std::enable_if< std::is_same< T, CameraIntrinsics::Distortion::P1 >::value, int >::type = 0>
const CameraIntrinsics::Distortion::P1 &	get () const

template<typename T , typename std::enable_if< std::is_same< T, CameraIntrinsics::Distortion::P2 >::value, int >::type = 0>
const CameraIntrinsics::Distortion::P2 &	get () const

template<size_t i, typename std::enable_if< i==0, int >::type = 0>
const CameraIntrinsics::Distortion::K1 &	get () const

template<size_t i, typename std::enable_if< i==1, int >::type = 0>
const CameraIntrinsics::Distortion::K2 &	get () const

template<size_t i, typename std::enable_if< i==2, int >::type = 0>
const CameraIntrinsics::Distortion::K3 &	get () const

template<size_t i, typename std::enable_if< i==3, int >::type = 0>
const CameraIntrinsics::Distortion::P1 &	get () const

template<size_t i, typename std::enable_if< i==4, int >::type = 0>
const CameraIntrinsics::Distortion::P2 &	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 Distortion &other) const
	Equality operator.

bool	operator!= (const Distortion &other) const
	Inequality operator.

std::string	toString () const
	Get the value as string.

Static Public Attributes
static constexpr DataModel::NodeType	nodeType = DataModel::NodeType::group
	The type of this node.

static constexpr const char *	path { "Distortion" }
	The full path for this value.

static constexpr const char *	name { "Distortion" }
	The name of this value.

static constexpr const char *	description
	The description for this value.

Friends
struct	DataModel::Detail::Befriend< Distortion >

std::ostream &	operator<< (std::ostream &stream, const Distortion &value)
	Operator to send the value as string to a stream.

Detailed Description

The radial and tangential distortion parameters.

Member Typedef Documentation

◆ Descendants

using Zivid::CameraIntrinsics::Distortion::Descendants = std::tuple< CameraIntrinsics::Distortion::K1, CameraIntrinsics::Distortion::K2, CameraIntrinsics::Distortion::K3, CameraIntrinsics::Distortion::P1, CameraIntrinsics::Distortion::P2>

Constructor & Destructor Documentation

◆ Distortion() [1/2]

Zivid::CameraIntrinsics::Distortion::Distortion ( )

Default constructor.

◆ Distortion() [2/2]

template<typename... Args>

Zivid::CameraIntrinsics::Distortion::Distortion ( 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 Distortion then invoking set(args).

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

Member Function Documentation

◆ copyWith()

template<typename... Args>

Distortion Zivid::CameraIntrinsics::Distortion::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 Distortion 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 Distortion. These types can be provided:

◆ forEach() [1/2]

template<typename F >

void Zivid::CameraIntrinsics::Distortion::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::CameraIntrinsics::Distortion::forEach ( const F & f ) const

inline

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

◆ get() [1/10]

template<typename T , typename std::enable_if< std::is_same< T, CameraIntrinsics::Distortion::K1 >::value, int >::type = 0>

const CameraIntrinsics::Distortion::K1 & Zivid::CameraIntrinsics::Distortion::get ( ) const

inline

◆ get() [2/10]

template<typename T , typename std::enable_if< std::is_same< T, CameraIntrinsics::Distortion::K2 >::value, int >::type = 0>

const CameraIntrinsics::Distortion::K2 & Zivid::CameraIntrinsics::Distortion::get ( ) const

inline

◆ get() [3/10]

template<typename T , typename std::enable_if< std::is_same< T, CameraIntrinsics::Distortion::K3 >::value, int >::type = 0>

const CameraIntrinsics::Distortion::K3 & Zivid::CameraIntrinsics::Distortion::get ( ) const

inline

◆ get() [4/10]

template<typename T , typename std::enable_if< std::is_same< T, CameraIntrinsics::Distortion::P1 >::value, int >::type = 0>

const CameraIntrinsics::Distortion::P1 & Zivid::CameraIntrinsics::Distortion::get ( ) const

inline

◆ get() [5/10]

template<typename T , typename std::enable_if< std::is_same< T, CameraIntrinsics::Distortion::P2 >::value, int >::type = 0>

const CameraIntrinsics::Distortion::P2 & Zivid::CameraIntrinsics::Distortion::get ( ) const

inline

◆ get() [6/10]

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

const CameraIntrinsics::Distortion::K1 & Zivid::CameraIntrinsics::Distortion::get ( ) const

inline

◆ get() [7/10]

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

const CameraIntrinsics::Distortion::K2 & Zivid::CameraIntrinsics::Distortion::get ( ) const

inline

◆ get() [8/10]

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

const CameraIntrinsics::Distortion::K3 & Zivid::CameraIntrinsics::Distortion::get ( ) const

inline

◆ get() [9/10]

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

const CameraIntrinsics::Distortion::P1 & Zivid::CameraIntrinsics::Distortion::get ( ) const

inline

◆ get() [10/10]

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

const CameraIntrinsics::Distortion::P2 & Zivid::CameraIntrinsics::Distortion::get ( ) const

inline

◆ k1() [1/2]

K1 & Zivid::CameraIntrinsics::Distortion::k1 ( )

inline

Get K1.

◆ k1() [2/2]

const K1 & Zivid::CameraIntrinsics::Distortion::k1 ( ) const

inline

Get K1.

◆ k2() [1/2]

K2 & Zivid::CameraIntrinsics::Distortion::k2 ( )

inline

Get K2.

◆ k2() [2/2]

const K2 & Zivid::CameraIntrinsics::Distortion::k2 ( ) const

inline

Get K2.

◆ k3() [1/2]

K3 & Zivid::CameraIntrinsics::Distortion::k3 ( )

inline

Get K3.

◆ k3() [2/2]

const K3 & Zivid::CameraIntrinsics::Distortion::k3 ( ) const

inline

Get K3.

◆ operator!=()

bool Zivid::CameraIntrinsics::Distortion::operator!= ( const Distortion & other ) const

Inequality operator.

◆ operator==()

bool Zivid::CameraIntrinsics::Distortion::operator== ( const Distortion & other ) const

Equality operator.

◆ p1() [1/2]

P1 & Zivid::CameraIntrinsics::Distortion::p1 ( )

inline

Get P1.

◆ p1() [2/2]

const P1 & Zivid::CameraIntrinsics::Distortion::p1 ( ) const

inline

Get P1.

◆ p2() [1/2]

P2 & Zivid::CameraIntrinsics::Distortion::p2 ( )

inline

Get P2.

◆ p2() [2/2]

const P2 & Zivid::CameraIntrinsics::Distortion::p2 ( ) const

inline

Get P2.

◆ set() [1/6]

template<typename... Args>

void Zivid::CameraIntrinsics::Distortion::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 Distortion. These types can be provided:

◆ set() [2/6]

Distortion & Zivid::CameraIntrinsics::Distortion::set ( const K1 & value )

inline

Set K1.

◆ set() [3/6]

Distortion & Zivid::CameraIntrinsics::Distortion::set ( const K2 & value )

inline

Set K2.

◆ set() [4/6]

Distortion & Zivid::CameraIntrinsics::Distortion::set ( const K3 & value )

inline

Set K3.

◆ set() [5/6]

Distortion & Zivid::CameraIntrinsics::Distortion::set ( const P1 & value )

inline

Set P1.

◆ set() [6/6]

Distortion & Zivid::CameraIntrinsics::Distortion::set ( const P2 & value )

inline

Set P2.

◆ toString()

std::string Zivid::CameraIntrinsics::Distortion::toString ( ) const

Get the value as string.

Friends And Related Symbol Documentation

◆ DataModel::Detail::Befriend< Distortion >

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

friend

◆ operator<<

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

friend

Operator to send the value as string to a stream.

Member Data Documentation

◆ description

constexpr const char* Zivid::CameraIntrinsics::Distortion::description

staticconstexpr

Initial value:

{
                R"description(The radial and tangential distortion parameters)description"
            }

The description for this value.

◆ name

constexpr const char* Zivid::CameraIntrinsics::Distortion::name { "Distortion" }

staticconstexpr

The name of this value.

◆ nodeType

constexpr DataModel::NodeType Zivid::CameraIntrinsics::Distortion::nodeType = DataModel::NodeType::group

staticconstexpr

The type of this node.

◆ path

constexpr const char* Zivid::CameraIntrinsics::Distortion::path { "Distortion" }

staticconstexpr

The full path for this value.

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

Zivid/CameraIntrinsics.h

Classes

Public Types

Public Member Functions

Static Public Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Descendants

Constructor & Destructor Documentation

◆ Distortion() [1/2]

◆ Distortion() [2/2]

Member Function Documentation

◆ copyWith()

◆ forEach() [1/2]

◆ forEach() [2/2]

◆ get() [1/10]

◆ get() [2/10]

◆ get() [3/10]

◆ get() [4/10]

◆ get() [5/10]

◆ get() [6/10]

◆ get() [7/10]

◆ get() [8/10]

◆ get() [9/10]

◆ get() [10/10]

◆ k1() [1/2]

◆ k1() [2/2]

◆ k2() [1/2]

◆ k2() [2/2]

◆ k3() [1/2]

◆ k3() [2/2]

◆ operator!=()

◆ operator==()

◆ p1() [1/2]

◆ p1() [2/2]

◆ p2() [1/2]

◆ p2() [2/2]

◆ set() [1/6]

◆ set() [2/6]

◆ set() [3/6]

◆ set() [4/6]

◆ set() [5/6]

◆ set() [6/6]

◆ toString()

Friends And Related Symbol Documentation

◆ DataModel::Detail::Befriend< Distortion >

◆ operator<<

Member Data Documentation

◆ description

◆ name

◆ nodeType

◆ path