Isis 3 Developer Reference
|
Provides support for NAIF's Digital Shape Kernel (DSK) More...
#include <NaifDskShape.h>
Public Member Functions | |
NaifDskShape () | |
Generic constructor sets type to a TIN. More... | |
NaifDskShape (Target *target, Pvl &pvl) | |
Constructor provided for instantiation from an ISIS cube. More... | |
NaifDskShape (const NaifDskPlateModel &model) | |
Constructor for creating new shape model from the same DSK file. More... | |
~NaifDskShape () | |
Destructor - cleanup is handled automagically. More... | |
bool | intersectSurface (std::vector< double > observerPos, std::vector< double > lookDirection) |
Compute a DEM intersection from and observer and look direction. More... | |
void | calculateDefaultNormal () |
Return the surface normal of the ellipsoid as the default. More... | |
bool | isDEM () const |
Indicates that this shape model is not from a DEM. More... | |
void | setLocalNormalFromIntercept () |
Set the normal vector to the intercept point normal. More... | |
void | calculateLocalNormal (QVector< double *> cornerNeighborPoints) |
Compute the normal for a local region of surface points. More... | |
void | calculateSurfaceNormal () |
Return the surface normal of the ellipsi=oud. More... | |
Distance | localRadius (const Latitude &lat, const Longitude &lon) |
Determine DEM radius at a given lat/lon grid point. More... | |
QVector< double > | ellipsoidNormal () |
Compute the true surface normal vector of an ellipsoid. More... | |
const NaifDskPlateModel & | model () const |
Returns a direct reference to the DSK plate model file interface. More... | |
const Intercept * | intercept () const |
Returns a pointer to the current intercept. 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... | |
Isis::NaifDskShape::NaifDskShape | ( | ) |
Generic constructor sets type to a TIN.
References Isis::ShapeModel::setName().
Constructor provided for instantiation from an ISIS cube.
This constructor is typically used for and ISIS cube that has been initialized by spiceinit. The DEM name should be that of a NAIF DSK file. This constructor will throw an exception if it fails to open the DSK file.
target | Target object describing the observed body |
pvl | ISIS Cube label. Extract the name of the DEM from the Kernels group |
References Isis::PvlObject::findGroup(), Isis::PvlContainer::hasKeyword(), Isis::ShapeModel::setName(), and Isis::PvlObject::Traverse.
Isis::NaifDskShape::NaifDskShape | ( | const NaifDskPlateModel & | model | ) |
Constructor for creating new shape model from the same DSK file.
This constructor provides the ability to create a formal shape model from the NAIF DSK plate model file already opened. This approach allows multiple threads to access the same DSK file interface without the overhead of opening many instances of the same file.
model | DSK plate model from an existing NaidDskPlateModel (see the model() method |
Isis::NaifDskShape::~NaifDskShape | ( | ) |
Destructor - cleanup is handled automagically.
|
virtual |
Return the surface normal of the ellipsoid as the default.
Implements Isis::ShapeModel.
References calculateSurfaceNormal().
|
protectedinherited |
Calculates the ellipsoidal surface normal.
References _FILEINFO_.
|
virtual |
Compute the normal for a local region of surface points.
This method will calculate the surface normal of an assumed very local region of points. This method is provided to fullfil the specs of the ShapeModel class but this approach is not the most efficent means to accomplish this for a pre-exising intercept point. See setLocalNormalFromIntercept() for this.
The ShapeModel class makes the assumption that the four pixel corners of the center intercept point forms a plane from which a surface normal can be computed. For the Naif DSK plate model, we have already identified the plate (see m_intercept) from the DSK plate model (m_model) of the intercept point that provides it directly. That is what setLocalNormalFromIntercept() provides.
So, this implementation will compute the centroid of the neighboring points and make a determination if it intercepts the current intercept plate as defined by m_intercept - if it is valid. If it does not exist or does not intercept the plate, a new intercept point is computed and returned here.
neighborPoints | Input body-fixed points to compute normal for |
Implements Isis::ShapeModel.
References _FILEINFO_, Isis::ShapeModel::hasIntersection(), Isis::IException::Programmer, and setLocalNormalFromIntercept().
|
virtual |
Return the surface normal of the ellipsi=oud.
Implements Isis::ShapeModel.
References ellipsoidNormal(), and Isis::ShapeModel::setNormal().
Referenced by calculateDefaultNormal().
|
virtualinherited |
Clears or resets the current surface point.
Reimplemented in Isis::BulletShapeModel, and Isis::EmbreeShapeModel.
Referenced by Isis::EmbreeShapeModel::clearSurfacePoint(), Isis::Sensor::SetGround(), Isis::Camera::SetGround(), Isis::Camera::SetImage(), Isis::Sensor::setTime(), Isis::Sensor::SetUniversalGround(), and Isis::Camera::SetUniversalGround().
QVector< double > Isis::NaifDskShape::ellipsoidNormal | ( | ) |
Compute the true surface normal vector of an ellipsoid.
This routine is used instead of the one provided by the ShapeModel implementation. This is primarly because ShapeModel::calculateEllipsoidalSurfaceNormal() it is only suitable for a spheroid. This implementation is intended for irregular bodies so we expect triaxial ellipsoids.
References _FILEINFO_, Isis::NaifStatus::CheckErrors(), Isis::ShapeModel::hasIntersection(), Isis::ShapeModel::hasValidTarget(), Isis::IException::Programmer, Isis::ShapeModel::surfaceIntersection(), Isis::ShapeModel::targetRadii(), and Isis::SurfacePoint::ToNaifArray().
Referenced by calculateSurfaceNormal().
|
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.
References Isis::RAD2DEG.
Referenced by Isis::Sensor::EmissionAngle().
|
protectedinherited |
Returns the status of the ellipsoid model intersection.
|
inherited |
Returns intersection status.
Referenced by Isis::DemShape::calculateDefaultNormal(), calculateLocalNormal(), Isis::EllipsoidShape::calculateLocalNormal(), Isis::EmbreeShapeModel::calculateLocalNormal(), Isis::BulletShapeModel::calculateLocalNormal(), Isis::EmbreeShapeModel::ellipsoidNormal(), ellipsoidNormal(), Isis::BulletShapeModel::ellipsoidNormal(), Isis::Camera::GetLocalNormal(), Isis::Sensor::HasSurfaceIntersection(), Isis::EquatorialCylindricalShape::intersectSurface(), Isis::EmbreeShapeModel::intersectSurface(), Isis::BulletShapeModel::intersectSurface(), Isis::DemShape::intersectSurface(), setLocalNormalFromIntercept(), and Isis::BulletShapeModel::setLocalNormalFromIntercept().
|
inherited |
Returns surface point normal status.
Referenced by Isis::Camera::GetLocalNormal(), and Isis::EmbreeShapeModel::incidenceAngle().
|
protectedinherited |
Returns the status of the target.
If it is NULL, this method returns false.
Referenced by Isis::EmbreeShapeModel::ellipsoidNormal(), 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.
References Isis::RAD2DEG.
Referenced by Isis::EmbreeShapeModel::incidenceAngle(), and Isis::Sensor::IncidenceAngle().
|
inherited |
Initializes the ShapeModel private variables.
const Intercept * Isis::NaifDskShape::intercept | ( | ) | const |
Returns a pointer to the current intercept.
This method returns a const pointer to the intercept last computed from the intersectSurface() call. Note it is left to the caller to ensure it is non-NULL.
|
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. |
Referenced by Isis::EllipsoidShape::intersectSurface(), and Isis::DemShape::intersectSurface().
|
virtual |
Compute a DEM intersection from and observer and look direction.
This method computes a DEM intercept point given an observer location and direction vector in body fixed coordinates. This method provides true ray intercept techiques as implemented by NAIF's DSK API.
If the intercept is successful, its state is retain in this class for further application. Use of a scoped pointer handles the memory management and indication of success.
observerPos | Position of observer in body fixed coordiates |
lookDirection | Look direction (ray) from the observer |
Implements Isis::ShapeModel.
References Isis::NaifDskPlateModel::intercept(), and Isis::ShapeModel::setSurfacePoint().
|
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.
|
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.
|
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.
|
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.
Determine DEM radius at a given lat/lon grid point.
This method computes the radius value of a point on an ellipsoid. A vector from the center of the body through the lart/lon location on the ellipsiod. From this, a look direction back toward the center of the body is genrated and then an intercept point is determined. See NaifDskPlateMode::point() for details.
Implements Isis::ShapeModel.
References Isis::NaifDskPlateModel::point().
const NaifDskPlateModel & Isis::NaifDskShape::model | ( | ) | const |
Returns a direct reference to the DSK plate model file interface.
|
inherited |
Gets the shape name.
Referenced by Isis::UniversalGroundMap::GroundRange(), Isis::VimsGroundMap::SetGround(), and Isis::Camera::SetGround().
|
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.
References _FILEINFO_.
Referenced by Isis::DemShape::calculateDefaultNormal(), Isis::EllipsoidShape::calculateLocalNormal(), Isis::DemShape::calculateLocalNormal(), Isis::Camera::GetLocalNormal(), Isis::EmbreeShapeModel::incidenceAngle(), and Isis::BulletShapeModel::setLocalNormalFromIntercept().
|
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. |
References Isis::RAD2DEG.
Referenced by Isis::Sensor::PhaseAngle().
|
protectedinherited |
Convenience method to get pixel resolution (m/pix) at current intersection point.
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. |
Referenced by Isis::EquatorialCylindricalShape::intersectSurface(), Isis::EmbreeShapeModel::intersectSurface(), Isis::PlaneShape::intersectSurface(), Isis::DemShape::intersectSurface(), and Isis::Sensor::SetLookDirection().
|
protectedinherited |
Sets the flag to indicate whether this ShapeModel has a surface normal.
b | Indicates whether there is a normal. |
Referenced by Isis::DemShape::calculateDefaultNormal(), Isis::EllipsoidShape::calculateLocalNormal(), Isis::DemShape::calculateLocalNormal(), and Isis::EmbreeShapeModel::clearSurfacePoint().
void Isis::NaifDskShape::setLocalNormalFromIntercept | ( | ) |
Set the normal vector to the intercept point normal.
This method will reassign the ShapeModel normal to the current intecept point shape (which is a triangular plate) normal. If an intercept point is not defined, an error will ensue.
References _FILEINFO_, Isis::ShapeModel::hasIntersection(), Isis::IException::Programmer, and Isis::ShapeModel::setNormal().
Referenced by calculateLocalNormal().
|
protectedinherited |
Sets the shape name.
name | The name of the ShapeModel. |
Referenced by Isis::BulletShapeModel::BulletShapeModel(), Isis::DemShape::DemShape(), Isis::EllipsoidShape::EllipsoidShape(), Isis::EmbreeShapeModel::EmbreeShapeModel(), Isis::EquatorialCylindricalShape::EquatorialCylindricalShape(), 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. |
References _FILEINFO_.
Referenced by Isis::DemShape::calculateDefaultNormal(), Isis::EllipsoidShape::calculateLocalNormal(), Isis::DemShape::calculateLocalNormal(), calculateSurfaceNormal(), Isis::EmbreeShapeModel::calculateSurfaceNormal(), Isis::BulletShapeModel::calculateSurfaceNormal(), Isis::EmbreeShapeModel::incidenceAngle(), Isis::PlaneShape::intersectSurface(), setLocalNormalFromIntercept(), and Isis::BulletShapeModel::setLocalNormalFromIntercept().
|
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. |
References _FILEINFO_.
|
virtualinherited |
Set surface intersection point.
surfacePoint | Position coordinate for the surface point. |
Reimplemented in Isis::BulletShapeModel.
Referenced by intersectSurface(), and Isis::RadarGroundMap::SetGround().
|
inherited |
Returns the surface intersection for this ShapeModel.
Referenced by Isis::DemShape::calculateDefaultNormal(), Isis::EllipsoidShape::calculateLocalNormal(), Isis::DemShape::calculateLocalNormal(), Isis::Sensor::Coordinate(), 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::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.
References _FILEINFO_.
Referenced by Isis::DemShape::calculateDefaultNormal(), Isis::EllipsoidShape::calculateLocalNormal(), ellipsoidNormal(), Isis::EmbreeShapeModel::ellipsoidNormal(), Isis::BulletShapeModel::ellipsoidNormal(), Isis::EquatorialCylindricalShape::intersectSurface(), and Isis::EllipsoidShape::localRadius().