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

#include <itkMovingHistogramImageFilter.h>

+ Inheritance diagram for itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >:
+ Collaboration diagram for itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >:

List of all members.

Public Types

typedef SmartPointer< const SelfConstPointer
typedef TInputImage::IndexType IndexType
typedef TInputImage InputImageType
typedef KernelType::ConstIterator KernelIteratorType
typedef TKernel KernelType
typedef std::list< OffsetTypeOffsetListType
typedef std::map< OffsetType,
OffsetListType, typename
OffsetType::LexicographicCompare > 
OffsetMapType
typedef TInputImage::OffsetType OffsetType
typedef
Superclass::OutputImageRegionType 
OutputImageRegionType
typedef TOutputImage OutputImageType
typedef TOutputImage::PixelType OutputPixelType
typedef TInputImage::PixelType PixelType
typedef SmartPointer< SelfPointer
typedef KernelType::SizeType RadiusType
typedef TInputImage::RegionType RegionType
typedef MovingHistogramImageFilter Self
typedef TInputImage::SizeType SizeType
typedef
MovingHistogramImageFilterBase
< TInputImage, TOutputImage,
TKernel > 
Superclass
- Public Types inherited from itk::MovingHistogramImageFilterBase< TInputImage, TOutputImage, TKernel >
- Public Types inherited from itk::KernelImageFilter< TInputImage, TOutputImage, TKernel >
typedef FlatStructuringElement
< itkGetStaticConstMacro(ImageDimension) > 
FlatKernelType
typedef TInputImage::PixelType InputPixelType
- Public Types inherited from itk::BoxImageFilter< TInputImage, TOutputImage >
typedef TInputImage::SizeValueType RadiusValueType
- Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
typedef
InputImageType::ConstPointer 
InputImageConstPointer
typedef InputImageType::PixelType InputImagePixelType
typedef InputImageType::Pointer InputImagePointer
typedef InputImageType::RegionType InputImageRegionType
typedef
Superclass::OutputImagePixelType 
OutputImagePixelType
- Public Types inherited from itk::ImageSource< TOutputImage >
typedef
Superclass::DataObjectIdentifierType 
DataObjectIdentifierType
typedef DataObject::Pointer DataObjectPointer
typedef
Superclass::DataObjectPointerArraySizeType 
DataObjectPointerArraySizeType
typedef OutputImageType::Pointer OutputImagePointer
- 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 void ConfigureHistogram (THistogram &)
virtual ::itk::LightObject::Pointer CreateAnother (void) const
virtual const char * GetNameOfClass () const
- Public Member Functions inherited from itk::MovingHistogramImageFilterBase< TInputImage, TOutputImage, TKernel >
virtual SizeValueType GetPixelsPerTranslation () const
void SetKernel (const KernelType &kernel)
- Public Member Functions inherited from itk::KernelImageFilter< TInputImage, TOutputImage, TKernel >
virtual const KernelTypeGetKernel ()
virtual void SetRadius (const RadiusType &radius)
virtual void SetRadius (const SizeValueType &radius)
- Public Member Functions inherited from itk::BoxImageFilter< TInputImage, TOutputImage >
void GenerateInputRequestedRegion ()
virtual const RadiusTypeGetRadius ()
virtual void SetRadius (const RadiusValueType &radius)
- 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 ()

Static Public Attributes

static const unsigned int ImageDimension = TInputImage::ImageDimension
- Static Public Attributes inherited from itk::MovingHistogramImageFilterBase< TInputImage, TOutputImage, TKernel >
- Static Public Attributes inherited from itk::KernelImageFilter< TInputImage, TOutputImage, TKernel >
- Static Public Attributes inherited from itk::BoxImageFilter< TInputImage, TOutputImage >
- Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static const unsigned int InputImageDimension = TInputImage::ImageDimension
static const unsigned int OutputImageDimension = TOutputImage::ImageDimension
- Static Public Attributes inherited from itk::ImageSource< TOutputImage >

Protected Types

typedef THistogram HistogramType

Protected Member Functions

 MovingHistogramImageFilter ()
void PushHistogram (HistogramType &histogram, const OffsetListType *addedList, const OffsetListType *removedList, const RegionType &inputRegion, const RegionType &kernRegion, const InputImageType *inputImage, const IndexType currentIdx)
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
 ~MovingHistogramImageFilter ()
- Protected Member Functions inherited from itk::MovingHistogramImageFilterBase< TInputImage, TOutputImage, TKernel >
void GetDirAndOffset (const IndexType LineStart, const IndexType PrevLineStart, OffsetType &LineOffset, OffsetType &Changes, int &LineDirection)
 MovingHistogramImageFilterBase ()
void PrintSelf (std::ostream &os, Indent indent) const
 ~MovingHistogramImageFilterBase ()
- Protected Member Functions inherited from itk::KernelImageFilter< TInputImage, TOutputImage, TKernel >
 KernelImageFilter ()
 ~KernelImageFilter ()
- Protected Member Functions inherited from itk::BoxImageFilter< TInputImage, TOutputImage >
 BoxImageFilter ()
 ~BoxImageFilter ()
- 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)
 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 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

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

Additional Inherited Members

- Protected Attributes inherited from itk::MovingHistogramImageFilterBase< TInputImage, TOutputImage, TKernel >
OffsetMapType m_AddedOffsets
FixedArray< int,
itkGetStaticConstMacro(ImageDimension) > 
m_Axes
OffsetListType m_KernelOffsets
SizeValueType m_PixelsPerTranslation
OffsetMapType m_RemovedOffsets
KernelType m_Kernel

Detailed Description

template<class TInputImage, class TOutputImage, class TKernel, class THistogram>
class itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >

Implements a generic moving histogram algorithm.

This filter is a base class to implement efficiently many neighborhood filters. Instead of visiting all the neighbors of a pixel, the set of pixels in the neighborhood is updated when the filter is moving to a new pixel. The number of pixels read for each pixel can be very smaller than the number of pixels read by a basic algorithm.

This filter moves the neighborhood over all the pixels of the output requested region, and pass the pixel added and removed of the neighborhood to the an histogram class. This filter doesn't implement the histogram class - it must be implement and passed as template parameter. The histogram class is not necessary a real histogram. It can be implemented in many ways, and only has to provide the methods described below.

This filter takes 4 template parameters: the input and output image type, the structuring element (or kernel) type, and the histogram type. The input and output image must have the same number of dimension.

The histogram type is a class which has to implements six methods:

MovingHistogramImageFilter add the new pixels before removing the old ones, so, if AddBoundary() is implemented and/or the kernel is symetric, it is safe to consider that the histogram will never be empty.

One histogram is created for each thread by the method NewHistogram(). The NewHistogram() method can be overiden to pass some parameters to the histogram.

The neighborhood is defined by a structuring element, and must a itk::Neighborhood object or a subclass. The structuring element is assumed to be composed of binary values (zero or one). Only elements of the structuring element having values > 0 are candidates for affecting the center pixel.

See also:
MovingWindowMeanImageFilter, RankImageFilter, MaskedMovingHistogramImageFitler,
MovingHistogramMorphologicalGradientImageFilter
Author:
Gaetan Lehmann
Richard Beare

Definition at line 87 of file itkMovingHistogramImageFilter.h.


Member Typedef Documentation

template<class TInputImage, class TOutputImage, class TKernel, class THistogram>
typedef SmartPointer< const Self > itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >::ConstPointer
template<class TInputImage, class TOutputImage, class TKernel, class THistogram>
typedef THistogram itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >::HistogramType
protected
template<class TInputImage, class TOutputImage, class TKernel, class THistogram>
typedef TInputImage::IndexType itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >::IndexType
template<class TInputImage, class TOutputImage, class TKernel, class THistogram>
typedef TInputImage itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >::InputImageType
template<class TInputImage, class TOutputImage, class TKernel, class THistogram>
typedef KernelType::ConstIterator itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >::KernelIteratorType
template<class TInputImage, class TOutputImage, class TKernel, class THistogram>
typedef TKernel itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >::KernelType
template<class TInputImage, class TOutputImage, class TKernel, class THistogram>
typedef std::list< OffsetType > itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >::OffsetListType
template<class TInputImage, class TOutputImage, class TKernel, class THistogram>
typedef std::map< OffsetType, OffsetListType, typename OffsetType::LexicographicCompare > itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >::OffsetMapType
template<class TInputImage, class TOutputImage, class TKernel, class THistogram>
typedef TInputImage::OffsetType itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >::OffsetType
template<class TInputImage, class TOutputImage, class TKernel, class THistogram>
typedef Superclass::OutputImageRegionType itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >::OutputImageRegionType
template<class TInputImage, class TOutputImage, class TKernel, class THistogram>
typedef TOutputImage itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >::OutputImageType
template<class TInputImage, class TOutputImage, class TKernel, class THistogram>
typedef TOutputImage::PixelType itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >::OutputPixelType
template<class TInputImage, class TOutputImage, class TKernel, class THistogram>
typedef TInputImage::PixelType itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >::PixelType
template<class TInputImage, class TOutputImage, class TKernel, class THistogram>
typedef SmartPointer< Self > itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >::Pointer
template<class TInputImage, class TOutputImage, class TKernel, class THistogram>
typedef KernelType::SizeType itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >::RadiusType
template<class TInputImage, class TOutputImage, class TKernel, class THistogram>
typedef TInputImage::RegionType itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >::RegionType
template<class TInputImage, class TOutputImage, class TKernel, class THistogram>
typedef MovingHistogramImageFilter itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >::Self
template<class TInputImage, class TOutputImage, class TKernel, class THistogram>
typedef TInputImage::SizeType itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >::SizeType
template<class TInputImage, class TOutputImage, class TKernel, class THistogram>
typedef MovingHistogramImageFilterBase< TInputImage, TOutputImage, TKernel > itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >::Superclass

Constructor & Destructor Documentation

template<class TInputImage, class TOutputImage, class TKernel, class THistogram>
itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >::MovingHistogramImageFilter ( )
protected
template<class TInputImage, class TOutputImage, class TKernel, class THistogram>
itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >::~MovingHistogramImageFilter ( )
inlineprotected

Definition at line 137 of file itkMovingHistogramImageFilter.h.

template<class TInputImage, class TOutputImage, class TKernel, class THistogram>
itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >::MovingHistogramImageFilter ( const Self )
private

Member Function Documentation

template<class TInputImage, class TOutputImage, class TKernel, class THistogram>
virtual void itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >::ConfigureHistogram ( THistogram &  )
inlinevirtual
template<class TInputImage, class TOutputImage, class TKernel, class THistogram>
virtual::itk::LightObject::Pointer itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >::CreateAnother ( void  ) const
virtual
template<class TInputImage, class TOutputImage, class TKernel, class THistogram>
virtual const char* itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >::GetNameOfClass ( ) const
virtual
template<class TInputImage, class TOutputImage, class TKernel, class THistogram>
static Pointer itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >::New ( )
static
template<class TInputImage, class TOutputImage, class TKernel, class THistogram>
void itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >::operator= ( const Self )
private
template<class TInputImage, class TOutputImage, class TKernel, class THistogram>
void itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >::PushHistogram ( HistogramType histogram,
const OffsetListType addedList,
const OffsetListType removedList,
const RegionType inputRegion,
const RegionType kernRegion,
const InputImageType inputImage,
const IndexType  currentIdx 
)
protected
template<class TInputImage, class TOutputImage, class TKernel, class THistogram>
void itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >::ThreadedGenerateData ( const OutputImageRegionType outputRegionForThread,
ThreadIdType  threadId 
)
protectedvirtual

Multi-thread version GenerateData.

Reimplemented from itk::ImageSource< TOutputImage >.


Member Data Documentation

template<class TInputImage, class TOutputImage, class TKernel, class THistogram>
const unsigned int itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >::ImageDimension = TInputImage::ImageDimension
static

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