Zivid C++ API 2.13.1+18e79e79-1
Zivid::CameraIntrinsics::CameraMatrix Class Reference

The camera matrix K (=[fx,0,cx;0,fy,cy;0,0,1]) More...

#include <Zivid/CameraIntrinsics.h>

Classes

class  CX
 x coordinate of the principal point More...
 
class  CY
 y coordinate of the principal point More...
 
class  FX
 Focal length in x. More...
 
class  FY
 Focal length in y. More...
 

Public Types

using Descendants
 

Public Member Functions

 CameraMatrix ()
 Default constructor.
 
template<typename... Args>
 CameraMatrix (Args &&...args)
 Constructor taking variadic number of arguments.
 
template<typename... Args>
void set (Args &&...args)
 Set multiple arguments.
 
template<typename... Args>
CameraMatrix copyWith (Args &&...args) const
 Returns a copy of this object with the given argument(s) set to the new value(s)
 
const CXcx () const
 Get CX.
 
CXcx ()
 Get CX.
 
CameraMatrixset (const CX &value)
 Set CX.
 
const CYcy () const
 Get CY.
 
CYcy ()
 Get CY.
 
CameraMatrixset (const CY &value)
 Set CY.
 
const FXfx () const
 Get FX.
 
FXfx ()
 Get FX.
 
CameraMatrixset (const FX &value)
 Set FX.
 
const FYfy () const
 Get FY.
 
FYfy ()
 Get FY.
 
CameraMatrixset (const FY &value)
 Set FY.
 
template<typename T , typename std::enable_if< std::is_same< T, CameraIntrinsics::CameraMatrix::CX >::value, int >::type = 0>
const CameraIntrinsics::CameraMatrix::CXget () const
 
template<typename T , typename std::enable_if< std::is_same< T, CameraIntrinsics::CameraMatrix::CY >::value, int >::type = 0>
const CameraIntrinsics::CameraMatrix::CYget () const
 
template<typename T , typename std::enable_if< std::is_same< T, CameraIntrinsics::CameraMatrix::FX >::value, int >::type = 0>
const CameraIntrinsics::CameraMatrix::FXget () const
 
template<typename T , typename std::enable_if< std::is_same< T, CameraIntrinsics::CameraMatrix::FY >::value, int >::type = 0>
const CameraIntrinsics::CameraMatrix::FYget () const
 
template<size_t i, typename std::enable_if< i==0, int >::type = 0>
const CameraIntrinsics::CameraMatrix::CXget () const
 
template<size_t i, typename std::enable_if< i==1, int >::type = 0>
const CameraIntrinsics::CameraMatrix::CYget () const
 
template<size_t i, typename std::enable_if< i==2, int >::type = 0>
const CameraIntrinsics::CameraMatrix::FXget () const
 
template<size_t i, typename std::enable_if< i==3, int >::type = 0>
const CameraIntrinsics::CameraMatrix::FYget () 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 CameraMatrix &other) const
 Equality operator.
 
bool operator!= (const CameraMatrix &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 { "CameraMatrix" }
 The full path for this value.
 
static constexpr const char * name { "CameraMatrix" }
 The name of this value.
 
static constexpr const char * description
 The description for this value.
 

Friends

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

Detailed Description

The camera matrix K (=[fx,0,cx;0,fy,cy;0,0,1])

Member Typedef Documentation

◆ Descendants

Initial value:
std::tuple<
CameraIntrinsics::CameraMatrix::CX,
CameraIntrinsics::CameraMatrix::CY,
CameraIntrinsics::CameraMatrix::FX,
CameraIntrinsics::CameraMatrix::FY>

Constructor & Destructor Documentation

◆ CameraMatrix() [1/2]

Zivid::CameraIntrinsics::CameraMatrix::CameraMatrix ( )

Default constructor.

◆ CameraMatrix() [2/2]

template<typename... Args>
Zivid::CameraIntrinsics::CameraMatrix::CameraMatrix ( 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 CameraMatrix then invoking set(args).

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

Member Function Documentation

◆ copyWith()

template<typename... Args>
CameraMatrix Zivid::CameraIntrinsics::CameraMatrix::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 CameraMatrix 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 CameraMatrix. These types can be provided:

◆ cx() [1/2]

CX & Zivid::CameraIntrinsics::CameraMatrix::cx ( )
inline

Get CX.

◆ cx() [2/2]

const CX & Zivid::CameraIntrinsics::CameraMatrix::cx ( ) const
inline

Get CX.

◆ cy() [1/2]

CY & Zivid::CameraIntrinsics::CameraMatrix::cy ( )
inline

Get CY.

◆ cy() [2/2]

const CY & Zivid::CameraIntrinsics::CameraMatrix::cy ( ) const
inline

Get CY.

◆ forEach() [1/2]

template<typename F >
void Zivid::CameraIntrinsics::CameraMatrix::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::CameraMatrix::forEach ( const F & f) const
inline

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

◆ fx() [1/2]

FX & Zivid::CameraIntrinsics::CameraMatrix::fx ( )
inline

Get FX.

◆ fx() [2/2]

const FX & Zivid::CameraIntrinsics::CameraMatrix::fx ( ) const
inline

Get FX.

◆ fy() [1/2]

FY & Zivid::CameraIntrinsics::CameraMatrix::fy ( )
inline

Get FY.

◆ fy() [2/2]

const FY & Zivid::CameraIntrinsics::CameraMatrix::fy ( ) const
inline

Get FY.

◆ get() [1/8]

template<typename T , typename std::enable_if< std::is_same< T, CameraIntrinsics::CameraMatrix::CX >::value, int >::type = 0>
const CameraIntrinsics::CameraMatrix::CX & Zivid::CameraIntrinsics::CameraMatrix::get ( ) const
inline

◆ get() [2/8]

template<typename T , typename std::enable_if< std::is_same< T, CameraIntrinsics::CameraMatrix::CY >::value, int >::type = 0>
const CameraIntrinsics::CameraMatrix::CY & Zivid::CameraIntrinsics::CameraMatrix::get ( ) const
inline

◆ get() [3/8]

template<typename T , typename std::enable_if< std::is_same< T, CameraIntrinsics::CameraMatrix::FX >::value, int >::type = 0>
const CameraIntrinsics::CameraMatrix::FX & Zivid::CameraIntrinsics::CameraMatrix::get ( ) const
inline

◆ get() [4/8]

template<typename T , typename std::enable_if< std::is_same< T, CameraIntrinsics::CameraMatrix::FY >::value, int >::type = 0>
const CameraIntrinsics::CameraMatrix::FY & Zivid::CameraIntrinsics::CameraMatrix::get ( ) const
inline

◆ get() [5/8]

template<size_t i, typename std::enable_if< i==0, int >::type = 0>
const CameraIntrinsics::CameraMatrix::CX & Zivid::CameraIntrinsics::CameraMatrix::get ( ) const
inline

◆ get() [6/8]

template<size_t i, typename std::enable_if< i==1, int >::type = 0>
const CameraIntrinsics::CameraMatrix::CY & Zivid::CameraIntrinsics::CameraMatrix::get ( ) const
inline

◆ get() [7/8]

template<size_t i, typename std::enable_if< i==2, int >::type = 0>
const CameraIntrinsics::CameraMatrix::FX & Zivid::CameraIntrinsics::CameraMatrix::get ( ) const
inline

◆ get() [8/8]

template<size_t i, typename std::enable_if< i==3, int >::type = 0>
const CameraIntrinsics::CameraMatrix::FY & Zivid::CameraIntrinsics::CameraMatrix::get ( ) const
inline

◆ operator!=()

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

Inequality operator.

◆ operator==()

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

Equality operator.

◆ set() [1/5]

template<typename... Args>
void Zivid::CameraIntrinsics::CameraMatrix::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 CameraMatrix. These types can be provided:

◆ set() [2/5]

CameraMatrix & Zivid::CameraIntrinsics::CameraMatrix::set ( const CX & value)
inline

Set CX.

◆ set() [3/5]

CameraMatrix & Zivid::CameraIntrinsics::CameraMatrix::set ( const CY & value)
inline

Set CY.

◆ set() [4/5]

CameraMatrix & Zivid::CameraIntrinsics::CameraMatrix::set ( const FX & value)
inline

Set FX.

◆ set() [5/5]

CameraMatrix & Zivid::CameraIntrinsics::CameraMatrix::set ( const FY & value)
inline

Set FY.

◆ toString()

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

Get the value as string.

Friends And Related Symbol Documentation

◆ DataModel::Detail::Befriend< CameraMatrix >

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

◆ operator<<

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

Operator to send the value as string to a stream.

Member Data Documentation

◆ description

const char* Zivid::CameraIntrinsics::CameraMatrix::description
staticconstexpr
Initial value:
{
R"description(The camera matrix K (=[fx,0,cx;0,fy,cy;0,0,1]))description"
}

The description for this value.

◆ name

const char* Zivid::CameraIntrinsics::CameraMatrix::name { "CameraMatrix" }
staticconstexpr

The name of this value.

◆ nodeType

DataModel::NodeType Zivid::CameraIntrinsics::CameraMatrix::nodeType = DataModel::NodeType::group
staticconstexpr

The type of this node.

◆ path

const char* Zivid::CameraIntrinsics::CameraMatrix::path { "CameraMatrix" }
staticconstexpr

The full path for this value.


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