Isis Developer Reference
Isis::PolygonSeeder Class Referenceabstract

This class is used as the base class for all PolygonSeeder objects. More...

#include <PolygonSeeder.h>

Inheritance diagram for Isis::PolygonSeeder:
Inheritance graph
Collaboration diagram for Isis::PolygonSeeder:
Collaboration graph

Public Member Functions

 PolygonSeeder (Pvl &pvl)
 Create PolygonSeeder object.
 
 PolygonSeeder (const PolygonSeeder &other)
 Copy constructor.
 
virtual ~PolygonSeeder ()
 Destroys the PolygonSeeder object.
 
virtual std::vector< geos::geom::Point * > Seed (const geos::geom::MultiPolygon *mp)=0
 Pure virtual seed method.
 
double MinimumThickness ()
 Return the minimum allowed thickness of the polygon.
 
double MinimumArea ()
 Return the minimum allowed area of the polygon.
 
QString Algorithm () const
 The name of the algorithm, read from the Name Keyword in the PolygonSeeder Pvl passed into the constructor.
 
virtual PvlGroup PluginParameters (QString grpName)
 Plugin parameters.
 
Pvl InvalidInput ()
 This method returns a copy of the Pvl passed in by the constructor (from a def file probably) minus what was used.
 
const PolygonSeederoperator= (const PolygonSeeder &other)
 Assignment operator.
 

Protected Member Functions

virtual void Parse (Pvl &pvl)
 Initialize parameters in the PolygonSeeder class using a PVL specification.
 
QString StandardTests (const geos::geom::MultiPolygon *multiPoly, const geos::geom::Envelope *polyBoundBox)
 Check the polygon to see if it meets standard criteria.
 

Protected Attributes

PvlinvalidInput
 The Pvl passed in by the constructor minus what was used.
 

Detailed Description

This class is used as the base class for all PolygonSeeder objects.

The class is pure virtual.

Author
2006-01-20 Stuart Sides

Constructor & Destructor Documentation

◆ PolygonSeeder() [1/2]

Isis::PolygonSeeder::PolygonSeeder ( Pvl & pvl)

Create PolygonSeeder object.

Because this is a pure virtual class you can not create an PolygonSeeder class directly. Instead, see the PolygonSeederFactory class.

Parameters
pvlA pvl object containing a valid PolygonSeeder specification

References invalidInput, and Parse().

◆ PolygonSeeder() [2/2]

Isis::PolygonSeeder::PolygonSeeder ( const PolygonSeeder & other)

Copy constructor.

Create PolygonSeeder object by copying the algorithm name, the minimum thickness, and the minimum area of an existing PolygonSeeder object.

Parameters
otherThe other PolygonSeeder object that will be copied.

◆ ~PolygonSeeder()

Isis::PolygonSeeder::~PolygonSeeder ( )
virtual

Destroys the PolygonSeeder object.

References invalidInput.

Member Function Documentation

◆ Algorithm()

QString Isis::PolygonSeeder::Algorithm ( ) const

The name of the algorithm, read from the Name Keyword in the PolygonSeeder Pvl passed into the constructor.

Returns
QString The value of the Name Keyword in the Pvl.

Referenced by Isis::GridPolygonSeeder::PluginParameters(), Isis::LimitPolygonSeeder::PluginParameters(), and Isis::StripPolygonSeeder::PluginParameters().

◆ InvalidInput()

Pvl Isis::PolygonSeeder::InvalidInput ( )

This method returns a copy of the Pvl passed in by the constructor (from a def file probably) minus what was used.

Returns
Pvl A copy of this pvl minus what was used.

References invalidInput.

◆ MinimumArea()

double Isis::PolygonSeeder::MinimumArea ( )

Return the minimum allowed area of the polygon.

This value is set from the "MinimumArea" keyword in the PVL. The seeding algorithm will not seed polygons that have an area less than this.

Returns
double The value for the minimum area allowed.

Referenced by Isis::GridPolygonSeeder::PluginParameters(), Isis::LimitPolygonSeeder::PluginParameters(), Isis::StripPolygonSeeder::PluginParameters(), and StandardTests().

