mitkNeighborhood Class Reference

A light-weight container object for storing an N-dimensional neighborhood of values. More...

#include <mitkNeighborhood.h>

List of all members.

Public Types
typedef mitkNeighborhood	Self
Public Member Functions
	~mitkNeighborhood ()
	mitkNeighborhood (const Self &other)
void	operator= (const Self &other)
void	SetDataType (int data_type)
int	GetDataType () const

---

Detailed Description

A light-weight container object for storing an N-dimensional neighborhood of values.

A mitkNeighborhood has an N-dimensional radius. The radius is defined separately for each dimension as the number of pixels that the neighborhood extends outward from the center pixel. For example, a 2D Neighborhood object with a radius of 2x3 has sides of length 5x7. Neighborhood objects always have an unambiguous center because their side lengths are always odd.

---

Member Typedef Documentation

typedef mitkNeighborhood mitkNeighborhood::Self

Standard class typedefs.

---

Constructor & Destructor Documentation

mitkNeighborhood::~mitkNeighborhood (   )  [inline]

Default constructor.

mitkNeighborhood::mitkNeighborhood (  const Self &  other  )

Copy constructor.

---

Member Function Documentation

int mitkNeighborhood::GetDataType (   )  const [inline]

Get data type of this Neighborhood. MITK supports various data type. Returns: All of the return values and their meaning are shown as follows: MITK_CHAR The data type is char MITK_UNSIGNED_CHAR The data type is unsigned char MITK_SHORT The data type is short MITK_UNSIGNED_SHORT The data type is unsigned short MITK_INT The data type is int MITK_UNSIGNED_INT The data type is unsigned int MITK_LONG The data type is long MITK_UNSIGNED_LONG The data type is unsigned long MITK_FLOAT The data type is float MITK_DOUBLE The data type is double

void mitkNeighborhood::operator= (  const Self &  other  )

Assignment operator.

void mitkNeighborhood::SetDataType (  int  data_type  )

Set data type of this Neighborhood. MITK supports various data type. Parameters: data_type  Its valid value and meaning is shown as follows: MITK_CHAR The data type is char MITK_UNSIGNED_CHAR The data type is unsigned char MITK_SHORT The data type is short MITK_UNSIGNED_SHORT The data type is unsigned short MITK_INT The data type is int MITK_UNSIGNED_INT The data type is unsigned int MITK_LONG The data type is long MITK_UNSIGNED_LONG The data type is unsigned long MITK_FLOAT The data type is float MITK_DOUBLE The data type is double

---

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

• mitkNeighborhood.h

---