itk::MedianImageFunction< TInputImage, TCoordRep > Class Template Reference

#include <itkMedianImageFunction.h>

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

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

Public Types
using	ConstPointer = SmartPointer< const Self >
using	ContinuousIndexType = typename Superclass::ContinuousIndexType
using	ImageSizeType = typename InputImageType::SizeType
using	IndexType = typename Superclass::IndexType
using	InputImageType = TInputImage
using	InputPixelType = typename Superclass::InputPixelType
using	OutputType = typename Superclass::OutputType
using	Pointer = SmartPointer< Self >
using	PointType = typename Superclass::PointType
using	Self = MedianImageFunction
using	Superclass = ImageFunction< TInputImage, typename TInputImage::PixelType, TCoordRep >
Public Types inherited from itk::ImageFunction< TInputImage, TInputImage::PixelType, TCoordRep >
using	ConstPointer = SmartPointer< const Self >
using	ContinuousIndexType = ContinuousIndex< TCoordRep, Self::ImageDimension >
using	CoordRepType = TCoordRep
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< TCoordRep, Self::ImageDimension >
using	Self = ImageFunction
using	Superclass = FunctionBase< Point< TCoordRep, Self::ImageDimension >, TInputImage::PixelType >
Public Types inherited from itk::FunctionBase< Point< TCoordRep, TInputImage::ImageDimension >, TInputImage::PixelType >
using	ConstPointer = SmartPointer< const Self >
using	InputType = Point< TCoordRep, 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
virtual ::itk::LightObject::Pointer	CreateAnother () const
OutputType	Evaluate (const PointType &point) const override
OutputType	EvaluateAtContinuousIndex (const ContinuousIndexType &cindex) const override
OutputType	EvaluateAtIndex (const IndexType &index) const override
virtual const char *	GetNameOfClass () const
Public Member Functions inherited from itk::ImageFunction< TInputImage, TInputImage::PixelType, TCoordRep >
TInputImage::PixelType	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
const InputImageType *	GetInputImage () 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
void	ConvertPointToContinuousIndex (const PointType &point, ContinuousIndexType &cindex) const
void	ConvertContinuousIndexToNearestIndex (const ContinuousIndexType &cindex, IndexType &index) const
virtual const IndexType &	GetStartIndex () const
virtual const IndexType &	GetEndIndex () const
virtual const ContinuousIndexType &	GetStartContinuousIndex () const
virtual const ContinuousIndexType &	GetEndContinuousIndex () const
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
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
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)
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 void	Delete ()
virtual int	GetReferenceCount () const
void	Print (std::ostream &os, Indent indent=0) const

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, TCoordRep >
static constexpr unsigned int	ImageDimension
unsigned int	m_NeighborhoodRadius { 1 }
std::vector< Offset< ImageDimension > >	m_NeighborhoodOffsets
void	SetNeighborhoodRadius (unsigned int)
virtual const unsigned int &	GetNeighborhoodRadius () const
	MedianImageFunction ()
	~MedianImageFunction () override=default
void	PrintSelf (std::ostream &os, Indent indent) const override

Additional Inherited Members
Protected Member Functions inherited from itk::ImageFunction< TInputImage, TInputImage::PixelType, TCoordRep >
	ImageFunction ()
	~ImageFunction () override=default
void	PrintSelf (std::ostream &os, Indent indent) const override
Protected Member Functions inherited from itk::FunctionBase< Point< TCoordRep, TInputImage::ImageDimension >, TInputImage::PixelType >
	FunctionBase ()=default
	~FunctionBase () override=default
Protected Member Functions inherited from itk::Object
	Object ()
	~Object () override
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &timeStamp)
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 ()
Protected Attributes inherited from itk::ImageFunction< TInputImage, TInputImage::PixelType, TCoordRep >
InputImageConstPointer	m_Image
IndexType	m_StartIndex
IndexType	m_EndIndex
ContinuousIndexType	m_StartContinuousIndex
ContinuousIndexType	m_EndContinuousIndex
Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount

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:

• All ITK Sphinx Examples

• Compute Median Of Image At Pixel

Examples

SphinxExamples/src/Core/ImageFunction/ComputeMedianOfImageAtPixel/Code.cxx.

Definition at line 49 of file itkMedianImageFunction.h.

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.

ContinuousIndexType

template<typename TInputImage , typename TCoordRep = float>

using itk::MedianImageFunction< TInputImage, TCoordRep >::ContinuousIndexType = typename Superclass::ContinuousIndexType

ContinuousIndex type alias support

Definition at line 79 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.

IndexType

template<typename TInputImage , typename TCoordRep = float>

using itk::MedianImageFunction< TInputImage, TCoordRep >::IndexType = typename Superclass::IndexType

Index type alias support

Definition at line 76 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.

InputPixelType

template<typename TInputImage , typename TCoordRep = float>

using itk::MedianImageFunction< TInputImage, TCoordRep >::InputPixelType = typename Superclass::InputPixelType

Definition at line 70 of file itkMedianImageFunction.h.

OutputType

template<typename TInputImage , typename TCoordRep = float>

using itk::MedianImageFunction< TInputImage, TCoordRep >::OutputType = typename Superclass::OutputType

OutputType type alias support

Definition at line 73 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.

PointType

template<typename TInputImage , typename TCoordRep = float>

using itk::MedianImageFunction< TInputImage, TCoordRep >::PointType = typename Superclass::PointType

Point type alias support

Definition at line 82 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

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

~MedianImageFunction()

template<typename TInputImage , typename TCoordRep = float>

itk::MedianImageFunction< TInputImage, TCoordRep >::~MedianImageFunction ( )

overrideprotecteddefault

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

Member Function Documentation

CreateAnother()

template<typename TInputImage , typename TCoordRep = float>

virtual::itk::LightObject::Pointer itk::MedianImageFunction< TInputImage, TCoordRep >::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::Object.

Evaluate()

template<typename TInputImage , typename TCoordRep = float>

OutputType itk::MedianImageFunction< TInputImage, TCoordRep >::Evaluate ( const PointType &  point ) const

inlineoverride

Evaluate the function at non-integer positions

Definition at line 96 of file itkMedianImageFunction.h.

EvaluateAtContinuousIndex()

template<typename TInputImage , typename TCoordRep = float>

OutputType itk::MedianImageFunction< TInputImage, TCoordRep >::EvaluateAtContinuousIndex ( const ContinuousIndexType &  cindex ) const

inlineoverride

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

override

Evalulate the function at specified index

GetNameOfClass()

template<typename TInputImage , typename TCoordRep = float>

virtual const char* itk::MedianImageFunction< TInputImage, TCoordRep >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageFunction< TInputImage, TInputImage::PixelType, TCoordRep >.

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

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

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)) }

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

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

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

Definition at line 127 of file itkMedianImageFunction.h.

---

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

• itkMedianImageFunction.h