ncut::Profile< IMG_ELM_TYPE, MSK_ELM_TYPE > Class Template Reference

Profile handles similarity information of one frame window. More...

#include <motionProfile.h>

Inheritance diagram for ncut::Profile< IMG_ELM_TYPE, MSK_ELM_TYPE >:

ncut::ElementProfile< IMG_ELM_TYPE, MSK_ELM_TYPE > ncut::SegmentProfile< IMG_ELM_TYPE, MSK_ELM_TYPE > List of all members.

Public Member Functions

const Matrixsimilarity () const
 Similarity matrix of this profile.
const std::map< MSK_ELM_TYPE,
unsigned int > * 
indices () const
 Get the indices of the regions in this profile.
const std::vector< MSK_ELM_TYPE > * identifiers () const
 Get the identifiers of the regions in this profile.
unsigned int idx (const MSK_ELM_TYPE &id) const
 Get the index of a region identified by an id.
const MSK_ELM_TYPE & id (unsigned int idx) const
 Get the identifier of the region with the given index.
 Profile (const Setting *setting)
 Profile empty constructor.
 Profile (const Profile &clone)
 Profile copy constructor
 Profile (const Matrix &similarity, const std::map< MSK_ELM_TYPE, unsigned int > &indices, const std::vector< MSK_ELM_TYPE > &identifiers, const Setting *setting)
 Profile can be constructed by manually setting all members.
virtual ~Profile ()
 Profile destructor.
virtual Profileoperator= (const Profile &clone)
 Profile assignment operator.

Protected Attributes

Matrix similarity_
std::map< MSK_ELM_TYPE, unsigned
int > 
indices_
std::vector< MSK_ELM_TYPE > identifiers_
const Settingsetting_

Detailed Description

template<class IMG_ELM_TYPE = unsigned char, class MSK_ELM_TYPE = signed long>
class ncut::Profile< IMG_ELM_TYPE, MSK_ELM_TYPE >

Profile handles similarity information of one frame window.

The base class for ElementProfile and SegmentProfile. A Profile contains Information about its associated type. Segmentation is done on Elements (e.g. from a prioir segmentation step) using information stored in an ElementProfile and the information of the resulting segments is stored in a SegmentProfile. Elements and segments are identified by numbers unique in all of the sequence. To get the index used for an element or a segment in a Profile (e.g. the index of this element in the similarity matrix) use the function idx(elementID).


Constructor & Destructor Documentation

template<class IMG_ELM_TYPE, class MSK_ELM_TYPE>
ncut::Profile< IMG_ELM_TYPE, MSK_ELM_TYPE >::Profile const Setting setting  ) 
 

Profile empty constructor.

The resulting Profile will contain empty indices and identifier maps and an empty similarity Matrix.

template<class IMG_ELM_TYPE, class MSK_ELM_TYPE>
ncut::Profile< IMG_ELM_TYPE, MSK_ELM_TYPE >::Profile const Profile< IMG_ELM_TYPE, MSK_ELM_TYPE > &  clone  ) 
 

Profile copy constructor

Parameters:
clone The Profile to be cloned.

template<class IMG_ELM_TYPE, class MSK_ELM_TYPE>
ncut::Profile< IMG_ELM_TYPE, MSK_ELM_TYPE >::Profile const Matrix similarity,
const std::map< MSK_ELM_TYPE, unsigned int > &  indices,
const std::vector< MSK_ELM_TYPE > &  identifiers,
const Setting setting
 

Profile can be constructed by manually setting all members.

Parameters:
similarity A similarity matrix.
indices An indices map.
identifiers An identifiers map.
setting The parameters of the current segmentation.
similarity , indices and identifiers must have the same dimension and indices and identifiers must be valid.


Member Function Documentation

template<class IMG_ELM_TYPE = unsigned char, class MSK_ELM_TYPE = signed long>
const MSK_ELM_TYPE& ncut::Profile< IMG_ELM_TYPE, MSK_ELM_TYPE >::id unsigned int  idx  )  const [inline]
 

Get the identifier of the region with the given index.

Parameters:
idx the idex of the region
Returns:
the id of the specified region

template<class IMG_ELM_TYPE = unsigned char, class MSK_ELM_TYPE = signed long>
const std::vector<MSK_ELM_TYPE>* ncut::Profile< IMG_ELM_TYPE, MSK_ELM_TYPE >::identifiers  )  const [inline]
 

Get the identifiers of the regions in this profile.

Returns:
the identifiers of the regions

template<class IMG_ELM_TYPE, class MSK_ELM_TYPE>
unsigned int ncut::Profile< IMG_ELM_TYPE, MSK_ELM_TYPE >::idx const MSK_ELM_TYPE &  id  )  const
 

Get the index of a region identified by an id.

Parameters:
idx the id of the region
Returns:
the index of the specified region

template<class IMG_ELM_TYPE = unsigned char, class MSK_ELM_TYPE = signed long>
const std::map<MSK_ELM_TYPE, unsigned int>* ncut::Profile< IMG_ELM_TYPE, MSK_ELM_TYPE >::indices  )  const [inline]
 

Get the indices of the regions in this profile.

Returns:
the indices of the regions

template<class IMG_ELM_TYPE, class MSK_ELM_TYPE>
Profile< IMG_ELM_TYPE, MSK_ELM_TYPE > & ncut::Profile< IMG_ELM_TYPE, MSK_ELM_TYPE >::operator= const Profile< IMG_ELM_TYPE, MSK_ELM_TYPE > &  clone  )  [virtual]
 

Profile assignment operator.

Parameters:
clone The Profile to be cloned.
Returns:
This object.

template<class IMG_ELM_TYPE = unsigned char, class MSK_ELM_TYPE = signed long>
const Matrix* ncut::Profile< IMG_ELM_TYPE, MSK_ELM_TYPE >::similarity  )  const [inline]
 

Similarity matrix of this profile.

Returns:
the similarity matrix of this profile


Member Data Documentation

template<class IMG_ELM_TYPE = unsigned char, class MSK_ELM_TYPE = signed long>
std::vector<MSK_ELM_TYPE> ncut::Profile< IMG_ELM_TYPE, MSK_ELM_TYPE >::identifiers_ [protected]
 

A map from local element indices to global element identifiers (inverse of indices_)

template<class IMG_ELM_TYPE = unsigned char, class MSK_ELM_TYPE = signed long>
std::map<MSK_ELM_TYPE, unsigned int> ncut::Profile< IMG_ELM_TYPE, MSK_ELM_TYPE >::indices_ [protected]
 

A map from global element identifiers that are consistently used in every iteration to the local indices these elements have in this profile (e.g. the index in the similarity matrix)

template<class IMG_ELM_TYPE = unsigned char, class MSK_ELM_TYPE = signed long>
const Setting* ncut::Profile< IMG_ELM_TYPE, MSK_ELM_TYPE >::setting_ [protected]
 

Contains all needed parameters

template<class IMG_ELM_TYPE = unsigned char, class MSK_ELM_TYPE = signed long>
Matrix ncut::Profile< IMG_ELM_TYPE, MSK_ELM_TYPE >::similarity_ [protected]
 

The similarity matrix stores the weight (=similarity) from every element to every other element


The documentation for this class was generated from the following file:
Generated on Thu Jun 22 14:47:21 2006 for ncut.kdevelop by  doxygen 1.4.6