 |
Isis 3 Developer Reference
|
|
Isis 3 Developer Reference
|
Seed points using a grid. More...
#include <GridPolygonSeeder.h>
Public Member Functions | |
| GridPolygonSeeder (Pvl &pvl) | |
| Construct a GridPolygonSeeder algorithm. More... | |
| virtual | ~GridPolygonSeeder () |
| Destructor. More... | |
| std::vector< geos::geom::Point * > | Seed (const geos::geom::MultiPolygon *mp) |
| Seed a polygon with points. More... | |
| bool | SubGrid () |
| virtual PvlGroup | PluginParameters (QString grpName) |
| Plugin parameters. More... | |
| double | MinimumThickness () |
| Return the minimum allowed thickness of the polygon. More... | |
| double | MinimumArea () |
| Return the minimum allowed area of the polygon. More... | |
| QString | Algorithm () const |
| The name of the algorithm, read from the Name Keyword in the PolygonSeeder Pvl passed into the constructor. More... | |
| Pvl | InvalidInput () |
| This method returns a copy of the Pvl passed in by the constructor (from a def file probably) minus what was used. More... | |
Protected Member Functions | |
| virtual void | Parse (Pvl &pvl) |
| Parse the GridPolygonSeeder spicific parameters from the PVL. More... | |
| QString | StandardTests (const geos::geom::MultiPolygon *multiPoly, const geos::geom::Envelope *polyBoundBox) |
| Check the polygon to see if it meets standard criteria. More... | |
Protected Attributes | |
| Pvl * | invalidInput |
| The Pvl passed in by the constructor minus what was used. More... | |
Seed points using a grid.
This class is used to construct a grid of points inside a polygon.
| Isis::GridPolygonSeeder::GridPolygonSeeder | ( | Pvl & | pvl | ) |
Construct a GridPolygonSeeder algorithm.
| pvl | A Pvl object that contains a valid polygon point seeding definition |
References Parse().
|
inlinevirtual |
Destructor.
|
inherited |
The name of the algorithm, read from the Name Keyword in the PolygonSeeder Pvl passed into the constructor.
Referenced by Isis::LimitPolygonSeeder::PluginParameters(), Isis::StripPolygonSeeder::PluginParameters(), and PluginParameters().
|
inherited |
This method returns a copy of the Pvl passed in by the constructor (from a def file probably) minus what was used.
References Isis::PolygonSeeder::invalidInput.
|
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.
Referenced by Isis::LimitPolygonSeeder::PluginParameters(), Isis::StripPolygonSeeder::PluginParameters(), PluginParameters(), and Isis::PolygonSeeder::StandardTests().
|
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
Referenced by Isis::LimitPolygonSeeder::PluginParameters(), Isis::StripPolygonSeeder::PluginParameters(), PluginParameters(), and Isis::PolygonSeeder::StandardTests().
|
protectedvirtual |
Parse the GridPolygonSeeder spicific parameters from the PVL.
| pvl | The PVL object containing the control parameters for this polygon seeder. |
Reimplemented from Isis::PolygonSeeder.
References _FILEINFO_, Isis::PvlContainer::deleteKeyword(), Isis::PvlContainer::fileName(), Isis::PvlObject::findGroup(), Isis::PvlContainer::hasKeyword(), Isis::PolygonSeeder::invalidInput, Isis::PolygonSeeder::Parse(), Isis::PvlObject::Traverse, Isis::IString::UpCase(), and Isis::IException::User.
Referenced by GridPolygonSeeder().
|
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.
| grpName | A string containing the PvlGroup name. |
Reimplemented from Isis::PolygonSeeder.
References Isis::PvlContainer::addKeyword(), Isis::PolygonSeeder::Algorithm(), Isis::PolygonSeeder::MinimumArea(), Isis::PolygonSeeder::MinimumThickness(), and Isis::toString().
|
virtual |
Seed a polygon with points.
Seed the supplied polygon with points in a grid pattern. The spacing is determined by the PVL group "PolygonSeederAlgorithm"
| lonLatPoly | geos::MultiPolygon The polygon to be seeded with points. |
| proj | The Projection to seed the polygon into |
Implements Isis::PolygonSeeder.
|
protectedinherited |
Check the polygon to see if it meets standard criteria.
| xymp | The multipoly containing the coordinates in x/y units instead of lon/lat |
| xyBoundBox | The bounding box of the multipoly |
References Isis::PolygonSeeder::MinimumArea(), Isis::PolygonSeeder::MinimumThickness(), and Isis::toString().
Referenced by Isis::LimitPolygonSeeder::Seed(), and Isis::StripPolygonSeeder::Seed().
|
inline |
|
protectedinherited |
The Pvl passed in by the constructor minus what was used.
Referenced by Isis::PolygonSeeder::InvalidInput(), Isis::LimitPolygonSeeder::Parse(), Parse(), Isis::StripPolygonSeeder::Parse(), Isis::PolygonSeeder::Parse(), Isis::PolygonSeeder::PolygonSeeder(), and Isis::PolygonSeeder::~PolygonSeeder().