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

#include <ShapeModel.h>

Inheritance diagram for Isis::ShapeModel:

Collaboration diagram for Isis::ShapeModel:

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.

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

void	Initialize ()
	Initializes the ShapeModel private variables.

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

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

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.

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

virtual SurfacePoint *	surfaceIntersection () const
	Returns the surface intersection for this ShapeModel.

bool	hasIntersection ()
	Returns intersection status.

bool	hasNormal () const
	Returns surface point normal status.

bool	hasLocalNormal () const
	Returns surface point local normal status.

virtual void	calculateDefaultNormal ()=0

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

virtual void	calculateSurfaceNormal ()=0

virtual void	clearSurfacePoint ()
	Clears or resets 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)
	Computes and returns incidence angle, in degrees, given the illuminator position.

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.

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

virtual bool	isDEM () const =0
	Indicates whether this shape model is from a DEM.

QString	name () const
	Gets the shape name.

void	setHasIntersection (bool b)
	Sets the flag to indicate whether this ShapeModel has an intersection.

virtual void	setSurfacePoint (const SurfacePoint &surfacePoint)
	Set surface intersection point.

virtual std::vector< double >	normal ()
	Returns the surface normal at the current intersection point.

virtual std::vector< double >	localNormal ()
	Returns the local surface normal at the current intersection point.

virtual bool	isVisibleFrom (const std::vector< double > observerPos, const std::vector< double > lookDirection)
	Default occulsion implementation.

Protected Member Functions
void	setNormal (const std::vector< double >)
	Sets the surface normal for the currect intersection point.

void	setNormal (const double a, const double b, const double c)
	Sets the surface normal for the currect intersection point.

void	setLocalNormal (const std::vector< double >)
	Sets the local normal for the currect intersection point.

void	setLocalNormal (const double a, const double b, const double c)
	Sets the local normal for the currect intersection point.

void	setName (QString name)
	Sets the shape name.

void	calculateEllipsoidalSurfaceNormal ()
	Calculates the 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)
	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).

bool	hasValidTarget () const
	Returns the status of the target.

std::vector< Distance >	targetRadii () const
	Returns the radii of the body in km.

void	setHasNormal (bool status)
	Sets the flag to indicate whether this ShapeModel has a surface normal.

void	setHasLocalNormal (bool status)
	Sets the flag to indicate whether this ShapeModel has a local normal.

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

Private Attributes
bool	m_hasEllipsoidIntersection
	Indicates the ellipsoid was successfully intersected.

bool	m_hasIntersection
	indicates good intersection exists

bool	m_hasNormal
	indicates normal has been computed

bool	m_hasLocalNormal
	indicates local normal has been computed

std::vector< double >	m_normal
	Surface normal of current intersection point.

std::vector< double >	m_localNormal
	Local normal of current intersection point.

QString *	m_name

SurfacePoint *	m_surfacePoint
	< Name of the shape

Target *	m_target

Detailed Description

Define shapes and provide utilities for Isis targets.

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

Author: 2010-07-30 Debbie A. Cook

History

2010-07-30 Debbie A. Cook - Original version.

2012-10-25 Jeannie Backer - Changed resolution() method and call to Spice::resolution() method to lower camel case. Added resolution() method test to improve unitTest code coverage. References #1181.

2012-10-31 Ken Edmundson - Added another SetNormal method and fixed original to set the m_hasNormal to true.

2012-11-14 Jeannie Backer - Removed cout lines left in while testing code. References #1181.

2012-12-21 Debbie A. Cook - Added new members m_hasEllipsoidIntersection and method hasEllipsoidIntersection(). Fixes Mantis ticket #1343

2015-04-30 Jeannie Backer - Added pure virtual isDEM() method. References #2243.

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

2015-10-01 Jeannie Backer - Made improvements to documentation and brought code closer to ISIS coding standards. References #1438

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

2017-05-19 Tyler Wilson - Removed the calculateEllipsoidalSurfaceNormal() function, as this is now being handled in the EllipsoidShape class. References #1028.

2017-03-23 Kris Becker - added isVisibleFrom() and two intersectSurface() methods to address real occlusions. It is recommended that derived models reimplement this method! Also made setSurfacePoint() & clearSurfacePoint() virtual to give some hope of a consistent internal state in derived models.

2023-11-17 Adam Paquette - Added new localNormal variable with same interface as the surface normal. This ensures that the currently stored m_normal is always the surface normal, and that the local normal is always stored in m_localNormal.

Definition at line 66 of file ShapeModel.h.

Constructor & Destructor Documentation

◆ ShapeModel() [1/2]

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.

Definition at line 40 of file ShapeModel.cpp.

References Initialize().

◆ ShapeModel() [2/2]

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.

Definition at line 56 of file ShapeModel.cpp.

References Initialize().

◆ ~ShapeModel()

Isis::ShapeModel::~ShapeModel ( )

pure virtual

Virtual destructor to destroy the ShapeModel object.

Definition at line 78 of file ShapeModel.cpp.

References m_surfacePoint.

Member Function Documentation

◆ calculateDefaultNormal()

virtual void Isis::ShapeModel::calculateDefaultNormal ( )

pure virtual

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

◆ calculateEllipsoidalSurfaceNormal()

void Isis::ShapeModel::calculateEllipsoidalSurfaceNormal ( )

protected

Calculates the ellipsoidal surface normal.

Definition at line 142 of file ShapeModel.cpp.

References m_hasIntersection, m_hasNormal, m_normal, Isis::IException::Programmer, and surfaceIntersection().

◆ calculateLocalNormal()

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

pure virtual

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

◆ calculateSurfaceNormal()

virtual void Isis::ShapeModel::calculateSurfaceNormal ( )

pure virtual

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

◆ clearSurfacePoint()

void Isis::ShapeModel::clearSurfacePoint ( )

virtual

Clears or resets the current surface point.

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

Definition at line 398 of file ShapeModel.cpp.

References m_hasEllipsoidIntersection, and setHasIntersection().

Referenced by Isis::EmbreeShapeModel::clearSurfacePoint(), intersectEllipsoid(), Isis::Camera::RawFocalPlanetoImage(), Isis::Camera::SetGround(), Isis::CSMCamera::SetGround(), Isis::Sensor::SetGround(), Isis::Sensor::SetGroundLocal(), Isis::Camera::SetImage(), Isis::Camera::SetImage(), Isis::Camera::SetImageMapProjection(), Isis::Camera::SetImageSkyMapProjection(), Isis::Sensor::SetUniversalGround(), Isis::Sensor::SetUniversalGround(), and Isis::BulletShapeModel::updateShapeModel().

◆ emissionAngle()

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.

Definition at line 187 of file ShapeModel.cpp.

References hasNormal(), m_normal, Isis::RAD2DEG, and surfaceIntersection().

Referenced by isVisibleFrom().

◆ hasEllipsoidIntersection()

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.

Definition at line 215 of file ShapeModel.cpp.

References m_hasEllipsoidIntersection.

◆ hasIntersection()

bool Isis::ShapeModel::hasIntersection ( )

Returns intersection status.

Returns: bool Indicates whether this ShapeModel has an intersection.

Definition at line 370 of file ShapeModel.cpp.

References m_hasIntersection.

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::EmbreeShapeModel::intersectSurface(), Isis::BulletShapeModel::intersectSurface(), Isis::EmbreeShapeModel::intersectSurface(), Isis::BulletShapeModel::intersectSurface(), Isis::DemShape::intersectSurface(), Isis::EmbreeShapeModel::intersectSurface(), Isis::EquatorialCylindricalShape::intersectSurface(), isVisibleFrom(), Isis::CSMCamera::SetGround(), Isis::Sensor::SetGroundLocal(), Isis::BulletShapeModel::setLocalNormalFromIntercept(), and Isis::NaifDskShape::setLocalNormalFromIntercept().

◆ hasLocalNormal()

bool Isis::ShapeModel::hasLocalNormal ( ) const

Returns surface point local normal status.

Returns: Indicates whether this ShapeModel has a surface normal.

Definition at line 390 of file ShapeModel.cpp.

References m_hasLocalNormal.

◆ hasNormal()

bool Isis::ShapeModel::hasNormal ( ) const

Returns surface point normal status.

Returns: Indicates whether this ShapeModel has a surface normal.

Definition at line 380 of file ShapeModel.cpp.

References m_hasNormal.

Referenced by emissionAngle(), Isis::EmbreeShapeModel::incidenceAngle(), and incidenceAngle().

◆ hasValidTarget()

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.

Definition at line 479 of file ShapeModel.cpp.

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

◆ incidenceAngle()

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::EmbreeShapeModel, and Isis::PlaneShape.

Definition at line 234 of file ShapeModel.cpp.

References hasNormal(), m_normal, Isis::RAD2DEG, and surfaceIntersection().

Referenced by Isis::EmbreeShapeModel::incidenceAngle().

◆ Initialize()

void Isis::ShapeModel::Initialize ( )

Initializes the ShapeModel private variables.

Definition at line 65 of file ShapeModel.cpp.

References m_hasEllipsoidIntersection, m_hasIntersection, m_hasLocalNormal, m_hasNormal, m_localNormal, m_normal, and m_surfacePoint.

Referenced by ShapeModel(), and ShapeModel().

◆ intersectEllipsoid()

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.

Definition at line 269 of file ShapeModel.cpp.

References Isis::NaifStatus::CheckErrors(), clearSurfacePoint(), Isis::SurfacePoint::FromNaifArray(), m_hasEllipsoidIntersection, m_hasIntersection, m_surfacePoint, and targetRadii().

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 )

virtual

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::EmbreeShapeModel, and Isis::BulletShapeModel.

Definition at line 105 of file ShapeModel.cpp.

◆ intersectSurface() [2/3]

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

virtual

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::EmbreeShapeModel, Isis::NaifDskShape, and Isis::BulletShapeModel.

Definition at line 129 of file ShapeModel.cpp.

References setSurfacePoint().

◆ intersectSurface() [3/3]

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

pure virtual

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

◆ isDEM()

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::BulletShapeModel, Isis::DemShape, Isis::EllipsoidShape, Isis::EmbreeShapeModel, Isis::NaifDskShape, and Isis::PlaneShape.

Referenced by Isis::IsisShape::intersect().

◆ isVisibleFrom()

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

virtual

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::BulletShapeModel, and Isis::EmbreeShapeModel.

Definition at line 461 of file ShapeModel.cpp.

References emissionAngle(), and hasIntersection().

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

◆ localNormal()

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

virtual

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 hasLocalNormal() method to verify before calling this method.

See also: hasLocalNormal()

Returns: A local surface normal vector, if it exists.

Definition at line 432 of file ShapeModel.cpp.

References m_hasLocalNormal, m_localNormal, and Isis::IException::Unknown.

Referenced by Isis::EllipsoidShape::calculateSurfaceNormal(), and Isis::EmbreeShapeModel::incidenceAngle().

◆ localRadius()

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

pure virtual

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

◆ name()

QString Isis::ShapeModel::name ( ) const

Gets the shape name.

Returns: QString The name of the ShapeModel.

Definition at line 620 of file ShapeModel.cpp.

Referenced by Isis::Spice::init(), Isis::Target::restoreShape(), Isis::Camera::SetGround(), Isis::CSMCamera::SetGround(), Isis::Camera::SetImageMapProjection(), and setName().

◆ normal()

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

virtual

Returns the 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 413 of file ShapeModel.cpp.

References m_hasNormal, m_normal, and Isis::IException::Unknown.

Referenced by Isis::DemShape::calculateDefaultNormal(), Isis::DemShape::calculateLocalNormal(), Isis::EllipsoidShape::calculateLocalNormal(), Isis::EmbreeShapeModel::incidenceAngle(), Isis::IsisShape::intersect(), setLocalNormal(), Isis::BulletShapeModel::setLocalNormalFromIntercept(), setNormal(), and Isis::BulletShapeModel::updateShapeModel().

◆ phaseAngle()

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.

Definition at line 326 of file ShapeModel.cpp.

References Isis::RAD2DEG, and surfaceIntersection().

◆ resolution()

double Isis::ShapeModel::resolution ( )

protected

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

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

Definition at line 681 of file ShapeModel.cpp.

References hasValidTarget(), m_hasIntersection, Isis::IException::Programmer, Isis::Spice::resolution(), and Isis::Target::spice().

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

◆ setHasIntersection()

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.

Definition at line 631 of file ShapeModel.cpp.

References m_hasIntersection, setHasLocalNormal(), and setHasNormal().

Referenced by clearSurfacePoint(), Isis::DemShape::intersectSurface(), Isis::EmbreeShapeModel::intersectSurface(), Isis::EquatorialCylindricalShape::intersectSurface(), Isis::PlaneShape::intersectSurface(), Isis::Camera::RawFocalPlanetoImage(), Isis::CSMCamera::SetGround(), Isis::Sensor::SetGroundLocal(), Isis::Camera::SetImageMapProjection(), and Isis::EmbreeShapeModel::updateIntersection().

◆ setHasLocalNormal()

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

protected

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

Parameters

status Indicates whether there is a normal.

Definition at line 670 of file ShapeModel.cpp.

References m_hasLocalNormal.

Referenced by Isis::DemShape::calculateLocalNormal(), Isis::EllipsoidShape::calculateLocalNormal(), Isis::EmbreeShapeModel::clearSurfacePoint(), setHasIntersection(), setSurfacePoint(), and Isis::BulletShapeModel::updateShapeModel().

◆ setHasNormal()

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

protected

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

Parameters

status Indicates whether there is a normal.

Definition at line 660 of file ShapeModel.cpp.

References m_hasNormal.

Referenced by Isis::DemShape::calculateDefaultNormal(), Isis::EmbreeShapeModel::clearSurfacePoint(), setHasIntersection(), and setSurfacePoint().

◆ setLocalNormal() [1/2]

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

protected

Sets the local 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 local normal.
b	Second coordinate value for the three dimensional local normal.
c	Third coordinate value for the three dimensional local normal.

Definition at line 590 of file ShapeModel.cpp.

References m_hasIntersection, m_hasLocalNormal, m_localNormal, and Isis::IException::Unknown.

◆ setLocalNormal() [2/2]

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

protected

Sets the local normal for the currect intersection point.

Note: This method will throw an error if this ShapeModel doesn't have an intersection. Use the hasIntersection() method to verify before calling this method.

See also: hasIntersection()

Parameters

normal Three dimensional local normal vector.

Definition at line 539 of file ShapeModel.cpp.

References m_hasIntersection, m_hasLocalNormal, m_localNormal, normal(), and Isis::IException::Unknown.

Referenced by Isis::DemShape::calculateLocalNormal(), Isis::EllipsoidShape::calculateLocalNormal(), Isis::BulletShapeModel::setLocalNormalFromIntercept(), Isis::NaifDskShape::setLocalNormalFromIntercept(), and Isis::BulletShapeModel::updateShapeModel().

◆ setName()

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

protected

Sets the shape name.

Parameters

name	The name of the ShapeModel.

Definition at line 609 of file ShapeModel.cpp.

References name().

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

◆ setNormal() [1/2]

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

protected

Sets the surface 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 564 of file ShapeModel.cpp.

References m_hasIntersection, m_hasNormal, m_normal, and Isis::IException::Unknown.

◆ setNormal() [2/2]

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

protected

Sets the surface normal for the currect intersection point.

Note: This method will throw an error if this ShapeModel doesn't have an intersection. Use the hasIntersection() method to verify before calling this method.

See also: hasIntersection()

Parameters

normal Three dimensional surface normal vector.

Definition at line 517 of file ShapeModel.cpp.

References m_hasIntersection, m_hasNormal, m_normal, normal(), and Isis::IException::Unknown.

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

◆ setSurfacePoint()

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

virtual

Set surface intersection point.

Parameters

surfacePoint Position coordinate for the surface point.

Reimplemented in Isis::BulletShapeModel.

Definition at line 643 of file ShapeModel.cpp.

References m_hasIntersection, m_surfacePoint, setHasLocalNormal(), and setHasNormal().

Referenced by intersectSurface(), Isis::NaifDskShape::intersectSurface(), Isis::EmbreeShapeModel::updateIntersection(), and Isis::BulletShapeModel::updateShapeModel().

◆ surfaceIntersection()

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

virtual

Returns the surface intersection for this ShapeModel.

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

Definition at line 360 of file ShapeModel.cpp.

References m_surfacePoint.

Referenced by Isis::DemShape::calculateDefaultNormal(), calculateEllipsoidalSurfaceNormal(), Isis::DemShape::calculateLocalNormal(), Isis::EllipsoidShape::calculateLocalNormal(), Isis::Sensor::Coordinate(), Isis::BulletShapeModel::ellipsoidNormal(), Isis::EmbreeShapeModel::ellipsoidNormal(), Isis::NaifDskShape::ellipsoidNormal(), Isis::PlaneShape::emissionAngle(), emissionAngle(), Isis::PlaneShape::incidenceAngle(), incidenceAngle(), Isis::IsisShape::intersect(), Isis::DemShape::intersectSurface(), Isis::EquatorialCylindricalShape::intersectSurface(), Isis::PlaneShape::intersectSurface(), Isis::EmbreeShapeModel::isVisibleFrom(), Isis::PlaneShape::localRadius(), phaseAngle(), and Isis::Sensor::SetGroundLocal().

◆ targetRadii()

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.

Definition at line 495 of file ShapeModel.cpp.

References hasValidTarget(), Isis::IException::Programmer, and Isis::Target::radii().

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

Member Data Documentation

◆ m_hasEllipsoidIntersection

bool Isis::ShapeModel::m_hasEllipsoidIntersection

private

Indicates the ellipsoid was successfully intersected.

Definition at line 184 of file ShapeModel.h.

Referenced by clearSurfacePoint(), hasEllipsoidIntersection(), Initialize(), and intersectEllipsoid().

◆ m_hasIntersection

bool Isis::ShapeModel::m_hasIntersection

private

indicates good intersection exists

Definition at line 185 of file ShapeModel.h.

Referenced by calculateEllipsoidalSurfaceNormal(), hasIntersection(), Initialize(), intersectEllipsoid(), resolution(), setHasIntersection(), setLocalNormal(), setLocalNormal(), setNormal(), setNormal(), and setSurfacePoint().

◆ m_hasLocalNormal

bool Isis::ShapeModel::m_hasLocalNormal

private

indicates local normal has been computed

Definition at line 187 of file ShapeModel.h.

Referenced by hasLocalNormal(), Initialize(), localNormal(), setHasLocalNormal(), setLocalNormal(), and setLocalNormal().

◆ m_hasNormal

bool Isis::ShapeModel::m_hasNormal

private

indicates normal has been computed

Definition at line 186 of file ShapeModel.h.

Referenced by calculateEllipsoidalSurfaceNormal(), hasNormal(), Initialize(), normal(), setHasNormal(), setNormal(), and setNormal().

◆ m_localNormal

std::vector<double> Isis::ShapeModel::m_localNormal

private

Local normal of current intersection point.

Definition at line 189 of file ShapeModel.h.

Referenced by Initialize(), localNormal(), setLocalNormal(), and setLocalNormal().

◆ m_name

QString* Isis::ShapeModel::m_name

private

Definition at line 190 of file ShapeModel.h.

◆ m_normal

std::vector<double> Isis::ShapeModel::m_normal

private

Surface normal of current intersection point.

Definition at line 188 of file ShapeModel.h.

Referenced by calculateEllipsoidalSurfaceNormal(), emissionAngle(), incidenceAngle(), Initialize(), normal(), setNormal(), and setNormal().

◆ m_surfacePoint

SurfacePoint* Isis::ShapeModel::m_surfacePoint

private

< Name of the shape

Current intersection point

Definition at line 191 of file ShapeModel.h.

Referenced by Initialize(), intersectEllipsoid(), setSurfacePoint(), surfaceIntersection(), and ~ShapeModel().

◆ m_target

Target* Isis::ShapeModel::m_target

private

Definition at line 193 of file ShapeModel.h.

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

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ShapeModel() [1/2]

◆ ShapeModel() [2/2]

◆ ~ShapeModel()

Member Function Documentation

◆ calculateDefaultNormal()

◆ calculateEllipsoidalSurfaceNormal()

◆ calculateLocalNormal()

◆ calculateSurfaceNormal()

◆ clearSurfacePoint()

◆ emissionAngle()

◆ hasEllipsoidIntersection()

◆ hasIntersection()

◆ hasLocalNormal()

◆ hasNormal()

◆ hasValidTarget()

◆ incidenceAngle()

◆ Initialize()

◆ intersectEllipsoid()

◆ intersectSurface() [1/3]

◆ intersectSurface() [2/3]

◆ intersectSurface() [3/3]

◆ isDEM()

◆ isVisibleFrom()

◆ localNormal()

◆ localRadius()

◆ name()

◆ normal()

◆ phaseAngle()

◆ resolution()

◆ setHasIntersection()

◆ setHasLocalNormal()

◆ setHasNormal()

◆ setLocalNormal() [1/2]

◆ setLocalNormal() [2/2]

◆ setName()

◆ setNormal() [1/2]

◆ setNormal() [2/2]

◆ setSurfacePoint()

◆ surfaceIntersection()

◆ targetRadii()

Member Data Documentation

◆ m_hasEllipsoidIntersection

◆ m_hasIntersection

◆ m_hasLocalNormal

◆ m_hasNormal

◆ m_localNormal

◆ m_name

◆ m_normal

◆ m_surfacePoint

◆ m_target