Define plane shape model. More...

#include <PlaneShape.h>

Inheritance diagram for Isis::PlaneShape:

Collaboration diagram for Isis::PlaneShape:

Public Member Functions
	PlaneShape (Target *target, Isis::Pvl &pvl)
	Initialize the PlaneShape.

	PlaneShape (Target *target)
	Initialize the PlaneShape.

	PlaneShape ()
	Initialize the PlaneShape.

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

void	calculateSurfaceNormal ()

void	calculateDefaultNormal ()

void	calculateLocalNormal (QVector< double * > cornerNeighborPoints)

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

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

Distance	localRadius (const Latitude &lat, const Longitude &lon)
	get local radius

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	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 plane shape model.

This class defines a plane shape model for Isis3 target bodies as well as provide utilities to retrieve radii and photometric information.

Author: 2012-07-30 Ken Edmundson

Definition at line 52 of file PlaneShape.h.

Constructor & Destructor Documentation

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

Initialize the PlaneShape.

Parameters

pvl	Valid Isis3 cube label.

Definition at line 25 of file PlaneShape.cpp.

References Isis::ShapeModel::setName().

Isis::PlaneShape::PlaneShape ( Target * target )

Initialize the PlaneShape.

Parameters

pvl	Valid Isis3 cube label.

Definition at line 38 of file PlaneShape.cpp.

References Isis::ShapeModel::setName().

Isis::PlaneShape::PlaneShape ( )

Initialize the PlaneShape.

Parameters

pvl	Valid Isis3 cube label.

Definition at line 51 of file PlaneShape.cpp.

References Isis::ShapeModel::setName().

Member Function Documentation

void Isis::ShapeModel::calculateEllipsoidalSurfaceNormal ( )

protectedinherited

Calculate 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::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::PlaneShape::emissionAngle ( const std::vector< double > & sB )

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 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 from Isis::ShapeModel.

Definition at line 130 of file PlaneShape.cpp.

References Isis::Displacement::kilometers(), Isis::RAD2DEG(), and Isis::ShapeModel::surfaceIntersection().

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(), 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::PlaneShape::incidenceAngle ( const std::vector< double > & uB )

virtual

Computes and returns incidence angle in degrees given the sun position.

Incidence Angle: The incidence angle provides a measure of the lighting condition at the surface intersection point. The angle between the surface normal vector at the intersection point and a vector from the intersection point to the sun. The incidence angle varies from 0 degrees when the intersection point coincides with the sub-solar point to 90 degrees when the intersection point is at the terminator (i.e., in the shadowed or dark portion of the target body). Thus, higher values of incidence angles indicate the existence of a greater number of surface shadows.

Parameters

uB,:	Sun position in body-fixed coordinates

Returns: Incidence angle in decimal degrees

Reimplemented from Isis::ShapeModel.

Definition at line 187 of file PlaneShape.cpp.

References Isis::Displacement::kilometers(), Isis::RAD2DEG(), and Isis::ShapeModel::surfaceIntersection().

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 Isis::DemShape::intersectSurface().

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

virtual

Find the intersection point.

Parameters

observerPos,:	observer (likely a spacecraft) position in Body-Fixed coordinates.
lookDirection,:	observer (likely a spacecraft) look vector in Body- Fixed coordinates.

Implements Isis::ShapeModel.

Definition at line 64 of file PlaneShape.cpp.

References Isis::SurfacePoint::FromNaifArray(), Isis::ShapeModel::setHasIntersection(), Isis::ShapeModel::setNormal(), and Isis::ShapeModel::surfaceIntersection().