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

#include <EquatorialCylindricalShape.h>

Inheritance diagram for Isis::EquatorialCylindricalShape:

Collaboration diagram for Isis::EquatorialCylindricalShape:

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.

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	Initialize ()
	Initializes the ShapeModel private variables.

virtual SurfacePoint *	surfaceIntersection () 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	calculateDefaultNormal ()
	Compute the true surface normal vector of an ellipsoid.

virtual void	calculateSurfaceNormal ()
	Calculate surface normal.

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
Cube *	demCube ()
	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.

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< Distance >	targetRadii () 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.

Private Member Functions
double	calcDemErrUpdateIntersection (std::vector< double > const &observerPos, std::vector< double > const &lookDirection, double t, double *intersectionPoint, bool &success)
	Given a position along a ray, compute the difference between the radius at that position and the surface radius at that lon-lat location.

double	findDemValue ()
	Find a value in the DEM.

Private Attributes
Distance *	m_minRadius
	Minimum radius value in DEM file.

Distance *	m_maxRadius
	Maximum radius value in DEM file.

Cube *	m_demCube
	The cube containing the model.

Projection *	m_demProj
	The projection of the model.

double	m_pixPerDegree
	Scale of DEM file in pixels per degree.

Portal *	m_portal
	Buffer used to read from the model.

Interpolator *	m_interp
	Use bilinear interpolation from dem.

double	m_demValue
	A value picked from the dem.

bool	m_demValueFound
	True if it was attempted to find a value in the DEM.

bool	m_hasEllipsoidIntersection
	Indicates the ellipsoid was successfully intersected.

bool	m_hasIntersection
	indicates good intersection exists

bool	m_hasNormal
	indicates normal has been computed

bool	m_hasLocalNormal
	indicates local normal has been computed

std::vector< double >	m_normal
	Surface normal of current intersection point.

std::vector< double >	m_localNormal
	Local normal of current intersection point.

QString *	m_name

SurfacePoint *	m_surfacePoint
	< Name of the shape

Target *	m_target

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

History

2012-12-19 Debbie A. Cook Added a check for an invalid radius in the intersectSurface() method, that was causing applications to hang. Also return a false if no ellipsoid itersection is found.

2015-07-21 Kristin Berry - Added NaifStatus::CheckErrors() to see if any NAIF errors were signaled. References #2248.

2015-10-01 Jeannie Backer - Made improvements to documentation and brought code closer to ISIS coding standards. Removed check for ellipsoid intersection in intersectSurface() method to prevent early return and attempt the iterative method even when the ellipsoid is not intersected. Fixes #1438

2018-01-05 Cole Neubauer - Fixed units conversion in intersectSurface so that the loop is stepping by radians per pixel, as recommended by Jeff Anderson (LROC team). Fixes #5245

Definition at line 39 of file EquatorialCylindricalShape.h.

Constructor & Destructor Documentation

◆ EquatorialCylindricalShape()

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

Initialize the ISIS Equatorial Cylindrical shape model.

Parameters

pvl	Valid ISIS cube label.

Definition at line 41 of file EquatorialCylindricalShape.cpp.

References Isis::DemShape::demCube(), Isis::DemShape::DemShape(), Isis::Distance::Kilometers, m_maxRadius, m_minRadius, and Isis::ShapeModel::setName().

◆ ~EquatorialCylindricalShape()

Isis::EquatorialCylindricalShape::~EquatorialCylindricalShape ( )

Destructor for ISIS Equatorial Cylindrical shape model.

Definition at line 73 of file EquatorialCylindricalShape.cpp.

References m_maxRadius, and m_minRadius.

Member Function Documentation

◆ calcDemErrUpdateIntersection()

double Isis::DemShape::calcDemErrUpdateIntersection	(	std::vector< double > const &	observerPos,
		std::vector< double > const &	lookDirection,
		double	t,
		double *	intersectionPoint,
		bool &	success )

privateinherited

Given a position along a ray, compute the difference between the radius at that position and the surface radius at that lon-lat location.

Update the intersection point in the class based on the input parameters. All lengths are in km.

Parameters

observerPos	Observer position
lookDirection	Look direction
t	parameter measuring location on the ray
intersectionPoint	location along the ray, eventual intersection location
success	True if the calculation was successful

Returns: @d double Signed error, if the calculation was successful

Definition at line 141 of file DemShape.cpp.

