ossimAffineTransform Class Reference

#include <ossimAffineTransform.h>

Inheritance diagram for ossimAffineTransform:

Public Member Functions
	ossimAffineTransform ()
	ossimAffineTransform (const ossimAffineTransform &src)
virtual const ossimAffineTransform &	operator= (const ossimAffineTransform &rhs)
	assignment operator= More...
virtual ossimObject *	dup () const
virtual void	forward (const ossimDpt &input, ossimDpt &output) const
virtual void	inverse (const ossimDpt &input, ossimDpt &output) const
virtual ossimDpt	getOrigin () const
bool	saveState (ossimKeywordlist &kwl, const char *prefix=0) const
bool	loadState (const ossimKeywordlist &kwl, const char *prefix=0)
void	setMatrix (double rotation, const ossimDpt &scale, const ossimDpt &translation)
void	setScale (const ossimDpt &scale)
void	setRotation (double rotation)
void	setTranslation (const ossimDpt &translation)
ossimDpt	getScale () const
ossimDpt	getTranslation () const
double	getRotation () const
void	setIdentity ()
void	setAffineEnabledFlag (bool flag)
virtual std::ostream &	print (std::ostream &out) const
	Generic print method. More...
Public Member Functions inherited from ossim2dTo2dTransform
virtual void	forward (ossimDpt &modify_this) const
virtual void	inverse (ossimDpt &modify_this) const
virtual const ossim2dTo2dTransform &	operator= (const ossim2dTo2dTransform &rhs)
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 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
void	computeMatrix ()
Protected Member Functions inherited from ossim2dTo2dTransform
	ossim2dTo2dTransform ()
virtual	~ossim2dTo2dTransform ()
Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

Protected Attributes
ossimDpt	theScale
double	theRotation
ossimDpt	theTranslation
bool	theAffineEnabledFlag
NEWMAT::Matrix	theForwardXform
NEWMAT::Matrix	theInverseXform
Protected Attributes inherited from ossim2dTo2dTransform
double	theConvergenceThreshold
int	theMaxIterations
ossimDpt	theDxDy

Detailed Description

Definition at line 16 of file ossimAffineTransform.h.

Constructor & Destructor Documentation

ossimAffineTransform() [1/2]

ossimAffineTransform::ossimAffineTransform

(

)

Definition at line 25 of file ossimAffineTransform.cpp.

References setIdentity().

   :
      ossim2dTo2dTransform(),
      theScale(1.0, 1.0),
      theRotation(0.0),
      theTranslation(0.0, 0.0),
      theAffineEnabledFlag(true),      
      theForwardXform(3, 3),
      theInverseXform(3, 3)
{
   setIdentity();
}

ossimAffineTransform() [2/2]

ossimAffineTransform::ossimAffineTransform

(

const ossimAffineTransform &

src

)

Definition at line 38 of file ossimAffineTransform.cpp.

   :
      ossim2dTo2dTransform(src),
      theScale(src.theScale),
      theRotation(src.theRotation),
      theTranslation(src.theTranslation),
      theAffineEnabledFlag(src.theAffineEnabledFlag),
      theForwardXform(src.theForwardXform),
      theInverseXform(src.theInverseXform)
{
}

Member Function Documentation

computeMatrix()

void ossimAffineTransform::computeMatrix ( )

protected

Definition at line 210 of file ossimAffineTransform.cpp.

References ossimMatrix3x3::createRotationZMatrix(), ossimMatrix3x3::createScaleMatrix(), ossimMatrix3x3::createTranslationMatrix(), theForwardXform, theInverseXform, theRotation, theScale, theTranslation, ossimDpt::x, and ossimDpt::y.

Referenced by loadState(), setIdentity(), and setMatrix().

{
   theForwardXform =
      ossimMatrix3x3::createTranslationMatrix(theTranslation.x, 
                                              theTranslation.y)* 
      ossimMatrix3x3::createRotationZMatrix(theRotation)* 
      ossimMatrix3x3::createScaleMatrix(theScale.x,
                                        theScale.y,
                                        1.0);

   //***
   // The inverse transform is just the matrix inverse:
   //***
   theInverseXform = theForwardXform.i();
}

dup()

virtual ossimObject* ossimAffineTransform::dup ( ) const

inlinevirtual

Reimplemented from ossimObject.

Definition at line 30 of file ossimAffineTransform.h.

   {
      return new ossimAffineTransform(*this);
   }

forward()

void ossimAffineTransform::forward ( const ossimDpt &  input, ossimDpt &  output  ) const

virtual

Implements ossim2dTo2dTransform.

Definition at line 70 of file ossimAffineTransform.cpp.

