ITK  5.1.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Attributes | List of all members
itk::RankImageFilter< TInputImage, TOutputImage, TKernel > Class Template Reference

#include <itkRankImageFilter.h>

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

Public Types

using ConstPointer = SmartPointer< const Self >
 
using HistogramType = typename Superclass::HistogramType
 
using IndexType = typename TInputImage::IndexType
 
using InputImageType = TInputImage
 
using InputPixelType = typename TInputImage::PixelType
 
using KernelIteratorType = typename KernelType::ConstIterator
 
using KernelType = TKernel
 
using OffsetType = typename TInputImage::OffsetType
 
using OutputImageRegionType = typename Superclass::OutputImageRegionType
 
using OutputImageType = TOutputImage
 
using OutputPixelType = typename TOutputImage::PixelType
 
using PixelType = typename TInputImage::PixelType
 
using Pointer = SmartPointer< Self >
 
using RadiusType = typename KernelType::SizeType
 
using RegionType = typename TInputImage::RegionType
 
using Self = RankImageFilter
 
using SizeType = typename TInputImage::SizeType
 
using Superclass = MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, Function::RankHistogram< typename TInputImage::PixelType > >
 
- Public Types inherited from itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, Function::RankHistogram< TInputImage::PixelType > >
using ConstPointer = SmartPointer< const Self >
 
using IndexType = typename TInputImage::IndexType
 
using InputImageType = TInputImage
 
using KernelIteratorType = typename KernelType::ConstIterator
 
using KernelType = TKernel
 
using OffsetListType = typename std::list< OffsetType >
 
using OffsetMapType = typename std::map< OffsetType, OffsetListType, Functor::LexicographicCompare >
 
using OffsetType = typename TInputImage::OffsetType
 
using OutputImageRegionType = typename Superclass::OutputImageRegionType
 
using OutputImageType = TOutputImage
 
using OutputPixelType = typename TOutputImage::PixelType
 
using PixelType = typename TInputImage::PixelType
 
using Pointer = SmartPointer< Self >
 
using RadiusType = typename KernelType::SizeType
 
using RegionType = typename TInputImage::RegionType
 
using Self = MovingHistogramImageFilter
 
using SizeType = typename TInputImage::SizeType
 
using Superclass = MovingHistogramImageFilterBase< TInputImage, TOutputImage, TKernel >
 
- Public Types inherited from itk::MovingHistogramImageFilterBase< TInputImage, TOutputImage, TKernel >
using ConstPointer = SmartPointer< const Self >
 
using IndexType = typename TInputImage::IndexType
 
using InputImageType = TInputImage
 
using KernelIteratorType = typename KernelType::ConstIterator
 
using KernelType = TKernel
 
using OffsetListType = typename std::list< OffsetType >
 
using OffsetMapType = typename std::map< OffsetType, OffsetListType, Functor::LexicographicCompare >
 
using OffsetType = typename TInputImage::OffsetType
 
using OutputImageRegionType = typename Superclass::OutputImageRegionType
 
using OutputImageType = TOutputImage
 
using OutputPixelType = typename TOutputImage::PixelType
 
using PixelType = typename TInputImage::PixelType
 
using Pointer = SmartPointer< Self >
 
using RadiusType = typename KernelType::SizeType
 
using RegionType = typename TInputImage::RegionType
 
using Self = MovingHistogramImageFilterBase
 
using SizeType = typename TInputImage::SizeType
 
using Superclass = KernelImageFilter< TInputImage, TOutputImage, TKernel >
 
- Public Types inherited from itk::KernelImageFilter< TInputImage, TOutputImage, TKernel >
using ConstPointer = SmartPointer< const Self >
 
using FlatKernelType = FlatStructuringElement<(Self::ImageDimension)>
 
using IndexType = typename TInputImage::IndexType
 
using InputImageType = TInputImage
 
using InputPixelType = typename TInputImage::PixelType
 
using KernelType = TKernel
 
using OffsetType = typename TInputImage::OffsetType
 
using OutputImageType = TOutputImage
 
using OutputPixelType = typename TOutputImage::PixelType
 
using Pointer = SmartPointer< Self >
 
using RadiusType = typename TInputImage::SizeType
 
using RegionType = typename TInputImage::RegionType
 
using Self = KernelImageFilter
 
using SizeType = typename TInputImage::SizeType
 
using Superclass = BoxImageFilter< TInputImage, TOutputImage >
 
- Public Types inherited from itk::BoxImageFilter< TInputImage, TOutputImage >
using ConstPointer = SmartPointer< const Self >
 
using IndexType = typename TInputImage::IndexType
 
using InputImageType = TInputImage
 
using InputPixelType = typename TInputImage::PixelType
 
using OffsetType = typename TInputImage::OffsetType
 
using OutputImageType = TOutputImage
 
using OutputPixelType = typename TOutputImage::PixelType
 
using Pointer = SmartPointer< Self >
 
using RadiusType = typename TInputImage::SizeType
 
using RadiusValueType = typename TInputImage::SizeValueType
 
using RegionType = typename TInputImage::RegionType
 
using Self = BoxImageFilter
 
using SizeType = typename TInputImage::SizeType
 
using Superclass = ImageToImageFilter< TInputImage, TOutputImage >
 
- Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
using ConstPointer = SmartPointer< const Self >
 
using InputImageConstPointer = typename InputImageType::ConstPointer
 
using InputImagePixelType = typename InputImageType::PixelType
 
using InputImagePointer = typename InputImageType::Pointer
 
using InputImageRegionType = typename InputImageType::RegionType
 
using InputImageType = TInputImage
 
using OutputImagePixelType = typename Superclass::OutputImagePixelType
 
using OutputImageRegionType = typename Superclass::OutputImageRegionType
 
using Pointer = SmartPointer< Self >
 
using Self = ImageToImageFilter
 
using Superclass = ImageSource< TOutputImage >
 
- Public Types inherited from itk::ImageSource< TOutputImage >
using ConstPointer = SmartPointer< const Self >
 
using DataObjectIdentifierType = Superclass::DataObjectIdentifierType
 
using DataObjectPointer = DataObject::Pointer
 
using DataObjectPointerArraySizeType = Superclass::DataObjectPointerArraySizeType
 
using OutputImagePixelType = typename OutputImageType::PixelType
 
using OutputImagePointer = typename OutputImageType::Pointer
 
using OutputImageRegionType = typename OutputImageType::RegionType
 
using OutputImageType = TOutputImage
 
using Pointer = SmartPointer< Self >
 
using Self = ImageSource
 
using Superclass = ProcessObject
 
- Public Types inherited from itk::ProcessObject
using ConstPointer = SmartPointer< const Self >
 
using DataObjectIdentifierType = DataObject::DataObjectIdentifierType
 
using DataObjectPointer = DataObject::Pointer
 
using DataObjectPointerArray = std::vector< DataObjectPointer >
 
using DataObjectPointerArraySizeType = DataObjectPointerArray::size_type
 
using MultiThreaderType = MultiThreaderBase
 
using NameArray = std::vector< DataObjectIdentifierType >
 
using Pointer = SmartPointer< Self >
 
using Self = ProcessObject
 
using Superclass = Object
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual const char * GetNameOfClass () const
 
virtual float GetRank () const
 
bool GetUseVectorBasedAlgorithm () const
 
virtual void SetRank (float _arg)
 
- Public Member Functions inherited from itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, Function::RankHistogram< TInputImage::PixelType > >
virtual void ConfigureHistogram (Function::RankHistogram< TInputImage::PixelType > &)
 
virtual ::itk::LightObject::Pointer CreateAnother () const
 
- Public Member Functions inherited from itk::MovingHistogramImageFilterBase< TInputImage, TOutputImage, TKernel >
virtual SizeValueType GetPixelsPerTranslation () const
 
void SetKernel (const KernelType &kernel) override
 
- Public Member Functions inherited from itk::KernelImageFilter< TInputImage, TOutputImage, TKernel >
virtual const KernelTypeGetKernel () const
 
void SetRadius (const RadiusType &radius) override
 
void SetRadius (const SizeValueType &radius) override
 
- Public Member Functions inherited from itk::BoxImageFilter< TInputImage, TOutputImage >
virtual const RadiusTypeGetRadius () const
 
virtual void SetRadius (const RadiusValueType &radius)
 
- Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageTypeGetInput () const
 
const InputImageTypeGetInput (unsigned int idx) const
 
void PopBackInput () override
 
void PopFrontInput () override
 
virtual void PushBackInput (const InputImageType *image)
 
virtual void PushFrontInput (const InputImageType *image)
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
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 ()
 
const OutputImageTypeGetOutput () const
 
OutputImageTypeGetOutput (unsigned int idx)
 
virtual void GraftOutput (DataObject *output)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *output)
 
ProcessObject::DataObjectPointer MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
 
ProcessObject::DataObjectPointer MakeOutput (const ProcessObject::DataObjectIdentifierType &) override
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual DataObjectPointerArraySizeType GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual const float & GetProgress () const
 
void UpdateProgress (float progress)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputInformation ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual void ResetPipeline ()
 
virtual void SetReleaseDataFlag (bool flag)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void ReleaseDataBeforeUpdateFlagOff ()
 
virtual void SetNumberOfWorkUnits (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfWorkUnits () const
 
MultiThreaderTypeGetMultiThreader () const
 
void SetMultiThreader (MultiThreaderType *threader)
 
virtual void PrepareOutputs ()
 
- 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 ()
 
const MetaDataDictionaryGetMetaDataDictionary () 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
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () 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::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, Function::RankHistogram< TInputImage::PixelType > >
static Pointer New ()
 
- Static Public Member Functions inherited from itk::MovingHistogramImageFilterBase< TInputImage, TOutputImage, TKernel >
static Pointer New ()
 
- Static Public Member Functions inherited from itk::KernelImageFilter< TInputImage, TOutputImage, TKernel >
static Pointer New ()
 
- Static Public Member Functions inherited from itk::BoxImageFilter< TInputImage, TOutputImage >
static Pointer New ()
 
- Static Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static void SetGlobalDefaultDirectionTolerance (double)
 
static double GetGlobalDefaultDirectionTolerance ()
 
static void SetGlobalDefaultCoordinateTolerance (double)
 
static double GetGlobalDefaultCoordinateTolerance ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Static Public Attributes

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

Protected Member Functions

void ConfigureHistogram (HistogramType &histogram) override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 RankImageFilter ()
 
 ~RankImageFilter () override=default
 
- Protected Member Functions inherited from itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, Function::RankHistogram< TInputImage::PixelType > >
void DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread) override
 
 MovingHistogramImageFilter ()
 
void PushHistogram (HistogramType &histogram, const OffsetListType *addedList, const OffsetListType *removedList, const RegionType &inputRegion, const RegionType &kernRegion, const InputImageType *inputImage, const IndexType currentIdx)
 
 ~MovingHistogramImageFilter () override=default
 
- 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 ()
 
 ~MovingHistogramImageFilterBase () override=default
 
- Protected Member Functions inherited from itk::KernelImageFilter< TInputImage, TOutputImage, TKernel >
 KernelImageFilter ()
 
 ~KernelImageFilter () override=default
 
- Protected Member Functions inherited from itk::BoxImageFilter< TInputImage, TOutputImage >
 BoxImageFilter ()
 
void GenerateInputRequestedRegion () override
 
 ~BoxImageFilter () override=default
 
- Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
 ImageToImageFilter ()
 
 ~ImageToImageFilter () override
 
void VerifyInputInformation () ITKv5_CONST override
 
virtual void CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
 
virtual void CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
 
void PushBackInput (const DataObject *input) override
 
void PushFrontInput (const DataObject *input) override
 
- Protected Member Functions inherited from itk::ImageSource< TOutputImage >
 ImageSource ()
 
 ~ImageSource () override=default
 
void GenerateData () override
 
void ClassicMultiThread (ThreadFunctionType callbackFunction)
 
virtual void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
 
virtual void AllocateOutputs ()
 
virtual void BeforeThreadedGenerateData ()
 
virtual void AfterThreadedGenerateData ()
 
virtual const ImageRegionSplitterBaseGetImageRegionSplitter () const
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
 
virtual bool GetDynamicMultiThreading () const
 
virtual void SetDynamicMultiThreading (bool _arg)
 
virtual void DynamicMultiThreadingOn ()
 
virtual void DynamicMultiThreadingOff ()
 
- Protected Member Functions inherited from itk::ProcessObject
 ProcessObject ()
 
 ~ProcessObject () override
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
 