References Isis::Angle::Degrees, Isis::SurfacePoint::FromNaifArray(), Isis::Distance::kilometers(), localRadius(), Isis::ShapeModel::setHasIntersection(), and Isis::ShapeModel::surfaceIntersection().

Referenced by intersectSurface().

◆ calculateDefaultNormal()

void Isis::ShapeModel::calculateDefaultNormal ( )

virtualinherited

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() is only suitable for a spheroid. This implementation is intended for irregular bodies so we expect triaxial ellipsoids.

Author: 2017-03-27 Kris Becker

Returns: QVector<double> Normal vector at the intercept point relative to the ellipsoid (not the plate model)

Reimplemented in Isis::PlaneShape.

Definition at line 160 of file ShapeModel.cpp.

References Isis::NaifStatus::CheckErrors(), hasIntersection(), hasValidTarget(), setHasNormal(), setNormal(), surfaceIntersection(), targetRadii(), and Isis::SurfacePoint::ToNaifArray().

Referenced by calculateSurfaceNormal(), emissionAngle(), and incidenceAngle().

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

Definition at line 459 of file DemShape.cpp.

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

◆ calculateSurfaceNormal()

void Isis::ShapeModel::calculateSurfaceNormal ( )

virtualinherited

Calculate surface normal.

Reimplemented in Isis::PlaneShape.

Definition at line 142 of file ShapeModel.cpp.

References calculateDefaultNormal().

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

◆ clearSurfacePoint()

void Isis::ShapeModel::clearSurfacePoint ( )

virtualinherited

Clears or resets the current surface point.

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

Definition at line 425 of file ShapeModel.cpp.

References m_hasEllipsoidIntersection, and setHasIntersection().

Referenced by Isis::EmbreeShapeModel::clearSurfacePoint(), intersectEllipsoid(), Isis::Camera::RawFocalPlanetoImage(), Isis::Camera::SetGround(), Isis::Camera::SetGround(), Isis::CSMCamera::SetGround(), Isis::CSMCamera::SetGround(), Isis::Sensor::SetGround(), Isis::Sensor::SetGroundLocal(), Isis::Camera::SetImage(), Isis::Camera::SetImage(), Isis::Camera::SetImageMapProjection(), Isis::Camera::SetImageSkyMapProjection(), Isis::Sensor::setTime(), Isis::Camera::SetUniversalGround(), Isis::Camera::SetUniversalGround(), Isis::Sensor::SetUniversalGround(), Isis::Sensor::SetUniversalGround(), and Isis::BulletShapeModel::updateShapeModel().

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

Definition at line 434 of file DemShape.cpp.

References m_demCube.

Referenced by Isis::EquatorialCylindricalShape::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.

Definition at line 425 of file DemShape.cpp.

References m_pixPerDegree.

Referenced by Isis::EquatorialCylindricalShape::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

observerBodyFixedPosition Three dimensional position of the observer, in the coordinate system of the target body.

Returns: The emission angle, in decimal degrees.

Reimplemented in Isis::PlaneShape.

Definition at line 214 of file ShapeModel.cpp.

References calculateDefaultNormal(), hasNormal(), Isis::Displacement::kilometers(), m_normal, and surfaceIntersection().

Referenced by Isis::CSMCamera::EmissionAngle(), Isis::Sensor::EmissionAngle(), and isVisibleFrom().

◆ findDemValue()

double Isis::DemShape::findDemValue ( )

privateinherited

Find a value in the DEM.

Used when intersecting a ray with the DEM. Returned value is in km. A more robust method would return a couple of values, and later try one if the other one fails.

Definition at line 347 of file DemShape.cpp.

References m_demCube, m_demValue, m_demValueFound, m_portal, and Isis::ShapeModel::targetRadii().

Referenced by intersectSurface().

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

Definition at line 242 of file ShapeModel.cpp.

References m_hasEllipsoidIntersection.

◆ hasIntersection()

bool Isis::ShapeModel::hasIntersection ( )

inherited

Returns intersection status.

Returns: bool Indicates whether this ShapeModel has an intersection.

Definition at line 397 of file ShapeModel.cpp.

References m_hasIntersection.

