Isis::ImageOverlap Class Reference

Individual overlap container. More...

#include <ImageOverlap.h>

Collaboration diagram for Isis::ImageOverlap:

Public Member Functions
	ImageOverlap ()
	Construct an empty ImageOverlap object. More...
	ImageOverlap (QString serialNumber, geos::geom::MultiPolygon &polygon)
	Construct an ImageOverlap object and initialize it with the arguments. More...
	ImageOverlap (std::istream &inputStream)
	Construct an ImageOverlap object and initialize it from the istream. More...
virtual	~ImageOverlap ()
	Destroy this ImageOverlap object. More...
virtual void	SetPolygon (const geos::geom::MultiPolygon &polygon)
	This method will replace the existing polygon that defines the overlap with a new one. More...
virtual void	SetPolygon (const geos::geom::MultiPolygon *polygon)
	This method will replace the existing polygon that defines the overlap with a new one. More...
void	Add (QString &sn)
	This method will add a new serial number to the list of serial numbers alread associated with the overlap. More...
int	Size () const
QString	operator[] (int index) const
const geos::geom::MultiPolygon *	Polygon () const
virtual double	Area ()
	This method will return the area of the polygon. More...
bool	HasAnySameSerialNumber (ImageOverlap &other) const
	This method will return true if any serial number from this ImageOverlap is also in the other ImageOverlap. More...
bool	HasSerialNumber (QString &sn) const
	This method will return true if input serial number exists in the ImageOverlap. More...
void	Write (std::ostream &outputStream)

Private Member Functions
void	Init ()
	Initialize this object to a known state. More...

Private Attributes
std::vector< QString >	p_serialNumbers
geos::geom::MultiPolygon *	p_polygon

Detailed Description

Individual overlap container.

Hold information about a single area of overlap. This includes the serial numbers of each cube that overlap this area and the polygon that defines this area.

Author

2005-08-03 Stuart Sides

History:

2005-08-03 Stuart Sides Original version

History:

2007-11-02 Tracie Sucharski, Added HasSN method

History:

2008-08-18 Steven Lambright - Updated to work with geos3.0.0 instead of geos2. Mostly namespace changes.

History:

2008-11-03 Steven Lambright - Added the Read and Write methods

History:

2010-05-25 Steven Lambright - Made HasAnySameSerialNumber and HasSerialNumber const

Definition at line 40 of file ImageOverlap.h.

Constructor & Destructor Documentation

ImageOverlap() [1/3]

Isis::ImageOverlap::ImageOverlap

(

)

Construct an empty ImageOverlap object.

Definition at line 25 of file ImageOverlap.cpp.

References Init().

ImageOverlap() [2/3]

Isis::ImageOverlap::ImageOverlap	(	QString	serialNumber,
		geos::geom::MultiPolygon &	polygon
	)

Construct an ImageOverlap object and initialize it with the arguments.

Parameters

serialNumber	The initial serial number assiciated with the polygon.
polygon	The polygon that defines the overlap area.

Definition at line 38 of file ImageOverlap.cpp.

References Add(), Init(), and SetPolygon().

ImageOverlap() [3/3]

Isis::ImageOverlap::ImageOverlap

(

std::istream &

inputStream

)

Construct an ImageOverlap object and initialize it from the istream.

Parameters

inputStream

A stream containing a representation of the image overlap

Definition at line 52 of file ImageOverlap.cpp.

References Add(), and Isis::PolygonTools::MakeMultiPolygon().

~ImageOverlap()

Isis::ImageOverlap::~ImageOverlap ( )

virtual

Destroy this ImageOverlap object.

Definition at line 79 of file ImageOverlap.cpp.

Member Function Documentation

Add()

void Isis::ImageOverlap::Add

(

QString &

sn

)

This method will add a new serial number to the list of serial numbers alread associated with the overlap.

Parameters

sn	The serial number to be added to the list.

Definition at line 157 of file ImageOverlap.cpp.

References Isis::IException::Programmer.

Referenced by Isis::ImageOverlapSet::AddSerialNumbers(), and ImageOverlap().

Area()

double Isis::ImageOverlap::Area ( )

virtual

This method will return the area of the polygon.

This member does not assume any particular units of measure for the verticies of the polygon. It is provided as a convience.

Definition at line 177 of file ImageOverlap.cpp.

HasAnySameSerialNumber()

bool Isis::ImageOverlap::HasAnySameSerialNumber

(

ImageOverlap &

other

)

const

This method will return true if any serial number from this ImageOverlap is also in the other ImageOverlap.

Definition at line 186 of file ImageOverlap.cpp.

HasSerialNumber()

bool Isis::ImageOverlap::HasSerialNumber

(

QString &

sn

)

const

This method will return true if input serial number exists in the ImageOverlap.

Parameters

[in]

sn

(QString &) Serial Number to search for

Returns

bool Returns true if the serial number exists in the ImageOverlap.

Definition at line 207 of file ImageOverlap.cpp.

Referenced by Isis::InterestOperator::FindOverlap().

Init()

void Isis::ImageOverlap::Init ( )

private

Initialize this object to a known state.

Definition at line 88 of file ImageOverlap.cpp.

Referenced by ImageOverlap().

SetPolygon() [1/2]

void Isis::ImageOverlap::SetPolygon ( const geos::geom::MultiPolygon &  polygon )

virtual

This method will replace the existing polygon that defines the overlap with a new one.

Parameters

polygon

The new polygon.

Definition at line 101 of file ImageOverlap.cpp.

References Isis::PolygonTools::CopyMultiPolygon().

Referenced by ImageOverlap(), and Isis::ImageOverlapSet::SetPolygon().

SetPolygon() [2/2]

void Isis::ImageOverlap::SetPolygon ( const geos::geom::MultiPolygon *  polygon )

virtual

This method will replace the existing polygon that defines the overlap with a new one.

Parameters

polygon

The new polygon.

Definition at line 118 of file ImageOverlap.cpp.

References Isis::PolygonTools::CopyMultiPolygon().

---

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

• src/base/objs/ImageOverlap/ImageOverlap.h
• src/base/objs/ImageOverlap/ImageOverlap.cpp