Define shapes and provide utilities for shapes stored as Isis3 EquatorialCylindrical map. More...

#include <EquatorialCylindricalShape.h>

Inheritance diagram for Isis::EquatorialCylindricalShape:

Collaboration diagram for Isis::EquatorialCylindricalShape:

Public Member Functions
	EquatorialCylindricalShape (Target *target, Pvl &pvl)
	Initialize the Isis3 Equatorial Cylindrical shape model. More...

	~EquatorialCylindricalShape ()
	Destructor for Isis3 Equatorial Cylindrical shape model. More...

bool	intersectSurface (std::vector< double > observerPos, std::vector< double > lookDirection)
	Finds the surface intersection point. More...

Distance	localRadius (const Latitude &lat, const Longitude &lon)
	Gets the radius from the DEM, if we have one. More...

double	demScale ()
	Return the scale of the DEM shape, in pixels per degree. More...

virtual void	calculateDefaultNormal ()
	This method calculates the default normal (Ellipsoid for backwards compatability) for the DemShape. More...

bool	isDEM () const
	Indicates that this shape model is from a DEM. More...

void	calculateLocalNormal (QVector< double * > cornerNeighborPoints)
	This method calculates the local surface normal of the current intersection point. More...

void	calculateSurfaceNormal ()
	This method calculates the surface normal of the current intersection point. More...

void	Initialize ()
	Initializes the ShapeModel private variables. More...

SurfacePoint *	surfaceIntersection () const
	Returns the surface intersection for this ShapeModel. More...

bool	hasIntersection ()
	Returns intersection status. More...

bool	hasNormal () const
	Returns surface point normal status. More...

void	clearSurfacePoint ()
	Clears or resets the current surface point. More...

virtual double	emissionAngle (const std::vector< double > &sB)
	Computes and returns emission angle, in degrees, given the observer position. More...

virtual double	incidenceAngle (const std::vector< double > &uB)
	Computes and returns incidence angle, in degrees, given the illuminator position. More...

virtual double	phaseAngle (const std::vector< double > &sB, const std::vector< double > &uB)
	Computes and returns phase angle, in degrees, given the positions of the observer and illuminator. More...

QString	name () const
	Gets the shape name. More...

void	setHasIntersection (bool b)
	Sets the flag to indicate whether this ShapeModel has an intersection. More...

void	setSurfacePoint (const SurfacePoint &surfacePoint)
	Set surface intersection point. More...

std::vector< double >	normal ()
	Returns the local surface normal at the current intersection point. More...

Protected Member Functions
Cube *	demCube ()
	Returns the cube defining the shape model. More...

void	setNormal (const std::vector< double >)
	Sets the normal for the currect intersection point. More...

void	setNormal (const double a, const double b, const double c)
	Sets the normal for the currect intersection point. More...

void	setName (QString name)
	Sets the shape name. More...

void	calculateEllipsoidalSurfaceNormal ()
	Calculates the ellipsoidal surface normal. More...

bool	hasEllipsoidIntersection ()
	Returns the status of the ellipsoid model intersection. More...

bool	intersectEllipsoid (const std::vector< double > observerPosRelativeToTarget, const std::vector< double > &observerLookVectorToTarget)
	Finds the intersection point on the ellipsoid model using the given position of the observer (spacecraft) and direction vector from the observer to the target (body). More...

bool	hasValidTarget () const
	Returns the status of the target. More...

std::vector< Distance >	targetRadii () const
	Returns the radii of the body in km. More...

void	setHasNormal (bool status)
	Sets the flag to indicate whether this ShapeModel has a surface normal. More...

double	resolution ()
	Convenience method to get pixel resolution (m/pix) at current intersection point. More...

Private Attributes
Distance *	m_minRadius
	Minimum radius value in DEM file. More...

Distance *	m_maxRadius
	Maximum radius value in DEM file. More...

Detailed Description

Define shapes and provide utilities for shapes stored as Isis3 EquatorialCylindrical map.

This class will define shapes of Isis3 target bodies with the shape defined by an EquatorialCylindrical map, as well as provide utilities to retrieve radii and photometric information for the intersection point.

Author: 2010-07-30 Debbie A. Cook

History:

2012-12-19 Debbie A. Cook Added a check for an invalid radius in the intersectSurface() method, that was causing applications to hang. Also return a false if no ellipsoid itersection is found.

