#include <ossim2dTo2dShiftTransform.h>

Inheritance diagram for ossim2dTo2dShiftTransform:

Public Member Functions
	ossim2dTo2dShiftTransform (const ossimDpt &shift=ossimDpt(0.0, 0.0))
	Constructor to initialize the shift transform. More...

	ossim2dTo2dShiftTransform (const ossim2dTo2dShiftTransform &src)
	Copy constructor. More...

virtual ossimObject *	dup () const
	Duplication method that duplicates this object. More...

const ossim2dTo2dShiftTransform &	operator= (const ossim2dTo2dShiftTransform &src)
	operator = allows one to copy the contents of the class through a common = operator. More...

virtual void	forward (const ossimDpt &input, ossimDpt &output) const
	Apply the shift to the input. More...

virtual void	forward (ossimDpt &modify_this) const
	Apply the shift to the input and put the result in the same variable. More...

virtual void	inverse (const ossimDpt &input, ossimDpt &output) const
	Negate the shift to the input and put the result in output. More...

virtual void	inverse (ossimDpt &modify_this) const
	Negate the shift operation and put the result in the same variable. More...

virtual bool	saveState (ossimKeywordlist &kwl, const char *prefix=0) const
	Saves the state of this object. More...

virtual bool	loadState (const ossimKeywordlist &kwl, const char *prefix=0)
	loads the state of this object from a keywordlist. More...

virtual std::ostream &	print (std::ostream &out) const
	Print the contents of the class and pass to the derived class. More...

Public Member Functions inherited from ossim2dTo2dTransform
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 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
virtual	~ossim2dTo2dShiftTransform ()

Protected Member Functions inherited from ossim2dTo2dTransform
	ossim2dTo2dTransform ()

virtual	~ossim2dTo2dTransform ()

Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

Protected Attributes
ossimDpt	m_shift

	TYPE_DATA

Protected Attributes inherited from ossim2dTo2dTransform
double	theConvergenceThreshold

int	theMaxIterations

ossimDpt	theDxDy

Detailed Description

Definition at line 13 of file ossim2dTo2dShiftTransform.h.

Constructor & Destructor Documentation

◆ ossim2dTo2dShiftTransform() [1/2]

ossim2dTo2dShiftTransform::ossim2dTo2dShiftTransform ( const ossimDpt & shift = ossimDpt(0.0,0.0) )

inline

Constructor to initialize the shift transform.

Definition at line 19 of file ossim2dTo2dShiftTransform.h.

    :ossim2dTo2dTransform(),
    m_shift(shift)
    {}

◆ ossim2dTo2dShiftTransform() [2/2]

ossim2dTo2dShiftTransform::ossim2dTo2dShiftTransform ( const ossim2dTo2dShiftTransform & src )

inline

Copy constructor.

Definition at line 27 of file ossim2dTo2dShiftTransform.h.

    :ossim2dTo2dTransform(src),
    m_shift(src.m_shift)
    {}

◆ ~ossim2dTo2dShiftTransform()

virtual ossim2dTo2dShiftTransform::~ossim2dTo2dShiftTransform ( )

inlineprotectedvirtual

Definition at line 120 of file ossim2dTo2dShiftTransform.h.

120 {}

Member Function Documentation

◆ dup()

virtual ossimObject* ossim2dTo2dShiftTransform::dup ( ) const

inlinevirtual

Duplication method that duplicates this object.

Reimplemented from ossimObject.

Definition at line 35 of file ossim2dTo2dShiftTransform.h.

35 {return new ossim2dTo2dShiftTransform(*this);}

ossim2dTo2dShiftTransform::ossim2dTo2dShiftTransform

ossim2dTo2dShiftTransform(const ossimDpt &shift=ossimDpt(0.0, 0.0))

Constructor to initialize the shift transform.

Definition: ossim2dTo2dShiftTransform.h:19

◆ forward() [1/2]

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

inlinevirtual

Apply the shift to the input.

Parameters

input	The value to shift.
output	the shifted value.

Implements ossim2dTo2dTransform.

Definition at line 57 of file ossim2dTo2dShiftTransform.h.

    {
       output = input + m_shift;
    }

◆ forward() [2/2]

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

inlinevirtual

Apply the shift to the input and put the result in the same variable.

Parameters

modify_this The value to shift. The result is placed back into this value.

Reimplemented from ossim2dTo2dTransform.

Definition at line 67 of file ossim2dTo2dShiftTransform.h.

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

    {
       modify_this.x += m_shift.x;
       modify_this.y += m_shift.y;
    }

◆ inverse() [1/2]

virtual void ossim2dTo2dShiftTransform::inverse	(	const ossimDpt &	input,
		ossimDpt &	output
	)		const

inlinevirtual

Negate the shift to the input and put the result in output.

Parameters

input	The value to apply the negated shift.
output	the shifted value.

Reimplemented from ossim2dTo2dTransform.

Definition at line 79 of file ossim2dTo2dShiftTransform.h.

    {
       output = input - m_shift;
    }

◆ inverse() [2/2]

virtual void ossim2dTo2dShiftTransform::inverse ( ossimDpt & modify_this ) const

inlinevirtual

Negate the shift operation and put the result in the same variable.

Parameters

modify_this The value to shift. The result is placed back into this value.

Reimplemented from ossim2dTo2dTransform.

Definition at line 90 of file ossim2dTo2dShiftTransform.h.

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

    {
       modify_this.x -= m_shift.x;
       modify_this.y -= m_shift.y;
    }

◆ loadState()

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

virtual

loads the state of this object from a keywordlist.

Reimplemented from ossim2dTo2dTransform.

Definition at line 13 of file ossim2dTo2dShiftTransform.cpp.

References ossimString::empty(), ossimKeywordlist::find(), ossim2dTo2dTransform::loadState(), m_shift, and ossimDpt::toPoint().

 {
    bool result = ossim2dTo2dTransform::loadState(kwl, prefix);
    
    ossimString shift = kwl.find(prefix, "shift");
    if(!shift.empty())
    {
       m_shift.toPoint(shift);
    }
    
    return result;
 }

◆ operator=()

const ossim2dTo2dShiftTransform& ossim2dTo2dShiftTransform::operator= ( const ossim2dTo2dShiftTransform & src )

inline

operator = allows one to copy the contents of the class through a common = operator.

The = is passed to the derived class.

Definition at line 41 of file ossim2dTo2dShiftTransform.h.

References m_shift, and ossim2dTo2dTransform::operator=().

    {
       if(this == &src) return *this;
       
       ossim2dTo2dTransform::operator =(*this); // call base classes equal operator
       m_shift = src.m_shift;
       
       return *this;
    }

◆ print()

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

inlinevirtual

Print the contents of the class and pass to the derived class.

Reimplemented from ossim2dTo2dTransform.

Definition at line 110 of file ossim2dTo2dShiftTransform.h.

References ossim2dTo2dTransform::print().

    {
       ossim2dTo2dTransform::print(out);
       
       out << "shift: " << m_shift;
       
       return out;
    }

◆ saveState()

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

virtual

Saves the state of this object.

Reimplemented from ossim2dTo2dTransform.

Definition at line 4 of file ossim2dTo2dShiftTransform.cpp.

References ossimKeywordlist::add(), m_shift, ossim2dTo2dTransform::saveState(), and ossimDpt::toString().

 {
    bool result = ossim2dTo2dTransform::saveState(kwl, prefix);
    kwl.add(prefix, "shift", m_shift.toString(), true);
    
    return result;
 }

Member Data Documentation

◆ m_shift

ossimDpt ossim2dTo2dShiftTransform::m_shift

protected

Definition at line 122 of file ossim2dTo2dShiftTransform.h.

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

◆ TYPE_DATA

ossim2dTo2dShiftTransform::TYPE_DATA

protected

Definition at line 124 of file ossim2dTo2dShiftTransform.h.

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ossim2dTo2dShiftTransform() [1/2]

◆ ossim2dTo2dShiftTransform() [2/2]

◆ ~ossim2dTo2dShiftTransform()

Member Function Documentation

◆ dup()

◆ forward() [1/2]

◆ forward() [2/2]

◆ inverse() [1/2]

◆ inverse() [2/2]

◆ loadState()

◆ operator=()

◆ print()

◆ saveState()

Member Data Documentation

◆ m_shift

◆ TYPE_DATA