itk::UnsharpMaskImageFilter< TInputImage, TOutputImage, TInternalPrecision > Class Template Reference

#include <itkUnsharpMaskImageFilter.h>

Detailed Description

template<typename TInputImage, typename TOutputImage = TInputImage, typename TInternalPrecision = float>
class itk::UnsharpMaskImageFilter< TInputImage, TOutputImage, TInternalPrecision >

Edge enhancement filter.

This filter subtracts a smoothed version of the image from the image to achieve the edge enhancing effect. https://en.wikipedia.org/w/index.php?title=Unsharp_masking&oldid=750486803#Photographic_unsharp_masking

It has configurable amount, radius (sigma) and threshold, and whether to clamp the resulting values to the range of output type.

Formula: sharpened=original+[itk::Math::abs(original-blurred)-threshold]*amount

If clamping is turned off (it is on by default), casting to output pixel format is done using C++ defaults, meaning that values are not clamped but rather wrap around e.g. 260 -> 4 (unsigned char).

See also

ImageToImageFilter

SmoothingRecursiveGaussianImageFilter

RescaleIntensityImageFilter

Definition at line 55 of file itkUnsharpMaskImageFilter.h.

Inheritance diagram for itk::UnsharpMaskImageFilter< TInputImage, TOutputImage, TInternalPrecision >:

Collaboration diagram for itk::UnsharpMaskImageFilter< TInputImage, TOutputImage, TInternalPrecision >:

Classes
class	UnsharpMaskingFunctor

Public Types
using	ConstPointer = SmartPointer< const Self >
using	GaussianType = SmoothingRecursiveGaussianImageFilter< TInputImage, Image< TInternalPrecision, TOutputImage::ImageDimension > >
using	InputImagePointer = typename InputImageType::Pointer
using	InputImageRegionType = typename TInputImage::RegionType
using	InputImageType = TInputImage
using	InputInternalPixelType = typename TInputImage::InternalPixelType
using	InputPixelType = typename TInputImage::PixelType
using	InternalPrecisionType = TInternalPrecision
using	OutputImageRegionType = typename TOutputImage::RegionType
using	OutputImageType = TOutputImage
using	OutputInternalPixelType = typename TOutputImage::InternalPixelType
using	OutputPixelType = typename TOutputImage::PixelType
using	Pointer = SmartPointer< Self >
using	Self = UnsharpMaskImageFilter
using	SigmaArrayType = typename GaussianType::SigmaArrayType
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	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
const char *	GetNameOfClass () const override
virtual void	SetSigmas (SigmaArrayType _arg)
virtual SigmaArrayType	GetSigmas () const
void	SetSigma (const typename SigmaArrayType::ValueType sigma)
virtual void	SetAmount (TInternalPrecision _arg)
virtual TInternalPrecision	GetAmount () const
virtual void	SetThreshold (TInternalPrecision _arg)
virtual TInternalPrecision	GetThreshold () const
virtual void	SetClamp (bool _arg)
virtual bool	GetClamp () const
virtual void	ClampOn ()
Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageType *	GetInput () const
const InputImageType *	GetInput (unsigned int idx) const
void	PopBackInput () override
void	PopFrontInput () override
virtual void	PushBackInput (const InputImageType *input)
virtual void	PushFrontInput (const InputImageType *input)
virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)
virtual void	SetInput (const InputImageType *input)
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 >
OutputImageType *	GetOutput (unsigned int idx)
OutputImageType *	GetOutput ()
const OutputImageType *	GetOutput () const
virtual void	GraftOutput (DataObject *graft)
virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *graft)
virtual void	GraftNthOutput (unsigned int idx, DataObject *graft)
ProcessObject::DataObjectPointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
ProcessObject::DataObjectPointer	MakeOutput (const ProcessObject::DataObjectIdentifierType &) override
Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOn ()
virtual void	EnlargeOutputRequestedRegion (DataObject *)
virtual const bool &	GetAbortGenerateData () const
DataObjectPointerArray	GetIndexedInputs ()
DataObjectPointerArray	GetIndexedOutputs ()
NameArray	GetInputNames () const
DataObjectPointerArray	GetInputs ()
MultiThreaderType *	GetMultiThreader () const
DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const
DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const
DataObjectPointerArraySizeType	GetNumberOfInputs () const
DataObjectPointerArraySizeType	GetNumberOfOutputs () const
virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const
NameArray	GetOutputNames () const
DataObjectPointerArray	GetOutputs ()
virtual float	GetProgress () const
NameArray	GetRequiredInputNames () const
bool	HasInput (const DataObjectIdentifierType &key) const
bool	HasOutput (const DataObjectIdentifierType &key) const
void	IncrementProgress (float increment)
virtual void	PrepareOutputs ()
virtual void	PropagateRequestedRegion (DataObject *output)
virtual void	ResetPipeline ()
virtual void	SetAbortGenerateData (bool _arg)
void	SetMultiThreader (MultiThreaderType *threader)
virtual void	Update ()
virtual void	UpdateLargestPossibleRegion ()
virtual void	UpdateOutputData (DataObject *output)
virtual void	UpdateOutputInformation ()
void	UpdateProgress (float progress)
virtual void	SetReleaseDataFlag (bool val)
virtual bool	GetReleaseDataFlag () const
void	ReleaseDataFlagOn ()
void	ReleaseDataFlagOff ()
virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)
virtual const bool &	GetReleaseDataBeforeUpdateFlag () const
virtual void	ReleaseDataBeforeUpdateFlagOn ()
virtual void	SetNumberOfWorkUnits (ThreadIdType _arg)
virtual const ThreadIdType &	GetNumberOfWorkUnits () const
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
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 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::ImageToImageFilter< TInputImage, TOutputImage >
static double	GetGlobalDefaultCoordinateTolerance ()
static double	GetGlobalDefaultDirectionTolerance ()
static void	SetGlobalDefaultCoordinateTolerance (double)
static void	SetGlobalDefaultDirectionTolerance (double)
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 = TOutputImage::ImageDimension
static constexpr unsigned int	InputImageDimension = 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	GenerateData () override
void	GenerateInputRequestedRegion () override
void	PrintSelf (std::ostream &os, Indent indent) const override
	UnsharpMaskImageFilter ()
void	VerifyPreconditions () const override
	~UnsharpMaskImageFilter () override=default
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 ()
void	VerifyInputInformation () const override
	~ImageToImageFilter () override=default
virtual void	PushBackInput (const DataObject *input)
virtual void	PushFrontInput (const DataObject *input)
Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void	AfterThreadedGenerateData ()
virtual void	AllocateOutputs ()
virtual void	BeforeThreadedGenerateData ()
void	ClassicMultiThread (ThreadFunctionType callbackFunction)
virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const
	ImageSource ()
virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
	~ImageSource () override=default
virtual void	ThreadedGenerateData (const OutputImageRegionType &region, ThreadIdType threadId)
virtual void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)
virtual bool	GetDynamicMultiThreading () const
virtual void	SetDynamicMultiThreading (bool _arg)
virtual void	DynamicMultiThreadingOn ()
Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)
void	AddOptionalInputName (const DataObjectIdentifierType &)
void	AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
virtual void	AddOutput (DataObject *output)
bool	AddRequiredInputName (const DataObjectIdentifierType &)
bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
virtual void	CacheInputReleaseDataFlags ()
virtual void	GenerateOutputInformation ()
virtual void	GenerateOutputRequestedRegion (DataObject *output)
DataObject *	GetInput (const DataObjectIdentifierType &key)
const DataObject *	GetInput (const DataObjectIdentifierType &key) const
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () const
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () const
bool	IsIndexedInputName (const DataObjectIdentifierType &) const
bool	IsIndexedOutputName (const DataObjectIdentifierType &) const
bool	IsRequiredInputName (const DataObjectIdentifierType &) const
DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const
DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
	ProcessObject ()
virtual void	PropagateResetPipeline ()
virtual void	PushBackInput (const DataObject *input)
virtual void	PushFrontInput (const DataObject *input)
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 idx, DataObject *input)
virtual void	SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)
void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
virtual void	SetOutput (const DataObjectIdentifierType &name, DataObject *output)
virtual void	SetPrimaryInput (DataObject *object)
virtual void	SetPrimaryOutput (DataObject *object)
void	SetRequiredInputNames (const NameArray &)
	~ProcessObject () override
