Isis Developer Reference
PolygonSeeder.h
Go to the documentation of this file.
1 #ifndef PolygonSeeder_h
2 #define PolygonSeeder_h
3 
8 /* SPDX-License-Identifier: CC0-1.0 */
9 
10 #include <string>
11 #include <vector>
12 #include <cmath>
13 
14 #include "geos/geom/Point.h"
15 #include "geos/geom/MultiPolygon.h"
16 
17 #include "Projection.h"
18 
19 namespace Isis {
20  class Pvl;
21  class PvlGroup;
22  class PolygonTools;
23 
47  class PolygonSeeder {
48  public:
49  PolygonSeeder(Pvl &pvl);
50  PolygonSeeder(const PolygonSeeder &other);
51  virtual ~PolygonSeeder();
52 
60  virtual std::vector<geos::geom::Point *>
61  Seed(const geos::geom::MultiPolygon *mp) = 0;
62 
63  double MinimumThickness();
64  double MinimumArea();
65  QString Algorithm() const;
66 
67  virtual PvlGroup PluginParameters(QString grpName);
68  Pvl InvalidInput();
69 
70  const PolygonSeeder &operator=(const PolygonSeeder &other);
71 
72  protected:
73  virtual void Parse(Pvl &pvl);
74  QString StandardTests(const geos::geom::MultiPolygon *multiPoly,
75  const geos::geom::Envelope *polyBoundBox);
76 
77  protected:
81  private:
82  QString p_algorithmName;
85  double p_minimumThickness;
89  double p_minimumArea;
94  };
95 };
96 
97 #endif
FileName.h
ProjectionFactory.h
Isis::PvlObject::findGroup
PvlGroupIterator findGroup(const QString &name, PvlGroupIterator beg, PvlGroupIterator end)
Find a group with the specified name, within these indexes.
Definition: PvlObject.h:129
Plugin.h
Isis::PvlKeyword
A single keyword-value pair.
Definition: PvlKeyword.h:82
PolygonSeeder.h
Isis::PvlContainer::addKeyword
void addKeyword(const PvlKeyword &keyword, const InsertMode mode=Append)
Add a keyword to the container.
Definition: PvlContainer.cpp:202
PvlGroup.h
Isis::PolygonSeeder::PluginParameters
virtual PvlGroup PluginParameters(QString grpName)
Plugin parameters.
Definition: PolygonSeeder.cpp:210
Isis::PvlContainer::hasKeyword
bool hasKeyword(const QString &name) const
Check to see if a keyword exists.
Definition: PvlContainer.cpp:159
Isis::Pvl
Container for cube-like labels.
Definition: Pvl.h:119
Isis::PolygonSeeder::Seed
virtual std::vector< geos::geom::Point * > Seed(const geos::geom::MultiPolygon *mp)=0
Pure virtual seed method.
Isis::PolygonSeeder::MinimumArea
double MinimumArea()
Return the minimum allowed area of the polygon.
Definition: PolygonSeeder.cpp:195
Isis::toString
QString toString(bool boolToConvert)
Global function to convert a boolean to a string.
Definition: IString.cpp:211
Isis::PvlObject::Traverse
@ Traverse
Search child objects.
Definition: PvlObject.h:158
Isis::PolygonSeeder::MinimumThickness
double MinimumThickness()
Return the minimum allowed thickness of the polygon.
Definition: PolygonSeeder.cpp:183
Isis::PvlGroup
Contains multiple PvlContainers.
Definition: PvlGroup.h:41
Pvl.h
_FILEINFO_
#define _FILEINFO_
Macro for the filename and line number.
Definition: IException.h:24
Isis::PolygonSeeder::invalidInput
Pvl * invalidInput
The Pvl passed in by the constructor minus what was used.
Definition: PolygonSeeder.h:78
Isis::PolygonSeeder::operator=
const PolygonSeeder & operator=(const PolygonSeeder &other)
Assignment operator.
Definition: PolygonSeeder.cpp:246
LeastSquares.h
Isis::PvlContainer::fileName
QString fileName() const
Returns the filename used to initialise the Pvl object.
Definition: PvlContainer.h:232
Isis::PolygonSeeder::~PolygonSeeder
virtual ~PolygonSeeder()
Destroys the PolygonSeeder object.
Definition: PolygonSeeder.cpp:59
Isis::IException
Isis exception class.
Definition: IException.h:91
Isis::PolygonSeeder::Parse
virtual void Parse(Pvl &pvl)
Initialize parameters in the PolygonSeeder class using a PVL specification.
Definition: PolygonSeeder.cpp:85
Isis::PvlContainer::deleteKeyword
void deleteKeyword(const QString &name)
Remove a specified keyword.
Definition: PvlContainer.cpp:97
IException.h
Isis::PolygonSeeder::Algorithm
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
Isis::PolygonSeeder::StandardTests
QString StandardTests(const geos::geom::MultiPolygon *multiPoly, const geos::geom::Envelope *polyBoundBox)
Check the polygon to see if it meets standard criteria.
Definition: PolygonSeeder.cpp:146
Projection.h
Isis::PolygonSeeder::PolygonSeeder
PolygonSeeder(Pvl &pvl)
Create PolygonSeeder object.
Definition: PolygonSeeder.cpp:30
PolygonTools.h
Isis::PolygonSeeder::InvalidInput
Pvl InvalidInput()
This method returns a copy of the Pvl passed in by the constructor (from a def file probably) minus w...
Definition: PolygonSeeder.cpp:231
Isis::PolygonSeeder
This class is used as the base class for all PolygonSeeder objects.
Definition: PolygonSeeder.h:47
PolynomialBivariate.h
Isis
This is free and unencumbered software released into the public domain.
Definition: Apollo.h:16
Isis::IException::User
@ User
A type of error that could only have occurred due to a mistake on the user's part (e....
Definition: IException.h:126