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::TwoOutputExampleImageFilter< TImage > Class Template Reference

#include <itkTwoOutputExampleImageFilter.h>

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

List of all members.

Public Types

typedef SmartPointer< const SelfConstPointer
typedef
Superclass::InputImageConstPointer 
InputImageConstPointer
typedef OutputImageType::PixelType OutputImagePixelType
typedef OutputImageType::Pointer OutputImagePointer
typedef OutputImageType::RegionType OutputImageRegionType
typedef TImage OutputImageType
typedef TImage::PixelType PixelType
typedef SmartPointer< SelfPointer
typedef TwoOutputExampleImageFilter Self
typedef ImageToImageFilter
< TImage, TImage > 
Superclass
- Public Types inherited from itk::ImageToImageFilter< TImage, TImage >
typedef InputImageType::PixelType InputImagePixelType
typedef InputImageType::Pointer InputImagePointer
typedef InputImageType::RegionType InputImageRegionType
typedef TImage InputImageType
- 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
OutputImagePointer GetInverseOutput ()
virtual const char * GetNameOfClass () const
virtual PixelType GetOutsideValue () const
void SetInverseOutput (OutputImageType *output)
virtual void SetOutsideValue (PixelType _arg)
void ThresholdAbove (PixelType &thresh)
void ThresholdBelow (PixelType &thresh)
void ThresholdOutside (PixelType &lower, PixelType &upper)
 typedef (Concept::Comparable< PixelType >) ComparableCheck
 typedef (Concept::OStreamWritable< PixelType >) OStreamWritableCheck
- 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

void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
 TwoOutputExampleImageFilter ()
 ~TwoOutputExampleImageFilter ()
void PrintSelf (std::ostream &os, Indent indent) const
- 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 AllocateOutputs ()
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 GenerateOutputInformation ()
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 ReleaseInputs ()
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

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

Private Attributes

PixelType m_Lower
PixelType m_OutsideValue
PixelType m_Upper

Additional Inherited Members

- Static Public Attributes inherited from itk::ImageToImageFilter< TImage, TImage >
static const unsigned int InputImageDimension
static const unsigned int OutputImageDimension
- Static Public Attributes inherited from itk::ImageSource< TImage >
- Protected Types inherited from itk::ImageToImageFilter< TImage, TImage >
typedef
ImageToImageFilterDetail::ImageRegionCopier
< itkGetStaticConstMacro(OutputImageDimension),
itkGetStaticConstMacro(InputImageDimension) > 
InputToOutputRegionCopierType
typedef
ImageToImageFilterDetail::ImageRegionCopier
< itkGetStaticConstMacro(InputImageDimension),
itkGetStaticConstMacro(OutputImageDimension) > 
OutputToInputRegionCopierType

Detailed Description

template<class TImage>
class itk::TwoOutputExampleImageFilter< TImage >

Example of a filter that produce two outputs.

