Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vcsl_coordinate_system Class Reference

Abstract coordinate system. More...

#include <vcsl_coordinate_system.h>

Inheritance diagram for vcsl_coordinate_system:
Inheritance graph
[legend]

Public Member Functions

 vcsl_coordinate_system (vcsl_coordinate_system const &c)
 
 ~vcsl_coordinate_system () override=default
 
int dimensionality () const
 Number of axes. More...
 
bool valid_axis (unsigned int i) const
 Is ‘i’ an index on an axis ?. More...
 
vcsl_axis_sptr axis (int i) const
 Return the axis ‘i’. More...
 
virtual const vcsl_spatialcast_to_spatial () const
 
vnl_vector< double > from_cs_to_standard_units (const vnl_vector< double > &v) const
 Convert ‘v’, expressed with cs units, to standard units. More...
 
vnl_vector< double > from_standard_units_to_cs (const vnl_vector< double > &v) const
 Convert ‘v’, expressed with standard units, to cs units. More...
 
void ref ()
 
void unref ()
 
long get_references () const
 
bool is_referenced () const
 

Protected Member Functions

 vcsl_coordinate_system ()=default
 

Protected Attributes

std::vector< vcsl_axis_sptraxes_
 List of axes. More...
 

Detailed Description

Abstract coordinate system.

Definition at line 28 of file vcsl_coordinate_system.h.

Constructor & Destructor Documentation

◆ vcsl_coordinate_system() [1/2]

vcsl_coordinate_system::vcsl_coordinate_system ( )
protecteddefault

◆ vcsl_coordinate_system() [2/2]

vcsl_coordinate_system::vcsl_coordinate_system ( vcsl_coordinate_system const &  c)
inline

Definition at line 41 of file vcsl_coordinate_system.h.

◆ ~vcsl_coordinate_system()

vcsl_coordinate_system::~vcsl_coordinate_system ( )
overridedefault

Member Function Documentation

◆ axis()

vcsl_axis_sptr vcsl_coordinate_system::axis ( int  i) const

Return the axis ‘i’.

REQUIRE: valid_axis(i)

Definition at line 14 of file vcsl_coordinate_system.cxx.

◆ cast_to_spatial()

virtual const vcsl_spatial* vcsl_coordinate_system::cast_to_spatial ( ) const
inlinevirtual

Reimplemented in vcsl_spatial.

Definition at line 64 of file vcsl_coordinate_system.h.

◆ dimensionality()

int vcsl_coordinate_system::dimensionality ( ) const
inline

Number of axes.

Definition at line 52 of file vcsl_coordinate_system.h.

◆ from_cs_to_standard_units()

vnl_vector< double > vcsl_coordinate_system::from_cs_to_standard_units ( const vnl_vector< double > &  v) const

Convert ‘v’, expressed with cs units, to standard units.

REQUIRE: v.size()==dimensionality()

Definition at line 27 of file vcsl_coordinate_system.cxx.

◆ from_standard_units_to_cs()

vnl_vector< double > vcsl_coordinate_system::from_standard_units_to_cs ( const vnl_vector< double > &  v) const

Convert ‘v’, expressed with standard units, to cs units.

REQUIRE: v.size()==dimensionality()

Definition at line 44 of file vcsl_coordinate_system.cxx.

◆ valid_axis()

bool vcsl_coordinate_system::valid_axis ( unsigned int  i) const
inline

Is ‘i’ an index on an axis ?.

Definition at line 55 of file vcsl_coordinate_system.h.

Member Data Documentation

◆ axes_

std::vector<vcsl_axis_sptr> vcsl_coordinate_system::axes_
protected

List of axes.

Definition at line 86 of file vcsl_coordinate_system.h.


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