This class defines a body-fixed surface point. More...

#include <SurfacePoint.h>

Collaboration diagram for Isis::SurfacePoint:

Public Types
enum	CoordinateType { Latitudinal , Rectangular }
	Defines the coordinate typ, units, and coordinate index for some of the output methods. More...

enum	CoordUnits { Degrees , Kilometers , Meters , Radians }

enum	CoordIndex { One =0 , Two =1 , Three =2 }

Public Member Functions
	SurfacePoint ()
	Constructs an empty SurfacePoint object.

	SurfacePoint (const SurfacePoint &other)
	Constructs a new SurfacePoint object from an existing SurfacePoint.

	SurfacePoint (const Latitude &lat, const Longitude &lon, const Distance &radius)
	Constructs a SurfacePoint object with a spherical point only.

	SurfacePoint (const Latitude &lat, const Longitude &lon, const Distance &radius, const Angle &latSigma, const Angle &lonSigma, const Distance &radiusSigma)
	Constructs a SurfacePoint object with a spherical point and its sigmas.

	SurfacePoint (const Latitude &lat, const Longitude &lon, const Distance &radius, const boost::numeric::ublas::symmetric_matrix< double, boost::numeric::ublas::upper > &covar)

	SurfacePoint (const Displacement &x, const Displacement &y, const Displacement &z)
	Constructs a SurfacePoint object with a rectangular point only.

	SurfacePoint (const Displacement &x, const Displacement &y, const Displacement &z, const Distance &xSigma, const Distance &ySigma, const Distance &zSigma)
	Constructs a SurfacePoint object with a rectangular point and sigmas.

	SurfacePoint (const Displacement &x, const Displacement &y, const Displacement &z, const boost::numeric::ublas::symmetric_matrix< double, boost::numeric::ublas::upper > &covar)

	~SurfacePoint ()
	Destroys a SurfacePoint object/.

void	SetRectangular (const Displacement &x, const Displacement &y, const Displacement &z, const Distance &xSigma=Distance(), const Distance &ySigma=Distance(), const Distance &zSigma=Distance())
	Set surface point in rectangular body-fixed coordinates wtih optional sigmas.

void	SetRectangular (const Displacement x, const Displacement y, const Displacement z, const boost::numeric::ublas::symmetric_matrix< double, boost::numeric::ublas::upper > &covar)

void	SetRectangularCoordinates (const Displacement &x, const Displacement &y, const Displacement &z)
	Set surface point in rectangular coordinates.

void	SetRectangularSigmas (const Distance &xSigma, const Distance &ySigma, const Distance &zSigma)
	Set surface point and sigmas in rectangular coordinates and convert to planetocentric.

void	SetRectangularMatrix (const boost::numeric::ublas::symmetric_matrix< double, boost::numeric::ublas::upper > &covar, SurfacePoint::CoordUnits units=SurfacePoint::Meters)
	Set rectangular covariance matrix and store in units of km**2.

void	SetSpherical (const Latitude &lat, const Longitude &lon, const Distance &radius, const Angle &latSigma=Angle(), const Angle &lonSigma=Angle(), const Distance &radiusSigma=Distance())
	Set surface point and covariance matrix in planetocentric coordinates and convert to rectangular (Latitude, Longitude in degrees, Radius in meters; matrix in radians and radians**2)

void	SetSpherical (const Latitude &lat, const Longitude &lon, const Distance &radius, const boost::numeric::ublas::symmetric_matrix< double, boost::numeric::ublas::upper > &covar)

void	SetSphericalCoordinates (const Latitude &lat, const Longitude &lon, const Distance &radius)
	Update spherical coordinates (lat/lon/radius)

void	SetSphericalMatrix (const boost::numeric::ublas::symmetric_matrix< double, boost::numeric::ublas::upper > &covar, SurfacePoint::CoordUnits units=SurfacePoint::Meters)
	Set spherical covariance matrix.

void	SetSphericalSigmas (const Angle &latSigma, const Angle &lonSigma, const Distance &radiusSigma)
	Set the spherical sigmas into the spherical variance/covariance matrix in diagonal units of radians^2, radians^2, km^2.

void	SetSphericalSigmasDistance (const Distance &latSigma, const Distance &lonSigma, const Distance &radiusSigma)
	Set the spherical sigmas (in Distance units) into the spherical variance/covariance matrix.

void	ResetLocalRadius (const Distance &radius)
	This method resets the local radius of a SurfacePoint.

bool	Valid () const

void	SetMatrix (CoordinateType type, const boost::numeric::ublas::symmetric_matrix< double, boost::numeric::ublas::upper > &covar)
	Set the covariance matrix.

std::vector< double >	Partial (CoordinateType type, CoordIndex index)
	Compute partial derivative of conversion from body-fixed coordinates to the specified.

double	GetCoord (CoordinateType type, CoordIndex index, CoordUnits units)
	This method returns a coordinate of a SurfacePoint.

double	GetSigma (CoordinateType type, CoordIndex index, CoordUnits units)
	This method returns a sigma of a SurfacePoint coordinate.

Distance	GetSigmaDistance (CoordinateType type, CoordIndex index)
	This method returns a sigma of a SurfacePoint coordinate as a Distance.

double	GetWeight (CoordinateType type, CoordIndex index)
	This method returns the weight of a SurfacePoint coordinate Note: At this time a units argument is not included.

Displacement	GetX () const

Displacement	GetY () const

Displacement	GetZ () const

Distance	GetXSigma () const

Distance	GetYSigma () const

Distance	GetZSigma () const

double	GetXWeight () const
	Return X weight for bundle adjustment Units are 1/(kilometers)^2.

double	GetYWeight () const
	Return Y weight for bundle adjustment Units are 1/(kilometers)^2.

double	GetZWeight () const
	Return Z weight for bundle adjustment Units are 1/(kilometers)^2.

boost::numeric::ublas::symmetric_matrix< double, boost::numeric::ublas::upper >	GetRectangularMatrix (SurfacePoint::CoordUnits units=SurfacePoint::Meters) const

Latitude	GetLatitude () const
	Return the body-fixed latitude for the surface point.

Longitude	GetLongitude () const
	Return the body-fixed longitude for the surface point.

Distance	GetLocalRadius () const
	Return the radius of the surface point.

Angle	GetLatSigma () const

Distance	GetLatSigmaDistance () const
	Return the latitude sigma as a Distance.

double	GetLatWeight () const
	Return latitude weight for bundle adjustment Units are 1/(radians)^2.

Angle	GetLonSigma () const

Distance	GetLonSigmaDistance () const
	Return the longitude sigma in meters.

double	GetLonWeight () const
	Return longitude weight for bundle adjustment Units are 1/(radians)^2.

Distance	GetLocalRadiusSigma () const

double	GetLocalRadiusWeight () const
	Return radius weight for bundle adjustment Units are 1/(kilometers)^2.

boost::numeric::ublas::symmetric_matrix< double, boost::numeric::ublas::upper >	GetSphericalMatrix (SurfacePoint::CoordUnits units=SurfacePoint::Meters) const

