SimpleITK  1.2.4
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::LabelMapMaskImageFilter Class Reference

Mask and image with a LabelMap . More...

#include <sitkLabelMapMaskImageFilter.h>

+ Inheritance diagram for itk::simple::LabelMapMaskImageFilter:
+ Collaboration diagram for itk::simple::LabelMapMaskImageFilter:

Public Types

typedef LabelPixelIDTypeList PixelIDTypeList
 
typedef LabelMapMaskImageFilter Self
 
- Public Types inherited from itk::simple::ImageFilter< 0 >
typedef ImageFilter Self
 
- Public Types inherited from itk::simple::ProcessObject
typedef ProcessObject Self
 

Public Member Functions

SelfCropOff ()
 
SelfCropOn ()
 
Image Execute (const Image &labelMapImage, const Image &featureImage)
 
Image Execute (const Image &labelMapImage, const Image &featureImage, uint64_t label, double backgroundValue, bool negated, bool crop, const std::vector< unsigned int > &cropBorder)
 
double GetBackgroundValue () const
 
bool GetCrop () const
 
std::vector< unsigned int > GetCropBorder () const
 
uint64_t GetLabel () const
 
std::string GetName () const
 
bool GetNegated () const
 
 LabelMapMaskImageFilter ()
 
SelfNegatedOff ()
 
SelfNegatedOn ()
 
SelfSetBackgroundValue (double BackgroundValue)
 
SelfSetCrop (bool Crop)
 
SelfSetCropBorder (const std::vector< unsigned int > &CropBorder)
 
SelfSetCropBorder (unsigned int value)
 
SelfSetLabel (uint64_t Label)
 
SelfSetNegated (bool Negated)
 
std::string ToString () const
 
virtual ~LabelMapMaskImageFilter ()
 
- Public Member Functions inherited from itk::simple::ImageFilter< 0 >
 ImageFilter ()
 
virtual ~ImageFilter ()=0
 
- Public Member Functions inherited from itk::simple::ProcessObject
virtual void Abort ()
 
virtual int AddCommand (itk::simple::EventEnum event, itk::simple::Command &cmd)
 Add a Command Object to observer the event. More...
 
virtual float GetProgress () const
 An Active Measurement of the progress of execution. More...
 
virtual bool HasCommand (itk::simple::EventEnum event) const
 Query of this object has any registered commands for event. More...
 
 ProcessObject ()
 
virtual void RemoveAllCommands ()
 Remove all registered commands. More...
 
virtual ~ProcessObject ()
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
virtual bool GetDebug () const
 
virtual void SetDebug (bool debugFlag)
 
virtual void SetNumberOfThreads (unsigned int n)
 
virtual unsigned int GetNumberOfThreads () const
 

Private Types

typedef Image(Self::* MemberFunctionType) (const Image *labelMapImage, const Image *featureImage)
 

Private Member Functions

template<class TImageType1 , class TImageType2 >
Image DualExecuteInternal (const Image *labelMapImage, const Image *featureImage)
 

Private Attributes

double m_BackgroundValue
 
bool m_Crop
 
std::vector< unsigned int > m_CropBorder
 
nsstd::auto_ptr< detail::DualMemberFunctionFactory< MemberFunctionType > > m_DualMemberFactory
 
uint64_t m_Label
 
bool m_Negated
 

Friends

struct detail::DualExecuteInternalAddressor< MemberFunctionType >
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::simple::ProcessObject
static bool GetGlobalDefaultDebug ()
 
static void GlobalDefaultDebugOff ()
 
static void GlobalDefaultDebugOn ()
 
static void SetGlobalDefaultDebug (bool debugFlag)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static void SetGlobalWarningDisplay (bool flag)
 
static bool GetGlobalWarningDisplay ()
 
static void SetGlobalDefaultNumberOfThreads (unsigned int n)
 
static unsigned int GetGlobalDefaultNumberOfThreads ()
 
static double GetGlobalDefaultCoordinateTolerance ()
 Access the global tolerance to determine congruent spaces. More...
 
static void SetGlobalDefaultCoordinateTolerance (double)
 Access the global tolerance to determine congruent spaces. More...
 
static double GetGlobalDefaultDirectionTolerance ()
 Access the global tolerance to determine congruent spaces. More...
 
static void SetGlobalDefaultDirectionTolerance (double)
 Access the global tolerance to determine congruent spaces. More...
 
