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

virtual bool	intersectSurface (const Latitude &lat, const Longitude &lon, const std::vector< double > &observerPos, const bool &backCheck=true)
	Compute surface intersection with optional occlusion check. More...

virtual bool	intersectSurface (const SurfacePoint &surfpt, const std::vector< double > &observerPos, const bool &backCheck=true)
	Compute surface intersection with optional occlusion check. 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...

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

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

virtual bool	isVisibleFrom (const std::vector< double > observerPos, const std::vector< double > lookDirection)
	Default occulsion implementation. 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 ISIS target bodies as well as provide utilities to retrieve radii and photometric information.

Author: 2012-07-30 Ken Edmundson

Constructor & Destructor Documentation

◆ PlaneShape() [1/3]

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

Initialize the PlaneShape.

Parameters

pvl	Valid ISIS cube label.

References Isis::ShapeModel::setName().

◆ PlaneShape() [2/3]

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

Initialize the PlaneShape.

Parameters

pvl	Valid ISIS cube label.

References Isis::ShapeModel::setName().

◆ PlaneShape() [3/3]

Isis::PlaneShape::PlaneShape ( )

Initialize the PlaneShape.

Parameters

pvl	Valid ISIS cube label.

References Isis::ShapeModel::setName().

◆ ~PlaneShape()

Isis::PlaneShape::~PlaneShape ( )

Destructor.

Member Function Documentation

◆ calculateDefaultNormal()

void Isis::PlaneShape::calculateDefaultNormal ( )

virtual

There is no implementation for this method.

Implements Isis::ShapeModel.

◆ calculateEllipsoidalSurfaceNormal()

void Isis::ShapeModel::calculateEllipsoidalSurfaceNormal ( )

protectedinherited

Calculates the ellipsoidal surface normal.

References _FILEINFO_.

◆ calculateLocalNormal()

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

virtual

There is no implementation for this method.

Implements Isis::ShapeModel.

◆ calculateSurfaceNormal()

void Isis::PlaneShape::calculateSurfaceNormal ( )

virtual

There is no implementation for this method.

Implements Isis::ShapeModel.

◆ clearSurfacePoint()

void Isis::ShapeModel::clearSurfacePoint ( )

virtualinherited

Clears or resets the current surface point.

Reimplemented in Isis::EmbreeShapeModel, and Isis::BulletShapeModel.

Referenced by Isis::EmbreeShapeModel::clearSurfacePoint(), Isis::Sensor::SetGround(), Isis::Camera::SetGround(), Isis::CSMCamera::SetGround(), Isis::Camera::SetImage(), Isis::Sensor::setTime(), Isis::Camera::SetUniversalGround(), and Isis::Sensor::SetUniversalGround().

◆ emissionAngle()

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.

References Isis::SurfacePoint::GetX(), Isis::SurfacePoint::GetY(), Isis::SurfacePoint::GetZ(), Isis::Displacement::kilometers(), Isis::RAD2DEG, and Isis::ShapeModel::surfaceIntersection().

◆ hasEllipsoidIntersection()

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.

◆ hasIntersection()

bool Isis::ShapeModel::hasIntersection ( )

inherited

Returns intersection status.

Returns: bool Indicates whether this ShapeModel has an intersection.

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

◆ hasNormal()

bool Isis::ShapeModel::hasNormal ( ) const

inherited

Returns surface point normal status.

Returns: Indicates whether this ShapeModel has a surface normal.

Referenced by Isis::Camera::GetLocalNormal(), and Isis::EmbreeShapeModel::incidenceAngle().

◆ hasValidTarget()

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.

Referenced by Isis::BulletShapeModel::ellipsoidNormal(), Isis::EmbreeShapeModel::ellipsoidNormal(), and Isis::NaifDskShape::ellipsoidNormal().

◆ incidenceAngle()

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.

References Isis::SurfacePoint::GetX(), Isis::SurfacePoint::GetY(), Isis::SurfacePoint::GetZ(), Isis::Displacement::kilometers(), Isis::RAD2DEG, and Isis::ShapeModel::surfaceIntersection().

◆ Initialize()

void Isis::ShapeModel::Initialize ( )

inherited

Initializes the ShapeModel private variables.

◆ intersectEllipsoid()

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.

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

◆ intersectSurface() [1/3]

bool Isis::ShapeModel::intersectSurface	(	const Latitude &	lat,
		const Longitude &	lon,
		const std::vector< double > &	observerPos,
		const bool &	backCheck = `true`
	)

virtualinherited

Compute surface intersection with optional occlusion check.

This method sets the surface point at the given latitude, longitude. The derived model is called to get the radius at that location to complete the accuracy of the surface point, them the derived method is called to complete the intersection.

Author: 2017-03-23 Kris Becker

Parameters

lat	Latitude of the surface point
lon	Longitude of the surface point
observerPos	Position of the observer
backCheck	Flag to indicate occlusion check

Returns: bool True if the intersection point is valid (visable)

Reimplemented in Isis::BulletShapeModel, and Isis::EmbreeShapeModel.

◆ intersectSurface() [2/3]