double	DisplacementToDouble (Displacement disp, CoordUnits units)
	This method returns a double version of a Displacement in the specified units.

double	DistanceToDouble (Distance dist, CoordUnits units)
	This method returns a double version of a Distance in the specified units.

double	MetersToLatitude (double latLength)
	This method returns an angular measure of a distance in the direction of and relative to the latitude of the SurfacePoint.

double	MetersToLongitude (double lonLength)
	This method returns an angular measure in radians of a distance in the direction of and relative to the longitude of the SurfacePoint.

double	LatitudeToMeters (double latitude) const
	This method returns a Displacement of an Angle relative to the current SurfacePoint latitude.

double	LongitudeToMeters (double longitude) const
	This method returns a length in meters version of a delta longitude angle in radians relative to the current SurfacePoint longitude.

double	LatToDouble (Latitude lat, CoordUnits units)
	This method returns a double version of a Latitude in the specified units.

double	LonToDouble (Longitude lon, CoordUnits units)
	This method returns a double version of a Longitude in the specified units.

Distance	GetDistanceToPoint (const SurfacePoint &other) const
	Computes and returns the distance between two surface points.

Distance	GetDistanceToPoint (const SurfacePoint &other, const Distance &sphereRadius) const
	Computes and returns the distance between two surface points, assuming both points are on a sphere with the given radius.

std::vector< double >	LatitudinalDerivative (CoordIndex index)
	Compute partial derivative of the conversion of the latitudinal coordinates to body-fixed rectangular coordinates with respect to the indicated coordinate.

std::vector< double >	RectangularDerivative (CoordIndex index)
	Compute partial derivative of the body-fixed rectangular coordinates with respect to the indicated coordinate.

void	ToNaifArray (double naifOutput[3]) const
	A naif array is a c-style array of size 3.

void	FromNaifArray (const double naifValues[3])
	A naif array is a c-style array of size 3.

bool	operator== (const SurfacePoint &other) const

SurfacePoint &	operator= (const SurfacePoint &other)

Static Public Member Functions
static CoordinateType	stringToCoordinateType (QString type)
	This method converts the given string value to a SurfacePoint::CoordinateType enumeration.

static QString	coordinateTypeToString (CoordinateType type)
	Converts the given SurfacePoint::CoordinateType enumeration to a string.

Private Member Functions
void	ComputeLocalRadius ()
	Compute the local radius of the surface point.

void	InitCovariance ()
	Initialize the variance/covariance matrices.

void	InitPoint ()
	Initialize a surface point.

void	SetRectangularPoint (const Displacement &x, const Displacement &y, const Displacement &z)
	This is a private method to set a surface point in rectangular, body-fixed coordinates.

void	SetSphericalPoint (const Latitude &lat, const Longitude &lon, const Distance &radius)
	This is a private method to set a surface point in spherical (lat/lon/radius), body-fixed coordinates.

void	FreeAllocatedMemory ()

Private Attributes
Distance	p_localRadius

Displacement *	p_x

Displacement *	p_y

Displacement *	p_z

boost::numeric::ublas::symmetric_matrix< double, boost::numeric::ublas::upper > *	p_rectCovar
	3x3 upper triangular covariance matrix rectangular coordinates

boost::numeric::ublas::symmetric_matrix< double, boost::numeric::ublas::upper > *	p_sphereCovar
	3x3 upper triangular covariance matrix ocentric coordinates

Detailed Description

This class defines a body-fixed surface point.

This class is a container for body-fixed surface points. It provides methods to set and present the coordinates of surface points in various usable units to support projection of image points to the ground and bundle adjustment.

Author: 2010-07-30 Tracie Sucharski, Ken L. Edmunson, and Debbie A. Cook

History

2010-08-25 Debbie A. Cook Added more error checking and testing

2010-09-10 Debbie A. Cook Made ocentric methods specific to units of sigmas (degrees or meters)

2010-10-04 Debbie A. Cook Remove using boost to avoid compile errors throughout Isis3 classes and added boost namespace name to all uses of matrix

2010-10-20 Debbie A. Cook and Steven Lambright Simplified the class by using new Displacement, Distance, Latitude, Longitude, and Angle objects.

2010-12-28 Steven Lambright and Sharmila Prasad Fixed a problem with retreiving longitudes outside of 0-360.

2011-02-11 Steven Lambright Added SphericalDistanceToPoint and optimized for speed inside the cameras and typical use cases where we only have an x,y,z but no other data. Fixed a problem where points were not properly considered valid at some boundary conditions.

2011-03-05 Ken Edmundson Added GetLatWeight, GetLonWeight, GetLocalRadiusWeight, and SetSphericalCoordinates methods for use in BundleAdjust.

2011-04-18 Steven Lambright GetLatSigmaDistance and GetLonSigmaDistance now return appropriate results when the point is invalid but has radii.

2011-08-08 Steven Lambright and Jai Rideout - SetSphericalSigmas() called with invalid parameters will clear the sigmas. Improved some safety checks.

2011-10-06 Steven Lambright - Get*SigmaDistance will no longer throw an exception if there is no stored sigma and there is no stored target radii.

2018-06-28 Debbie A. Cook - Removed target body radii and all related methods. Any reference to the major axis (equatorial radius) was replaced with the local radius. Technically I think we should be using the target body minor axis (polar) for the conversion of latitude degrees to/from distance and the local radius of the surface point for conversion of longitude degrees to/from distance. For large bodies the percent error will be small, so we will use the local radius for convenience. For small bodies, any bundle adjustment will likely use rectangular coordinates where degree conversions will not be necessary. Added new member p_localRadius to avoid recalculating when coordinates have not changed. Also corrected the longitude conversion equation in SetSphericalSigmasDistance and GetLonSigmaDistance. References #5457.

2018-08-15 Debbie A. Cook - Initialized the local radius whenever any SurfacePoint coordinate was changed, removed memory errors, and cleaned up documentation. Changed localRadius member from a pointer to value to reduce extraneous if blocks.
References #5457

2018-09-06 Debbie A. Cook - Originally added to BundleXYZ branch on 2017-06-25 - Added CoordinateType, CoordUnits, and CoordIndex to support new convenience methods GetCoord, GetSigma, and GetWeight. Also added methods GetXWeight, GetYWeight, GetZWeight, LatToDouble, LonToDouble, DistanceToDouble, DisplacementToDouble,
getCoordSigmaDistance, stringToCoordinateType, and coordinateTypeToString. Fixed comment in GetLocalRadiusWeight method to indicate kilometers instead of meters. References #4649 and #501.

2018-09-06 Debbie A. Cook - Originally added to BundleXYZ branch on 2017-07-25 - Corrected covar(2,2) units in SetSphericalSigmas, and all diagonal units in SetRectangularSigmas. Corrected spelling of equatorial in comments. Corrected conversion of longitude sigma from meters to radians in SetSphericalSigmasDistance and from radians to meters in GetLonSigmaDistance. Fixed SetRectangularMatrix to take input in km instead of m.

