ossimLsrVector Class Reference

#include <ossimLsrVector.h>

Public Member Functions
	ossimLsrVector ()
	ossimLsrVector (const ossimLsrVector &copy_this)
	ossimLsrVector (const ossimColumnVector3d &assign_this, const ossimLsrSpace &space)
	ossimLsrVector (const double &x, const double &y, const double &z, const ossimLsrSpace &space)
	ossimLsrVector (const ossimEcefVector &convert_this, const ossimLsrSpace &)
	ossimLsrVector (const ossimLsrVector &convert_this, const ossimLsrSpace &)
const ossimLsrVector &	operator= (const ossimLsrVector &)
ossimLsrVector	operator- () const
ossimLsrVector	operator+ (const ossimLsrVector &) const
ossimLsrVector	operator- (const ossimLsrVector &) const
ossimLsrPoint	operator+ (const ossimLsrPoint &) const
ossimLsrVector	operator* (const double &scalar) const
ossimLsrVector	operator/ (const double &scalar) const
bool	operator== (const ossimLsrVector &) const
bool	operator!= (const ossimLsrVector &) const
	operator ossimEcefVector () const
double	dot (const ossimLsrVector &) const
double	angleTo (const ossimLsrVector &) const
ossimLsrVector	cross (const ossimLsrVector &) const
ossimLsrVector	unitVector () const
double	magnitude () const
void	normalize ()
double	x () const
double &	x ()
double	y () const
double &	y ()
double	z () const
double &	z ()
bool	hasNans () const
void	makeNan ()
ossimColumnVector3d &	data ()
const ossimColumnVector3d &	data () const
ossimLsrSpace &	lsrSpace ()
const ossimLsrSpace &	lsrSpace () const
std::ostream &	print (ostream &stream) const

Protected Member Functions
void	initialize (const ossimEcefVector &ecef_point)

Protected Attributes
ossimColumnVector3d	theData
ossimLsrSpace	theLsrSpace

Friends
std::ostream &	operator<< (std::ostream &os, const ossimLsrVector &instance)

Detailed Description

Definition at line 36 of file ossimLsrVector.h.

Constructor & Destructor Documentation

ossimLsrVector() [1/6]

ossimLsrVector::ossimLsrVector ( )

inline

CONSTRUCTORS:

Definition at line 42 of file ossimLsrVector.h.

Referenced by cross(), operator*(), operator+(), operator-(), operator/(), and unitVector().

      : theData (0,0,0) {}

ossimLsrVector() [2/6]

ossimLsrVector::ossimLsrVector ( const ossimLsrVector &  copy_this )

inline

Definition at line 45 of file ossimLsrVector.h.

      : theData(copy_this.theData), theLsrSpace(copy_this.theLsrSpace) {}

ossimLsrVector() [3/6]

ossimLsrVector::ossimLsrVector ( const ossimColumnVector3d &  assign_this, const ossimLsrSpace &  space  )

inline

Definition at line 48 of file ossimLsrVector.h.

      : theData(assign_this), theLsrSpace(space) {}

ossimLsrVector() [4/6]

ossimLsrVector::ossimLsrVector ( const double &  x, const double &  y, const double &  z, const ossimLsrSpace &  space  )

inline

Definition at line 52 of file ossimLsrVector.h.

      : theData(x,y,z), theLsrSpace(space) {}

ossimLsrVector() [5/6]

ossimLsrVector::ossimLsrVector	(	const ossimEcefVector &	convert_this,
		const ossimLsrSpace &	new_space
	)

Definition at line 27 of file ossimLsrVector.cpp.

References initialize().

   : theLsrSpace (new_space)
{
   initialize(convert_this);
}

ossimLsrVector() [6/6]

ossimLsrVector::ossimLsrVector	(	const ossimLsrVector &	convert_this,
		const ossimLsrSpace &	new_space
	)

Definition at line 41 of file ossimLsrVector.cpp.

References initialize().

   : theLsrSpace (new_space)
{
   initialize(ossimEcefVector(convert_this));
}

Member Function Documentation

angleTo()