bool Isis::ShapeModel::intersectSurface	(	const SurfacePoint &	surfpt,
		const std::vector< double > &	observerPos,
		const bool &	backCheck = `true`
	)

virtualinherited

Compute surface intersection with optional occlusion check.

This method sets the surface point at the given latitude, longitude. The derived model is called to get the radius at that location to complete the accuracy of the surface point, them the derived method is called to complete the intersection.

Author: 2017-03-23 Kris Becker

Parameters

surfpt	Absolute point on the surface to check
observerPos	Position of the observer
backCheck	Flag to indicate occlusion check

Returns: bool True if the intersection point is valid (visable)

Reimplemented in Isis::BulletShapeModel, and Isis::EmbreeShapeModel.

◆ intersectSurface() [3/3]

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.

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

◆ isDEM()

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.

◆ isVisibleFrom()

bool Isis::ShapeModel::isVisibleFrom	(	const std::vector< double >	observerPos,
		const std::vector< double >	lookDirection
	)

virtualinherited

Default occulsion implementation.

This method is originally copied from Sensor::SetLocalGround(bool backCheck). This version checks for the emission angle from the observer to be less than or equal to 90 degrees.

It is recommended that models derived from this base class reimplement this method if a more robust, efficent test can be made.

Note this implementation does not handle occlusion!

Author: 2017-03-17 Kris Becker

Parameters

observerPos	Position of the observer in body fixed coordinates
lookDirection	Look direction from the observer

Returns: bool True if the point is not visable, false if it can be seen

Reimplemented in Isis::EmbreeShapeModel, and Isis::BulletShapeModel.

◆ localRadius()

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.

References Isis::SurfacePoint::GetX(), Isis::SurfacePoint::GetY(), Isis::SurfacePoint::GetZ(), Isis::Displacement::kilometers(), Isis::Distance::Kilometers, and Isis::ShapeModel::surfaceIntersection().

◆ name()

QString Isis::ShapeModel::name ( ) const

inherited

Gets the shape name.

Returns: QString The name of the ShapeModel.

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

◆ normal()

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.

References _FILEINFO_.

Referenced by Isis::DemShape::calculateDefaultNormal(), Isis::DemShape::calculateLocalNormal(), Isis::EllipsoidShape::calculateLocalNormal(), Isis::Camera::GetLocalNormal(), Isis::EmbreeShapeModel::incidenceAngle(), and Isis::BulletShapeModel::setLocalNormalFromIntercept().

◆ phaseAngle()

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.

References Isis::RAD2DEG.

Referenced by Isis::CSMCamera::PhaseAngle(), and Isis::Sensor::PhaseAngle().

◆ resolution()

double Isis::ShapeModel::resolution ( )

protectedinherited

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

Returns: @double The pixel resolution at the surface intersection.

References _FILEINFO_.

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

◆ setHasIntersection()

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.

Referenced by Isis::DemShape::intersectSurface(), Isis::EmbreeShapeModel::intersectSurface(), Isis::EquatorialCylindricalShape::intersectSurface(), intersectSurface(), Isis::CSMCamera::SetGround(), and Isis::Sensor::SetLookDirection().

◆ setHasNormal()

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.

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

◆ setName()

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

protectedinherited

Sets the shape name.

Parameters

name	The name of the ShapeModel.

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

◆ setNormal() [1/2]

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.

References _FILEINFO_.

◆ setNormal() [2/2]

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.

References _FILEINFO_.

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

◆ setSurfacePoint()

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

virtualinherited

Set surface intersection point.

Parameters

surfacePoint Position coordinate for the surface point.

Reimplemented in Isis::BulletShapeModel.

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

◆ surfaceIntersection()

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.

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

◆ targetRadii()

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.

References _FILEINFO_.

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

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

/home/isis3mgr/repos/ISIS3/isis/src/base/objs/PlaneShape/PlaneShape.h
/home/isis3mgr/repos/ISIS3/isis/src/base/objs/PlaneShape/PlaneShape.cpp

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ PlaneShape() [1/3]

◆ PlaneShape() [2/3]

◆ PlaneShape() [3/3]

◆ ~PlaneShape()

Member Function Documentation

◆ calculateDefaultNormal()

◆ calculateEllipsoidalSurfaceNormal()

◆ calculateLocalNormal()

◆ calculateSurfaceNormal()

◆ clearSurfacePoint()

◆ emissionAngle()

◆ hasEllipsoidIntersection()

◆ hasIntersection()

◆ hasNormal()

◆ hasValidTarget()

◆ incidenceAngle()

◆ Initialize()

◆ intersectEllipsoid()

◆ intersectSurface() [1/3]

◆ intersectSurface() [2/3]

◆ intersectSurface() [3/3]

◆ isDEM()

◆ isVisibleFrom()

◆ localRadius()

◆ name()

◆ normal()

◆ phaseAngle()

◆ resolution()

◆ setHasIntersection()

◆ setHasNormal()

◆ setName()

◆ setNormal() [1/2]

◆ setNormal() [2/2]

◆ setSurfacePoint()

◆ surfaceIntersection()

◆ targetRadii()