Define shapes and provide utilities for targets stored as Isis3 maps. More...

#include <DemShape.h>

Inheritance diagram for Isis::DemShape:

Collaboration diagram for Isis::DemShape:

Public Member Functions
	DemShape (Target *target, Pvl &pvl)
	Construct a DemShape object.

	DemShape ()
	Construct a DemShape object.

	~DemShape ()
	Destroys the DemShape.

bool	intersectSurface (std::vector< double > observerPos, std::vector< double > lookDirection)
	Find the intersection point with the DEM.

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

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

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

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

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

void	Initialize ()
	Initialize the ShapeModel private variables.

SurfacePoint *	surfaceIntersection () const
	Return the surface intersection.

bool	hasIntersection ()
	Return intersection status.

bool	hasNormal () const
	Return surface point normal status.

void	clearSurfacePoint ()
	Clear or reset the current surface point.

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

virtual double	incidenceAngle (const std::vector< double > &uB)
	Returns the incidence angle in degrees.

virtual double	phaseAngle (const std::vector< double > &sB, const std::vector< double > &uB)
	Returns the phase angle in degrees.

QString	name () const
	Get the shape name.

void	setHasIntersection (bool b)
	Set m_hasIntersection;.

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

std::vector< double >	normal ()
	Return the local normal of the current intersection point.

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

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

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

void	setName (QString name)
	Set the shape name.

void	calculateEllipsoidalSurfaceNormal ()
	Calculate ellipsoidal surface normal.

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

bool	intersectEllipsoid (const std::vector< double > observerPosRelativeToTarget, const std::vector< double > &observerLookVectorToTarget)
	Find the intersection point on the ellipsoid model.

bool	hasValidTarget () const

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

void	setHasNormal (bool status)
	Set the hasNormal flag.

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

Private Attributes
Cube *	m_demCube
	The cube containing the model.

Projection *	m_demProj
	The projection of the model.

double	m_pixPerDegree
	Scale of DEM file in pixels per degree.

Portal *	m_portal
	Buffer used to read from the model.

Interpolator *	m_interp
	Use bilinear interpolation from dem.

Detailed Description

Define shapes and provide utilities for targets stored as Isis3 maps.

This class will define shapes of Isis3 target bodies with the shape defined by an Isis 3 map fille (level 2 image), as well as provide utilities to retrieve radii and photometric information for the intersection point.

Author: 2010-07-30 Debbie A. Cook

History:

2010-07-30 - Debbie A. Cook - Original version.

2012-10-25 - Jeannie Backer - Changed call to Spice::resolution() method to lower camel case. Added documentation. Ordered includes. References #1181.

Definition at line 51 of file DemShape.h.

Constructor & Destructor Documentation

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

Construct a DemShape object.

This method creates a ShapeModel object named "DemShape" and initializes member variables from the projection shape model using the given Target and Pvl.

Parameters

pvl	Valid Isis3 cube label.

Definition at line 43 of file DemShape.cpp.

References Isis::Cube::addCachingAlgorithm(), Isis::PvlObject::findGroup(), Isis::PvlContainer::hasKeyword(), Isis::Interpolator::HotLine(), Isis::Interpolator::HotSample(), Isis::Cube::label(), Isis::Interpolator::Lines(), m_demCube, m_demProj, m_interp, m_pixPerDegree, m_portal, Isis::CubeManager::Open(), Isis::Cube::pixelType(), Isis::Cube::projection(), Isis::Interpolator::Samples(), Isis::ShapeModel::setName(), and Isis::PvlObject::Traverse.

Isis::DemShape::DemShape ( )

Construct a DemShape object.

This method creates a ShapeModel object named "DemShape". The member variables are set to Null.

Definition at line 88 of file DemShape.cpp.

References m_demCube, m_demProj, m_interp, m_portal, and Isis::ShapeModel::setName().

Isis::DemShape::~DemShape ( )

Destroys the DemShape.

Definition at line 98 of file DemShape.cpp.

References m_demCube, m_demProj, m_interp, and m_portal.

Member Function Documentation

void Isis::DemShape::calculateDefaultNormal ( )

virtual

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

Implements Isis::ShapeModel.

Definition at line 274 of file DemShape.cpp.

References Isis::ShapeModel::calculateEllipsoidalSurfaceNormal().

void Isis::ShapeModel::calculateEllipsoidalSurfaceNormal ( )

protectedinherited

Calculate ellipsoidal surface normal.

Definition at line 81 of file ShapeModel.cpp.

References _FILEINFO_.

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

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

virtual

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

Parameters

neighborPoints

Implements Isis::ShapeModel.

Definition at line 295 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 ( )

virtual

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

Implements Isis::ShapeModel.

Definition at line 341 of file DemShape.cpp.

References Isis::ShapeModel::calculateEllipsoidalSurfaceNormal().

void Isis::ShapeModel::clearSurfacePoint ( )

inherited

Clear or reset the current surface point.

Definition at line 286 of file ShapeModel.cpp.

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

Cube * Isis::DemShape::demCube ( )

protected

Returns the cube defining the shape model.

Returns the DEM Cube object.

Returns: The DEM cube associated with this shape model.

Definition at line 284 of file DemShape.cpp.

References m_demCube.

Referenced by Isis::EquatorialCylindricalShape::EquatorialCylindricalShape().

double Isis::DemShape::demScale ( )

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

Returns: The scale of the DEM

Definition at line 265 of file DemShape.cpp.

References m_pixPerDegree.

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

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

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 a vector from the intersection point to the spacecraft. The emission angle varies from 0 degrees when the spacecraft 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

sB,:	Spacecraft position in body-fixed coordinates

Returns: Emmision angle in decimal degrees

Reimplemented in Isis::PlaneShape.

Definition at line 123 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.

Definition at line 150 of file ShapeModel.cpp.

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

bool Isis::ShapeModel::hasIntersection ( )

inherited

Return intersection status.

Definition at line 270 of file ShapeModel.cpp.

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

bool Isis::ShapeModel::hasNormal ( ) const

inherited

Return surface point normal status.

Definition at line 278 of file ShapeModel.cpp.

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

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

virtualinherited

Returns the incidence angle in degrees.

This does not use the surface model.

Returns: double Incidence angle, in degrees.

Reimplemented in Isis::PlaneShape.

Definition at line 160 of file ShapeModel.cpp.

References Isis::RAD2DEG().

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

void Isis::ShapeModel::Initialize ( )

inherited

Initialize the ShapeModel private variables.

Definition at line 58 of file ShapeModel.cpp.

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

protectedinherited

Find the intersection point on the ellipsoid model.

Definition at line 186 of file ShapeModel.cpp.

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

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

virtual

Find the intersection point with the DEM.

TIDBIT: From the code below we have historically tested to see if we can first intersect the ellipsoid. If not then we assumed that we could not intersect the DEM. This of course isn't always true as the DEM could be above the surface of the ellipsoid. For most images we really wouldn't notice. It has recently (Aug 2011) come into play trying to intersect images containing a limb and spiceinit'ed with a DEM (e.g., Vesta and soon Mercury). This implies that info at the limb will not always be computed. In the future we may want to do a better job handling this special case.

Parameters