Isis Developer Reference
Isis::EquatorialCylindricalShape Class Reference

Define shapes and provide utilities for shapes stored as ISIS EquatorialCylindrical map. More...

#include <EquatorialCylindricalShape.h>

Inheritance diagram for Isis::EquatorialCylindricalShape:
Inheritance graph
Collaboration diagram for Isis::EquatorialCylindricalShape:
Collaboration graph

Public Member Functions

 EquatorialCylindricalShape (Target *target, Pvl &pvl)
 Initialize the ISIS Equatorial Cylindrical shape model.
 
 ~EquatorialCylindricalShape ()
 Destructor for ISIS Equatorial Cylindrical shape model.
 
bool intersectSurface (std::vector< double > observerPos, std::vector< double > lookDirection)
 Finds the surface intersection point.
 
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.
 
Distance localRadius (const Latitude &lat, const Longitude &lon)
 Gets the radius from the DEM, if we have one.
 
double demScale ()
 Return the scale of the DEM shape, in pixels per degree.
 
virtual void calculateDefaultNormal ()
 This method calculates the default normal (Ellipsoid for backwards compatability) for the DemShape.
 
bool isDEM () const
 Indicates that this shape model is from a DEM.
 
void calculateLocalNormal (QVector< double * > cornerNeighborPoints)
 This method calculates the local surface normal of the current intersection point.
 
void calculateSurfaceNormal ()
 This method calculates the surface normal of the current intersection point.
 
void Initialize ()
 Initializes the ShapeModel private variables.
 
virtual SurfacePointsurfaceIntersection () 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 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.
 
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

CubedemCube ()
 Returns the cube defining the shape model.
 
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< DistancetargetRadii () 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.
 

Detailed Description

Define shapes and provide utilities for shapes stored as ISIS EquatorialCylindrical map.

This class will define shapes of ISIS target bodies with the shape defined by an EquatorialCylindrical map, as well as provide utilities to retrieve radii and photometric information for the intersection point.

Author
2010-07-30 Debbie A. Cook

Constructor & Destructor Documentation

◆ EquatorialCylindricalShape()

Isis::EquatorialCylindricalShape::EquatorialCylindricalShape ( Target * target,
Pvl & pvl )

Initialize the ISIS Equatorial Cylindrical shape model.

Parameters
pvlValid ISIS cube label.

References _FILEINFO_, Isis::DemShape::demCube(), Isis::Distance::Kilometers, Isis::ShapeModel::setName(), and Isis::IException::User.

◆ ~EquatorialCylindricalShape()

Isis::EquatorialCylindricalShape::~EquatorialCylindricalShape ( )

Destructor for ISIS Equatorial Cylindrical shape model.

Member Function Documentation

◆ calculateDefaultNormal()

void Isis::DemShape::calculateDefaultNormal ( )
virtualinherited

◆ calculateEllipsoidalSurfaceNormal()

void Isis::ShapeModel::calculateEllipsoidalSurfaceNormal ( )
protectedinherited

Calculates the ellipsoidal surface normal.

References _FILEINFO_, Isis::IException::Programmer, and Isis::ShapeModel::surfaceIntersection().

◆ calculateLocalNormal()

void Isis::DemShape::calculateLocalNormal ( QVector< double * > neighborPoints)
virtualinherited

This method calculates the local surface normal of the current intersection point.

Parameters
neighborPoints

Implements Isis::ShapeModel.

References Isis::ShapeModel::normal(), Isis::ShapeModel::setHasLocalNormal(), Isis::ShapeModel::setLocalNormal(), and Isis::ShapeModel::surfaceIntersection().

◆ calculateSurfaceNormal()

void Isis::DemShape::calculateSurfaceNormal ( )
virtualinherited

This method calculates the surface normal of the current intersection point.

Implements Isis::ShapeModel.

References Isis::DemShape::calculateDefaultNormal().

◆ clearSurfacePoint()

◆ demCube()

Cube * Isis::DemShape::demCube ( )
protectedinherited

Returns the cube defining the shape model.

Returns the DEM Cube object.

Returns
Cube* A pointer to the DEM cube associated with this shape model.

Referenced by EquatorialCylindricalShape().

◆ demScale()

double Isis::DemShape::demScale ( )
inherited

Return the scale of the DEM shape, in pixels per degree.

Returns
double The scale of the DEM.

Referenced by intersectSurface().

◆ emissionAngle()

double Isis::ShapeModel::emissionAngle ( const std::vector< double > & observerBodyFixedPosition)
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.

Parameters
observerBodyFixedPositionThree dimensional position of the observer, in the coordinate system of the target body.
Returns
The emission angle, in decimal degrees.

Reimplemented in Isis::PlaneShape.

References Isis::ShapeModel::calculateDefaultNormal(), Isis::ShapeModel::hasNormal(), Isis::RAD2DEG, and Isis::ShapeModel::surfaceIntersection().

Referenced by Isis::ShapeModel::isVisibleFrom().

◆ hasEllipsoidIntersection()

bool Isis::ShapeModel::hasEllipsoidIntersection ( )
protectedinherited

Returns the status of the ellipsoid model intersection.

Returns
bool Indicates whether this shape model has a valid ellipsoid intersection.

◆ hasIntersection()

◆ hasLocalNormal()

bool Isis::ShapeModel::hasLocalNormal ( ) const
inherited

Returns surface point local normal status.

Returns
Indicates whether this ShapeModel has a surface normal.

◆ hasNormal()

bool Isis::ShapeModel::hasNormal ( ) const
inherited

Returns surface point normal status.

Returns
Indicates whether this ShapeModel has a surface normal.

Referenced by Isis::ShapeModel::emissionAngle(), Isis::EmbreeShapeModel::incidenceAngle(), and Isis::ShapeModel::incidenceAngle().

◆ hasValidTarget()

bool Isis::ShapeModel::hasValidTarget ( ) const
protectedinherited

Returns the status of the target.

If it is NULL, this method returns false.

Returns
Indicates whether the target is valid.

Referenced by Isis::BulletShapeModel::ellipsoidNormal(), Isis::EmbreeShapeModel::ellipsoidNormal(), Isis::NaifDskShape::ellipsoidNormal(), Isis::ShapeModel::resolution(), and Isis::ShapeModel::targetRadii().

◆ incidenceAngle()

double Isis::ShapeModel::incidenceAngle ( const std::vector< double > & illuminatorBodyFixedPosition)
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.

Parameters
illuminatorBodyFixedPositionThree dimensional position for the illuminator, in the body-fixed coordinate system.
Returns
double Incidence angle, in degrees.

Reimplemented in Isis::EmbreeShapeModel, and Isis::PlaneShape.

References Isis::ShapeModel::calculateDefaultNormal(), Isis::ShapeModel::hasNormal(), Isis::RAD2DEG, and Isis::ShapeModel::surfaceIntersection().

Referenced by Isis::EmbreeShapeModel::incidenceAngle().

◆ Initialize()

void Isis::ShapeModel::Initialize ( )
inherited

Initializes the ShapeModel private variables.

Referenced by Isis::ShapeModel::ShapeModel(), and Isis::ShapeModel::ShapeModel().

◆ intersectEllipsoid()

bool Isis::ShapeModel::intersectEllipsoid ( const std::vector< double > observerBodyFixedPosition,
const std::vector< double > & observerLookVectorToTarget )
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).

Parameters
observerBodyFixedPositionThree dimensional position of the observer, in the coordinate system of the target body.
observerLookVectorToTargetThree dimensional direction vector from the observer to the target.
Returns
bool Indicates whether this shape model found a valid ellipsoid intersection.

References Isis::NaifStatus::CheckErrors(), Isis::ShapeModel::clearSurfacePoint(), Isis::SurfacePoint::FromNaifArray(), and Isis::ShapeModel::targetRadii().

Referenced by Isis::DemShape::intersectSurface(), and Isis::EllipsoidShape::intersectSurface().

◆ intersectSurface() [1/3]

bool Isis::ShapeModel::intersectSurface ( const Latitude & lat,
const Longitude & lon,
const std::vector< double > & observerPos,
const bool & backCheck = true )
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.

Author
2017-03-23 Kris Becker
Parameters
latLatitude of the surface point
lonLongitude of the surface point
observerPosPosition of the observer
backCheckFlag to indicate occlusion check
Returns
bool True if the intersection point is valid (visable)

Reimplemented in Isis::EmbreeShapeModel, and Isis::BulletShapeModel.

References Isis::ShapeModel::intersectSurface(), and Isis::ShapeModel::localRadius().

◆ intersectSurface() [2/3]

