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

#include <EllipsoidShape.h>

Inheritance diagram for Isis::EllipsoidShape:

Collaboration diagram for Isis::EllipsoidShape:

Public Member Functions
	EllipsoidShape (Target *target, Isis::Pvl &pvl)
	Constructors.

	EllipsoidShape (Target *target)
	Initialize the EllipsoidShape.

	EllipsoidShape ()
	Initialize the EllipsoidShape.

	~EllipsoidShape ()
	Destructor.

bool	intersectSurface (std::vector< double > observerPos, std::vector< double > lookDirection)
	Intersect the shape model.

virtual void	calculateDefaultNormal ()
	Calculate the default normal of the current intersection point.

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

void	calculateSurfaceNormal ()
	Calculate the surface normal of the current intersection point.

Distance	localRadius (const Latitude &lat, const Longitude &lon)
	Get the local radius for a point on the surface.

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

Detailed Description

Define shapes and provide utilities for Isis3 targets.

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

Author: 2010-08-02 Debbie A. Cook

History:: 2012-12-21 - Debbie A. Cook - Cleaned up intersectSurface method to reflect changes made to ShapeModel class. References #1343.

Definition at line 47 of file EllipsoidShape.h.

Constructor & Destructor Documentation

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

Constructors.

Initialize the EllipsoidShape.

Parameters

pvl	Valid Isis3 cube label.

Definition at line 26 of file EllipsoidShape.cpp.

References Isis::ShapeModel::setName().

Isis::EllipsoidShape::EllipsoidShape ( Target * target )

Initialize the EllipsoidShape.

Parameters

pvl	Valid Isis3 cube label.

Definition at line 37 of file EllipsoidShape.cpp.

References Isis::ShapeModel::setName().

Isis::EllipsoidShape::EllipsoidShape ( )

Initialize the EllipsoidShape.

Parameters

pvl	Valid Isis3 cube label.

Definition at line 48 of file EllipsoidShape.cpp.

References Isis::ShapeModel::setName().

Isis::EllipsoidShape::~EllipsoidShape ( )

inline

Destructor.

Definition at line 55 of file EllipsoidShape.h.

Member Function Documentation

void Isis::EllipsoidShape::calculateDefaultNormal ( )

virtual

Calculate the default normal of the current intersection point.

Calculate default normal.

Implements Isis::ShapeModel.

Definition at line 66 of file EllipsoidShape.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 calculateDefaultNormal(), Isis::DemShape::calculateDefaultNormal(), calculateSurfaceNormal(), and Isis::DemShape::calculateSurfaceNormal().

void Isis::EllipsoidShape::calculateLocalNormal ( QVector< double * > cornerNeighborPoints )

virtual

Calculate the local surface normal of the current intersection point.

Calculate local normal.

Implements Isis::ShapeModel.

Definition at line 82 of file EllipsoidShape.cpp.

References _FILEINFO_, Isis::ShapeModel::hasIntersection(), Isis::Displacement::kilometers(), Isis::ShapeModel::normal(), Isis::IException::Programmer, Isis::ShapeModel::setHasNormal(), Isis::ShapeModel::setNormal(), Isis::ShapeModel::surfaceIntersection(), and Isis::ShapeModel::targetRadii().

void Isis::EllipsoidShape::calculateSurfaceNormal ( )

virtual

Calculate the surface normal of the current intersection point.

Calculate surface normal.

Implements Isis::ShapeModel.

Definition at line 74 of file EllipsoidShape.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().

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

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
	)