2015-07-21 Kristin Berry - Added NaifStatus::CheckErrors() to see if any NAIF errors were signaled. References #2248.

2015-10-01 Jeannie Backer - Made improvements to documentation and brought code closer to ISIS coding standards. Removed check for ellipsoid intersection in intersectSurface() method to prevent early return and attempt the iterative method even when the ellipsoid is not intersected. Fixes #1438

Definition at line 51 of file EquatorialCylindricalShape.h.

Constructor & Destructor Documentation

Isis::EquatorialCylindricalShape::EquatorialCylindricalShape	(	Target *	target,
		Pvl &	pvl
	)

Initialize the Isis3 Equatorial Cylindrical shape model.

Parameters

pvl	Valid Isis3 cube label.

Definition at line 37 of file EquatorialCylindricalShape.cpp.

References _FILEINFO_, Isis::DemShape::demCube(), Isis::Distance::Kilometers, m_maxRadius, m_minRadius, Isis::ShapeModel::setName(), and Isis::IException::User.

Isis::EquatorialCylindricalShape::~EquatorialCylindricalShape ( )

Destructor for Isis3 Equatorial Cylindrical shape model.

Definition at line 69 of file EquatorialCylindricalShape.cpp.

References m_maxRadius, and m_minRadius.

Member Function Documentation

void Isis::DemShape::calculateDefaultNormal ( )

virtualinherited

This method calculates the default normal (Ellipsoid for backwards compatability) for the DemShape.

Implements Isis::ShapeModel.

Definition at line 298 of file DemShape.cpp.

References Isis::ShapeModel::calculateEllipsoidalSurfaceNormal().

void Isis::ShapeModel::calculateEllipsoidalSurfaceNormal ( )

protectedinherited

Calculates the ellipsoidal surface normal.

Definition at line 81 of file ShapeModel.cpp.

References _FILEINFO_.

Referenced by Isis::EllipsoidShape::calculateDefaultNormal(), Isis::DemShape::calculateDefaultNormal(), Isis::EllipsoidShape::calculateSurfaceNormal(), and Isis::DemShape::calculateSurfaceNormal().

void Isis::DemShape::calculateLocalNormal ( QVector< double * > neighborPoints )

virtualinherited

This method calculates the local surface normal of the current intersection point.

Parameters

neighborPoints

Implements Isis::ShapeModel.

Definition at line 333 of file DemShape.cpp.

References Isis::ShapeModel::normal(), Isis::ShapeModel::setHasNormal(), Isis::ShapeModel::setNormal(), Isis::ShapeModel::surfaceIntersection(), and Isis::SurfacePoint::ToNaifArray().

void Isis::DemShape::calculateSurfaceNormal ( )

virtualinherited

This method calculates the surface normal of the current intersection point.

Implements Isis::ShapeModel.

Definition at line 387 of file DemShape.cpp.

References Isis::ShapeModel::calculateEllipsoidalSurfaceNormal().

void Isis::ShapeModel::clearSurfacePoint ( )

inherited

Clears or resets the current surface point.

Definition at line 327 of file ShapeModel.cpp.

Referenced by Isis::Camera::RawFocalPlanetoImage(), Isis::Sensor::SetGround(), Isis::Camera::SetGround(), Isis::Sensor::SetGroundLocal(), Isis::Camera::SetImage(), Isis::Camera::SetImageMapProjection(), Isis::Camera::SetImageSkyMapProjection(), Isis::Sensor::setTime(), Isis::Sensor::SetUniversalGround(), and Isis::Camera::SetUniversalGround().

Cube * Isis::DemShape::demCube ( )

protectedinherited

Returns the cube defining the shape model.

Returns the DEM Cube object.

Returns: Cube* A pointer to the DEM cube associated with this shape model.

Definition at line 308 of file DemShape.cpp.

References Isis::DemShape::m_demCube.

Referenced by EquatorialCylindricalShape().

double Isis::DemShape::demScale ( )

inherited

Return the scale of the DEM shape, in pixels per degree.

Returns: double The scale of the DEM.

Definition at line 289 of file DemShape.cpp.

References Isis::DemShape::m_pixPerDegree.

Referenced by intersectSurface().

double Isis::ShapeModel::emissionAngle ( const std::vector< double > & observerBodyFixedPosition )

virtualinherited

Computes and returns emission angle, in degrees, given the observer position.

Emission Angle: The angle between the surface normal vector at the intersection point and the vector from the intersection point to the observer (usually the spacecraft). The emission angle varies from 0 degrees when the observer is viewing the sub-spacecraft point (nadir viewing) to 90 degrees when the intercept is tangent to the surface of the target body. Thus, higher values of emission angle indicate more oblique viewing of the target.

Parameters

observerBodyFixedPosition Three dimensional position of the observer, in the coordinate system of the target body.

Returns: The emission angle, in decimal degrees.

Reimplemented in Isis::PlaneShape.

Definition at line 126 of file ShapeModel.cpp.

References Isis::RAD2DEG().

Referenced by Isis::Sensor::EmissionAngle(), and Isis::Sensor::SetGroundLocal().

bool Isis::ShapeModel::hasEllipsoidIntersection ( )

protectedinherited

Returns the status of the ellipsoid model intersection.

Returns: bool Indicates whether this shape model has a valid ellipsoid intersection.

Definition at line 154 of file ShapeModel.cpp.

bool Isis::ShapeModel::hasIntersection ( )

inherited

Returns intersection status.

Returns: bool Indicates whether this ShapeModel has an intersection.

Definition at line 309 of file ShapeModel.cpp.

Referenced by Isis::EllipsoidShape::calculateLocalNormal(), Isis::NaifDskShape::calculateLocalNormal(), Isis::NaifDskShape::ellipsoidNormal(), Isis::Camera::GetLocalNormal(), Isis::Sensor::HasSurfaceIntersection(), intersectSurface(), Isis::DemShape::intersectSurface(), and Isis::NaifDskShape::setLocalNormalFromIntercept().

bool Isis::ShapeModel::hasNormal ( ) const

inherited

Returns surface point normal status.

Returns: Indicates whether this ShapeModel has a surface normal.

Definition at line 319 of file ShapeModel.cpp.

Referenced by Isis::Camera::GetLocalNormal().

bool Isis::ShapeModel::hasValidTarget ( ) const

protectedinherited

Returns the status of the target.

If it is NULL, this method returns false.

Returns: Indicates whether the target is valid.

Definition at line 360 of file ShapeModel.cpp.

Referenced by Isis::NaifDskShape::ellipsoidNormal().

double Isis::ShapeModel::incidenceAngle ( const std::vector< double > & illuminatorBodyFixedPosition )

virtualinherited

Computes and returns incidence angle, in degrees, given the illuminator position.

Incidence Angle: The angle between the surface normal vector at the intersection point and the vector from the intersection point to the illuminator (usually the sun).

Note: this method does not use the surface model.

Parameters

illuminatorBodyFixedPosition Three dimensional position for the illuminator, in the body-fixed coordinate system.

Returns: double Incidence angle, in degrees.

Reimplemented in Isis::PlaneShape.

Definition at line 173 of file ShapeModel.cpp.

References Isis::RAD2DEG().

Referenced by Isis::Sensor::IncidenceAngle().

void Isis::ShapeModel::Initialize ( )

inherited

Initializes the ShapeModel private variables.

Definition at line 57 of file ShapeModel.cpp.

bool Isis::ShapeModel::intersectEllipsoid	(	const std::vector< double >	observerBodyFixedPosition,
		const std::vector< double > &	observerLookVectorToTarget
	)

protectedinherited

Finds the intersection point on the ellipsoid model using the given position of the observer (spacecraft) and direction vector from the observer to the target (body).

Parameters

observerBodyFixedPosition	Three dimensional position of the observer, in the coordinate system of the target body.
observerLookVectorToTarget	Three dimensional direction vector from the observer to the target.

Returns: bool Indicates whether this shape model found a valid ellipsoid intersection.

Definition at line 208 of file ShapeModel.cpp.

Referenced by Isis::EllipsoidShape::intersectSurface(), and Isis::DemShape::intersectSurface().

bool Isis::EquatorialCylindricalShape::intersectSurface	(	std::vector< double >	observerPos,
		std::vector< double >	lookDirection
	)

virtual

Finds the surface intersection point.

Parameters

observerBodyFixedPosition	Three dimensional position of the observer, in the coordinate system of the target body.
observerLookVectorToTarget	Three dimensional direction vector from the observer to the target.

Returns: bool Indicates whether this shape model found a valid surface intersection.

Reimplemented from Isis::DemShape.

