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

Third radial distortion term. More...

#include <Zivid/CameraIntrinsics.h>

Public Types

using ValueType = double
 The type of the underlying value.
 

Public Member Functions

 K3 ()=default
 Default constructor.
 
constexpr K3 (double value)
 Constructor.
 
double value () const
 Get the value.
 
std::string toString () const
 Get the value as string.
 
bool operator== (const K3 &other) const
 Comparison operator.
 
bool operator!= (const K3 &other) const
 Comparison operator.
 
bool operator< (const K3 &other) const
 Comparison operator.
 
bool operator> (const K3 &other) const
 Comparison operator.
 
bool operator<= (const K3 &other) const
 Comparison operator.
 
bool operator>= (const K3 &other) const
 Comparison operator.
 

Static Public Member Functions

static constexpr Range< double > validRange ()
 The range of valid values for K3.
 

Static Public Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue
 The type of this node.
 
static constexpr const char * path { "Distortion/K3" }
 The full path for this value.
 
static constexpr const char * name { "K3" }
 The name of this value.
 
static constexpr const char * description { R"description(Third radial distortion term)description" }
 The description for this value.
 

Friends

struct DataModel::Detail::Befriend< K3 >
 
std::ostream & operator<< (std::ostream &stream, const K3 &value)
 Operator to serialize the value to a stream.
 

Detailed Description

Third radial distortion term.

Member Typedef Documentation

◆ ValueType

The type of the underlying value.

Constructor & Destructor Documentation

◆ K3() [1/2]

Zivid::CameraIntrinsics::Distortion::K3::K3 ( )
default

Default constructor.

◆ K3() [2/2]

Zivid::CameraIntrinsics::Distortion::K3::K3 ( double value)
inlineexplicitconstexpr

Constructor.

Member Function Documentation

◆ operator!=()

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

Comparison operator.

◆ operator<()

bool Zivid::CameraIntrinsics::Distortion::K3::operator< ( const K3 & other) const
inline

Comparison operator.

◆ operator<=()

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

Comparison operator.

◆ operator==()

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

Comparison operator.

◆ operator>()

bool Zivid::CameraIntrinsics::Distortion::K3::operator> ( const K3 & other) const
inline

Comparison operator.

◆ operator>=()

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

Comparison operator.

◆ toString()

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

Get the value as string.

◆ validRange()

static constexpr Range< double > Zivid::CameraIntrinsics::Distortion::K3::validRange ( )
inlinestaticconstexpr

The range of valid values for K3.

◆ value()

double Zivid::CameraIntrinsics::Distortion::K3::value ( ) const

Get the value.

Friends And Related Symbol Documentation

◆ DataModel::Detail::Befriend< K3 >

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

◆ operator<<

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

Operator to serialize the value to a stream.

Member Data Documentation

◆ description

const char* Zivid::CameraIntrinsics::Distortion::K3::description { R"description(Third radial distortion term)description" }
staticconstexpr

The description for this value.

◆ name

const char* Zivid::CameraIntrinsics::Distortion::K3::name { "K3" }
staticconstexpr

The name of this value.

◆ nodeType

DataModel::NodeType Zivid::CameraIntrinsics::Distortion::K3::nodeType = DataModel::NodeType::leafValue
staticconstexpr

The type of this node.

◆ path

const char* Zivid::CameraIntrinsics::Distortion::K3::path { "Distortion/K3" }
staticconstexpr

The full path for this value.


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