double ossimLsrVector::angleTo

(

const ossimLsrVector &

v

)

const

Definition at line 70 of file ossimLsrVector.cpp.

References ossim::acosd(), ossimColumnVector3d::dot(), hasNans(), ossimLsrSpace::lsrSpaceErrorMessage(), ossimColumnVector3d::magnitude(), ossim::nan(), theData, and theLsrSpace.

{
   if(hasNans()||v.hasNans()||(theLsrSpace != v.theLsrSpace))
   {
      ossimLsrSpace::lsrSpaceErrorMessage();
      return ossim::nan();
   }
   double mag_product = theData.magnitude() * v.theData.magnitude();
   return ossim::acosd(theData.dot(v.theData)/mag_product);
}

cross()

ossimLsrVector ossimLsrVector::cross

(

const ossimLsrVector &

v

)

const

Definition at line 87 of file ossimLsrVector.cpp.

References ossimColumnVector3d::cross(), data(), hasNans(), ossimLsrSpace::lsrSpaceErrorMessage(), ossim::nan(), ossimLsrVector(), theData, and theLsrSpace.

{
   if(hasNans()||v.hasNans()||(theLsrSpace != v.theLsrSpace))
   {
      ossimLsrSpace::lsrSpaceErrorMessage();
      return ossimLsrVector(ossim::nan(), ossim::nan(), ossim::nan(),
                            theLsrSpace);
   }
   return ossimLsrVector(theData.cross(v.data()), theLsrSpace);
}

data() [1/2]

ossimColumnVector3d& ossimLsrVector::data ( )

inline

Definition at line 116 of file ossimLsrVector.h.

Referenced by cross(), dot(), ossimLsrPoint::operator+(), and operator-().

{ return theData; }

data() [2/2]

const ossimColumnVector3d& ossimLsrVector::data ( ) const

inline

Definition at line 117 of file ossimLsrVector.h.

{ return theData; }

dot()

double ossimLsrVector::dot

(

const ossimLsrVector &

v

)

const

Vector-related functions:

Definition at line 54 of file ossimLsrVector.cpp.

References data(), ossimColumnVector3d::dot(), hasNans(), ossimLsrSpace::lsrSpaceErrorMessage(), ossim::nan(), theData, and theLsrSpace.

{
   if(hasNans()||v.hasNans()||(theLsrSpace != v.theLsrSpace))
   {
      ossimLsrSpace::lsrSpaceErrorMessage();
      return ossim::nan();
   }
   return theData.dot(v.data());
}

hasNans()

bool ossimLsrVector::hasNans ( ) const

inline

Definition at line 104 of file ossimLsrVector.h.

References ossim::isnan().

Referenced by angleTo(), cross(), dot(), magnitude(), operator+(), ossimLsrPoint::operator+(), operator-(), and unitVector().

   {
      return (ossim::isnan(theData[0])||
              ossim::isnan(theData[1])||
              ossim::isnan(theData[2]));
   }

initialize()

void ossimLsrVector::initialize ( const ossimEcefVector &  ecef_point )

inlineprotected

METHOD: initialize(ossimEcefVector) Convenience method used by several constructors for initializing theData given an ECEF vector. Assumes theLsrSpace has been previously initialized

Definition at line 284 of file ossimLsrVector.h.

References ossimEcefVector::data(), ossimLsrSpace::ecefToLsrRotMatrix(), theData, and theLsrSpace.

Referenced by ossimLsrVector().

{
   theData = theLsrSpace.ecefToLsrRotMatrix() * ecef_vector.data();
}

lsrSpace() [1/2]

ossimLsrSpace& ossimLsrVector::lsrSpace ( )

inline

Definition at line 119 of file ossimLsrVector.h.

Referenced by ossimLsrPoint::operator+(), and ossimLsrRay::ossimLsrRay().

{ return theLsrSpace; }

lsrSpace() [2/2]

const ossimLsrSpace& ossimLsrVector::lsrSpace ( ) const

inline

Definition at line 120 of file ossimLsrVector.h.

{ return theLsrSpace; }

