ITK  6.0.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::MedianImageFunction< TInputImage, TCoordRep > Class Template Reference
Data Processing Objects » Functions » Image Functions | Group Core » Module ITKImageFunction

#include <itkMedianImageFunction.h>

Detailed Description

template<typename TInputImage, typename TCoordRep = float>
class itk::MedianImageFunction< TInputImage, TCoordRep >

Calculate the median value in the neighborhood of a pixel.

Calculate the median pixel value over the standard 8, 26, etc. connected neighborhood. This calculation uses a ZeroFluxNeumannBoundaryCondition.

If called with a ContinuousIndex or Point, the calculation is performed at the nearest neighbor.

This class is templated over the input image type and the coordinate representation type (e.g. float or double ).

ITK Sphinx Examples:
  • <a href=
  • <a href=

Definition at line 49 of file itkMedianImageFunction.h.

+ Inheritance diagram for itk::MedianImageFunction< TInputImage, TCoordRep >:
+ Collaboration diagram for itk::MedianImageFunction< TInputImage, TCoordRep >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using ImageSizeType = typename InputImageType::SizeType
 
using InputImageType = TInputImage
 
using Pointer = SmartPointer< Self >
 
using Self = MedianImageFunction
 
using Superclass = ImageFunction< TInputImage, typename TInputImage::PixelType, TCoordRep >
 
- Public Types inherited from itk::ImageFunction< TInputImage, TInputImage::PixelType, float >
using ConstPointer = SmartPointer< const Self >
 
using ContinuousIndexType = ContinuousIndex< float, Self::ImageDimension >
 
using CoordRepType = float
 
using IndexType = typename InputImageType::IndexType
 
using IndexValueType = typename InputImageType::IndexValueType
 
using InputImageConstPointer = typename InputImageType::ConstPointer
 
using InputImageType = TInputImage
 
using InputPixelType = typename InputImageType::PixelType
 
using OutputType = TInputImage::PixelType
 
using Pointer = SmartPointer< Self >
 
using PointType = Point< float, Self::ImageDimension >
 
using Self = ImageFunction
 
using Superclass = FunctionBase< Point< float, Self::ImageDimension >, TInputImage::PixelType >
 
- Public Types inherited from itk::FunctionBase< Point< float, TInputImage::ImageDimension >, TInputImage::PixelType >
using ConstPointer = SmartPointer< const Self >
 
using InputType = Point< float, TInputImage::ImageDimension >
 
using OutputType = TInputImage::PixelType
 
using Pointer = SmartPointer< Self >
 
using Self = FunctionBase
 
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

OutputType Evaluate (const PointType &point) const override
 
OutputType EvaluateAtContinuousIndex (const ContinuousIndexType &cindex) const override
 
OutputType EvaluateAtIndex (const IndexType &index) const override
 
const char * GetNameOfClass () const override
 
void SetNeighborhoodRadius (unsigned int)
 
virtual const unsigned int & GetNeighborhoodRadius () const
 
- Public Member Functions inherited from itk::ImageFunction< TInputImage, TInputImage::PixelType, float >
void ConvertContinuousIndexToNearestIndex (const ContinuousIndexType &cindex, IndexType &index) const
 
void ConvertPointToContinuousIndex (const PointType &point, ContinuousIndexType &cindex) const
 
OutputType Evaluate (const PointType &point) const override=0
 
virtual TInputImage::PixelType EvaluateAtContinuousIndex (const ContinuousIndexType &index) const=0
 
virtual TInputImage::PixelType EvaluateAtIndex (const IndexType &index) const=0
 
virtual const ContinuousIndexType & GetEndContinuousIndex () const
 
virtual const IndexType & GetEndIndex () const
 
const InputImageType * GetInputImage () const
 
const char * GetNameOfClass () const override
 
virtual const ContinuousIndexType & GetStartContinuousIndex () const
 
virtual const IndexType & GetStartIndex () const
 
virtual void SetInputImage (const InputImageType *ptr)
 
virtual bool IsInsideBuffer (const IndexType &index) const
 
