ITK  4.2.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions
itk::MaskNegatedImageFilter< TInputImage, TMaskImage, TOutputImage > Class Template Reference

#include <itkMaskNegatedImageFilter.h>

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

List of all members.

Public Types

typedef SmartPointer< const SelfConstPointer
typedef TMaskImage MaskImageType
typedef SmartPointer< SelfPointer
typedef MaskNegatedImageFilter Self
typedef
BinaryFunctorImageFilter
< TInputImage, TMaskImage,
TOutputImage,
Functor::MaskNegatedInput
< typename
TInputImage::PixelType,
typename TMaskImage::PixelType,
typename
TOutputImage::PixelType > > 
Superclass
- Public Types inherited from itk::BinaryFunctorImageFilter< TInputImage, TMaskImage, TOutputImage, Functor::MaskNegatedInput< TInputImage::PixelType, TMaskImage::PixelType, TOutputImage::PixelType > >
typedef
SimpleDataObjectDecorator
< Input1ImagePixelType
DecoratedInput1ImagePixelType
typedef
SimpleDataObjectDecorator
< Input2ImagePixelType
DecoratedInput2ImagePixelType
typedef
Functor::MaskNegatedInput
< 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
- Public Types inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
typedef
InputImageType::ConstPointer 
InputImageConstPointer
typedef InputImageType::PixelType InputImagePixelType
typedef InputImageType::Pointer InputImagePointer
typedef InputImageType::RegionType InputImageRegionType
typedef TInputImage InputImageType
- Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
- Public Types inherited from itk::ImageSource< TOutputImage >
typedef
Superclass::DataObjectIdentifierType 
DataObjectIdentifierType
typedef DataObject::Pointer DataObjectPointer
typedef
Superclass::DataObjectPointerArraySizeType 
DataObjectPointerArraySizeType
- Public Types inherited from itk::ProcessObject
typedef std::vector
< DataObjectPointer
DataObjectPointerArray
typedef std::vector
< DataObjectIdentifierType
NameArray
- Public Types inherited from itk::Object
- Public Types inherited from itk::LightObject

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
const MaskImageTypeGetMaskImage ()
virtual const char * GetNameOfClass () const
const TOutputImage::PixelType & GetOutsideValue () const
void SetMaskImage (const MaskImageType *maskImage)
 typedef (Concept::EqualityComparable< typename TMaskImage::PixelType >) MaskEqualityComparableCheck
 typedef (Concept::Convertible< typename TInputImage::PixelType, typename TOutputImage::PixelType >) InputConvertibleToOutputCheck
void SetOutsideValue (const typename TOutputImage::PixelType &outsideValue)
- Public Member Functions inherited from itk::BinaryFunctorImageFilter< TInputImage, TMaskImage, TOutputImage, Functor::MaskNegatedInput< TInputImage::PixelType, TMaskImage::PixelType, TOutputImage::PixelType > >
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)
- 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 unsigned long 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 ()

Protected Member Functions

void PrintSelf (std::ostream &os, Indent indent) const
 MaskNegatedImageFilter ()
virtual ~MaskNegatedImageFilter ()
- Protected Member Functions inherited from itk::BinaryFunctorImageFilter< TInputImage, TMaskImage, TOutputImage, Functor::MaskNegatedInput< 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 BeforeThreadedGenerateData ()
virtual void GenerateData ()
 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)
bool AddRequiredInputName (const DataObjectIdentifierType &)
virtual void CacheInputReleaseDataFlags ()
virtual void GenerateOutputRequestedRegion (DataObject *output)
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredInputs ()
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredOutputs ()
bool IsIndexedName (const DataObjectIdentifierType &) const
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 itkLegacyMacro (virtual void RemoveInput(DataObject *input))
 itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
 itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
 itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
DataObjectPointerArraySizeType MakeIndexFromName (const DataObjectIdentifierType &) const
DataObjectIdentifierType MakeNameFromIndex (DataObjectPointerArraySizeType) 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)
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
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 SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
virtual void SetPrimaryInput (DataObject *input)
virtual void SetPrimaryOutput (DataObject *output)
void SetRequiredInputNames (const NameArray &)
virtual void VerifyPreconditions ()
 ~ProcessObject ()
DataObjectGetInput (const DataObjectIdentifierType &key)
const DataObjectGetInput (const DataObjectIdentifierType &key) const
DataObjectGetInput (DataObjectPointerArraySizeType)
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
DataObjectGetPrimaryInput ()
const DataObjectGetPrimaryInput () const
DataObjectGetOutput (const DataObjectIdentifierType &key)
const DataObjectGetOutput (const DataObjectIdentifierType &key) 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

 MaskNegatedImageFilter (const Self &)
