Gazebo Sensors

API Reference

6.8.1
Distortion Class Reference

Distortion models for sensor output signals. More...

#include <ignition/sensors/Distortion.hh>

Public Member Functions

 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...
 
virtual void Load (const sdf::Camera &_sdf)
 Load distortion parameters from sdf. More...
 
virtual void Print (std::ostream &_out) const
 Output information about the distortion model. More...
 
DistortionType Type () const
 Accessor for DistortionType. More...
 

Detailed Description

Distortion models for sensor output signals.

Constructor & Destructor Documentation

◆ Distortion()

Distortion ( DistortionType  _type)
explicit

Constructor. This should not be called directly unless creating an empty distortion model. Use DistortionFactory::NewDistortionModel to instantiate a new distortion model.

Parameters
[in]_typeType of distortion model.
See also
DistortionFactory::NewDistortionModel

◆ ~Distortion()

virtual ~Distortion ( )
virtual

Destructor.

Member Function Documentation

◆ Load()

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

Load distortion parameters from sdf.

Parameters
[in]_sdfSDF Distortion DOM object.

Reimplemented in ImageBrownDistortionModel, and BrownDistortionModel.

◆ Print()

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

Output information about the distortion model.

Parameters
[in]_outOutput stream

Reimplemented in BrownDistortionModel, and ImageBrownDistortionModel.

◆ Type()

DistortionType Type ( ) const

Accessor for DistortionType.

Returns
Type of distortion currently in use.

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