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

#include <EllipsoidShape.h>

Inheritance diagram for Isis::EllipsoidShape:

Collaboration diagram for Isis::EllipsoidShape:

Public Member Functions
	EllipsoidShape (Target *target)
	Constructors.

	EllipsoidShape ()
	Initialize the EllipsoidShape.

	~EllipsoidShape ()
	Destructor.

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

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

void	calculateLocalNormal (QVector< double * > cornerNeighborPoints)
	Calculate the local 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.

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.

void	Initialize ()
	Initializes the ShapeModel private variables.

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 ()
	Compute the true surface normal vector of an ellipsoid.

virtual void	calculateSurfaceNormal ()
	Calculate surface normal.

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.

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.

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 class will define shapes of ISIS 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.

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

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

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

2017-05-19 Tyler Wilson - calculateSurfaceNormal() and calculateDefaultNormal() now call calculateLocalNormal(), which calculates the normal vector to an ellipsoid. Prior to this, they were calling ShapeModel::calculateEllipsoidalSurfaceNormal() function which was incorrectly returning the normal vector to a sphere and not an ellipsoid. Fixes #1028.

2017-06-07 Kristin Berry - Added a using declaration so that the new intersectSurface methods in ShapeModel are accessible by EllipsoidShape.

Definition at line 44 of file EllipsoidShape.h.

Constructor & Destructor Documentation

◆ EllipsoidShape() [1/2]

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

Constructors.

Initialize the EllipsoidShape.

Parameters

pvl	Valid ISIS cube label.

Definition at line 34 of file EllipsoidShape.cpp.

References Isis::ShapeModel::setName(), and Isis::ShapeModel::ShapeModel().

◆ EllipsoidShape() [2/2]

Isis::EllipsoidShape::EllipsoidShape ( )

Initialize the EllipsoidShape.

Parameters

pvl	Valid ISIS cube label.

Definition at line 44 of file EllipsoidShape.cpp.

References Isis::ShapeModel::setName(), and Isis::ShapeModel::ShapeModel().

◆ ~EllipsoidShape()

Isis::EllipsoidShape::~EllipsoidShape ( )

inline

Destructor.

Definition at line 51 of file EllipsoidShape.h.

Member Function Documentation

◆ calculateDefaultNormal()

void Isis::ShapeModel::calculateDefaultNormal ( )

virtualinherited

Compute the true surface normal vector of an ellipsoid.

This routine is used instead of the one provided by the ShapeModel implementation. This is primarly because ShapeModel::calculateEllipsoidalSurfaceNormal() is only suitable for a spheroid. This implementation is intended for irregular bodies so we expect triaxial ellipsoids.

Author: 2017-03-27 Kris Becker

Returns: QVector<double> Normal vector at the intercept point relative to the ellipsoid (not the plate model)

Reimplemented in Isis::PlaneShape.

Definition at line 160 of file ShapeModel.cpp.

References Isis::NaifStatus::CheckErrors(), hasIntersection(), hasValidTarget(), setHasNormal(), setNormal(), surfaceIntersection(), targetRadii(), and Isis::SurfacePoint::ToNaifArray().

Referenced by calculateSurfaceNormal(), emissionAngle(), and incidenceAngle().

◆ calculateLocalNormal()

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

virtual

Calculate the local surface normal of the current intersection point.

Calculates the unit normal to an ellipsoid at the point of intersection.

In the event that the three axial radii of the body are equal, this method returns the normal vector for a sphere.

The implicit equation for an ellipsoid is: U(x,y,z) = x^2/a^2 + y^2/b^2 + z^2/c^2 -1 =0

The normal to U(x,y,z) is given by:

n = grad(U)/norm(U)

i.e. as:

n = <ux,uy,uz>/sqrt(ux^2,+uy^2+uz^2)

Parameters

cornerNeighborPoints

Implements Isis::ShapeModel.

Definition at line 90 of file EllipsoidShape.cpp.

References Isis::ShapeModel::calculateSurfaceNormal(), Isis::ShapeModel::hasNormal(), Isis::ShapeModel::normal(), and Isis::ShapeModel::setLocalNormal().

◆ calculateSurfaceNormal()

void Isis::ShapeModel::calculateSurfaceNormal ( )

virtualinherited

Calculate surface normal.

Reimplemented in Isis::PlaneShape.

Definition at line 142 of file ShapeModel.cpp.

References calculateDefaultNormal().

Referenced by Isis::EllipsoidShape::calculateLocalNormal(), and Isis::Camera::Slope().

◆ clearSurfacePoint()

void Isis::ShapeModel::clearSurfacePoint ( )

virtualinherited

Clears or resets the current surface point.

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

Definition at line 425 of file ShapeModel.cpp.

References m_hasEllipsoidIntersection, and setHasIntersection().

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

◆ emissionAngle()

double Isis::ShapeModel::emissionAngle ( const std::vector< double > & observerBodyFixedPosition )

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

References calculateDefaultNormal(), hasNormal(), Isis::Displacement::kilometers(), m_normal, and surfaceIntersection().

Referenced by Isis::CSMCamera::EmissionAngle(), Isis::Sensor::EmissionAngle(), and isVisibleFrom().

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

Definition at line 242 of file ShapeModel.cpp.

References m_hasEllipsoidIntersection.

◆ hasIntersection()

bool Isis::ShapeModel::hasIntersection ( )

inherited

Returns intersection status.

Returns: bool Indicates whether this ShapeModel has an intersection.

Definition at line 397 of file ShapeModel.cpp.

References m_hasIntersection.

Referenced by calculateDefaultNormal(), Isis::BulletShapeModel::calculateLocalNormal(), Isis::EmbreeShapeModel::calculateLocalNormal(), Isis::NaifDskShape::calculateLocalNormal(), Isis::Camera::GetLocalNormal(), Isis::Sensor::HasSurfaceIntersection(), Isis::BulletShapeModel::intersectSurface(), Isis::BulletShapeModel::intersectSurface(), Isis::EmbreeShapeModel::intersectSurface(), Isis::EmbreeShapeModel::intersectSurface(), Isis::EmbreeShapeModel::intersectSurface(), Isis::EquatorialCylindricalShape::intersectSurface(), isVisibleFrom(), Isis::CSMCamera::SetGround(), Isis::Sensor::SetGroundLocal(), Isis::BulletShapeModel::setLocalNormalFromIntercept(), Isis::NaifDskShape::setLocalNormalFromIntercept(), and Isis::Camera::Slope().

◆ hasLocalNormal()

bool Isis::ShapeModel::hasLocalNormal ( ) const

inherited

Returns surface point local normal status.

Returns: Indicates whether this ShapeModel has a surface normal.

Definition at line 417 of file ShapeModel.cpp.

References m_hasLocalNormal.

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

◆ hasNormal()

bool Isis::ShapeModel::hasNormal ( ) const

inherited

Returns surface point normal status.

Returns: Indicates whether this ShapeModel has a surface normal.

Definition at line 407 of file ShapeModel.cpp.

References m_hasNormal.

Referenced by Isis::EllipsoidShape::calculateLocalNormal(), emissionAngle(), incidenceAngle(), and Isis::Camera::Slope().

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

Definition at line 506 of file ShapeModel.cpp.

Referenced by calculateDefaultNormal(), resolution(), and targetRadii().

◆ incidenceAngle()

double Isis::ShapeModel::incidenceAngle ( const std::vector< double > & illuminatorBodyFixedPosition )

virtualinherited

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

Definition at line 261 of file ShapeModel.cpp.

References calculateDefaultNormal(), hasNormal(), Isis::Displacement::kilometers(), m_normal, and surfaceIntersection().

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

◆ Initialize()

void Isis::ShapeModel::Initialize ( )

inherited

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 )

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

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

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

Definition at line 85 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 from Isis::ShapeModel.

Definition at line 88 of file ShapeModel.cpp.

◆ intersectSurface() [3/3]

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

virtual

Intersect the shape model.

Find the intersection point.

Implements Isis::ShapeModel.

Definition at line 52 of file EllipsoidShape.cpp.

References Isis::ShapeModel::intersectEllipsoid().

◆ isDEM()

bool Isis::EllipsoidShape::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 66 of file EllipsoidShape.cpp.

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

Definition at line 488 of file ShapeModel.cpp.

References emissionAngle(), and hasIntersection().

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

◆ localNormal()

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

virtualinherited

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

References m_hasLocalNormal, and m_localNormal.

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

◆ localRadius()

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

virtual

Get the local radius for a point on the surface.

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

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

Implements Isis::ShapeModel.

Definition at line 106 of file EllipsoidShape.cpp.

References Isis::Distance::Kilometers, Isis::Angle::radians(), and Isis::ShapeModel::targetRadii().

◆ name()

QString Isis::ShapeModel::name ( ) const

inherited

Gets the shape name.

Returns: QString The name of the ShapeModel.

Definition at line 647 of file ShapeModel.cpp.

Referenced by isDEM(), Isis::Camera::SetGround(), Isis::CSMCamera::SetGround(), Isis::Camera::SetImageMapProjection(), setName(), Isis::TrackTool::updateLabels(), and Isis::AdvancedTrackTool::updateRow().

◆ normal()

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

virtualinherited

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

References m_hasNormal, and m_normal.

Referenced by Isis::DemShape::calculateLocalNormal(), Isis::EllipsoidShape::calculateLocalNormal(), setLocalNormal(), Isis::BulletShapeModel::setLocalNormalFromIntercept(), setNormal(), Isis::Camera::Slope(), and Isis::BulletShapeModel::updateShapeModel().

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

Definition at line 353 of file ShapeModel.cpp.

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

Referenced by Isis::CSMCamera::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.

Definition at line 708 of file ShapeModel.cpp.

References hasValidTarget(), and m_hasIntersection.

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.

Definition at line 658 of file ShapeModel.cpp.

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

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

◆ setHasLocalNormal()

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

protectedinherited

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

Parameters

status Indicates whether there is a normal.

Definition at line 697 of file ShapeModel.cpp.

References m_hasLocalNormal.

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

◆ setHasNormal()

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

protectedinherited

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

Parameters

status Indicates whether there is a normal.

Definition at line 687 of file ShapeModel.cpp.

References m_hasNormal.

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

◆ setLocalNormal() [1/2]

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

protectedinherited

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

References m_hasIntersection, m_hasLocalNormal, and m_localNormal.

◆ setLocalNormal() [2/2]

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

protectedinherited

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

References m_hasIntersection, m_hasLocalNormal, m_localNormal, and normal().

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

◆ setName()

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

protectedinherited

Sets the shape name.

Parameters

name	The name of the ShapeModel.

Definition at line 636 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 )

protectedinherited

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

References m_hasIntersection, m_hasNormal, and m_normal.

◆ setNormal() [2/2]

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

protectedinherited

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

References m_hasIntersection, m_hasNormal, m_normal, and normal().

Referenced by calculateDefaultNormal(), and Isis::PlaneShape::intersectSurface().

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

Definition at line 670 of file ShapeModel.cpp.

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

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

◆ surfaceIntersection()

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

virtualinherited

Returns the surface intersection for this ShapeModel.

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

Definition at line 387 of file ShapeModel.cpp.

References m_surfacePoint.

Referenced by Isis::DemShape::calcDemErrUpdateIntersection(), calculateDefaultNormal(), Isis::DemShape::calculateLocalNormal(), Isis::Sensor::Coordinate(), Isis::PlaneShape::emissionAngle(), emissionAngle(), Isis::Sensor::GetLatitude(), Isis::Sensor::GetLongitude(), Isis::Sensor::GetSurfacePoint(), Isis::PlaneShape::incidenceAngle(), incidenceAngle(), Isis::DemShape::intersectSurface(), Isis::EquatorialCylindricalShape::intersectSurface(), Isis::PlaneShape::intersectSurface(), Isis::EmbreeShapeModel::isVisibleFrom(), Isis::Sensor::LocalRadius(), Isis::PlaneShape::localRadius(), phaseAngle(), Isis::Sensor::SetGroundLocal(), 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.

Definition at line 522 of file ShapeModel.cpp.

References hasValidTarget().

Referenced by calculateDefaultNormal(), Isis::DemShape::findDemValue(), intersectEllipsoid(), Isis::EquatorialCylindricalShape::intersectSurface(), and Isis::EllipsoidShape::localRadius().

Member Data Documentation

◆ m_hasEllipsoidIntersection

bool Isis::ShapeModel::m_hasEllipsoidIntersection

privateinherited

Indicates the ellipsoid was successfully intersected.

Definition at line 182 of file ShapeModel.h.

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

◆ m_hasIntersection

bool Isis::ShapeModel::m_hasIntersection

privateinherited

indicates good intersection exists

Definition at line 183 of file ShapeModel.h.

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

◆ m_hasLocalNormal

bool Isis::ShapeModel::m_hasLocalNormal

privateinherited

indicates local normal has been computed

Definition at line 185 of file ShapeModel.h.

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

◆ m_hasNormal

bool Isis::ShapeModel::m_hasNormal

privateinherited

indicates normal has been computed

Definition at line 184 of file ShapeModel.h.

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

◆ m_localNormal

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

privateinherited

Local normal of current intersection point.

Definition at line 187 of file ShapeModel.h.

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

◆ m_name

QString* Isis::ShapeModel::m_name

privateinherited

Definition at line 188 of file ShapeModel.h.

◆ m_normal

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

privateinherited

Surface normal of current intersection point.

Definition at line 186 of file ShapeModel.h.

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

◆ m_surfacePoint

SurfacePoint* Isis::ShapeModel::m_surfacePoint

privateinherited

< Name of the shape

Current intersection point

Definition at line 189 of file ShapeModel.h.

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

◆ m_target

Target* Isis::ShapeModel::m_target

privateinherited

Definition at line 191 of file ShapeModel.h.

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

src/base/objs/EllipsoidShape/EllipsoidShape.h
src/base/objs/EllipsoidShape/EllipsoidShape.cpp

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ EllipsoidShape() [1/2]

◆ EllipsoidShape() [2/2]

◆ ~EllipsoidShape()

Member Function Documentation

◆ calculateDefaultNormal()

◆ 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