void operator= (const Self &)

Additional Inherited Members

- Static Public Attributes inherited from itk::BinaryFunctorImageFilter< TInputImage, TMaskImage, TOutputImage, Functor::MaskNegatedInput< TInputImage::PixelType, TMaskImage::PixelType, TOutputImage::PixelType > >
static const unsigned int InputImage1Dimension
static const unsigned int InputImage2Dimension
static const unsigned int OutputImageDimension
- Static Public Attributes inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
static const unsigned int InputImageDimension = TInputImage::ImageDimension
- Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
- Static Public Attributes inherited from itk::ImageSource< TOutputImage >

Detailed Description

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

Mask an image with the negative of 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 != 0
pixel_output_image = output_value
else
pixel_output_image = pixel_input_image

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 0 will not be masked out.
See also:
MaskImageFilter
Wiki Examples:

Definition at line 113 of file itkMaskNegatedImageFilter.h.


Member Typedef Documentation

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

Typedefs

Definition at line 140 of file itkMaskNegatedImageFilter.h.

template<class TInputImage , class TMaskImage , class TOutputImage = TInputImage>
typedef SmartPointer< Self > itk::MaskNegatedImageFilter< TInputImage, TMaskImage, TOutputImage >::Pointer
template<class TInputImage , class TMaskImage , class TOutputImage = TInputImage>
typedef MaskNegatedImageFilter itk::MaskNegatedImageFilter< TInputImage, TMaskImage, TOutputImage >::Self
template<class TInputImage , class TMaskImage , class TOutputImage = TInputImage>
typedef BinaryFunctorImageFilter< TInputImage, TMaskImage, TOutputImage, Functor::MaskNegatedInput< typename TInputImage::PixelType, typename TMaskImage::PixelType, typename TOutputImage::PixelType > > itk::MaskNegatedImageFilter< TInputImage, TMaskImage, TOutputImage >::Superclass

Constructor & Destructor Documentation

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

End concept checking

Definition at line 187 of file itkMaskNegatedImageFilter.h.

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

End concept checking

Definition at line 188 of file itkMaskNegatedImageFilter.h.

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

Member Function Documentation

template<class TInputImage , class TMaskImage , class TOutputImage = TInputImage>
virtual::itk::LightObject::Pointer itk::MaskNegatedImageFilter< 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::BinaryFunctorImageFilter< TInputImage, TMaskImage, TOutputImage, Functor::MaskNegatedInput< TInputImage::PixelType, TMaskImage::PixelType, TOutputImage::PixelType > >.

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

Definition at line 171 of file itkMaskNegatedImageFilter.h.

References itk::ProcessObject::GetInput().

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

Definition at line 156 of file itkMaskNegatedImageFilter.h.

template<class TInputImage , class TMaskImage , class TOutputImage = TInputImage>
static Pointer itk::MaskNegatedImageFilter< TInputImage, TMaskImage, TOutputImage >::New ( )
static
template<class TInputImage , class TMaskImage , class TOutputImage = TInputImage>
void itk::MaskNegatedImageFilter< TInputImage, TMaskImage, TOutputImage >::operator= ( const Self )
private

PushBackInput(), PushFronInput() in the public section force the input to be the type expected by an ImageToImageFilter. However, these methods end of "hiding" the versions from the superclass (ProcessObject) whose arguments are DataObjects. Here, we re-expose the versions from ProcessObject to avoid warnings about hiding methods from the superclass.

Reimplemented from itk::BinaryFunctorImageFilter< TInputImage, TMaskImage, TOutputImage, Functor::MaskNegatedInput< TInputImage::PixelType, TMaskImage::PixelType, TOutputImage::PixelType > >.

template<class TInputImage , class TMaskImage , class TOutputImage = TInputImage>
void itk::MaskNegatedImageFilter< 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 191 of file itkMaskNegatedImageFilter.h.

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

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

Definition at line 165 of file itkMaskNegatedImageFilter.h.

template<class TInputImage , class TMaskImage , class TOutputImage = TInputImage>
void itk::MaskNegatedImageFilter< 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 146 of file itkMaskNegatedImageFilter.h.

template<class TInputImage , class TMaskImage , class TOutputImage = TInputImage>
itk::MaskNegatedImageFilter< 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::MaskNegatedImageFilter< 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: