Orfeo Toolbox  3.16
Public Types | Public Member Functions | Private Attributes | List of all members
itk::BloxCoreAtomItem< VImageDimension > Class Template Reference

A core atom object, stored in a BloxPixel. More...

#include <itkBloxCoreAtomItem.h>

+ Inheritance diagram for itk::BloxCoreAtomItem< VImageDimension >:
+ Collaboration diagram for itk::BloxCoreAtomItem< VImageDimension >:

Public Types

typedef BloxBoundaryPointItem
< VImageDimension > 
BPItemType
 
typedef Point< double,
VImageDimension > 
PositionType
 

Public Member Functions

 BloxCoreAtomItem ()
 
 ~BloxCoreAtomItem ()
 
void CalcCenterAndDiameter ()
 
BPItemTypeGetBoundaryPointA ()
 
BPItemTypeGetBoundaryPointB ()
 
PositionType GetCenterPosition ()
 
double GetDiameter ()
 
void SetBoundaryPointA (BPItemType *pointA)
 
void SetBoundaryPointB (BPItemType *pointB)
 
void SetCenterPosition (PositionType pos)
 
void SetDiameter (double diameter)
 

Private Attributes

BPItemTypem_BoundaryPointA
 
BPItemTypem_BoundaryPointB
 
PositionType m_CenterPosition
 
double m_Diameter
 

Detailed Description

template<unsigned int VImageDimension>
class itk::BloxCoreAtomItem< VImageDimension >

A core atom object, stored in a BloxPixel.

A core atom is two boundary points whose gradients face each other They store pointers to the two boundary points and a vnl_vector_fixed representing the "center" of the core atom (i.e. the midpoint along the vector between the two boundary points).

Definition at line 39 of file itkBloxCoreAtomItem.h.

Member Typedef Documentation

template<unsigned int VImageDimension>
typedef BloxBoundaryPointItem<VImageDimension> itk::BloxCoreAtomItem< VImageDimension >::BPItemType

The type of boundary point item we store pointers to. *

Definition at line 46 of file itkBloxCoreAtomItem.h.

template<unsigned int VImageDimension>
typedef Point<double, VImageDimension> itk::BloxCoreAtomItem< VImageDimension >::PositionType

The point type used to store the position of the CoreAtomItem.

Definition at line 43 of file itkBloxCoreAtomItem.h.

Constructor & Destructor Documentation

template<unsigned int VImageDimension>
itk::BloxCoreAtomItem< VImageDimension >::BloxCoreAtomItem ( )

Definition at line 27 of file itkBloxCoreAtomItem.txx.

template<unsigned int VImageDimension>
itk::BloxCoreAtomItem< VImageDimension >::~BloxCoreAtomItem ( )

Definition at line 34 of file itkBloxCoreAtomItem.txx.

Member Function Documentation

template<unsigned int VImageDimension>
void itk::BloxCoreAtomItem< VImageDimension >::CalcCenterAndDiameter ( )

Calculate the position of the center of the core atom in physical space (assumes that the two boundary points are initialized) Also calculates the core atom's diameter This function is not often used because center and diameter are usually initialized via set() functions when the core atom is created elsewhere.

Definition at line 42 of file itkBloxCoreAtomItem.txx.

template<unsigned int VImageDimension>
BPItemType* itk::BloxCoreAtomItem< VImageDimension >::GetBoundaryPointA ( )
inline

Get the position of the first boundary point in physical space.

Definition at line 53 of file itkBloxCoreAtomItem.h.

Referenced by itk::BloxCoreAtomPixel< NDimensions >::DoCoreAtomEigenanalysis().

template<unsigned int VImageDimension>
BPItemType* itk::BloxCoreAtomItem< VImageDimension >::GetBoundaryPointB ( )
inline

Get the position of the first boundary point in physical space.

Definition at line 61 of file itkBloxCoreAtomItem.h.

Referenced by itk::BloxCoreAtomPixel< NDimensions >::DoCoreAtomEigenanalysis().

template<unsigned int VImageDimension>
PositionType itk::BloxCoreAtomItem< VImageDimension >::GetCenterPosition ( )
inline

Get the position of the center of the core atom in physical space.

Definition at line 69 of file itkBloxCoreAtomItem.h.

Referenced by itk::BloxCoreAtomPixel< NDimensions >::CalcWeightedCoreAtomLocation().

template<unsigned int VImageDimension>
double itk::BloxCoreAtomItem< VImageDimension >::GetDiameter ( )
inline

Get the diameter.

Definition at line 77 of file itkBloxCoreAtomItem.h.

Referenced by itk::BloxCoreAtomPixel< NDimensions >::CalcMeanCoreAtomDiameter().

template<unsigned int VImageDimension>
void itk::BloxCoreAtomItem< VImageDimension >::SetBoundaryPointA ( BPItemType pointA)
inline
template<unsigned int VImageDimension>
void itk::BloxCoreAtomItem< VImageDimension >::SetBoundaryPointB ( BPItemType pointB)
inline
template<unsigned int VImageDimension>
void itk::BloxCoreAtomItem< VImageDimension >::SetCenterPosition ( PositionType  pos)
inline
template<unsigned int VImageDimension>
void itk::BloxCoreAtomItem< VImageDimension >::SetDiameter ( double  diameter)
inline

Member Data Documentation

template<unsigned int VImageDimension>
BPItemType* itk::BloxCoreAtomItem< VImageDimension >::m_BoundaryPointA
private

The first boundary point that's part of the core atom.

Definition at line 100 of file itkBloxCoreAtomItem.h.

template<unsigned int VImageDimension>
BPItemType* itk::BloxCoreAtomItem< VImageDimension >::m_BoundaryPointB
private

The second boundary point that's part of the core atom.

Definition at line 103 of file itkBloxCoreAtomItem.h.

template<unsigned int VImageDimension>
PositionType itk::BloxCoreAtomItem< VImageDimension >::m_CenterPosition
private

The position of the center of the core atom.

Definition at line 93 of file itkBloxCoreAtomItem.h.

template<unsigned int VImageDimension>
double itk::BloxCoreAtomItem< VImageDimension >::m_Diameter
private

The diameter of the core atom This is the magnitude of the vector from boundary points A->B.

Definition at line 97 of file itkBloxCoreAtomItem.h.


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

Generated at Sun May 12 2013 01:20:32 for Orfeo Toolbox with doxygen 1.8.3.1