References theAffineEnabledFlag, theForwardXform, ossimDpt::x, and ossimDpt::y.

{
   if(theAffineEnabledFlag)
   {
      output.x = theForwardXform[0][0]*input.x+
                 theForwardXform[0][1]*input.y+
                 theForwardXform[0][2];
      output.y = theForwardXform[1][0]*input.x+
                 theForwardXform[1][1]*input.y+
                 theForwardXform[1][2];
   }
   else
   {
      output = input;
   }
}

getOrigin()

virtual ossimDpt ossimAffineTransform::getOrigin ( ) const

inlinevirtual

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

Reimplemented from ossim2dTo2dTransform.

Definition at line 43 of file ossimAffineTransform.h.

      {
         return ossimDpt(0,0);
      }

getRotation()

double ossimAffineTransform::getRotation ( ) const

inline

Definition at line 83 of file ossimAffineTransform.h.

      {
         return theRotation;
      }

getScale()

ossimDpt ossimAffineTransform::getScale ( ) const

inline

Definition at line 75 of file ossimAffineTransform.h.

      {
         return theScale;
      }

getTranslation()

ossimDpt ossimAffineTransform::getTranslation ( ) const

inline

Definition at line 79 of file ossimAffineTransform.h.

      {
         return theTranslation;
      }

inverse()

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

virtual

Reimplemented from ossim2dTo2dTransform.

Definition at line 91 of file ossimAffineTransform.cpp.

References theAffineEnabledFlag, theInverseXform, ossimDpt::x, and ossimDpt::y.

{
   if(theAffineEnabledFlag)
   {
      output.x = theInverseXform[0][0]*input.x+
                 theInverseXform[0][1]*input.y+
                 theInverseXform[0][2];
      output.y = theInverseXform[1][0]*input.x+
                 theInverseXform[1][1]*input.y+
                 theInverseXform[1][2];
   }
   else
   {
      output = input;
   }
}

loadState()

bool ossimAffineTransform::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 144 of file ossimAffineTransform.cpp.

References computeMatrix(), ossimKeywordlist::find(), ossim2dTo2dTransform::loadState(), ossimKeywordNames::ROTATION_KW, ossimKeywordNames::SCALE_X_KW, ossimKeywordNames::SCALE_Y_KW, theRotation, theScale, theTranslation, ossimKeywordNames::TRANSLATION_X_KW, ossimKeywordNames::TRANSLATION_Y_KW, ossimDpt::x, and ossimDpt::y.

{
   const char* buf;

   if (!ossim2dTo2dTransform::loadState(kwl, prefix))
      goto BAD_KEYWORD;
       
   buf= kwl.find(prefix, ossimKeywordNames::SCALE_X_KW);
   if (!buf) goto BAD_KEYWORD;
   theScale.x = std::atof(buf);

   buf= kwl.find(prefix, ossimKeywordNames::SCALE_Y_KW);
   if (!buf) goto BAD_KEYWORD;
   theScale.y = std::atof(buf);

   buf= kwl.find(prefix, ossimKeywordNames::TRANSLATION_X_KW);
   if (!buf) goto BAD_KEYWORD;
   theTranslation.x = std::atof(buf);

   buf= kwl.find(prefix, ossimKeywordNames::TRANSLATION_Y_KW);
   if (!buf) goto BAD_KEYWORD;
   theTranslation.y = std::atof(buf);

   buf= kwl.find(prefix, ossimKeywordNames::ROTATION_KW);
   if (!buf) goto BAD_KEYWORD;
   theRotation = std::atof(buf);

   computeMatrix();   
   return true;

 BAD_KEYWORD:
   return false;
}

operator=()

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

virtual

assignment operator=

Parameters

rhs	The data to assign from.
A	reference to this object.

Definition at line 50 of file ossimAffineTransform.cpp.

References ossim2dTo2dTransform::operator=(), theAffineEnabledFlag, theForwardXform, theInverseXform, theRotation, theScale, and theTranslation.

{
   if (this != &rhs)
   {
      ossim2dTo2dTransform::operator=(rhs);
      
      theScale             = rhs.theScale;
      theRotation          = rhs.theRotation;
      theTranslation       = rhs.theTranslation;
      theAffineEnabledFlag = rhs.theAffineEnabledFlag;
      theForwardXform      = rhs.theForwardXform;
      theInverseXform      = rhs.theInverseXform;
   }
   return *this;
}

print()

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

virtual

Generic print method.

Derived classes should re-implement as they see fit.

Returns

std::ostream&

Reimplemented from ossim2dTo2dTransform.

Definition at line 230 of file ossimAffineTransform.cpp.

References theRotation, theScale, and theTranslation.

