#include <ossimRadialDecentLensDistortion.h>

Inheritance diagram for ossimRadialDecentLensDistortion:

Public Member Functions
	ossimRadialDecentLensDistortion ()

	ossimRadialDecentLensDistortion (const ossimDpt &calibratedPrincipalPoint, const NEWMAT::ColumnVector &radialDistortionParameters, const NEWMAT::ColumnVector &decentDistortionParameters)

	ossimRadialDecentLensDistortion (const ossimRadialDecentLensDistortion &copy)

	ossimRadialDecentLensDistortion (const ossimKeywordlist &kwl, const char *prefix)

virtual	~ossimRadialDecentLensDistortion ()

virtual void	forward (const ossimDpt &undistorted_point_in, ossimDpt &distorted_point_out) const

virtual void	forward (ossimDpt &modify_this) const

virtual bool	saveState (ossimKeywordlist &kwl, const char *prefix=0) const

virtual bool	loadState (const ossimKeywordlist &kwl, const char *prefix=0)

void	setPrincipalPoint (const ossimDpt pp)

void	setRadialDistortionParams (const NEWMAT::ColumnVector &params)

void	setDecentDistortionParams (const NEWMAT::ColumnVector &params)

virtual std::ostream &	print (std::ostream &out) const

Public Member Functions inherited from ossim2dTo2dTransform
virtual void	inverse (const ossimDpt &input, ossimDpt &output) const

virtual void	inverse (ossimDpt &modify_this) const

virtual const ossim2dTo2dTransform &	operator= (const ossim2dTo2dTransform &rhs)

virtual ossimDpt	getOrigin () const

void	setConvergenceThreshold (const double &new_threshold)

void	setMaxIterations (int new_max_iters)

void	setDxDy (const ossimDpt &dxdy)

Public Member Functions inherited from ossimObject
	ossimObject ()

virtual	~ossimObject ()

virtual ossimObject *	dup () const

virtual ossimString	getShortName () const

virtual ossimString	getLongName () const

virtual ossimString	getDescription () const

virtual ossimString	getClassName () const

virtual RTTItypeid	getType () const

virtual bool	canCastTo (ossimObject *obj) const

virtual bool	canCastTo (const RTTItypeid &id) const

virtual bool	canCastTo (const ossimString &parentClassName) const

virtual bool	isEqualTo (const ossimObject &obj, ossimCompareType compareType=OSSIM_COMPARE_FULL) const

virtual void	accept (ossimVisitor &visitor)

Public Member Functions inherited from ossimReferenced
	ossimReferenced ()

	ossimReferenced (const ossimReferenced &)

ossimReferenced &	operator= (const ossimReferenced &)

void	ref () const
	increment the reference count by one, indicating that this object has another pointer which is referencing it. More...

void	unref () const
	decrement the reference count by one, indicating that a pointer to this object is referencing it. More...

void	unref_nodelete () const
	decrement the reference count by one, indicating that a pointer to this object is referencing it. More...

int	referenceCount () const

Static Public Attributes
static const char *	PRINCIPAL_POINT_X_KW = "principal_point_x"

static const char *	PRINCIPAL_POINT_Y_KW = "principal_point_y"

static const char *	RADIAL_DISTORTION_COEFF_KW = "radial_distortion_coeff_K"

static const char *	DECENT_DISTORTION_COEFF_KW = "decent_distortion_coeff_P"

Protected Member Functions
virtual double	deltaR (double radius) const

Protected Member Functions inherited from ossim2dTo2dTransform
	ossim2dTo2dTransform ()

virtual	~ossim2dTo2dTransform ()

Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

Protected Attributes
ossimDpt	theCalibratedPrincipalPoint

NEWMAT::ColumnVector	theRadialDistortionParameters

NEWMAT::ColumnVector	theDecentDistortionParameters

Protected Attributes inherited from ossim2dTo2dTransform
double	theConvergenceThreshold

int	theMaxIterations

ossimDpt	theDxDy

Detailed Description

Definition at line 48 of file ossimRadialDecentLensDistortion.h.

Constructor & Destructor Documentation

◆ ossimRadialDecentLensDistortion() [1/4]

ossimRadialDecentLensDistortion::ossimRadialDecentLensDistortion ( )

inline

Definition at line 52 of file ossimRadialDecentLensDistortion.h.

52 {}

◆ ossimRadialDecentLensDistortion() [2/4]

ossimRadialDecentLensDistortion::ossimRadialDecentLensDistortion	(	const ossimDpt &	calibratedPrincipalPoint,
		const NEWMAT::ColumnVector &	radialDistortionParameters,
		const NEWMAT::ColumnVector &	decentDistortionParameters
	)

inline

Definition at line 54 of file ossimRadialDecentLensDistortion.h.

       : theCalibratedPrincipalPoint(calibratedPrincipalPoint),
         theRadialDistortionParameters(radialDistortionParameters),
         theDecentDistortionParameters(decentDistortionParameters)
       {  }

◆ ossimRadialDecentLensDistortion() [3/4]

ossimRadialDecentLensDistortion::ossimRadialDecentLensDistortion ( const ossimRadialDecentLensDistortion & copy )

inline

Definition at line 62 of file ossimRadialDecentLensDistortion.h.

       : theCalibratedPrincipalPoint (copy.theCalibratedPrincipalPoint),
         theRadialDistortionParameters (copy.theRadialDistortionParameters),
         theDecentDistortionParameters (copy.theDecentDistortionParameters) { }

◆ ossimRadialDecentLensDistortion() [4/4]

ossimRadialDecentLensDistortion::ossimRadialDecentLensDistortion	(	const ossimKeywordlist &	kwl,
		const char *	prefix
	)

Definition at line 34 of file ossimRadialDecentLensDistortion.cpp.

    :
    theCalibratedPrincipalPoint (0, 0),
    theRadialDistortionParameters(5),
    theDecentDistortionParameters(5)
 {
    loadState(kwl, prefix);
 }

◆ ~ossimRadialDecentLensDistortion()

virtual ossimRadialDecentLensDistortion::~ossimRadialDecentLensDistortion ( )

inlinevirtual

Definition at line 70 of file ossimRadialDecentLensDistortion.h.

70 {}

Member Function Documentation

◆ deltaR()

double ossimRadialDecentLensDistortion::deltaR ( double radius ) const

protectedvirtual

default implementation Will solve the polynomial:

k0 + k1*r^2 + k2*r^4 + k3*r^6 + k4*r^8

Definition at line 142 of file ossimRadialDecentLensDistortion.cpp.

References theRadialDistortionParameters.

Referenced by forward().

 {
   double rSquare = radius*radius;
 
   return theRadialDistortionParameters[0] +
      rSquare*(theRadialDistortionParameters[1] +
               rSquare*(theRadialDistortionParameters[2] +
                        rSquare*(theRadialDistortionParameters[3] +
                                 rSquare*theRadialDistortionParameters[4])));
 }

◆ forward() [1/2]

void ossimRadialDecentLensDistortion::forward	(	const ossimDpt &	undistorted_point_in,
		ossimDpt &	distorted_point_out
	)		const

virtual

Implementation of base class 2D-to-2D transformation. The "forward" transformation is defined here as going from an undistorted ideal point to a distorted real point, i.e., adding distortion.

Also available (implemented in the base class) are: inverse(distorted_point_in, undistorted_pt_out) inverse(undistort_this_pt)

Implements ossim2dTo2dTransform.

Definition at line 156 of file ossimRadialDecentLensDistortion.cpp.

References deltaR(), ossim::square(), theCalibratedPrincipalPoint, theDecentDistortionParameters, ossimDpt::x, and ossimDpt::y.

 {
    ossimDpt deltaPosition(input_pt.x - theCalibratedPrincipalPoint.x,
                           input_pt.y - theCalibratedPrincipalPoint.y);
    double r = sqrt(ossim::square(deltaPosition.x) + 
                    ossim::square(deltaPosition.y));
    double dr = deltaR(r);
    double deltaX1 = deltaPosition.x*dr;
    double deltaY1 = deltaPosition.y*dr;
 
    double rSquare = r*r;
    double deltaX2 =  (1 + theDecentDistortionParameters[3]*rSquare +
                       theDecentDistortionParameters[4]*rSquare*rSquare)*
                      (theDecentDistortionParameters[1]*(rSquare + 2*deltaPosition.x*deltaPosition.x) +
                       2*theDecentDistortionParameters[2]*deltaPosition.x*deltaPosition.y);
    
    double deltaY2 =  (1 + theDecentDistortionParameters[3]*rSquare +  theDecentDistortionParameters[4]*rSquare*rSquare)*
                      (theDecentDistortionParameters[2]*(rSquare + 2*deltaPosition.y*deltaPosition.y) +
                       2*theDecentDistortionParameters[1]*deltaPosition.x*deltaPosition.y);
 
    output_pt.x = deltaPosition.x + deltaX1 + deltaX2;
    output_pt.y = deltaPosition.y + deltaY1 + deltaY2;
 }

◆ forward() [2/2]

virtual void ossimRadialDecentLensDistortion::forward ( ossimDpt & modify_this ) const

inlinevirtual

Reimplemented from ossim2dTo2dTransform.

Definition at line 84 of file ossimRadialDecentLensDistortion.h.

       {
          ossimDpt output;
          forward(modify_this, output);
          modify_this = output;
       }

◆ loadState()

bool ossimRadialDecentLensDistortion::loadState	(	const ossimKeywordlist &	kwl,
		const char *	prefix = `0`
	)

virtual

Method to the load (recreate) the state of the object from a keyword list. Return true if ok or false on error.

Reimplemented from ossim2dTo2dTransform.

Definition at line 43 of file ossimRadialDecentLensDistortion.cpp.

References ossimString::c_str(), DECENT_DISTORTION_COEFF_KW, ossimKeywordlist::find(), ossim2dTo2dTransform::loadState(), PRINCIPAL_POINT_X_KW, PRINCIPAL_POINT_Y_KW, RADIAL_DISTORTION_COEFF_KW, theCalibratedPrincipalPoint, theDecentDistortionParameters, theRadialDistortionParameters, ossimString::toDouble(), ossimString::toString(), ossimDpt::x, and ossimDpt::y.

 {
    const char* value;
 
    theCalibratedPrincipalPoint = ossimDpt(0, 0);
 
    value = kwl.find(prefix, PRINCIPAL_POINT_X_KW);
    if (value)
    {
       theCalibratedPrincipalPoint.x = atof(value);
    }
 
    value = kwl.find(prefix, PRINCIPAL_POINT_Y_KW);
    if (value)
    {
       theCalibratedPrincipalPoint.y = atof(value);
    }
    
    for (int i=0; i<5; ++i)
    {
       ossimString key = RADIAL_DISTORTION_COEFF_KW;
       key += ossimString::toString(i);
       value = kwl.find(prefix, key.c_str());
       if (!value)
       {
          theRadialDistortionParameters[i] = 0.0;
       }
       else
       {
          theRadialDistortionParameters[i] = ossimString::toDouble(value);
       }
 
       key = DECENT_DISTORTION_COEFF_KW;
       key += ossimString::toString(i);
       value = kwl.find(prefix, key.c_str());
       if (!value)
       {
          theDecentDistortionParameters[i] = 0.0;
       }
       else
       {
          theDecentDistortionParameters[i] = ossimString::toDouble(value);
       }
    }
 
    //***
    // Pass on to base class:
    //***
    bool rtn_val = ossim2dTo2dTransform::loadState(kwl, prefix);
 
    return rtn_val;
 }

◆ print()

std::ostream & ossimRadialDecentLensDistortion::print ( std::ostream & out ) const

virtual

Dumps contents of object to ostream.

Reimplemented from ossim2dTo2dTransform.

Definition at line 186 of file ossimRadialDecentLensDistortion.cpp.

References theCalibratedPrincipalPoint, theDecentDistortionParameters, and theRadialDistortionParameters.

 {
    os << "\nDump of ossimRadialDecentLensDistortion object" << endl;
    
    os << "  theCalibratedPrincipalPoint: " << theCalibratedPrincipalPoint;
    
    for (unsigned int i=0; i<5; i++)
       os << "\n  K["<<i<<"]: " << theRadialDistortionParameters[i];  
    
    for (unsigned int i=0; i<5; i++)
       os << "\n  P["<<i<<"]: " << theDecentDistortionParameters[i];  
    
    os << endl;
 
    // call base class print???
    
    return os;
 }

◆ saveState()

bool ossimRadialDecentLensDistortion::saveState	(	ossimKeywordlist &	kwl,
		const char *	prefix = `0`
	)		const

virtual

Method to save the state of the object to a keyword list. Return true if ok or false on error.

Reimplemented from ossim2dTo2dTransform.

Definition at line 97 of file ossimRadialDecentLensDistortion.cpp.

References ossimKeywordlist::add(), ossimString::c_str(), DECENT_DISTORTION_COEFF_KW, PRINCIPAL_POINT_X_KW, PRINCIPAL_POINT_Y_KW, RADIAL_DISTORTION_COEFF_KW, ossim2dTo2dTransform::saveState(), theCalibratedPrincipalPoint, theDecentDistortionParameters, theRadialDistortionParameters, ossimString::toString(), ossimDpt::x, and ossimDpt::y.

 {
    //***
    // Principal Point:
    //***
    kwl.add(prefix, PRINCIPAL_POINT_X_KW, theCalibratedPrincipalPoint.x);
    kwl.add(prefix, PRINCIPAL_POINT_Y_KW, theCalibratedPrincipalPoint.y);
    
    for(int i=0; i<5; ++i)
    {
       //---
       // Radial distortion coefficients:
       //---
       ossimString key = RADIAL_DISTORTION_COEFF_KW;
       key += ossimString::toString(i);
       kwl.add(prefix,
               key.c_str(),
               theRadialDistortionParameters[i],
               true,  // overwrite
               15); // scientific
 
       //---
       // Decentering distortion coefficients:
       //---
       key = DECENT_DISTORTION_COEFF_KW;
       key += ossimString::toString(i);
       kwl.add(prefix,
               key.c_str(),
               theDecentDistortionParameters[i],
               true,  // overwrite
               15); // scientific
    }
 
    //***
    // Pass on to base class:
    //***
    bool rtn_val = ossim2dTo2dTransform::saveState(kwl, prefix);
 
    return rtn_val;
 }

◆ setDecentDistortionParams()

void ossimRadialDecentLensDistortion::setDecentDistortionParams ( const NEWMAT::ColumnVector & params )

inline

Definition at line 153 of file ossimRadialDecentLensDistortion.h.

 {
    theDecentDistortionParameters = params;
 }

◆ setPrincipalPoint()

void ossimRadialDecentLensDistortion::setPrincipalPoint ( const ossimDpt pp )

inline

Set methods provide alternative initialization scheme to loadState:

Definition at line 141 of file ossimRadialDecentLensDistortion.h.

 {
    theCalibratedPrincipalPoint = pp;
 }

◆ setRadialDistortionParams()

void ossimRadialDecentLensDistortion::setRadialDistortionParams ( const NEWMAT::ColumnVector & params )

inline

Definition at line 147 of file ossimRadialDecentLensDistortion.h.

 {
    theRadialDistortionParameters = params;
 }

Member Data Documentation

◆ DECENT_DISTORTION_COEFF_KW

const char * ossimRadialDecentLensDistortion::DECENT_DISTORTION_COEFF_KW = "decent_distortion_coeff_P"

static

Definition at line 120 of file ossimRadialDecentLensDistortion.h.

Referenced by loadState(), and saveState().

◆ PRINCIPAL_POINT_X_KW

const char * ossimRadialDecentLensDistortion::PRINCIPAL_POINT_X_KW = "principal_point_x"

static

Definition at line 117 of file ossimRadialDecentLensDistortion.h.

Referenced by loadState(), and saveState().

◆ PRINCIPAL_POINT_Y_KW

const char * ossimRadialDecentLensDistortion::PRINCIPAL_POINT_Y_KW = "principal_point_y"

static

Definition at line 118 of file ossimRadialDecentLensDistortion.h.

Referenced by loadState(), and saveState().

◆ RADIAL_DISTORTION_COEFF_KW

const char * ossimRadialDecentLensDistortion::RADIAL_DISTORTION_COEFF_KW = "radial_distortion_coeff_K"

static

Definition at line 119 of file ossimRadialDecentLensDistortion.h.

Referenced by loadState(), and saveState().

◆ theCalibratedPrincipalPoint

ossimDpt ossimRadialDecentLensDistortion::theCalibratedPrincipalPoint

protected

Definition at line 130 of file ossimRadialDecentLensDistortion.h.

Referenced by forward(), loadState(), print(), and saveState().

◆ theDecentDistortionParameters

NEWMAT::ColumnVector ossimRadialDecentLensDistortion::theDecentDistortionParameters

protected

Definition at line 132 of file ossimRadialDecentLensDistortion.h.

Referenced by forward(), loadState(), print(), and saveState().

◆ theRadialDistortionParameters

NEWMAT::ColumnVector ossimRadialDecentLensDistortion::theRadialDistortionParameters

protected

Definition at line 131 of file ossimRadialDecentLensDistortion.h.

Referenced by deltaR(), loadState(), print(), and saveState().

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

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ossimRadialDecentLensDistortion() [1/4]

◆ ossimRadialDecentLensDistortion() [2/4]

◆ ossimRadialDecentLensDistortion() [3/4]

◆ ossimRadialDecentLensDistortion() [4/4]

◆ ~ossimRadialDecentLensDistortion()

Member Function Documentation

◆ deltaR()

◆ forward() [1/2]

◆ forward() [2/2]

◆ loadState()

◆ print()

◆ saveState()

◆ setDecentDistortionParams()

◆ setPrincipalPoint()

◆ setRadialDistortionParams()

Member Data Documentation

◆ DECENT_DISTORTION_COEFF_KW

◆ PRINCIPAL_POINT_X_KW

◆ PRINCIPAL_POINT_Y_KW

◆ RADIAL_DISTORTION_COEFF_KW

◆ theCalibratedPrincipalPoint

◆ theDecentDistortionParameters

◆ theRadialDistortionParameters