Definition at line 89 of file EquatorialCylindricalShape.cpp.

References Isis::NaifStatus::CheckErrors(), Isis::DEG2RAD(), Isis::Angle::Degrees, Isis::DemShape::demScale(), Isis::E(), Isis::SurfacePoint::FromNaifArray(), Isis::ShapeModel::hasIntersection(), Isis::DemShape::intersectSurface(), Isis::IsSpecial(), Isis::Distance::kilometers(), Isis::DemShape::localRadius(), m_maxRadius, Isis::PI(), Isis::RAD2DEG(), Isis::ShapeModel::setHasIntersection(), Isis::ShapeModel::surfaceIntersection(), and Isis::ShapeModel::targetRadii().

bool Isis::DemShape::isDEM ( ) const

virtualinherited

Indicates that this shape model is from a DEM.

Since this method returns true for this class, the Camera class will calculate the local normal using neighbor points. This method is pure virtual and must be implemented by all DemShape classes. This parent implementation returns true.

Returns: bool Indicates that this is a DEM shape model.

Implements Isis::ShapeModel.

Definition at line 322 of file DemShape.cpp.

Distance Isis::DemShape::localRadius	(	const Latitude &	lat,
		const Longitude &	lon
	)

virtualinherited

Gets the radius from the DEM, if we have one.

Parameters

lat	Latitude
lon	Longitude

Returns: Distance Local radius from the DEM

Implements Isis::ShapeModel.

Definition at line 258 of file DemShape.cpp.

References Isis::Angle::degrees(), Isis::Buffer::DoubleBuffer(), Isis::Interpolator::Interpolate(), Isis::Angle::isValid(), Isis::DemShape::m_demCube, Isis::DemShape::m_demProj, Isis::DemShape::m_interp, Isis::DemShape::m_portal, Isis::Distance::Meters, Isis::Cube::read(), Isis::Portal::SetPosition(), Isis::Projection::SetUniversalGround(), Isis::Projection::WorldX(), and Isis::Projection::WorldY().

Referenced by intersectSurface(), and Isis::DemShape::intersectSurface().

QString Isis::ShapeModel::name ( ) const

inherited

Gets the shape name.

Returns: QString The name of the ShapeModel.

Definition at line 454 of file ShapeModel.cpp.

Referenced by Isis::UniversalGroundMap::GroundRange(), Isis::VimsGroundMap::SetGround(), Isis::Camera::SetGround(), Isis::Camera::SetImageMapProjection(), Isis::TrackTool::updateLabels(), and Isis::AdvancedTrackTool::updateRow().

std::vector< double > Isis::ShapeModel::normal ( )

inherited

Returns the local surface normal at the current intersection point.

Note: This method will throw an error if the normal doesn't exist. Use the hasNormal() method to verify before calling this method.

See Also: hasNormal()

Returns: A surface normal vector, if it exists.

Definition at line 342 of file ShapeModel.cpp.

References _FILEINFO_.

Referenced by Isis::EllipsoidShape::calculateLocalNormal(), Isis::DemShape::calculateLocalNormal(), and Isis::Camera::GetLocalNormal().

double Isis::ShapeModel::phaseAngle	(	const std::vector< double > &	observerBodyFixedPosition,
		const std::vector< double > &	illuminatorBodyFixedPosition
	)

virtualinherited

Computes and returns phase angle, in degrees, given the positions of the observer and illuminator.

Phase Angle: The angle between the vector from the intersection point to the observer (usually the spacecraft) and the vector from the intersection point to the illuminator (usually the sun).

Parameters

observerBodyFixedPosition	Three dimensional position of the observer, in the coordinate system of the target body.
illuminatorBodyFixedPosition	Three dimensional position for the illuminator, in the body-fixed coordinate system.

Returns: double Phase angle, in degrees.

Definition at line 265 of file ShapeModel.cpp.

References Isis::RAD2DEG().

Referenced by Isis::Sensor::PhaseAngle().

double Isis::ShapeModel::resolution ( )

protectedinherited

Convenience method to get pixel resolution (m/pix) at current intersection point.

Returns: The pixel resolution at the surface intersection.

Definition at line 503 of file ShapeModel.cpp.

References _FILEINFO_.

Referenced by Isis::DemShape::intersectSurface().

void Isis::ShapeModel::setHasIntersection ( bool b )

inherited

Sets the flag to indicate whether this ShapeModel has an intersection.

