mlib::PIXEL

mlib::PIXEL Class Reference
["PIXEL" Coordinate System]

A point in pixel coordinates. More...

#include <points.H>

Inheritance diagram for mlib::PIXEL:

[legend]Collaboration diagram for mlib::PIXEL:

[legend]List of all members.


Public Types
typedef double	value_type
Public Member Functions
	Point2 ()
	Default constructor. Creates a point at the origin.
	Point2 (double s)
	Constructor that creates a point with the supplied double argumetn value in all components.
	Point2 (double xx, double yy)
	Construtor that creates a point with the components supplied in the arguments.
const double *	data () const
	Returns the elements of the point as an array.
double	operator[] (int index) const
double &	operator[] (int index)
PIXEL	operator+ (const PIXEL &p) const
	Adds a point to a point.
PIXEL	operator+ (const VEXEL &v) const
VEXEL	operator- (const PIXEL &p) const
PIXEL	operator- (const VEXEL &v) const
PIXEL	operator- () const
PIXEL	operator * (double s) const
PIXEL	operator * (const PIXEL &p) const
	Component-wise multiplcation.
PIXEL	operator/ (double s) const
void	operator *= (const PIXEL &p) const
	Component-wise multiplication.
void	operator *= (double scalar)
void	operator+= (const PIXEL &p)
	Adds a point to a point.
void	operator+= (const VEXEL &v)
void	operator-= (const PIXEL &p)
void	operator-= (const VEXEL &v)
void	operator/= (double scalar)
bool	operator== (const PIXEL &p) const
	Are the two points exactly equal (component-wise)?
bool	operator!= (const PIXEL &p) const
	Are the two points not equal (component-wise)?
double	length () const
	Compute the distance from the point to the origin.
double	length_sqrd () const
	Compute the distance squared from the point to the origin.
double	dist_sqrd (const PIXEL &p) const
	Compute the distance squared between two points.
double	dist (const PIXEL &p) const
	Compute the distance between two points.
bool	is_equal (const PIXEL &p, double epsSqrd=epsAbsSqrdMath()) const
	Is the distance between the two points essentially zero?
Constructors
	PIXEL ()
	PIXEL (double s)
	PIXEL (double x, double y)
	PIXEL (CXYpt &)
	PIXEL (CWpt &w)
Static Public Member Functions
static CPIXEL &	Origin ()
static int	dim ()
Protected Attributes
double	_x
double	_y
Static Protected Attributes
static CPIXEL	_origin

Detailed Description

A point in pixel coordinates.

Definition at line 1131 of file points.H.

Member Typedef Documentation

typedef double mlib::Point2< PIXEL , VEXEL >::value_type [inherited]

Definition at line 57 of file point2.H.

Constructor & Destructor Documentation

mlib::PIXEL::PIXEL ( ) [inline]

Definition at line 1142 of file points.H.

mlib::PIXEL::PIXEL ( double s ) [inline, explicit]

Definition at line 1143 of file points.H.

mlib::PIXEL::PIXEL ( double x,

double y

) [inline]

Definition at line 1144 of file points.H.

mlib::PIXEL::PIXEL ( CXYpt & )

Definition at line 487 of file points.C.
References mlib::Point2< PIXEL, VEXEL >::_x, mlib::Point2< PIXEL, VEXEL >::_y, VIEW_PIXELS, and VIEW_SIZE.

mlib::PIXEL::PIXEL ( CWpt & w ) [inline]

Definition at line 1146 of file points.H.

Member Function Documentation

const double* mlib::Point2< PIXEL , VEXEL >::data ( ) const [inline, inherited]

Returns the elements of the point as an array.

Definition at line 66 of file point2.H.

static int mlib::Point2< PIXEL , VEXEL >::dim ( ) [inline, static, inherited]

Definition at line 58 of file point2.H.

double mlib::Point2< PIXEL , VEXEL >::dist ( const PIXEL & p ) const [inline, inherited]

Compute the distance between two points.

Definition at line 138 of file point2.H.

double mlib::Point2< PIXEL , VEXEL >::dist_sqrd ( const PIXEL & p ) const [inline, inherited]

Compute the distance squared between two points.

Definition at line 135 of file point2.H.

bool mlib::Point2< PIXEL , VEXEL >::is_equal ( const PIXEL & p,

double epsSqrd = epsAbsSqrdMath()

) const [inline, inherited]

Is the distance between the two points essentially zero?

Definition at line 146 of file point2.H.

double mlib::Point2< PIXEL , VEXEL >::length ( ) const [inline, inherited]

Compute the distance from the point to the origin.

Questions:
Do we need/want this function (since points don't really have a length)?

Definition at line 123 of file point2.H.

double mlib::Point2< PIXEL , VEXEL >::length_sqrd ( ) const [inline, inherited]

Compute the distance squared from the point to the origin.

Questions:
Do we need/want this function (since points don't really have a length)?

Definition at line 127 of file point2.H.

PIXEL mlib::Point2< PIXEL , VEXEL >::operator * ( const PIXEL & p ) const [inline, inherited]

Component-wise multiplcation.

Definition at line 89 of file point2.H.

PIXEL mlib::Point2< PIXEL , VEXEL >::operator * ( double s ) const [inline, inherited]

Definition at line 85 of file point2.H.

void mlib::Point2< PIXEL , VEXEL >::operator *= ( double scalar ) [inline, inherited]

Definition at line 102 of file point2.H.

void mlib::Point2< PIXEL , VEXEL >::operator *= ( const PIXEL & p ) const [inline, inherited]

Component-wise multiplication.

Definition at line 91 of file point2.H.

bool mlib::Point2< PIXEL , VEXEL >::operator!= ( const PIXEL & p ) const [inline, inherited]

Are the two points not equal (component-wise)?

Definition at line 113 of file point2.H.

PIXEL mlib::Point2< PIXEL , VEXEL >::operator+ ( const VEXEL & v ) const [inline, inherited]

Definition at line 80 of file point2.H.

PIXEL mlib::Point2< PIXEL , VEXEL >::operator+ ( const PIXEL & p ) const [inline, inherited]

Adds a point to a point.

Warning:
This should only be used to add points that have already been pre-weighted by coefficients that add up to 1.

Definition at line 79 of file point2.H.

void mlib::Point2< PIXEL , VEXEL >::operator+= ( const VEXEL & v ) [inline, inherited]

Definition at line 97 of file point2.H.

void mlib::Point2< PIXEL , VEXEL >::operator+= ( const PIXEL & p ) [inline, inherited]

Adds a point to a point.

Warning:
This should only be used to add points that have already been pre-weighted by coefficients that add up to 1.

Definition at line 96 of file point2.H.

PIXEL mlib::Point2< PIXEL , VEXEL >::operator- ( ) const [inline, inherited]

Definition at line 83 of file point2.H.

PIXEL mlib::Point2< PIXEL , VEXEL >::operator- ( const VEXEL & v ) const [inline, inherited]

Definition at line 82 of file point2.H.

VEXEL mlib::Point2< PIXEL , VEXEL >::operator- ( const PIXEL & p ) const [inline, inherited]

Definition at line 81 of file point2.H.

void mlib::Point2< PIXEL , VEXEL >::operator-= ( const VEXEL & v ) [inline, inherited]

Definition at line 101 of file point2.H.

void mlib::Point2< PIXEL , VEXEL >::operator-= ( const PIXEL & p ) [inline, inherited]

Questions:
Should this function be allowed (subtracting two points and getting a point as the result)?

Definition at line 100 of file point2.H.

PIXEL mlib::Point2< PIXEL , VEXEL >::operator/ ( double s ) const [inline, inherited]

Definition at line 86 of file point2.H.

void mlib::Point2< PIXEL , VEXEL >::operator/= ( double scalar ) [inline, inherited]

Definition at line 103 of file point2.H.

bool mlib::Point2< PIXEL , VEXEL >::operator== ( const PIXEL & p ) const [inline, inherited]

Are the two points exactly equal (component-wise)?

Definition at line 111 of file point2.H.

double& mlib::Point2< PIXEL , VEXEL >::operator[] ( int index ) [inline, inherited]

Definition at line 69 of file point2.H.

double mlib::Point2< PIXEL , VEXEL >::operator[] ( int index ) const [inline, inherited]

Definition at line 68 of file point2.H.

static CPIXEL& mlib::PIXEL::Origin ( ) [inline, static]

Definition at line 1150 of file points.H.
References _origin.

mlib::Point2< PIXEL , VEXEL >::Point2 ( double xx,

double yy

) [inline, inherited]

Construtor that creates a point with the components supplied in the arguments.

Definition at line 50 of file point2.H.

mlib::Point2< PIXEL , VEXEL >::Point2 ( double s ) [inline, explicit, inherited]

Constructor that creates a point with the supplied double argumetn value in all components.

Definition at line 47 of file point2.H.

mlib::Point2< PIXEL , VEXEL >::Point2 ( ) [inline, inherited]

Default constructor. Creates a point at the origin.

Definition at line 44 of file point2.H.

Member Data Documentation

CPIXEL mlib::PIXEL::_origin [static, protected]

Definition at line 1135 of file points.H.
Referenced by Origin().

double mlib::Point2< PIXEL , VEXEL >::_x [protected, inherited]

Definition at line 36 of file point2.H.
Referenced by PIXEL().

double mlib::Point2< PIXEL , VEXEL >::_y [protected, inherited]

Definition at line 36 of file point2.H.
Referenced by PIXEL().

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

Generated on Mon Sep 18 11:48:22 2006 for jot by

1.4.4

mlib::PIXEL Class Reference ["PIXEL" Coordinate System]

Public Types

Public Member Functions

Static Public Member Functions