2018-09-06 Debbie A. Cook - Originally added to BundleXYZ branch on 2017-11-20 - Added an additional argument to SetRectangularMatrix and SetSphericalMatrix to specify the units of the matrix. This will allow the bundle adjust to set in km and existing software to continue setting in the default units (meters). The matrix will be stored in km in this object to avoid extra conversions during processing.

2018-09-06 Debbie A. Cook - Originally added to BundleXYZ branch on 2018-03-07 - Added an additional argument to GetRectangularMatrix and GetSphericalMatrix to specify the units of the matrix. This will allow existing callers to get in m (the default) and bundle adjust software to get in km and minimize conversions. The matrix is held in this object in km to avoid extra conversions during the bundle adjustment. The control net stores the distance values of the matrix in m**2.

2018-09-20 Debbie A. Cook - Added new methods LatitudeToMeters, MetersToLatitude, LongitudeToMeters, and MetersToLongitude for converting sigmas and corrections at the current SurfacePoint coordinates. References #4649 and #501.

2018-10-12 Debbie A. Cook - Initialized local radius in SetRectangularCoordinates

2019-05-29 Debbie A. Cook Changed test constant from DBL_EPSILON to 1.0e-50 to avoid false positives and negatives in MetersToLongitude, GetLatSigmaDistance, and GetLonSigmaDistance.

Definition at line 132 of file SurfacePoint.h.

Member Enumeration Documentation

◆ CoordinateType

enum Isis::SurfacePoint::CoordinateType

Defines the coordinate typ, units, and coordinate index for some of the output methods.

Enumerator
Latitudinal	Planetocentric latitudinal (lat/lon/rad) coordinates.
Rectangular	Body-fixed rectangular x/y/z coordinates.

Definition at line 139 of file SurfacePoint.h.

◆ CoordIndex

enum Isis::SurfacePoint::CoordIndex

Definition at line 149 of file SurfacePoint.h.

◆ CoordUnits

enum Isis::SurfacePoint::CoordUnits

Definition at line 143 of file SurfacePoint.h.

Constructor & Destructor Documentation

◆ SurfacePoint() [1/6]

Isis::SurfacePoint::SurfacePoint ( )

Constructs an empty SurfacePoint object.

Definition at line 26 of file SurfacePoint.cpp.

References InitCovariance(), and InitPoint().

◆ SurfacePoint() [2/6]

Isis::SurfacePoint::SurfacePoint ( const SurfacePoint & other )

Constructs a new SurfacePoint object from an existing SurfacePoint.

Definition at line 35 of file SurfacePoint.cpp.

References p_rectCovar, and p_sphereCovar.

◆ SurfacePoint() [3/6]

Isis::SurfacePoint::SurfacePoint	(	const Latitude &	lat,
		const Longitude &	lon,
		const Distance &	radius )

Constructs a SurfacePoint object with a spherical point only.

Parameters

lat	The latitude of the surface point
lon	The longitude of the surface point
radius	The radius of the surface point

Definition at line 82 of file SurfacePoint.cpp.

References InitCovariance(), InitPoint(), and SetSphericalPoint().

◆ SurfacePoint() [4/6]

Isis::SurfacePoint::SurfacePoint	(	const Latitude &	lat,
		const Longitude &	lon,
		const Distance &	radius,
		const Angle &	latSigma,
		const Angle &	lonSigma,
		const Distance &	radiusSigma )

Constructs a SurfacePoint object with a spherical point and its sigmas.

Parameters

lat	The latitude of the surface point
lon	The longitude of the surface point
radius	The radius of the surface point The sigmas indicate the accuracy of the point. For instance, a latitude sigma of 5 degrees would indicate that the latitiude value could have an error or + or - 5 degrees.
sigmaLat	The sigma of the latitude
sigmaLon	The sigma of the longitude
sigmaRadius	The sigma of the local radius

Definition at line 105 of file SurfacePoint.cpp.

References InitCovariance(), InitPoint(), and SetSpherical().

◆ SurfacePoint() [5/6]

Isis::SurfacePoint::SurfacePoint	(	const Displacement &	x,
		const Displacement &	y,
		const Displacement &	z )

Constructs a SurfacePoint object with a rectangular point only.

Parameters

x	The x coordinate of the surface point
y	The y coordinate of the surface point
z	The z coordinate of the surface point

Definition at line 134 of file SurfacePoint.cpp.

References InitCovariance(), InitPoint(), and SetRectangular().

◆ SurfacePoint() [6/6]

Isis::SurfacePoint::SurfacePoint	(	const Displacement &	x,
		const Displacement &	y,
		const Displacement &	z,
		const Distance &	xSigma,
		const Distance &	ySigma,
		const Distance &	zSigma )

Constructs a SurfacePoint object with a rectangular point and sigmas.

Parameters

x	The x coordinate of the surface point
y	The y coordinate of the surface point
z	The z coordinate of the surface point The sigmas indicate the accuracy of the point. For instance, a sigmaX=100 m, would indicate that the x coordinate was accurate to within 100 meters.
xSigma	The x coordinate of the surface point
ySigma	The y coordinate of the surface point
zSigma	The z coordinate of the surface point

Definition at line 156 of file SurfacePoint.cpp.

References InitCovariance(), InitPoint(), and SetRectangular().

◆ ~SurfacePoint()

Isis::SurfacePoint::~SurfacePoint ( )

Destroys a SurfacePoint object/.

Definition at line 186 of file SurfacePoint.cpp.

Member Function Documentation

◆ ComputeLocalRadius()

void Isis::SurfacePoint::ComputeLocalRadius ( )

private

Compute the local radius of the surface point.

Definition at line 1709 of file SurfacePoint.cpp.

References Isis::Displacement::Meters, Isis::Displacement::meters(), Isis::Distance::Meters, and Isis::IException::Programmer.

Referenced by FromNaifArray(), and SetRectangularPoint().

◆ coordinateTypeToString()

QString Isis::SurfacePoint::coordinateTypeToString ( SurfacePoint::CoordinateType type )

static

Converts the given SurfacePoint::CoordinateType enumeration to a string.

This method is used to print the type of control point coordinates used in the bundle adjustment.

Parameters

type	The Coordinate Type enumeration to be converted.

Returns: QString The name associated with the given CoordinateType.

Exceptions

Isis::Exception::Programmer "Unknown SurfacePoint CoordinateType enum."

Definition at line 1389 of file SurfacePoint.cpp.

References Latitudinal, Isis::IException::Programmer, Rectangular, and Isis::toString().

Referenced by Isis::BundleSolutionInfo::outputHeader().

◆ DisplacementToDouble()

double Isis::SurfacePoint::DisplacementToDouble	(	Displacement	disp,
		CoordUnits	units )

This method returns a double version of a Displacement in the specified units.

Parameters

disp	The displacement to convert to a double
units	The units in which to return the displacement (see CoordinateUnits in .h file)

Definition at line 1160 of file SurfacePoint.cpp.

References Isis::IException::Programmer.

Referenced by GetCoord().

◆ DistanceToDouble()

double Isis::SurfacePoint::DistanceToDouble	(	Distance	dist,
		CoordUnits	units )

This method returns a double version of a Distance in the specified units.

Parameters

dist	The distance to convert to a double
units	The units in which to return the distance (see CoordinateUnits in .h file)

