rsdl_point Class Reference

#include <rsdl_point.h>

List of all members.


Detailed Description

Definition at line 21 of file rsdl_point.h.


Public Types

typedef vcl_vector< double
>::const_iterator 
const_iterator
 Used until we support member templates.

Public Member Functions

 rsdl_point ()
 Provided only for STL.
 rsdl_point (unsigned int Nc, unsigned int Na=0)
 Ctor to set the dimensions without setting the values.
 rsdl_point (const_iterator c_begin, const_iterator c_end, const_iterator a_begin, const_iterator a_end)
 Ctor from Cartesian and angular value vector iterators.
 rsdl_point (const vnl_vector< double > &c, const vnl_vector< double > &a)
 Ctor from Cartesian and angular value vnl_vectors.
 rsdl_point (const rsdl_point &old)
 Copy constructor.
 rsdl_point (const vnl_vector< double > &all, unsigned int Na=0)
 Ctor from cartesian and the angular values, in order, in a single vnl_vector.
 ~rsdl_point ()
 Destructor.
unsigned int num_cartesian () const
 Number of cartesian dimensions.
unsigned int num_angular () const
 Number of angular dimensions.
void set_cartesian (const vnl_vector< double > &c)
 Establish the cartesian values from a vnl_vector.
void set_cartesian (const_iterator c)
 Establish the cartesian values from an iterator.
void set_angular (const vnl_vector< double > &a)
 Establish the angular values from a vnl_vector.
void set_all (const vnl_vector< double > &all)
 Establish the cartesian and angular values from a vnl_vector.
void set_angular (const_iterator a)
 Establish the angular values from an iterator.
double cartesian (unsigned int i) const
 Constant access to the indexed cartesian coordinate.
double & cartesian (unsigned int i)
 Mutable access to the indexed cartesian coordinate.
double angular (unsigned int i) const
 Constant access to the indexed angular coordinate.
double & angular (unsigned int i)
 Mutable access to the indexed angular coordinate.
rsdl_pointoperator= (const rsdl_point &old)
 Assignment operator.
void resize (unsigned int Nc, unsigned int Na)
 Resize both the cartesian and angular dimensions.

Private Attributes

unsigned int Nc_
unsigned int Na_
double * data_

Member Typedef Documentation

typedef vcl_vector<double>::const_iterator rsdl_point::const_iterator

Used until we support member templates.

Definition at line 25 of file rsdl_point.h.


Constructor & Destructor Documentation

rsdl_point::rsdl_point (  ) 

Provided only for STL.

Creates a point without any data.

Definition at line 10 of file rsdl_point.cxx.

rsdl_point::rsdl_point ( unsigned int  Nc,
unsigned int  Na = 0 
)

Ctor to set the dimensions without setting the values.

Nc and Na are the number of cartesian and angular coordinates, respectively.

Definition at line 15 of file rsdl_point.cxx.

rsdl_point::rsdl_point ( const_iterator  c_begin,
const_iterator  c_end,
const_iterator  a_begin,
const_iterator  a_end 
)

Ctor from Cartesian and angular value vector iterators.

Definition at line 20 of file rsdl_point.cxx.

rsdl_point::rsdl_point ( const vnl_vector< double > &  c,
const vnl_vector< double > &  a 
)

Ctor from Cartesian and angular value vnl_vectors.

Definition at line 31 of file rsdl_point.cxx.

rsdl_point::rsdl_point ( const rsdl_point old  ) 

Copy constructor.

Definition at line 39 of file rsdl_point.cxx.

rsdl_point::rsdl_point ( const vnl_vector< double > &  all,
unsigned int  Na = 0 
)

Ctor from cartesian and the angular values, in order, in a single vnl_vector.

The angular data is taken as the last Na values in the vector.

Definition at line 46 of file rsdl_point.cxx.

rsdl_point::~rsdl_point (  ) 

Destructor.

Definition at line 55 of file rsdl_point.cxx.


Member Function Documentation

unsigned int rsdl_point::num_cartesian (  )  const [inline]

Number of cartesian dimensions.

Definition at line 55 of file rsdl_point.h.

unsigned int rsdl_point::num_angular (  )  const [inline]

Number of angular dimensions.

Definition at line 58 of file rsdl_point.h.

void rsdl_point::set_cartesian ( const vnl_vector< double > &  c  ) 

Establish the cartesian values from a vnl_vector.

Definition at line 62 of file rsdl_point.cxx.

void rsdl_point::set_cartesian ( const_iterator  c  ) 

Establish the cartesian values from an iterator.

No checking is done: Nc elements are expected.

Definition at line 71 of file rsdl_point.cxx.

void rsdl_point::set_angular ( const vnl_vector< double > &  a  ) 

Establish the angular values from a vnl_vector.

Definition at line 79 of file rsdl_point.cxx.

void rsdl_point::set_all ( const vnl_vector< double > &  all  ) 

Establish the cartesian and angular values from a vnl_vector.

Definition at line 88 of file rsdl_point.cxx.

void rsdl_point::set_angular ( const_iterator  a  ) 

Establish the angular values from an iterator.

No checking is done: Nc elements are expected.

Definition at line 97 of file rsdl_point.cxx.

double rsdl_point::cartesian ( unsigned int  i  )  const [inline]

Constant access to the indexed cartesian coordinate.

Definition at line 78 of file rsdl_point.h.

double& rsdl_point::cartesian ( unsigned int  i  )  [inline]

Mutable access to the indexed cartesian coordinate.

Definition at line 81 of file rsdl_point.h.

double rsdl_point::angular ( unsigned int  i  )  const [inline]

Constant access to the indexed angular coordinate.

Definition at line 84 of file rsdl_point.h.

double& rsdl_point::angular ( unsigned int  i  )  [inline]

Mutable access to the indexed angular coordinate.

Definition at line 87 of file rsdl_point.h.

rsdl_point & rsdl_point::operator= ( const rsdl_point old  ) 

Assignment operator.

Definition at line 105 of file rsdl_point.cxx.

void rsdl_point::resize ( unsigned int  Nc,
unsigned int  Na 
)

Resize both the cartesian and angular dimensions.

Definition at line 120 of file rsdl_point.cxx.


Member Data Documentation

unsigned int rsdl_point::Nc_ [private]

Definition at line 96 of file rsdl_point.h.

unsigned int rsdl_point::Na_ [private]

Definition at line 97 of file rsdl_point.h.

double* rsdl_point::data_ [private]

Definition at line 98 of file rsdl_point.h.


The documentation for this class was generated from the following files:
Generated on Mon Mar 8 05:26:58 2010 for contrib/rpl/rsdl by  doxygen 1.5.1