FREE::ImageMaskedROI< VImageDimension > Class Template Reference

Base class for a masked ROI within f.r.e.e. More...

#include <freROI.h>

Inheritance diagram for FREE::ImageMaskedROI< VImageDimension >:

[legend]

Collaboration diagram for FREE::ImageMaskedROI< VImageDimension >:

[legend]

List of all members.

Public Types
typedef ImageMaskedROI	Self
typedef ImageROIBase < VImageDimension >	Superclass
typedef itk::SmartPointer < Self >	Pointer
typedef itk::SmartPointer < const Self >	ConstPointer
typedef ImageTypes < VImageDimension > ::MaskType	MaskType
typedef MaskType::Pointer	MaskPointer
typedef Superclass::PointType	PointType
typedef Superclass::ImageType	ImageType
typedef Superclass::ImagePointer	ImagePointer
typedef Superclass::RegionType	RegionType
typedef Superclass::SpacingType	SpacingType
typedef Superclass::SpatialObjectType	SpatialObjectType
typedef Superclass::SpatialObjectPointer	SpatialObjectPointer
Public Member Functions
	itkTypeMacro (ImageMaskedROIBase, ImageROIBase)
	itkNewMacro (Self)
virtual void	Reset ()
const MaskType *	GetMask () const
MaskType *	GetMask ()
MaskPointer &	GetMaskSmartPointer ()
void	SetMask (MaskType *pMask)
void	SetMask (const std::string &sMaskFile)
std::string	GetMaskFileName () const
void	SetMaskFileName (const std::string &sMaskFile)
void	SetMaskImage (const bool &bMaskImage)
bool	GetMaskImage ()
void	SetMaskAtROIOrigin (const bool &bSameOrigin)
bool	GetMaskAtROIOrigin ()
virtual SpatialObjectPointer	GetSpatialObject (const ImageType *pImage)
virtual ImagePointer	ReadyImageByROI (const ImageType *pImage)
virtual bool	PointWithinROI (PointType point)
Protected Member Functions
	ImageMaskedROI ()
Protected Attributes
MaskPointer	m_smpMask
std::string	m_sMaskFile

---

Detailed Description

template<unsigned int VImageDimension>
class FREE::ImageMaskedROI< VImageDimension >

Base class for a masked ROI within f.r.e.e.

This is the class for a masked region of interest (ROI) within f.r.e.e.. It owns all derived features from ImageROIBase, but you can also define an image mask. A mask is an image, which will be used to determine, if a given point is within the ROI or not. A pixel value of 0 means not within.

Remarks:

Every point outside of a given mask image will also be considered as nasked. If no mask has been specified the ROI behaves as normal ROI.

Definition at line 284 of file freROI.h.

---

Member Typedef Documentation

template<unsigned int VImageDimension>

typedef ImageMaskedROI FREE::ImageMaskedROI< VImageDimension >::Self

Standard typedefs

Reimplemented from FREE::ImageROIBase< VImageDimension >.

Definition at line 288 of file freROI.h.

template<unsigned int VImageDimension>

typedef ImageROIBase<VImageDimension> FREE::ImageMaskedROI< VImageDimension >::Superclass

Reimplemented from FREE::ImageROIBase< VImageDimension >.

Definition at line 289 of file freROI.h.

template<unsigned int VImageDimension>

typedef itk::SmartPointer<Self> FREE::ImageMaskedROI< VImageDimension >::Pointer

Reimplemented from FREE::ImageROIBase< VImageDimension >.

Definition at line 290 of file freROI.h.

template<unsigned int VImageDimension>

typedef itk::SmartPointer<const Self> FREE::ImageMaskedROI< VImageDimension >::ConstPointer

Reimplemented from FREE::ImageROIBase< VImageDimension >.

Definition at line 291 of file freROI.h.

template<unsigned int VImageDimension>

typedef ImageTypes<VImageDimension>::MaskType FREE::ImageMaskedROI< VImageDimension >::MaskType

Definition at line 293 of file freROI.h.

template<unsigned int VImageDimension>

typedef MaskType::Pointer FREE::ImageMaskedROI< VImageDimension >::MaskPointer

Definition at line 294 of file freROI.h.

template<unsigned int VImageDimension>

typedef Superclass::PointType FREE::ImageMaskedROI< VImageDimension >::PointType

Reimplemented from FREE::ImageROIBase< VImageDimension >.

Definition at line 296 of file freROI.h.

template<unsigned int VImageDimension>

typedef Superclass::ImageType FREE::ImageMaskedROI< VImageDimension >::ImageType

Reimplemented from FREE::ImageROIBase< VImageDimension >.

Definition at line 297 of file freROI.h.