Parameters

b	Indicates whether there is an intersection.

Definition at line 465 of file ShapeModel.cpp.

Referenced by intersectSurface(), Isis::DemShape::intersectSurface(), Isis::PlaneShape::intersectSurface(), Isis::Camera::RawFocalPlanetoImage(), Isis::Sensor::SetGroundLocal(), Isis::Camera::SetImageMapProjection(), and Isis::Sensor::SetLookDirection().

void Isis::ShapeModel::setHasNormal ( bool status )

protectedinherited

Sets the flag to indicate whether this ShapeModel has a surface normal.

Parameters

b	Indicates whether there is a normal.

Definition at line 492 of file ShapeModel.cpp.

Referenced by Isis::EllipsoidShape::calculateLocalNormal(), and Isis::DemShape::calculateLocalNormal().

void Isis::ShapeModel::setName ( QString name )

protectedinherited

Sets the shape name.

Parameters

name	The name of the ShapeModel.

Definition at line 443 of file ShapeModel.cpp.

Referenced by Isis::DemShape::DemShape(), Isis::EllipsoidShape::EllipsoidShape(), EquatorialCylindricalShape(), Isis::NaifDskShape::NaifDskShape(), and Isis::PlaneShape::PlaneShape().

void Isis::ShapeModel::setNormal ( const std::vector< double > normal )

protectedinherited

Sets the normal for the currect intersection point.

Note: This method will throw an error if this ShapeModel doesn't have and intersection. Use the hasIntersection() method to verify before calling this method.

See Also: hasIntersection()

Parameters

normal Three dimensional surface normal vector.

Definition at line 398 of file ShapeModel.cpp.

References _FILEINFO_.

Referenced by Isis::EllipsoidShape::calculateLocalNormal(), Isis::DemShape::calculateLocalNormal(), Isis::NaifDskShape::calculateSurfaceNormal(), Isis::PlaneShape::intersectSurface(), and Isis::NaifDskShape::setLocalNormalFromIntercept().

void Isis::ShapeModel::setNormal	(	const double	a,
		const double	b,
		const double	c
	)

protectedinherited

Sets the normal for the currect intersection point.

Note: This method will throw an error if this ShapeModel doesn't have and intersection. Use the hasIntersection() method to verify before calling this method.

See Also: hasIntersection()

Parameters

a	First coordinate value for the three dimensional surface normal.
b	Second coordinate value for the three dimensional surface normal.
c	Third coordinate value for the three dimensional surface normal.

Definition at line 423 of file ShapeModel.cpp.

References _FILEINFO_.

void Isis::ShapeModel::setSurfacePoint ( const SurfacePoint & surfacePoint )

inherited

Set surface intersection point.

Parameters

surfacePoint Position coordinate for the surface point.

Definition at line 476 of file ShapeModel.cpp.

Referenced by Isis::NaifDskShape::intersectSurface(), Isis::RadarGroundMap::SetGround(), and Isis::Sensor::SetGround().

SurfacePoint * Isis::ShapeModel::surfaceIntersection ( ) const

inherited

Returns the surface intersection for this ShapeModel.

Returns: SurfacePoint Three dimensional position for the surface intersection, in body-fixed coordinate system.

Definition at line 299 of file ShapeModel.cpp.

Referenced by Isis::EllipsoidShape::calculateLocalNormal(), Isis::DemShape::calculateLocalNormal(), Isis::Sensor::Coordinate(), Isis::NaifDskShape::ellipsoidNormal(), Isis::PlaneShape::emissionAngle(), Isis::Sensor::GetLatitude(), Isis::Sensor::GetLongitude(), Isis::Sensor::GetSurfacePoint(), Isis::PlaneShape::incidenceAngle(), intersectSurface(), Isis::DemShape::intersectSurface(), Isis::PlaneShape::intersectSurface(), Isis::PlaneShape::localRadius(), Isis::Sensor::LocalRadius(), Isis::Sensor::SetGroundLocal(), Isis::Sensor::SetUniversalGround(), Isis::Sensor::SlantDistance(), and Isis::Sensor::SolarDistance().

std::vector< Distance > Isis::ShapeModel::targetRadii ( ) const

protectedinherited

Returns the radii of the body in km.

The radii are obtained from the target. Note: This method will throw an error if the ShapeModel does not have a valid target. Use the hasValidTarget() method to verify before calling this method.