TwoOutputExampleImageFilter sets image values to a user-specified "outside" value (by default, "black") if the image values are below, above, or between simple threshold values. The filter can produce two outputs, one the inverse of the other. (GetOutput() returns an image whose pixels satisfy the threshold values and are passed to the output unchanged (and those that don't are marked with the outside user-value); GetInverseOutput() returns an image in which pixels satisfying the threshold are marked "outside", and the other pixel values are passed through.)

The pixels must support the operators >= and <=.

Definition at line 44 of file itkTwoOutputExampleImageFilter.h.


Member Typedef Documentation

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

Reimplemented from itk::ImageToImageFilter< TImage, TImage >.

Definition at line 52 of file itkTwoOutputExampleImageFilter.h.

template<class TImage >
typedef Superclass::InputImageConstPointer itk::TwoOutputExampleImageFilter< TImage >::InputImageConstPointer

Reimplemented from itk::ImageToImageFilter< TImage, TImage >.

Definition at line 79 of file itkTwoOutputExampleImageFilter.h.

template<class TImage >
typedef OutputImageType::PixelType itk::TwoOutputExampleImageFilter< TImage >::OutputImagePixelType

Reimplemented from itk::ImageToImageFilter< TImage, TImage >.

Definition at line 85 of file itkTwoOutputExampleImageFilter.h.

template<class TImage >
typedef OutputImageType::Pointer itk::TwoOutputExampleImageFilter< TImage >::OutputImagePointer

Reimplemented from itk::ImageSource< TImage >.

Definition at line 83 of file itkTwoOutputExampleImageFilter.h.

template<class TImage >
typedef OutputImageType::RegionType itk::TwoOutputExampleImageFilter< TImage >::OutputImageRegionType

Superclass typedefs.

Reimplemented from itk::ImageToImageFilter< TImage, TImage >.

Definition at line 84 of file itkTwoOutputExampleImageFilter.h.

template<class TImage >
typedef TImage itk::TwoOutputExampleImageFilter< TImage >::OutputImageType

Some typedefs to handle the second output.

Reimplemented from itk::ImageSource< TImage >.

Definition at line 82 of file itkTwoOutputExampleImageFilter.h.

template<class TImage >
typedef TImage::PixelType itk::TwoOutputExampleImageFilter< TImage >::PixelType

Typedef to describe the type of pixel.

Definition at line 55 of file itkTwoOutputExampleImageFilter.h.

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

Reimplemented from itk::ImageToImageFilter< TImage, TImage >.

Definition at line 51 of file itkTwoOutputExampleImageFilter.h.

Standard class typedefs.

Reimplemented from itk::ImageToImageFilter< TImage, TImage >.

Definition at line 49 of file itkTwoOutputExampleImageFilter.h.

template<class TImage >
typedef ImageToImageFilter< TImage, TImage > itk::TwoOutputExampleImageFilter< TImage >::Superclass

Reimplemented from itk::ImageToImageFilter< TImage, TImage >.

Definition at line 50 of file itkTwoOutputExampleImageFilter.h.


Constructor & Destructor Documentation

template<class TImage >
itk::TwoOutputExampleImageFilter< TImage >::TwoOutputExampleImageFilter ( )
protected

Begin concept checking

template<class TImage >
itk::TwoOutputExampleImageFilter< TImage >::~TwoOutputExampleImageFilter ( )
inlineprotected

Begin concept checking

Definition at line 106 of file itkTwoOutputExampleImageFilter.h.

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

Member Function Documentation

template<class TImage >
virtual::itk::LightObject::Pointer itk::TwoOutputExampleImageFilter< 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::Object.

template<class TImage >
OutputImagePointer itk::TwoOutputExampleImageFilter< TImage >::GetInverseOutput ( )
inline

Get the image output of this process object.

Definition at line 88 of file itkTwoOutputExampleImageFilter.h.

References itk::ProcessObject::GetOutput().

template<class TImage >
virtual const char* itk::TwoOutputExampleImageFilter< TImage >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageToImageFilter< TImage, TImage >.

template<class TImage >
virtual PixelType itk::TwoOutputExampleImageFilter< TImage >::GetOutsideValue ( ) const
virtual

Get the "outside" pixel value.

template<class TImage >
static Pointer itk::TwoOutputExampleImageFilter< TImage >::New ( )
static

Method for creation through the object factory.

Reimplemented from itk::Object.

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

template<class TImage >
void itk::TwoOutputExampleImageFilter< TImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
protectedvirtual

Begin concept checking

Reimplemented from itk::ImageToImageFilter< TImage, TImage >.

template<class TImage >
void itk::TwoOutputExampleImageFilter< TImage >::SetInverseOutput ( OutputImageType output)
inline

Set the image output of this process object.

Definition at line 92 of file itkTwoOutputExampleImageFilter.h.

template<class TImage >
virtual void itk::TwoOutputExampleImageFilter< TImage >::SetOutsideValue ( PixelType  _arg)
virtual

Set the "outside" pixel value. The default value NumericTraits<PixelType>::Zero.

template<class TImage >
void itk::TwoOutputExampleImageFilter< TImage >::ThreadedGenerateData ( const OutputImageRegionType outputRegionForThread,
ThreadIdType  threadId 
)
protectedvirtual

TwoOutputExampleImageFilter can be implemented as a multithreaded filter. Therefore, this implementation provides a ThreadedGenerateData() routine which is called for each processing thread. The output image data is allocated automatically by the superclass prior to calling ThreadedGenerateData(). ThreadedGenerateData can only write to the portion of the output image specified by the parameter "outputRegionForThread"

See also:
ImageToImageFilter::ThreadedGenerateData(), ImageToImageFilter::GenerateData()

Reimplemented from itk::ImageSource< TImage >.

template<class TImage >
void itk::TwoOutputExampleImageFilter< TImage >::ThresholdAbove ( PixelType thresh)

The values greater than or equal to the value are set to OutsideValue.

template<class TImage >
void itk::TwoOutputExampleImageFilter< TImage >::ThresholdBelow ( PixelType thresh)

The values less than or equal to the value are set to OutsideValue.

template<class TImage >
void itk::TwoOutputExampleImageFilter< TImage >::ThresholdOutside ( PixelType lower,
PixelType upper 
)

The values outside the range are set to OutsideValue.

template<class TImage >
itk::TwoOutputExampleImageFilter< TImage >::typedef ( Concept::Comparable< PixelType )

Begin concept checking This class requires ComparableCheck in the form of ( Concept::Comparable< PixelType > )

template<class TImage >
itk::TwoOutputExampleImageFilter< TImage >::typedef ( Concept::OStreamWritable< PixelType )

This class requires OStreamWritableCheck in the form of ( Concept::OStreamWritable< PixelType > )


Member Data Documentation

template<class TImage >
PixelType itk::TwoOutputExampleImageFilter< TImage >::m_Lower
private

Definition at line 128 of file itkTwoOutputExampleImageFilter.h.

template<class TImage >
PixelType itk::TwoOutputExampleImageFilter< TImage >::m_OutsideValue
private

Definition at line 127 of file itkTwoOutputExampleImageFilter.h.

template<class TImage >
PixelType itk::TwoOutputExampleImageFilter< TImage >::m_Upper
private

Definition at line 129 of file itkTwoOutputExampleImageFilter.h.


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