Displacement is a signed length, usually in meters. More...

#include <Displacement.h>

Collaboration diagram for Isis::Displacement:

Public Types
enum	Units { Meters, Kilometers, Pixels }
	This is a list of available units to access and store Distances in. More...

Public Member Functions
	Displacement ()
	This initializes the displacement to an invalid state. More...

	Displacement (double displacement, Units distanceUnit)
	This is the general purpose constructor for Displacement. More...

	Displacement (double displacementInPixels, double pixelsPerMeter)
	This is a constructor for Displacement given pixels with a conversion ratio. More...

	Displacement (const Distance &distanceToCopy)
	This creates a displacement equal to a distance. More...

	~Displacement ()
	Free the memory allocated by this instance of the displacement class. More...

double	meters () const
	Get the displacement in meters. More...

void	setMeters (double displacementInMeters)
	Set the displacement in meters. More...

double	kilometers () const
	Get the displacement in kilometers. More...

void	setKilometers (double displacementInKilometers)
	Set the displacement in kilometers. More...

double	pixels (double pixelsPerMeter=1.0) const
	Get the displacement in pixels using the given conversion ratio. More...

void	setPixels (double distanceInPixels, double pixelsPerMeter=1.0)
	Set the displacement in pixels. More...

bool	isValid () const
	Test if this displacement has been initialized or not. More...

bool	operator> (const Displacement &otherDisplacement) const
	Get the displacement in meters. More...

bool	operator< (const Displacement &otherDisplacement) const
	Compare two displacements with the less than operator. More...

bool	operator>= (const Displacement &otherDisplacement) const
	Compare the distances of 2 displacements with the >= operator. More...

bool	operator<= (const Displacement &otherDisplacement) const
	Compare the lengths of 2 displacements with the <= operator. More...

bool	operator!= (const Displacement &otherDisplacement) const
	Compare the lengths of 2 displacements with the != operator. More...

bool	operator== (const Displacement &otherDisplacement) const
	Compare the lengths of 2 displacements with the == operator. More...

Displacement	operator+ (const Displacement &displacementToAdd) const
	Add another displacement to this displacement (1km + 5m = 1005m) More...

Displacement	operator- (const Displacement &displacementToSub) const
	Subtract another displacement from this displacement (1km - 5m = 995m). More...

Displacement	operator- (const Distance &distanceToSub) const
	Subtract a distance from this displacement (1km - 5m = 995m). More...

double	operator/ (const Displacement &displacementToDiv) const
	Divide another displacement into this displacement (5m / 1m = 5). More...

Displacement	operator/ (const double &valueToDiv) const
	Divide a value from this displacement (5m / 2 = 2.5m). More...

Displacement	operator* (const double &valueToMult) const
	Multiply this displacement by a value (5m * 2 = 10m). More...

void	operator+= (const Displacement &displacementToAdd)
	Add and assign the given displacement to ourselves. More...

void	operator-= (const Displacement &displacementToSub)
	Subtract the given displacement from ourself and assign. More...

void	operator-= (const Distance &distanceToSub)
	Subtract the given distance from ourself and assign. More...

void	operator/= (const double &valueToDiv)
	Divide this displacement by a value and assign the result to ourself. More...

void	operator*= (const double &valueToMult)
	Multiply this displacement by a value and assign the result to ourself. More...

Protected Member Functions
double	displacement (Units displacementUnit) const
	This is a helper method to access displacements in a universal manner with uniform error checking. More...

void	setDisplacement (const double &displacement, Units displacementUnit)
	This is a helper method to set displacements in a universal manner with uniform error checking. More...

Private Attributes
double	m_displacementInMeters
	This is the displacement value that this class is encapsulating, always stored in meters. More...

Friends
Displacement	operator* (double mult, Displacement displacement)
	Multiply displacement by a value (5m * 2 = 10m). More...

Detailed Description

Displacement is a signed length, usually in meters.

This class is designed to encapsulate the concept of a displacement. A displacement has a distance and a sense of direction indicated by a sign (+ or -). It is typically used for vectors or coordinates, but is also available as a general purpose class. This class does accept both positive and negative values.

