Isis 3 Programmer Reference
Public Member Functions | Public Attributes | List of all members
Isis::Coordinate Class Reference

Define a generic Y/X container. More...

#include <GruenTypes.h>

Collaboration diagram for Isis::Coordinate:
Collaboration graph

Public Member Functions

 Coordinate (double y, double x)
 
 Coordinate (const Chip &chip)
 
void setLatLon (const double &latitude, const double &longitude)
 Use Latitude/Longitude interface.
 
void setLineSamp (const double &line, const double &sample)
 Use the Line/Sample interface.
 
Coordinate & operator+= (const Coordinate &other)
 Add a point to this point.
 
Coordinate & operator-= (const Coordinate &other)
 Subtract a point from this point.
 
double getDistance (const Coordinate &pntA=Coordinate(0.0, 0.0)) const
 Computes the distance from this point and the point provided.
 
bool isValid () const
 Check for goodness.
 
double getLatitude () const
 
double getLongitude () const
 
double getLine () const
 
double getSample () const
 

Public Attributes

double m_y
 
double m_x
 

Detailed Description

Define a generic Y/X container.

This generic container is designed to be used as a line/sample or a latitude/longitude container. It can be used to contain other cartesian coordinates if desired.

The default initialization sets the points the ISIS Null pixel value indicating it has not been initialized or can signal an invalid point if either one of the values is not initialized to something other than an ISIS special pixel.

Operators are defined to ease performing simple add/subtract operations.

Author
????-??-?? Unknown

Definition at line 53 of file GruenTypes.h.

Constructor & Destructor Documentation

◆ Coordinate() [1/3]

Isis::Coordinate::Coordinate ( )
inline

Definition at line 55 of file GruenTypes.h.

◆ Coordinate() [2/3]

Isis::Coordinate::Coordinate ( double y,
double x )
inline

Definition at line 56 of file GruenTypes.h.

◆ Coordinate() [3/3]

Isis::Coordinate::Coordinate ( const Chip & chip)
inline

Definition at line 57 of file GruenTypes.h.

◆ ~Coordinate()

Isis::Coordinate::~Coordinate ( )
inline

Definition at line 59 of file GruenTypes.h.

Member Function Documentation

◆ getDistance()

double Isis::Coordinate::getDistance ( const Coordinate & pntA = Coordinate(0.0, 0.0)) const
inline

Computes the distance from this point and the point provided.

Definition at line 100 of file GruenTypes.h.

Referenced by Isis::Gruen::CheckConstraints().

◆ getLatitude()

double Isis::Coordinate::getLatitude ( ) const
inline

Definition at line 111 of file GruenTypes.h.

◆ getLine()

double Isis::Coordinate::getLine ( ) const
inline

Definition at line 113 of file GruenTypes.h.

◆ getLongitude()

double Isis::Coordinate::getLongitude ( ) const
inline

Definition at line 112 of file GruenTypes.h.

◆ getSample()

double Isis::Coordinate::getSample ( ) const
inline

Definition at line 114 of file GruenTypes.h.

◆ isValid()

bool Isis::Coordinate::isValid ( ) const
inline

Check for goodness.

Definition at line 107 of file GruenTypes.h.

References Isis::IsSpecial().

Referenced by Isis::SmtkMatcher::getLineSample(), Isis::PointPair::isValid(), Isis::operator+(), operator+=(), Isis::operator-(), and operator-=().

◆ operator+=()

Coordinate & Isis::Coordinate::operator+= ( const Coordinate & other)
inline

Add a point to this point.

Definition at line 76 of file GruenTypes.h.

References isValid(), and Isis::Null.

◆ operator-=()

Coordinate & Isis::Coordinate::operator-= ( const Coordinate & other)
inline

Subtract a point from this point.

Definition at line 88 of file GruenTypes.h.

References isValid(), and Isis::Null.

◆ setLatLon()

void Isis::Coordinate::setLatLon ( const double & latitude,
const double & longitude )
inline

Use Latitude/Longitude interface.

Definition at line 62 of file GruenTypes.h.

Referenced by Isis::SmtkMatcher::getLatLon().

◆ setLineSamp()

void Isis::Coordinate::setLineSamp ( const double & line,
const double & sample )
inline

Use the Line/Sample interface.

Definition at line 69 of file GruenTypes.h.

Referenced by Isis::SmtkMatcher::getLineSample().

Member Data Documentation

◆ m_x

double Isis::Coordinate::m_x

Definition at line 117 of file GruenTypes.h.

◆ m_y

double Isis::Coordinate::m_y

Definition at line 116 of file GruenTypes.h.

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