◆ MinimumThickness()

double Isis::PolygonSeeder::MinimumThickness ( )

Return the minimum allowed thickness of the polygon.

This value is set from the "MinimumThickness" keyword in the PVL. The seeding algorithm will not seed polygons that have a thickness ratio less than this

Returns
double The value for the minimum thickness allowed.

Referenced by Isis::GridPolygonSeeder::PluginParameters(), Isis::LimitPolygonSeeder::PluginParameters(), Isis::StripPolygonSeeder::PluginParameters(), and StandardTests().

◆ operator=()

const PolygonSeeder & Isis::PolygonSeeder::operator= ( const PolygonSeeder & other)

Assignment operator.

Sets this PolygonSeeder object equal to another by copying the algorithm name, the minimum thickness, and the minimum area of the other PolygonSeeder object.

Parameters
otherThe other PolygonSeeder object whose values will be copied.
Returns
PolygonSeeder This PolygonSeeder object, once the other object's values have been copied.

◆ Parse()

void Isis::PolygonSeeder::Parse ( Pvl & pvl)
protectedvirtual

Initialize parameters in the PolygonSeeder class using a PVL specification.

An example of the PVL required for this is:

Object = AutoSeed
Group = Algorithm
Name = Grid
Tolerance = 0.7
EndGroup
EndObject
QString Algorithm() const
The name of the algorithm, read from the Name Keyword in the PolygonSeeder Pvl passed into the constr...
Definition PolygonSeeder.cpp:172

There are many other options that can be set via the pvl and are described in other documentation (see below).

Parameters
pvlThe pvl object containing the specification

Reimplemented in Isis::GridPolygonSeeder, Isis::LimitPolygonSeeder, and Isis::StripPolygonSeeder.

References _FILEINFO_, Isis::PvlObject::findGroup(), invalidInput, Isis::PvlObject::Traverse, and Isis::IException::User.

Referenced by Isis::GridPolygonSeeder::Parse(), Isis::LimitPolygonSeeder::Parse(), Isis::StripPolygonSeeder::Parse(), and PolygonSeeder().

◆ PluginParameters()

PvlGroup Isis::PolygonSeeder::PluginParameters ( QString grpName)
virtual

Plugin parameters.

This method will add the PvlKeyword values for algorithm name, minimum thickness, and minimum area of this object to a PvlGroup with the name that is passed in.

Parameters
grpNameA string containing the PvlGroup name.
Returns
PvlGroup The PvlGroup with the appropriate parameters added.

Reimplemented in Isis::GridPolygonSeeder, Isis::LimitPolygonSeeder, and Isis::StripPolygonSeeder.

References Isis::toString().

◆ Seed()

virtual std::vector< geos::geom::Point * > Isis::PolygonSeeder::Seed ( const geos::geom::MultiPolygon * mp)
pure virtual

Pure virtual seed method.

Parameters
mpThe MultiPolygon object from the geos::geom library.
Returns
std::vector<geos::geom::Point*> A vector of Point objects from the geos::geom library.

Implemented in Isis::GridPolygonSeeder, Isis::LimitPolygonSeeder, and Isis::StripPolygonSeeder.

◆ StandardTests()

QString Isis::PolygonSeeder::StandardTests ( const geos::geom::MultiPolygon * xymp,
const geos::geom::Envelope * xyBoundBox )
protected

Check the polygon to see if it meets standard criteria.

Parameters
xympThe multipoly containing the coordinates in x/y units instead of lon/lat
xyBoundBoxThe bounding box of the multipoly
Returns
QString A string with an appropriate message to throw if a test was unsuccessful or an empty string if all tests passed.

References MinimumArea(), MinimumThickness(), and Isis::toString().

Referenced by Isis::LimitPolygonSeeder::Seed(), and Isis::StripPolygonSeeder::Seed().

Member Data Documentation

◆ invalidInput

Pvl* Isis::PolygonSeeder::invalidInput
protected

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