OneByteImagePixelDataset Class Reference
[Datasets]

Datasets with 2 dimensions and a pixel type of size 1. More...

#include <one_byte_image_pixel_dataset.h>

Inheritance diagram for OneByteImagePixelDataset:

[legend]Collaboration diagram for OneByteImagePixelDataset:


Public Types
typedef image_type	type
Public Member Functions
	OneByteImagePixelDataset (dataset_key_type dataset_key, image_pointer_type image=0)
virtual	~OneByteImagePixelDataset ()
virtual external_data_pointer_type	getData () const throw (NullPointerException)
void	setDataset (image_pointer_type dataset)
image_pointer_type	getDataset ()
const_image_pointer_type	getDataset () const
virtual void	setIntensity (double window, double level)
virtual double	getIntensityWindow () const throw (NullPointerException)
virtual double	getIntensityLevel () const throw (NullPointerException)
Protected Types
typedef one_byte_image_type	image_type
typedef one_byte_image_pointer_type	image_pointer_type
typedef const_one_byte_image_pointer_type	const_image_pointer_type
typedef const_one_byte_image_iterator_type	const_image_iterator_type
typedef one_byte_pixel_type	pixel_type
typedef image_type::RegionType	region_type
typedef image_type::SizeType	region_size_type
typedef image_type::IndexType	region_index_type
typedef itk::IntensityWindowingImageFilter< image_type, external_image_type >	image_intensity_filter_type
Protected Member Functions
	OneByteImagePixelDataset (OneByteImagePixelDataset const &src)
void	setDatasetInternal (image_pointer_type dataset)
Protected Attributes
image_pointer_type	dataset_
image_intensity_filter_type::Pointer	image_intensity_filter_

Detailed Description

Datasets with 2 dimensions and a pixel type of size 1.

The implementation of the Dataset interface for 2 dimensional datasets with a pixel stride of one byte.

Author:

Tobias Gross (tobias.gross@imedgine.org)

Christian Koerner (christian.koerner@imedgine.org)

Alexander Lex (alexander.lex@imedgine.org)

Marc Streit (marc.streit@imedgine.org)

Martin Reininger (martin.reininger@imedgine.org)

See also:: Dataset

Definition at line 43 of file one_byte_image_pixel_dataset.h.

Member Typedef Documentation

typedef const_one_byte_image_iterator_type const_image_iterator_type [protected]

The type for a read-only iterator through the image
Definition at line 65 of file one_byte_image_pixel_dataset.h.

typedef const_one_byte_image_pointer_type const_image_pointer_type [protected]

The type for a read-only pointer to the image
Definition at line 60 of file one_byte_image_pixel_dataset.h.

typedef itk::IntensityWindowingImageFilter<image_type, external_image_type> image_intensity_filter_type [protected]

The type for the intensity mapper in 2 dimensional datasets
Definition at line 170 of file one_byte_image_pixel_dataset.h.

typedef one_byte_image_pointer_type image_pointer_type [protected]

The type for a pointer to the image
Definition at line 55 of file one_byte_image_pixel_dataset.h.

typedef one_byte_image_type image_type [protected]

The type for the image
Definition at line 50 of file one_byte_image_pixel_dataset.h.

typedef one_byte_pixel_type pixel_type [protected]

The type used to store one pixel
Definition at line 70 of file one_byte_image_pixel_dataset.h.

typedef image_type::IndexType region_index_type [protected]

The type for a x,y,z-position within the volume
Definition at line 164 of file one_byte_image_pixel_dataset.h.

typedef image_type::SizeType region_size_type [protected]

The type for a x,y,z-size of a region within the volume
Definition at line 159 of file one_byte_image_pixel_dataset.h.

typedef image_type::RegionType region_type [protected]

The type for a region (size and origin) within the volume
Definition at line 154 of file one_byte_image_pixel_dataset.h.

typedef image_type type

The type of the dataset for external scoping
Definition at line 77 of file one_byte_image_pixel_dataset.h.

Constructor & Destructor Documentation

OneByteImagePixelDataset ( dataset_key_type dataset_key,

image_pointer_type image = 0

)

Constructor
Parameters:

dataset_key The unique key of the dataset

image The image to manage

Definition at line 22 of file one_byte_image_pixel_dataset.cpp.

~OneByteImagePixelDataset ( ) [virtual]

Destructor
Definition at line 43 of file one_byte_image_pixel_dataset.cpp.

OneByteImagePixelDataset ( OneByteImagePixelDataset const & src ) [protected]

Copy constructor
Definition at line 35 of file one_byte_image_pixel_dataset.cpp.

Member Function Documentation

external_data_pointer_type getData ( ) const throw (NullPointerException) [virtual]

Returns a pointer to the raw data held by the dataset.
Returns:
A pointer to the dataset

Implements PixelDataset.
Definition at line 49 of file one_byte_image_pixel_dataset.cpp.
References OneByteImagePixelDataset::dataset_.

OneByteImagePixelDataset::const_image_pointer_type getDataset ( ) const

Returns a read-only pointer to the image dataset internally managed.
Returns:
A read-only pointer to the image

Definition at line 77 of file one_byte_image_pixel_dataset.cpp.
References OneByteImagePixelDataset::dataset_.

OneByteImagePixelDataset::image_pointer_type getDataset ( )

Returns a pointer to the image dataset internally managed.
Returns:
A pointer to the image

Definition at line 69 of file one_byte_image_pixel_dataset.cpp.
References OneByteImagePixelDataset::dataset_.

double getIntensityLevel ( ) const throw (NullPointerException) [virtual]

Return the intensity level of the dataset.
Returns:
The intensity level (pixel value in the center of the window)

Implements PixelDataset.
Definition at line 172 of file one_byte_image_pixel_dataset.cpp.
References OneByteImagePixelDataset::image_intensity_filter_.

double getIntensityWindow ( ) const throw (NullPointerException) [virtual]

Return the intensity window of the dataset.
Returns:
The intensity window (pixel value range)

Implements PixelDataset.
Definition at line 160 of file one_byte_image_pixel_dataset.cpp.
References OneByteImagePixelDataset::image_intensity_filter_.

void setDataset ( image_pointer_type dataset )

Sets the image dataset to manage.
Parameters:

dataset The image dataset to manage

Definition at line 84 of file one_byte_image_pixel_dataset.cpp.
References Dataset::is_dirty_, and OneByteImagePixelDataset::setDatasetInternal().
Here is the call graph for this function:

void setDatasetInternal ( image_pointer_type dataset ) [protected]

Sets the image dataset internally
Parameters:

dataset The image dataset to manage

Definition at line 92 of file one_byte_image_pixel_dataset.cpp.
References OneByteImagePixelDataset::dataset_, Dataset::is_data_set_, and PixelDataset::max_pixel_value_.
Referenced by OneByteImagePixelDataset::setDataset().

void setIntensity ( double window,

double level

) [virtual]

Set the intensity window and level for the dataset.
Parameters:

window The window (pixel value range) to set

level The level (pixel value in the center of the window) to set

Implements PixelDataset.
Definition at line 127 of file one_byte_image_pixel_dataset.cpp.
References OneByteImagePixelDataset::image_intensity_filter_.