Universal Ground Map. More...

#include <UniversalGroundMap.h>

Collaboration diagram for Isis::UniversalGroundMap:

Public Types
enum	CameraPriority { CameraFirst, ProjectionFirst }
	This enum is used to define whether to use a camera or projection primarily, and which to fall back on. More...

Public Member Functions
	UniversalGroundMap (Cube &cube, CameraPriority priority=CameraFirst)
	Constructs a UniversalGroundMap object from a cube.

	~UniversalGroundMap ()
	Destroys the UniversalGroundMap object.

void	SetBand (const int band)
	Set the image band number.

bool	SetUniversalGround (double lat, double lon)
	Returns whether the lat/lon position was set successfully in the camera model or projection.

bool	SetGround (Latitude lat, Longitude lon)
	Returns whether the lat/lon position was set successfully in the camera model or projection.

bool	SetGround (const SurfacePoint &)
	Returns whether the SurfacePoint was set successfully in the camera model or projection.

double	Sample () const
	Returns the current line value of the camera model or projection.

double	Line () const
	Returns the current line value of the camera model or projection.

bool	SetImage (double sample, double line)
	Returns whether the sample/line postion was set successfully in the camera model or projection.

double	UniversalLatitude () const
	Returns the universal latitude of the camera model or projection.

double	UniversalLongitude () const
	Returns the universal longitude of the camera model or projection.

double	Resolution () const
	Returns the resolution of the camera model or projection.

bool	GroundRange (Cube *cube, Latitude &minLat, Latitude &maxLat, Longitude &minLon, Longitude &maxLon, bool allowEstimation=true)
	Find the lat/lon range of the image.

bool	HasProjection ()
	Returns whether the ground map has a projection or not.

bool	HasCamera ()
	Returns whether the ground map has a camera or not.

Isis::Projection *	Projection () const
	Return the projection associated with the ground map (NULL implies none)

Isis::Camera *	Camera () const
	Return the camera associated with the ground map (NULL implies none)

Private Attributes
Isis::Camera *	p_camera
	The camera (if the image has a camera)

Isis::Projection *	p_projection
	The projection (if the image is projected)

Detailed Description

Universal Ground Map.

???

Author: 2005-08-09 Jeff Anderson

Todo:: Jeff Anderson - Finish Class Documentation

History:

2005-11-09 Tracie Sucharski Added HasProjection method.

2006-03-20 Elizabeth Miller Added camera, projection, and Resolution methods and documentation

2006-03-31 Elizabeth Miller Added unitTest

2006-05-17 Elizabeth Miller Depricated CameraManager to CameraFactory

2007-02-06 Tracie Sucharski Added SetBand method.

2007-02-06 Steven Lambright Fixed documentation

2009-04-24 Steven Koechle Added a check to SetUniversalGround that makes sure the result is on the cube before returning true.

2010-04-09 Sharmila Prasad Added an API to check for camera in an image

2010-04-28 Mackenzie Boyd Fixed dereferencing issue in constructor that takes a cube.

2011-01-25 Steven Lambright Added CameraPriority and SetGround. The CameraPriority was for grid to use projections by default so they would work across the image regardless of the camera. The SetGround is so that conversions between lat/lon types are simply handled and allows a clean interface to use the new Latitude and Longitude classes.

2011-01-25 Eric Hyer - Added SetGround method for Surface Points

2012-03-22 Steven Lambright - Added GroundRange() method because I needed a ground range in the qview nomenclature tool and this seemed like the best place to put it. The Cube paramater is optional.

2012-06-29 Steven Lambright and Kimberly Oyama - Made the estimation section of GroundRange() sample more points by walking the perimeter, the two corner to corner diagonals, and a plus that intersects in the center of the image. This ensures that the entire longitude range is returned. Fixes #855.

2012-12-20 Debbie A. Cook - Changed to use TProjection instead of Projection. References #775.

2013-04-24 Tracie Sucharski - Added ring plane functionality to methods UniversalLatitude() and UniversalLongitude(). Reference #775.

2012-04-24 Jeannie Backer - Removed prototype for constructor that has been removed from this class. References #775.

Definition at line 83 of file UniversalGroundMap.h.

Member Enumeration Documentation

enum Isis::UniversalGroundMap::CameraPriority

This enum is used to define whether to use a camera or projection primarily, and which to fall back on.

