Public Types | Public Member Functions
C3DLandmarklist Class Reference

A list of named landmarks. More...

#include <mia/3d/landmarklist.hh>

Inheritance diagram for C3DLandmarklist:
CIOData

Public Types

typedef CMap::const_iterator const_iterator
 read only iterator More...
 
typedef CMap::iterator iterator
 read-write iterator More...
 
typedef std::shared_ptr
< C3DLandmarklist
Pointer
 
typedef CMap::value_type value_type
 Type of the map values (needed for lambda arguments) More...
 

Public Member Functions

void add (P3DLandmark lm)
 
const_iterator begin () const
 
iterator begin ()
 
C3DLandmarklistclone () const
 
const_iterator end () const
 
iterator end ()
 
P3DLandmark get (const std::string &name) const
 
const std::string & get_name () const
 
void set_name (const std::string &name)
 
void set_path (const boost::filesystem::path &path)
 
size_t size () const
 
- Public Member Functions inherited from CIOData
const std::string & get_source_format () const
 
void set_source_format (const std::string &format)
 

Detailed Description

A list of named landmarks.

This class implements a list of uniquely named landmarks.

Definition at line 39 of file landmarklist.hh.

Member Typedef Documentation

typedef CMap::const_iterator C3DLandmarklist::const_iterator

read only iterator

Definition at line 47 of file landmarklist.hh.

typedef CMap::iterator C3DLandmarklist::iterator

read-write iterator

Definition at line 50 of file landmarklist.hh.

typedef std::shared_ptr<C3DLandmarklist> C3DLandmarklist::Pointer

Definition at line 62 of file landmarklist.hh.

typedef CMap::value_type C3DLandmarklist::value_type

Type of the map values (needed for lambda arguments)

Definition at line 44 of file landmarklist.hh.

Member Function Documentation

void C3DLandmarklist::add ( P3DLandmark  lm)

Add a Landmark to the list. If the landmark name already exists it is siletly overwritten.

Parameters
lmthe landmark to be added
const_iterator C3DLandmarklist::begin ( ) const
Returns
a read-only STL iterator to the landmarks
iterator C3DLandmarklist::begin ( )
Returns
a read-write STL iterator to the landmarks
C3DLandmarklist* C3DLandmarklist::clone ( ) const
Returns
a dynamically created copy of the landmark list
const_iterator C3DLandmarklist::end ( ) const
Returns
a read-only STL iterator to the landmarks
iterator C3DLandmarklist::end ( )
Returns
a read-write STL iterator to the landmarks
P3DLandmark C3DLandmarklist::get ( const std::string &  name) const
Returns
the landmark with the giben name. If this landmark doesn't exist the function returns a (shared) null pointer.
const std::string& C3DLandmarklist::get_name ( ) const
Returns
the name of the landmark list
void C3DLandmarklist::set_name ( const std::string &  name)

Set the name of the landmark list

Parameters
name
void C3DLandmarklist::set_path ( const boost::filesystem::path &  path)

Set the root path of the document (used to read the images)

Parameters
path
size_t C3DLandmarklist::size ( ) const
Returns
the number of landmarks stored in the list

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