Isis 3 Programmer Reference
Isis::ShapeModel Class Referenceabstract

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

#include <ShapeModel.h>

Inheritance diagram for Isis::ShapeModel:
Inheritance graph
Collaboration diagram for Isis::ShapeModel:
Collaboration graph

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. More...
 
 ShapeModel (Target *target)
 Constructs and loads a shape model from a target only. More...
 
void Initialize ()
 Initializes the ShapeModel private variables. More...
 
virtual ~ShapeModel ()=0
 Virtual destructor to destroy the ShapeModel object. More...
 
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. More...
 
virtual bool intersectSurface (const SurfacePoint &surfpt, const std::vector< double > &observerPos, const bool &backCheck=true)
 Compute surface intersection with optional occlusion check. More...
 
SurfacePointsurfaceIntersection () 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 calculateDefaultNormal ()=0
 
virtual void calculateLocalNormal (QVector< double *> neighborPoints)=0
 
virtual void calculateSurfaceNormal ()=0
 
virtual void clearSurfacePoint ()
 Clears or resets the current surface point. More...
 
virtual double emissionAngle (const std::vector< double > &sB)
 Computes and returns emission angle, in degrees, given the observer position. More...
 
virtual double incidenceAngle (const std::vector< double > &uB)
 Computes and returns incidence angle, in degrees, given the illuminator position. 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...
 
virtual Distance localRadius (const Latitude &lat, const Longitude &lon)=0
 
virtual bool isDEM () const =0
 Indicates whether this shape model is from a DEM. 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< DistancetargetRadii () 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...
 

Private Attributes

bool m_hasEllipsoidIntersection
 Indicates the ellipsoid was successfully intersected. More...
 
bool m_hasIntersection
 indicates good intersection exists More...
 
bool m_hasNormal
 indicates normal has been computed More...
 
std::vector< double > m_normal
 Local normal of current intersection point. More...
 
QString * m_name
 
SurfacePointm_surfacePoint
 < Name of the shape More...
 
Targetm_target
 

Detailed Description

Define shapes and provide utilities for Isis3 targets.

This base class will define shapes of Isis3 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.

Definition at line 78 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 34 of file ShapeModel.cpp.

◆ 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
targetA pointer to a valid ISIS target.

Definition at line 50 of file ShapeModel.cpp.

◆ ~ShapeModel()

Isis::ShapeModel::~ShapeModel ( )
pure virtual

Virtual destructor to destroy the ShapeModel object.

Definition at line 70 of file ShapeModel.cpp.

Member Function Documentation

◆ calculateEllipsoidalSurfaceNormal()

void Isis::ShapeModel::calculateEllipsoidalSurfaceNormal ( )
protected

Calculates the ellipsoidal surface normal.

Definition at line 134 of file ShapeModel.cpp.

References _FILEINFO_.

◆ clearSurfacePoint()

◆ 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
observerBodyFixedPositionThree 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 179 of file ShapeModel.cpp.

References Isis::RAD2DEG.

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

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

◆ hasIntersection()

◆ hasNormal()

bool Isis::ShapeModel::hasNormal ( ) const

Returns surface point normal status.

Returns
Indicates whether this ShapeModel has a surface normal.

Definition at line 372 of file ShapeModel.cpp.

Referenced by Isis::Camera::GetLocalNormal(), and Isis::EmbreeShapeModel::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 443 of file ShapeModel.cpp.

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

◆ 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
illuminatorBodyFixedPositionThree 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 226 of file ShapeModel.cpp.

References Isis::RAD2DEG.

Referenced by Isis::EmbreeShapeModel::incidenceAngle(), and Isis::Sensor::IncidenceAngle().

◆ Initialize()

void Isis::ShapeModel::Initialize ( )

Initializes the ShapeModel private variables.

Definition at line 59 of file ShapeModel.cpp.

◆ 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
observerBodyFixedPositionThree dimensional position of the observer, in the coordinate system of the target body.
observerLookVectorToTargetThree dimensional direction vector from the observer to the target.
Returns
bool Indicates whether this shape model found a valid ellipsoid intersection.

Definition at line 261 of file ShapeModel.cpp.

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

◆ intersectSurface() [1/2]

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
latLatitude of the surface point
lonLongitude of the surface point
observerPosPosition of the observer
backCheckFlag to indicate occlusion check
Returns
bool True if the intersection point is valid (visable)

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

Definition at line 97 of file ShapeModel.cpp.

◆ intersectSurface() [2/2]

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
surfptAbsolute point on the surface to check
observerPosPosition of the observer
backCheckFlag to indicate occlusion check
Returns
bool True if the intersection point is valid (visable)

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

Definition at line 121 of file ShapeModel.cpp.

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

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

◆ 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
observerPosPosition of the observer in body fixed coordinates
lookDirectionLook 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 425 of file ShapeModel.cpp.

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

◆ name()

QString Isis::ShapeModel::name ( ) const

◆ normal()

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

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

References _FILEINFO_.

Referenced by Isis::DemShape::calculateDefaultNormal(), Isis::EllipsoidShape::calculateLocalNormal(), Isis::DemShape::calculateLocalNormal(), Isis::Camera::GetLocalNormal(), Isis::EmbreeShapeModel::incidenceAngle(), Isis::BulletShapeModel::setLocalNormalFromIntercept(), 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
observerBodyFixedPositionThree dimensional position of the observer, in the coordinate system of the target body.
illuminatorBodyFixedPositionThree dimensional position for the illuminator, in the body-fixed coordinate system.
Returns
double Phase angle, in degrees.

Definition at line 318 of file ShapeModel.cpp.

References Isis::RAD2DEG.

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

◆ resolution()

double Isis::ShapeModel::resolution ( )
protected

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

Returns
The pixel resolution at the surface intersection.

Definition at line 586 of file ShapeModel.cpp.

References _FILEINFO_.

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

◆ setHasIntersection()

◆ setHasNormal()

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

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

Parameters
bIndicates whether there is a normal.

Definition at line 575 of file ShapeModel.cpp.

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

◆ setName()

◆ setNormal() [1/2]

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

◆ setNormal() [2/2]

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

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
aFirst coordinate value for the three dimensional surface normal.
bSecond coordinate value for the three dimensional surface normal.
cThird coordinate value for the three dimensional surface normal.

Definition at line 506 of file ShapeModel.cpp.

References _FILEINFO_.

◆ setSurfacePoint()

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

Set surface intersection point.

Parameters
surfacePointPosition coordinate for the surface point.

Reimplemented in Isis::BulletShapeModel.

Definition at line 559 of file ShapeModel.cpp.

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

◆ surfaceIntersection()

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

References _FILEINFO_.

Referenced by Isis::DemShape::calculateDefaultNormal(), Isis::EllipsoidShape::calculateLocalNormal(), Isis::NaifDskShape::ellipsoidNormal(), Isis::EmbreeShapeModel::ellipsoidNormal(), Isis::BulletShapeModel::ellipsoidNormal(), 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 187 of file ShapeModel.h.

◆ m_hasIntersection

bool Isis::ShapeModel::m_hasIntersection
private

indicates good intersection exists

Definition at line 188 of file ShapeModel.h.

◆ m_hasNormal

bool Isis::ShapeModel::m_hasNormal
private

indicates normal has been computed

Definition at line 189 of file ShapeModel.h.

◆ m_normal

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

Local normal of current intersection point.

Definition at line 190 of file ShapeModel.h.

◆ m_surfacePoint

SurfacePoint* Isis::ShapeModel::m_surfacePoint
private

< Name of the shape

Current intersection point

Definition at line 192 of file ShapeModel.h.


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