Enumerator

CameraFirst

This is the default because cameras are projection-aware.

Use the camera for additional power if available, and fall back to projection

ProjectionFirst

Use the projection for functionality well outside the original image if available, and fall back to camera.

Definition at line 89 of file UniversalGroundMap.h.

Constructor & Destructor Documentation

Isis::UniversalGroundMap::UniversalGroundMap	(	Cube &	cube,
		CameraPriority	priority = `CameraFirst`
	)

Constructs a UniversalGroundMap object from a cube.

Parameters

cube	The Cube to create the UniversalGroundMap from
priority	Try to make a camera or projection first

Definition at line 27 of file UniversalGroundMap.cpp.

References _FILEINFO_, Isis::IException::append(), CameraFirst, Isis::CameraFactory::Create(), Isis::ProjectionFactory::CreateFromCube(), Isis::Cube::fileName(), Isis::Cube::label(), p_camera, p_projection, and Isis::IException::Unknown.

Isis::UniversalGroundMap::~UniversalGroundMap ( )

Destroys the UniversalGroundMap object.

Definition at line 74 of file UniversalGroundMap.cpp.

References p_camera, and p_projection.

Member Function Documentation

Isis::Camera* Isis::UniversalGroundMap::Camera ( ) const

inline

Return the camera associated with the ground map (NULL implies none)

Definition at line 149 of file UniversalGroundMap.h.

References p_camera.

Referenced by Isis::ImagePolygon::Create(), Isis::CubeViewport::CubeViewport(), Isis::FindTool::distancePerPixel(), Isis::MosaicSceneItem::drawImage(), Isis::ImagePolygon::FixPolePoly(), Isis::ImagePolygon::initCube(), and Isis::ImagePolygon::SetImage().

bool Isis::UniversalGroundMap::GroundRange	(	Cube *	cube,
		Latitude &	minLat,
		Latitude &	maxLat,
		Longitude &	minLon,
		Longitude &	maxLon,
		bool	allowEstimation = `true`
	)

Find the lat/lon range of the image.

This will use the image footprint, camera, or projection in order to find a good result.

Parameters

Cube*	This is required for estimation. You can pass in NULL (it will disable estimation).
minLat	This is an output: minimum latitude
maxLat	This is an output: maximum latitude
minLon	This is an output: minimum longitude
maxLon	This is an output: maximum longitude
allowEstimation	If this is true then extra efforts will be made to guess the ground range of the input. This can still fail.

Returns: True if a ground range was found, false if no ground range could be determined. Some lat/lon results may still be populated; their values are undefined.

Definition at line 282 of file UniversalGroundMap.cpp.

References Isis::Angle::Degrees, Isis::Camera::GroundRange(), HasCamera(), Isis::PvlContainer::hasKeyword(), HasProjection(), Isis::Angle::isValid(), Isis::Cube::lineCount(), Isis::PolygonTools::MakeMultiPolygon(), Isis::ShapeModel::name(), p_camera, p_projection, Isis::ImagePolygon::Polys(), Isis::Projection::projectionType(), Isis::Cube::read(), Isis::Projection::RingPlane, Isis::Cube::sampleCount(), Isis::Projection::SetWorld(), Isis::Target::shape(), Isis::Spice::target(), Isis::TProjection::UniversalLatitude(), and Isis::TProjection::UniversalLongitude().

Referenced by Isis::FeatureNomenclatureTool::findMissingNomenclature().

bool Isis::UniversalGroundMap::HasCamera ( )

inline

Returns whether the ground map has a camera or not.

Returns: bool Returns true if the ground map has a camera, and false if it does not

Definition at line 139 of file UniversalGroundMap.h.

References p_camera.

Referenced by GroundRange(), and Isis::InterestOperator::Operate().

bool Isis::UniversalGroundMap::HasProjection ( )

inline

Returns whether the ground map has a projection or not.

Returns: bool Returns true if the ground map has a projection, and false if it does not

Definition at line 128 of file UniversalGroundMap.h.

References p_projection.

Referenced by Isis::FindTool::distancePerPixel(), and GroundRange().

double Isis::UniversalGroundMap::Line ( ) const

Returns the current line value of the camera model or projection.

Returns: Line value

Definition at line 176 of file UniversalGroundMap.cpp.