DataObject *	GetInput (DataObjectPointerArraySizeType idx)
const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryInput ()
const DataObject *	GetPrimaryInput () const
virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)
virtual const char *	GetPrimaryInputName () const
DataObject *	GetOutput (const DataObjectIdentifierType &key)
const DataObject *	GetOutput (const DataObjectIdentifierType &key) const
virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)
virtual const char *	GetPrimaryOutputName () const
DataObject *	GetOutput (DataObjectPointerArraySizeType i)
const DataObject *	GetOutput (DataObjectPointerArraySizeType i) const
DataObject *	GetPrimaryOutput ()
const DataObject *	GetPrimaryOutput () const
virtual bool	GetThreaderUpdateProgress () const
virtual void	ThreaderUpdateProgressOn ()
virtual void	SetThreaderUpdateProgress (bool arg)
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
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	PrintTrailer (std::ostream &os, Indent indent) const
virtual	~LightObject ()

Private Attributes
TInternalPrecision	m_Amount {}
bool	m_Clamp {}
SigmaArrayType	m_Sigmas {}
TInternalPrecision	m_Threshold {}

Additional Inherited Members
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 ImageRegionSplitterBase *	GetGlobalDefaultSplitter ()
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	ThreaderCallback (void *arg)
Static Protected Member Functions inherited from itk::ProcessObject
template<typename TSourceObject >
static void	MakeRequiredOutputs (TSourceObject &sourceObject, const DataObjectPointerArraySizeType numberOfRequiredOutputs)
static constexpr float	progressFixedToFloat (uint32_t fixed)
static uint32_t	progressFloatToFixed (float f)
Protected Attributes inherited from itk::ImageSource< TOutputImage >
bool	m_DynamicMultiThreading { true }
Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime {}
bool	m_Updating {}
Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Member Typedef Documentation

ConstPointer

template<typename TInputImage , typename TOutputImage = TInputImage, typename TInternalPrecision = float>

using itk::UnsharpMaskImageFilter< TInputImage, TOutputImage, TInternalPrecision >::ConstPointer = SmartPointer<const Self>

Definition at line 91 of file itkUnsharpMaskImageFilter.h.

GaussianType

template<typename TInputImage , typename TOutputImage = TInputImage, typename TInternalPrecision = float>

using itk::UnsharpMaskImageFilter< TInputImage, TOutputImage, TInternalPrecision >::GaussianType = SmoothingRecursiveGaussianImageFilter<TInputImage, Image<TInternalPrecision, TOutputImage::ImageDimension> >

Definition at line 110 of file itkUnsharpMaskImageFilter.h.

InputImagePointer

template<typename TInputImage , typename TOutputImage = TInputImage, typename TInternalPrecision = float>

using itk::UnsharpMaskImageFilter< TInputImage, TOutputImage, TInternalPrecision >::InputImagePointer = typename InputImageType::Pointer

Definition at line 83 of file itkUnsharpMaskImageFilter.h.

InputImageRegionType

template<typename TInputImage , typename TOutputImage = TInputImage, typename TInternalPrecision = float>

using itk::UnsharpMaskImageFilter< TInputImage, TOutputImage, TInternalPrecision >::InputImageRegionType = typename TInputImage::RegionType

Definition at line 74 of file itkUnsharpMaskImageFilter.h.

InputImageType

template<typename TInputImage , typename TOutputImage = TInputImage, typename TInternalPrecision = float>

using itk::UnsharpMaskImageFilter< TInputImage, TOutputImage, TInternalPrecision >::InputImageType = TInputImage

Image type alias support

Definition at line 81 of file itkUnsharpMaskImageFilter.h.

InputInternalPixelType

template<typename TInputImage , typename TOutputImage = TInputImage, typename TInternalPrecision = float>

using itk::UnsharpMaskImageFilter< TInputImage, TOutputImage, TInternalPrecision >::InputInternalPixelType = typename TInputImage::InternalPixelType

Definition at line 72 of file itkUnsharpMaskImageFilter.h.

InputPixelType

template<typename TInputImage , typename TOutputImage = TInputImage, typename TInternalPrecision = float>

using itk::UnsharpMaskImageFilter< TInputImage, TOutputImage, TInternalPrecision >::InputPixelType = typename TInputImage::PixelType

Definition at line 71 of file itkUnsharpMaskImageFilter.h.

InternalPrecisionType

template<typename TInputImage , typename TOutputImage = TInputImage, typename TInternalPrecision = float>

using itk::UnsharpMaskImageFilter< TInputImage, TOutputImage, TInternalPrecision >::InternalPrecisionType = TInternalPrecision

Definition at line 85 of file itkUnsharpMaskImageFilter.h.

OutputImageRegionType

template<typename TInputImage , typename TOutputImage = TInputImage, typename TInternalPrecision = float>

using itk::UnsharpMaskImageFilter< TInputImage, TOutputImage, TInternalPrecision >::OutputImageRegionType = typename TOutputImage::RegionType

Definition at line 73 of file itkUnsharpMaskImageFilter.h.

OutputImageType

template<typename TInputImage , typename TOutputImage = TInputImage, typename TInternalPrecision = float>

using itk::UnsharpMaskImageFilter< TInputImage, TOutputImage, TInternalPrecision >::OutputImageType = TOutputImage

Definition at line 82 of file itkUnsharpMaskImageFilter.h.

OutputInternalPixelType

template<typename TInputImage , typename TOutputImage = TInputImage, typename TInternalPrecision = float>

using itk::UnsharpMaskImageFilter< TInputImage, TOutputImage, TInternalPrecision >::OutputInternalPixelType = typename TOutputImage::InternalPixelType

Definition at line 70 of file itkUnsharpMaskImageFilter.h.

OutputPixelType

template<typename TInputImage , typename TOutputImage = TInputImage, typename TInternalPrecision = float>

using itk::UnsharpMaskImageFilter< TInputImage, TOutputImage, TInternalPrecision >::OutputPixelType = typename TOutputImage::PixelType

Extract some information from the image types.

Definition at line 69 of file itkUnsharpMaskImageFilter.h.

Pointer

template<typename TInputImage , typename TOutputImage = TInputImage, typename TInternalPrecision = float>

using itk::UnsharpMaskImageFilter< TInputImage, TOutputImage, TInternalPrecision >::Pointer = SmartPointer<Self>

Smart pointer type alias support

Definition at line 90 of file itkUnsharpMaskImageFilter.h.

Self

template<typename TInputImage , typename TOutputImage = TInputImage, typename TInternalPrecision = float>

using itk::UnsharpMaskImageFilter< TInputImage, TOutputImage, TInternalPrecision >::Self = UnsharpMaskImageFilter

Standard "Self" & Superclass type alias.

Definition at line 63 of file itkUnsharpMaskImageFilter.h.

SigmaArrayType

template<typename TInputImage , typename TOutputImage = TInputImage, typename TInternalPrecision = float>

using itk::UnsharpMaskImageFilter< TInputImage, TOutputImage, TInternalPrecision >::SigmaArrayType = typename GaussianType::SigmaArrayType

Definition at line 112 of file itkUnsharpMaskImageFilter.h.

Superclass

template<typename TInputImage , typename TOutputImage = TInputImage, typename TInternalPrecision = float>

using itk::UnsharpMaskImageFilter< TInputImage, TOutputImage, TInternalPrecision >::Superclass = ImageToImageFilter<TInputImage, TOutputImage>

Definition at line 64 of file itkUnsharpMaskImageFilter.h.

Constructor & Destructor Documentation

UnsharpMaskImageFilter()

template<typename TInputImage , typename TOutputImage = TInputImage, typename TInternalPrecision = float>

itk::UnsharpMaskImageFilter< TInputImage, TOutputImage, TInternalPrecision >::UnsharpMaskImageFilter ( )

protected

~UnsharpMaskImageFilter()

template<typename TInputImage , typename TOutputImage = TInputImage, typename TInternalPrecision = float>

itk::UnsharpMaskImageFilter< TInputImage, TOutputImage, TInternalPrecision >::~UnsharpMaskImageFilter ( )

overrideprotecteddefault

Member Function Documentation

ClampOn()

template<typename TInputImage , typename TOutputImage = TInputImage, typename TInternalPrecision = float>

virtual void itk::UnsharpMaskImageFilter< TInputImage, TOutputImage, TInternalPrecision >::ClampOn ( )

virtual

Set/Get whether to clamp values to supported range of output type. Default: On.

GenerateData()

template<typename TInputImage , typename TOutputImage = TInputImage, typename TInternalPrecision = float>

void itk::UnsharpMaskImageFilter< TInputImage, TOutputImage, TInternalPrecision >::GenerateData ( )

overrideprotectedvirtual

A version of GenerateData() specific for image processing filters. This implementation will split the processing across multiple threads. The buffer is allocated by this method. Then the BeforeThreadedGenerateData() method is called (if provided). Then, a series of threads are spawned each calling DynamicThreadedGenerateData(). After all the threads have completed processing, the AfterThreadedGenerateData() method is called (if provided). If an image processing filter cannot be threaded, the filter should provide an implementation of GenerateData(). That implementation is responsible for allocating the output buffer. If a filter can be threaded, it should NOT provide a GenerateData() method but should provide a DynamicThreadedGenerateData() instead.

See also

ThreadedGenerateData()

Reimplemented from itk::ImageSource< TOutputImage >.

GenerateInputRequestedRegion()

template<typename TInputImage , typename TOutputImage = TInputImage, typename TInternalPrecision = float>

void itk::UnsharpMaskImageFilter< TInputImage, TOutputImage, TInternalPrecision >::GenerateInputRequestedRegion ( )

overrideprotectedvirtual

UnsharpMaskImageFilter needs a larger input requested region than the output requested region (larger by the size of the Gaussian kernel). As such, UnsharpMaskImageFilter needs to provide an implementation for GenerateInputRequestedRegion() in order to inform the pipeline execution model.

See also

ImageToImageFilter::GenerateInputRequestedRegion()

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

GetAmount()

template<typename TInputImage , typename TOutputImage = TInputImage, typename TInternalPrecision = float>

virtual TInternalPrecision itk::UnsharpMaskImageFilter< TInputImage, TOutputImage, TInternalPrecision >::GetAmount ( ) const

virtual

Set/Get amount of enhancement. Usual range: 0.1 to 2.0. Default: 0.5.

GetClamp()

template<typename TInputImage , typename TOutputImage = TInputImage, typename TInternalPrecision = float>

virtual bool itk::UnsharpMaskImageFilter< TInputImage, TOutputImage, TInternalPrecision >::GetClamp ( ) const

virtual

Set/Get whether to clamp values to supported range of output type. Default: On.

GetNameOfClass()

template<typename TInputImage , typename TOutputImage = TInputImage, typename TInternalPrecision = float>

const char* itk::UnsharpMaskImageFilter< TInputImage, TOutputImage, TInternalPrecision >::GetNameOfClass ( ) const

overridevirtual

Run-time type information (and related methods)

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

GetSigmas()

template<typename TInputImage , typename TOutputImage = TInputImage, typename TInternalPrecision = float>

virtual SigmaArrayType itk::UnsharpMaskImageFilter< TInputImage, TOutputImage, TInternalPrecision >::GetSigmas ( ) const

virtual

Set/Get Sigma values measured in the units of image spacing. Default: 1.0.

GetThreshold()

template<typename TInputImage , typename TOutputImage = TInputImage, typename TInternalPrecision = float>

virtual TInternalPrecision itk::UnsharpMaskImageFilter< TInputImage, TOutputImage, TInternalPrecision >::GetThreshold ( ) const

virtual

Set/Get threshold for enhancement. Default: 0.

New()

template<typename TInputImage , typename TOutputImage = TInputImage, typename TInternalPrecision = float>

static Pointer itk::UnsharpMaskImageFilter< TInputImage, TOutputImage, TInternalPrecision >::New ( )

static

Method for creation through the object factory.

PrintSelf()

template<typename TInputImage , typename TOutputImage = TInputImage, typename TInternalPrecision = float>

void itk::UnsharpMaskImageFilter< TInputImage, TOutputImage, TInternalPrecision >::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::ImageToImageFilter< TInputImage, TOutputImage >.

SetAmount()

template<typename TInputImage , typename TOutputImage = TInputImage, typename TInternalPrecision = float>

virtual void itk::UnsharpMaskImageFilter< TInputImage, TOutputImage, TInternalPrecision >::SetAmount ( TInternalPrecision  _arg )

virtual

Set/Get amount of enhancement. Usual range: 0.1 to 2.0. Default: 0.5.

SetClamp()

