Isis Developer Reference
|
Define shapes and provide utilities for Isis 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. | |
ShapeModel (Target *target) | |
Constructs and loads a shape model from a target only. | |
void | Initialize () |
Initializes the ShapeModel private variables. | |
virtual | ~ShapeModel ()=0 |
Virtual destructor to destroy the ShapeModel object. | |
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. | |
virtual bool | intersectSurface (const SurfacePoint &surfpt, const std::vector< double > &observerPos, const bool &backCheck=true) |
Compute surface intersection with optional occlusion check. | |
virtual SurfacePoint * | surfaceIntersection () const |
Returns the surface intersection for this ShapeModel. | |
bool | hasIntersection () |
Returns intersection status. | |
bool | hasNormal () const |
Returns surface point normal status. | |
bool | hasLocalNormal () const |
Returns surface point local normal status. | |
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. | |
virtual double | emissionAngle (const std::vector< double > &sB) |
Computes and returns emission angle, in degrees, given the observer position. | |
virtual double | incidenceAngle (const std::vector< double > &uB) |
Computes and returns incidence angle, in degrees, given the illuminator position. | |
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. | |
virtual Distance | localRadius (const Latitude &lat, const Longitude &lon)=0 |
virtual bool | isDEM () const =0 |
Indicates whether this shape model is from a DEM. | |
QString | name () const |
Gets the shape name. | |
void | setHasIntersection (bool b) |
Sets the flag to indicate whether this ShapeModel has an intersection. | |
virtual void | setSurfacePoint (const SurfacePoint &surfacePoint) |
Set surface intersection point. | |
virtual std::vector< double > | normal () |
Returns the surface normal at the current intersection point. | |
virtual std::vector< double > | localNormal () |
Returns the local surface normal at the current intersection point. | |
virtual bool | isVisibleFrom (const std::vector< double > observerPos, const std::vector< double > lookDirection) |
Default occulsion implementation. | |
Protected Member Functions | |
void | setNormal (const std::vector< double >) |
Sets the surface normal for the currect intersection point. | |
void | setNormal (const double a, const double b, const double c) |
Sets the surface normal for the currect intersection point. | |
void | setLocalNormal (const std::vector< double >) |
Sets the local normal for the currect intersection point. | |
void | setLocalNormal (const double a, const double b, const double c) |
Sets the local normal for the currect intersection point. | |
void | setName (QString name) |
Sets the shape name. | |
void | calculateEllipsoidalSurfaceNormal () |
Calculates the ellipsoidal surface normal. | |
bool | hasEllipsoidIntersection () |
Returns the status of the ellipsoid model intersection. | |
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). | |
bool | hasValidTarget () const |
Returns the status of the target. | |
std::vector< Distance > | targetRadii () const |
Returns the radii of the body in km. | |
void | setHasNormal (bool status) |
Sets the flag to indicate whether this ShapeModel has a surface normal. | |
void | setHasLocalNormal (bool status) |
Sets the flag to indicate whether this ShapeModel has a local normal. | |
double | resolution () |
Convenience method to get pixel resolution (m/pix) at current intersection point. | |
Define shapes and provide utilities for Isis targets.
This base class will define shapes of Isis target bodies as well as provide utilities to retrieve radii and photometric information.
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.
References Initialize().
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. |
References Initialize().
|
pure virtual |
Virtual destructor to destroy the ShapeModel object.
|
pure virtual |
Implemented in Isis::BulletShapeModel, Isis::DemShape, Isis::EllipsoidShape, Isis::EmbreeShapeModel, Isis::NaifDskShape, and Isis::PlaneShape.
Referenced by emissionAngle(), and incidenceAngle().
|
protected |
Calculates the ellipsoidal surface normal.
References _FILEINFO_, Isis::IException::Programmer, and surfaceIntersection().
|
pure virtual |
Implemented in Isis::BulletShapeModel, Isis::DemShape, Isis::EllipsoidShape, Isis::EmbreeShapeModel, Isis::NaifDskShape, and Isis::PlaneShape.
Referenced by Isis::IsisShape::intersect().
|
pure virtual |
Implemented in Isis::BulletShapeModel, Isis::DemShape, Isis::EllipsoidShape, Isis::EmbreeShapeModel, Isis::NaifDskShape, and Isis::PlaneShape.
Referenced by Isis::IsisShape::intersect().
|
virtual |
Clears or resets the current surface point.
Reimplemented in Isis::BulletShapeModel, and Isis::EmbreeShapeModel.
References setHasIntersection().
Referenced by Isis::EmbreeShapeModel::clearSurfacePoint(), intersectEllipsoid(), Isis::Camera::SetGround(), Isis::CSMCamera::SetGround(), Isis::Sensor::SetGround(), Isis::Camera::SetImage(), Isis::Camera::SetImage(), Isis::Sensor::SetUniversalGround(), and Isis::Sensor::SetUniversalGround().
|
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.
References calculateDefaultNormal(), hasNormal(), Isis::RAD2DEG, and surfaceIntersection().
Referenced by isVisibleFrom().
|
protected |
Returns the status of the ellipsoid model intersection.
bool Isis::ShapeModel::hasIntersection | ( | ) |
Returns intersection status.
Referenced by Isis::DemShape::calculateDefaultNormal(), Isis::BulletShapeModel::calculateLocalNormal(), Isis::EllipsoidShape::calculateLocalNormal(), Isis::EmbreeShapeModel::calculateLocalNormal(), Isis::NaifDskShape::calculateLocalNormal(), Isis::BulletShapeModel::ellipsoidNormal(), Isis::EmbreeShapeModel::ellipsoidNormal(), Isis::NaifDskShape::ellipsoidNormal(), Isis::EmbreeShapeModel::intersectSurface(), Isis::BulletShapeModel::intersectSurface(), Isis::EmbreeShapeModel::intersectSurface(), Isis::BulletShapeModel::intersectSurface(), Isis::DemShape::intersectSurface(), Isis::EmbreeShapeModel::intersectSurface(), Isis::EquatorialCylindricalShape::intersectSurface(), isVisibleFrom(), Isis::CSMCamera::SetGround(), Isis::BulletShapeModel::setLocalNormalFromIntercept(), and Isis::NaifDskShape::setLocalNormalFromIntercept().
bool Isis::ShapeModel::hasLocalNormal | ( | ) | const |
Returns surface point local normal status.
bool Isis::ShapeModel::hasNormal | ( | ) | const |
Returns surface point normal status.
Referenced by emissionAngle(), Isis::EmbreeShapeModel::incidenceAngle(), and incidenceAngle().
|
protected |
Returns the status of the target.
If it is NULL, this method returns false.
Referenced by Isis::BulletShapeModel::ellipsoidNormal(), Isis::EmbreeShapeModel::ellipsoidNormal(), Isis::NaifDskShape::ellipsoidNormal(), resolution(), and targetRadii().
|
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.
References calculateDefaultNormal(), hasNormal(), Isis::RAD2DEG, and surfaceIntersection().
Referenced by Isis::EmbreeShapeModel::incidenceAngle().
void Isis::ShapeModel::Initialize | ( | ) |
Initializes the ShapeModel private variables.
Referenced by ShapeModel(), and ShapeModel().
|
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. |
References Isis::NaifStatus::CheckErrors(), clearSurfacePoint(), Isis::SurfacePoint::FromNaifArray(), and targetRadii().
Referenced by Isis::DemShape::intersectSurface(), and Isis::EllipsoidShape::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::EmbreeShapeModel, and Isis::BulletShapeModel.
References intersectSurface(), and localRadius().
|
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::EmbreeShapeModel, Isis::NaifDskShape, and Isis::BulletShapeModel.
References setSurfacePoint().
|
pure virtual |
Implemented in Isis::BulletShapeModel, Isis::DemShape, Isis::EllipsoidShape, Isis::EmbreeShapeModel, Isis::EquatorialCylindricalShape, Isis::NaifDskShape, and Isis::PlaneShape.
Referenced by Isis::IsisShape::intersect(), intersectSurface(), Isis::CSMCamera::SetGround(), Isis::Sensor::SetGround(), Isis::Sensor::SetUniversalGround(), and Isis::Sensor::SetUniversalGround().
|
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::BulletShapeModel, Isis::DemShape, Isis::EllipsoidShape, Isis::EmbreeShapeModel, Isis::NaifDskShape, and Isis::PlaneShape.
Referenced by Isis::IsisShape::intersect().
|
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.
References emissionAngle(), and hasIntersection().
|
virtual |
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 hasLocalNormal() method to verify before calling this method.
References _FILEINFO_, and Isis::IException::Unknown.
Referenced by Isis::EllipsoidShape::calculateSurfaceNormal(), and Isis::EmbreeShapeModel::incidenceAngle().
|
pure virtual |
Implemented in Isis::BulletShapeModel, Isis::DemShape, Isis::EllipsoidShape, Isis::EmbreeShapeModel, Isis::NaifDskShape, and Isis::PlaneShape.
Referenced by intersectSurface().
QString Isis::ShapeModel::name | ( | ) | const |
Gets the shape name.
Referenced by Isis::Target::restoreShape(), Isis::Camera::SetGround(), Isis::CSMCamera::SetGround(), and setName().
|
virtual |
Returns the 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.
References _FILEINFO_, and Isis::IException::Unknown.
Referenced by Isis::DemShape::calculateDefaultNormal(), Isis::DemShape::calculateLocalNormal(), Isis::EllipsoidShape::calculateLocalNormal(), Isis::EmbreeShapeModel::incidenceAngle(), Isis::IsisShape::intersect(), setLocalNormal(), Isis::BulletShapeModel::setLocalNormalFromIntercept(), and setNormal().
|
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. |
References Isis::RAD2DEG, and surfaceIntersection().
|
protected |
Convenience method to get pixel resolution (m/pix) at current intersection point.
References _FILEINFO_, hasValidTarget(), Isis::IException::Programmer, Isis::Spice::resolution(), and Isis::Target::spice().
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. |
References setHasLocalNormal(), and setHasNormal().
Referenced by clearSurfacePoint(), Isis::DemShape::intersectSurface(), Isis::EmbreeShapeModel::intersectSurface(), Isis::EquatorialCylindricalShape::intersectSurface(), Isis::PlaneShape::intersectSurface(), and Isis::CSMCamera::SetGround().
|
protected |
Sets the flag to indicate whether this ShapeModel has a local normal.
status | Indicates whether there is a normal. |
Referenced by Isis::DemShape::calculateLocalNormal(), Isis::EllipsoidShape::calculateLocalNormal(), Isis::EmbreeShapeModel::clearSurfacePoint(), setHasIntersection(), and setSurfacePoint().
|
protected |
Sets the flag to indicate whether this ShapeModel has a surface normal.
status | Indicates whether there is a normal. |
Referenced by Isis::DemShape::calculateDefaultNormal(), Isis::EmbreeShapeModel::clearSurfacePoint(), setHasIntersection(), and setSurfacePoint().
|
protected |
Sets the local 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 local normal. |
b | Second coordinate value for the three dimensional local normal. |
c | Third coordinate value for the three dimensional local normal. |
References _FILEINFO_, and Isis::IException::Unknown.
|
protected |
Sets the local normal for the currect intersection point.
Note: This method will throw an error if this ShapeModel doesn't have an intersection. Use the hasIntersection() method to verify before calling this method.
normal | Three dimensional local normal vector. |
References _FILEINFO_, normal(), and Isis::IException::Unknown.
Referenced by Isis::DemShape::calculateLocalNormal(), Isis::EllipsoidShape::calculateLocalNormal(), Isis::BulletShapeModel::setLocalNormalFromIntercept(), and Isis::NaifDskShape::setLocalNormalFromIntercept().
|
protected |
Sets the shape name.
name | The name of the ShapeModel. |
References name().
Referenced by Isis::BulletShapeModel::BulletShapeModel(), Isis::BulletShapeModel::BulletShapeModel(), Isis::BulletShapeModel::BulletShapeModel(), Isis::DemShape::DemShape(), Isis::DemShape::DemShape(), Isis::EllipsoidShape::EllipsoidShape(), Isis::EllipsoidShape::EllipsoidShape(), Isis::EmbreeShapeModel::EmbreeShapeModel(), Isis::EmbreeShapeModel::EmbreeShapeModel(), Isis::EmbreeShapeModel::EmbreeShapeModel(), Isis::EquatorialCylindricalShape::EquatorialCylindricalShape(), Isis::NaifDskShape::NaifDskShape(), Isis::NaifDskShape::NaifDskShape(), Isis::PlaneShape::PlaneShape(), Isis::PlaneShape::PlaneShape(), and Isis::PlaneShape::PlaneShape().
|
protected |
Sets the surface 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. |
References _FILEINFO_, and Isis::IException::Unknown.
|
protected |
Sets the surface normal for the currect intersection point.
Note: This method will throw an error if this ShapeModel doesn't have an intersection. Use the hasIntersection() method to verify before calling this method.
normal | Three dimensional surface normal vector. |
References _FILEINFO_, normal(), and Isis::IException::Unknown.
Referenced by Isis::DemShape::calculateDefaultNormal(), Isis::BulletShapeModel::calculateSurfaceNormal(), Isis::EllipsoidShape::calculateSurfaceNormal(), Isis::EmbreeShapeModel::calculateSurfaceNormal(), Isis::NaifDskShape::calculateSurfaceNormal(), Isis::EmbreeShapeModel::incidenceAngle(), and Isis::PlaneShape::intersectSurface().
|
virtual |
Set surface intersection point.
surfacePoint | Position coordinate for the surface point. |
Reimplemented in Isis::BulletShapeModel.
References setHasLocalNormal(), and setHasNormal().
Referenced by intersectSurface(), and Isis::NaifDskShape::intersectSurface().
|
virtual |
Returns the surface intersection for this ShapeModel.
Referenced by Isis::DemShape::calculateDefaultNormal(), calculateEllipsoidalSurfaceNormal(), Isis::DemShape::calculateLocalNormal(), Isis::EllipsoidShape::calculateLocalNormal(), Isis::Sensor::Coordinate(), Isis::BulletShapeModel::ellipsoidNormal(), Isis::EmbreeShapeModel::ellipsoidNormal(), Isis::NaifDskShape::ellipsoidNormal(), Isis::PlaneShape::emissionAngle(), emissionAngle(), Isis::PlaneShape::incidenceAngle(), incidenceAngle(), Isis::IsisShape::intersect(), Isis::DemShape::intersectSurface(), Isis::EquatorialCylindricalShape::intersectSurface(), Isis::PlaneShape::intersectSurface(), Isis::EmbreeShapeModel::isVisibleFrom(), Isis::PlaneShape::localRadius(), and phaseAngle().
|
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.
References _FILEINFO_, hasValidTarget(), Isis::IException::Programmer, and Isis::Target::radii().
Referenced by Isis::DemShape::calculateDefaultNormal(), Isis::EllipsoidShape::calculateLocalNormal(), Isis::BulletShapeModel::ellipsoidNormal(), Isis::EmbreeShapeModel::ellipsoidNormal(), Isis::NaifDskShape::ellipsoidNormal(), intersectEllipsoid(), Isis::EquatorialCylindricalShape::intersectSurface(), and Isis::EllipsoidShape::localRadius().