virtual void AddInput (DataObject *input)
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
virtual void SetPrimaryInput (DataObject *input)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredInputs () const
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
void SetRequiredInputNames (const NameArray &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
void AddOptionalInputName (const DataObjectIdentifierType &)
 
void AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
virtual void SetPrimaryOutput (DataObject *output)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
virtual void AddOutput (DataObject *output)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredOutputs () const
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
virtual void VerifyPreconditions () ITKv5_CONST
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
virtual void GenerateOutputInformation ()
 
virtual void PropagateResetPipeline ()
 
virtual void ReleaseInputs ()
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void RestoreInputReleaseDataFlags ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
- 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 Attributes

float m_Rank
 

Additional Inherited Members

- Protected Types inherited from itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, Function::RankHistogram< TInputImage::PixelType > >
using HistogramType = Function::RankHistogram< TInputImage::PixelType >
 
- Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
using InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension >
 
using OutputToInputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::InputImageDimension, Self::OutputImageDimension >
 
- Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const ImageRegionSplitterBaseGetGlobalDefaultSplitter ()
 
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION ThreaderCallback (void *arg)
 
- Protected Attributes inherited from itk::MovingHistogramImageFilterBase< TInputImage, TOutputImage, TKernel >
OffsetMapType m_AddedOffsets
 
FixedArray< int, Self::ImageDimensionm_Axes
 
OffsetListType m_KernelOffsets
 
SizeValueType m_PixelsPerTranslation
 
OffsetMapType m_RemovedOffsets
 
- Protected Attributes inherited from itk::KernelImageFilter< TInputImage, TOutputImage, TKernel >
KernelType m_Kernel
 
- Protected Attributes inherited from itk::ImageSource< TOutputImage >
bool m_DynamicMultiThreading
 
- Protected Attributes inherited from itk::ProcessObject
bool m_Updating
 
TimeStamp m_OutputInformationMTime
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Detailed Description

template<typename TInputImage, typename TOutputImage, typename TKernel = FlatStructuringElement<TInputImage::ImageDimension>>
class itk::RankImageFilter< TInputImage, TOutputImage, TKernel >

Rank filter of a greyscale image.

Nonlinear filter in which each output pixel is a user defined rank of input pixels in a user defined neighborhood. The default rank is 0.5 (median). The boundary conditions are different to the standard itkMedianImageFilter. In this filter the neighborhood is cropped at the boundary, and is therefore smaller.

This filter uses a recursive implementation - essentially the one by Huang 1979, I believe, to compute the rank, and is therefore usually a lot faster than the direct implementation. The extensions to Huang are support for arbitrary pixel types (using c++ maps) and arbitrary neighborhoods. I presume that these are not new ideas.

This filter is based on the sliding window code from the consolidatedMorphology package on InsightJournal.

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.

This code was contributed in the Insight Journal paper: "Efficient implementation of kernel filtering" by Beare R., Lehmann G https://hdl.handle.net/1926/555 http://www.insight-journal.org/browse/publication/160

See also
MedianImageFilter
Author
Richard Beare

Definition at line 71 of file itkRankImageFilter.h.

Member Typedef Documentation

◆ ConstPointer

template<typename TInputImage , typename TOutputImage , typename TKernel = FlatStructuringElement<TInputImage::ImageDimension>>
using itk::RankImageFilter< TInputImage, TOutputImage, TKernel >::ConstPointer = SmartPointer<const Self>

Definition at line 83 of file itkRankImageFilter.h.

◆ HistogramType

template<typename TInputImage , typename TOutputImage , typename TKernel = FlatStructuringElement<TInputImage::ImageDimension>>
using itk::RankImageFilter< TInputImage, TOutputImage, TKernel >::HistogramType = typename Superclass::HistogramType

Definition at line 107 of file itkRankImageFilter.h.

◆ IndexType

template<typename TInputImage , typename TOutputImage , typename TKernel = FlatStructuringElement<TInputImage::ImageDimension>>
using itk::RankImageFilter< TInputImage, TOutputImage, TKernel >::IndexType = typename TInputImage::IndexType

Definition at line 100 of file itkRankImageFilter.h.

◆ InputImageType

template<typename TInputImage , typename TOutputImage , typename TKernel = FlatStructuringElement<TInputImage::ImageDimension>>
using itk::RankImageFilter< TInputImage, TOutputImage, TKernel >::InputImageType = TInputImage

Image related type alias.

Definition at line 96 of file itkRankImageFilter.h.

◆ InputPixelType

template<typename TInputImage , typename TOutputImage , typename TKernel = FlatStructuringElement<TInputImage::ImageDimension>>
using itk::RankImageFilter< TInputImage, TOutputImage, TKernel >::InputPixelType = typename TInputImage::PixelType

Definition at line 105 of file itkRankImageFilter.h.

◆ KernelIteratorType

template<typename TInputImage , typename TOutputImage , typename TKernel = FlatStructuringElement<TInputImage::ImageDimension>>
using itk::RankImageFilter< TInputImage, TOutputImage, TKernel >::KernelIteratorType = typename KernelType::ConstIterator

Kernel (structuring element) iterator.

Definition at line 116 of file itkRankImageFilter.h.

◆ KernelType

template<typename TInputImage , typename TOutputImage , typename TKernel = FlatStructuringElement<TInputImage::ImageDimension>>
using itk::RankImageFilter< TInputImage, TOutputImage, TKernel >::KernelType = TKernel

Kernel type alias.

Definition at line 113 of file itkRankImageFilter.h.

◆ OffsetType

template<typename TInputImage , typename TOutputImage , typename TKernel = FlatStructuringElement<TInputImage::ImageDimension>>
using itk::RankImageFilter< TInputImage, TOutputImage, TKernel >::OffsetType = typename TInputImage::OffsetType

Definition at line 102 of file itkRankImageFilter.h.

◆ OutputImageRegionType

template<typename TInputImage , typename TOutputImage , typename TKernel = FlatStructuringElement<TInputImage::ImageDimension>>
using itk::RankImageFilter< TInputImage, TOutputImage, TKernel >::OutputImageRegionType = typename Superclass::OutputImageRegionType

Definition at line 103 of file itkRankImageFilter.h.

◆ OutputImageType

template<typename TInputImage , typename TOutputImage , typename TKernel = FlatStructuringElement<TInputImage::ImageDimension>>
using itk::RankImageFilter< TInputImage, TOutputImage, TKernel >::OutputImageType = TOutputImage

Definition at line 97 of file itkRankImageFilter.h.

◆ OutputPixelType

template<typename TInputImage , typename TOutputImage , typename TKernel = FlatStructuringElement<TInputImage::ImageDimension>>
using itk::RankImageFilter< TInputImage, TOutputImage, TKernel >::OutputPixelType = typename TOutputImage::PixelType

Definition at line 104 of file itkRankImageFilter.h.

◆ PixelType

template<typename TInputImage , typename TOutputImage , typename TKernel = FlatStructuringElement<TInputImage::ImageDimension>>
using itk::RankImageFilter< TInputImage, TOutputImage, TKernel >::PixelType = typename TInputImage::PixelType

Definition at line 101 of file itkRankImageFilter.h.

◆ Pointer

template<typename TInputImage , typename TOutputImage , typename TKernel = FlatStructuringElement<TInputImage::ImageDimension>>
using itk::RankImageFilter< TInputImage, TOutputImage, TKernel >::Pointer = SmartPointer<Self>

Definition at line 82 of file itkRankImageFilter.h.

◆ RadiusType

template<typename TInputImage , typename TOutputImage , typename TKernel = FlatStructuringElement<TInputImage::ImageDimension>>
using itk::RankImageFilter< TInputImage, TOutputImage, TKernel >::RadiusType = typename KernelType::SizeType

n-dimensional Kernel radius.

Definition at line 119 of file itkRankImageFilter.h.

◆ RegionType

template<typename TInputImage , typename TOutputImage , typename TKernel = FlatStructuringElement<TInputImage::ImageDimension>>
using itk::RankImageFilter< TInputImage, TOutputImage, TKernel >::RegionType = typename TInputImage::RegionType

Definition at line 98 of file itkRankImageFilter.h.

◆ Self

template<typename TInputImage , typename TOutputImage , typename TKernel = FlatStructuringElement<TInputImage::ImageDimension>>
using itk::RankImageFilter< TInputImage, TOutputImage, TKernel >::Self = RankImageFilter

Standard class type aliases.

Definition at line 81 of file itkRankImageFilter.h.

◆ SizeType

template<typename TInputImage , typename TOutputImage , typename TKernel = FlatStructuringElement<TInputImage::ImageDimension>>
using itk::RankImageFilter< TInputImage, TOutputImage, TKernel >::SizeType = typename TInputImage::SizeType

Definition at line 99 of file itkRankImageFilter.h.

◆ Superclass

template<typename TInputImage , typename TOutputImage , typename TKernel = FlatStructuringElement<TInputImage::ImageDimension>>
using itk::RankImageFilter< TInputImage, TOutputImage, TKernel >::Superclass = MovingHistogramImageFilter<TInputImage, TOutputImage, TKernel, Function::RankHistogram<typename TInputImage::PixelType> >

Definition at line 87 of file itkRankImageFilter.h.

Constructor & Destructor Documentation

◆ RankImageFilter()

template<typename TInputImage , typename TOutputImage , typename TKernel = FlatStructuringElement<TInputImage::ImageDimension>>
itk::RankImageFilter< TInputImage, TOutputImage, TKernel >::RankImageFilter ( )
protected

◆ ~RankImageFilter()

template<typename TInputImage , typename TOutputImage , typename TKernel = FlatStructuringElement<TInputImage::ImageDimension>>
itk::RankImageFilter< TInputImage, TOutputImage, TKernel >::~RankImageFilter ( )
overrideprotecteddefault

Member Function Documentation

◆ ConfigureHistogram()

template<typename TInputImage , typename TOutputImage , typename TKernel = FlatStructuringElement<TInputImage::ImageDimension>>
void itk::RankImageFilter< TInputImage, TOutputImage, TKernel >::ConfigureHistogram ( HistogramType histogram)
overrideprotected

◆ CreateAnother()

template<typename TInputImage , typename TOutputImage , typename TKernel = FlatStructuringElement<TInputImage::ImageDimension>>
virtual::itk::LightObject::Pointer itk::RankImageFilter< TInputImage, TOutputImage, TKernel >::CreateAnother ( ) 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::MovingHistogramImageFilterBase< TInputImage, TOutputImage, TKernel >.

◆ GetNameOfClass()

template<typename TInputImage , typename TOutputImage , typename TKernel = FlatStructuringElement<TInputImage::ImageDimension>>
virtual const char* itk::RankImageFilter< TInputImage, TOutputImage, TKernel >::GetNameOfClass ( ) const
virtual

◆ GetRank()

template<typename TInputImage , typename TOutputImage , typename TKernel = FlatStructuringElement<TInputImage::ImageDimension>>
virtual float itk::RankImageFilter< TInputImage, TOutputImage, TKernel >::GetRank ( ) const
virtual

◆ GetUseVectorBasedAlgorithm()

template<typename TInputImage , typename TOutputImage , typename TKernel = FlatStructuringElement<TInputImage::ImageDimension>>
bool itk::RankImageFilter< TInputImage, TOutputImage, TKernel >::GetUseVectorBasedAlgorithm ( ) const
inline

Definition at line 124 of file itkRankImageFilter.h.

◆ New()

template<typename TInputImage , typename TOutputImage , typename TKernel = FlatStructuringElement<TInputImage::ImageDimension>>
static Pointer itk::RankImageFilter< TInputImage, TOutputImage, TKernel >::New ( )
static

Standard New method.

◆ PrintSelf()

template<typename TInputImage , typename TOutputImage , typename TKernel = FlatStructuringElement<TInputImage::ImageDimension>>
void itk::RankImageFilter< TInputImage, TOutputImage, TKernel >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

Typedef for the region copier function object that converts an input region to an output region.

Reimplemented from itk::MovingHistogramImageFilterBase< TInputImage, TOutputImage, TKernel >.

◆ SetRank()

template<typename TInputImage , typename TOutputImage , typename TKernel = FlatStructuringElement<TInputImage::ImageDimension>>
virtual void itk::RankImageFilter< TInputImage, TOutputImage, TKernel >::SetRank ( float  _arg)
virtual

Member Data Documentation

◆ ImageDimension

template<typename TInputImage , typename TOutputImage , typename TKernel = FlatStructuringElement<TInputImage::ImageDimension>>
constexpr unsigned int itk::RankImageFilter< TInputImage, TOutputImage, TKernel >::ImageDimension = TInputImage::ImageDimension
staticconstexpr

Image related type alias.

Definition at line 110 of file itkRankImageFilter.h.

◆ m_Rank

template<typename TInputImage , typename TOutputImage , typename TKernel = FlatStructuringElement<TInputImage::ImageDimension>>
float itk::RankImageFilter< TInputImage, TOutputImage, TKernel >::m_Rank
private

Definition at line 140 of file itkRankImageFilter.h.


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