bool Isis::ShapeModel::intersectSurface ( const SurfacePoint & surfpt,
const std::vector< double > & observerPos,
const bool & backCheck = true )
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.

Author
2017-03-23 Kris Becker
Parameters
surfptAbsolute point on the surface to check
observerPosPosition of the observer
backCheckFlag to indicate occlusion check
Returns
bool True if the intersection point is valid (visable)

Reimplemented in Isis::EmbreeShapeModel, Isis::NaifDskShape, and Isis::BulletShapeModel.

References Isis::ShapeModel::setSurfacePoint().

◆ intersectSurface() [3/3]

bool Isis::EquatorialCylindricalShape::intersectSurface ( std::vector< double > observerPos,
std::vector< double > lookDirection )
virtual

Finds the surface intersection point.

Parameters
observerBodyFixedPositionThree dimensional position of the observer, in the coordinate system of the target body.
observerLookVectorToTargetThree dimensional direction vector from the observer to the target.
Returns
bool Indicates whether this shape model found a valid surface intersection.

Reimplemented from Isis::DemShape.

References Isis::NaifStatus::CheckErrors(), Isis::DEG2RAD, Isis::Angle::Degrees, Isis::DemShape::demScale(), Isis::E, Isis::ShapeModel::hasIntersection(), Isis::DemShape::intersectSurface(), Isis::IsSpecial(), Isis::Distance::kilometers(), Isis::DemShape::localRadius(), MAX, Isis::PI, Isis::RAD2DEG, Isis::ShapeModel::setHasIntersection(), Isis::ShapeModel::surfaceIntersection(), and Isis::ShapeModel::targetRadii().

◆ isDEM()

bool Isis::DemShape::isDEM ( ) const
virtualinherited

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.

Returns
bool Indicates that this is a DEM shape model.

Implements Isis::ShapeModel.

◆ isVisibleFrom()

bool Isis::ShapeModel::isVisibleFrom ( const std::vector< double > observerPos,
const std::vector< double > lookDirection )
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!

Author
2017-03-17 Kris Becker
Parameters
observerPosPosition of the observer in body fixed coordinates
lookDirectionLook direction from the observer
Returns
bool True if the point is not visable, false if it can be seen

Reimplemented in Isis::BulletShapeModel, and Isis::EmbreeShapeModel.

References Isis::ShapeModel::emissionAngle(), and Isis::ShapeModel::hasIntersection().

◆ localNormal()

std::vector< double > Isis::ShapeModel::localNormal ( )
virtualinherited

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.

See also
hasLocalNormal()
Returns
A local surface normal vector, if it exists.

References _FILEINFO_, and Isis::IException::Unknown.

Referenced by Isis::EllipsoidShape::calculateSurfaceNormal(), and Isis::EmbreeShapeModel::incidenceAngle().

◆ localRadius()

Distance Isis::DemShape::localRadius ( const Latitude & lat,
const Longitude & lon )
virtualinherited

◆ name()

QString Isis::ShapeModel::name ( ) const
inherited

Gets the shape name.

Returns
QString The name of the ShapeModel.

Referenced by Isis::Target::restoreShape(), Isis::Camera::SetGround(), Isis::CSMCamera::SetGround(), and Isis::ShapeModel::setName().

◆ normal()

std::vector< double > Isis::ShapeModel::normal ( )
virtualinherited

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.

See also
hasNormal()
Returns
A surface normal vector, if it exists.

References _FILEINFO_, and Isis::IException::Unknown.

Referenced by Isis::DemShape::calculateDefaultNormal(), Isis::DemShape::calculateLocalNormal(), Isis::EllipsoidShape::calculateLocalNormal(), Isis::EmbreeShapeModel::incidenceAngle(), Isis::IsisShape::intersect(), Isis::ShapeModel::setLocalNormal(), Isis::BulletShapeModel::setLocalNormalFromIntercept(), and Isis::ShapeModel::setNormal().

◆ phaseAngle()

double Isis::ShapeModel::phaseAngle ( const std::vector< double > & observerBodyFixedPosition,
const std::vector< double > & illuminatorBodyFixedPosition )
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).

Parameters
observerBodyFixedPositionThree dimensional position of the observer, in the coordinate system of the target body.
illuminatorBodyFixedPositionThree dimensional position for the illuminator, in the body-fixed coordinate system.
Returns
double Phase angle, in degrees.

