Class to handle transforming image points, rectangles, and offsets from one reduced resolution data set (rrds) level to another. More...

#include <ossimImageModel.h>

Inheritance diagram for ossimImageModel:

Public Member Functions
	ossimImageModel ()
	default constructor More...

virtual void	initialize (const ossimImageHandler &ih)
	Method to initialize class from an image handler. More...

void	rnToR0 (ossim_uint32 rrds, const ossimDpt &rnPt, ossimDpt &r0Pt) const
	Get r0 point from rn point. More...

void	rnToR0 (const ossimDpt &rnPt, ossimDpt &r0Pt) const
	Get r0 point from rn point. More...

void	r0ToRn (ossim_uint32 rrds, const ossimDpt &r0Pt, ossimDpt &rnPt) const
	Get rn point from r0 point. More...

void	r0ToRn (const ossimDpt &r0Pt, ossimDpt &rnPt) const
	Get rn point from r0 point. More...

void	getSubImageOffset (ossim_uint32 rrds, ossimDpt &offset) const
	Get the sub image offset for a given resolution level. More...

void	getImageRectangle (ossim_uint32 rrds, ossimDrect &rect) const
	Gets the zero-based image rectangle for a given reduced resolution data set. More...

void	getBoundingRectangle (ossim_uint32 rrds, ossimDrect &rect) const
	Gets the model-based image rectangle for a given reduced resolution data set. More...

ossim_uint32	getNumberOfDecimationLevels () const

void	setTargetRrds (ossim_uint32 rrds)
	Set theTargetRrds data member. More...

ossim_uint32	getTargetRrds () const

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	saveState (ossimKeywordlist &kwl, const char *prefix=0) const

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

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

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	~ossimImageModel ()
	virtual destructor More...

Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

Protected Attributes
ossimDpt	theSubImageOffset
	Offset from the full image. More...

std::vector< ossimDpt >	theDecimationFactors
	Decimation factors for each rrds level. More...

ossim_uint32	theLines

ossim_uint32	theSamples

ossim_uint32	theTargetRrds

Detailed Description

Class to handle transforming image points, rectangles, and offsets from one reduced resolution data set (rrds) level to another.

Derived from ossimObject only so users can pass via the ossimViewInterface::setView method.

Definition at line 33 of file ossimImageModel.h.

Constructor & Destructor Documentation

◆ ossimImageModel()

ossimImageModel::ossimImageModel ( )

default constructor

Definition at line 23 of file ossimImageModel.cpp.

    : ossimObject(),
      theSubImageOffset(),
      theDecimationFactors(),
      theLines(0),
      theSamples(0),
      theTargetRrds(0)
 {
 }

◆ ~ossimImageModel()

ossimImageModel::~ossimImageModel ( )

protectedvirtual

virtual destructor

Definition at line 33 of file ossimImageModel.cpp.

34 {

35 }

Member Function Documentation

◆ getBoundingRectangle()

void ossimImageModel::getBoundingRectangle	(	ossim_uint32	rrds,
		ossimDrect &	rect
	)		const

Gets the model-based image rectangle for a given reduced resolution data set.

If this image is a sub image the offset is applied. So if the image has a sub image offset of (1024, 1024), and has 1024 lines and 1024 samples the rectangle for r0 will be: (1024, 1024) (2047, 2047)

Parameters

rrds	The reduced resolution data set.
rect	Initialized with image rectangle for rrds.

Note: Throws ossimException on out of range rrds.

Definition at line 118 of file ossimImageModel.cpp.

References theDecimationFactors, theLines, theSamples, theSubImageOffset, ossimDpt::x, and ossimDpt::y.

 {
    if ( rrds < theDecimationFactors.size() )
    {
       ossim_float64 urX = theSubImageOffset.x * theDecimationFactors[rrds].x;
       ossim_float64 urY = theSubImageOffset.y * theDecimationFactors[rrds].y;
       
       ossim_float64 lrX = urX + theSamples*theDecimationFactors[rrds].x - 1.0;
       ossim_float64 lrY = urY + theLines  *theDecimationFactors[rrds].y - 1.0;
       ossimDrect r(0, 0, lrX, lrY);
       rect = r;
    }
    else
    {
       std::string e =
          "ossimImageModel::getBoundingRectangle rrds out of range!";
       throw ossimException(e);
    }  
 }

