Isis 3.0
Back | Home
Isis::ImageOverlap Class Reference

Individual overlap container. More...

#include <ImageOverlap.h>

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)
 

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

Constructor & Destructor Documentation

Isis::ImageOverlap::ImageOverlap ( )

Construct an empty ImageOverlap object.

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

Construct an ImageOverlap object and initialize it with the arguments.

Parameters
serialNumberThe initial serial number assiciated with the polygon.
polygonThe polygon that defines the overlap area.

References Add(), and SetPolygon().

Isis::ImageOverlap::ImageOverlap ( std::istream &  inputStream)

Construct an ImageOverlap object and initialize it from the istream.

Parameters
inputStreamA stream containing a representation of the image overlap

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

Isis::ImageOverlap::~ImageOverlap ( )
virtual

Destroy this ImageOverlap object.

Member Function Documentation

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
snThe serial number to be added to the list.

References _FILEINFO_, and Isis::IException::Programmer.

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

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.

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.

References Size().

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.

References Size().

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

QString Isis::ImageOverlap::operator[] ( int  index) const
inline
const geos::geom::MultiPolygon* Isis::ImageOverlap::Polygon ( ) const
inline
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
polygonThe new polygon.

References Isis::PolygonTools::CopyMultiPolygon().

Referenced by ImageOverlap().

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
polygonThe new polygon.

References Isis::PolygonTools::CopyMultiPolygon().

void Isis::ImageOverlap::Write ( std::ostream &  outputStream)

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

U.S. Department of the Interior | U.S. Geological Survey
ISIS | Privacy & Disclaimers | Astrogeology Research Program
To contact us, please post comments and questions on the ISIS Support Center
File Modified: 07/12/2023 23:38:54