Ignition Sensors

API Reference

6.3.0
BrownDistortionModel Class Reference

Brown Distortion Model class. More...

#include <ignition/sensors/BrownDistortionModel.hh>

Public Member Functions

 BrownDistortionModel ()
 Constructor. More...
 
virtual ~BrownDistortionModel ()
 Destructor. More...
 
math::Vector2d Center () const
 Get the distortion center. More...
 
double K1 () const
 Get the radial distortion coefficient k1. More...
 
double K2 () const
 Get the radial distortion coefficient k2. More...
 
double K3 () const
 Get the radial distortion coefficient k3. More...
 
virtual void Load (const sdf::Camera &_sdf) override
 Load distortion parameters from sdf. More...
 
double P1 () const
 Get the tangential distortion coefficient p1. More...
 
double P2 () const
 Get the tangential distortion coefficient p2. More...
 
virtual void Print (std::ostream &_out) const override
 Documentation inherited. More...
 
- Public Member Functions inherited from Distortion
 Distortion (DistortionType _type)
 Constructor. This should not be called directly unless creating an empty distortion model. Use DistortionFactory::NewDistortionModel to instantiate a new distortion model. More...
 
virtual ~Distortion ()
 Destructor. More...
 
DistortionType Type () const
 Accessor for DistortionType. More...
 

Detailed Description

Brown Distortion Model class.

Constructor & Destructor Documentation

◆ BrownDistortionModel()

Constructor.

◆ ~BrownDistortionModel()

virtual ~BrownDistortionModel ( )
virtual

Destructor.

Member Function Documentation

◆ Center()

math::Vector2d Center ( ) const

Get the distortion center.

Returns
Distortion center.

◆ K1()

double K1 ( ) const

Get the radial distortion coefficient k1.

Returns
Distortion coefficient k1.

◆ K2()

double K2 ( ) const

Get the radial distortion coefficient k2.

Returns
Distortion coefficient k2.

◆ K3()

double K3 ( ) const

Get the radial distortion coefficient k3.

Returns
Distortion coefficient k3.

◆ Load()

virtual void Load ( const sdf::Camera &  _sdf)
overridevirtual

Load distortion parameters from sdf.

Parameters
[in]_sdfSDF Distortion DOM object.

Reimplemented from Distortion.

Reimplemented in ImageBrownDistortionModel.

◆ P1()

double P1 ( ) const

Get the tangential distortion coefficient p1.

Returns
Distortion coefficient p1.

◆ P2()

double P2 ( ) const

Get the tangential distortion coefficient p2.

Returns
Distortion coefficient p2.

◆ Print()

virtual void Print ( std::ostream _out) const
overridevirtual

Documentation inherited.

Reimplemented from Distortion.

Reimplemented in ImageBrownDistortionModel.


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