Referenced by calculateDefaultNormal(), Isis::BulletShapeModel::calculateLocalNormal(), Isis::EmbreeShapeModel::calculateLocalNormal(), Isis::NaifDskShape::calculateLocalNormal(), Isis::Camera::GetLocalNormal(), Isis::Sensor::HasSurfaceIntersection(), Isis::BulletShapeModel::intersectSurface(), Isis::BulletShapeModel::intersectSurface(), Isis::EmbreeShapeModel::intersectSurface(), Isis::EmbreeShapeModel::intersectSurface(), Isis::EmbreeShapeModel::intersectSurface(), Isis::EquatorialCylindricalShape::intersectSurface(), isVisibleFrom(), Isis::CSMCamera::SetGround(), Isis::Sensor::SetGroundLocal(), Isis::BulletShapeModel::setLocalNormalFromIntercept(), Isis::NaifDskShape::setLocalNormalFromIntercept(), and Isis::Camera::Slope().

◆ hasLocalNormal()

bool Isis::ShapeModel::hasLocalNormal ( ) const

inherited

Returns surface point local normal status.

Returns: Indicates whether this ShapeModel has a surface normal.

Definition at line 417 of file ShapeModel.cpp.

References m_hasLocalNormal.

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

◆ hasNormal()

bool Isis::ShapeModel::hasNormal ( ) const

inherited

Returns surface point normal status.

Returns: Indicates whether this ShapeModel has a surface normal.

Definition at line 407 of file ShapeModel.cpp.

References m_hasNormal.

Referenced by Isis::EllipsoidShape::calculateLocalNormal(), emissionAngle(), incidenceAngle(), and Isis::Camera::Slope().

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

Definition at line 506 of file ShapeModel.cpp.

Referenced by calculateDefaultNormal(), resolution(), and 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

illuminatorBodyFixedPosition Three dimensional position for the illuminator, in the body-fixed coordinate system.

Returns: double Incidence angle, in degrees.

Reimplemented in Isis::PlaneShape.

Definition at line 261 of file ShapeModel.cpp.

References calculateDefaultNormal(), hasNormal(), Isis::Displacement::kilometers(), m_normal, and surfaceIntersection().

Referenced by Isis::CSMCamera::IncidenceAngle(), and Isis::Sensor::IncidenceAngle().

◆ Initialize()

void Isis::ShapeModel::Initialize ( )

inherited

Initializes the ShapeModel private variables.

Definition at line 65 of file ShapeModel.cpp.

References m_hasEllipsoidIntersection, m_hasIntersection, m_hasLocalNormal, m_hasNormal, m_localNormal, m_normal, and m_surfacePoint.

Referenced by ShapeModel(), and 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

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.

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

Definition at line 296 of file ShapeModel.cpp.

References Isis::NaifStatus::CheckErrors(), clearSurfacePoint(), m_hasEllipsoidIntersection, m_hasIntersection, m_surfacePoint, and targetRadii().

Referenced by 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

lat	Latitude of the surface point
lon	Longitude of the surface point
observerPos	Position of the observer
backCheck	Flag to indicate occlusion check

Returns: bool True if the intersection point is valid (visable)

Reimplemented from Isis::ShapeModel.

Definition at line 85 of file ShapeModel.cpp.

◆ 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

surfpt	Absolute point on the surface to check
observerPos	Position of the observer
backCheck	Flag to indicate occlusion check

Returns: bool True if the intersection point is valid (visable)

Reimplemented from Isis::ShapeModel.

Definition at line 88 of file ShapeModel.cpp.

◆ intersectSurface() [3/3]

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

virtual

Finds the surface intersection point.

Parameters

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.

Returns: bool Indicates whether this shape model found a valid surface intersection.

Reimplemented from Isis::DemShape.

Definition at line 93 of file EquatorialCylindricalShape.cpp.

References Isis::NaifStatus::CheckErrors(), Isis::Angle::Degrees, Isis::DemShape::demScale(), Isis::SurfacePoint::FromNaifArray(), Isis::ShapeModel::hasIntersection(), Isis::DemShape::intersectSurface(), Isis::DemShape::localRadius(), m_maxRadius, 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.

Definition at line 448 of file DemShape.cpp.

◆ 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

observerPos	Position of the observer in body fixed coordinates
lookDirection	Look 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.

Definition at line 488 of file ShapeModel.cpp.

References emissionAngle(), and hasIntersection().

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

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

Definition at line 459 of file ShapeModel.cpp.

References m_hasLocalNormal, and m_localNormal.

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

◆ localRadius()

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: Distance Local radius from the DEM

Implements Isis::ShapeModel.

Definition at line 395 of file DemShape.cpp.

References Isis::Angle::degrees(), Isis::Angle::isValid(), m_demCube, m_demProj, m_interp, m_portal, and Isis::Distance::Meters.

Referenced by calcDemErrUpdateIntersection(), and Isis::EquatorialCylindricalShape::intersectSurface().

◆ name()

QString Isis::ShapeModel::name ( ) const

inherited

Gets the shape name.

Returns: QString The name of the ShapeModel.

Definition at line 647 of file ShapeModel.cpp.

Referenced by isDEM(), Isis::Camera::SetGround(), Isis::CSMCamera::SetGround(), Isis::Camera::SetImageMapProjection(), setName(), Isis::TrackTool::updateLabels(), and Isis::AdvancedTrackTool::updateRow().

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

Definition at line 440 of file ShapeModel.cpp.

References m_hasNormal, and m_normal.

Referenced by Isis::DemShape::calculateLocalNormal(), Isis::EllipsoidShape::calculateLocalNormal(), setLocalNormal(), Isis::BulletShapeModel::setLocalNormalFromIntercept(), setNormal(), Isis::Camera::Slope(), and Isis::BulletShapeModel::updateShapeModel().

◆ 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

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.

Returns: double Phase angle, in degrees.

Definition at line 353 of file ShapeModel.cpp.

References Isis::Displacement::kilometers(), and surfaceIntersection().

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

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

Definition at line 708 of file ShapeModel.cpp.

References hasValidTarget(), and m_hasIntersection.

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

◆ setHasIntersection()

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

inherited

Sets the flag to indicate whether this ShapeModel has an intersection.

Parameters

b	Indicates whether there is an intersection.

Definition at line 658 of file ShapeModel.cpp.

References m_hasIntersection, setHasLocalNormal(), and setHasNormal().

Referenced by Isis::DemShape::calcDemErrUpdateIntersection(), clearSurfacePoint(), Isis::DemShape::intersectSurface(), Isis::EmbreeShapeModel::intersectSurface(), Isis::EquatorialCylindricalShape::intersectSurface(), Isis::PlaneShape::intersectSurface(), Isis::Camera::RawFocalPlanetoImage(), Isis::CSMCamera::SetGround(), Isis::Sensor::SetGroundLocal(), Isis::CSMCamera::SetImage(), Isis::Camera::SetImageMapProjection(), Isis::CSMCamera::SetLookDirection(), Isis::Sensor::SetLookDirection(), and Isis::EmbreeShapeModel::updateIntersection().

◆ setHasLocalNormal()

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

protectedinherited

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

Parameters

status Indicates whether there is a normal.

Definition at line 697 of file ShapeModel.cpp.

References m_hasLocalNormal.

Referenced by Isis::DemShape::calculateLocalNormal(), Isis::EmbreeShapeModel::clearSurfacePoint(), setHasIntersection(), setSurfacePoint(), and Isis::BulletShapeModel::updateShapeModel().

◆ setHasNormal()

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

protectedinherited

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

Parameters

status Indicates whether there is a normal.

Definition at line 687 of file ShapeModel.cpp.

References m_hasNormal.

Referenced by calculateDefaultNormal(), Isis::EmbreeShapeModel::clearSurfacePoint(), setHasIntersection(), and 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

a	First coordinate value for the three dimensional local normal.
b	Second coordinate value for the three dimensional local normal.
c	Third coordinate value for the three dimensional local normal.

Definition at line 617 of file ShapeModel.cpp.

References m_hasIntersection, m_hasLocalNormal, and m_localNormal.

◆ 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

normal Three dimensional local normal vector.

Definition at line 566 of file ShapeModel.cpp.

References m_hasIntersection, m_hasLocalNormal, m_localNormal, and normal().

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

◆ setName()

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

protectedinherited

Sets the shape name.

Parameters

name	The name of the ShapeModel.

Definition at line 636 of file ShapeModel.cpp.

References name().

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

◆ 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

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.

Definition at line 591 of file ShapeModel.cpp.

References m_hasIntersection, m_hasNormal, and m_normal.

◆ 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

normal Three dimensional surface normal vector.

Definition at line 544 of file ShapeModel.cpp.

References m_hasIntersection, m_hasNormal, m_normal, and normal().

Referenced by calculateDefaultNormal(), and Isis::PlaneShape::intersectSurface().

