NVIDIA DeepStream SDK API Reference
6.4 Release
Public Member Functions | Data Fields
cvcore::CameraDistortionModel Struct Reference

Detailed Description

Struct type used to store Camera Distortion model type and coefficients.

Definition at line 43 of file CameraModel.h.

Public Member Functions

 CameraDistortionModel ()
 
 CameraDistortionModel (CameraDistortionType distortionType, std::array< float, 8 > &distortionCoefficients)
 Camera Distortion Model creation using array of coefficients. More...
 
 CameraDistortionModel (CameraDistortionType distortionType, float k1, float k2, float k3, float k4, float k5, float k6, float p1, float p2)
 Camera Distortion Model creation using individual coefficients. More...
 
CameraDistortionType getDistortionType () const
 Get camera distortion model type. More...
 
const float * getCoefficients () const
 Get camera distortion model coefficients. More...
 
bool operator== (const CameraDistortionModel &other) const noexcept
 
bool operator!= (const CameraDistortionModel &other) const noexcept
 

Data Fields

CameraDistortionType type
 Camera distortion model type. More...
 
union {
   float   coefficients [8]
 
   struct {
      float   k1
 
      float   k2
 
      float   k3
 
      float   k4
 
      float   k5
 
      float   k6
 
      float   p1
 
      float   p2
 
   } 
 
}; 
 

Constructor & Destructor Documentation

◆ CameraDistortionModel() [1/3]

cvcore::CameraDistortionModel::CameraDistortionModel ( )
inline

Definition at line 56 of file CameraModel.h.

References cvcore::UNKNOWN.

◆ CameraDistortionModel() [2/3]

cvcore::CameraDistortionModel::CameraDistortionModel ( CameraDistortionType  distortionType,
std::array< float, 8 > &  distortionCoefficients 
)
inline

Camera Distortion Model creation using array of coefficients.

Parameters
distortionTypeCamera distortion model type
distortionCoefficientsAn array of camera distortion model coefficients
Returns
Camera Distortion Model

Definition at line 67 of file CameraModel.h.

References coefficients.

◆ CameraDistortionModel() [3/3]

cvcore::CameraDistortionModel::CameraDistortionModel ( CameraDistortionType  distortionType,
float  k1,
float  k2,
float  k3,
float  k4,
float  k5,
float  k6,
float  p1,
float  p2 
)
inline

Camera Distortion Model creation using individual coefficients.

Parameters
distortionTypeCamera distortion model type
k1Camera distortion model coefficient - k1
k2Camera distortion model coefficient - k2
k3Camera distortion model coefficient - k3
k4Camera distortion model coefficient - k4
k5Camera distortion model coefficient - k5
k6Camera distortion model coefficient - k6
p1Camera distortion model coefficient - p1
p2Camera distortion model coefficient - p2
Returns
Camera Distortion Model

Definition at line 86 of file CameraModel.h.

Member Function Documentation

◆ getCoefficients()

const float* cvcore::CameraDistortionModel::getCoefficients ( ) const
inline

Get camera distortion model coefficients.

Returns
Camera distortion model coefficients array

Definition at line 114 of file CameraModel.h.

References coefficients.

◆ getDistortionType()

CameraDistortionType cvcore::CameraDistortionModel::getDistortionType ( ) const
inline

Get camera distortion model type.

Returns
Camera distortion model type

Definition at line 105 of file CameraModel.h.

References type.

◆ operator!=()

bool cvcore::CameraDistortionModel::operator!= ( const CameraDistortionModel &  other) const
inlinenoexcept

Definition at line 131 of file CameraModel.h.

◆ operator==()

bool cvcore::CameraDistortionModel::operator== ( const CameraDistortionModel &  other) const
inlinenoexcept

Definition at line 119 of file CameraModel.h.

References k1, k2, k3, k4, k5, k6, p1, and p2.

Field Documentation

◆ @40

union { ... }

◆ coefficients

float cvcore::CameraDistortionModel::coefficients[8]

Definition at line 48 of file CameraModel.h.

Referenced by CameraDistortionModel(), and getCoefficients().

◆ k1

float cvcore::CameraDistortionModel::k1

Definition at line 51 of file CameraModel.h.

Referenced by operator==().

◆ k2

float cvcore::CameraDistortionModel::k2

Definition at line 51 of file CameraModel.h.

Referenced by operator==().

◆ k3

float cvcore::CameraDistortionModel::k3

Definition at line 51 of file CameraModel.h.

Referenced by operator==().

◆ k4

float cvcore::CameraDistortionModel::k4

Definition at line 51 of file CameraModel.h.

Referenced by operator==().

◆ k5

float cvcore::CameraDistortionModel::k5

Definition at line 51 of file CameraModel.h.

Referenced by operator==().

◆ k6

float cvcore::CameraDistortionModel::k6

Definition at line 51 of file CameraModel.h.

Referenced by operator==().

◆ p1

float cvcore::CameraDistortionModel::p1

Definition at line 52 of file CameraModel.h.

Referenced by operator==().

◆ p2

float cvcore::CameraDistortionModel::p2

Definition at line 52 of file CameraModel.h.

Referenced by operator==().

◆ type

CameraDistortionType cvcore::CameraDistortionModel::type

Camera distortion model type.

Definition at line 45 of file CameraModel.h.

Referenced by getDistortionType().

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