Isis 3.0
| Home |
Define plane shape model. More...
#include <PlaneShape.h>
Inherits Isis::ShapeModel.
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... | |
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 | 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 | |
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.
Initialize the PlaneShape.
pvl | Valid Isis3 cube label. |
References Isis::ShapeModel::setName().
Isis::PlaneShape::PlaneShape | ( | Target * | target | ) |
Initialize the PlaneShape.
pvl | Valid Isis3 cube label. |
References Isis::ShapeModel::setName().
Isis::PlaneShape::PlaneShape | ( | ) |
Initialize the PlaneShape.
pvl | Valid Isis3 cube label. |
References Isis::ShapeModel::setName().
Isis::PlaneShape::~PlaneShape | ( | ) |
Destructor.
|
virtual |
There is no implementation for this method.
Implements Isis::ShapeModel.
|
protectedinherited |
Calculates the ellipsoidal surface normal.
References _FILEINFO_.
Referenced by Isis::EllipsoidShape::calculateDefaultNormal(), Isis::DemShape::calculateDefaultNormal(), Isis::EllipsoidShape::calculateSurfaceNormal(), and Isis::DemShape::calculateSurfaceNormal().
|
virtual |
There is no implementation for this method.
Implements Isis::ShapeModel.
|
virtual |
There is no implementation for this method.
Implements Isis::ShapeModel.
|
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().
|
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.
References Isis::SurfacePoint::GetX(), Isis::SurfacePoint::GetY(), Isis::SurfacePoint::GetZ(), Isis::Displacement::kilometers(), Isis::RAD2DEG(), and Isis::ShapeModel::surfaceIntersection().
|
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(), Isis::DemShape::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().
|
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.
References Isis::SurfacePoint::GetX(), Isis::SurfacePoint::GetY(), Isis::SurfacePoint::GetZ(), Isis::Displacement::kilometers(), Isis::RAD2DEG(), and Isis::ShapeModel::surfaceIntersection().
|
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 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.
References Isis::NaifStatus::CheckErrors(), Isis::SurfacePoint::FromNaifArray(), Isis::ShapeModel::setHasIntersection(), Isis::ShapeModel::setNormal(), and Isis::ShapeModel::surfaceIntersection().
|
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.
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.
References Isis::SurfacePoint::GetX(), Isis::SurfacePoint::GetY(), Isis::SurfacePoint::GetZ(), Isis::Distance::Kilometers, Isis::Displacement::kilometers(), and Isis::ShapeModel::surfaceIntersection().
|
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(), Isis::DemShape::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 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::DemShape::intersectSurface(), 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 Isis::DemShape::calculateLocalNormal().
|
protectedinherited |
Sets the shape name.
name | The name of the ShapeModel. |
Referenced by Isis::DemShape::DemShape(), Isis::EllipsoidShape::EllipsoidShape(), 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. |
References _FILEINFO_.
Referenced by Isis::EllipsoidShape::calculateLocalNormal(), Isis::DemShape::calculateLocalNormal(), Isis::NaifDskShape::calculateSurfaceNormal(), 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(), Isis::DemShape::calculateLocalNormal(), Isis::Sensor::Coordinate(), Isis::NaifDskShape::ellipsoidNormal(), emissionAngle(), Isis::Sensor::GetLatitude(), Isis::Sensor::GetLongitude(), Isis::Sensor::GetSurfacePoint(), incidenceAngle(), Isis::EquatorialCylindricalShape::intersectSurface(), Isis::DemShape::intersectSurface(), intersectSurface(), 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().