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

First radial distortion term. More...

#include <Zivid/CameraIntrinsics.h>

Public Types

using ValueType = double
 The type of the underlying value.
 

Public Member Functions

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

Static Public Member Functions

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

Static Public Attributes

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

Friends

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

Detailed Description

First radial distortion term.

Member Typedef Documentation

◆ ValueType

The type of the underlying value.

Constructor & Destructor Documentation

◆ K1() [1/2]

Zivid::CameraIntrinsics::Distortion::K1::K1 ( )
default

Default constructor.

◆ K1() [2/2]

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

Constructor.

Member Function Documentation

◆ operator!=()

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

Comparison operator.

◆ operator<()

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

Comparison operator.

◆ operator<=()

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

Comparison operator.

◆ operator==()

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

Comparison operator.

◆ operator>()

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

Comparison operator.

◆ operator>=()

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

Comparison operator.

◆ toString()

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

Get the value as string.

◆ validRange()

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

The range of valid values for K1.

◆ value()

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

Get the value.

Friends And Related Symbol Documentation

◆ DataModel::Detail::Befriend< K1 >

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

◆ operator<<

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

Operator to serialize the value to a stream.

Member Data Documentation

◆ description

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

The description for this value.

◆ name

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

The name of this value.

◆ nodeType

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

The type of this node.

◆ path

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

The full path for this value.


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