◆ setSurfacePoint()

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

virtualinherited

Set surface intersection point.

Parameters

surfacePoint Position coordinate for the surface point.

Reimplemented in Isis::BulletShapeModel.

Definition at line 670 of file ShapeModel.cpp.

References m_hasIntersection, m_surfacePoint, setHasLocalNormal(), and setHasNormal().

Referenced by Isis::NaifDskShape::intersectSurface(), intersectSurface(), Isis::EmbreeShapeModel::updateIntersection(), and Isis::BulletShapeModel::updateShapeModel().

◆ surfaceIntersection()

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

virtualinherited

Returns the surface intersection for this ShapeModel.

Returns: SurfacePoint Three dimensional position for the surface intersection, in body-fixed coordinate system.

Definition at line 387 of file ShapeModel.cpp.

References m_surfacePoint.

Referenced by Isis::DemShape::calcDemErrUpdateIntersection(), calculateDefaultNormal(), Isis::DemShape::calculateLocalNormal(), Isis::Sensor::Coordinate(), Isis::PlaneShape::emissionAngle(), emissionAngle(), Isis::Sensor::GetLatitude(), Isis::Sensor::GetLongitude(), Isis::Sensor::GetSurfacePoint(), Isis::PlaneShape::incidenceAngle(), incidenceAngle(), Isis::DemShape::intersectSurface(), Isis::EquatorialCylindricalShape::intersectSurface(), Isis::PlaneShape::intersectSurface(), Isis::EmbreeShapeModel::isVisibleFrom(), Isis::Sensor::LocalRadius(), Isis::PlaneShape::localRadius(), phaseAngle(), Isis::Sensor::SetGroundLocal(), Isis::Sensor::SlantDistance(), and Isis::Sensor::SolarDistance().

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

Definition at line 522 of file ShapeModel.cpp.

References hasValidTarget().

Referenced by calculateDefaultNormal(), Isis::DemShape::findDemValue(), intersectEllipsoid(), Isis::EquatorialCylindricalShape::intersectSurface(), and Isis::EllipsoidShape::localRadius().

Member Data Documentation

◆ m_demCube

Cube* Isis::DemShape::m_demCube

privateinherited

The cube containing the model.

Definition at line 104 of file DemShape.h.

Referenced by demCube(), DemShape(), DemShape(), findDemValue(), localRadius(), and ~DemShape().

◆ m_demProj

Projection* Isis::DemShape::m_demProj

privateinherited

The projection of the model.

Definition at line 105 of file DemShape.h.

Referenced by DemShape(), DemShape(), localRadius(), and ~DemShape().

◆ m_demValue

double Isis::DemShape::m_demValue

privateinherited

A value picked from the dem.

Definition at line 109 of file DemShape.h.

Referenced by DemShape(), DemShape(), and findDemValue().

◆ m_demValueFound

bool Isis::DemShape::m_demValueFound

privateinherited

True if it was attempted to find a value in the DEM.

Definition at line 110 of file DemShape.h.

Referenced by DemShape(), DemShape(), and findDemValue().

◆ m_hasEllipsoidIntersection

bool Isis::ShapeModel::m_hasEllipsoidIntersection

privateinherited

Indicates the ellipsoid was successfully intersected.

Definition at line 182 of file ShapeModel.h.

Referenced by clearSurfacePoint(), hasEllipsoidIntersection(), Initialize(), and intersectEllipsoid().

◆ m_hasIntersection

bool Isis::ShapeModel::m_hasIntersection

privateinherited

indicates good intersection exists

Definition at line 183 of file ShapeModel.h.

Referenced by hasIntersection(), Initialize(), intersectEllipsoid(), resolution(), setHasIntersection(), setLocalNormal(), setLocalNormal(), setNormal(), setNormal(), and setSurfacePoint().

◆ m_hasLocalNormal

bool Isis::ShapeModel::m_hasLocalNormal

privateinherited

indicates local normal has been computed

Definition at line 185 of file ShapeModel.h.

Referenced by hasLocalNormal(), Initialize(), localNormal(), setHasLocalNormal(), setLocalNormal(), and setLocalNormal().

◆ m_hasNormal

bool Isis::ShapeModel::m_hasNormal

privateinherited

indicates normal has been computed

Definition at line 184 of file ShapeModel.h.

Referenced by hasNormal(), Initialize(), normal(), setHasNormal(), setNormal(), and setNormal().

◆ m_interp

Interpolator* Isis::DemShape::m_interp

privateinherited

Use bilinear interpolation from dem.

Definition at line 108 of file DemShape.h.

Referenced by DemShape(), DemShape(), localRadius(), and ~DemShape().

◆ m_localNormal

std::vector<double> Isis::ShapeModel::m_localNormal

privateinherited

Local normal of current intersection point.

Definition at line 187 of file ShapeModel.h.

Referenced by Initialize(), localNormal(), setLocalNormal(), and setLocalNormal().

◆ m_maxRadius

Distance* Isis::EquatorialCylindricalShape::m_maxRadius

private

Maximum radius value in DEM file.

Definition at line 53 of file EquatorialCylindricalShape.h.

Referenced by EquatorialCylindricalShape(), intersectSurface(), and ~EquatorialCylindricalShape().

◆ m_minRadius

Distance* Isis::EquatorialCylindricalShape::m_minRadius

private

Minimum radius value in DEM file.

Definition at line 52 of file EquatorialCylindricalShape.h.

Referenced by EquatorialCylindricalShape(), and ~EquatorialCylindricalShape().

◆ m_name

QString* Isis::ShapeModel::m_name

privateinherited

Definition at line 188 of file ShapeModel.h.

◆ m_normal

std::vector<double> Isis::ShapeModel::m_normal

privateinherited

Surface normal of current intersection point.

Definition at line 186 of file ShapeModel.h.

Referenced by emissionAngle(), incidenceAngle(), Initialize(), normal(), setNormal(), and setNormal().

◆ m_pixPerDegree

double Isis::DemShape::m_pixPerDegree

privateinherited

Scale of DEM file in pixels per degree.

Definition at line 106 of file DemShape.h.

Referenced by demScale(), and DemShape().

◆ m_portal

Portal* Isis::DemShape::m_portal

privateinherited

Buffer used to read from the model.

Definition at line 107 of file DemShape.h.

Referenced by DemShape(), DemShape(), findDemValue(), localRadius(), and ~DemShape().

◆ m_surfacePoint

SurfacePoint* Isis::ShapeModel::m_surfacePoint

privateinherited

< Name of the shape

Current intersection point

Definition at line 189 of file ShapeModel.h.

Referenced by Initialize(), intersectEllipsoid(), setSurfacePoint(), surfaceIntersection(), and ~ShapeModel().

◆ m_target

Target* Isis::ShapeModel::m_target

privateinherited

Definition at line 191 of file ShapeModel.h.

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

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

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ EquatorialCylindricalShape()

◆ ~EquatorialCylindricalShape()

Member Function Documentation

◆ calcDemErrUpdateIntersection()

◆ calculateDefaultNormal()

◆ calculateLocalNormal()

◆ calculateSurfaceNormal()

◆ clearSurfacePoint()

◆ demCube()

◆ demScale()

◆ emissionAngle()

◆ findDemValue()

◆ hasEllipsoidIntersection()

◆ hasIntersection()

◆ hasLocalNormal()

◆ hasNormal()

◆ hasValidTarget()

◆ incidenceAngle()

◆ Initialize()

◆ intersectEllipsoid()

◆ intersectSurface() [1/3]

◆ intersectSurface() [2/3]

◆ intersectSurface() [3/3]

◆ isDEM()

◆ isVisibleFrom()

◆ localNormal()

◆ localRadius()

◆ name()

◆ normal()

◆ phaseAngle()

◆ resolution()

◆ setHasIntersection()

◆ setHasLocalNormal()

◆ setHasNormal()

◆ setLocalNormal() [1/2]

◆ setLocalNormal() [2/2]

◆ setName()

◆ setNormal() [1/2]

◆ setNormal() [2/2]

◆ setSurfacePoint()

◆ surfaceIntersection()

◆ targetRadii()

Member Data Documentation

◆ m_demCube

◆ m_demProj

◆ m_demValue

◆ m_demValueFound

◆ m_hasEllipsoidIntersection

◆ m_hasIntersection

◆ m_hasLocalNormal

◆ m_hasNormal

◆ m_interp

◆ m_localNormal

◆ m_maxRadius

◆ m_minRadius

◆ m_name

◆ m_normal

◆ m_pixPerDegree

◆ m_portal

◆ m_surfacePoint

◆ m_target