#include <ossim2dTo2dTransform.h>

Inheritance diagram for ossim2dTo2dTransform:

Public Member Functions
virtual void	forward (const ossimDpt &input, ossimDpt &output) const =0

virtual void	forward (ossimDpt &modify_this) const

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

virtual std::ostream &	print (std::ostream &out) const
	Generic print method. More...

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

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

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

Protected Member Functions
	ossim2dTo2dTransform ()

virtual	~ossim2dTo2dTransform ()

Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

Protected Attributes
double	theConvergenceThreshold

int	theMaxIterations

ossimDpt	theDxDy

Detailed Description

Definition at line 17 of file ossim2dTo2dTransform.h.

Constructor & Destructor Documentation

◆ ossim2dTo2dTransform()

ossim2dTo2dTransform::ossim2dTo2dTransform ( )

protected

Definition at line 47 of file ossim2dTo2dTransform.cpp.

    :
       theConvergenceThreshold (DEFAULT_THRESHOLD),
       theMaxIterations        (DEFAULT_MAX_ITERATIONS),
       theDxDy(1.0, 1.0)
 {
 }

◆ ~ossim2dTo2dTransform()

virtual ossim2dTo2dTransform::~ossim2dTo2dTransform ( )

inlineprotectedvirtual

Definition at line 55 of file ossim2dTo2dTransform.h.

55 {}

Member Function Documentation

◆ forward() [1/2]

virtual void ossim2dTo2dTransform::forward	(	const ossimDpt &	input,
		ossimDpt &	output
	)		const

pure virtual

Implemented in ossimQuadTreeWarp, ossim2dTo2dMatrixTransform, ossim2dBilinearTransform, ossimRadialDecentLensDistortion, ossim2dTo2dShiftTransform, ossimAffineTransform, ossimImageViewTransform, ossimLensDistortion, and ossim2dTo2dIdentityTransform.

Referenced by forward(), and ossimImageGeometry::rnToFull().

◆ forward() [2/2]

void ossim2dTo2dTransform::forward ( ossimDpt & modify_this ) const

virtual

Reimplemented in ossimQuadTreeWarp, ossim2dTo2dMatrixTransform, ossim2dBilinearTransform, ossimRadialDecentLensDistortion, ossim2dTo2dShiftTransform, and ossim2dTo2dIdentityTransform.

Definition at line 225 of file ossim2dTo2dTransform.cpp.

References forward().

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

◆ getOrigin()

ossimDpt ossim2dTo2dTransform::getOrigin ( ) const

virtual

Used by the inverse iterator. This will give it a good initial value that is within the input transforms

Reimplemented in ossimQuadTreeWarp, and ossimAffineTransform.

Definition at line 239 of file ossim2dTo2dTransform.cpp.

 {
    return ossimDpt(0,0);
 }

◆ inverse() [1/2]

void ossim2dTo2dTransform::inverse	(	const ossimDpt &	input,
		ossimDpt &	output
	)		const

virtual

Reimplemented in ossim2dTo2dMatrixTransform, ossim2dBilinearTransform, ossim2dTo2dShiftTransform, ossim2dTo2dIdentityTransform, ossimAffineTransform, and ossimImageViewTransform.

Definition at line 58 of file ossim2dTo2dTransform.cpp.

Referenced by ossimImageGeometry::fullToRn(), inverse(), and ossimImageViewTransform::viewToImage().

 {
    static const char MODULE[] = "ossim2dTo2dTransform::inverse";
    if (traceExec())  ossimNotify(ossimNotifyLevel_DEBUG) << "DEBUG: " << MODULE << ", entering...\n";
    
    //***
    // Begin with guess. Forward transform is defined as trasforming left to
    // right. We are therefore solving for left:
    //***
    ossimDpt left = getOrigin();
    ossimDpt left_dx;
    ossimDpt left_dy;
    ossimDpt right;
    ossimDpt right_dx;
    ossimDpt right_dy;
    ossimDpt dr_dx;
    ossimDpt dr_dy;
    ossimDpt r_diff;
    ossimDpt l_diff;
    double inverse_norm;
    int iters=0;
    //***
    // Begin iterations:
    //***
    do
    {
       //***
       // establish perturbed image points about the guessed point:
       //***
       left_dx.x = left.x + theDxDy.x;
       left_dx.y = left.y;
       left_dy.x = left.x;
       left_dy.y = left.y + theDxDy.y;
       
       //***
       // Compute numerical partials at current guessed point:
       //***
       forward(left,    right);
       forward(left_dx, right_dx);
       forward(left_dy, right_dy);
 
       dr_dx.x = (right_dx.x - right.x)/theDxDy.x; //e
       dr_dx.y = (right_dx.y - right.y)/theDxDy.y; //g
       dr_dy.x = (right_dy.x - right.x)/theDxDy.x; //f
       dr_dy.y = (right_dy.y - right.y)/theDxDy.y; //h
 
       //***
       // Test for convergence:
       //***
       r_diff = input - right;
       
       //***
       // Compute linearized estimate of image point given gp delta:
       //***
       inverse_norm = dr_dy.x*dr_dx.y - dr_dx.x*dr_dy.y; // fg-eh
 
       if (inverse_norm != 0)
       {
          l_diff.x = (-dr_dy.y*r_diff.x + dr_dy.x*r_diff.y)/inverse_norm;
          l_diff.y = ( dr_dx.y*r_diff.x - dr_dx.x*r_diff.y)/inverse_norm;
 
          left += l_diff;
       }
       else
       {
          l_diff.x = 0;
          l_diff.y = 0;
       }
 
       iters++;
       
    } while (((fabs(l_diff.x) > theConvergenceThreshold) ||
              (fabs(l_diff.y) > theConvergenceThreshold)) &&
             (iters < theMaxIterations));
 
    //***
    // Note that this error mesage appears only if max count was reached while
    // iterating. A linear (no iteration) solution would finish with iters =
    // MAX_NUM_ITERATIONS + 1:
    //***
     if (iters == theMaxIterations)
     {
        ossimNotify(ossimNotifyLevel_WARN) << "WARNING: " << MODULE << ", exceeded max number of iterations computing inverse "
                                           << "transform for point: " << input << "\n";
     }
 
    output = left;
    if (traceExec())  ossimNotify(ossimNotifyLevel_DEBUG) << "DEBUG: " << MODULE << ", returning...\n";
    return;
    
 }

