SimpleITK  2.1.0.dev79
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

using PixelIDTypeList = LabelPixelIDTypeList
 
using Self = LabelMapMaskImageFilter
 
- Public Types inherited from itk::simple::ImageFilter
using Self = ImageFilter
 
- Public Types inherited from itk::simple::ProcessObject
using Self = ProcessObject
 

Public Member Functions

SelfCropOff ()
 
SelfCropOn ()
 
Image Execute (const Image &labelMapImage, const Image &featureImage)
 
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 (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
 ImageFilter ()
 
virtual ~ImageFilter ()=0
 
- Public Member Functions inherited from itk::simple::ProcessObject
virtual void Abort ()
 
virtual int AddCommand (itk::simple::EventEnum event, const std::function< void()> &func)
 Directly add a callback to observe an event. More...
 
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
 
virtual void SetNumberOfWorkUnits (unsigned int n)
 
virtual unsigned int GetNumberOfWorkUnits () const
 

Private Types

using MemberFunctionType = Image(Self::*)(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 {0}
 
bool m_Crop {false}
 
std::vector< unsigned int > m_CropBorder {std::vector<unsigned int>(3, 0)}
 
std::unique_ptr< detail::DualMemberFunctionFactory< MemberFunctionType > > m_DualMemberFactory
 
uint64_t m_Label {1u}
 
bool m_Negated {false}
 

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 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...
 
static bool SetGlobalDefaultThreader (const std::string &threader)
 Set/Get the default threader used for process objects. More...
 
static std::string GetGlobalDefaultThreader ()
 Set/Get the default threader used for process objects. More...
 
static void SetGlobalDefaultNumberOfThreads (unsigned int n)
 
static unsigned int GetGlobalDefaultNumberOfThreads ()
 Set/Get the default threader used for process objects. More...
 
- Protected Member Functions inherited from itk::simple::ImageFilter
void CheckImageMatchingDimension (const Image &image1, const Image &image2, const std::string &image2Name)
 
void CheckImageMatchingPixelType (const Image &image1, const Image &image2, const std::string &image2Name)
 
void CheckImageMatchingSize (const Image &image1, const Image &image2, const std::string &image2Name)
 
- 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) noexcept
 
virtual void PreUpdate (itk::ProcessObject *p)
 
virtual void RemoveITKObserver (EventCommand &e)
 
- Protected Member Functions inherited from itk::simple::NonCopyable
 NonCopyable ()=default
 
 NonCopyable (const NonCopyable &)=delete
 
NonCopyableoperator= (const NonCopyable &)=delete
 
- Static Protected Member Functions inherited from itk::simple::ImageFilter
template<class TImageType >
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 TPixelType , unsigned int VImageDimension, unsigned int VLength, template< typename, unsigned int > class TVector>
static Image CastITKToImage (itk::Image< TVector< TPixelType, VLength >, VImageDimension > *img)
 
template<class TImageType >
static Image CastITKToImage (TImageType *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 50 of file sitkLabelMapMaskImageFilter.h.

Member Typedef Documentation

◆ MemberFunctionType

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

Setup for member function dispatching

Definition at line 141 of file sitkLabelMapMaskImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 62 of file sitkLabelMapMaskImageFilter.h.

◆ Self

Definition at line 52 of file sitkLabelMapMaskImageFilter.h.

Constructor & Destructor Documentation

◆ ~LabelMapMaskImageFilter()

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

Destructor

◆ LabelMapMaskImageFilter()

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

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ CropOff()

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

Definition at line 107 of file sitkLabelMapMaskImageFilter.h.

◆ CropOn()

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

Set the value of Crop to true or false respectfully.

Definition at line 106 of file sitkLabelMapMaskImageFilter.h.

◆ DualExecuteInternal()

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

◆ Execute()

Image itk::simple::LabelMapMaskImageFilter::Execute ( const Image labelMapImage,
const Image featureImage 
)

Execute the filter on the input image

◆ GetBackgroundValue()

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 84 of file sitkLabelMapMaskImageFilter.h.

◆ GetCrop()

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 112 of file sitkLabelMapMaskImageFilter.h.

◆ GetCropBorder()

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.

◆ GetLabel()

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 74 of file sitkLabelMapMaskImageFilter.h.

◆ GetName()

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 128 of file sitkLabelMapMaskImageFilter.h.

◆ GetNegated()

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

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

Definition at line 98 of file sitkLabelMapMaskImageFilter.h.

◆ NegatedOff()

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

Definition at line 93 of file sitkLabelMapMaskImageFilter.h.

◆ NegatedOn()

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

Set the value of Negated to true or false respectfully.

Definition at line 92 of file sitkLabelMapMaskImageFilter.h.

◆ SetBackgroundValue()

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 79 of file sitkLabelMapMaskImageFilter.h.

◆ SetCrop()

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 103 of file sitkLabelMapMaskImageFilter.h.

References itk::simple::Crop().

◆ SetCropBorder() [1/2]

Self& itk::simple::LabelMapMaskImageFilter::SetCropBorder ( 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 117 of file sitkLabelMapMaskImageFilter.h.

◆ SetCropBorder() [2/2]

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

Set the values of the CropBorder vector all to value

Definition at line 120 of file sitkLabelMapMaskImageFilter.h.

◆ SetLabel()

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 69 of file sitkLabelMapMaskImageFilter.h.

◆ SetNegated()

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

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

Definition at line 89 of file sitkLabelMapMaskImageFilter.h.

◆ ToString()

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::DualExecuteInternalAddressor< MemberFunctionType >

Definition at line 143 of file sitkLabelMapMaskImageFilter.h.

Member Data Documentation

◆ m_BackgroundValue

double itk::simple::LabelMapMaskImageFilter::m_BackgroundValue {0}
private

Definition at line 155 of file sitkLabelMapMaskImageFilter.h.

◆ m_Crop

bool itk::simple::LabelMapMaskImageFilter::m_Crop {false}
private

Definition at line 161 of file sitkLabelMapMaskImageFilter.h.

◆ m_CropBorder

std::vector<unsigned int> itk::simple::LabelMapMaskImageFilter::m_CropBorder {std::vector<unsigned int>(3, 0)}
private

Definition at line 163 of file sitkLabelMapMaskImageFilter.h.

◆ m_DualMemberFactory

std::unique_ptr<detail::DualMemberFunctionFactory<MemberFunctionType> > itk::simple::LabelMapMaskImageFilter::m_DualMemberFactory
private

Definition at line 147 of file sitkLabelMapMaskImageFilter.h.

◆ m_Label

uint64_t itk::simple::LabelMapMaskImageFilter::m_Label {1u}
private

Definition at line 152 of file sitkLabelMapMaskImageFilter.h.

◆ m_Negated

bool itk::simple::LabelMapMaskImageFilter::m_Negated {false}
private

Definition at line 158 of file sitkLabelMapMaskImageFilter.h.


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