Define shapes and provide utilities for Isis3 targets. More...

#include <ShapeModel.h>

Inheritance diagram for Isis::ShapeModel:

Collaboration diagram for Isis::ShapeModel:

Public Member Functions
	ShapeModel ()
	Default constructor creates ShapeModel object, initializing name to an empty string, surface point to an empty surface point, has intersection to FALSE, has normal to FALSE, has ellipsoid intersection to FALSE, normal vector size to 3, and target to NULL.
	ShapeModel (Target *target, Isis::Pvl &pvl)
	Constructs and loads a shape model from a pvl.
	ShapeModel (Target *target)
	Constructs and loads a shape model from a target only.
void	Initialize ()
	Initializes the ShapeModel private variables.
virtual	~ShapeModel ()=0
	Virtual destructor to destroy the ShapeModel object.
virtual bool	intersectSurface (std::vector< double > observerPos, std::vector< double > lookDirection)=0
SurfacePoint *	surfaceIntersection () const
	Returns the surface intersection for this ShapeModel.
bool	hasIntersection ()
	Returns intersection status.
bool	hasNormal () const
	Returns surface point normal status.
virtual void	calculateDefaultNormal ()=0
virtual void	calculateLocalNormal (QVector< double * > neighborPoints)=0
virtual void	calculateSurfaceNormal ()=0
void	clearSurfacePoint ()
	Clears or resets 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)
	Computes and returns incidence angle, in degrees, given the illuminator position.
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.
virtual Distance	localRadius (const Latitude &lat, const Longitude &lon)=0
virtual bool	isDEM () const =0
	Indicates whether this shape model is from a DEM.
QString	name () const
	Gets the shape name.
void	setHasIntersection (bool b)
	Sets the flag to indicate whether this ShapeModel has an intersection.
void	setSurfacePoint (const SurfacePoint &surfacePoint)
	Set surface intersection point.
std::vector< double >	normal ()
	Returns the local surface normal at the current intersection point.

Protected Member Functions
void	setNormal (const std::vector< double >)
	Sets the normal for the currect intersection point.
void	setNormal (const double a, const double b, const double c)
	Sets the normal for the currect intersection point.
void	setName (QString name)
	Sets the shape name.
void	calculateEllipsoidalSurfaceNormal ()
	Calculates the 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)
	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).
bool	hasValidTarget () const
	Returns the status of the target.
std::vector< Distance >	targetRadii () const
	Returns the radii of the body in km.
void	setHasNormal (bool status)
	Sets the flag to indicate whether this ShapeModel has a surface normal.
double	resolution ()
	Convenience method to get pixel resolution (m/pix) at current intersection point.

Private Attributes
bool	m_hasEllipsoidIntersection
	Indicates the ellipsoid was successfully intersected.
bool	m_hasIntersection
	indicates good intersection exists
bool	m_hasNormal
	indicates normal has been computed
std::vector< double >	m_normal
	Local normal of current intersection point.
QString *	m_name
SurfacePoint *	m_surfacePoint
	< Name of the shape
Target *	m_target

Detailed Description

Define shapes and provide utilities for Isis3 targets.

This base class will define shapes of Isis3 target bodies as well as provide utilities to retrieve radii and photometric information.

Author: 2010-07-30 Debbie A. Cook

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

History:: 2012-10-25 Jeannie Backer - Changed resolution() method and call to Spice::resolution() method to lower camel case. Added resolution() method test to improve unitTest code coverage. References #1181.

History:: 2012-10-31 Ken Edmundson - Added another SetNormal method and fixed original to set the m_hasNormal to true.

History:: 2012-11-14 Jeannie Backer - Removed cout lines left in while testing code. References #1181.

History:: 2012-12-21 Debbie A. Cook - Added new members m_hasEllipsoidIntersection and method hasEllipsoidIntersection(). Fixes Mantis ticket #1343

History:: 2015-04-30 Jeannie Backer - Added pure virtual isDEM() method. References #2243.

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

History:: 2015-10-01 Jeannie Backer - Made improvements to documentation and brought code closer to ISIS coding standards. References #1438

Definition at line 66 of file ShapeModel.h.

Constructor & Destructor Documentation

Isis::ShapeModel::ShapeModel ( )

Default constructor creates ShapeModel object, initializing name to an empty string, surface point to an empty surface point, has intersection to FALSE, has normal to FALSE, has ellipsoid intersection to FALSE, normal vector size to 3, and target to NULL.

Definition at line 32 of file ShapeModel.cpp.

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

Constructs and loads a shape model from a pvl.

This constructor creates ShapeModel object, initializing name to an empty string, surface point to an empty surface point, has intersection to FALSE, has normal to FALSE, has ellipsoid intersection to FALSE, normal vector size to 3, and target to the given target.

Parameters

pvl	A valid ISIS cube label.

Definition at line 48 of file ShapeModel.cpp.

Isis::ShapeModel::ShapeModel ( Target * target )

Constructs and loads a shape model from a target only.

This constructor creates ShapeModel object, initializing name to an empty string, surface point to an empty surface point, has intersection to FALSE, has normal to FALSE, has ellipsoid intersection to FALSE, normal vector size to 3, and target to the given target.

Parameters

target A pointer to a valid ISIS target.

Definition at line 64 of file ShapeModel.cpp.

Isis::ShapeModel::~ShapeModel ( )

pure virtual

Virtual destructor to destroy the ShapeModel object.

Definition at line 84 of file ShapeModel.cpp.

Member Function Documentation

void Isis::ShapeModel::calculateEllipsoidalSurfaceNormal ( )

protected

Calculates the ellipsoidal surface normal.

Definition at line 97 of file ShapeModel.cpp.

References _FILEINFO_.

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

void Isis::ShapeModel::clearSurfacePoint ( )

Clears or resets the current surface point.

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

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

virtual

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 142 of file ShapeModel.cpp.

References Isis::RAD2DEG().

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

bool Isis::ShapeModel::hasEllipsoidIntersection ( )

protected

Returns the status of the ellipsoid model intersection.

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

Definition at line 170 of file ShapeModel.cpp.

bool Isis::ShapeModel::hasIntersection ( )

Returns intersection status.

Returns: bool Indicates whether this ShapeModel has an intersection.

Definition at line 325 of file ShapeModel.cpp.

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

bool Isis::ShapeModel::hasNormal ( ) const

Returns surface point normal status.

Returns: Indicates whether this ShapeModel has a surface normal.

Definition at line 335 of file ShapeModel.cpp.

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

bool Isis::ShapeModel::hasValidTarget ( ) const

protected

Returns the status of the target.

If it is NULL, this method returns false.

Returns: Indicates whether the target is valid.

Definition at line 376 of file ShapeModel.cpp.

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

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

virtual

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 189 of file ShapeModel.cpp.

References Isis::RAD2DEG().

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

void Isis::ShapeModel::Initialize ( )

Initializes the ShapeModel private variables.

Definition at line 73 of file ShapeModel.cpp.

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

protected

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 224 of file ShapeModel.cpp.

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

virtual bool Isis::ShapeModel::isDEM ( ) const

pure virtual

Indicates whether this shape model is from a DEM.

This method is used to determine whether the Camera class will calculate the local normal using neighbor points. This method is pure virtual and must be implemented by all ShapeModel classes. The parent implementation returns false.

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

Implemented in Isis::DemShape, Isis::NaifDskShape, Isis::PlaneShape, and Isis::EllipsoidShape.

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

QString Isis::ShapeModel::name ( ) const

Gets the shape name.

Returns: QString The name of the ShapeModel.

Definition at line 470 of file ShapeModel.cpp.

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

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

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 358 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
	)

virtual

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 281 of file ShapeModel.cpp.

References Isis::RAD2DEG().

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

double Isis::ShapeModel::resolution ( )

protected

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

Returns: The pixel resolution at the surface intersection.

Definition at line 519 of file ShapeModel.cpp.

References _FILEINFO_.

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

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

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

Parameters

b	Indicates whether there is an intersection.

Definition at line 481 of file ShapeModel.cpp.

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

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

protected

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

Parameters

b	Indicates whether there is a normal.

Definition at line 508 of file ShapeModel.cpp.

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

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

protected

Sets the shape name.

Parameters

name	The name of the ShapeModel.

Definition at line 459 of file ShapeModel.cpp.

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

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

protected

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 414 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
	)

protected

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 439 of file ShapeModel.cpp.

References _FILEINFO_.

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

Set surface intersection point.

Parameters

surfacePoint Position coordinate for the surface point.

Definition at line 492 of file ShapeModel.cpp.

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

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

Returns the surface intersection for this ShapeModel.

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

Definition at line 315 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(), Isis::EquatorialCylindricalShape::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

protected

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.

See Also: hasValidTarget()

Returns: Three dimensional vector containing the ellipsoid radii values.

Definition at line 392 of file ShapeModel.cpp.

References _FILEINFO_.

Referenced by Isis::EllipsoidShape::calculateLocalNormal(), Isis::NaifDskShape::ellipsoidNormal(), Isis::EquatorialCylindricalShape::intersectSurface(), and Isis::EllipsoidShape::localRadius().

Member Data Documentation

bool Isis::ShapeModel::m_hasEllipsoidIntersection

private

Indicates the ellipsoid was successfully intersected.

Definition at line 160 of file ShapeModel.h.

bool Isis::ShapeModel::m_hasIntersection

private

indicates good intersection exists

Definition at line 161 of file ShapeModel.h.

bool Isis::ShapeModel::m_hasNormal

private

indicates normal has been computed

Definition at line 162 of file ShapeModel.h.

std::vector<double> Isis::ShapeModel::m_normal

private

Local normal of current intersection point.

Definition at line 163 of file ShapeModel.h.

SurfacePoint* Isis::ShapeModel::m_surfacePoint

private

< Name of the shape

Current intersection point

Definition at line 165 of file ShapeModel.h.

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

src/base/objs/ShapeModel/ShapeModel.h
src/base/objs/ShapeModel/ShapeModel.cpp

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation