Isis 3 Programmer Reference
ImagePolygon.h
1 #ifndef ImagePolygon_h
2 #define ImagePolygon_h
3 
8 /* SPDX-License-Identifier: CC0-1.0 */
9 
10 #include <string>
11 #include <sstream>
12 #include <vector>
13 
14 #include "IException.h"
15 #include "Cube.h"
16 #include "Brick.h"
17 #include "Blob.h"
18 #include "Camera.h"
19 #include "Projection.h"
20 #include "UniversalGroundMap.h"
21 #include "Blob.h"
22 #include "geos/geom/Coordinate.h"
23 #include "geos/geom/MultiPolygon.h"
24 #include "geos/geom/CoordinateSequence.h"
25 
26 namespace Isis {
27 
153  class ImagePolygon {
154 
155  public:
156  ImagePolygon();
157  ImagePolygon(Blob &blob);
158  ~ImagePolygon();
159 
160  void Create(Cube &cube, int sinc = 1, int linc = 1,
161  int ss = 1, int sl = 1, int ns = 0, int nl = 0, int band = 1,
162  bool increasePrecision = false);
163 
164  void Create(std::vector<std::vector<double>> polyCoordinates);
165 
166  Camera * initCube(Cube &cube, int ss = 1, int sl = 1,
167  int ns = 0, int nl = 0, int band = 1);
168 
174  void Emission(double emission) {
175  p_emission = emission;
176  }
182  void Incidence(double incidence) {
183  p_incidence = incidence;
184  }
185 
192  void EllipsoidLimb(bool ellip) {
193  p_ellipsoid = ellip;
194  }
195 
205  void SubpixelAccuracy(int div) {
206  p_subpixelAccuracy = div;
207  }
208 
210  geos::geom::MultiPolygon *Polys() {
211  return p_polygons;
212  };
213 
215  std::string polyStr() const {
216  return p_polyStr;
217  };
218 
219  double validSampleDim();
220  double validLineDim();
221 
223  int getSinc() const {
224  return p_sampinc;
225  }
226 
228  int getLinc() const {
229  return p_lineinc;
230  }
231 
232  int numVertices() const {
233  return p_pts->size();
234  }
235 
236  Blob toBlob() const;
237 
238  private:
239  // Please do not add new polygon manipulation methods to this class.
240  // Polygon manipulation should be done in the PolygonTools class.
241  bool SetImage(const double sample, const double line);
242 
243  geos::geom::Coordinate FindFirstPoint();
244  void WalkPoly();
245  geos::geom::Coordinate FindNextPoint(geos::geom::Coordinate *currentPoint,
246  geos::geom::Coordinate lastPoint,
247  int recursionDepth = 0);
248 
249  double DistanceSquared(const geos::geom::Coordinate *p1, const geos::geom::Coordinate *p2);
250 
251  void MoveBackInsideImage(double &sample, double &line, double sinc, double linc);
252  bool InsideImage(double sample, double line);
253  void Fix360Poly();
254  void FixPolePoly(std::vector<geos::geom::Coordinate> *crossingPoints);
255 
256  bool IsLimb();
257  geos::geom::Coordinate FindBestPoint(geos::geom::Coordinate *currentPoint,
258  geos::geom::Coordinate newPoint,
259  geos::geom::Coordinate lastPoint);
260  geos::geom::Coordinate FixCornerSkip(geos::geom::Coordinate *currentPoint,
261  geos::geom::Coordinate newPoint);
262 
263  void FindSubpixel(std::vector<geos::geom::Coordinate> & points);
264 
266 
269 
271 
272  geos::geom::CoordinateSequence *p_pts;
273 
274  geos::geom::MultiPolygon *p_polygons;
275 
276  std::string p_polyStr;
277 
279 
280  geos::geom::Coordinate *m_leftCoord;
281  geos::geom::Coordinate *m_rightCoord;
282  geos::geom::Coordinate *m_topCoord;
283  geos::geom::Coordinate *m_botCoord;
284 
289 
290  int p_sampinc;
291  int p_lineinc;
292 
293  double p_emission;
294  double p_incidence;
295  bool p_ellipsoid;
296 
298 
299  };
300 };
301 
302 #endif
Isis::ImagePolygon::ImagePolygon
ImagePolygon()
Constructs a Polygon object, setting the polygon name.
Definition: ImagePolygon.cpp:40
Isis::ImagePolygon::Incidence
void Incidence(double incidence)
Set the maximum incidence angle ( light contacting the planet )
Definition: ImagePolygon.h:182
Isis::ImagePolygon::~ImagePolygon
~ImagePolygon()
Destroys the Polygon object.
Definition: ImagePolygon.cpp:86
Isis::ImagePolygon::FixCornerSkip
geos::geom::Coordinate FixCornerSkip(geos::geom::Coordinate *currentPoint, geos::geom::Coordinate newPoint)
Looks at the next possible point relative to the lasts and attempts to adjust the point outward to gr...
Definition: ImagePolygon.cpp:1472
Isis::ImagePolygon::m_topCoord
geos::geom::Coordinate * m_topCoord
The cube's top-most valid coord.
Definition: ImagePolygon.h:282
Isis::ImagePolygon::p_sampinc
int p_sampinc
The increment for walking along the polygon in the sample direction.
Definition: ImagePolygon.h:290
Isis::ImagePolygon::InsideImage
bool InsideImage(double sample, double line)
This returns true if sample/line are inside the cube.
Definition: ImagePolygon.cpp:514
Isis::ImagePolygon::p_subpixelAccuracy
int p_subpixelAccuracy
The subpixel accuracy to use.
Definition: ImagePolygon.h:297
Isis::UniversalGroundMap
Universal Ground Map.
Definition: UniversalGroundMap.h:69
Isis::ImagePolygon::validSampleDim
double validSampleDim()
Retuns the maximum valid sample width of the cube set with either initCube() or Create()
Definition: ImagePolygon.cpp:555
Isis::ImagePolygon::FindFirstPoint
geos::geom::Coordinate FindFirstPoint()
Finds the first point that projects in an image.
Definition: ImagePolygon.cpp:528
Isis::ImagePolygon::p_cubeLines
int p_cubeLines
The number of lines in the cube.
Definition: ImagePolygon.h:288
Isis::ImagePolygon::validLineDim
double validLineDim()
Retuns the maximum valid line width of the cube set with either initCube() or Create()
Definition: ImagePolygon.cpp:570
Isis::ImagePolygon::m_rightCoord
geos::geom::Coordinate * m_rightCoord
The cube's right-most valid coord.
Definition: ImagePolygon.h:281
Isis::ImagePolygon::p_ellipsoid
bool p_ellipsoid
Uses an ellipsoid if a limb is detected.
Definition: ImagePolygon.h:295
Isis::ImagePolygon::toBlob
Blob toBlob() const
Serialize the ImagePolygon to a Blob.
Definition: ImagePolygon.cpp:1347
Isis::ImagePolygon::initCube
Camera * initCube(Cube &cube, int ss=1, int sl=1, int ns=0, int nl=0, int band=1)
Create a Polygon from given cube.
Definition: ImagePolygon.cpp:121
Isis::ImagePolygon::polyStr
std::string polyStr() const
Return a geos Multipolygon.
Definition: ImagePolygon.h:215
Isis::ImagePolygon::Create
void Create(Cube &cube, int sinc=1, int linc=1, int ss=1, int sl=1, int ns=0, int nl=0, int band=1, bool increasePrecision=false)
Create a Polygon from given cube.
Definition: ImagePolygon.cpp:217
Isis::ImagePolygon::p_cube
Cube * p_cube
The cube provided.
Definition: ImagePolygon.h:267
Isis::ImagePolygon
Create cube polygons, read/write polygons to blobs.
Definition: ImagePolygon.h:153
Isis::Camera
Definition: Camera.h:236
Isis::ImagePolygon::p_isProjected
bool p_isProjected
True when the provided cube is projected.
Definition: ImagePolygon.h:268
Isis::ImagePolygon::getSinc
int getSinc() const
Return the sample increment used the create this polygon.
Definition: ImagePolygon.h:223
Isis::Brick
Buffer for containing a three dimensional section of an image.
Definition: Brick.h:45
Isis::ImagePolygon::m_leftCoord
geos::geom::Coordinate * m_leftCoord
The cube's left-most valid coord.
Definition: ImagePolygon.h:280
Isis::ImagePolygon::p_emission
double p_emission
The maximum emission angle to consider valid.
Definition: ImagePolygon.h:293
Isis::ImagePolygon::m_botCoord
geos::geom::Coordinate * m_botCoord
The cube's bot-most valid coord.
Definition: ImagePolygon.h:283
Isis::ImagePolygon::WalkPoly
void WalkPoly()
Walks the image finding its lon lat polygon and stores it to p_pts.
Definition: ImagePolygon.cpp:638
Isis::ImagePolygon::p_polyStr
std::string p_polyStr
The string representation of the polygon.
Definition: ImagePolygon.h:276
Isis::ImagePolygon::p_gMap
UniversalGroundMap * p_gMap
The cube's ground map.
Definition: ImagePolygon.h:278
Isis::ImagePolygon::SubpixelAccuracy
void SubpixelAccuracy(int div)
The subpixel accuracy to use.
Definition: ImagePolygon.h:205
Isis::ImagePolygon::p_brick
Brick * p_brick
Used to check for valid DNs.
Definition: ImagePolygon.h:270
Isis::ImagePolygon::FindNextPoint
geos::geom::Coordinate FindNextPoint(geos::geom::Coordinate *currentPoint, geos::geom::Coordinate lastPoint, int recursionDepth=0)
Finds the next point on the image using a left hand rule walking algorithm.
Definition: ImagePolygon.cpp:316
Isis::ImagePolygon::DistanceSquared
double DistanceSquared(const geos::geom::Coordinate *p1, const geos::geom::Coordinate *p2)
Calculates the distance squared between two coordinates.
Definition: ImagePolygon.cpp:1373
Isis::ImagePolygon::p_lineinc
int p_lineinc
The increment for walking along the polygon in the line direcction.
Definition: ImagePolygon.h:291
Isis::ImagePolygon::p_cubeStartLine
int p_cubeStartLine
The the line of the first valid point in the cube.
Definition: ImagePolygon.h:286
Isis::ImagePolygon::p_polygons
geos::geom::MultiPolygon * p_polygons
The multipolygon of the image.
Definition: ImagePolygon.h:274
Isis::ImagePolygon::Emission
void Emission(double emission)
Set the maximum emission angle ( light refleted to camera )
Definition: ImagePolygon.h:174
Isis::ImagePolygon::p_cubeStartSamp
int p_cubeStartSamp
The the sample of the first valid point in the cube.
Definition: ImagePolygon.h:285
Isis::ImagePolygon::SetImage
bool SetImage(const double sample, const double line)
Sets the sample/line values of the cube to get lat/lon values.
Definition: ImagePolygon.cpp:1079
Isis::ImagePolygon::getLinc
int getLinc() const
Return the line increment used the create this polygon.
Definition: ImagePolygon.h:228
Isis::ImagePolygon::p_cubeSamps
int p_cubeSamps
The number of samples in the cube.
Definition: ImagePolygon.h:287
Isis::Cube
IO Handler for Isis Cubes.
Definition: Cube.h:167
Isis::ImagePolygon::p_incidence
double p_incidence
The maximum incidence angle to consider valid.
Definition: ImagePolygon.h:294
Isis::ImagePolygon::FixPolePoly
void FixPolePoly(std::vector< geos::geom::Coordinate > *crossingPoints)
If the cube crosses the 0/360 boundary and contains a pole, Some points are added to allow the polygo...
Definition: ImagePolygon.cpp:835
Isis::ImagePolygon::IsLimb
bool IsLimb()
Returns True when the input image is a limb image.
Definition: ImagePolygon.cpp:1383
Isis::ImagePolygon::calcImageBorderCoordinates
void calcImageBorderCoordinates()
Calculates the four border points, particularly for validSampleDim() and validLineDim()
Definition: ImagePolygon.cpp:589
Isis::ImagePolygon::MoveBackInsideImage
void MoveBackInsideImage(double &sample, double &line, double sinc, double linc)
This method ensures sample/line after sinc/linc have been applied is inside the image.
Definition: ImagePolygon.cpp:446
Isis::ImagePolygon::FindSubpixel
void FindSubpixel(std::vector< geos::geom::Coordinate > &points)
Takes p_polygons in sample/line space and finds its subpixel accuracy.
Definition: ImagePolygon.cpp:1528
Isis::ImagePolygon::Fix360Poly
void Fix360Poly()
If the cube crosses the 0/360 boundary and does not include a pole, the polygon is separated into mul...
Definition: ImagePolygon.cpp:1141
Isis::ImagePolygon::EllipsoidLimb
void EllipsoidLimb(bool ellip)
If a limb is detected, use un ellipsoid shape model if true.
Definition: ImagePolygon.h:192
Isis::ImagePolygon::FindBestPoint
geos::geom::Coordinate FindBestPoint(geos::geom::Coordinate *currentPoint, geos::geom::Coordinate newPoint, geos::geom::Coordinate lastPoint)
While walking the image in sample/line space, this function finds the best valid point between the fi...
Definition: ImagePolygon.cpp:1407
Isis::ImagePolygon::p_pts
geos::geom::CoordinateSequence * p_pts
The sequence of coordinates that compose the boundry of the image.
Definition: ImagePolygon.h:272
Isis::Blob
Definition: Blob.h:51
Isis::ImagePolygon::Polys
geos::geom::MultiPolygon * Polys()
Return a geos Multipolygon.
Definition: ImagePolygon.h:210
Isis
This is free and unencumbered software released into the public domain.
Definition: Apollo.h:16