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

#include <ShapeModel.h>

Inherited by Isis::DemShape, Isis::EllipsoidShape, Isis::NaifDskShape, and Isis::PlaneShape.

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. More...

	ShapeModel (Target *target)
	Constructs and loads a shape model from a target only. More...

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

virtual	~ShapeModel ()=0
	Virtual destructor to destroy the ShapeModel object. More...

virtual bool	intersectSurface (std::vector< double > observerPos, std::vector< double > lookDirection)=0

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...

virtual void	calculateDefaultNormal ()=0

virtual void	calculateLocalNormal (QVector< double * > neighborPoints)=0

virtual void	calculateSurfaceNormal ()=0

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...

virtual Distance	localRadius (const Latitude &lat, const Longitude &lon)=0

virtual bool	isDEM () const =0
	Indicates whether this shape model is from a DEM. 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
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...

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

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.

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.

Isis::ShapeModel::~ShapeModel ( )

pure virtual

Virtual destructor to destroy the ShapeModel object.

Member Function Documentation

virtual void Isis::ShapeModel::calculateDefaultNormal ( )

pure virtual

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

void Isis::ShapeModel::calculateEllipsoidalSurfaceNormal ( )

protected

Calculates the ellipsoidal surface normal.

References _FILEINFO_.

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

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

pure virtual

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

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

virtual void Isis::ShapeModel::calculateSurfaceNormal ( )

pure virtual

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

void Isis::ShapeModel::clearSurfacePoint ( )

Clears or resets the current surface point.

Referenced by Isis::Sensor::SetGround(), Isis::Camera::SetGround(), 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.

References Isis::RAD2DEG().

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

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.

bool Isis::ShapeModel::hasIntersection ( )

Returns intersection status.

Returns: bool Indicates whether this ShapeModel has an intersection.

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.

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.

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.

References Isis::RAD2DEG().

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

void Isis::ShapeModel::Initialize ( )

Initializes the ShapeModel private variables.

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.

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

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

pure virtual

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

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

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().

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

pure virtual

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

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

QString Isis::ShapeModel::name ( ) const

Gets the shape name.

Returns: QString The name of the ShapeModel.

Referenced by Isis::UniversalGroundMap::GroundRange(), Isis::VimsGroundMap::SetGround(), and Isis::Camera::SetGround().

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.

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.

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.

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.

Referenced by Isis::EquatorialCylindricalShape::intersectSurface(), Isis::DemShape::intersectSurface(), Isis::PlaneShape::intersectSurface(), 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.

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.

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.

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.

References _FILEINFO_.

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

Set surface intersection point.

Parameters

surfacePoint Position coordinate for the surface point.

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.

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::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.

References _FILEINFO_.

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

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

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation