Isis 3.0
| Home |
Define shapes and provide utilities for targets stored as Isis3 maps. More...
#include <DemShape.h>
Inherits Isis::ShapeModel.
Inherited by Isis::EquatorialCylindricalShape.
Public Member Functions | |
DemShape (Target *target, Pvl &pvl) | |
Construct a DemShape object. More... | |
DemShape () | |
Construct a DemShape object. More... | |
~DemShape () | |
Destroys the DemShape. More... | |
bool | intersectSurface (std::vector< double > observerPos, std::vector< double > lookDirection) |
Find the intersection point with the DEM. More... | |
Distance | localRadius (const Latitude &lat, const Longitude &lon) |
Gets the radius from the DEM, if we have one. More... | |
double | demScale () |
Return the scale of the DEM shape, in pixels per degree. More... | |
virtual void | calculateDefaultNormal () |
This method calculates the default normal (Ellipsoid for backwards compatability) for the DemShape. More... | |
bool | isDEM () const |
Indicates that this shape model is from a DEM. More... | |
void | calculateLocalNormal (QVector< double * > cornerNeighborPoints) |
This method calculates the local surface normal of the current intersection point. More... | |
void | calculateSurfaceNormal () |
This method calculates the surface normal of the current intersection point. More... | |
void | Initialize () |
Initializes the ShapeModel private variables. 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... | |
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... | |
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... | |
Protected Member Functions | |
Cube * | demCube () |
Returns the cube defining the shape model. More... | |
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 targets stored as Isis3 maps.
This class will define shapes of Isis3 target bodies with the shape defined by an ISIS 3 map fille (level 2 image), as well as provide utilities to retrieve radii and photometric information for the intersection point.
Construct a DemShape object.
This method creates a ShapeModel object named "DemShape" and initializes member variables from the projection shape model using the given Target and Pvl.
target | Pointer to a valid target. |
pvl | Valid ISIS cube label. |
References Isis::Cube::addCachingAlgorithm(), Isis::Interpolator::BiLinearType, Isis::PvlObject::findGroup(), Isis::PvlContainer::hasKeyword(), Isis::Interpolator::HotLine(), Isis::Interpolator::HotSample(), Isis::Cube::label(), Isis::Interpolator::Lines(), Isis::CubeManager::Open(), Isis::Cube::pixelType(), Isis::Cube::projection(), Isis::Interpolator::Samples(), Isis::ShapeModel::setName(), and Isis::PvlObject::Traverse.
Isis::DemShape::DemShape | ( | ) |
Construct a DemShape object.
This method creates a ShapeModel object named "DemShape". The member variables are set to Null.
References Isis::ShapeModel::setName().
Isis::DemShape::~DemShape | ( | ) |
Destroys the DemShape.
|
virtual |
This method calculates the default normal (Ellipsoid for backwards compatability) for the DemShape.
Implements Isis::ShapeModel.
References Isis::ShapeModel::calculateEllipsoidalSurfaceNormal().
|
protectedinherited |
Calculates the ellipsoidal surface normal.
References _FILEINFO_.
Referenced by Isis::EllipsoidShape::calculateDefaultNormal(), calculateDefaultNormal(), Isis::EllipsoidShape::calculateSurfaceNormal(), and calculateSurfaceNormal().
|
virtual |
This method calculates the local surface normal of the current intersection point.
neighborPoints |
Implements Isis::ShapeModel.
References Isis::ShapeModel::normal(), Isis::ShapeModel::setHasNormal(), Isis::ShapeModel::setNormal(), Isis::ShapeModel::surfaceIntersection(), and Isis::SurfacePoint::ToNaifArray().
|
virtual |
This method calculates the surface normal of the current intersection point.
Implements Isis::ShapeModel.
References Isis::ShapeModel::calculateEllipsoidalSurfaceNormal().
|
inherited |
Clears or resets the current surface point.
Referenced by Isis::Sensor::SetGround(), Isis::Camera::SetGround(), Isis::Camera::SetImage(), Isis::Sensor::setTime(), Isis::Sensor::SetUniversalGround(), and Isis::Camera::SetUniversalGround().
|
protected |
Returns the cube defining the shape model.
Returns the DEM Cube object.
Referenced by Isis::EquatorialCylindricalShape::EquatorialCylindricalShape().
double Isis::DemShape::demScale | ( | ) |
Return the scale of the DEM shape, in pixels per degree.
Referenced by Isis::EquatorialCylindricalShape::intersectSurface().
|
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::EllipsoidShape::calculateLocalNormal(), Isis::NaifDskShape::calculateLocalNormal(), Isis::NaifDskShape::ellipsoidNormal(), Isis::Camera::GetLocalNormal(), Isis::Sensor::HasSurfaceIntersection(), Isis::EquatorialCylindricalShape::intersectSurface(), intersectSurface(), and Isis::NaifDskShape::setLocalNormalFromIntercept().
|
inherited |
Returns surface point normal status.
Referenced by Isis::Camera::GetLocalNormal().
|
protectedinherited |
Returns the status of the target.
If it is NULL, this method returns false.
Referenced by Isis::NaifDskShape::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::PlaneShape.
References Isis::RAD2DEG().
Referenced by Isis::Sensor::IncidenceAngle().
|
inherited |
Initializes the ShapeModel private variables.
|
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 intersectSurface().
|
virtual |
Find the intersection point with the DEM.
TIDBIT: From the code below we have historically tested to see if we can first intersect the ellipsoid. If not then we assumed that we could not intersect the DEM. This of course isn't always true as the DEM could be above the surface of the ellipsoid. For most images we really wouldn't notice. It has recently (Aug 2011) come into play trying to intersect images containing a limb and spiceinit'ed with a DEM (e.g., Vesta and soon Mercury). This implies that info at the limb will not always be computed. In the future we may want to do a better job handling this special case.
observerPos | |
lookDirection |
Implements Isis::ShapeModel.
Reimplemented in Isis::EquatorialCylindricalShape.
References Isis::NaifStatus::CheckErrors(), Isis::Angle::Degrees, Isis::SurfacePoint::FromNaifArray(), Isis::SurfacePoint::GetX(), Isis::SurfacePoint::GetY(), Isis::SurfacePoint::GetZ(), Isis::ShapeModel::hasIntersection(), Isis::ShapeModel::intersectEllipsoid(), Isis::IsSpecial(), Isis::Displacement::kilometers(), Isis::Distance::kilometers(), localRadius(), Isis::RAD2DEG(), Isis::ShapeModel::resolution(), Isis::ShapeModel::setHasIntersection(), and Isis::ShapeModel::surfaceIntersection().
Referenced by Isis::EquatorialCylindricalShape::intersectSurface().
|
virtual |
Indicates that this shape model is from a DEM.
Since this method returns true for this class, the Camera class will calculate the local normal using neighbor points. This method is pure virtual and must be implemented by all DemShape classes. This parent implementation returns true.
Implements Isis::ShapeModel.
Gets the radius from the DEM, if we have one.
Implements Isis::ShapeModel.
References Isis::Angle::degrees(), Isis::Buffer::DoubleBuffer(), Isis::Interpolator::Interpolate(), Isis::Angle::isValid(), Isis::Distance::Meters, Isis::Cube::read(), Isis::Portal::SetPosition(), Isis::Projection::SetUniversalGround(), Isis::Projection::WorldX(), and Isis::Projection::WorldY().
Referenced by Isis::EquatorialCylindricalShape::intersectSurface(), and intersectSurface().
|
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::EllipsoidShape::calculateLocalNormal(), calculateLocalNormal(), and Isis::Camera::GetLocalNormal().
|
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 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(), intersectSurface(), Isis::PlaneShape::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::EllipsoidShape::calculateLocalNormal(), and calculateLocalNormal().
|
protectedinherited |
Sets the shape name.
name | The name of the ShapeModel. |
Referenced by DemShape(), Isis::EllipsoidShape::EllipsoidShape(), 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. |
References _FILEINFO_.
Referenced by Isis::EllipsoidShape::calculateLocalNormal(), calculateLocalNormal(), Isis::NaifDskShape::calculateSurfaceNormal(), Isis::PlaneShape::intersectSurface(), and Isis::NaifDskShape::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_.
|
inherited |
Set surface intersection point.
surfacePoint | Position coordinate for the surface point. |
Referenced by Isis::NaifDskShape::intersectSurface(), Isis::RadarGroundMap::SetGround(), and Isis::Sensor::SetGround().
|
inherited |
Returns the surface intersection for this ShapeModel.
Referenced by Isis::EllipsoidShape::calculateLocalNormal(), calculateLocalNormal(), Isis::Sensor::Coordinate(), Isis::NaifDskShape::ellipsoidNormal(), Isis::PlaneShape::emissionAngle(), Isis::Sensor::GetLatitude(), Isis::Sensor::GetLongitude(), Isis::Sensor::GetSurfacePoint(), Isis::PlaneShape::incidenceAngle(), Isis::EquatorialCylindricalShape::intersectSurface(), intersectSurface(), Isis::PlaneShape::intersectSurface(), Isis::PlaneShape::localRadius(), Isis::Sensor::LocalRadius(), Isis::Sensor::SetUniversalGround(), 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::EllipsoidShape::calculateLocalNormal(), Isis::NaifDskShape::ellipsoidNormal(), Isis::EquatorialCylindricalShape::intersectSurface(), and Isis::EllipsoidShape::localRadius().