Definition at line 1188 of file SurfacePoint.cpp.

References Isis::IException::Programmer.

Referenced by GetCoord(), and GetSigma().

◆ FreeAllocatedMemory()

void Isis::SurfacePoint::FreeAllocatedMemory ( )

private

Definition at line 2012 of file SurfacePoint.cpp.

◆ FromNaifArray()

void Isis::SurfacePoint::FromNaifArray ( const double naifValues[3] )

A naif array is a c-style array of size 3.

The element types are double... keep in mind a SpiceDouble is a double. The values' units are kilometers because that is the unit naif works in. The first element is X, the second Y, and the third Z. This loads the naif array into the surface point.

Parameters

naifValues The naif array to use as rectangular coordinates

Definition at line 891 of file SurfacePoint.cpp.

References ComputeLocalRadius(), GetLocalRadius(), Isis::Displacement::Kilometers, and Isis::Displacement::setKilometers().

Referenced by Isis::ShapeModel::intersectEllipsoid(), and Isis::BulletShapeModel::makeSurfacePoint().

◆ GetCoord()

double Isis::SurfacePoint::GetCoord	(	CoordinateType	type,
		CoordIndex	index,
		CoordUnits	units )

This method returns a coordinate of a SurfacePoint.

Parameters

type	The coordinate type to return (see CoordinateType in .h file)
index	The coordinate index to return (1 <= index <= 3)
units	The units in which to return the coordinate value (see CoordinateUnits in .h file)

Definition at line 962 of file SurfacePoint.cpp.

References DisplacementToDouble(), DistanceToDouble(), GetLatitude(), GetLocalRadius(), GetLongitude(), Latitudinal, LatToDouble(), LonToDouble(), Isis::IException::Programmer, Rectangular, and Isis::toString().

Referenced by Isis::BundleControlPoint::formatBundleOutputSummaryString().

◆ GetDistanceToPoint() [1/2]

Distance Isis::SurfacePoint::GetDistanceToPoint ( const SurfacePoint & other ) const

Computes and returns the distance between two surface points.

The average of the local radii will be used.

Definition at line 1880 of file SurfacePoint.cpp.

References GetDistanceToPoint(), and GetLocalRadius().

Referenced by GetDistanceToPoint().

◆ GetDistanceToPoint() [2/2]

Distance Isis::SurfacePoint::GetDistanceToPoint	(	const SurfacePoint &	other,
		const Distance &	sphereRadius ) const

Computes and returns the distance between two surface points, assuming both points are on a sphere with the given radius.

This uses the haversine formula to compute the distance. Using a spherical model gives errors typically <1%

Definition at line 1897 of file SurfacePoint.cpp.

References GetLatitude(), and GetLongitude().

◆ GetLatitude()

Latitude Isis::SurfacePoint::GetLatitude ( ) const

Return the body-fixed latitude for the surface point.

Definition at line 1665 of file SurfacePoint.cpp.

References Isis::Displacement::meters(), and Isis::Angle::Radians.

Referenced by Isis::BundleLidarRangeConstraint::applyConstraint(), Isis::BundleControlPoint::formatBundleLatitudinalOutputDetailString(), Isis::BundleControlPoint::formatBundleRectangularOutputDetailString(), GetCoord(), GetDistanceToPoint(), Isis::Camera::GetLocalNormal(), LatitudinalDerivative(), LatToDouble(), LongitudeToMeters(), MetersToLongitude(), ResetLocalRadius(), Isis::VimsGroundMap::SetGround(), SetSphericalMatrix(), Isis::CSMCamera::subSpacecraftPoint(), Isis::ControlNetVersioner::toPvl(), Isis::SunShadowTool::updateRow(), Isis::QnetTool::updateSurfacePointInfo(), and Isis::LidarData::write().

◆ GetLatSigma()

Angle Isis::SurfacePoint::GetLatSigma ( ) const

Definition at line 1645 of file SurfacePoint.cpp.

◆ GetLatSigmaDistance()

Distance Isis::SurfacePoint::GetLatSigmaDistance ( ) const

Return the latitude sigma as a Distance.

History: 2019-05-29 Debbie A. Cook Changed test constant from DBL_EPSILON to 1.0e-50 to fix possible false errors from reasonably small distances on fixed or tightly constrained points occurring during error propagation in jigsaw.

Definition at line 1747 of file SurfacePoint.cpp.

References LatitudeToMeters(), and Isis::Distance::Meters.

Referenced by GetSigma(), GetSigmaDistance(), Isis::ControlNetVersioner::toPvl(), and Isis::ControlNetVersioner::writeFirstPoint().

◆ GetLatWeight()

double Isis::SurfacePoint::GetLatWeight ( ) const

Return latitude weight for bundle adjustment Units are 1/(radians)^2.

Definition at line 1832 of file SurfacePoint.cpp.

References Isis::IException::Programmer, and Isis::Angle::radians().

Referenced by GetWeight().

◆ GetLocalRadius()

Distance Isis::SurfacePoint::GetLocalRadius ( ) const

Return the radius of the surface point.

Definition at line 1732 of file SurfacePoint.cpp.

Referenced by Isis::BundleLidarRangeConstraint::applyConstraint(), Isis::BundleControlPoint::formatBundleLatitudinalOutputDetailString(), Isis::BundleControlPoint::formatBundleRectangularOutputDetailString(), FromNaifArray(), GetCoord(), GetDistanceToPoint(), LatitudeToMeters(), LatitudinalDerivative(), LongitudeToMeters(), MetersToLatitude(), MetersToLongitude(), SetRectangularPoint(), SetSphericalMatrix(), Isis::ControlNetVersioner::toPvl(), Isis::QnetTool::updateSurfacePointInfo(), and Isis::LidarData::write().

◆ GetLocalRadiusSigma()

Distance Isis::SurfacePoint::GetLocalRadiusSigma ( ) const

Definition at line 1776 of file SurfacePoint.cpp.

◆ GetLocalRadiusWeight()

double Isis::SurfacePoint::GetLocalRadiusWeight ( ) const

Return radius weight for bundle adjustment Units are 1/(kilometers)^2.

Definition at line 1864 of file SurfacePoint.cpp.

References Isis::Distance::kilometers(), and Isis::IException::Programmer.

Referenced by GetWeight().

◆ GetLongitude()

Longitude Isis::SurfacePoint::GetLongitude ( ) const

Return the body-fixed longitude for the surface point.

Definition at line 1685 of file SurfacePoint.cpp.

References Isis::Displacement::meters(), Isis::PI, and Isis::Angle::Radians.

Referenced by Isis::BundleLidarRangeConstraint::applyConstraint(), Isis::BundleControlPoint::formatBundleLatitudinalOutputDetailString(), Isis::BundleControlPoint::formatBundleRectangularOutputDetailString(), GetCoord(), GetDistanceToPoint(), Isis::Camera::GetLocalNormal(), LatitudinalDerivative(), LonToDouble(), ResetLocalRadius(), Isis::VimsGroundMap::SetGround(), SetSphericalMatrix(), Isis::CSMCamera::subSpacecraftPoint(), Isis::ControlNetVersioner::toPvl(), Isis::SunShadowTool::updateRow(), Isis::QnetTool::updateSurfacePointInfo(), and Isis::LidarData::write().