template<unsigned int VImageDimension>

typedef Superclass::ImagePointer FREE::ImageMaskedROI< VImageDimension >::ImagePointer

Reimplemented from FREE::ImageROIBase< VImageDimension >.

Definition at line 298 of file freROI.h.

template<unsigned int VImageDimension>

typedef Superclass::RegionType FREE::ImageMaskedROI< VImageDimension >::RegionType

Reimplemented from FREE::ImageROIBase< VImageDimension >.

Definition at line 299 of file freROI.h.

template<unsigned int VImageDimension>

typedef Superclass::SpacingType FREE::ImageMaskedROI< VImageDimension >::SpacingType

Reimplemented from FREE::ImageROIBase< VImageDimension >.

Definition at line 300 of file freROI.h.

template<unsigned int VImageDimension>

typedef Superclass::SpatialObjectType FREE::ImageMaskedROI< VImageDimension >::SpatialObjectType

Reimplemented from FREE::ImageROIBase< VImageDimension >.

Definition at line 302 of file freROI.h.

template<unsigned int VImageDimension>

typedef Superclass::SpatialObjectPointer FREE::ImageMaskedROI< VImageDimension >::SpatialObjectPointer

Reimplemented from FREE::ImageROIBase< VImageDimension >.

Definition at line 303 of file freROI.h.

---

Constructor & Destructor Documentation

template<unsigned int VImageDimension>

FREE::ImageMaskedROI< VImageDimension >::ImageMaskedROI

(

)

[inline, protected]

Definition at line 461 of file freROI.h.

References FREE::ImageMaskedROI< VImageDimension >::Reset().

Here is the call graph for this function:

---

Member Function Documentation

template<unsigned int VImageDimension>

FREE::ImageMaskedROI< VImageDimension >::itkTypeMacro	(	ImageMaskedROIBase	,
		ImageROIBase
	)

Run-time type information (and related methods).

template<unsigned int VImageDimension>

FREE::ImageMaskedROI< VImageDimension >::itkNewMacro

(

Self

)

Reimplemented from FREE::ImageROIBase< VImageDimension >.

template<unsigned int VImageDimension>

virtual void FREE::ImageMaskedROI< VImageDimension >::Reset

(

)

[inline, virtual]

Reimplemented from FREE::ImageROIBase< VImageDimension >.

Definition at line 309 of file freROI.h.

References FREE::ImageROIBase< VImageDimension >::m_dOrigin, and FREE::ImageROIBase< VImageDimension >::m_dSize.

Referenced by FREE::ImageMaskedROI< VImageDimension >::ImageMaskedROI().

template<unsigned int VImageDimension>

const MaskType* FREE::ImageMaskedROI< VImageDimension >::GetMask

(

)

const [inline]

Function returns the mask of the ROI.

Definition at line 319 of file freROI.h.

References FREE::ImageMaskedROI< VImageDimension >::m_smpMask.

template<unsigned int VImageDimension>

MaskType* FREE::ImageMaskedROI< VImageDimension >::GetMask

(

)

[inline]

Definition at line 323 of file freROI.h.

References FREE::ImageMaskedROI< VImageDimension >::m_smpMask.

template<unsigned int VImageDimension>

MaskPointer& FREE::ImageMaskedROI< VImageDimension >::GetMaskSmartPointer

(

)

[inline]

Definition at line 327 of file freROI.h.

References FREE::ImageMaskedROI< VImageDimension >::m_smpMask.

template<unsigned int VImageDimension>

void FREE::ImageMaskedROI< VImageDimension >::SetMask

(

MaskType *

pMask

)

[inline]

Function sets the mask, of the ROI.

Definition at line 333 of file freROI.h.

References FREE::ImageMaskedROI< VImageDimension >::m_smpMask.

template<unsigned int VImageDimension>

void FREE::ImageMaskedROI< VImageDimension >::SetMask

(

const std::string &

sMaskFile

)

[inline]

Function sets the mask, of the ROI. The mask is loaded from the file specified by the passed string. Also m_sMaskFile will be set to the specified file, if loaded successfully.

Definition at line 340 of file freROI.h.

References catchAllNPassMacro, FREE::ImageMaskedROI< VImageDimension >::m_sMaskFile, and FREE::ImageMaskedROI< VImageDimension >::m_smpMask.

template<unsigned int VImageDimension>

std::string FREE::ImageMaskedROI< VImageDimension >::GetMaskFileName

(

)

const [inline]

Function returns the file name of the mask. If it isn't set, the return is ''.

Definition at line 359 of file freROI.h.

References FREE::ImageMaskedROI< VImageDimension >::m_sMaskFile.

template<unsigned int VImageDimension>

void FREE::ImageMaskedROI< VImageDimension >::SetMaskFileName

(

const std::string &

sMaskFile

)

[inline]

Function sets the mask file nameMask, of the ROI. If the Mask is set this way, the m mask file name will be reseted.

Definition at line 366 of file freROI.h.

References FREE::ImageMaskedROI< VImageDimension >::m_sMaskFile.

template<unsigned int VImageDimension>

void FREE::ImageMaskedROI< VImageDimension >::SetMaskImage

(

const bool &

bMaskImage

)

[inline]

Definition at line 371 of file freROI.h.

template<unsigned int VImageDimension>

bool FREE::ImageMaskedROI< VImageDimension >::GetMaskImage

(

)

[inline]

Definition at line 375 of file freROI.h.

template<unsigned int VImageDimension>

void FREE::ImageMaskedROI< VImageDimension >::SetMaskAtROIOrigin

(

const bool &

bSameOrigin

)

[inline]

Definition at line 380 of file freROI.h.

template<unsigned int VImageDimension>

bool FREE::ImageMaskedROI< VImageDimension >::GetMaskAtROIOrigin

(

)

[inline]

Definition at line 384 of file freROI.h.

template<unsigned int VImageDimension>

virtual SpatialObjectPointer FREE::ImageMaskedROI< VImageDimension >::GetSpatialObject

(

const ImageType *

pImage

)

[inline, virtual]

Function creates a derivate of itk::SpatialObject which represents the ROI for the passed image.

Parameters:

[in]

pImage

Pointer to the image for which the spatial object should be created.

Returns:

Returns the spatial object.

Definition at line 394 of file freROI.h.

References FREE::ImageMaskedROI< VImageDimension >::m_smpMask.

template<unsigned int VImageDimension>

virtual ImagePointer FREE::ImageMaskedROI< VImageDimension >::ReadyImageByROI

(

const ImageType *

pImage

)

[inline, virtual]

This function computes the image with the given information. The return of the function is an image, which is ready to be used in further image processing.
In this case, a part of the image will be extracted regarding the ROI and all Parts of this image will be masked to black using m_Mask.

Remarks:

This funcion uses the spacing of the passed Image to generate the ROI. If the ROI is not within the largest possible region of the image, the return will be an empty image with an origin same as the ROI.

Parameters:

[in]

pImage

Pointer to the image from where the ROI should be extracted.

Returns:

The computed image volume.

Definition at line 413 of file freROI.h.

References FREE::ImageROIBase< VImageDimension >::ExtractImageByROI(), and FREE::ImageMaskedROI< VImageDimension >::m_smpMask.

Here is the call graph for this function:

template<unsigned int VImageDimension>

virtual bool FREE::ImageMaskedROI< VImageDimension >::PointWithinROI

(

PointType

point

)

[inline, virtual]

This function checks, if the given point is within the ROI or not. The behavior of this function depends on the derivates and may change. The default case is a simple check if the given point is within the computes the image with the given information. The return of the function is an image, which is ready to be used in further image processing.
The result of the function depends on the derived classes. In this case, a part of the image will be extracted regarding the ROI.

Remarks:

This funcion uses the spacing of the passed Image to generate the ROI. If the ROI is not within the largest possible region of the image, the return will be an empty image with an origin same as the ROI.

Parameters:

[in]

pImage

Pointer to the image from where the ROI should be extracted.

Returns:

The computed image volume.

Definition at line 445 of file freROI.h.

References FREE::ImageMaskedROI< VImageDimension >::m_smpMask.

---

Member Data Documentation

template<unsigned int VImageDimension>

MaskPointer FREE::ImageMaskedROI< VImageDimension >::m_smpMask [protected]

Definition at line 464 of file freROI.h.

Referenced by FREE::ImageMaskedROI< VImageDimension >::GetMask(), FREE::ImageMaskedROI< VImageDimension >::GetMaskSmartPointer(), FREE::ImageMaskedROI< VImageDimension >::GetSpatialObject(), FREE::ImageMaskedROI< VImageDimension >::PointWithinROI(), FREE::ImageMaskedROI< VImageDimension >::ReadyImageByROI(), and FREE::ImageMaskedROI< VImageDimension >::SetMask().

template<unsigned int VImageDimension>

std::string FREE::ImageMaskedROI< VImageDimension >::m_sMaskFile [protected]

Definition at line 467 of file freROI.h.

Referenced by FREE::ImageMaskedROI< VImageDimension >::GetMaskFileName(), FREE::ImageMaskedROI< VImageDimension >::SetMask(), and FREE::ImageMaskedROI< VImageDimension >::SetMaskFileName().

---

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

• freROI.h

---