Isis::EquatorialCylindricalShape Class Reference

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

#include <EquatorialCylindricalShape.h>

Inherits Isis::DemShape.

Public Member Functions
	EquatorialCylindricalShape (Target *target, Pvl &pvl)
	Initialize the Isis3 Equatorial Cylindrical shape model.
	~EquatorialCylindricalShape ()
	Destructor for Isis3 Equatorial Cylindrical shape model.
bool	intersectSurface (std::vector< double > observerPos, std::vector< double > lookDirection)
	Find the intersection point.
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.
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 ()
	Initialize the ShapeModel private variables.
SurfacePoint *	surfaceIntersection () const
	Return the surface intersection.
bool	hasIntersection ()
	Return intersection status.
bool	hasNormal () const
	Return surface point normal status.
void	clearSurfacePoint ()
	Clear or reset 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)
	Returns the incidence angle in degrees.
virtual double	phaseAngle (const std::vector< double > &sB, const std::vector< double > &uB)
	Returns the phase angle in degrees.
QString	name () const
	Get the shape name.
void	setHasIntersection (bool b)
	Set m_hasIntersection;.
void	setSurfacePoint (const SurfacePoint &surfacePoint)
	Set surface intersection point.
std::vector< double >	normal ()
	Return the local normal of the current intersection point.

Protected Member Functions
Cube *	demCube ()
	Returns the cube defining the shape model.
void	setNormal (const std::vector< double >)
	Set the normal for the currect intersection point.
void	setNormal (const double a, const double b, const double c)
	Set the normal for the currect intersection point.
void	setName (QString name)
	Set the shape name.
void	calculateEllipsoidalSurfaceNormal ()
	Calculate 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)
	Find the intersection point on the ellipsoid model.
bool	hasValidTarget () const
std::vector< Distance >	targetRadii () const
	Returns the radii of the body in km.
void	setHasNormal (bool status)
	Set the hasNormal flag.
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 Isis3 EquatorialCylindrical map.

This class will define shapes of Isis3 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

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

Initialize the Isis3 Equatorial Cylindrical shape model.

Parameters

pvl	Valid Isis3 cube label.

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

Isis::EquatorialCylindricalShape::~EquatorialCylindricalShape

(

)

Destructor for Isis3 Equatorial Cylindrical shape model.

Member Function Documentation

void Isis::DemShape::calculateDefaultNormal ( )

virtualinherited

This method calculates the default normal (Ellipsoid for backwards compatability) for the DemShape.

Implements Isis::ShapeModel.

References Isis::ShapeModel::calculateEllipsoidalSurfaceNormal().

void Isis::ShapeModel::calculateEllipsoidalSurfaceNormal ( )

protectedinherited

Calculate ellipsoidal surface normal.

References _FILEINFO_.

Referenced by Isis::EllipsoidShape::calculateDefaultNormal(), Isis::DemShape::calculateDefaultNormal(), Isis::EllipsoidShape::calculateSurfaceNormal(), and Isis::DemShape::calculateSurfaceNormal().

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::setHasNormal(), Isis::ShapeModel::setNormal(), Isis::ShapeModel::surfaceIntersection(), and Isis::SurfacePoint::ToNaifArray().

void Isis::DemShape::calculateSurfaceNormal ( )

virtualinherited

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

Implements Isis::ShapeModel.

References Isis::ShapeModel::calculateEllipsoidalSurfaceNormal().

void Isis::ShapeModel::clearSurfacePoint ( )

inherited

Clear or reset 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().

Cube * Isis::DemShape::demCube ( )

protectedinherited

Returns the cube defining the shape model.

Returns the DEM Cube object.

Returns

The DEM cube associated with this shape model.

Referenced by EquatorialCylindricalShape().

double Isis::DemShape::demScale ( )

inherited

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

Returns

The scale of the DEM

Referenced by intersectSurface().

double Isis::ShapeModel::emissionAngle ( const std::vector< double > &  sB )

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 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.

Parameters

sB,:	Spacecraft position in body-fixed coordinates

Returns

Emmision angle in decimal degrees

Reimplemented in Isis::PlaneShape.

References Isis::RAD2DEG().

Referenced by Isis::Sensor::EmissionAngle().

bool Isis::ShapeModel::hasEllipsoidIntersection ( )

protectedinherited

Returns the status of the ellipsoid model intersection.

Referenced by intersectSurface().

bool Isis::ShapeModel::hasIntersection ( )

inherited

Return intersection status.

Referenced by Isis::EllipsoidShape::calculateLocalNormal(), Isis::NaifDskShape::calculateLocalNormal(), Isis::NaifDskShape::ellipsoidNormal(), Isis::Camera::GetLocalNormal(), Isis::Sensor::HasSurfaceIntersection(), intersectSurface(), Isis::DemShape::intersectSurface(), and Isis::NaifDskShape::setLocalNormalFromIntercept().

bool Isis::ShapeModel::hasNormal ( ) const

inherited

Return surface point normal status.

Referenced by Isis::Camera::GetLocalNormal().

bool Isis::ShapeModel::hasValidTarget ( ) const

protectedinherited

Referenced by Isis::NaifDskShape::ellipsoidNormal().

