ITK  4.4.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage > Class Template Reference

#include <itkMaskImageFilter.h>

+ Inheritance diagram for itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >:
+ Collaboration diagram for itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >:

Detailed Description

template<class TInputImage, class TMaskImage, class TOutputImage = TInputImage>
class itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >

Mask an image with a mask.

This class is templated over the types of the input image type, the mask image type and the type of the output image. Numeric conversions (castings) are done by the C++ defaults.

The pixel type of the input 2 image must have a valid definition of the operator != with zero. This condition is required because internally this filter will perform the operation

if pixel_from_mask_image != masking_value
pixel_output_image = pixel_input_image
else
pixel_output_image = outside_value

The pixel from the input 1 is cast to the pixel type of the output image.

Note that the input and the mask images must be of the same size.

Warning
Any pixel value other than masking value (0 by default) will not be masked out.
See Also
MaskNegatedImageFilter
Wiki Examples:

Definition at line 145 of file itkMaskImageFilter.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef TMaskImage MaskImageType
 
typedef SmartPointer< SelfPointer
 
typedef MaskImageFilter Self
 
typedef
BinaryFunctorImageFilter
< TInputImage, TMaskImage,
TOutputImage,
Functor::MaskInput< typename
TInputImage::PixelType,
typename TMaskImage::PixelType,
typename
TOutputImage::PixelType > > 
Superclass
 
- Public Types inherited from itk::BinaryFunctorImageFilter< TInputImage, TMaskImage, TOutputImage, Functor::MaskInput< TInputImage::PixelType, TMaskImage::PixelType, TOutputImage::PixelType > >
typedef SmartPointer< const SelfConstPointer
 
typedef
SimpleDataObjectDecorator
< Input1ImagePixelType
DecoratedInput1ImagePixelType
 
typedef
SimpleDataObjectDecorator
< Input2ImagePixelType
DecoratedInput2ImagePixelType
 
typedef Functor::MaskInput
< TInputImage::PixelType,
TMaskImage::PixelType,
TOutputImage::PixelType > 
FunctorType
 
typedef Input1ImageType::PixelType Input1ImagePixelType
 
typedef
Input1ImageType::ConstPointer 
Input1ImagePointer
 
typedef Input1ImageType::RegionType Input1ImageRegionType
 
typedef TInputImage Input1ImageType
 
typedef Input2ImageType::PixelType Input2ImagePixelType
 
typedef
Input2ImageType::ConstPointer 
Input2ImagePointer
 
typedef Input2ImageType::RegionType Input2ImageRegionType
 
typedef TMaskImage Input2ImageType
 
typedef OutputImageType::PixelType OutputImagePixelType
 
typedef OutputImageType::Pointer OutputImagePointer
 
typedef OutputImageType::RegionType OutputImageRegionType
 
typedef TOutputImage OutputImageType
 
typedef SmartPointer< SelfPointer
 
typedef BinaryFunctorImageFilter Self
 
typedef InPlaceImageFilter
< TInputImage, TOutputImage > 
Superclass
 
- Public Types inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
typedef SmartPointer< const SelfConstPointer
 
typedef
InputImageType::ConstPointer 
InputImageConstPointer
 
typedef InputImageType::PixelType InputImagePixelType
 
typedef InputImageType::Pointer InputImagePointer
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef TInputImage InputImageType
 
typedef
Superclass::OutputImagePixelType 
OutputImagePixelType
 
typedef
Superclass::OutputImagePointer 
OutputImagePointer
 
typedef
Superclass::OutputImageRegionType 
OutputImageRegionType
 
typedef Superclass::OutputImageType OutputImageType
 
typedef SmartPointer< SelfPointer
 
typedef InPlaceImageFilter Self
 
typedef ImageToImageFilter
< TInputImage, TOutputImage > 
Superclass
 
- Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
typedef SmartPointer< const SelfConstPointer
 
typedef
InputImageType::ConstPointer 
InputImageConstPointer
 
typedef InputImageType::PixelType InputImagePixelType
 
typedef InputImageType::Pointer InputImagePointer
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef TInputImage InputImageType
 
typedef
Superclass::OutputImagePixelType 
OutputImagePixelType
 
typedef
Superclass::OutputImageRegionType 
OutputImageRegionType
 
typedef SmartPointer< SelfPointer
 
typedef ImageToImageFilter Self
 
typedef ImageSource< TOutputImage > Superclass
 
- Public Types inherited from itk::ImageSource< TOutputImage >
typedef SmartPointer< const SelfConstPointer
 
typedef
Superclass::DataObjectIdentifierType 
DataObjectIdentifierType
 
typedef DataObject::Pointer DataObjectPointer
 
typedef
Superclass::DataObjectPointerArraySizeType 
DataObjectPointerArraySizeType
 
typedef OutputImageType::PixelType OutputImagePixelType
 
typedef OutputImageType::Pointer OutputImagePointer
 
typedef OutputImageType::RegionType OutputImageRegionType
 
typedef TOutputImage OutputImageType
 
typedef SmartPointer< SelfPointer
 
typedef ImageSource Self
 
typedef ProcessObject Superclass
 
- Public Types inherited from itk::ProcessObject
typedef SmartPointer< const SelfConstPointer
 
typedef
DataObject::DataObjectIdentifierType 
DataObjectIdentifierType
 
typedef DataObject::Pointer DataObjectPointer
 
typedef std::vector
< DataObjectPointer
DataObjectPointerArray
 
typedef
DataObjectPointerArray::size_type 
DataObjectPointerArraySizeType
 
typedef std::vector
< DataObjectIdentifierType
NameArray
 
typedef SmartPointer< SelfPointer
 
typedef ProcessObject Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

void BeforeThreadedGenerateData ()
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
const TMaskImage::PixelType & GetMaskingValue () const
 
virtual const char * GetNameOfClass () const
 
const TOutputImage::PixelType & GetOutsideValue () const
 
 typedef (Concept::EqualityComparable< typename TMaskImage::PixelType >) MaskEqualityComparableCheck
 
 typedef (Concept::Convertible< typename TInputImage::PixelType, typename TOutputImage::PixelType >) InputConvertibleToOutputCheck
 
void SetMaskImage (const MaskImageType *maskImage)
 
const MaskImageTypeGetMaskImage ()
 
void SetOutsideValue (const typename TOutputImage::PixelType &outsideValue)
 
void SetMaskingValue (const typename TMaskImage::PixelType &maskingValue)
 
- Public Member Functions inherited from itk::BinaryFunctorImageFilter< TInputImage, TMaskImage, TOutputImage, Functor::MaskInput< TInputImage::PixelType, TMaskImage::PixelType, TOutputImage::PixelType > >
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const
Input1ImagePixelType
GetConstant1 () const
 
virtual const
Input2ImagePixelType
GetConstant2 () const
 
FunctorTypeGetFunctor ()
 
const FunctorTypeGetFunctor () const
 
virtual void SetConstant1 (const Input1ImagePixelType &input1)
 
 typedef (Concept::SameDimension< itkGetStaticConstMacro(InputImage1Dimension), itkGetStaticConstMacro(InputImage2Dimension) >) SameDimensionCheck1
 
 typedef (Concept::SameDimension< itkGetStaticConstMacro(InputImage1Dimension), itkGetStaticConstMacro(OutputImageDimension) >) SameDimensionCheck2
 
virtual void SetInput1 (const TInputImage *image1)
 
virtual void SetInput1 (const DecoratedInput1ImagePixelType *input1)
 
virtual void SetInput1 (const Input1ImagePixelType &input1)
 
virtual void SetInput2 (const TMaskImage *image2)
 
virtual void SetInput2 (const DecoratedInput2ImagePixelType *input2)
 
virtual void SetInput2 (const Input2ImagePixelType &input2)
 
virtual void SetConstant2 (const Input2ImagePixelType &input2)
 
void SetConstant (Input2ImagePixelType ct)
 
const Input2ImagePixelTypeGetConstant () const
 
void SetFunctor (const FunctorType &functor)
 
- Public Member Functions inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
virtual bool CanRunInPlace () const
 
virtual void SetInPlace (bool _arg)
 
virtual bool GetInPlace () const
 
virtual void InPlaceOn ()
 
virtual void InPlaceOff ()
 
- Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageTypeGetInput (void) const
 
const InputImageTypeGetInput (unsigned int idx) const
 
virtual void PopBackInput ()
 
virtual void PopFrontInput ()
 
virtual void PushBackInput (const InputImageType *image)
 
virtual void PushFrontInput (const InputImageType *image)
 
virtual void SetInput (const InputImageType *image)
 
virtual void SetInput (unsigned int, const TInputImage *image)
 
virtual void SetCoordinateTolerance (double _arg)
 
virtual double GetCoordinateTolerance () const
 
virtual void SetDirectionTolerance (double _arg)
 
virtual double GetDirectionTolerance () const
 
- Public Member Functions inherited from itk::ImageSource< TOutputImage >
OutputImageTypeGetOutput (unsigned int idx)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *output)
 
virtual void GraftOutput (DataObject *output)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
 
OutputImageTypeGetOutput (void)
 
const OutputImageTypeGetOutput (void) const
 
virtual
ProcessObject::DataObjectPointer 
MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx)
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData ()
 
NameArray GetInputNames () const
 
MultiThreader * GetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual
DataObjectPointerArraySizeType 
GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
virtual const float & GetProgress ()
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
virtual DataObjectPointer MakeOutput (const DataObjectIdentifierType &)
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual void SetProgress (float _arg)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float amount)
 
DataObjectPointerArray GetInputs ()
 
DataObjectPointerArray GetOutputs ()
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
virtual void SetReleaseDataFlag (bool flag)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag ()
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void ReleaseDataBeforeUpdateFlagOff ()
 
virtual void SetNumberOfThreads (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfThreads ()
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary (void)
 
const MetaDataDictionaryGetMetaDataDictionary (void) const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int)
 
virtual void UnRegister () const
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::BinaryFunctorImageFilter< TInputImage, TMaskImage, TOutputImage, Functor::MaskInput< TInputImage::PixelType, TMaskImage::PixelType, TOutputImage::PixelType > >
static Pointer New ()
 

Protected Member Functions

 MaskImageFilter ()
 
void PrintSelf (std::ostream &os, Indent indent) const
 
virtual ~MaskImageFilter ()
 
- Protected Member Functions inherited from itk::BinaryFunctorImageFilter< TInputImage, TMaskImage, TOutputImage, Functor::MaskInput< TInputImage::PixelType, TMaskImage::PixelType, TOutputImage::PixelType > >
 BinaryFunctorImageFilter ()
 
virtual void GenerateOutputInformation ()
 
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
 
virtual ~BinaryFunctorImageFilter ()
 
- Protected Member Functions inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
virtual void AllocateOutputs ()
 
virtual bool GetRunningInPlace () const
 
 InPlaceImageFilter ()
 
virtual void ReleaseInputs ()
 
 ~InPlaceImageFilter ()
 
- Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
virtual void CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
 
virtual void CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
 
virtual void GenerateInputRequestedRegion ()
 
 ImageToImageFilter ()
 
virtual void VerifyInputInformation ()
 
 ~ImageToImageFilter ()
 
void PushBackInput (const DataObject *input)
 
void PushFrontInput (const DataObject *input)
 
- Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void AfterThreadedGenerateData ()
 
virtual void GenerateData ()
 
virtual const
ImageRegionSplitterBase
GetImageRegionSplitter (void) const
 
 ImageSource ()
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int num, OutputImageRegionType &splitRegion)
 
virtual ~ImageSource ()
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
virtual void AddOutput (DataObject *output)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredOutputs ()
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
 itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
 
 itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
 
 itkLegacyMacro (virtual void RemoveInput(DataObject *input))
 
 itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *input)
 
virtual void SetPrimaryOutput (DataObject *output)
 
virtual void VerifyPreconditions ()
 
 ~ProcessObject ()
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName (void) const
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredInputs ()
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
void SetRequiredInputNames (const NameArray &)
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName (void) const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Member Functions

template<class TPixelType >
void CheckOutsideValue (const TPixelType *)
 
template<class TValue >
void CheckOutsideValue (const VariableLengthVector< TValue > *)
 
 MaskImageFilter (const Self &)
 
void operator= (const Self &)
 

Additional Inherited Members

- Static Public Attributes inherited from itk::BinaryFunctorImageFilter< TInputImage, TMaskImage, TOutputImage, Functor::MaskInput< TInputImage::PixelType, TMaskImage::PixelType, TOutputImage::PixelType > >
static const unsigned int InputImage1Dimension
 
static const unsigned int InputImage2Dimension
 
static const unsigned int OutputImageDimension
 
- Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
typedef
ImageToImageFilterDetail::ImageRegionCopier
< itkGetStaticConstMacro(OutputImageDimension),
itkGetStaticConstMacro(InputImageDimension) > 
InputToOutputRegionCopierType
 
typedef
ImageToImageFilterDetail::ImageRegionCopier
< itkGetStaticConstMacro(InputImageDimension),
itkGetStaticConstMacro(OutputImageDimension) > 
OutputToInputRegionCopierType
 
- Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const
ImageRegionSplitterBase
GetGlobalDefaultSplitter ()
 
static ITK_THREAD_RETURN_TYPE ThreaderCallback (void *arg)
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime
 
bool m_Updating
 

Member Typedef Documentation

template<class TInputImage , class TMaskImage , class TOutputImage = TInputImage>
typedef SmartPointer< const Self > itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::ConstPointer

Definition at line 165 of file itkMaskImageFilter.h.

template<class TInputImage , class TMaskImage , class TOutputImage = TInputImage>
typedef TMaskImage itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::MaskImageType

Typedefs

Definition at line 172 of file itkMaskImageFilter.h.

template<class TInputImage , class TMaskImage , class TOutputImage = TInputImage>
typedef SmartPointer< Self > itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::Pointer

Definition at line 164 of file itkMaskImageFilter.h.

template<class TInputImage , class TMaskImage , class TOutputImage = TInputImage>
typedef MaskImageFilter itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::Self

Standard class typedefs.

Definition at line 156 of file itkMaskImageFilter.h.

template<class TInputImage , class TMaskImage , class TOutputImage = TInputImage>
typedef BinaryFunctorImageFilter< TInputImage, TMaskImage, TOutputImage, Functor::MaskInput< typename TInputImage::PixelType, typename TMaskImage::PixelType, typename TOutputImage::PixelType > > itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::Superclass

Definition at line 162 of file itkMaskImageFilter.h.

Constructor & Destructor Documentation

template<class TInputImage , class TMaskImage , class TOutputImage = TInputImage>
itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::MaskImageFilter ( )
inlineprotected

End concept checking

Definition at line 243 of file itkMaskImageFilter.h.

template<class TInputImage , class TMaskImage , class TOutputImage = TInputImage>
virtual itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::~MaskImageFilter ( )
inlineprotectedvirtual

Definition at line 244 of file itkMaskImageFilter.h.

template<class TInputImage , class TMaskImage , class TOutputImage = TInputImage>
itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::MaskImageFilter ( const Self )
private

Member Function Documentation

template<class TInputImage , class TMaskImage , class TOutputImage = TInputImage>
void itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::BeforeThreadedGenerateData ( void  )
inlinevirtual

If an imaging filter needs to perform processing after the buffer has been allocated but before threads are spawned, the filter can can provide an implementation for BeforeThreadedGenerateData(). The execution flow in the default GenerateData() method will be: 1) Allocate the output buffer 2) Call BeforeThreadedGenerateData() 3) Spawn threads, calling ThreadedGenerateData() in each thread. 4) Call AfterThreadedGenerateData() Note that this flow of control is only available if a filter provides a ThreadedGenerateData() method and NOT a GenerateData() method.

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 225 of file itkMaskImageFilter.h.

References NULL.

template<class TInputImage , class TMaskImage , class TOutputImage = TInputImage>
template<class TPixelType >
void itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::CheckOutsideValue ( const TPixelType *  )
inlineprivate

Definition at line 257 of file itkMaskImageFilter.h.

template<class TInputImage , class TMaskImage , class TOutputImage = TInputImage>
template<class TValue >
void itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::CheckOutsideValue ( const VariableLengthVector< TValue > *  )
inlineprivate
template<class TInputImage , class TMaskImage , class TOutputImage = TInputImage>
virtual::itk::LightObject::Pointer itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::CreateAnother ( void  ) const
virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

template<class TInputImage , class TMaskImage , class TOutputImage = TInputImage>
const MaskImageType* itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::GetMaskImage ( )
inline

Set/Get the mask image. Pixels set in the mask image will retain the original value of the input image while pixels not set in the mask will be set to the "OutsideValue".

Definition at line 186 of file itkMaskImageFilter.h.

References itk::ProcessObject::GetInput().

template<class TInputImage , class TMaskImage , class TOutputImage = TInputImage>
const TMaskImage::PixelType& itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::GetMaskingValue ( ) const
inline

Method to get the masking value of the mask.

Definition at line 220 of file itkMaskImageFilter.h.

template<class TInputImage , class TMaskImage , class TOutputImage = TInputImage>
virtual const char* itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::GetNameOfClass ( ) const
virtual
template<class TInputImage , class TMaskImage , class TOutputImage = TInputImage>
const TOutputImage::PixelType& itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::GetOutsideValue ( ) const
inline

Definition at line 203 of file itkMaskImageFilter.h.

template<class TInputImage , class TMaskImage , class TOutputImage = TInputImage>
static Pointer itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::New ( )
static

Method for creation through the object factory.

template<class TInputImage , class TMaskImage , class TOutputImage = TInputImage>
void itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::operator= ( const Self )
private
template<class TInputImage , class TMaskImage , class TOutputImage = TInputImage>
void itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
inlineprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::InPlaceImageFilter< TInputImage, TOutputImage >.

Definition at line 246 of file itkMaskImageFilter.h.

template<class TInputImage , class TMaskImage , class TOutputImage = TInputImage>
void itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::SetMaskImage ( const MaskImageType maskImage)
inline

Set/Get the mask image. Pixels set in the mask image will retain the original value of the input image while pixels not set in the mask will be set to the "OutsideValue".

Definition at line 181 of file itkMaskImageFilter.h.

template<class TInputImage , class TMaskImage , class TOutputImage = TInputImage>
void itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::SetMaskingValue ( const typename TMaskImage::PixelType &  maskingValue)
inline

Method to explicitly set the masking value of the mask. Defaults to 0

Definition at line 209 of file itkMaskImageFilter.h.

References itk::GetMaskingValue().

template<class TInputImage , class TMaskImage , class TOutputImage = TInputImage>
void itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::SetOutsideValue ( const typename TOutputImage::PixelType &  outsideValue)
inline

Method to explicitly set the outside value of the mask. Defaults to 0

Definition at line 193 of file itkMaskImageFilter.h.

template<class TInputImage , class TMaskImage , class TOutputImage = TInputImage>
itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::typedef ( Concept::EqualityComparable< typename TMaskImage::PixelType >  )

Begin concept checking This class requires MaskEqualityComparableCheck in the form of ( Concept::EqualityComparable< typename TMaskImage::PixelType > )

template<class TInputImage , class TMaskImage , class TOutputImage = TInputImage>
itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::typedef ( Concept::Convertible< typename TInputImage::PixelType, typename TOutputImage::PixelType >  )

This class requires InputConvertibleToOutputCheck in the form of ( Concept::Convertible< typename TInputImage::PixelType, typename TOutputImage::PixelType > )


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