◆ inverse() [2/2]

void ossim2dTo2dTransform::inverse ( ossimDpt & modify_this ) const

virtual

Reimplemented in ossim2dTo2dMatrixTransform, ossim2dBilinearTransform, ossim2dTo2dShiftTransform, and ossim2dTo2dIdentityTransform.

Definition at line 232 of file ossim2dTo2dTransform.cpp.

References inverse().

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

◆ loadState()

bool ossim2dTo2dTransform::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 ossimObject.

Reimplemented in ossimQuadTreeWarp, ossim2dTo2dMatrixTransform, ossim2dBilinearTransform, ossimImageViewAffineTransform, ossimImageViewTransform, ossimMeanRadialLensDistortion, ossim2dTo2dShiftTransform, ossimImageViewProjectionTransform, ossimRadialDecentLensDistortion, ossimTangentialRadialLensDistortion, ossimAffineTransform, and ossimLensDistortion.

Definition at line 177 of file ossim2dTo2dTransform.cpp.

References ossimKeywordNames::CONVERGENCE_THRESHOLD_KW, ossimKeywordlist::find(), ossimObject::loadState(), ossimKeywordNames::MAX_ITERATIONS_KW, ossimString::split(), theConvergenceThreshold, theDxDy, theMaxIterations, ossimString::trim(), ossimDpt::x, and ossimDpt::y.

Referenced by ossim2dTo2dTransformFactory::createTransform(), ossimLensDistortion::loadState(), ossimAffineTransform::loadState(), ossimRadialDecentLensDistortion::loadState(), ossim2dTo2dShiftTransform::loadState(), ossimImageViewTransform::loadState(), ossim2dBilinearTransform::loadState(), ossim2dTo2dMatrixTransform::loadState(), ossimQuadTreeWarp::loadState(), ossimAffineProjection::ossimAffineProjection(), and ossimWarpProjection::ossimWarpProjection().

 {
   bool result = true;
 
    const char* buf;
 
    buf= kwl.find(prefix, ossimKeywordNames::CONVERGENCE_THRESHOLD_KW);
 
    if (buf)
    {
       theConvergenceThreshold = atof(buf);
    }
    else
    {
       theConvergenceThreshold = .00000000000002;
    }
    
    buf= kwl.find(prefix, ossimKeywordNames::MAX_ITERATIONS_KW);
    if(buf)
    {
       theMaxIterations = atoi(buf);
    }
    else
    {
       theMaxIterations = 10;
    }
    const char* dxdy = kwl.find(prefix, "dxdy");
    if(dxdy)
    {
       ossimString tempString(dxdy);
       std::vector<ossimString> splitArray;
       tempString = tempString.trim();
       tempString.split(splitArray, " ");
       if(splitArray.size()==2)
       {
          theDxDy.x = splitArray[0].toDouble();
          theDxDy.y = splitArray[1].toDouble();
       }
    }
    if(result)
    {
       ossimObject::loadState(kwl, prefix);
    }
    
    return result;
 }

◆ operator=()

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

virtual

Definition at line 260 of file ossim2dTo2dTransform.cpp.

References ossimReferenced::operator=(), theConvergenceThreshold, theDxDy, and theMaxIterations.

Referenced by ossimAffineTransform::operator=(), ossim2dTo2dShiftTransform::operator=(), ossim2dTo2dIdentityTransform::operator=(), ossim2dBilinearTransform::operator=(), and ossim2dTo2dMatrixTransform::operator=().

 {
    if (this != &rhs)
    {
       ossimObject::operator = (rhs);
       
       theConvergenceThreshold = rhs.theConvergenceThreshold;
       theMaxIterations        = rhs.theMaxIterations;
       theDxDy                 = rhs.theDxDy;
    }
    return *this;
 }

◆ print()

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

virtual

Generic print method.

Derived classes should re-implement as they see fit.