References Isis::RAD2DEG, and Isis::ShapeModel::surfaceIntersection().

◆ resolution()

double Isis::ShapeModel::resolution ( )
protectedinherited

Convenience method to get pixel resolution (m/pix) at current intersection point.

Returns
@double The pixel resolution at the surface intersection.

References _FILEINFO_, Isis::ShapeModel::hasValidTarget(), Isis::IException::Programmer, Isis::Spice::resolution(), and Isis::Target::spice().

Referenced by Isis::DemShape::intersectSurface().

◆ setHasIntersection()

void Isis::ShapeModel::setHasIntersection ( bool b)
inherited

◆ setHasLocalNormal()

void Isis::ShapeModel::setHasLocalNormal ( bool status)
protectedinherited

Sets the flag to indicate whether this ShapeModel has a local normal.

Parameters
statusIndicates whether there is a normal.

Referenced by Isis::DemShape::calculateLocalNormal(), Isis::EllipsoidShape::calculateLocalNormal(), Isis::EmbreeShapeModel::clearSurfacePoint(), Isis::ShapeModel::setHasIntersection(), and Isis::ShapeModel::setSurfacePoint().

◆ setHasNormal()

void Isis::ShapeModel::setHasNormal ( bool status)
protectedinherited

Sets the flag to indicate whether this ShapeModel has a surface normal.

Parameters
statusIndicates whether there is a normal.

Referenced by Isis::DemShape::calculateDefaultNormal(), Isis::EmbreeShapeModel::clearSurfacePoint(), Isis::ShapeModel::setHasIntersection(), and Isis::ShapeModel::setSurfacePoint().

◆ setLocalNormal() [1/2]

void Isis::ShapeModel::setLocalNormal ( const double a,
const double b,
const double c )
protectedinherited

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.

See also
hasIntersection()
Parameters
aFirst coordinate value for the three dimensional local normal.
bSecond coordinate value for the three dimensional local normal.
cThird coordinate value for the three dimensional local normal.

References _FILEINFO_, and Isis::IException::Unknown.

◆ setLocalNormal() [2/2]

void Isis::ShapeModel::setLocalNormal ( const std::vector< double > normal)
protectedinherited

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.

See also
hasIntersection()
Parameters
normalThree dimensional local normal vector.

References _FILEINFO_, Isis::ShapeModel::normal(), and Isis::IException::Unknown.

Referenced by Isis::DemShape::calculateLocalNormal(), Isis::EllipsoidShape::calculateLocalNormal(), Isis::BulletShapeModel::setLocalNormalFromIntercept(), and Isis::NaifDskShape::setLocalNormalFromIntercept().

◆ setName()

◆ setNormal() [1/2]

void Isis::ShapeModel::setNormal ( const double a,
const double b,
const double c )
protectedinherited

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.

See also
hasIntersection()
Parameters
aFirst coordinate value for the three dimensional surface normal.
bSecond coordinate value for the three dimensional surface normal.
cThird coordinate value for the three dimensional surface normal.

References _FILEINFO_, and Isis::IException::Unknown.

◆ setNormal() [2/2]

void Isis::ShapeModel::setNormal ( const std::vector< double > normal)
protectedinherited

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.

See also
hasIntersection()
Parameters
normalThree dimensional surface normal vector.

References _FILEINFO_, Isis::ShapeModel::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().

◆ setSurfacePoint()

void Isis::ShapeModel::setSurfacePoint ( const SurfacePoint & surfacePoint)
virtualinherited

Set surface intersection point.

Parameters
surfacePointPosition coordinate for the surface point.

Reimplemented in Isis::BulletShapeModel.

References Isis::ShapeModel::setHasLocalNormal(), and Isis::ShapeModel::setHasNormal().

Referenced by Isis::ShapeModel::intersectSurface(), and Isis::NaifDskShape::intersectSurface().

◆ surfaceIntersection()

◆ targetRadii()

std::vector< Distance > Isis::ShapeModel::targetRadii ( ) const
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.

See also
hasValidTarget()
Returns
Three dimensional vector containing the ellipsoid radii values.

References _FILEINFO_, Isis::ShapeModel::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(), Isis::ShapeModel::intersectEllipsoid(), intersectSurface(), and Isis::EllipsoidShape::localRadius().


The documentation for this class was generated from the following files: