Isis 3.0 Object Programmers' Reference |
Home |
Calculates a lat/lon grid over an area. More...
#include <GroundGrid.h>
Public Member Functions | |
GroundGrid (UniversalGroundMap *gmap, bool splitLatLon, unsigned int width, unsigned int height) | |
This method initializes the class by allocating the grid, calculating the lat/lon range, and getting a default grid resolution. | |
virtual | ~GroundGrid () |
Delete the object. | |
void | CreateGrid (Latitude baseLat, Longitude baseLon, Angle latInc, Angle lonInc, Progress *progress=0) |
This method draws the grid internally, using default resolutions. | |
void | CreateGrid (Latitude baseLat, Longitude baseLon, Angle latInc, Angle lonInc, Progress *progress, Angle latRes, Angle lonRes) |
This method draws the grid internally. | |
void | WalkBoundary () |
This draws grid lines along the extremes of the lat/lon box of the grid. | |
void | SetGroundLimits (Latitude minLat, Longitude minLon, Latitude maxLat, Longitude maxLon) |
This restricts (or grows) the ground range in which to draw grid lines. | |
bool | PixelOnGrid (int x, int y) |
Returns true if the grid is on this point. | |
bool | PixelOnGrid (int x, int y, bool latGrid) |
Returns true if the grid is on this point. | |
PvlGroup * | GetMappingGroup () |
Returns a mapping group representation of the projection or camera. | |
Protected Member Functions | |
virtual bool | GetXY (Latitude lat, Longitude lon, unsigned int &x, unsigned int &y) |
This method converts a lat/lon to an X/Y. | |
UniversalGroundMap * | GroundMap () |
Returns the ground map for children. | |
Private Member Functions | |
void | SetGridBit (unsigned int x, unsigned int y, bool latGrid) |
This flags a bit as on the grid lines. | |
bool | GetGridBit (unsigned int x, unsigned int y, bool latGrid) |
Returns true if the specified coordinate is on the grid lines. | |
void | DrawLineOnGrid (unsigned int x1, unsigned int y1, unsigned int x2, unsigned int y2, bool isLatLine) |
This sets the bits on the grid along the specified line. | |
Private Attributes | |
char * | p_grid |
This stores the bits of each pixel in the grid. | |
char * | p_latLinesGrid |
This stores the bits of each pixel in the grid. | |
char * | p_lonLinesGrid |
This stores the bits of each pixel in the grid. | |
unsigned int | p_width |
This is the width of the grid. | |
unsigned int | p_height |
This is the height of the grid. | |
unsigned long | p_gridSize |
This is width*height. | |
UniversalGroundMap * | p_groundMap |
This calculates single grid pts. | |
Latitude * | p_minLat |
Lowest latitude in image. | |
Longitude * | p_minLon |
Lowest longitude in image. | |
Latitude * | p_maxLat |
Highest latitude in image. | |
Longitude * | p_maxLon |
Highest longitude in image. | |
PvlGroup * | p_mapping |
The mapping group representation of the projection or camera. | |
double | p_defaultResolution |
Default step size in degrees/pixel. | |
bool | p_reinitialize |
True if we need to reset p_grid in CreateGrid. | |
Calculates a lat/lon grid over an area.
This class, given a universal ground map, area width and height, base lat/lon, lat/lon increments, and optionalls a progress and resolutions will calculate where grid lines should lie.
2010-05-06 Steven Lambright - Added Split Lat/Lon Functionality
2010-06-22 Steven Lambright - Improved handling of resolutions
2011-01-25 Steven Lambright - Now uses native units to the projection, Lat/Lon classes, and several bug fixes when it comes to out of range values or non-standard projection types.
2011-01-26 Steven Lambright - Fixed a bug where the grid was not consistent on the edges and added SetGroundLimits and WalkBoundary for the new grid options Bound lat/lon range.
2011-02-25 Steven Lambright - Min/Max Lat/Lons do not have to be known in the constructor any more
2011-12-08 Steven Lambright - Fixed a bug causing the longitude range to be incorrect. Fixes #607.
2014-06-06 Kristin Berry - Fixed a bug where lat/lon were swapped in the code. Fixes #2081.
Definition at line 62 of file GroundGrid.h.
Isis::GroundGrid::GroundGrid | ( | UniversalGroundMap * | gmap, |
bool | splitLatLon, | ||
unsigned int | width, | ||
unsigned int | height | ||
) |
This method initializes the class by allocating the grid, calculating the lat/lon range, and getting a default grid resolution.
gmap | A universal ground map to use for calculating the grid |
splitLatLon | Make two grids: one for latitude lines and one for longitude lines |
width | The width of the grid; often cube samples |
height | The height of the grid; often cube samples |
Definition at line 32 of file GroundGrid.cpp.
References Isis::PvlObject::findGroup(), Isis::Distance::meters(), and Isis::toDouble().
|
virtual |
Delete the object.
Definition at line 154 of file GroundGrid.cpp.
void Isis::GroundGrid::CreateGrid | ( | Latitude | baseLat, |
Longitude | baseLon, | ||
Angle | latInc, | ||
Angle | lonInc, | ||
Progress * | progress = 0 |
||
) |
This method draws the grid internally, using default resolutions.
baseLat | Latitude to hit in the grid |
baseLon | Longitude to hit in the grid |
latInc | Distance between latitude lines |
lonInc | Distance between longitude lines |
progress | If passed in, this progress will be used |
Definition at line 205 of file GroundGrid.cpp.
void Isis::GroundGrid::CreateGrid | ( | Latitude | baseLat, |
Longitude | baseLon, | ||
Angle | latInc, | ||
Angle | lonInc, | ||
Progress * | progress, | ||
Angle | latRes, | ||
Angle | lonRes | ||
) |
This method draws the grid internally.
It is not valid to call PixelOnGrid until this method has been called.
baseLat | Latitude to hit in the grid |
baseLon | Longitude to hit in the grid |
latInc | Distance between latitude lines |
lonInc | Distance between longitude lines |
progress | If passed in, this progress will be used |
latRes | Resolution of latitude lines (in degrees/pixel) |
lonRes | Resolution of longitude lines (in degrees/pixel) |
Definition at line 224 of file GroundGrid.cpp.
References _FILEINFO_, Isis::Progress::CheckStatus(), Isis::Angle::isValid(), and Isis::Progress::SetMaximumSteps().
|
private |
This sets the bits on the grid along the specified line.
x1 | Start X |
y1 | Start Y |
x2 | End X |
y2 | End Y |
isLatLine |
Definition at line 615 of file GroundGrid.cpp.
|
private |
Returns true if the specified coordinate is on the grid lines.
x | X-Coordinate (0-based) |
y | Y-Coordinate (0-based) |
latGrid | True if you want to access the latitude grid where there are separate lat/lon grids. False for lon. Irrelevant if using a single grid. |
Definition at line 576 of file GroundGrid.cpp.
References _FILEINFO_.
|
inline |
Returns a mapping group representation of the projection or camera.
This is useful for matching units with lat/lons.
Definition at line 92 of file GroundGrid.h.
References p_mapping.
|
protectedvirtual |
This method converts a lat/lon to an X/Y.
This implementation converts to sample/line.
lat | Latitude of Lat/Lon pair to convert to S/L |
lon | Longitude of Lat/Lon pair to convert to S/L |
x | Output sample (0-based) |
y | Output line (0-based) |
Definition at line 517 of file GroundGrid.cpp.
|
inlineprotected |
Returns the ground map for children.
Definition at line 99 of file GroundGrid.h.
References p_groundMap.
bool Isis::GroundGrid::PixelOnGrid | ( | int | x, |
int | y | ||
) |
Returns true if the grid is on this point.
x | X-Coordinate of grid (0-based) |
y | Y-Coordinate of grid (0-based) |
Definition at line 495 of file GroundGrid.cpp.
bool Isis::GroundGrid::PixelOnGrid | ( | int | x, |
int | y, | ||
bool | latGrid | ||
) |
Returns true if the grid is on this point.
Using this method is recommended if lat/lon grids are separate.
x | X-Coordinate of grid (0-based) |
y | Y-Coordinate of grid (0-based) |
latGrid | True for latitude lines, false for longitude lines |
Definition at line 476 of file GroundGrid.cpp.
|
private |
This flags a bit as on the grid lines.
x | X-Coordinate (0-based) |
y | Y-Coordinate (0-based) |
latGrid | True if this is derived from a latitude line |
Definition at line 540 of file GroundGrid.cpp.
References _FILEINFO_.
void Isis::GroundGrid::SetGroundLimits | ( | Latitude | minLat, |
Longitude | minLon, | ||
Latitude | maxLat, | ||
Longitude | maxLon | ||
) |
This restricts (or grows) the ground range in which to draw grid lines.
minLat | The lowest latitude extreme to draw grid lines to |
maxLat | The highest latitude extreme to draw grid lines to |
minLon | The lowest longitude extreme to draw grid lines to |
maxLon | The highest longitude extreme to draw grid lines to |
Definition at line 385 of file GroundGrid.cpp.
References Isis::Angle::isValid().
void Isis::GroundGrid::WalkBoundary | ( | ) |
This draws grid lines along the extremes of the lat/lon box of the grid.
Definition at line 408 of file GroundGrid.cpp.
|
private |
Default step size in degrees/pixel.
Definition at line 127 of file GroundGrid.h.
|
private |
This stores the bits of each pixel in the grid.
Definition at line 111 of file GroundGrid.h.
|
private |
This is width*height.
Definition at line 116 of file GroundGrid.h.
|
private |
This calculates single grid pts.
Definition at line 117 of file GroundGrid.h.
Referenced by GroundMap().
|
private |
This is the height of the grid.
Definition at line 115 of file GroundGrid.h.
|
private |
This stores the bits of each pixel in the grid.
Definition at line 112 of file GroundGrid.h.
|
private |
This stores the bits of each pixel in the grid.
Definition at line 113 of file GroundGrid.h.
|
private |
The mapping group representation of the projection or camera.
Definition at line 125 of file GroundGrid.h.
Referenced by GetMappingGroup().
|
private |
Highest latitude in image.
Definition at line 121 of file GroundGrid.h.
|
private |
Highest longitude in image.
Definition at line 122 of file GroundGrid.h.
|
private |
Lowest latitude in image.
Definition at line 119 of file GroundGrid.h.
|
private |
Lowest longitude in image.
Definition at line 120 of file GroundGrid.h.
|
private |
True if we need to reset p_grid in CreateGrid.
Definition at line 129 of file GroundGrid.h.
|
private |
This is the width of the grid.
Definition at line 114 of file GroundGrid.h.