Isis 3 Programmer Reference
|
Define plane shape model. More...
#include <PlaneShape.h>
Public Member Functions | |
PlaneShape (Target *target, Isis::Pvl &pvl) | |
Initialize the PlaneShape. More... | |
PlaneShape (Target *target) | |
Initialize the PlaneShape. More... | |
PlaneShape () | |
Initialize the PlaneShape. More... | |
~PlaneShape () | |
Destructor. More... | |
bool | intersectSurface (std::vector< double > observerPos, std::vector< double > lookDirection) |
Find the intersection point. More... | |
bool | isDEM () const |
Indicates that this shape model is not from a DEM. More... | |
void | calculateSurfaceNormal () |
There is no implementation for this method. More... | |
void | calculateDefaultNormal () |
There is no implementation for this method. More... | |
void | calculateLocalNormal (QVector< double *> cornerNeighborPoints) |
There is no implementation for this method. More... | |
double | emissionAngle (const std::vector< double > &sB) |
Computes and returns emission angle in degrees given the observer position. More... | |
double | incidenceAngle (const std::vector< double > &uB) |
Computes and returns incidence angle in degrees given the sun position. More... | |
Distance | localRadius (const Latitude &lat, const Longitude &lon) |
Gets the local radius for the given latitude/longitude coordinate. 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 | 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 plane shape model.
This class defines a plane shape model for Isis3 target bodies as well as provide utilities to retrieve radii and photometric information.
2015-04-30 Jeannie Backer - Added isDEM() method. References #2243. Moved method implementation to cpp file.
2015-07-31 Kristin Berry - Added NaifStatus::CheckErrors() to see if any NAIF errors were signaled. References #2248.
2016-06-13 Kelvin Rodriguez - Removed redundant contructor PlaneShape(Target, Pvl). References #2214
2017-06-07 Kristin Berry - Added a using declaration so that the new intersectSurface methods in ShapeModel are accessible by DemShape.
Definition at line 60 of file PlaneShape.h.
Initialize the PlaneShape.
pvl | Valid Isis3 cube label. |
Definition at line 25 of file PlaneShape.cpp.
References Isis::ShapeModel::setName().
Isis::PlaneShape::PlaneShape | ( | Target * | target | ) |
Initialize the PlaneShape.
pvl | Valid Isis3 cube label. |
Definition at line 38 of file PlaneShape.cpp.
References Isis::ShapeModel::setName().
Isis::PlaneShape::PlaneShape | ( | ) |
Initialize the PlaneShape.
pvl | Valid Isis3 cube label. |
Definition at line 51 of file PlaneShape.cpp.
References Isis::ShapeModel::setName().
Isis::PlaneShape::~PlaneShape | ( | ) |
Destructor.
Definition at line 59 of file PlaneShape.cpp.
|
virtual |
There is no implementation for this method.
Implements Isis::ShapeModel.
Definition at line 146 of file PlaneShape.cpp.
|
protectedinherited |
Calculates the ellipsoidal surface normal.
Definition at line 134 of file ShapeModel.cpp.
References _FILEINFO_.
|
virtual |
There is no implementation for this method.
Implements Isis::ShapeModel.
Definition at line 153 of file PlaneShape.cpp.
|
virtual |
There is no implementation for this method.
Implements Isis::ShapeModel.
Definition at line 139 of file PlaneShape.cpp.
|
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().
|
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 a vector from the intersection point to the spacecraft. The emission angle varies from 0 degrees when the spacecraft 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.
sB | Spacecraft position in body-fixed coordinates |
Reimplemented from Isis::ShapeModel.
Definition at line 172 of file PlaneShape.cpp.
References Isis::Displacement::kilometers(), Isis::RAD2DEG, and Isis::ShapeModel::surfaceIntersection().
|
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(), 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().
|
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().
|
virtual |
Computes and returns incidence angle in degrees given the sun position.
Incidence Angle: The incidence angle provides a measure of the lighting condition at the surface intersection point. The angle between the surface normal vector at the intersection point and a vector from the intersection point to the sun. The incidence angle varies from 0 degrees when the intersection point coincides with the sub-solar point to 90 degrees when the intersection point is at the terminator (i.e., in the shadowed or dark portion of the target body). Thus, higher values of incidence angles indicate the existence of a greater number of surface shadows.
uB | Sun position in body-fixed coordinates |
Reimplemented from Isis::ShapeModel.
Definition at line 229 of file PlaneShape.cpp.
References Isis::Displacement::kilometers(), Isis::RAD2DEG, and Isis::ShapeModel::surfaceIntersection().
|
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 Isis::EllipsoidShape::intersectSurface(), and Isis::DemShape::intersectSurface().
|
virtual |
Find the intersection point.
observerPos | observer (likely a spacecraft) position in Body-Fixed coordinates. |
lookDirection | observer (likely a spacecraft) look vector in Body- Fixed coordinates. |
Implements Isis::ShapeModel.
Definition at line 71 of file PlaneShape.cpp.
References Isis::NaifStatus::CheckErrors(), Isis::SurfacePoint::FromNaifArray(), Isis::ShapeModel::setHasIntersection(), Isis::ShapeModel::setNormal(), and Isis::ShapeModel::surfaceIntersection().
|
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 131 of file PlaneShape.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().
Gets the local radius for the given latitude/longitude coordinate.
For the plane shape model, this is calculated by finding the distance of the surface intersection point from the plane's origin.
Implements Isis::ShapeModel.
Definition at line 279 of file PlaneShape.cpp.
References Isis::Distance::Kilometers, Isis::Displacement::kilometers(), and Isis::ShapeModel::surfaceIntersection().
|
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(), Isis::EllipsoidShape::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(), 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(), Isis::EllipsoidShape::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(), Isis::EllipsoidShape::EllipsoidShape(), Isis::EmbreeShapeModel::EmbreeShapeModel(), Isis::EquatorialCylindricalShape::EquatorialCylindricalShape(), Isis::NaifDskShape::NaifDskShape(), and 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(), Isis::EllipsoidShape::calculateLocalNormal(), Isis::DemShape::calculateLocalNormal(), Isis::NaifDskShape::calculateSurfaceNormal(), Isis::EmbreeShapeModel::calculateSurfaceNormal(), Isis::BulletShapeModel::calculateSurfaceNormal(), Isis::EmbreeShapeModel::incidenceAngle(), 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(), Isis::EllipsoidShape::calculateLocalNormal(), Isis::DemShape::calculateLocalNormal(), Isis::Sensor::Coordinate(), Isis::NaifDskShape::ellipsoidNormal(), Isis::EmbreeShapeModel::ellipsoidNormal(), Isis::BulletShapeModel::ellipsoidNormal(), emissionAngle(), Isis::Sensor::GetLatitude(), Isis::Sensor::GetLongitude(), Isis::Sensor::GetSurfacePoint(), incidenceAngle(), Isis::EquatorialCylindricalShape::intersectSurface(), intersectSurface(), Isis::DemShape::intersectSurface(), Isis::EmbreeShapeModel::isVisibleFrom(), 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(), Isis::EllipsoidShape::calculateLocalNormal(), Isis::EmbreeShapeModel::ellipsoidNormal(), Isis::NaifDskShape::ellipsoidNormal(), Isis::BulletShapeModel::ellipsoidNormal(), Isis::EquatorialCylindricalShape::intersectSurface(), and Isis::EllipsoidShape::localRadius().