◆ getImageRectangle()

void ossimImageModel::getImageRectangle	(	ossim_uint32	rrds,
		ossimDrect &	rect
	)		const

Gets the zero-based image rectangle for a given reduced resolution data set.

Parameters

rrds	The reduced resolution data set.
rect	Initialized with image rectangle for rrds.

Note: Throws ossimException on out of range rrds.

Definition at line 101 of file ossimImageModel.cpp.

References theDecimationFactors, theLines, and theSamples.

 {
    if ( rrds < theDecimationFactors.size() )
    {
       ossim_float64 lrX = theSamples * theDecimationFactors[rrds].x - 1.0;
       ossim_float64 lrY = theLines   * theDecimationFactors[rrds].y - 1.0;
       ossimDrect r(0.0, 0.0, lrX, lrY);
       rect = r;
    }
    else
    {
       std::string e = "ossimImageModel::getImageRectangle rrds out of range!";
       throw ossimException(e);
    } 
 }

◆ getNumberOfDecimationLevels()

ossim_uint32 ossimImageModel::getNumberOfDecimationLevels ( ) const

Returns: This returns the total number of decimation levels.

Definition at line 138 of file ossimImageModel.cpp.

References theDecimationFactors.

 {
    return (ossim_uint32)theDecimationFactors.size();
 }

◆ getSubImageOffset()

void ossimImageModel::getSubImageOffset	(	ossim_uint32	rrds,
		ossimDpt &	offset
	)		const

Get the sub image offset for a given resolution level.

Parameters

rrds	The reduced resolution data set.
offset	the Point to initialize.

Note: Throws ossimException on out of range rrds.

Definition at line 86 of file ossimImageModel.cpp.

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

 {
    if ( rrds < theDecimationFactors.size() )
    {
       offset.x = theSubImageOffset.x * theDecimationFactors[rrds].x;
       offset.y = theSubImageOffset.y * theDecimationFactors[rrds].y;
    }
    else
    {
       std::string e = "ossimImageModel::getSubImageOffset rrds out of range!";
       throw ossimException(e);
    } 
 }

◆ getTargetRrds()

ossim_uint32 ossimImageModel::getTargetRrds ( ) const

Returns: The target reduced resolution data set.

Definition at line 148 of file ossimImageModel.cpp.

References theTargetRrds.

 {
    return theTargetRrds;
 }

◆ initialize()

void ossimImageModel::initialize ( const ossimImageHandler & ih )

virtual

Method to initialize class from an image handler.

Parameters

ih	Image handler.

Reimplemented in ossimImageProjectionModel.

Definition at line 37 of file ossimImageModel.cpp.

References ossimImageHandler::getDecimationFactors(), ossimImageHandler::getNumberOfLines(), ossimImageHandler::getNumberOfSamples(), theDecimationFactors, theLines, theSamples, and theSubImageOffset.

Referenced by ossimImageProjectionModel::initialize().

 {
    theSubImageOffset = ossimDpt();
    theLines          = ih.getNumberOfLines(0);
    theSamples        = ih.getNumberOfSamples(0);
    ih.getDecimationFactors(theDecimationFactors);
 }

◆ r0ToRn() [1/2]

void ossimImageModel::r0ToRn	(	ossim_uint32	rrds,
		const ossimDpt &	r0Pt,
		ossimDpt &	rnPt
	)		const

Get rn point from r0 point.

Parameters

rrds	Target (rnPt) reduced resolution data set.
r0Pt	The image point to tranform.
rnPt	the Point to initialize.

Note: Throws ossimException on out of range rrds.

Definition at line 65 of file ossimImageModel.cpp.

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

Referenced by r0ToRn().

 {
    if ( rrds < theDecimationFactors.size() )
    {
       rnPt.x = r0Pt.x * theDecimationFactors[rrds].x;
       rnPt.y = r0Pt.y * theDecimationFactors[rrds].y;
    }
    else
    {
       std::string e = "ossimImageModel::r0ToRn rrds out of range!";
       throw ossimException(e);
    }
 }

◆ r0ToRn() [2/2]

void ossimImageModel::r0ToRn	(	const ossimDpt &	r0Pt,
		ossimDpt &	rnPt
	)		const

Get rn point from r0 point.

