Isis 3 Programmer Reference
|
Define shapes and provide utilities for Isis3 targets. More...
#include <EllipsoidShape.h>
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... | |
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 | 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< 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... | |
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.
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.
Isis::EllipsoidShape::EllipsoidShape | ( | Target * | target | ) |
Constructors.
Initialize the EllipsoidShape.
pvl | Valid Isis3 cube label. |
Definition at line 28 of file EllipsoidShape.cpp.
References Isis::ShapeModel::setName().
Isis::EllipsoidShape::EllipsoidShape | ( | ) |
Initialize the EllipsoidShape.
pvl | Valid Isis3 cube label. |
Definition at line 38 of file EllipsoidShape.cpp.
References Isis::ShapeModel::setName().
|
inline |
Destructor.
Definition at line 68 of file EllipsoidShape.h.
|
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().
|
protectedinherited |
Calculates the ellipsoidal surface normal.
Definition at line 134 of file ShapeModel.cpp.
References _FILEINFO_.
|
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)
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().
|
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().
|
virtualinherited |
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().
|
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.
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().
|
protectedinherited |
Returns the status of the ellipsoid model intersection.
Definition at line 207 of file ShapeModel.cpp.
|
inherited |
Returns intersection status.
Definition at line 362 of file ShapeModel.cpp.
Referenced by Isis::DemShape::calculateDefaultNormal(), Isis::NaifDskShape::calculateLocalNormal(), 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().
|
inherited |
Returns surface point normal status.
Definition at line 372 of file ShapeModel.cpp.
Referenced by Isis::Camera::GetLocalNormal(), and Isis::EmbreeShapeModel::incidenceAngle().
|
protectedinherited |
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().
|
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.
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().
|
inherited |
Initializes the ShapeModel private variables.
Definition at line 59 of file ShapeModel.cpp.
|
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).
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 intersectSurface(), and Isis::DemShape::intersectSurface().
|
virtual |
Intersect the shape model.
Find the intersection point.
Implements Isis::ShapeModel.
Definition at line 46 of file EllipsoidShape.cpp.
References Isis::ShapeModel::intersectEllipsoid().
|
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.
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.
|
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.
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.
|
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.
Implements Isis::ShapeModel.
Definition at line 78 of file EllipsoidShape.cpp.
|
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!
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().
Get the local radius for a point on the surface.
Gets the local radius for the given latitude/longitude coordinate.
Implements Isis::ShapeModel.
Definition at line 138 of file EllipsoidShape.cpp.
References Isis::Distance::Kilometers, Isis::Angle::radians(), and Isis::ShapeModel::targetRadii().
|
inherited |
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().
|
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.
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().
|
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).
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().
|
protectedinherited |
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().
|
inherited |
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().
|
protectedinherited |
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(), calculateLocalNormal(), Isis::DemShape::calculateLocalNormal(), Isis::EmbreeShapeModel::clearSurfacePoint(), and Isis::BulletShapeModel::updateShapeModel().
|
protectedinherited |
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(), EllipsoidShape(), Isis::EmbreeShapeModel::EmbreeShapeModel(), Isis::EquatorialCylindricalShape::EquatorialCylindricalShape(), Isis::NaifDskShape::NaifDskShape(), and Isis::PlaneShape::PlaneShape().
|
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.
normal | Three dimensional surface normal vector. |
Definition at line 481 of file ShapeModel.cpp.
References _FILEINFO_.
Referenced by Isis::DemShape::calculateDefaultNormal(), 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().
|
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.
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_.
|
virtualinherited |
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().
|
inherited |
Returns the surface intersection for this ShapeModel.
Definition at line 352 of file ShapeModel.cpp.
Referenced by Isis::DemShape::calculateDefaultNormal(), 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().
|
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.
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().