◆ GetLonSigma()

Angle Isis::SurfacePoint::GetLonSigma ( ) const

Definition at line 1653 of file SurfacePoint.cpp.

◆ GetLonSigmaDistance()

Distance Isis::SurfacePoint::GetLonSigmaDistance ( ) const

Return the longitude sigma in meters.

Definition at line 1763 of file SurfacePoint.cpp.

References LongitudeToMeters(), and Isis::Distance::Meters.

Referenced by GetSigma(), GetSigmaDistance(), Isis::ControlNetVersioner::toPvl(), and Isis::ControlNetVersioner::writeFirstPoint().

◆ GetLonWeight()

double Isis::SurfacePoint::GetLonWeight ( ) const

Return longitude weight for bundle adjustment Units are 1/(radians)^2.

Definition at line 1848 of file SurfacePoint.cpp.

References Isis::IException::Programmer, and Isis::Angle::radians().

Referenced by GetWeight().

◆ GetRectangularMatrix()

symmetric_matrix< double, upper > Isis::SurfacePoint::GetRectangularMatrix ( SurfacePoint::CoordUnits units = SurfacePoint::Meters ) const

Definition at line 1602 of file SurfacePoint.cpp.

◆ GetSigma()

double Isis::SurfacePoint::GetSigma	(	CoordinateType	type,
		CoordIndex	index,
		CoordUnits	units )

This method returns a sigma of a SurfacePoint coordinate.

Parameters

type	The coordinate type to return (see CoordinateType in .h file)
index	The coordinate index to return (1 <= index <= 3)
units	The units in which to return the coordinate value (see CoordinateUnits in .h file)

Definition at line 1029 of file SurfacePoint.cpp.

References DistanceToDouble(), GetLatSigmaDistance(), GetLonSigmaDistance(), Latitudinal, Isis::IException::Programmer, Rectangular, and Isis::toString().

◆ GetSigmaDistance()

Distance Isis::SurfacePoint::GetSigmaDistance	(	CoordinateType	type,
		CoordIndex	index )

This method returns a sigma of a SurfacePoint coordinate as a Distance.

Parameters

type	The coordinate type to return (see CoordinateType in .h file)
index	The coordinate index to return (1 <= index <= 3)

Definition at line 1094 of file SurfacePoint.cpp.

References GetLatSigmaDistance(), GetLonSigmaDistance(), Latitudinal, Isis::IException::Programmer, Rectangular, and Isis::toString().

Referenced by Isis::BundleControlPoint::formatAdjustedSigmaString(), and Isis::BundleControlPoint::setWeights().

◆ GetSphericalMatrix()

symmetric_matrix< double, upper > Isis::SurfacePoint::GetSphericalMatrix ( SurfacePoint::CoordUnits units = SurfacePoint::Meters ) const

Definition at line 1784 of file SurfacePoint.cpp.

◆ GetWeight()

double Isis::SurfacePoint::GetWeight	(	CoordinateType	type,
		CoordIndex	index )

This method returns the weight of a SurfacePoint coordinate Note: At this time a units argument is not included.

If BundleAdjust is modified to allow different distance or displacement units other than kilometers, the units argument can be added similar to the GetCoord and GetSigma methods. Angle weights are in 1/rad^2 and distance and displacements are in 1/km^2

Parameters

type	The coordinate type to return (see CoordinateType in .h file)
index	The coordinate index to return (1 <= index <= 3)

Definition at line 1491 of file SurfacePoint.cpp.

References GetLatWeight(), GetLocalRadiusWeight(), GetLonWeight(), GetXWeight(), GetYWeight(), GetZWeight(), Latitudinal, Isis::IException::Programmer, Rectangular, and Isis::toString().

Referenced by Isis::BundleControlPoint::setWeights().

◆ GetX()

Displacement Isis::SurfacePoint::GetX ( ) const

Definition at line 1436 of file SurfacePoint.cpp.

◆ GetXSigma()

Distance Isis::SurfacePoint::GetXSigma ( ) const

Definition at line 1457 of file SurfacePoint.cpp.

◆ GetXWeight()

double Isis::SurfacePoint::GetXWeight ( ) const

Return X weight for bundle adjustment Units are 1/(kilometers)^2.

Definition at line 1553 of file SurfacePoint.cpp.

References Isis::Distance::kilometers(), and Isis::IException::Programmer.

Referenced by GetWeight().

◆ GetY()

Displacement Isis::SurfacePoint::GetY ( ) const

Definition at line 1443 of file SurfacePoint.cpp.

◆ GetYSigma()

Distance Isis::SurfacePoint::GetYSigma ( ) const

Definition at line 1464 of file SurfacePoint.cpp.

◆ GetYWeight()

double Isis::SurfacePoint::GetYWeight ( ) const

Return Y weight for bundle adjustment Units are 1/(kilometers)^2.

Definition at line 1571 of file SurfacePoint.cpp.

References Isis::Distance::kilometers(), and Isis::IException::Programmer.

Referenced by GetWeight().

◆ GetZ()

Displacement Isis::SurfacePoint::GetZ ( ) const

Definition at line 1450 of file SurfacePoint.cpp.

◆ GetZSigma()

Distance Isis::SurfacePoint::GetZSigma ( ) const

Definition at line 1471 of file SurfacePoint.cpp.

◆ GetZWeight()

double Isis::SurfacePoint::GetZWeight ( ) const

Return Z weight for bundle adjustment Units are 1/(kilometers)^2.

Definition at line 1589 of file SurfacePoint.cpp.

References Isis::Distance::kilometers(), and Isis::IException::Programmer.

Referenced by GetWeight().

◆ InitCovariance()

void Isis::SurfacePoint::InitCovariance ( )

private

Initialize the variance/covariance matrices.

Definition at line 195 of file SurfacePoint.cpp.

References p_rectCovar, and p_sphereCovar.

Referenced by SurfacePoint(), SurfacePoint(), SurfacePoint(), SurfacePoint(), and SurfacePoint().

◆ InitPoint()

void Isis::SurfacePoint::InitPoint ( )

private

Initialize a surface point.

Definition at line 205 of file SurfacePoint.cpp.

Referenced by SurfacePoint(), SurfacePoint(), SurfacePoint(), SurfacePoint(), and SurfacePoint().

◆ LatitudeToMeters()

double Isis::SurfacePoint::LatitudeToMeters ( double relativeLat ) const

This method returns a Displacement of an Angle relative to the current SurfacePoint latitude.

It should only be used to convert relative latitudes near the SurfacePoint latitude. Typical usage would be to convert latitude sigmas and point corrections for the SurfacePoint.

Parameters

latRadians The latitude in Angle units to convert to Displacement units

Returns: LatDisp The converted latitude in displacement units at the SurfacePoint latitude

Definition at line 1310 of file SurfacePoint.cpp.

References GetLocalRadius(), Isis::IsSpecial(), Isis::Distance::meters(), and Isis::Null.

Referenced by Isis::BundleControlPoint::formatBundleLatitudinalOutputDetailString(), and GetLatSigmaDistance().

◆ LatitudinalDerivative()

std::vector< double > Isis::SurfacePoint::LatitudinalDerivative ( CoordIndex index )

Compute partial derivative of the conversion of the latitudinal coordinates to body-fixed rectangular coordinates with respect to the indicated coordinate.

Parameters

index Coordinate index

Returns: std::vector<double> The derivative of the latitudinal to body-fixed vector

Definition at line 798 of file SurfacePoint.cpp.

References GetLatitude(), GetLocalRadius(), GetLongitude(), Isis::Distance::kilometers(), Isis::IException::Programmer, and Isis::Angle::radians().

Referenced by Isis::CsmBundleObservation::computePoint3DPartials(), and Partial().

◆ LatToDouble()

double Isis::SurfacePoint::LatToDouble	(	Latitude	lat,
		CoordUnits	units )

This method returns a double version of a Latitude in the specified units.

Parameters

lat	The latitude to convert to a double
units	The units in which to return the latitude (see CoordinateUnits in .h file)

Definition at line 1216 of file SurfacePoint.cpp.

References Isis::Angle::degrees(), GetLatitude(), Isis::IException::Programmer, and Isis::Angle::radians().

Referenced by GetCoord().

◆ LongitudeToMeters()

double Isis::SurfacePoint::LongitudeToMeters ( double deltaLonRadians ) const

This method returns a length in meters version of a delta longitude angle in radians relative to the current SurfacePoint longitude.

It should only be used to convert delta longitudes relative to the SurfacePoint longitude.
Typical usage would be to convert longitude sigmas and point corrections for the SurfacePoint.

Parameters

lonRadians The delta longitude in radians to convert to meters

Returns: relativeLonDist The delta longitude in meters from the SurfacePoint longitude

Definition at line 1336 of file SurfacePoint.cpp.

References GetLatitude(), GetLocalRadius(), Isis::IsSpecial(), Isis::Distance::meters(), and Isis::Null.

Referenced by Isis::BundleControlPoint::formatBundleLatitudinalOutputDetailString(), and GetLonSigmaDistance().

◆ LonToDouble()

double Isis::SurfacePoint::LonToDouble	(	Longitude	lon,
		CoordUnits	units )

This method returns a double version of a Longitude in the specified units.

Parameters

lon	The longitude to convert to a double
units	The units in which to return the longitude (see CoordinateUnits in .h file)

Definition at line 1415 of file SurfacePoint.cpp.

References Isis::Angle::degrees(), GetLongitude(), Isis::IException::Programmer, and Isis::Angle::radians().

Referenced by GetCoord().

◆ MetersToLatitude()

double Isis::SurfacePoint::MetersToLatitude ( double latLength )

This method returns an angular measure of a distance in the direction of and relative to the latitude of the SurfacePoint.

It should only be used to convert lengths relative to the SurfacePoint and in the direction of latitude. Typical usage would be to convert latitude sigmas and point corrections for the SurfacePoint.

Parameters

latLength The latitude in meters to convert to radian units

Returns: LatDispAngle The converted linear measure in radian units

Definition at line 1248 of file SurfacePoint.cpp.

References GetLocalRadius(), Isis::IsSpecial(), Isis::Distance::meters(), and Isis::Null.

Referenced by Isis::BundleControlPoint::setSigmaWeightFromGlobals(), and SetSphericalSigmasDistance().

◆ MetersToLongitude()

double Isis::SurfacePoint::MetersToLongitude ( double deltaLonMeters )

This method returns an angular measure in radians of a distance in the direction of and relative to the longitude of the SurfacePoint.

It should only be used to
convert lengths relative to the SurfacePoint and in the direction of longitude. Typical usage is to convert longitude sigmas and point corrections for the SurfacePoint.

Parameters

lonLength The delta longitude distance in meters to convert to radians

Returns: LonDistAngle The converted delta length in radians

History: 2019-05-29 Debbie A. Cook Changed test constant from DBL_EPSILON to 1.0e-50 to fix possible false errors from reasonably small distances on fixed or tightly constrained points occurring during error propagation in jigsaw.

Definition at line 1276 of file SurfacePoint.cpp.

References GetLatitude(), GetLocalRadius(), Isis::IsSpecial(), Isis::Distance::meters(), Isis::Null, and Isis::PI.

Referenced by Isis::BundleControlPoint::setSigmaWeightFromGlobals(), and SetSphericalSigmasDistance().

◆ operator=()

SurfacePoint & Isis::SurfacePoint::operator= ( const SurfacePoint & other )

Definition at line 1970 of file SurfacePoint.cpp.

◆ operator==()

bool Isis::SurfacePoint::operator== ( const SurfacePoint & other ) const

Definition at line 1929 of file SurfacePoint.cpp.

◆ Partial()

std::vector< double > Isis::SurfacePoint::Partial	(	CoordinateType	type,
		CoordIndex	index )

Compute partial derivative of conversion from body-fixed coordinates to the specified.

Compute partial derivative of the conversion of the body-fixed surface point coordinate to the specified coordinate type.

Parameters

covar variance/covariance matrix

Returns: void

Definition at line 773 of file SurfacePoint.cpp.

References Latitudinal, LatitudinalDerivative(), Isis::IException::Programmer, Rectangular, RectangularDerivative(), and Isis::toString().

Referenced by Isis::IsisBundleObservation::computePoint3DPartials().

◆ RectangularDerivative()

std::vector< double > Isis::SurfacePoint::RectangularDerivative ( CoordIndex index )

Compute partial derivative of the body-fixed rectangular coordinates with respect to the indicated coordinate.

Parameters

index Coordinate index

Returns: std::vector<double> The derivative of the body-fixed vector

Definition at line 840 of file SurfacePoint.cpp.

References Isis::IException::Programmer.

Referenced by Partial().

◆ ResetLocalRadius()

void Isis::SurfacePoint::ResetLocalRadius ( const Distance & radius )

This method resets the local radius of a SurfacePoint.

Parameters

radius The new local radius value to set

Definition at line 914 of file SurfacePoint.cpp.

References GetLatitude(), GetLongitude(), Isis::Displacement::isValid(), Isis::IException::Programmer, Isis::Angle::radians(), and Isis::Displacement::setKilometers().

◆ SetMatrix()

void Isis::SurfacePoint::SetMatrix	(	CoordinateType	type,
		const boost::numeric::ublas::symmetric_matrix< double, boost::numeric::ublas::upper > &	covar )

Set the covariance matrix.

Set covariance matrix in km.

Parameters

covar variance/covariance matrix

Returns: void

Definition at line 749 of file SurfacePoint.cpp.

References Latitudinal, Isis::IException::Programmer, Rectangular, SetRectangularMatrix(), SetSphericalMatrix(), and Isis::toString().

Referenced by Isis::BundleAdjust::errorPropagation(), Isis::BundleAdjust::formLidarPointNormals(), and Isis::BundleAdjust::formPointNormals().

◆ SetRectangular()

void Isis::SurfacePoint::SetRectangular	(	const Displacement &	x,
		const Displacement &	y,
		const Displacement &	z,
		const Distance &	xSigma = Distance(),
		const Distance &	ySigma = Distance(),
		const Distance &	zSigma = Distance() )

Set surface point in rectangular body-fixed coordinates wtih optional sigmas.

Parameters

x	x value of body-fixed coordinate of surface point
y	y value of body-fixed coordinate of surface point
z	z value of body-fixed coordinate of surface point
xSigma	x sigma of body-fixed coordinate of surface point
ySigma	y sigma of body-fixed coordinate of surface point
zSigma	z sigma of body-fixed coordinate of surface point

Returns: void

Definition at line 283 of file SurfacePoint.cpp.

References SetRectangularPoint(), and SetRectangularSigmas().

Referenced by Isis::ControlPoint::ComputeApriori(), Isis::ControlPointV0001::ControlPointV0001(), Isis::QnetSetAprioriDialog::fillAverageAprioriLineEdits(), SurfacePoint(), and SurfacePoint().

◆ SetRectangularCoordinates()

void Isis::SurfacePoint::SetRectangularCoordinates	(	const Displacement &	x,
		const Displacement &	y,
		const Displacement &	z )

Set surface point in rectangular coordinates.

Parameters

x	x value of body-fixed coordinate of surface point
y	y value of body-fixed coordinate of surface point
z	z value of body-fixed coordinate of surface point

Returns: void

Definition at line 327 of file SurfacePoint.cpp.

References SetRectangularPoint().

◆ SetRectangularMatrix()

void Isis::SurfacePoint::SetRectangularMatrix	(	const boost::numeric::ublas::symmetric_matrix< double, boost::numeric::ublas::upper > &	covar,
		SurfacePoint::CoordUnits	units = SurfacePoint::Meters )

Set rectangular covariance matrix and store in units of km**2.

Parameters

covar	Rectangular variance/covariance matrix
units	Units of matrix are units**2

Returns: void

Definition at line 376 of file SurfacePoint.cpp.

References Isis::Displacement::meters(), p_rectCovar, p_sphereCovar, and Isis::IException::Programmer.

Referenced by Isis::ControlNetVersioner::createPoint(), SetMatrix(), and SetRectangularSigmas().

◆ SetRectangularPoint()

void Isis::SurfacePoint::SetRectangularPoint	(	const Displacement &	x,
		const Displacement &	y,
		const Displacement &	z )

private

This is a private method to set a surface point in rectangular, body-fixed coordinates.

This method isolates the procedure for setting a rectangular point in one place.

Parameters

x	x value of body-fixed coordinate of surface point
y	y value of body-fixed coordinate of surface point
z	z value of body-fixed coordinate of surface point

Returns: void

Definition at line 225 of file SurfacePoint.cpp.

References ComputeLocalRadius(), GetLocalRadius(), Isis::Displacement::isValid(), Isis::Distance::isValid(), and Isis::IException::User.

Referenced by SetRectangular(), SetRectangularCoordinates(), and SetSphericalPoint().

◆ SetRectangularSigmas()

void Isis::SurfacePoint::SetRectangularSigmas	(	const Distance &	xSigma,
		const Distance &	ySigma,
		const Distance &	zSigma )

Set surface point and sigmas in rectangular coordinates and convert to planetocentric.

Set the rectangular sigmas into the rectangular variance/covariance matrix with diagonal element units of km^2, km^2, and km^2.

Parameters

xSigma	x sigma of body-fixed coordinate of surface point
ySigma	y sigma of body-fixed coordinate of surface point
zSigma	z sigma of body-fixed coordinate of surface point

History

2017-07-25 Debbie A. Cook Added documentation and corrected units for diagonal elements to be km^2 instead of m^2.

2017-11-22 Debbie A. Cook Updated call to SetRectangularMatrix

Definition at line 350 of file SurfacePoint.cpp.

References SetRectangularMatrix(), and Isis::IException::User.

Referenced by SetRectangular().

◆ SetSpherical()

void Isis::SurfacePoint::SetSpherical	(	const Latitude &	lat,
		const Longitude &	lon,
		const Distance &	radius,
		const Angle &	latSigma = Angle(),
		const Angle &	lonSigma = Angle(),
		const Distance &	radiusSigma = Distance() )

Set surface point and covariance matrix in planetocentric coordinates and convert to rectangular (Latitude, Longitude in degrees, Radius in meters; matrix in radians and radians**2)

Set surface point in spherical body-fixed coordinates (lat/lon/radius) wtih optional sigmas.

Parameters

lat	Body-fixed latitude of surface point
lon	Body-fixed longitude of surface point
radius	Local radius of surface point
latSigma	Latitude sigma of of spherical coordinate of surface point
lonSigma	Longitude sigma of of spherical coordinate of surface point
radiusSigma	Local radius sigma of of spherical coordinate of surface point

Definition at line 518 of file SurfacePoint.cpp.

References SetSphericalPoint(), and SetSphericalSigmas().

Referenced by SurfacePoint().

◆ SetSphericalCoordinates()

void Isis::SurfacePoint::SetSphericalCoordinates	(	const Latitude &	lat,
		const Longitude &	lon,
		const Distance &	radius )

Update spherical coordinates (lat/lon/radius)

Parameters

lat
lon
radius

Definition at line 553 of file SurfacePoint.cpp.

References SetSphericalPoint().

◆ SetSphericalMatrix()

void Isis::SurfacePoint::SetSphericalMatrix	(	const boost::numeric::ublas::symmetric_matrix< double, boost::numeric::ublas::upper > &	covar,
		SurfacePoint::CoordUnits	units = SurfacePoint::Meters )

Set spherical covariance matrix.

Parameters

covar Spherical variance/covariance matrix (radians**2 for lat and lon)

Returns: void

Definition at line 637 of file SurfacePoint.cpp.

References GetLatitude(), GetLocalRadius(), GetLongitude(), Isis::Distance::kilometers(), Isis::Distance::meters(), p_rectCovar, p_sphereCovar, Isis::IException::Programmer, and Isis::Angle::radians().

Referenced by SetMatrix(), and SetSphericalSigmas().

◆ SetSphericalPoint()

void Isis::SurfacePoint::SetSphericalPoint	(	const Latitude &	lat,
		const Longitude &	lon,
		const Distance &	radius )

private

This is a private method to set a surface point in spherical (lat/lon/radius), body-fixed coordinates.

This method isolates the procedure for setting a spherical point in one place.

Parameters

lat	Body-fixed latitude of surface point
lon	Body-fixed longitude of surface point
radius	Local radius of surface point

Returns: void

Definition at line 480 of file SurfacePoint.cpp.

References Isis::Displacement::Kilometers, SetRectangularPoint(), and Isis::IException::User.

Referenced by SetSpherical(), SetSphericalCoordinates(), and SurfacePoint().

◆ SetSphericalSigmas()

void Isis::SurfacePoint::SetSphericalSigmas	(	const Angle &	latSigma,
		const Angle &	lonSigma,
		const Distance &	radiusSigma )

Set the spherical sigmas into the spherical variance/covariance matrix in diagonal units of radians^2, radians^2, km^2.

Parameters

latSigma	Latitude sigma of body-fixed coordinate of surface point
lonSigma	Longitude sigma of body-fixed coordinate of surface point
radiusSigma	Radius sigma of body-fixed coordinate of surface point

History

2017-07-25 Debbie A. Cook Added documentation and corrected units for covar(2,2) to be km^2 instead of m^2.

2017-11-22 Debbie A. Cook Set units for covar(2,2) back to m^2 which is not the default for the set method.

Definition at line 573 of file SurfacePoint.cpp.

References p_rectCovar, p_sphereCovar, and SetSphericalMatrix().

Referenced by SetSpherical(), and SetSphericalSigmasDistance().

◆ SetSphericalSigmasDistance()

void Isis::SurfacePoint::SetSphericalSigmasDistance	(	const Distance &	latSigma,
		const Distance &	lonSigma,
		const Distance &	radiusSigma )

Set the spherical sigmas (in Distance units) into the spherical variance/covariance matrix.

Parameters

latSigma	Latitude sigma of body-fixed coordinate of surface point as a Distance
lonSigma	Longitude sigma of body-fixed coordinate of surface point as a Distance
radiusSigma	Radius sigma of body-fixed coordinate of surface point in meters

History: 2018-06-28 Debbie A. Cook Revised to use the local radius of the SurfacePoint to convert distance to angle instead of the major equatorial axis. Also corrected longitude conversion. See note in SurfacePoint.h. References #5457.

Definition at line 617 of file SurfacePoint.cpp.

References MetersToLatitude(), MetersToLongitude(), Isis::IException::Programmer, Isis::Angle::Radians, and SetSphericalSigmas().

Referenced by Isis::QnetSetAprioriDialog::setApriori().

◆ stringToCoordinateType()

SurfacePoint::CoordinateType Isis::SurfacePoint::stringToCoordinateType ( QString type )

static

This method converts the given string value to a SurfacePoint::CoordinateType enumeration.

Currently (March 31, 2017) accepted inputs are listed below.
This method is case insensitive.

Parameters

type	The coordinate type name to be converted

Returns: CoordinateType The enumeration corresponding to the input name

Definition at line 1363 of file SurfacePoint.cpp.

References Latitudinal, Isis::IException::Programmer, and Rectangular.

Referenced by Isis::BundleSettings::XmlHandler::startElement().

◆ ToNaifArray()

void Isis::SurfacePoint::ToNaifArray ( double naifOutput[3] ) const

A naif array is a c-style array of size 3.

The element types are double... keep in mind a SpiceDouble is a double. The values' units are kilometers because that is the unit naif works in. The first element is X, the second Y, and the third Z.

Parameters

naifOutput The naif array to populate with the surface point's XYZ position.

Definition at line 870 of file SurfacePoint.cpp.

References Isis::Displacement::kilometers(), and Isis::IException::Programmer.

Referenced by Isis::TriangularPlate::hasPoint(), Isis::TriangularPlate::point(), and Isis::RadarGroundMap::SetGround().

◆ Valid()

bool Isis::SurfacePoint::Valid ( ) const

Definition at line 947 of file SurfacePoint.cpp.

Member Data Documentation

◆ p_localRadius

Distance Isis::SurfacePoint::p_localRadius

private

Definition at line 306 of file SurfacePoint.h.

◆ p_rectCovar

boost::numeric::ublas::symmetric_matrix<double,boost::numeric::ublas::upper>* Isis::SurfacePoint::p_rectCovar

private

3x3 upper triangular covariance matrix rectangular coordinates

Definition at line 312 of file SurfacePoint.h.

Referenced by InitCovariance(), SetRectangularMatrix(), SetSphericalMatrix(), SetSphericalSigmas(), and SurfacePoint().

◆ p_sphereCovar

boost::numeric::ublas::symmetric_matrix<double,boost::numeric::ublas::upper>* Isis::SurfacePoint::p_sphereCovar

private

3x3 upper triangular covariance matrix ocentric coordinates

Definition at line 315 of file SurfacePoint.h.

Referenced by InitCovariance(), SetRectangularMatrix(), SetSphericalMatrix(), SetSphericalSigmas(), and SurfacePoint().

◆ p_x

Displacement* Isis::SurfacePoint::p_x

private

Definition at line 307 of file SurfacePoint.h.

◆ p_y

Displacement* Isis::SurfacePoint::p_y

private

Definition at line 308 of file SurfacePoint.h.

◆ p_z

Displacement* Isis::SurfacePoint::p_z

private

Definition at line 309 of file SurfacePoint.h.

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

src/base/objs/SurfacePoint/SurfacePoint.h
src/base/objs/SurfacePoint/SurfacePoint.cpp

Public Types

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ CoordinateType

◆ CoordIndex

◆ CoordUnits

Constructor & Destructor Documentation

◆ SurfacePoint() [1/6]

◆ SurfacePoint() [2/6]

◆ SurfacePoint() [3/6]

◆ SurfacePoint() [4/6]

◆ SurfacePoint() [5/6]

◆ SurfacePoint() [6/6]

◆ ~SurfacePoint()

Member Function Documentation

◆ ComputeLocalRadius()

◆ coordinateTypeToString()

◆ DisplacementToDouble()

◆ DistanceToDouble()

◆ FreeAllocatedMemory()

◆ FromNaifArray()

◆ GetCoord()

◆ GetDistanceToPoint() [1/2]

◆ GetDistanceToPoint() [2/2]

◆ GetLatitude()

◆ GetLatSigma()

◆ GetLatSigmaDistance()

◆ GetLatWeight()

◆ GetLocalRadius()

◆ GetLocalRadiusSigma()

◆ GetLocalRadiusWeight()

◆ GetLongitude()

◆ GetLonSigma()

◆ GetLonSigmaDistance()

◆ GetLonWeight()

◆ GetRectangularMatrix()

◆ GetSigma()

◆ GetSigmaDistance()

◆ GetSphericalMatrix()

◆ GetWeight()

◆ GetX()

◆ GetXSigma()

◆ GetXWeight()

◆ GetY()

◆ GetYSigma()

◆ GetYWeight()

◆ GetZ()

◆ GetZSigma()

◆ GetZWeight()

◆ InitCovariance()

◆ InitPoint()

◆ LatitudeToMeters()

◆ LatitudinalDerivative()

◆ LatToDouble()

◆ LongitudeToMeters()

◆ LonToDouble()

◆ MetersToLatitude()

◆ MetersToLongitude()

◆ operator=()

◆ operator==()

◆ Partial()

◆ RectangularDerivative()

◆ ResetLocalRadius()

◆ SetMatrix()

◆ SetRectangular()

◆ SetRectangularCoordinates()

◆ SetRectangularMatrix()

◆ SetRectangularPoint()

◆ SetRectangularSigmas()

◆ SetSpherical()

◆ SetSphericalCoordinates()

◆ SetSphericalMatrix()

◆ SetSphericalPoint()

◆ SetSphericalSigmas()

◆ SetSphericalSigmasDistance()

◆ stringToCoordinateType()