This requires calling setTargetRrds(ossim_uint32 rrds) to the level for rnPt.

Parameters

r0Pt	The image point to tranform.
rnPt	the Point to initialize.

Note: Throws ossimException on out of range rrds.

See also: setTargetRrds

Definition at line 81 of file ossimImageModel.cpp.

References r0ToRn(), and theTargetRrds.

 {
    r0ToRn(theTargetRrds, r0Pt, rnPt);
 }

◆ rnToR0() [1/2]

void ossimImageModel::rnToR0	(	ossim_uint32	rrds,
		const ossimDpt &	rnPt,
		ossimDpt &	r0Pt
	)		const

Get r0 point from rn point.

Parameters

rrds	Source (rnPt) reduced resolution data set.
rnPt	The image point to tranform.
r0Pt	the Point to initialize.

Note: Throws ossimException on out of range rrds.

Definition at line 45 of file ossimImageModel.cpp.

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

Referenced by rnToR0().

 {
    if ( rrds < theDecimationFactors.size() )
    {
       r0Pt.x = rnPt.x / theDecimationFactors[rrds].x;
       r0Pt.y = rnPt.y / theDecimationFactors[rrds].y;
    }
    else
    {
       std::string e = "ossimImageModel::rnToR0 rrds out of range!";
       throw ossimException(e);
    }
 }

◆ rnToR0() [2/2]

void ossimImageModel::rnToR0	(	const ossimDpt &	rnPt,
		ossimDpt &	r0Pt
	)		const

Get r0 point from rn point.

This requires calling setTargetRrds(ossim_uint32 rrds) to the level for rnPt.

Parameters

rnPt	The image point to tranform.
r0Pt	the Point to initialize.

Note: Throws ossimException on out of range rrds.

See also: setTargetRrds

Definition at line 60 of file ossimImageModel.cpp.

References rnToR0(), and theTargetRrds.

 {
    rnToR0(theTargetRrds, rnPt, r0Pt);
 }

◆ setTargetRrds()

void ossimImageModel::setTargetRrds ( ossim_uint32 rrds )

Set theTargetRrds data member.

This is used by methods rnToR0 and r0ToRn that do not take a rrds argument.

Parameters

rrds	Target reduced resolution data set.

Definition at line 143 of file ossimImageModel.cpp.

References theTargetRrds.

 {
    theTargetRrds = rrds;
 }

Member Data Documentation

◆ theDecimationFactors

std::vector<ossimDpt> ossimImageModel::theDecimationFactors

protected

Decimation factors for each rrds level.

Definition at line 180 of file ossimImageModel.h.

Referenced by getBoundingRectangle(), getImageRectangle(), getNumberOfDecimationLevels(), getSubImageOffset(), initialize(), r0ToRn(), and rnToR0().

◆ theLines

ossim_uint32 ossimImageModel::theLines

protected

Definition at line 182 of file ossimImageModel.h.

Referenced by getBoundingRectangle(), getImageRectangle(), and initialize().

◆ theSamples

ossim_uint32 ossimImageModel::theSamples

protected

Definition at line 183 of file ossimImageModel.h.

Referenced by getBoundingRectangle(), getImageRectangle(), and initialize().

◆ theSubImageOffset

ossimDpt ossimImageModel::theSubImageOffset

protected

Offset from the full image.

Definition at line 177 of file ossimImageModel.h.

Referenced by getBoundingRectangle(), getSubImageOffset(), and initialize().

◆ theTargetRrds

ossim_uint32 ossimImageModel::theTargetRrds

protected

Definition at line 184 of file ossimImageModel.h.

Referenced by getTargetRrds(), r0ToRn(), rnToR0(), and setTargetRrds().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ossimImageModel()

◆ ~ossimImageModel()

Member Function Documentation

◆ getBoundingRectangle()

◆ getImageRectangle()

◆ getNumberOfDecimationLevels()

◆ getSubImageOffset()

◆ getTargetRrds()

◆ initialize()

◆ r0ToRn() [1/2]

◆ r0ToRn() [2/2]

◆ rnToR0() [1/2]

◆ rnToR0() [2/2]

◆ setTargetRrds()

Member Data Documentation

◆ theDecimationFactors

◆ theLines

◆ theSamples

◆ theSubImageOffset

◆ theTargetRrds