Author: 2010-10-12 Steven Lambright and Debbie A. Cook

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

Definition at line 31 of file Displacement.h.

Member Enumeration Documentation

◆ Units

enum Isis::Displacement::Units

This is a list of available units to access and store Distances in.

These values can be passed to the constructor to specify which unit the double you are passing in is in.

Enumerator
Meters	The distance is being specified in meters.
Kilometers	The distance is being specified in kilometers.
Pixels	The distance is being specified in pixels.

Definition at line 38 of file Displacement.h.

Constructor & Destructor Documentation

◆ Displacement() [1/4]

Isis::Displacement::Displacement ( )

This initializes the displacement to an invalid state.

You must set the displacement later on with operator= or one of the Set methods.

Definition at line 20 of file Displacement.cpp.

References Meters, Isis::Null, and setDisplacement().

Referenced by operator*(), and operator/().

◆ Displacement() [2/4]

Isis::Displacement::Displacement	(	double	displacement,
		Units	displacementUnit
	)

This is the general purpose constructor for Displacement.

This will initialize with the given displacement. If Pixels are supplied as the units, then a default pixels/meter = 1.0 will be used.

Parameters

displacement	The initial displacement; must be in units of displacementUnit
displacementUnit	The unit of displacement; can be any value in displacement::Units

Definition at line 46 of file Displacement.cpp.

References displacement(), Meters, Pixels, and setDisplacement().

◆ Displacement() [3/4]

Isis::Displacement::Displacement	(	double	displacementInPixels,
		double	pixelsPerMeter
	)

This is a constructor for Displacement given pixels with a conversion ratio.

This will initialize with the pixels converted to meters.

Parameters

displacementInPixels	The displacement to initialize with, must be in units of pixels and should not be negative
pixelsPerMeter	The pixels/meter conversion factor

Definition at line 62 of file Displacement.cpp.

References Meters, and setDisplacement().

◆ Displacement() [4/4]

Isis::Displacement::Displacement ( const Distance & distanceToCopy )

This creates a displacement equal to a distance.

Parameters

distanceToCopy This is the distance we are duplicating

Definition at line 30 of file Displacement.cpp.

References Meters, Isis::Distance::meters(), and setDisplacement().

◆ ~Displacement()

Isis::Displacement::~Displacement ( )

inline

Free the memory allocated by this instance of the displacement class.

Definition at line 55 of file Displacement.h.

Member Function Documentation

◆ displacement()

double Isis::Displacement::displacement ( Units displacementUnit ) const

protected

This is a helper method to access displacements in a universal manner with uniform error checking.

Parameters

displacementUnit Unit of the return value. If this is invalid, an exception will be thrown.

Returns: The displacement in units of displacementUnit

Definition at line 358 of file Displacement.cpp.

References Kilometers, m_displacementInMeters, Meters, Isis::Null, Pixels, and Isis::IException::Programmer.

Referenced by Displacement(), isValid(), kilometers(), meters(), pixels(), and setDisplacement().

◆ isValid()

bool Isis::Displacement::isValid ( ) const

Test if this displacement has been initialized or not.

Returns: True if this displacement has been initialized.

Definition at line 141 of file Displacement.cpp.

References displacement(), Meters, and Isis::Null.

Referenced by operator*(), operator*=(), operator+=(), operator-=(), operator/(), operator/=(), operator<(), operator>(), Isis::Area3D::setArea(), and Isis::SurfacePoint::SetRectangularPoint().

◆ kilometers()

double Isis::Displacement::kilometers ( ) const

Get the displacement in kilometers.

Returns: Current displacement, in kilometers

Definition at line 94 of file Displacement.cpp.

References displacement(), and Kilometers.

Referenced by Isis::DemShape::calculateDefaultNormal(), Isis::EllipsoidShape::calculateLocalNormal(), Isis::Sensor::Coordinate(), Isis::SurfacePoint::DisplacementToDouble(), Isis::PlaneShape::emissionAngle(), Isis::BundleControlPoint::formatBundleLatitudinalOutputDetailString(), Isis::BundleControlPoint::formatBundleRectangularOutputDetailString(), Isis::RadarGroundMap::GetXY(), Isis::CameraGroundMap::GetXY(), Isis::PlaneShape::incidenceAngle(), Isis::DemShape::intersectSurface(), Isis::Camera::LocalPhotometricAngles(), Isis::PlaneShape::localRadius(), Isis::CameraGroundMap::MeanRadiusPartial(), Isis::Sensor::SetGroundLocal(), Isis::CSMCamera::SlantDistance(), Isis::Sensor::SlantDistance(), and Isis::Sensor::SolarDistance().

◆ meters()

double Isis::Displacement::meters ( ) const

Get the displacement in meters.

Returns: Current displacement, in meters.

Definition at line 73 of file Displacement.cpp.

References displacement(), and Meters.

Referenced by Isis::ControlPointV0001::ControlPointV0001(), Isis::SurfacePoint::DisplacementToDouble(), Isis::QnetSetAprioriDialog::fillAverageAprioriLineEdits(), Isis::CSMCamera::isisToCsmGround(), operator*(), operator*=(), operator+=(), operator-=(), operator/(), operator/=(), operator<(), operator>(), Isis::SunShadowTool::recalculateShadowHeight(), Isis::Area3D::setArea(), Isis::Projection::SetUpperLeftCorner(), Isis::ControlNetVersioner::toPvl(), Isis::BundleControlPoint::updateAdjustedSurfacePointRectangularly(), and Isis::ControlNetVersioner::writeFirstPoint().

◆ operator!=()

bool Isis::Displacement::operator!= ( const Displacement & otherDisplacement ) const

inline

Compare the lengths of 2 displacements with the != operator.

Two uninitialized displacements are equal to each other.

Parameters

otherDisplacement This is the displacement we are comparing to, i.e. it is on the right-hand-side of the operator when used

Returns: True if the length of this displacement is not equal to the given displacement

Definition at line 116 of file Displacement.h.

◆ operator*()

Displacement Isis::Displacement::operator* ( const double & valueToMult ) const

Multiply this displacement by a value (5m * 2 = 10m).

Parameters

valueToMult This is the value to multiply by

Returns: Resulting value

Definition at line 264 of file Displacement.cpp.

References Displacement(), Isis::IsSpecial(), isValid(), Meters, and meters().

◆ operator*=()

void Isis::Displacement::operator*= ( const double & valueToMult )

Multiply this displacement by a value and assign the result to ourself.

Parameters

valueToMult This is the value we are going to multiply by

Definition at line 342 of file Displacement.cpp.

References Isis::IsSpecial(), isValid(), Meters, meters(), Isis::Null, and setDisplacement().

◆ operator+()

Displacement Isis::Displacement::operator+ ( const Displacement & displacementToAdd ) const

Add another displacement to this displacement (1km + 5m = 1005m)

Parameters

displacementToAdd This is the displacement we are adding to ourselves

Returns: Resulting displacement, self not modified

Definition at line 190 of file Displacement.cpp.

◆ operator+=()

void Isis::Displacement::operator+= ( const Displacement & displacementToAdd )

Add and assign the given displacement to ourselves.

Parameters

displacementToAdd This is the displacement we are to add

Definition at line 290 of file Displacement.cpp.

References isValid(), Meters, meters(), Isis::Null, and setDisplacement().

◆ operator-() [1/2]

Displacement Isis::Displacement::operator- ( const Displacement & displacementToSub ) const

Subtract another displacement from this displacement (1km - 5m = 995m).

Parameters

displacementToSub This is the displacement we are subtracting from ourself

Returns: Resulting displacement, self not modified

Definition at line 205 of file Displacement.cpp.

◆ operator-() [2/2]

Displacement Isis::Displacement::operator- ( const Distance & distanceToSub ) const

Subtract a distance from this displacement (1km - 5m = 995m).

Parameters

distanceToSub This is the displacement we are subtracting from ourself

Returns: Resulting displacement, self not modified

Definition at line 221 of file Displacement.cpp.

◆ operator-=() [1/2]

void Isis::Displacement::operator-= ( const Displacement & displacementToSub )

Subtract the given displacement from ourself and assign.

Parameters

displacementToSub This is the displacement we are to subtract

Definition at line 303 of file Displacement.cpp.

References isValid(), Meters, meters(), Isis::Null, and setDisplacement().

◆ operator-=() [2/2]

void Isis::Displacement::operator-= ( const Distance & distanceToSub )

Subtract the given distance from ourself and assign.

Parameters

distanceToSub This is the distance we are to subtract

Definition at line 316 of file Displacement.cpp.

References isValid(), Isis::Distance::isValid(), Meters, meters(), Isis::Distance::meters(), Isis::Null, and setDisplacement().

◆ operator/() [1/2]

double Isis::Displacement::operator/ ( const Displacement & displacementToDiv ) const

Divide another displacement into this displacement (5m / 1m = 5).

Parameters

displacementToDiv This is the divisor displacement (denominator)

Returns: Resulting value

Definition at line 236 of file Displacement.cpp.

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

◆ operator/() [2/2]

Displacement Isis::Displacement::operator/ ( const double & valueToDiv ) const

Divide a value from this displacement (5m / 2 = 2.5m).

Parameters

valueToDiv This is the divisor displacement (denominator)

Returns: Resulting value

Definition at line 250 of file Displacement.cpp.

References Displacement(), Isis::IsSpecial(), isValid(), Meters, and meters().

◆ operator/=()

void Isis::Displacement::operator/= ( const double & valueToDiv )

Divide this displacement by a value and assign the result to ourself.

Parameters

valueToDiv This is the value we are going to divide by

Definition at line 329 of file Displacement.cpp.

References Isis::IsSpecial(), isValid(), Meters, meters(), Isis::Null, and setDisplacement().

◆ operator<()

bool Isis::Displacement::operator< ( const Displacement & otherDisplacement ) const

Compare two displacements with the less than operator.

Parameters

otherdisplacement This is the displacement we're comparing to, i.e. on the right-hand-side of the operator when used

Returns: True if the length of the displacement is less than the length of the given displacement

Definition at line 173 of file Displacement.cpp.

References isValid(), meters(), and Isis::IException::Programmer.

◆ operator<=()

bool Isis::Displacement::operator<= ( const Displacement & otherDisplacement ) const

inline

Compare the lengths of 2 displacements with the <= operator.

Parameters

otherDisplacement This is the displacement we are comparing i.e. it is on the right-hand-side of the operator when used

Returns: True if the length of this displacement is less than or equal to the length of the given displacement.

Definition at line 102 of file Displacement.h.

◆ operator==()

bool Isis::Displacement::operator== ( const Displacement & otherDisplacement ) const

inline

Compare the lengths of 2 displacements with the == operator.

Two uninitialized displacements are equal to each other.

Parameters

otherDisplacement This is the displacement we are comparing to, i.e. it is on the right-hand-side of the operator when used

Returns: True if the length of this displacement is equal to the
given displacement

Definition at line 130 of file Displacement.h.

References m_displacementInMeters.

◆ operator>()

bool Isis::Displacement::operator> ( const Displacement & otherDisplacement ) const

Get the displacement in meters.

Compare two displacements with the greater than operator.

This is equivalent to meters()

Returns: The displacement, as a number, in units of Meters

operator double() const { return meters(); }

Parameters

otherdisplacement This is the displacement we're comparing to, i.e. it is on the right-hand-side of the operator when used

Returns: True if the length of this displacement is greater than the length of the given displacement

Definition at line 154 of file Displacement.cpp.

References isValid(), meters(), and Isis::IException::Programmer.

◆ operator>=()

bool Isis::Displacement::operator>= ( const Displacement & otherDisplacement ) const

inline

Compare the distances of 2 displacements with the >= operator.

Parameters

otherDisplacement This is the displacement we are comparing to, i.e. it is on the right-hand-side of the operator when used

Returns: True if the length (unsigned) of the displacement is greater than or equal to the length of the given displacement

Definition at line 89 of file Displacement.h.

◆ pixels()

double Isis::Displacement::pixels ( double pixelsPerMeter = 1.0 ) const

Get the displacement in pixels using the given conversion ratio.

Parameters

pixelsPerMeter Pixels/Meters conversion ratio to use, stored data is always in meters

Returns: Current displacement, in pixels

Definition at line 117 of file Displacement.cpp.

References displacement(), and Meters.

Referenced by Isis::RawCubeChunk::RawCubeChunk().

◆ setDisplacement()

void Isis::Displacement::setDisplacement	(	const double &	displacement,
		Units	displacementUnit
	)

protected

This is a helper method to set displacements in a universal manner with uniform error checking.

Parameters

displacement	The displacement, in units of displacementUnit, to set this class to. If this is negative an exception will be thrown and the state unmodified.
displacementUnit	Unit of displacement. If this is invalid, an exception will be thrown and the state left unmodified.

Definition at line 400 of file Displacement.cpp.

References displacement(), Isis::IsSpecial(), Kilometers, m_displacementInMeters, Meters, Isis::Null, Pixels, and Isis::IException::Programmer.

Referenced by Displacement(), operator*=(), operator+=(), operator-=(), operator/=(), setKilometers(), setMeters(), and setPixels().

◆ setKilometers()

void Isis::Displacement::setKilometers ( double displacementInKilometers )

Set the displacement in kilometers.

Parameters

displacementInKilometers This is the value to set as the displacement, given in kilometers.

Definition at line 105 of file Displacement.cpp.

References Kilometers, and setDisplacement().

◆ setMeters()

void Isis::Displacement::setMeters ( double displacementInMeters )

Set the displacement in meters.

Parameters

displacementInMeters This is the value to set this displacement to, given in meters.

Definition at line 84 of file Displacement.cpp.

References Meters, and setDisplacement().

◆ setPixels()

void Isis::Displacement::setPixels	(	double	displacementInPixels,
		double	pixelsPerMeter = `1.0`
	)

Set the displacement in pixels.

Parameters

displacementInPixels	This is the value to set this displacement to, given in pixels.
pixelsPerMeter	Pixels/Meters conversion ratio to use, stored data is always in meters

Definition at line 130 of file Displacement.cpp.

References Meters, and setDisplacement().

Friends And Related Function Documentation

◆ operator*

Displacement operator*	(	double	mult,
		Displacement	displacement
	)

friend

Multiply displacement by a value (5m * 2 = 10m).

Parameters

mult	This is the value to multiply by
displacement	This is the distance to multiply into

Returns: Resulting value

Definition at line 279 of file Displacement.cpp.

Member Data Documentation

◆ m_displacementInMeters

double Isis::Displacement::m_displacementInMeters

private

This is the displacement value that this class is encapsulating, always stored in meters.

Definition at line 157 of file Displacement.h.

Referenced by displacement(), operator==(), and setDisplacement().

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

src/base/objs/Displacement/Displacement.h
src/base/objs/Displacement/Displacement.cpp

Public Types

Public Member Functions

Protected Member Functions

Private Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ Units

Constructor & Destructor Documentation

◆ Displacement() [1/4]

◆ Displacement() [2/4]

◆ Displacement() [3/4]

◆ Displacement() [4/4]

◆ ~Displacement()

Member Function Documentation

◆ displacement()

◆ isValid()

◆ kilometers()

◆ meters()

◆ operator!=()

◆ operator*()

◆ operator*=()

◆ operator+()

◆ operator+=()

◆ operator-() [1/2]

◆ operator-() [2/2]

◆ operator-=() [1/2]

◆ operator-=() [2/2]

◆ operator/() [1/2]

◆ operator/() [2/2]

◆ operator/=()

◆ operator<()

◆ operator<=()

◆ operator==()

◆ operator>()

◆ operator>=()

◆ pixels()

◆ setDisplacement()

◆ setKilometers()

◆ setMeters()

◆ setPixels()

Friends And Related Function Documentation

◆ operator*

Member Data Documentation

◆ m_displacementInMeters