magnitude()

double ossimLsrVector::magnitude ( ) const

inline

Definition at line 262 of file ossimLsrVector.h.

References hasNans(), ossimColumnVector3d::magnitude(), ossim::nan(), and theData.

{
   if(hasNans()) return ossim::nan();
   return theData.magnitude();
}

makeNan()

void ossimLsrVector::makeNan ( )

inline

Definition at line 110 of file ossimLsrVector.h.

References ossim::nan().

   {
      theData[0] = ossim::nan();
      theData[1] = ossim::nan();
      theData[2] = ossim::nan();
   }

normalize()

void ossimLsrVector::normalize ( )

inline

Definition at line 272 of file ossimLsrVector.h.

References ossimColumnVector3d::magnitude(), and theData.

Referenced by ossimLsrRay::ossimLsrRay().

{
   theData /= theData.magnitude();
}

operator ossimEcefVector()

ossimLsrVector::operator ossimEcefVector ( ) const

inline

CASTING OPERATOR: Used as: myEcefVector = ossimEcefVector(this) – looks like a constructor but is an operation on this object. ECEF knows nothing about LSR, so cannot provide an ossimEcefVector(ossimLsrVector) constructor.

Definition at line 243 of file ossimLsrVector.h.

{   
   return ossimEcefVector(theLsrSpace.lsrToEcefRotMatrix()*theData);
}   

operator!=()

bool ossimLsrVector::operator!= ( const ossimLsrVector &  v ) const

inline

Definition at line 231 of file ossimLsrVector.h.

{
   return (!(*this == v));
}

operator*()

ossimLsrVector ossimLsrVector::operator* ( const double &  scalar ) const

inline

Definition at line 207 of file ossimLsrVector.h.

References ossimLsrVector(), theData, and theLsrSpace.

{
   return ossimLsrVector(theData*scalar, theLsrSpace);
}

operator+() [1/2]

ossimLsrVector ossimLsrVector::operator+ ( const ossimLsrVector &  v ) const

inline

Definition at line 167 of file ossimLsrVector.h.

References hasNans(), ossimLsrSpace::lsrSpaceErrorMessage(), ossim::nan(), ossimLsrVector(), theData, and theLsrSpace.

{
   if ((theLsrSpace != v.theLsrSpace)||hasNans()||v.hasNans())
   {
      theLsrSpace.lsrSpaceErrorMessage();
      return ossimLsrVector(ossim::nan(), ossim::nan(), ossim::nan(), theLsrSpace);
   }
   return ossimLsrVector(theData + v.theData, theLsrSpace);

}

operator+() [2/2]

ossimLsrPoint ossimLsrVector::operator+ ( const ossimLsrPoint &  p ) const

inline

Definition at line 194 of file ossimLsrVector.h.

References ossimLsrPoint::data(), ossimLsrPoint::hasNans(), hasNans(), ossimLsrPoint::lsrSpace(), ossimLsrSpace::lsrSpaceErrorMessage(), ossim::nan(), theData, and theLsrSpace.

{
   if ((theLsrSpace != p.lsrSpace())||hasNans()||p.hasNans())
   {
      theLsrSpace.lsrSpaceErrorMessage();
      return ossimLsrPoint(ossim::nan(), ossim::nan(), ossim::nan(), theLsrSpace);
   }
   return ossimLsrPoint(theData + p.data(), theLsrSpace);
}

operator-() [1/2]

ossimLsrVector ossimLsrVector::operator- ( ) const

inline

Definition at line 159 of file ossimLsrVector.h.

References ossimLsrVector(), theData, and theLsrSpace.

{
   return ossimLsrVector(-theData, theLsrSpace);
}

operator-() [2/2]

ossimLsrVector ossimLsrVector::operator- ( const ossimLsrVector &  v ) const

inline

Definition at line 181 of file ossimLsrVector.h.

References data(), hasNans(), ossimLsrSpace::lsrSpaceErrorMessage(), ossim::nan(), ossimLsrVector(), theData, and theLsrSpace.

