Isis Developer Reference
Isis::LimitPolygonSeeder Class Reference

Seed points using a grid. More...

#include <LimitPolygonSeeder.h>

Inheritance diagram for Isis::LimitPolygonSeeder:
Inheritance graph
Collaboration diagram for Isis::LimitPolygonSeeder:
Collaboration graph

Public Member Functions

 LimitPolygonSeeder (Pvl &pvl)
 Construct a LimitPolygonSeeder algorithm.
 
virtual ~LimitPolygonSeeder ()
 Destructor.
 
std::vector< geos::geom::Point * > Seed (const geos::geom::MultiPolygon *mp)
 Seed a polygon with points.
 
virtual PvlGroup PluginParameters (QString grpName)
 Plugin parameters.
 
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.
 
Pvl InvalidInput ()
 This method returns a copy of the Pvl passed in by the constructor (from a def file probably) minus what was used.
 

Protected Member Functions

virtual void Parse (Pvl &pvl)
 Parse the LimitPolygonSeeder spicific parameters from the PVL.
 
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

Seed points using a grid.

This class seeds the polygons with Control Points by creating a grid centered on the polygon. For each grid square, if it contains any overlap, a box is then created within the grid square, surrounding the valid data. The point checked is the center of this box, and if this point is within the overlap polygon then this point is returned, otherwise the grid square does not have a point.

Author
2008-04-21 Steven Lambright

Constructor & Destructor Documentation

◆ LimitPolygonSeeder()

Isis::LimitPolygonSeeder::LimitPolygonSeeder ( Pvl & pvl)

Construct a LimitPolygonSeeder algorithm.

Parameters
pvlA Pvl object that contains a valid polygon point seeding definition

References Parse().

◆ ~LimitPolygonSeeder()

virtual Isis::LimitPolygonSeeder::~LimitPolygonSeeder ( )
inlinevirtual

Destructor.

Member Function Documentation

◆ Algorithm()

QString Isis::PolygonSeeder::Algorithm ( ) const
inherited

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(), PluginParameters(), and Isis::StripPolygonSeeder::PluginParameters().

◆ InvalidInput()

Pvl Isis::PolygonSeeder::InvalidInput ( )
inherited

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 Isis::PolygonSeeder::invalidInput.

◆ MinimumArea()

double Isis::PolygonSeeder::MinimumArea ( )
inherited

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(), PluginParameters(), Isis::StripPolygonSeeder::PluginParameters(), and Isis::PolygonSeeder::StandardTests().

◆ MinimumThickness()

double Isis::PolygonSeeder::MinimumThickness ( )
inherited

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(), PluginParameters(), Isis::StripPolygonSeeder::PluginParameters(), and Isis::PolygonSeeder::StandardTests().

◆ Parse()

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

Parse the LimitPolygonSeeder spicific parameters from the PVL.

Parameters
pvlThe PVL object containing the control parameters for this polygon seeder.

Reimplemented from Isis::PolygonSeeder.

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

Referenced by LimitPolygonSeeder().

◆ PluginParameters()

PvlGroup Isis::LimitPolygonSeeder::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 from Isis::PolygonSeeder.

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

◆ Seed()

std::vector< geos::geom::Point * > Isis::LimitPolygonSeeder::Seed ( const geos::geom::MultiPolygon * multiPoly)
virtual

Seed a polygon with points.

Seed the supplied polygon with points in a staggered pattern. The spacing is determined by the PVL group "PolygonSeederAlgorithm"

Parameters
lonLatPolygeos::MultiPolygon The polygon to be seeded with points.
Returns
std::vector<geos::Point*> A vector of points which have been seeded into the polygon. The caller assumes responsibility for deleteing these.

Implements Isis::PolygonSeeder.

References Isis::globalFactory, and Isis::PolygonSeeder::StandardTests().

◆ StandardTests()

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

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 Isis::PolygonSeeder::MinimumArea(), Isis::PolygonSeeder::MinimumThickness(), and Isis::toString().

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

Member Data Documentation

◆ invalidInput

Pvl* Isis::PolygonSeeder::invalidInput
protectedinherited

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