ITK  4.2.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes
itk::BinaryNotImageFilter< TImage > Class Template Reference

#include <itkBinaryNotImageFilter.h>

+ Inheritance diagram for itk::BinaryNotImageFilter< TImage >:
+ Collaboration diagram for itk::BinaryNotImageFilter< TImage >:

List of all members.

Public Types

typedef SmartPointer< const SelfConstPointer
typedef TImage::PixelType PixelType
typedef SmartPointer< SelfPointer
typedef BinaryNotImageFilter Self
typedef
UnaryFunctorImageFilter
< TImage, TImage,
Functor::BinaryNot< typename
TImage::PixelType > > 
Superclass
- Public Types inherited from itk::UnaryFunctorImageFilter< TImage, TImage, Functor::BinaryNot< TImage::PixelType > >
typedef Functor::BinaryNot
< TImage::PixelType > 
FunctorType
typedef InputImageType::PixelType InputImagePixelType
typedef
InputImageType::ConstPointer 
InputImagePointer
typedef InputImageType::RegionType InputImageRegionType
typedef TImage InputImageType
typedef OutputImageType::PixelType OutputImagePixelType
typedef OutputImageType::Pointer OutputImagePointer
typedef OutputImageType::RegionType OutputImageRegionType
typedef TImage OutputImageType
- Public Types inherited from itk::InPlaceImageFilter< TImage, TImage >
typedef
InputImageType::ConstPointer 
InputImageConstPointer
- Public Types inherited from itk::ImageToImageFilter< TImage, TImage >
- Public Types inherited from itk::ImageSource< TImage >
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
virtual PixelType GetBackgroundValue () const
virtual const char * GetNameOfClass () const
virtual void SetBackgroundValue (PixelType _arg)
virtual void SetForegroundValue (PixelType _arg)
virtual PixelType GetForegroundValue () const
- Public Member Functions inherited from itk::UnaryFunctorImageFilter< TImage, TImage, Functor::BinaryNot< TImage::PixelType > >
FunctorTypeGetFunctor ()
const FunctorTypeGetFunctor () const
void SetFunctor (const FunctorType &functor)
- Public Member Functions inherited from itk::InPlaceImageFilter< TImage, TImage >
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< TImage, TImage >
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 TImage *image)
- Public Member Functions inherited from itk::ImageSource< TImage >
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

 BinaryNotImageFilter ()
void GenerateData ()
void PrintSelf (std::ostream &os, Indent indent) const
virtual ~BinaryNotImageFilter ()
- Protected Member Functions inherited from itk::UnaryFunctorImageFilter< TImage, TImage, Functor::BinaryNot< TImage::PixelType > >
virtual void GenerateOutputInformation ()
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
 UnaryFunctorImageFilter ()
virtual ~UnaryFunctorImageFilter ()
- Protected Member Functions inherited from itk::InPlaceImageFilter< TImage, TImage >
virtual void AllocateOutputs ()
virtual bool GetRunningInPlace () const
 InPlaceImageFilter ()
virtual void ReleaseInputs ()
 ~InPlaceImageFilter ()
- Protected Member Functions inherited from itk::ImageToImageFilter< TImage, TImage >
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< TImage >
virtual void AfterThreadedGenerateData ()
virtual void BeforeThreadedGenerateData ()
 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

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

Private Attributes

PixelType m_BackgroundValue
PixelType m_ForegroundValue

Detailed Description

template<class TImage>
class itk::BinaryNotImageFilter< TImage >

Implements the BinaryNot logical operator pixel-wise between two images.

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

The total operation over one pixel will be

output_pixel = static_cast<PixelType>( input1_pixel != input2_pixel )

Where "!=" is the equality operator in C++.

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: http://hdl.handle.net/1926/584 or http://www.insight-journal.org/browse/publication/176

Wiki Examples:

Definition at line 86 of file itkBinaryNotImageFilter.h.


Member Typedef Documentation

template<class TImage >
typedef SmartPointer<const Self> itk::BinaryNotImageFilter< TImage >::ConstPointer
template<class TImage >
typedef TImage::PixelType itk::BinaryNotImageFilter< TImage >::PixelType

Definition at line 106 of file itkBinaryNotImageFilter.h.

template<class TImage >
typedef SmartPointer<Self> itk::BinaryNotImageFilter< TImage >::Pointer
template<class TImage >
typedef BinaryNotImageFilter itk::BinaryNotImageFilter< TImage >::Self

Standard class typedefs.

Reimplemented from itk::UnaryFunctorImageFilter< TImage, TImage, Functor::BinaryNot< TImage::PixelType > >.

Definition at line 95 of file itkBinaryNotImageFilter.h.

template<class TImage >
typedef UnaryFunctorImageFilter<TImage, TImage, Functor::BinaryNot< typename TImage::PixelType> > itk::BinaryNotImageFilter< TImage >::Superclass

Constructor & Destructor Documentation

template<class TImage >
itk::BinaryNotImageFilter< TImage >::BinaryNotImageFilter ( )
inlineprotected

Definition at line 126 of file itkBinaryNotImageFilter.h.

template<class TImage >
virtual itk::BinaryNotImageFilter< TImage >::~BinaryNotImageFilter ( )
inlineprotectedvirtual

Definition at line 131 of file itkBinaryNotImageFilter.h.

template<class TImage >
itk::BinaryNotImageFilter< TImage >::BinaryNotImageFilter ( const Self )
private

Member Function Documentation

template<class TImage >
virtual::itk::LightObject::Pointer itk::BinaryNotImageFilter< TImage >::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::UnaryFunctorImageFilter< TImage, TImage, Functor::BinaryNot< TImage::PixelType > >.

template<class TImage >
void itk::BinaryNotImageFilter< TImage >::GenerateData ( void  )
inlineprotectedvirtual

A version of GenerateData() specific for image processing filters. This implementation will split the processing across multiple threads. The buffer is allocated by this method. Then the BeforeThreadedGenerateData() method is called (if provided). Then, a series of threads are spawned each calling ThreadedGenerateData(). After all the threads have completed processing, the AfterThreadedGenerateData() method is called (if provided). If an image processing filter cannot be threaded, the filter should provide an implementation of GenerateData(). That implementation is responsible for allocating the output buffer. If a filter an be threaded, it should NOT provide a GenerateData() method but should provide a ThreadedGenerateData() instead.

See also:
ThreadedGenerateData()

Reimplemented from itk::ImageSource< TImage >.

Definition at line 149 of file itkBinaryNotImageFilter.h.

template<class TImage >
virtual PixelType itk::BinaryNotImageFilter< TImage >::GetBackgroundValue ( ) const
virtual

Get the value used as "background". Defaults to NumericTraits<PixelType>::NonpositiveMin().

template<class TImage >
virtual PixelType itk::BinaryNotImageFilter< TImage >::GetForegroundValue ( ) const
virtual

Set/Get the value in the image considered as "foreground". Defaults to maximum value of PixelType.

template<class TImage >
virtual const char* itk::BinaryNotImageFilter< TImage >::GetNameOfClass ( ) const
virtual
template<class TImage >
static Pointer itk::BinaryNotImageFilter< TImage >::New ( )
static

Method for creation through the object factory.

Reimplemented from itk::UnaryFunctorImageFilter< TImage, TImage, Functor::BinaryNot< TImage::PixelType > >.

template<class TImage >
void itk::BinaryNotImageFilter< TImage >::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::UnaryFunctorImageFilter< TImage, TImage, Functor::BinaryNot< TImage::PixelType > >.

template<class TImage >
void itk::BinaryNotImageFilter< TImage >::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< TImage, TImage >.

Definition at line 133 of file itkBinaryNotImageFilter.h.

template<class TImage >
virtual void itk::BinaryNotImageFilter< TImage >::SetBackgroundValue ( PixelType  _arg)
virtual

Set the value used as "background". Defaults to NumericTraits<PixelType>::NonpositiveMin().

template<class TImage >
virtual void itk::BinaryNotImageFilter< TImage >::SetForegroundValue ( PixelType  _arg)
virtual

Set/Get the value in the image considered as "foreground". Defaults to maximum value of PixelType.


Member Data Documentation

template<class TImage >
PixelType itk::BinaryNotImageFilter< TImage >::m_BackgroundValue
private

Definition at line 161 of file itkBinaryNotImageFilter.h.

template<class TImage >
PixelType itk::BinaryNotImageFilter< TImage >::m_ForegroundValue
private

Definition at line 160 of file itkBinaryNotImageFilter.h.


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