virtual bool IsInsideBuffer (const ContinuousIndexType &index) const
 
virtual bool IsInsideBuffer (const PointType &point) const
 
void ConvertPointToNearestIndex (const PointType &point, IndexType &index) const
 
virtual OutputType Evaluate (const InputType &input) const=0
 
const char * GetNameOfClass () const override
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *cmd) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
Command * GetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionary & GetMetaDataDictionary ()
 
const MetaDataDictionary & GetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
const char * GetNameOfClass () const override
 
virtual const TimeStamp & GetTimeStamp () 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) const
 
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
Pointer Clone () const
 
virtual Pointer CreateAnother () const
 
virtual void Delete ()
 
virtual const char * GetNameOfClass () const
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 
virtual void Register () const
 
virtual void SetReferenceCount (int)
 
virtual void UnRegister () const noexcept
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Static Public Attributes

static constexpr unsigned int ImageDimension = InputImageType::ImageDimension
 
- Static Public Attributes inherited from itk::ImageFunction< TInputImage, TInputImage::PixelType, float >
static constexpr unsigned int ImageDimension
 

Protected Member Functions

 MedianImageFunction ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~MedianImageFunction () override=default
 
- Protected Member Functions inherited from itk::ImageFunction< TInputImage, TInputImage::PixelType, float >
 ImageFunction ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~ImageFunction () override=default
 
- Protected Member Functions inherited from itk::FunctionBase< Point< float, TInputImage::ImageDimension >, TInputImage::PixelType >
 FunctionBase ()=default
 
 ~FunctionBase () override=default
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~Object () override
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintSelf (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Attributes

std::vector< Offset< ImageDimension > > m_NeighborhoodOffsets
 
unsigned int m_NeighborhoodRadius { 1 }
 

Additional Inherited Members

- Protected Attributes inherited from itk::ImageFunction< TInputImage, TInputImage::PixelType, float >
ContinuousIndexType m_EndContinuousIndex
 
IndexType m_EndIndex
 
InputImageConstPointer m_Image
 
ContinuousIndexType m_StartContinuousIndex
 
IndexType m_StartIndex
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ ConstPointer

template<typename TInputImage , typename TCoordRep = float>
using itk::MedianImageFunction< TInputImage, TCoordRep >::ConstPointer = SmartPointer<const Self>

Definition at line 60 of file itkMedianImageFunction.h.

◆ ImageSizeType

template<typename TInputImage , typename TCoordRep = float>
using itk::MedianImageFunction< TInputImage, TCoordRep >::ImageSizeType = typename InputImageType::SizeType

Size type of the underlying image.

Definition at line 85 of file itkMedianImageFunction.h.

◆ InputImageType

template<typename TInputImage , typename TCoordRep = float>
using itk::MedianImageFunction< TInputImage, TCoordRep >::InputImageType = TInputImage

InputImageType type alias support

Definition at line 69 of file itkMedianImageFunction.h.

◆ Pointer

template<typename TInputImage , typename TCoordRep = float>
using itk::MedianImageFunction< TInputImage, TCoordRep >::Pointer = SmartPointer<Self>

Definition at line 59 of file itkMedianImageFunction.h.

◆ Self

template<typename TInputImage , typename TCoordRep = float>
using itk::MedianImageFunction< TInputImage, TCoordRep >::Self = MedianImageFunction

Standard class type aliases.

Definition at line 56 of file itkMedianImageFunction.h.

◆ Superclass

template<typename TInputImage , typename TCoordRep = float>
using itk::MedianImageFunction< TInputImage, TCoordRep >::Superclass = ImageFunction<TInputImage, typename TInputImage::PixelType, TCoordRep>

Definition at line 57 of file itkMedianImageFunction.h.

Constructor & Destructor Documentation

◆ MedianImageFunction()

template<typename TInputImage , typename TCoordRep = float>
itk::MedianImageFunction< TInputImage, TCoordRep >::MedianImageFunction ( )
protected

◆ ~MedianImageFunction()

template<typename TInputImage , typename TCoordRep = float>
itk::MedianImageFunction< TInputImage, TCoordRep >::~MedianImageFunction ( )
overrideprotecteddefault

Member Function Documentation

◆ Evaluate()

template<typename TInputImage , typename TCoordRep = float>
OutputType itk::MedianImageFunction< TInputImage, TCoordRep >::Evaluate ( const PointType &  point) const
inlineoverridevirtual

Evaluate the function at non-integer positions

Implements itk::ImageFunction< TInputImage, TInputImage::PixelType, float >.

Definition at line 96 of file itkMedianImageFunction.h.

References itk::point().

◆ EvaluateAtContinuousIndex()

template<typename TInputImage , typename TCoordRep = float>
OutputType itk::MedianImageFunction< TInputImage, TCoordRep >::EvaluateAtContinuousIndex ( const ContinuousIndexType &  index) const
inlineoverridevirtual

Evaluate the function at specified ContinuousIndex position. Subclasses must provide this method.

Implements itk::ImageFunction< TInputImage, TInputImage::PixelType, float >.

Definition at line 105 of file itkMedianImageFunction.h.

◆ EvaluateAtIndex()

template<typename TInputImage , typename TCoordRep = float>
OutputType itk::MedianImageFunction< TInputImage, TCoordRep >::EvaluateAtIndex ( const IndexType &  index) const
overridevirtual

Evaluate the function at specified index

Implements itk::ImageFunction< TInputImage, TInputImage::PixelType, float >.

◆ GetNameOfClass()

template<typename TInputImage , typename TCoordRep = float>
const char * itk::MedianImageFunction< TInputImage, TCoordRep >::GetNameOfClass ( ) const
overridevirtual
See also
LightObject::GetNameOfClass()

Reimplemented from itk::Object.

◆ GetNeighborhoodRadius()

template<typename TInputImage , typename TCoordRep = float>
virtual const unsigned int & itk::MedianImageFunction< TInputImage, TCoordRep >::GetNeighborhoodRadius ( ) const
virtual

Get/Set the radius of the neighborhood over which the statistics are evaluated

◆ New()

template<typename TInputImage , typename TCoordRep = float>
static Pointer itk::MedianImageFunction< TInputImage, TCoordRep >::New ( )
static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TInputImage , typename TCoordRep = float>
void itk::MedianImageFunction< TInputImage, TCoordRep >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

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::Object.

◆ SetNeighborhoodRadius()

template<typename TInputImage , typename TCoordRep = float>
void itk::MedianImageFunction< TInputImage, TCoordRep >::SetNeighborhoodRadius ( unsigned int  )

Get/Set the radius of the neighborhood over which the statistics are evaluated

Member Data Documentation

◆ ImageDimension

template<typename TInputImage , typename TCoordRep = float>
constexpr unsigned int itk::MedianImageFunction< TInputImage, TCoordRep >::ImageDimension = InputImageType::ImageDimension
staticconstexpr

Dimension of the underlying image.

Definition at line 88 of file itkMedianImageFunction.h.

◆ m_NeighborhoodOffsets

template<typename TInputImage , typename TCoordRep = float>
std::vector<Offset<ImageDimension> > itk::MedianImageFunction< TInputImage, TCoordRep >::m_NeighborhoodOffsets
private
Initial value:
{ GenerateRectangularImageNeighborhoodOffsets(
ImageSizeType::Filled(1)) }
itk::GenerateRectangularImageNeighborhoodOffsets
std::vector< Offset< VImageDimension > > GenerateRectangularImageNeighborhoodOffsets(const Size< VImageDimension > &radius)
Definition: itkImageNeighborhoodOffsets.h:43

Definition at line 129 of file itkMedianImageFunction.h.

◆ m_NeighborhoodRadius

template<typename TInputImage , typename TCoordRep = float>
unsigned int itk::MedianImageFunction< TInputImage, TCoordRep >::m_NeighborhoodRadius { 1 }
private

Definition at line 127 of file itkMedianImageFunction.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file. Previous versions of this documentation for version: 5.3, 5.2, 5.1, 5.0, 4.13, 3.20.
Generated on unknown for ITK by   doxygen 1.9.3