- Protected Member Functions inherited from itk::simple::ProcessObject
virtual unsigned long AddITKObserver (const itk::EventObject &, itk::Command *)
 
virtual itk::ProcessObjectGetActiveProcess ()
 
virtual void OnActiveProcessDelete ()
 
virtual void onCommandDelete (const itk::simple::Command *cmd) SITK_NOEXCEPT
 
virtual void PreUpdate (itk::ProcessObject *p)
 
virtual void RemoveITKObserver (EventCommand &e)
 
- Protected Member Functions inherited from itk::simple::NonCopyable
 NonCopyable ()
 
- Static Protected Member Functions inherited from itk::simple::ImageFilter< 0 >
static void FixNonZeroIndex (TImageType *img)
 
- Static Protected Member Functions inherited from itk::simple::ProcessObject
template<class TImageType >
static TImageType::ConstPointer CastImageToITK (const Image &img)
 
template<class TImageType >
static Image CastITKToImage (TImageType *img)
 
template<class TPixelType , unsigned int VImageDimension, unsigned int VLength, template< typename, unsigned int > class TVector>
static Image CastITKToImage (itk::Image< TVector< TPixelType, VLength >, VImageDimension > *img)
 
static const itk::EventObjectGetITKEventObject (EventEnum e)
 
template<typename T >
static std::ostream & ToStringHelper (std::ostream &os, const T &v)
 
static std::ostream & ToStringHelper (std::ostream &os, const char &v)
 
static std::ostream & ToStringHelper (std::ostream &os, const signed char &v)
 
static std::ostream & ToStringHelper (std::ostream &os, const unsigned char &v)
 

Detailed Description

Mask and image with a LabelMap .

LabelMapMaskImageFilter mask the content of an input image according to the content of the input LabelMap . The masked pixel of the input image are set to the BackgroundValue. LabelMapMaskImageFilter can keep the input image for one label only, with Negated = false (the default) or it can mask the input image for a single label, when Negated equals true. In Both cases, the label is set with SetLabel() .

Author
Gaetan Lehmann. Biologie du Developpement et de la Reproduction, INRA de Jouy-en-Josas, France.

This implementation was taken from the Insight Journal paper: https://hdl.handle.net/1926/584 or http://www.insight-journal.org/browse/publication/176

See also
LabelMapToBinaryImageFilter , LabelMapToLabelImageFilter
itk::simple::LabelMapMask for the procedural interface
itk::LabelMapMaskImageFilter for the Doxygen on the original ITK class.

Definition at line 49 of file sitkLabelMapMaskImageFilter.h.

Member Typedef Documentation

typedef Image(Self::* itk::simple::LabelMapMaskImageFilter::MemberFunctionType) (const Image *labelMapImage, const Image *featureImage)
private

Setup for member function dispatching

Definition at line 143 of file sitkLabelMapMaskImageFilter.h.

Define the pixels types supported by this filter

Definition at line 61 of file sitkLabelMapMaskImageFilter.h.

Definition at line 51 of file sitkLabelMapMaskImageFilter.h.

Constructor & Destructor Documentation

virtual itk::simple::LabelMapMaskImageFilter::~LabelMapMaskImageFilter ( )
virtual

Destructor

itk::simple::LabelMapMaskImageFilter::LabelMapMaskImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

Self& itk::simple::LabelMapMaskImageFilter::CropOff ( )
inline

Definition at line 106 of file sitkLabelMapMaskImageFilter.h.

Self& itk::simple::LabelMapMaskImageFilter::CropOn ( )
inline

Set the value of Crop to true or false respectfully.

Definition at line 105 of file sitkLabelMapMaskImageFilter.h.

template<class TImageType1 , class TImageType2 >
Image itk::simple::LabelMapMaskImageFilter::DualExecuteInternal ( const Image labelMapImage,
const Image featureImage 
)
private
Image itk::simple::LabelMapMaskImageFilter::Execute ( const Image labelMapImage,
const Image featureImage 
)

Execute the filter on the input image

Image itk::simple::LabelMapMaskImageFilter::Execute ( const Image labelMapImage,
const Image featureImage,
uint64_t  label,
double  backgroundValue,
bool  negated,
bool  crop,
const std::vector< unsigned int > &  cropBorder 
)

Execute the filter on the input image with the given parameters

double itk::simple::LabelMapMaskImageFilter::GetBackgroundValue ( ) const
inline

Set/Get the value used as "background" in the output image. Defaults to NumericTraits<PixelType>::ZeroValue() .

Definition at line 83 of file sitkLabelMapMaskImageFilter.h.

bool itk::simple::LabelMapMaskImageFilter::GetCrop ( ) const
inline

Set/Get whether the image size should be adjusted to the masked image or not.

Definition at line 111 of file sitkLabelMapMaskImageFilter.h.

std::vector<unsigned int> itk::simple::LabelMapMaskImageFilter::GetCropBorder ( ) const
inline

Set/Get the boder added to the mask before the crop. The default is 0 on all the axes.

Definition at line 125 of file sitkLabelMapMaskImageFilter.h.

uint64_t itk::simple::LabelMapMaskImageFilter::GetLabel ( ) const
inline

The label to mask or to not mask, depending on the value of the Negated ivar.

Definition at line 73 of file sitkLabelMapMaskImageFilter.h.

std::string itk::simple::LabelMapMaskImageFilter::GetName ( ) const
inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 127 of file sitkLabelMapMaskImageFilter.h.

bool itk::simple::LabelMapMaskImageFilter::GetNegated ( ) const
inline

Set/Get whether the Label should be masked or not.

Definition at line 97 of file sitkLabelMapMaskImageFilter.h.

Self& itk::simple::LabelMapMaskImageFilter::NegatedOff ( )
inline

Definition at line 92 of file sitkLabelMapMaskImageFilter.h.

Self& itk::simple::LabelMapMaskImageFilter::NegatedOn ( )
inline

Set the value of Negated to true or false respectfully.

Definition at line 91 of file sitkLabelMapMaskImageFilter.h.

Self& itk::simple::LabelMapMaskImageFilter::SetBackgroundValue ( double  BackgroundValue)
inline

Set/Get the value used as "background" in the output image. Defaults to NumericTraits<PixelType>::ZeroValue() .

Definition at line 78 of file sitkLabelMapMaskImageFilter.h.

Self& itk::simple::LabelMapMaskImageFilter::SetCrop ( bool  Crop)
inline

Set/Get whether the image size should be adjusted to the masked image or not.

Definition at line 102 of file sitkLabelMapMaskImageFilter.h.

References itk::simple::Crop().

Self& itk::simple::LabelMapMaskImageFilter::SetCropBorder ( const std::vector< unsigned int > &  CropBorder)
inline

Set/Get the boder added to the mask before the crop. The default is 0 on all the axes.

Definition at line 116 of file sitkLabelMapMaskImageFilter.h.

Self& itk::simple::LabelMapMaskImageFilter::SetCropBorder ( unsigned int  value)
inline

Set the values of the CropBorder vector all to value

Definition at line 119 of file sitkLabelMapMaskImageFilter.h.

Self& itk::simple::LabelMapMaskImageFilter::SetLabel ( uint64_t  Label)
inline

The label to mask or to not mask, depending on the value of the Negated ivar.

Definition at line 68 of file sitkLabelMapMaskImageFilter.h.

Self& itk::simple::LabelMapMaskImageFilter::SetNegated ( bool  Negated)
inline

Set/Get whether the Label should be masked or not.

Definition at line 88 of file sitkLabelMapMaskImageFilter.h.

std::string itk::simple::LabelMapMaskImageFilter::ToString ( ) const
virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

Definition at line 145 of file sitkLabelMapMaskImageFilter.h.

Member Data Documentation

double itk::simple::LabelMapMaskImageFilter::m_BackgroundValue
private

Definition at line 156 of file sitkLabelMapMaskImageFilter.h.

bool itk::simple::LabelMapMaskImageFilter::m_Crop
private

Definition at line 160 of file sitkLabelMapMaskImageFilter.h.

std::vector<unsigned int> itk::simple::LabelMapMaskImageFilter::m_CropBorder
private

Definition at line 161 of file sitkLabelMapMaskImageFilter.h.

nsstd::auto_ptr<detail::DualMemberFunctionFactory<MemberFunctionType> > itk::simple::LabelMapMaskImageFilter::m_DualMemberFactory
private

Definition at line 149 of file sitkLabelMapMaskImageFilter.h.

uint64_t itk::simple::LabelMapMaskImageFilter::m_Label
private

Definition at line 154 of file sitkLabelMapMaskImageFilter.h.

bool itk::simple::LabelMapMaskImageFilter::m_Negated
private

Definition at line 158 of file sitkLabelMapMaskImageFilter.h.


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