double Isis::ShapeModel::incidenceAngle ( const std::vector< double > &  uB )

virtualinherited

Returns the incidence angle in degrees.

This does not use the surface model.

Returns

double Incidence angle, in degrees.

Reimplemented in Isis::PlaneShape.

References Isis::RAD2DEG().

Referenced by Isis::Sensor::IncidenceAngle().

void Isis::ShapeModel::Initialize ( )

inherited

Initialize the ShapeModel private variables.

bool Isis::ShapeModel::intersectEllipsoid ( const std::vector< double >  observerPosRelativeToTarget, const std::vector< double > &  observerLookVectorToTarget  )

protectedinherited

Find the intersection point on the ellipsoid model.

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

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

virtual

Find the intersection point.

Reimplemented from Isis::DemShape.

References Isis::DEG2RAD(), Isis::Angle::Degrees, Isis::DemShape::demScale(), Isis::E(), Isis::SurfacePoint::FromNaifArray(), Isis::ShapeModel::hasEllipsoidIntersection(), 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().

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

virtualinherited

Gets the radius from the DEM, if we have one.

Parameters

lat	Latitude
lon	Longitude

Returns

double Local radius from the DEM

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 intersectSurface(), and Isis::DemShape::intersectSurface().

QString Isis::ShapeModel::name ( ) const

inherited

Get the shape name.

Referenced by Isis::Camera::GetLocalNormal(), Isis::UniversalGroundMap::GroundRange(), Isis::VimsGroundMap::SetGround(), Isis::Camera::SetGround(), and Isis::Camera::SetImage().

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

inherited

Return the local normal of the current intersection point.

Parameters

returns

normal vector if it exists

References _FILEINFO_.

Referenced by Isis::EllipsoidShape::calculateLocalNormal(), Isis::DemShape::calculateLocalNormal(), and Isis::Camera::GetLocalNormal().

double Isis::ShapeModel::phaseAngle ( const std::vector< double > &  sB, const std::vector< double > &  uB  )

virtualinherited

Returns the phase angle in degrees.

Returns

double Phase angle, in degrees.

References Isis::RAD2DEG().

Referenced by Isis::Sensor::PhaseAngle().

double Isis::ShapeModel::resolution ( )

protectedinherited

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

References _FILEINFO_.

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

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

inherited

Set m_hasIntersection;.

Referenced by intersectSurface(), Isis::PlaneShape::intersectSurface(), Isis::DemShape::intersectSurface(), Isis::Camera::SetImage(), and Isis::Sensor::SetLookDirection().

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

protectedinherited

Set the hasNormal flag.

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

void Isis::ShapeModel::setName ( QString  name )

protectedinherited

Set the shape name.

Referenced by Isis::DemShape::DemShape(), Isis::EllipsoidShape::EllipsoidShape(), EquatorialCylindricalShape(), Isis::NaifDskShape::NaifDskShape(), and Isis::PlaneShape::PlaneShape().

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

protectedinherited

Set the normal for the currect intersection point.

References _FILEINFO_.

Referenced by Isis::EllipsoidShape::calculateLocalNormal(), Isis::DemShape::calculateLocalNormal(), Isis::NaifDskShape::calculateSurfaceNormal(), Isis::PlaneShape::intersectSurface(), and Isis::NaifDskShape::setLocalNormalFromIntercept().

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

protectedinherited

Set the normal for the currect intersection point.

References _FILEINFO_.

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

inherited

Set surface intersection point.

Referenced by Isis::NaifDskShape::intersectSurface(), Isis::RadarGroundMap::SetGround(), and Isis::Sensor::SetGround().

SurfacePoint * Isis::ShapeModel::surfaceIntersection ( ) const

inherited

Return the surface intersection.

Referenced by Isis::EllipsoidShape::calculateLocalNormal(), Isis::DemShape::calculateLocalNormal(), Isis::Sensor::Coordinate(), Isis::NaifDskShape::ellipsoidNormal(), Isis::PlaneShape::emissionAngle(), Isis::Sensor::GetLatitude(), Isis::Sensor::GetLongitude(), Isis::Sensor::GetSurfacePoint(), Isis::PlaneShape::incidenceAngle(), intersectSurface(), Isis::DemShape::intersectSurface(), Isis::PlaneShape::intersectSurface(), Isis::PlaneShape::localRadius(), Isis::Sensor::LocalRadius(), Isis::Sensor::SetUniversalGround(), Isis::Sensor::SlantDistance(), Isis::Sensor::SolarDistance(), Isis::Sensor::UniversalLatitude(), and Isis::Sensor::UniversalLongitude().

std::vector< Distance > Isis::ShapeModel::targetRadii ( ) const

protectedinherited

Returns the radii of the body in km.

The radii are obtained from the target.

References _FILEINFO_.

Referenced by Isis::EllipsoidShape::calculateLocalNormal(), Isis::NaifDskShape::ellipsoidNormal(), intersectSurface(), and Isis::EllipsoidShape::localRadius().

---

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

• src/base/objs/EquatorialCylindricalShape/EquatorialCylindricalShape.h
• src/base/objs/EquatorialCylindricalShape/EquatorialCylindricalShape.cpp