Isis 3 Programmer Reference
Isis::EllipsoidShape Class Reference

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

#include <EllipsoidShape.h>

Inheritance diagram for Isis::EllipsoidShape:
Inheritance graph
Collaboration diagram for Isis::EllipsoidShape:
Collaboration graph

Public Member Functions

 EllipsoidShape (Target *target)
 Constructors. More...
 
 EllipsoidShape ()
 Initialize the EllipsoidShape. More...
 
 ~EllipsoidShape ()
 Destructor. More...
 
bool intersectSurface (std::vector< double > observerPos, std::vector< double > lookDirection)
 Intersect the shape model. More...
 
virtual void calculateDefaultNormal ()
 Calculate the default normal of the current intersection point. More...
 
bool isDEM () const
 Indicates that this shape model is not from a DEM. More...
 
void calculateLocalNormal (QVector< double *> cornerNeighborPoints)
 Calculate the local surface normal of the current intersection point. More...
 
void calculateSurfaceNormal ()
 Calculate the surface normal of the current intersection point. More...
 
Distance localRadius (const Latitude &lat, const Longitude &lon)
 Get the local radius for a point on the surface. 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...
 
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 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...
 
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...
 

Detailed Description

Define shapes and provide utilities for Isis3 targets.

This class will define shapes of Isis3 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 61 of file EllipsoidShape.h.

Constructor & Destructor Documentation

◆ EllipsoidShape() [1/2]

Isis::EllipsoidShape::EllipsoidShape ( Target target)

Constructors.

Initialize the EllipsoidShape.

Parameters
pvlValid Isis3 cube label.

Definition at line 28 of file EllipsoidShape.cpp.

References Isis::ShapeModel::setName().

◆ EllipsoidShape() [2/2]

Isis::EllipsoidShape::EllipsoidShape ( )

Initialize the EllipsoidShape.

Parameters
pvlValid Isis3 cube label.

Definition at line 38 of file EllipsoidShape.cpp.

References Isis::ShapeModel::setName().

◆ ~EllipsoidShape()

Isis::EllipsoidShape::~EllipsoidShape ( )
inline

Destructor.

Definition at line 68 of file EllipsoidShape.h.

Member Function Documentation

◆ calculateDefaultNormal()

void Isis::EllipsoidShape::calculateDefaultNormal ( )
virtual

Calculate the default normal of the current intersection point.

Calculate default normal.

Implements Isis::ShapeModel.

Definition at line 56 of file EllipsoidShape.cpp.

References calculateLocalNormal().

◆ calculateEllipsoidalSurfaceNormal()

void Isis::ShapeModel::calculateEllipsoidalSurfaceNormal ( )
protectedinherited

Calculates the ellipsoidal surface normal.

Definition at line 134 of file ShapeModel.cpp.

References _FILEINFO_.

◆ 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 102 of file EllipsoidShape.cpp.

References _FILEINFO_, Isis::NaifStatus::CheckErrors(), Isis::ShapeModel::hasIntersection(), Isis::Displacement::kilometers(), Isis::ShapeModel::normal(), Isis::IException::Programmer, Isis::ShapeModel::setHasNormal(), Isis::ShapeModel::setNormal(), Isis::ShapeModel::surfaceIntersection(), and Isis::ShapeModel::targetRadii().

Referenced by calculateDefaultNormal(), and calculateSurfaceNormal().

◆ calculateSurfaceNormal()

void Isis::EllipsoidShape::calculateSurfaceNormal ( )
virtual

Calculate the surface normal of the current intersection point.

Calculate surface normal.

Implements Isis::ShapeModel.

Definition at line 65 of file EllipsoidShape.cpp.

References calculateLocalNormal().

◆ clearSurfacePoint()

◆ 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
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 ( )
protectedinherited

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
inherited

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
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 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)
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
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 ( )
inherited

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 
)
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
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 intersectSurface(), and Isis::DemShape::intersectSurface().

◆ intersectSurface() [1/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 46 of file EllipsoidShape.cpp.

References Isis::ShapeModel::intersectEllipsoid().

◆ intersectSurface() [2/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
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() [3/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
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()

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 78 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
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().

◆ 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 138 of file EllipsoidShape.cpp.

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

◆ name()

QString Isis::ShapeModel::name ( ) const
inherited

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

Definition at line 395 of file ShapeModel.cpp.

References _FILEINFO_.

Referenced by Isis::DemShape::calculateDefaultNormal(), 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 
)
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
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 ( )
protectedinherited

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

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

◆ setHasNormal()

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

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(), calculateLocalNormal(), Isis::DemShape::calculateLocalNormal(), Isis::EmbreeShapeModel::clearSurfacePoint(), and Isis::BulletShapeModel::updateShapeModel().

◆ setName()

◆ setNormal() [1/2]

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

◆ setNormal() [2/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
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)
virtualinherited

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

References _FILEINFO_.

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


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