{
   if ((theLsrSpace != v.theLsrSpace)||hasNans()||v.hasNans())
   {
      theLsrSpace.lsrSpaceErrorMessage();
      return ossimLsrVector(ossim::nan(), ossim::nan(), ossim::nan(), theLsrSpace);
   }
   return ossimLsrVector(theData - v.data(), theLsrSpace);
}

operator/()

ossimLsrVector ossimLsrVector::operator/ ( const double &  scalar ) const

inline

Definition at line 215 of file ossimLsrVector.h.

References ossimLsrVector(), theData, and theLsrSpace.

{
   return ossimLsrVector(theData/scalar, theLsrSpace);
}

operator=()

const ossimLsrVector & ossimLsrVector::operator= ( const ossimLsrVector &  v )

inline

OPERATORS: (all methods inlined below)

Definition at line 148 of file ossimLsrVector.h.

References theData, and theLsrSpace.

{
   theData = v.theData;
   theLsrSpace = v.theLsrSpace;

   return *this;
}

operator==()

bool ossimLsrVector::operator== ( const ossimLsrVector &  v ) const

inline

Definition at line 223 of file ossimLsrVector.h.

References theData, and theLsrSpace.

{
   return ((theData == v.theData) && (theLsrSpace == v.theLsrSpace));
}

print()

std::ostream & ossimLsrVector::print

(

std::ostream &

os

)

const

Debug Dump:

Definition at line 98 of file ossimLsrVector.cpp.

References theData, and theLsrSpace.

Referenced by operator<<().

{
   os << "(ossimLsrVector)\n"
      << "  theData = " << theData
      << "\n  theLsrSpace = " << theLsrSpace;
   return os;
}

unitVector()

ossimLsrVector ossimLsrVector::unitVector ( ) const

inline

Definition at line 252 of file ossimLsrVector.h.

References hasNans(), ossimColumnVector3d::magnitude(), ossim::nan(), ossimLsrVector(), theData, and theLsrSpace.

{
   if(hasNans()) return ossimLsrVector(ossim::nan(), ossim::nan(), ossim::nan(), theLsrSpace);

   return ossimLsrVector(theData/theData.magnitude(), theLsrSpace);
}

x() [1/2]

double ossimLsrVector::x ( ) const

inline

DATA ACCESS METHODS:

Definition at line 97 of file ossimLsrVector.h.

{ return theData[0]; }

x() [2/2]

double& ossimLsrVector::x ( )

inline

Definition at line 98 of file ossimLsrVector.h.

{ return theData[0]; }

y() [1/2]

double ossimLsrVector::y ( ) const

inline

Definition at line 99 of file ossimLsrVector.h.

{ return theData[1]; }

y() [2/2]

double& ossimLsrVector::y ( )

inline

Definition at line 100 of file ossimLsrVector.h.

{ return theData[1]; }

z() [1/2]

double ossimLsrVector::z ( ) const

inline

Definition at line 101 of file ossimLsrVector.h.

{ return theData[2]; }

z() [2/2]

double& ossimLsrVector::z ( )

inline

Definition at line 102 of file ossimLsrVector.h.

{ return theData[2]; }

Friends And Related Function Documentation

operator<<

std::ostream& operator<< ( std::ostream &  os, const ossimLsrVector &  instance  )

friend

Definition at line 106 of file ossimLsrVector.cpp.

{
   return instance.print(os);
}

Member Data Documentation

theData

ossimColumnVector3d ossimLsrVector::theData

protected

Definition at line 138 of file ossimLsrVector.h.

Referenced by angleTo(), cross(), dot(), initialize(), magnitude(), normalize(), operator*(), operator+(), operator-(), operator/(), operator=(), operator==(), print(), and unitVector().

theLsrSpace

ossimLsrSpace ossimLsrVector::theLsrSpace

protected

Definition at line 139 of file ossimLsrVector.h.

Referenced by angleTo(), cross(), dot(), initialize(), operator*(), operator+(), operator-(), operator/(), operator=(), operator==(), print(), and unitVector().

---

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

• ossimLsrVector.h
• ossimLsrVector.cpp