References Isis::Camera::Line(), p_camera, p_projection, and Isis::Projection::WorldY().

Referenced by Isis::FindTool::centerLinkedViewports(), Isis::StereoTool::createPoint(), Isis::QnetTool::demRadius(), Isis::FindTool::distancePerPixel(), Isis::ControlPointEdit::findPoint(), Isis::FindTool::handleRecordClicked(), Isis::PolygonTools::LatLonToSampleLine(), Isis::FindTool::paintViewport(), and Isis::FindTool::updateTool().

Isis::Projection* Isis::UniversalGroundMap::Projection ( ) const

inline

Return the projection associated with the ground map (NULL implies none)

Definition at line 144 of file UniversalGroundMap.h.

References p_projection.

Referenced by Isis::CubeViewport::CubeViewport(), Isis::FindTool::distancePerPixel(), Isis::MosaicSceneItem::drawImage(), and Isis::ImagePolygon::FixPolePoly().

double Isis::UniversalGroundMap::Resolution ( ) const

Returns the resolution of the camera model or projection.

Returns: Resolution

Definition at line 256 of file UniversalGroundMap.cpp.

References p_camera, p_projection, Isis::Camera::PixelResolution(), and Isis::Projection::Resolution().

Referenced by Isis::FindTool::distancePerPixel().

double Isis::UniversalGroundMap::Sample ( ) const

Returns the current line value of the camera model or projection.

Returns: Sample value

Definition at line 162 of file UniversalGroundMap.cpp.

References p_camera, p_projection, Isis::Camera::Sample(), and Isis::Projection::WorldX().

Referenced by Isis::FindTool::centerLinkedViewports(), Isis::StereoTool::createPoint(), Isis::QnetTool::demRadius(), Isis::FindTool::distancePerPixel(), Isis::ControlPointEdit::findPoint(), Isis::FindTool::handleRecordClicked(), Isis::PolygonTools::LatLonToSampleLine(), Isis::FindTool::paintViewport(), and Isis::FindTool::updateTool().

void Isis::UniversalGroundMap::SetBand ( const int band )

Set the image band number.

Parameters

[in] band (int) Image band number

Definition at line 66 of file UniversalGroundMap.cpp.

References p_camera, and Isis::Camera::SetBand().

Referenced by Isis::ImagePolygon::initCube().

bool Isis::UniversalGroundMap::SetGround	(	Latitude	lat,
		Longitude	lon
	)

Returns whether the lat/lon position was set successfully in the camera model or projection.

Parameters

lat	The universal latitude or ring radius for ring planes
lon	The universal longitude or ring longitude (azimuth) for ring planes

Returns: Returns true if the lat/lon position was set successfully, and false if it was not

Definition at line 116 of file UniversalGroundMap.cpp.

References Isis::Angle::degrees(), Isis::Camera::InCube(), p_camera, p_projection, Isis::Camera::SetGround(), and Isis::Projection::SetUniversalGround().

Referenced by Isis::StereoTool::measureSaved().

bool Isis::UniversalGroundMap::SetGround ( const SurfacePoint & sp )

Returns whether the SurfacePoint was set successfully in the camera model or projection.

Parameters

sp	The Surface Point to set ground with

Returns: Returns true if the Surface Point was set successfully, and false otherwise

Definition at line 142 of file UniversalGroundMap.cpp.

References Isis::Angle::degrees(), Isis::SurfacePoint::GetLatitude(), Isis::SurfacePoint::GetLongitude(), Isis::Camera::InCube(), p_camera, p_projection, Isis::Camera::SetGround(), and Isis::Projection::SetUniversalGround().

bool Isis::UniversalGroundMap::SetImage	(	double	sample,
		double	line
	)

Returns whether the sample/line postion was set successfully in the camera model or projection.

Parameters

sample	The sample position
line	The line position

Returns: Returns true if the sample/line position was set successfully, and false if it was not

Definition at line 195 of file UniversalGroundMap.cpp.

References p_camera, p_projection, Isis::Camera::SetImage(), and Isis::Projection::SetWorld().

Referenced by Isis::FindTool::distancePerPixel(), Isis::ControlPointEdit::findPoint(), Isis::SpatialPlotTool::getSpatialStatistics(), Isis::StereoTool::measureSaved(), Isis::FindTool::mouseButtonRelease(), Isis::QnetTool::mouseButtonRelease(), Isis::InterestOperator::Operate(), Isis::ImagePolygon::SetImage(), Isis::ControlPointEdit::updateLeftPositionLabel(), Isis::ControlPointEdit::updateRightPositionLabel(), and Isis::FindTool::updateTool().

