Isis 3 Programmer Reference
|
Define shapes and provide utilities for Isis3 targets. More...
#include <ShapeModel.h>
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... | |
SurfacePoint * | surfaceIntersection () const |
Returns the surface intersection for this ShapeModel. More... | |
bool | hasIntersection () |
Returns intersection status. More... | |
bool | hasNormal () const |
Returns surface point normal status. More... | |
virtual void | 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< Distance > | targetRadii () const |
Returns the radii of the body in km. More... | |
void | setHasNormal (bool status) |
Sets the flag to indicate whether this ShapeModel has a surface normal. More... | |
double | resolution () |
Convenience method to get pixel resolution (m/pix) at current intersection point. More... | |
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 |
SurfacePoint * | m_surfacePoint |
< Name of the shape More... | |
Target * | m_target |
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.
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.
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.
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.
target | A pointer to a valid ISIS target. |
Definition at line 50 of file ShapeModel.cpp.
|
pure virtual |
Virtual destructor to destroy the ShapeModel object.
Definition at line 70 of file ShapeModel.cpp.
|
protected |
Calculates the ellipsoidal surface normal.
Definition at line 134 of file ShapeModel.cpp.
References _FILEINFO_.
|
virtual |
Clears or resets the current surface point.
Reimplemented in Isis::BulletShapeModel, and Isis::EmbreeShapeModel.
Definition at line 380 of file ShapeModel.cpp.
Referenced by Isis::EmbreeShapeModel::clearSurfacePoint(), Isis::Camera::RawFocalPlanetoImage(), Isis::Sensor::SetGround(), Isis::Camera::SetGround(), Isis::Sensor::SetGroundLocal(), Isis::Camera::SetImage(), Isis::Camera::SetImageMapProjection(), Isis::Camera::SetImageSkyMapProjection(), Isis::Sensor::setTime(), Isis::Sensor::SetUniversalGround(), Isis::Camera::SetUniversalGround(), and Isis::BulletShapeModel::updateShapeModel().
|
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.
observerBodyFixedPosition | Three dimensional position of the observer, in the coordinate system of the target body. |
Reimplemented in Isis::PlaneShape.
Definition at line 179 of file ShapeModel.cpp.
References Isis::RAD2DEG.
Referenced by Isis::Sensor::EmissionAngle().
|
protected |
Returns the status of the ellipsoid model intersection.
Definition at line 207 of file ShapeModel.cpp.
bool Isis::ShapeModel::hasIntersection | ( | ) |
Returns intersection status.
Definition at line 362 of file ShapeModel.cpp.
Referenced by Isis::DemShape::calculateDefaultNormal(), Isis::NaifDskShape::calculateLocalNormal(), Isis::EllipsoidShape::calculateLocalNormal(), Isis::EmbreeShapeModel::calculateLocalNormal(), Isis::BulletShapeModel::calculateLocalNormal(), Isis::EmbreeShapeModel::ellipsoidNormal(), Isis::NaifDskShape::ellipsoidNormal(), Isis::BulletShapeModel::ellipsoidNormal(), Isis::Camera::GetLocalNormal(), Isis::Sensor::HasSurfaceIntersection(), Isis::EquatorialCylindricalShape::intersectSurface(), Isis::EmbreeShapeModel::intersectSurface(), Isis::BulletShapeModel::intersectSurface(), Isis::DemShape::intersectSurface(), Isis::Sensor::SetGroundLocal(), Isis::NaifDskShape::setLocalNormalFromIntercept(), and Isis::BulletShapeModel::setLocalNormalFromIntercept().
bool Isis::ShapeModel::hasNormal | ( | ) | const |
Returns surface point normal status.
Definition at line 372 of file ShapeModel.cpp.
Referenced by Isis::Camera::GetLocalNormal(), and Isis::EmbreeShapeModel::incidenceAngle().
|
protected |
Returns the status of the target.
If it is NULL, this method returns false.
Definition at line 443 of file ShapeModel.cpp.
Referenced by Isis::EmbreeShapeModel::ellipsoidNormal(), Isis::NaifDskShape::ellipsoidNormal(), and Isis::BulletShapeModel::ellipsoidNormal().
|
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.
illuminatorBodyFixedPosition | Three dimensional position for the illuminator, in the body-fixed coordinate system. |
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().
void Isis::ShapeModel::Initialize | ( | ) |
Initializes the ShapeModel private variables.
Definition at line 59 of file ShapeModel.cpp.
|
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).
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. |
Definition at line 261 of file ShapeModel.cpp.
Referenced by Isis::EllipsoidShape::intersectSurface(), and Isis::DemShape::intersectSurface().
|
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.
lat | Latitude of the surface point |
lon | Longitude of the surface point |
observerPos | Position of the observer |
backCheck | Flag to indicate occlusion check |
Reimplemented in Isis::BulletShapeModel, and Isis::EmbreeShapeModel.
Definition at line 97 of file ShapeModel.cpp.
|
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.
surfpt | Absolute point on the surface to check |
observerPos | Position of the observer |
backCheck | Flag to indicate occlusion check |
Reimplemented in Isis::BulletShapeModel, and Isis::EmbreeShapeModel.
Definition at line 121 of file ShapeModel.cpp.
|
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.
Implemented in Isis::DemShape, Isis::BulletShapeModel, Isis::EllipsoidShape, Isis::NaifDskShape, Isis::EmbreeShapeModel, and Isis::PlaneShape.
Referenced by Isis::Camera::GetLocalNormal().
|
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!
observerPos | Position of the observer in body fixed coordinates |
lookDirection | Look direction from the observer |
Reimplemented in Isis::BulletShapeModel, and Isis::EmbreeShapeModel.
Definition at line 425 of file ShapeModel.cpp.
Referenced by Isis::Sensor::SetGroundLocal().
QString Isis::ShapeModel::name | ( | ) | const |
Gets the shape name.
Definition at line 537 of file ShapeModel.cpp.
Referenced by Isis::UniversalGroundMap::GroundRange(), Isis::VimsGroundMap::SetGround(), Isis::Camera::SetGround(), Isis::Camera::SetImageMapProjection(), Isis::TrackTool::updateLabels(), and Isis::AdvancedTrackTool::updateRow().
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.
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().
|
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).
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. |
Definition at line 318 of file ShapeModel.cpp.
References Isis::RAD2DEG.
Referenced by Isis::Sensor::PhaseAngle().
|
protected |
Convenience method to get pixel resolution (m/pix) at current intersection point.
Definition at line 586 of file ShapeModel.cpp.
References _FILEINFO_.
Referenced by Isis::DemShape::intersectSurface().
void Isis::ShapeModel::setHasIntersection | ( | bool | b | ) |
Sets the flag to indicate whether this ShapeModel has an intersection.
b | Indicates whether there is an intersection. |
Definition at line 548 of file ShapeModel.cpp.
Referenced by Isis::EquatorialCylindricalShape::intersectSurface(), Isis::EmbreeShapeModel::intersectSurface(), Isis::PlaneShape::intersectSurface(), Isis::DemShape::intersectSurface(), Isis::Camera::RawFocalPlanetoImage(), Isis::Sensor::SetGroundLocal(), Isis::Camera::SetImageMapProjection(), Isis::Sensor::SetLookDirection(), and Isis::EmbreeShapeModel::updateIntersection().
|
protected |
Sets the flag to indicate whether this ShapeModel has a surface normal.
b | Indicates 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().
|
protected |
Sets the shape name.
name | The name of the ShapeModel. |
Definition at line 526 of file ShapeModel.cpp.
Referenced by Isis::BulletShapeModel::BulletShapeModel(), Isis::DemShape::DemShape(), Isis::EllipsoidShape::EllipsoidShape(), Isis::EmbreeShapeModel::EmbreeShapeModel(), Isis::EquatorialCylindricalShape::EquatorialCylindricalShape(), Isis::NaifDskShape::NaifDskShape(), and Isis::PlaneShape::PlaneShape().
|
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.
normal | Three dimensional surface normal vector. |
Definition at line 481 of file ShapeModel.cpp.
References _FILEINFO_.
Referenced by Isis::DemShape::calculateDefaultNormal(), Isis::EllipsoidShape::calculateLocalNormal(), Isis::DemShape::calculateLocalNormal(), Isis::NaifDskShape::calculateSurfaceNormal(), Isis::EmbreeShapeModel::calculateSurfaceNormal(), Isis::BulletShapeModel::calculateSurfaceNormal(), Isis::EmbreeShapeModel::incidenceAngle(), Isis::PlaneShape::intersectSurface(), Isis::NaifDskShape::setLocalNormalFromIntercept(), Isis::BulletShapeModel::setLocalNormalFromIntercept(), Isis::EmbreeShapeModel::updateIntersection(), and Isis::BulletShapeModel::updateShapeModel().
|
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.
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 506 of file ShapeModel.cpp.
References _FILEINFO_.
|
virtual |
Set surface intersection point.
surfacePoint | Position 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().
SurfacePoint * Isis::ShapeModel::surfaceIntersection | ( | ) | const |
Returns the surface intersection for this ShapeModel.
Definition at line 352 of file ShapeModel.cpp.
Referenced by Isis::DemShape::calculateDefaultNormal(), Isis::EllipsoidShape::calculateLocalNormal(), Isis::DemShape::calculateLocalNormal(), Isis::Sensor::Coordinate(), Isis::NaifDskShape::ellipsoidNormal(), Isis::EmbreeShapeModel::ellipsoidNormal(), Isis::BulletShapeModel::ellipsoidNormal(), Isis::PlaneShape::emissionAngle(), Isis::Sensor::GetLatitude(), Isis::Sensor::GetLongitude(), Isis::Sensor::GetSurfacePoint(), Isis::PlaneShape::incidenceAngle(), Isis::EquatorialCylindricalShape::intersectSurface(), Isis::PlaneShape::intersectSurface(), Isis::DemShape::intersectSurface(), Isis::EmbreeShapeModel::isVisibleFrom(), Isis::PlaneShape::localRadius(), Isis::Sensor::LocalRadius(), Isis::Sensor::SetGroundLocal(), Isis::Sensor::SlantDistance(), and Isis::Sensor::SolarDistance().
|
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.
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().
|
private |
Indicates the ellipsoid was successfully intersected.
Definition at line 187 of file ShapeModel.h.
|
private |
indicates good intersection exists
Definition at line 188 of file ShapeModel.h.
|
private |
indicates normal has been computed
Definition at line 189 of file ShapeModel.h.
|
private |
Local normal of current intersection point.
Definition at line 190 of file ShapeModel.h.
|
private |