template<typename TInputImage , typename TOutputImage = TInputImage, typename TInternalPrecision = float>

virtual void itk::UnsharpMaskImageFilter< TInputImage, TOutputImage, TInternalPrecision >::SetClamp ( bool  _arg )

virtual

Set/Get whether to clamp values to supported range of output type. Default: On.

SetSigma()

template<typename TInputImage , typename TOutputImage = TInputImage, typename TInternalPrecision = float>

void itk::UnsharpMaskImageFilter< TInputImage, TOutputImage, TInternalPrecision >::SetSigma ( const typename SigmaArrayType::ValueType  sigma )

inline

Convenience method for setting all dimensional parameters to the same values.

Definition at line 122 of file itkUnsharpMaskImageFilter.h.

SetSigmas()

template<typename TInputImage , typename TOutputImage = TInputImage, typename TInternalPrecision = float>

virtual void itk::UnsharpMaskImageFilter< TInputImage, TOutputImage, TInternalPrecision >::SetSigmas ( SigmaArrayType  _arg )

virtual

Set/Get Sigma values measured in the units of image spacing. Default: 1.0.

SetThreshold()

template<typename TInputImage , typename TOutputImage = TInputImage, typename TInternalPrecision = float>

virtual void itk::UnsharpMaskImageFilter< TInputImage, TOutputImage, TInternalPrecision >::SetThreshold ( TInternalPrecision  _arg )

virtual

Set/Get threshold for enhancement. Default: 0.

VerifyPreconditions()

template<typename TInputImage , typename TOutputImage = TInputImage, typename TInternalPrecision = float>

void itk::UnsharpMaskImageFilter< TInputImage, TOutputImage, TInternalPrecision >::VerifyPreconditions ( ) const

overrideprotectedvirtual

Verifies that the process object has been configured correctly, that all required inputs are set, and needed parameters are set appropriately. If not valid an exceptions will be thrown.

This method is called before UpdateOutputInformation() is propagated to the inputs.

The ProcessObject's implementation verifies that the m_NumberOfRequiredInputs are set and not null.

Reimplemented from itk::ProcessObject.

Member Data Documentation

ImageDimension

template<typename TInputImage , typename TOutputImage = TInputImage, typename TInternalPrecision = float>

constexpr unsigned int itk::UnsharpMaskImageFilter< TInputImage, TOutputImage, TInternalPrecision >::ImageDimension = TOutputImage::ImageDimension

staticconstexpr

Definition at line 75 of file itkUnsharpMaskImageFilter.h.

InputImageDimension

template<typename TInputImage , typename TOutputImage = TInputImage, typename TInternalPrecision = float>

constexpr unsigned int itk::UnsharpMaskImageFilter< TInputImage, TOutputImage, TInternalPrecision >::InputImageDimension = TInputImage::ImageDimension

staticconstexpr

Definition at line 76 of file itkUnsharpMaskImageFilter.h.

m_Amount

template<typename TInputImage , typename TOutputImage = TInputImage, typename TInternalPrecision = float>

TInternalPrecision itk::UnsharpMaskImageFilter< TInputImage, TOutputImage, TInternalPrecision >::m_Amount {}

private

The edge amplification amount

Definition at line 171 of file itkUnsharpMaskImageFilter.h.

m_Clamp

template<typename TInputImage , typename TOutputImage = TInputImage, typename TInternalPrecision = float>

bool itk::UnsharpMaskImageFilter< TInputImage, TOutputImage, TInternalPrecision >::m_Clamp {}

private

Definition at line 174 of file itkUnsharpMaskImageFilter.h.

m_Sigmas

template<typename TInputImage , typename TOutputImage = TInputImage, typename TInternalPrecision = float>

SigmaArrayType itk::UnsharpMaskImageFilter< TInputImage, TOutputImage, TInternalPrecision >::m_Sigmas {}

private

Definition at line 173 of file itkUnsharpMaskImageFilter.h.

m_Threshold

template<typename TInputImage , typename TOutputImage = TInputImage, typename TInternalPrecision = float>

TInternalPrecision itk::UnsharpMaskImageFilter< TInputImage, TOutputImage, TInternalPrecision >::m_Threshold {}

private

Definition at line 172 of file itkUnsharpMaskImageFilter.h.

---

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

• itkUnsharpMaskImageFilter.h