bool Isis::UniversalGroundMap::SetUniversalGround	(	double	lat,
		double	lon
	)

Returns whether the lat/lon position was set successfully in the camera model or projection.

Parameters

lat	The universal latitude or ring radius for ring planes
lon	The universal longitude or ring longitude (azimuth) for ring planes

Returns: Returns true if the lat/lon position was set successfully, and false if it was not

Definition at line 91 of file UniversalGroundMap.cpp.

References Isis::Camera::InCube(), p_camera, p_projection, Isis::Projection::SetUniversalGround(), and Isis::Camera::SetUniversalGround().

Referenced by Isis::FindTool::centerLinkedViewports(), Isis::StereoTool::createPoint(), Isis::QnetTool::demRadius(), Isis::FindTool::distancePerPixel(), Isis::MosaicSceneItem::drawImage(), Isis::ControlPointEdit::findPoint(), Isis::ImagePolygon::FixPolePoly(), Isis::FindTool::handleRecordClicked(), Isis::PolygonTools::LatLonToSampleLine(), Isis::FindTool::paintViewport(), and Isis::FindTool::updateTool().

double Isis::UniversalGroundMap::UniversalLatitude ( ) const

Returns the universal latitude of the camera model or projection.

Returns: Universal Latitude

Definition at line 209 of file UniversalGroundMap.cpp.

References p_camera, p_projection, Isis::Projection::projectionType(), Isis::RingPlaneProjection::RingRadius(), Isis::Projection::Triaxial, Isis::Sensor::UniversalLatitude(), and Isis::TProjection::UniversalLatitude().

Referenced by Isis::FindTool::distancePerPixel(), Isis::ControlPointEdit::findPoint(), Isis::StereoTool::measureSaved(), Isis::FindTool::mouseButtonRelease(), Isis::QnetTool::mouseButtonRelease(), Isis::ControlPointEdit::updateLeftPositionLabel(), Isis::ControlPointEdit::updateRightPositionLabel(), Isis::FindTool::updateTool(), and Isis::ImagePolygon::WalkPoly().

double Isis::UniversalGroundMap::UniversalLongitude ( ) const

Returns the universal longitude of the camera model or projection.

Returns: Universal Longitude

Definition at line 232 of file UniversalGroundMap.cpp.

References p_camera, p_projection, Isis::Projection::projectionType(), Isis::RingPlaneProjection::RingLongitude(), Isis::Projection::Triaxial, Isis::Sensor::UniversalLongitude(), and Isis::TProjection::UniversalLongitude().

Referenced by Isis::FindTool::distancePerPixel(), Isis::ControlPointEdit::findPoint(), Isis::StereoTool::measureSaved(), Isis::FindTool::mouseButtonRelease(), Isis::QnetTool::mouseButtonRelease(), Isis::ControlPointEdit::updateLeftPositionLabel(), Isis::ControlPointEdit::updateRightPositionLabel(), Isis::FindTool::updateTool(), and Isis::ImagePolygon::WalkPoly().

Member Data Documentation

Isis::Camera* Isis::UniversalGroundMap::p_camera

private

The camera (if the image has a camera)

Definition at line 151 of file UniversalGroundMap.h.

Referenced by Camera(), GroundRange(), HasCamera(), Line(), Resolution(), Sample(), SetBand(), SetGround(), SetImage(), SetUniversalGround(), UniversalGroundMap(), UniversalLatitude(), UniversalLongitude(), and ~UniversalGroundMap().

Isis::Projection* Isis::UniversalGroundMap::p_projection

private

The projection (if the image is projected)

Definition at line 156 of file UniversalGroundMap.h.

Referenced by GroundRange(), HasProjection(), Line(), Projection(), Resolution(), Sample(), SetGround(), SetImage(), SetUniversalGround(), UniversalGroundMap(), UniversalLatitude(), UniversalLongitude(), and ~UniversalGroundMap().

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

src/base/objs/UniversalGroundMap/UniversalGroundMap.h
src/base/objs/UniversalGroundMap/UniversalGroundMap.cpp

Public Types

Public Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation