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

	PlaneShape (Target *target)
	Initialize the PlaneShape. More...

	PlaneShape ()
	Initialize the PlaneShape. More...

	~PlaneShape ()
	Destructor. More...

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

bool	isDEM () const
	Indicates that this shape model is not from a DEM. More...

void	calculateSurfaceNormal ()
	There is no implementation for this method. More...

void	calculateDefaultNormal ()
	There is no implementation for this method. More...

void	calculateLocalNormal (QVector< double * > cornerNeighborPoints)
	There is no implementation for this method. More...

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

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

Distance	localRadius (const Latitude &lat, const Longitude &lon)
	Gets the local radius for the given latitude/longitude coordinate. More...

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

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

void	clearSurfacePoint ()
	Clears or resets the current surface point. 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...

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

History:

2015-04-30 Jeannie Backer - Added isDEM() method. References #2243. Moved method implementation to cpp file.

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

2016-06-13 Kelvin Rodriguez - Removed redundant contructor PlaneShape(Target, Pvl). References #2214

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

Isis::PlaneShape::~PlaneShape ( )

Destructor.

Definition at line 59 of file PlaneShape.cpp.

Member Function Documentation

void Isis::PlaneShape::calculateDefaultNormal ( )

virtual

There is no implementation for this method.

Implements Isis::ShapeModel.

Definition at line 146 of file PlaneShape.cpp.

void Isis::ShapeModel::calculateEllipsoidalSurfaceNormal ( )

protectedinherited

Calculates the 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::PlaneShape::calculateLocalNormal ( QVector< double * > cornerNeighborPoints )

virtual

There is no implementation for this method.

Implements Isis::ShapeModel.

Definition at line 153 of file PlaneShape.cpp.

void Isis::PlaneShape::calculateSurfaceNormal ( )

virtual

There is no implementation for this method.

Implements Isis::ShapeModel.

Definition at line 139 of file PlaneShape.cpp.

void Isis::ShapeModel::clearSurfacePoint ( )

inherited

Clears or resets the current surface point.

Definition at line 327 of file ShapeModel.cpp.

Referenced by Isis::Camera::RawFocalPlanetoImage(), Isis::Sensor::SetGround(), Isis::Camera::SetGround(), Isis::Sensor::SetGroundLocal(), Isis::Camera::SetImage(), Isis::Camera::SetImageMapProjection(), Isis::Camera::SetImageSkyMapProjection(), 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 172 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.

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

Definition at line 154 of file ShapeModel.cpp.

bool Isis::ShapeModel::hasIntersection ( )

inherited

Returns intersection status.

Returns: bool Indicates whether this ShapeModel has an intersection.

Definition at line 309 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

Returns surface point normal status.

Returns: Indicates whether this ShapeModel has a surface normal.

Definition at line 319 of file ShapeModel.cpp.

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

bool Isis::ShapeModel::hasValidTarget ( ) const

protectedinherited

Returns the status of the target.

If it is NULL, this method returns false.

Returns: Indicates whether the target is valid.

Definition at line 360 of file ShapeModel.cpp.

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

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 229 of file PlaneShape.cpp.

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

void Isis::ShapeModel::Initialize ( )

inherited

Initializes the ShapeModel private variables.

Definition at line 57 of file ShapeModel.cpp.

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

protectedinherited

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 208 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 71 of file PlaneShape.cpp.

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

bool Isis::PlaneShape::isDEM ( ) const

virtual

Indicates that this shape model is not from a DEM.

Since this method returns false for this class, the Camera class will not calculate the local normal using neighbor points.

Returns: bool Indicates that this is not a DEM shape model.

Implements Isis::ShapeModel.

Definition at line 131 of file PlaneShape.cpp.

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

virtual

Gets the local radius for the given latitude/longitude coordinate.

For the plane shape model, this is calculated by finding the distance of the surface intersection point from the plane's origin.

Returns: Distance The distance from the center of the body to its surface at the given lat/lon location.

Implements Isis::ShapeModel.

Definition at line 279 of file PlaneShape.cpp.

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

QString Isis::ShapeModel::name ( ) const

inherited

Gets the shape name.

Returns: QString The name of the ShapeModel.

Definition at line 454 of file ShapeModel.cpp.

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

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

inherited

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

virtualinherited

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

References Isis::RAD2DEG().

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

double Isis::ShapeModel::resolution ( )

protectedinherited

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

Returns: The pixel resolution at the surface intersection.

Definition at line 503 of file ShapeModel.cpp.

References _FILEINFO_.

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

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

inherited

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

Parameters

b	Indicates whether there is an intersection.

Definition at line 465 of file ShapeModel.cpp.

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

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

protectedinherited

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

Parameters

b	Indicates whether there is a normal.

Definition at line 492 of file ShapeModel.cpp.

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

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

protectedinherited

Sets the shape name.

Parameters

name	The name of the ShapeModel.

Definition at line 443 of file ShapeModel.cpp.

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

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

protectedinherited

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

References _FILEINFO_.

Referenced by Isis::EllipsoidShape::calculateLocalNormal(), Isis::DemShape::calculateLocalNormal(), Isis::NaifDskShape::calculateSurfaceNormal(), intersectSurface(), and Isis::NaifDskShape::setLocalNormalFromIntercept().

void Isis::ShapeModel::setNormal	(	const double	a,
		const double	b,
		const double	c
	)

protectedinherited

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

References _FILEINFO_.

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

inherited

Set surface intersection point.

Parameters

surfacePoint Position coordinate for the surface point.

Definition at line 476 of file ShapeModel.cpp.

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

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

inherited

Returns the surface intersection for this ShapeModel.

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

Definition at line 299 of file ShapeModel.cpp.

Referenced by Isis::EllipsoidShape::calculateLocalNormal(), Isis::DemShape::calculateLocalNormal(), Isis::Sensor::Coordinate(), Isis::NaifDskShape::ellipsoidNormal(), emissionAngle(), Isis::Sensor::GetLatitude(), Isis::Sensor::GetLongitude(), Isis::Sensor::GetSurfacePoint(), incidenceAngle(), Isis::EquatorialCylindricalShape::intersectSurface(), Isis::DemShape::intersectSurface(), intersectSurface(), localRadius(), Isis::Sensor::LocalRadius(), Isis::Sensor::SetGroundLocal(), Isis::Sensor::SetUniversalGround(), Isis::Sensor::SlantDistance(), and Isis::Sensor::SolarDistance().

std::vector< Distance > Isis::ShapeModel::targetRadii ( ) const

protectedinherited

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

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/PlaneShape/PlaneShape.h
src/base/objs/PlaneShape/PlaneShape.cpp

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation