Defines an angle and provides unit conversions. More...

#include <Angle.h>

Inheritance diagram for Isis::Angle:

Collaboration diagram for Isis::Angle:

Public Types
enum	Units { Degrees, Radians }
	The set of usable angle measurement units. More...

Public Member Functions
	Angle ()
	Constructs a blank angle object which needs a value to be set in order to do any calculations. More...

	Angle (double angle, Units unit)
	Constructs an angle object with the entered value and unit. More...

	Angle (const Angle &angle)
	Constructs an angle object from another Angle object. More...

	Angle (QString angle)
	Constructs an angle object with units of Angle::Degrees from a QString of the general form "dd mm ss.ss" (there can be more than 2 digits per piece.) More...

virtual	~Angle ()
	Destroys the angle object. More...

bool	isValid () const
	This indicates whether we have a legitimate angle stored or are in an unset, or invalid, state. More...

Angle &	operator= (const Angle &angle2)
	Assign angle object equal to another. More...

Angle	operator+ (const Angle &angle2) const
	Add angle value to another. More...

Angle	operator- (const Angle &angle2) const
	Subtract angle value from another and return the resulting angle. More...

Angle	operator* (double value) const
	Multiply this angle by a double and return the resulting angle. More...

Angle	operator/ (double value) const
	Divide this angle by a double. More...

double	operator/ (Angle value) const
	Divide this angle by another angle and return the ratio. More...

bool	operator< (const Angle &angle2) const
	Test if the other angle is less than the current angle. More...

bool	operator> (const Angle &angle2) const
	Test if the other angle is greater than the current angle. More...

void	operator+= (const Angle &angle2)
	Add angle value to another as double and replace original. More...

void	operator-= (const Angle &angle2)
	Subtract angle value from another and set this instance to the resulting angle. More...

Angle	operator* (int value) const
	Multiply this angle by an integer and return the resulting angle. More...

void	operator*= (double value)
	Multiply this angle by a double and set this instance to the resulting angle. More...

Angle	operator/ (int value) const
	Divide this angle by an integer and return the resulting angle. More...

void	operator/= (double value)
	Divide this angle by a double and return the resulting angle. More...

bool	operator== (const Angle &angle2) const
	Test if another angle is equal to this angle. More...

bool	operator!= (const Angle &angle2) const
	Test if another angle is not equal to this angle. More...

bool	operator<= (const Angle &angle2) const
	Test if the other angle is less than or equal to the current angle. More...

bool	operator>= (const Angle &angle2) const
	Test if the other angle is greater than or equal to the current angle. More...

double	radians () const
	Convert an angle to a double. More...

double	degrees () const
	Get the angle in units of Degrees. More...

void	setRadians (double radians)
	Set the angle in units of Radians. More...

void	setDegrees (double degrees)
	Set the angle in units of Degrees. More...

virtual QString	toString (bool includeUnits=true) const
	Get the angle in human-readable form. More...

double	unitWrapValue (const Units &unit) const
	Return wrap value in desired units. More...

virtual double	angle (const Units &unit) const
	Return angle value in desired units. More...

virtual void	setAngle (const double &angle, const Units &unit)
	Set angle value in desired units. More...

Static Public Member Functions
static Angle	fullRotation ()
	Makes an angle to represent a full rotation (0-360 or 0-2pi). More...

Private Attributes
double	m_radians
	The angle measure, always stored in radians. More...

Friends
Angle	operator* (double mult, Angle angle)
	Multiply this angle by a double and return the resulting angle. More...

Detailed Description

Defines an angle and provides unit conversions.

Author: 2010-10-09 Debbie A. Cook

History:

2010-11-01 Steven Lambright - Added methods setRadians and SetDegrees

2012-02-16 Steven Lambright - Brought up to method and member naming standards.

2012-03-22 Steven Lambright - Renamed text() to toString().

2012-06-29 Steven Lambright and Kimberly Oyama - Removed duplicate code from the constructor. Added the fullRotation() method which creates an angle of 360 degrees and modified the unit test to exercise this. References #958.

2012-07-26 Steven Lambright and Kimberly Oyama - Modified the < and > operators to make sure they do not return true if the two operands are the same. Updated the unitTest to exercise this change. References #604.

2013-02-01 Steven Lambright - Added QDebug() printout capabilities. References #1060.

2014-07-28 Kristin Berry - Added a constructor which accepts a Qstring of the form: "dd mm ss.ss" for angles provided in this format.

2014-08-21 Jeannie Backer - Modified isValid to utilize the IsValidPixel() method in the SpecialPixel header. References #1659.

2017-07-03 Makayla Shepherd - Updated documentation. References #4807.

2018-11-13 Kristin Berry - Made protected methods public as part of testing refactor.

2019-03-11 Kaitlyn Lee - Added comments to > and < operators to clarify why the != comparison was needed.

Definition at line 62 of file Angle.h.

Member Enumeration Documentation

◆ Units

enum Isis::Angle::Units

The set of usable angle measurement units.

Enumerator

Degrees

Degrees are generally considered more human readable, 0-360 is one circle, however most math does not use this unit.

Use these for displaying to the user and accepting input from the user.

Radians

Radians are generally used in mathematical equations, 0-2*PI is one circle, however these are more difficult for users to understand when displayed since they have PI in them.

This is the default unit and is necessary for most math library calls.

Definition at line 66 of file Angle.h.

Constructor & Destructor Documentation

◆ Angle() [1/4]

Isis::Angle::Angle ( )

Constructs a blank angle object which needs a value to be set in order to do any calculations.

Definition at line 38 of file Angle.cpp.

References m_radians, and Isis::Null.

Referenced by Isis::Longitude::force180Domain(), fullRotation(), operator*(), operator+(), operator-(), operator/(), Isis::Latitude::planetographic(), Isis::Latitude::setAngle(), and Isis::Latitude::setPlanetographic().

◆ Angle() [2/4]

Isis::Angle::Angle	(	double	angle,
		Units	unit
	)

Constructs an angle object with the entered value and unit.

Parameters

angle	The initial angle value in units of the unit parameter
unit	The unit of the initial angle (see Angle::Units)

Definition at line 48 of file Angle.cpp.

References angle(), and setAngle().

◆ Angle() [3/4]

Isis::Angle::Angle ( const Angle & fromAngle )

Constructs an angle object from another Angle object.

Parameters

fromAngle The angle object to copy on initialization

Definition at line 58 of file Angle.cpp.

References m_radians.

◆ Angle() [4/4]

Isis::Angle::Angle ( QString angle )

Constructs an angle object with units of Angle::Degrees from a QString of the general form "dd mm ss.ss" (there can be more than 2 digits per piece.)

Parameters

angle The value of the angle in degrees, as a QString of the form: "dd mm ss.ss"

Definition at line 69 of file Angle.cpp.

References _FILEINFO_, angle(), Degrees, degrees(), Isis::IException::Programmer, and setAngle().

◆ ~Angle()

Isis::Angle::~Angle ( )

virtual

Destroys the angle object.

Definition at line 98 of file Angle.cpp.

References m_radians, and Isis::Null.

Member Function Documentation

◆ angle()

double Isis::Angle::angle ( const Units & unit ) const

virtual

Return angle value in desired units.

Parameters

unit	Desired units of the angle (see Angle::Units)

Returns: angle value in specified units

Definition at line 304 of file Angle.cpp.

References _FILEINFO_, Degrees, m_radians, Isis::Null, Isis::IException::Programmer, Isis::RAD2DEG, and Radians.

Referenced by Angle(), degrees(), Isis::Longitude::force360Domain(), operator<(), operator==(), operator>(), Isis::Latitude::planetocentric(), Isis::Longitude::positiveEast(), Isis::Longitude::positiveWest(), radians(), Isis::Latitude::setAngle(), and setAngle().

◆ degrees()

double Isis::Angle::degrees ( ) const

inline

Get the angle in units of Degrees.

Returns: A double-value representing this angle. Null if not valid.

Definition at line 249 of file Angle.h.

References angle(), and Degrees.

Referenced by Angle(), Isis::MosaicGridTool::autoGrid(), Isis::PhotometricFunction::compute(), Isis::ControlPointEditWidget::createTemporaryGroundMeasure(), Isis::MosaicGridTool::drawGrid(), Isis::QnetSetAprioriDialog::fillAverageAprioriLineEdits(), Isis::QnetSetAprioriDialog::fillCurrentAprioriLineEdits(), Isis::QnetSetAprioriDialog::fillReferenceAprioriLineEdits(), Isis::QnetTool::findPointLocation(), Isis::Longitude::force180Domain(), Isis::Longitude::force360Domain(), Isis::BundleControlPoint::formatBundleLatitudinalOutputDetailString(), Isis::BundleTargetBody::formatBundleOutputString(), Isis::ImageTreeWidgetItem::ImageTreeWidgetItem(), Isis::DemShape::localRadius(), operator<<(), Isis::ControlNetFilter::PointLatLonFilter(), Isis::MosaicGridToolConfigDialog::readSettings(), Isis::MosaicGridToolConfigDialog::refreshWidgetStates(), Isis::FeatureNomenclature::runQuery(), Isis::Latitude::setAngle(), setDegrees(), Isis::VimsGroundMap::SetGround(), Isis::UniversalGroundMap::SetGround(), Isis::CameraGroundMap::SetGround(), Isis::Camera::SetGround(), Isis::ControlPointEditWidget::setShapesForPoint(), Isis::BundleTargetBody::setSolveSettings(), Isis::UniversalGroundMap::SetUnboundGround(), Isis::RingPlaneProjection::To180Domain(), Isis::TProjection::To180Domain(), Isis::RingPlaneProjection::To360Domain(), Isis::TProjection::To360Domain(), Isis::MosaicGridTool::toPvl(), Isis::ControlNetVersioner::toPvl(), toString(), Isis::Sensor::UniversalLatitude(), Isis::Sensor::UniversalLongitude(), Isis::BundleControlPoint::updateAdjustedSurfacePointLatitudinally(), Isis::MeasureTool::updateDist(), Isis::SunShadowTool::updateRow(), Isis::AdvancedTrackTool::updateRow(), Isis::ControlPointEditWidget::updateSurfacePointInfo(), and Isis::QnetTool::updateSurfacePointInfo().

◆ fullRotation()

Angle Isis::Angle::fullRotation ( )

static

Makes an angle to represent a full rotation (0-360 or 0-2pi).

Returns: the angle of 1 full rotation

Definition at line 121 of file Angle.cpp.

References Angle(), and Degrees.

Referenced by Isis::Hillshade::shadedValue(), and Isis::Longitude::to360Range().

◆ isValid()

bool Isis::Angle::isValid ( ) const

This indicates whether we have a legitimate angle stored or are in an unset, or invalid, state.

Returns: True if we have a legitimate angle value, false if not initialized

Definition at line 110 of file Angle.cpp.

References m_radians, and Isis::Null.

Referenced by Isis::FeatureNomenclatureTool::FeaturePosition::applyExtentType(), Isis::GroundGrid::CreateGrid(), Isis::Longitude::force180Domain(), Isis::Longitude::force360Domain(), Isis::UniversalGroundMap::GroundRange(), Isis::DemShape::localRadius(), Isis::SunShadowTool::mouseMove(), operator*(), operator+(), operator-(), operator/(), operator<(), operator>(), Isis::Latitude::planetographic(), Isis::NaifDskPlateModel::point(), Isis::Shape::save(), Isis::Image::save(), Isis::ControlPoint::SetAprioriSurfacePoint(), Isis::Hillshade::setAzimuth(), Isis::GroundGrid::SetGroundLimits(), Isis::Camera::SetImageMapProjection(), Isis::SurfacePoint::SetSpherical(), Isis::SurfacePoint::SetSphericalPoint(), Isis::SurfacePoint::SetSphericalSigmas(), Isis::Hillshade::setZenith(), Isis::Longitude::to360Range(), toString(), and Isis::SunShadowTool::updateRow().

◆ operator!=()

bool Isis::Angle::operator!= ( const Angle & angle2 ) const

inline

Test if another angle is not equal to this angle.

Takes the negated result of the '==' operator.

Parameters

angle2 The comparison angle (on right-hand-side of != operator)

Returns: true if the angle does not equal the comparision angle

Definition at line 203 of file Angle.h.

◆ operator*() [1/2]

Angle Isis::Angle::operator* ( double value ) const

Multiply this angle by a double and return the resulting angle.

If this is an invalid angle, then the result will be an invalid angle.

Parameters

value The value to multiply to this angle

Returns: Multiplied angle

Definition at line 169 of file Angle.cpp.

References Angle(), isValid(), Radians, and radians().

◆ operator*() [2/2]

Angle Isis::Angle::operator* ( int value ) const

inline

Multiply this angle by an integer and return the resulting angle.

Parameters

value The integer value to multiply with this angle

Returns: Product of the angles

Definition at line 143 of file Angle.h.

◆ operator*=()

void Isis::Angle::operator*= ( double value )

inline

Multiply this angle by a double and set this instance to the resulting angle.

Parameters

value The double value to multiply with this angle

Definition at line 154 of file Angle.h.

◆ operator+()

Angle Isis::Angle::operator+ ( const Angle & angle2 ) const

Add angle value to another.

If either of these are invalid angles, then the result will be an invalid angle.

Parameters

angle2 The angle to add to this angle

Returns: sum angle

Definition at line 133 of file Angle.cpp.

References Angle(), isValid(), Radians, and radians().

◆ operator+=()

void Isis::Angle::operator+= ( const Angle & angle2 )

inline

Add angle value to another as double and replace original.

Parameters

angle2 The angle to add to this angle

Returns: sum angle, replaces original

Definition at line 121 of file Angle.h.

◆ operator-()

Angle Isis::Angle::operator- ( const Angle & angle2 ) const

Subtract angle value from another and return the resulting angle.

If either of these are invalid angles, then the result will be an invalid angle.

Parameters

angle2 The angle to subtract from this angle

Returns: difference angle

Definition at line 151 of file Angle.cpp.

References Angle(), isValid(), Radians, and radians().

◆ operator-=()

void Isis::Angle::operator-= ( const Angle & angle2 )

inline

Subtract angle value from another and set this instance to the resulting angle.

Parameters

angle2 The angle to subtract from this angle

Definition at line 132 of file Angle.h.

◆ operator/() [1/3]

Angle Isis::Angle::operator/ ( double value ) const

Divide this angle by a double.

Parameters

value The double value to use as the divisor

Returns: Quotient of the angles

Definition at line 196 of file Angle.cpp.

References Angle(), isValid(), Radians, and radians().

◆ operator/() [2/3]

double Isis::Angle::operator/ ( Angle value ) const

Divide this angle by another angle and return the ratio.

Parameters

value The ratio, Null if invalid

Returns: Quotient of the angles

Definition at line 209 of file Angle.cpp.

References isValid(), Isis::Null, and radians().

◆ operator/() [3/3]

Angle Isis::Angle::operator/ ( int value ) const

inline

Divide this angle by an integer and return the resulting angle.

Parameters

value The double value to use as the divisor

Returns: Quotient of the angles

Definition at line 165 of file Angle.h.

◆ operator/=()

void Isis::Angle::operator/= ( double value )

inline

Divide this angle by a double and return the resulting angle.

Parameters

value The double value to use as the divisor

Definition at line 175 of file Angle.h.

◆ operator<()

bool Isis::Angle::operator< ( const Angle & angle2 ) const

Test if the other angle is less than the current angle.

If either is invalid, then an exception will be thrown.

Parameters

angle2 The comparison angle (on right-hand-side of < operator)

Returns: True if the angle is less than the comparision angle

Definition at line 223 of file Angle.cpp.

References _FILEINFO_, angle(), isValid(), Isis::IException::Programmer, and Radians.

◆ operator<=()

bool Isis::Angle::operator<= ( const Angle & angle2 ) const

inline

Test if the other angle is less than or equal to the current angle.

Parameters

angle2 The comparison angle (on right-hand-side of < operator)

Returns: true if the angle is less than or equal to the comparision angle

Definition at line 214 of file Angle.h.

◆ operator=()

Angle& Isis::Angle::operator= ( const Angle & angle2 )

inline

Assign angle object equal to another.

Parameters

angle2 The angle value to copy

Returns: The new angle value

Definition at line 100 of file Angle.h.

References Radians, radians(), and setAngle().

◆ operator==()

bool Isis::Angle::operator== ( const Angle & angle2 ) const

inline

Test if another angle is equal to this angle.

This does not compensate for going around a circle: Angle(360, Angle::Degrees) does not equal Angle(0, Angle::Degrees)

Invalid angles are equal to each other.

Parameters

angle2 The comparison angle (on right-hand-side of == operator)

Returns: true if the angle equals the comparision angle

Definition at line 191 of file Angle.h.

References angle(), and Radians.

◆ operator>()

bool Isis::Angle::operator> ( const Angle & angle2 ) const

Test if the other angle is greater than the current angle.

If either is invalid, then an exception will be thrown.

Parameters

angle2 The comparison angle (on right-hand-side of > operator)

Returns: True if the angle is greater than the comparision angle

Definition at line 241 of file Angle.cpp.

References _FILEINFO_, angle(), isValid(), Isis::IException::Programmer, and Radians.

◆ operator>=()

bool Isis::Angle::operator>= ( const Angle & angle2 ) const

inline

Test if the other angle is greater than or equal to the current angle.

Parameters

angle2 The comparison angle (on right-hand-side of < operator)

Returns: true if the angle is greater than or equal to the comparision angle

Definition at line 226 of file Angle.h.

◆ radians()

double Isis::Angle::radians ( ) const

inline

Convert an angle to a double.

This will return the radians version of the angle.

Returns: The angle value in radians

operator double() const { return angle(Radians); } Get the angle in units of Radians.

Returns: A double-value representing this angle. Null if not valid.

Definition at line 243 of file Angle.h.

References angle(), and Radians.

Referenced by Isis::Latitude::add(), Isis::MosaicAreaTool::calcLatLonRange(), Isis::CameraGroundMap::EllipsoidPartial(), Isis::SurfacePoint::GetDistanceToPoint(), Isis::Camera::GetLocalNormal(), Isis::Longitude::inRange(), Isis::Latitude::Latitude(), Isis::EmbreeShapeModel::latlonToRay(), Isis::BulletShapeModel::latlonToVector(), Isis::EllipsoidShape::localRadius(), Isis::BundleTargetBody::localRadius(), Isis::Longitude::Longitude(), Isis::SunShadowTool::mouseMove(), operator*(), operator+(), operator-(), operator/(), operator<<(), operator=(), Isis::FeatureNomenclatureTool::ViewportFeatureDisplay::paint(), Isis::Latitude::planetographic(), Isis::CameraGroundMap::PointPartial(), Isis::LinearAlgebra::rotate(), Isis::Shape::save(), Isis::Image::save(), Isis::SpiceRotation::setEphemerisTimePckPolyFunction(), Isis::VimsGroundMap::SetGround(), Isis::Latitude::setPlanetographic(), setRadians(), Isis::BundleTargetBody::setSolveSettings(), Isis::SurfacePoint::SetSphericalPoint(), Isis::SurfacePoint::SetSphericalSigmas(), Isis::Hillshade::shadedValue(), Isis::MeasureTool::updateDist(), and Isis::SunShadowTool::updateRow().

◆ setAngle()

void Isis::Angle::setAngle	(	const double &	angle,
		const Units &	unit
	)

virtual

Set angle value in desired units.

Parameters

angle	The angle value in units of the unit parameter
unit	Desired units of the angle (see Angle::Units)

Reimplemented in Isis::Latitude.

Definition at line 338 of file Angle.cpp.

References _FILEINFO_, angle(), Isis::DEG2RAD, Degrees, Isis::IsSpecial(), m_radians, Isis::Null, Isis::IException::Programmer, and Radians.

Referenced by Angle(), operator=(), Isis::Latitude::setAngle(), setDegrees(), Isis::Longitude::setPositiveEast(), Isis::Longitude::setPositiveWest(), and setRadians().

◆ setDegrees()

void Isis::Angle::setDegrees ( double degrees )

inline

Set the angle in units of Degrees.

Parameters

degrees The new angle value, Null for invalid angle

Definition at line 263 of file Angle.h.

References Degrees, degrees(), and setAngle().

◆ setRadians()

void Isis::Angle::setRadians ( double radians )

inline

Set the angle in units of Radians.

Parameters

radians The new angle value, Null for invalid angle

Definition at line 256 of file Angle.h.

References Radians, radians(), and setAngle().

Referenced by Isis::LinearAlgebra::toAxisAngle(), and Isis::LinearAlgebra::toEulerAngles().

◆ toString()

QString Isis::Angle::toString ( bool includeUnits = true ) const

virtual

Get the angle in human-readable form.

Parameters

includeUnits Include the angle's units in the text.

Returns: A user-displayable angle string.

Definition at line 258 of file Angle.cpp.

References degrees(), isValid(), and Isis::toString().

Referenced by Isis::Latitude::inRange(), Isis::Latitude::Latitude(), Isis::operator<<(), Isis::Latitude::planetographic(), and Isis::Hillshade::shadedValue().

◆ unitWrapValue()

double Isis::Angle::unitWrapValue ( const Units & unit ) const

Return wrap value in desired units.

The 'wrap' value is the value where one circle occurs - angles greater than this are conceptually 'wrapping' back to zero. For example, this is 2*PI in radians because 2*PI == 0 on a circle. Please keep in mind we still differentiate those two angles.

Parameters

unit	Desired units of the Angle wrap constant (see Angle::Units)

Returns: Wrap value in specified units

Definition at line 281 of file Angle.cpp.

References _FILEINFO_, Degrees, Isis::PI, Isis::IException::Programmer, and Radians.

Referenced by Isis::Longitude::positiveWest(), and Isis::Longitude::setPositiveWest().

Friends And Related Function Documentation

◆ operator*

Angle operator*	(	double	mult,
		Angle	angle
	)

friend

Multiply this angle by a double and return the resulting angle.

If this is an invalid angle, then the result will be an invalid angle.

Parameters

mult	The value to multiply to this angle
angle	The angle being multiplied by mult

Returns: Multiplied angle

Definition at line 185 of file Angle.cpp.

Member Data Documentation

◆ m_radians

double Isis::Angle::m_radians

private

The angle measure, always stored in radians.

If degrees are requested then a conversion is done on the fly.

Definition at line 275 of file Angle.h.

Referenced by Angle(), angle(), isValid(), setAngle(), and ~Angle().

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

src/base/objs/Angle/Angle.h
src/base/objs/Angle/Angle.cpp

Public Types

Public Member Functions

Static Public Member Functions

Private Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ Units

Constructor & Destructor Documentation

◆ Angle() [1/4]

◆ Angle() [2/4]

◆ Angle() [3/4]

◆ Angle() [4/4]

◆ ~Angle()

Member Function Documentation

◆ angle()

◆ degrees()

◆ fullRotation()

◆ isValid()

◆ operator!=()

◆ operator*() [1/2]

◆ operator*() [2/2]

◆ operator*=()

◆ operator+()

◆ operator+=()

◆ operator-()

◆ operator-=()

◆ operator/() [1/3]

◆ operator/() [2/3]

◆ operator/() [3/3]

◆ operator/=()

◆ operator<()

◆ operator<=()

◆ operator=()

◆ operator==()

◆ operator>()

◆ operator>=()

◆ radians()

◆ setAngle()

◆ setDegrees()

◆ setRadians()

◆ toString()

◆ unitWrapValue()

Friends And Related Function Documentation

◆ operator*

Member Data Documentation

◆ m_radians