{
   os << "ossimAffineTransform:"
      << "\n  theScale       = " << theScale
      << "\n  theTranslation = " << theTranslation
      << "\n  theRotation    = " << theRotation << std::endl;
   return os;
}

saveState()

bool ossimAffineTransform::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 112 of file ossimAffineTransform.cpp.

References ossimKeywordlist::add(), ossimKeywordNames::ROTATION_KW, ossim2dTo2dTransform::saveState(), ossimKeywordNames::SCALE_X_KW, ossimKeywordNames::SCALE_Y_KW, theRotation, theScale, theTranslation, ossimKeywordNames::TRANSLATION_X_KW, ossimKeywordNames::TRANSLATION_Y_KW, ossimDpt::x, and ossimDpt::y.

{
   kwl.add(prefix,
           ossimKeywordNames::SCALE_X_KW,
           theScale.x,
           true);
   kwl.add(prefix,
           ossimKeywordNames::SCALE_Y_KW,
           theScale.y,
           true);
   kwl.add(prefix,
           ossimKeywordNames::TRANSLATION_X_KW,
           theTranslation.x,
           true);
   kwl.add(prefix,
           ossimKeywordNames::TRANSLATION_Y_KW,
           theTranslation.y,
           true);
   kwl.add(prefix,
           ossimKeywordNames::ROTATION_KW,
           theRotation,
           true);

   ossim2dTo2dTransform::saveState(kwl, prefix);
   
   return true;
}

setAffineEnabledFlag()

void ossimAffineTransform::setAffineEnabledFlag ( bool  flag )

inline

Definition at line 89 of file ossimAffineTransform.h.

      {
         theAffineEnabledFlag = flag;
      }

setIdentity()

void ossimAffineTransform::setIdentity

(

)

Definition at line 196 of file ossimAffineTransform.cpp.

References computeMatrix(), theRotation, theScale, theTranslation, ossimDpt::x, and ossimDpt::y.

Referenced by ossimAffineTransform().

{
   theScale.x       = 1;
   theScale.y       = 1;
   theTranslation.x = 0;
   theTranslation.y = 0;
   theRotation      = 0.0;
   
   computeMatrix();
}

setMatrix()

void ossimAffineTransform::setMatrix	(	double	rotation,
		const ossimDpt &	scale,
		const ossimDpt &	translation
	)

Definition at line 182 of file ossimAffineTransform.cpp.

References computeMatrix(), theRotation, theScale, and theTranslation.

{
   theScale       = scale;
   theRotation    = rotation;
   theTranslation = translation;
   
   computeMatrix();
}

setRotation()

void ossimAffineTransform::setRotation ( double  rotation )

inline

Definition at line 64 of file ossimAffineTransform.h.

      {
         theRotation = rotation;
         computeMatrix();
      }

setScale()

void ossimAffineTransform::setScale ( const ossimDpt &  scale )

inline

Definition at line 58 of file ossimAffineTransform.h.

      {
         theScale       = scale;
         computeMatrix();
      }

setTranslation()

void ossimAffineTransform::setTranslation ( const ossimDpt &  translation )

inline

Definition at line 70 of file ossimAffineTransform.h.

      {
         theTranslation = translation;
         computeMatrix();
      }

Member Data Documentation

theAffineEnabledFlag

bool ossimAffineTransform::theAffineEnabledFlag

protected

Definition at line 101 of file ossimAffineTransform.h.

Referenced by forward(), inverse(), and operator=().

theForwardXform

NEWMAT::Matrix ossimAffineTransform::theForwardXform

protected

Definition at line 103 of file ossimAffineTransform.h.

Referenced by computeMatrix(), forward(), and operator=().

theInverseXform

NEWMAT::Matrix ossimAffineTransform::theInverseXform

protected

Definition at line 104 of file ossimAffineTransform.h.

Referenced by computeMatrix(), inverse(), and operator=().

theRotation

double ossimAffineTransform::theRotation

protected

Definition at line 99 of file ossimAffineTransform.h.

Referenced by computeMatrix(), loadState(), operator=(), print(), saveState(), setIdentity(), and setMatrix().

theScale

ossimDpt ossimAffineTransform::theScale

protected

Definition at line 98 of file ossimAffineTransform.h.

Referenced by computeMatrix(), loadState(), operator=(), print(), saveState(), setIdentity(), and setMatrix().

theTranslation

ossimDpt ossimAffineTransform::theTranslation

protected

Definition at line 100 of file ossimAffineTransform.h.

Referenced by computeMatrix(), loadState(), operator=(), print(), saveState(), setIdentity(), and setMatrix().

---

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

• ossimAffineTransform.h
• ossimAffineTransform.cpp