Returns: std::ostream&

Reimplemented from ossimObject.

Reimplemented in ossim2dTo2dMatrixTransform, ossim2dBilinearTransform, ossimQuadTreeWarp, ossimRadialDecentLensDistortion, ossim2dTo2dShiftTransform, ossimAffineTransform, ossimImageViewTransform, ossimMeanRadialLensDistortion, ossimImageViewProjectionTransform, and ossimTangentialRadialLensDistortion.

Definition at line 273 of file ossim2dTo2dTransform.cpp.

References theConvergenceThreshold, theDxDy, and theMaxIterations.

Referenced by ossim2dTo2dShiftTransform::print(), ossim2dBilinearTransform::print(), ossim2dTo2dMatrixTransform::print(), and ossimImageGeometry::print().

 {
    out << "convergenceThreshold: " << theConvergenceThreshold << "\n"
    << "maxIterations:        " << theMaxIterations << "\n"
    << "dxdy:                 " << theDxDy << "\n";
    return out;
 }

◆ saveState()

bool ossim2dTo2dTransform::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 ossimObject.

Reimplemented in ossimQuadTreeWarp, ossim2dTo2dMatrixTransform, ossim2dBilinearTransform, ossimImageViewAffineTransform, ossimImageViewTransform, ossimImageViewProjectionTransform, ossimMeanRadialLensDistortion, ossim2dTo2dShiftTransform, ossimRadialDecentLensDistortion, ossimTangentialRadialLensDistortion, ossimAffineTransform, and ossimLensDistortion.

Definition at line 154 of file ossim2dTo2dTransform.cpp.

References ossimKeywordlist::add(), ossimKeywordNames::CONVERGENCE_THRESHOLD_KW, ossimKeywordNames::MAX_ITERATIONS_KW, ossimObject::saveState(), theConvergenceThreshold, theDxDy, theMaxIterations, ossimString::toString(), ossimDpt::x, and ossimDpt::y.

Referenced by ossimLensDistortion::saveState(), ossimAffineTransform::saveState(), ossimRadialDecentLensDistortion::saveState(), ossim2dTo2dShiftTransform::saveState(), ossimImageViewTransform::saveState(), ossim2dBilinearTransform::saveState(), ossim2dTo2dMatrixTransform::saveState(), ossimQuadTreeWarp::saveState(), and ossimImageGeometry::saveState().

 {
    kwl.add(prefix,
            ossimKeywordNames::CONVERGENCE_THRESHOLD_KW,
            theConvergenceThreshold,
            true);
    kwl.add(prefix,
            ossimKeywordNames::MAX_ITERATIONS_KW,
            theMaxIterations,
            true);
    kwl.add(prefix,
            "dxdy",
            ossimString::toString(theDxDy.x) + " " +
            ossimString::toString(theDxDy.y),
            true);
            
    return ossimObject::saveState(kwl, prefix);
 }

◆ setConvergenceThreshold()

void ossim2dTo2dTransform::setConvergenceThreshold ( const double & new_threshold )

Definition at line 244 of file ossim2dTo2dTransform.cpp.

References theConvergenceThreshold.

 {
    theConvergenceThreshold = new_threshold;
 }

◆ setDxDy()

void ossim2dTo2dTransform::setDxDy ( const ossimDpt & dxdy )

Definition at line 254 of file ossim2dTo2dTransform.cpp.

References theDxDy, ossimDpt::x, and ossimDpt::y.

 {
    theDxDy.x = dxdy.x;
    theDxDy.y = dxdy.y;
 }

◆ setMaxIterations()

void ossim2dTo2dTransform::setMaxIterations ( int new_max_iters )

Definition at line 249 of file ossim2dTo2dTransform.cpp.

References theMaxIterations.

 {
    theMaxIterations = new_max_iters;
 }

Member Data Documentation

◆ theConvergenceThreshold

double ossim2dTo2dTransform::theConvergenceThreshold

protected

Definition at line 56 of file ossim2dTo2dTransform.h.

Referenced by ossimLensDistortion::distort(), loadState(), operator=(), print(), saveState(), and setConvergenceThreshold().

◆ theDxDy

ossimDpt ossim2dTo2dTransform::theDxDy

protected

Definition at line 59 of file ossim2dTo2dTransform.h.

Referenced by loadState(), operator=(), print(), saveState(), and setDxDy().

◆ theMaxIterations

int ossim2dTo2dTransform::theMaxIterations

protected

Definition at line 57 of file ossim2dTo2dTransform.h.

Referenced by ossimLensDistortion::distort(), loadState(), operator=(), print(), saveState(), and setMaxIterations().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ossim2dTo2dTransform()

◆ ~ossim2dTo2dTransform()

Member Function Documentation

◆ forward() [1/2]

◆ forward() [2/2]

◆ getOrigin()

◆ inverse() [1/2]

◆ inverse() [2/2]

◆ loadState()

◆ operator=()

◆ print()

◆ saveState()

◆ setConvergenceThreshold()

◆ setDxDy()

◆ setMaxIterations()

Member Data Documentation

◆ theConvergenceThreshold

◆ theDxDy

◆ theMaxIterations