#include <itkUnsharpMaskLevelSetImageFilter.h>

Inheritance diagram for itk::UnsharpMaskLevelSetImageFilter< TInputImage, TOutputImage >:

Collaboration diagram for itk::UnsharpMaskLevelSetImageFilter< TInputImage, TOutputImage >:

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef LevelSetFunctionWithRefitTerm < TOutputImage, SparseImageType >	FunctionType
typedef SmartPointer< Self >	Pointer
typedef FunctionType::RadiusType	RadiusType
typedef UnsharpMaskLevelSetImageFilter	Self
typedef Superclass::SparseImageType	SparseImageType
typedef SparseFieldFourthOrderLevelSetImageFilter < TInputImage, TOutputImage >	Superclass
Public Types inherited from itk::SparseFieldFourthOrderLevelSetImageFilter< TInputImage, TOutputImage >
typedef Superclass::IndexType	IndexType
typedef Superclass::LayerType	LayerType
typedef LevelSetFunctionWithRefitTerm < OutputImageType, SparseImageType >	LevelSetFunctionType
typedef Superclass::NeighborhoodScalesType	NeighborhoodScalesType
typedef NormalBandNode < OutputImageType >	NodeType
typedef ImplicitManifoldNormalVectorFilter < OutputImageType, SparseImageType >	NormalVectorFilterType
typedef NormalVectorDiffusionFunction < SparseImageType >	NormalVectorFunctionType
typedef NodeType::NodeDataType	NormalVectorType
typedef Superclass::OutputImageType	OutputImageType
typedef NeighborhoodIterator < SparseImageType >	SparseImageIteratorType
typedef Superclass::ValueType	ValueType
Public Types inherited from itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >
typedef TInputImage	InputImageType
typedef std::vector < LayerPointerType >	LayerListType
typedef ObjectStore < LayerNodeType >	LayerNodeStorageType
typedef SparseFieldLevelSetNode < IndexType >	LayerNodeType
typedef LayerType::Pointer	LayerPointerType
typedef Image< StatusType, itkGetStaticConstMacro(ImageDimension) >	StatusImageType
typedef signed char	StatusType
typedef Superclass::TimeStepType	TimeStepType
typedef std::vector< ValueType >	UpdateBufferType
Public Types inherited from itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >
typedef FiniteDifferenceFunction < TOutputImage >	FiniteDifferenceFunctionType
typedef TInputImage::PixelType	InputPixelType
typedef NumericTraits < InputPixelType >::ValueType	InputPixelValueType
typedef TOutputImage::PixelType	OutputPixelType
typedef NumericTraits < OutputPixelType >::ValueType	OutputPixelValueType
typedef OutputPixelType	PixelType
Public Types inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
typedef InputImageType::ConstPointer	InputImageConstPointer
typedef InputImageType::PixelType	InputImagePixelType
typedef InputImageType::Pointer	InputImagePointer
typedef InputImageType::RegionType	InputImageRegionType
typedef Superclass::OutputImagePixelType	OutputImagePixelType
typedef Superclass::OutputImagePointer	OutputImagePointer
typedef Superclass::OutputImageRegionType	OutputImageRegionType
Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
Public Types inherited from itk::ImageSource< TOutputImage >
typedef Superclass::DataObjectIdentifierType	DataObjectIdentifierType
typedef DataObject::Pointer	DataObjectPointer
typedef Superclass::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType
Public Types inherited from itk::ProcessObject
typedef std::vector < DataObjectPointer >	DataObjectPointerArray
typedef std::vector < DataObjectIdentifierType >	NameArray
Public Types inherited from itk::Object
Public Types inherited from itk::LightObject

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual unsigned int	GetMaxFilterIteration () const
virtual const char *	GetNameOfClass () const
virtual void	SetMaxFilterIteration (unsigned int _arg)
Public Member Functions inherited from itk::SparseFieldFourthOrderLevelSetImageFilter< TInputImage, TOutputImage >
virtual const ValueType &	GetCurvatureBandWidth ()
virtual const unsigned int &	GetMaxNormalIteration ()
virtual const unsigned int &	GetMaxRefitIteration ()
unsigned int	GetMinimumNumberOfLayers () const
virtual const ValueType &	GetNormalProcessConductance ()
virtual const int &	GetNormalProcessType ()
virtual const bool &	GetNormalProcessUnsharpFlag ()
virtual const ValueType &	GetNormalProcessUnsharpWeight ()
virtual const ValueType &	GetRMSChangeNormalProcessTrigger ()
virtual void	SetCurvatureBandWidth (ValueType _arg)
void	SetLevelSetFunction (LevelSetFunctionType *lsf)
virtual void	SetMaxNormalIteration (unsigned int _arg)
virtual void	SetMaxRefitIteration (unsigned int _arg)
virtual void	SetNormalProcessConductance (ValueType _arg)
virtual void	SetNormalProcessType (int _arg)
virtual void	SetNormalProcessUnsharpFlag (bool _arg)
virtual void	SetNormalProcessUnsharpWeight (ValueType _arg)
virtual void	SetNumberOfLayers (const unsigned int n)
virtual void	SetRMSChangeNormalProcessTrigger (ValueType _arg)
virtual void	InitializeIteration ()
	typedef (Concept::HasNumericTraits< ValueType >) OutputHasNumericTraitsCheck
Public Member Functions inherited from itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >
	typedef (Concept::EqualityComparable< typename TOutputImage::PixelType >) OutputEqualityComparableCheck
	typedef (Concept::Convertible< double, typename TOutputImage::PixelType >) DoubleConvertibleToOutputCheck
	typedef (Concept::OStreamWritable< typename TOutputImage::PixelType >) OutputOStreamWritableCheck
virtual unsigned int	GetNumberOfLayers () const
virtual void	SetIsoSurfaceValue (ValueType _arg)
virtual ValueType	GetIsoSurfaceValue () const
virtual void	SetInterpolateSurfaceLocation (bool _arg)
virtual bool	GetInterpolateSurfaceLocation () const
void	InterpolateSurfaceLocationOn ()
void	InterpolateSurfaceLocationOff ()
Public Member Functions inherited from itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >
virtual const FiniteDifferenceFunctionType::Pointer &	GetDifferenceFunction () const
virtual const IdentifierType &	GetElapsedIterations ()
virtual bool	GetIsInitialized ()
virtual void	SetDifferenceFunction (FiniteDifferenceFunctionType *_arg)
virtual void	SetIsInitialized (bool _arg)
void	SetStateToInitialized ()
void	SetStateToUninitialized ()
virtual void	SetNumberOfIterations (IdentifierType _arg)
virtual const IdentifierType &	GetNumberOfIterations ()
virtual void	SetUseImageSpacing (bool _arg)
virtual void	UseImageSpacingOn ()
virtual void	UseImageSpacingOff ()
virtual const bool &	GetUseImageSpacing ()
virtual void	SetMaximumRMSError (double _arg)
virtual const double &	GetMaximumRMSError ()
virtual void	SetRMSChange (double _arg)
virtual const double &	GetRMSChange ()
virtual void	SetManualReinitialization (bool _arg)
virtual const bool &	GetManualReinitialization ()
virtual void	ManualReinitializationOn ()
virtual void	ManualReinitializationOff ()
Public Member Functions inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
virtual bool	CanRunInPlace () const
virtual void	SetInPlace (bool _arg)
virtual bool	GetInPlace () const
virtual void	InPlaceOn ()
virtual void	InPlaceOff ()
Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageType *	GetInput (void) const
const InputImageType *	GetInput (unsigned int idx) const
virtual void	PopBackInput ()
virtual void	PopFrontInput ()
virtual void	PushBackInput (const InputImageType *image)
virtual void	PushFrontInput (const InputImageType *image)
virtual void	SetInput (const InputImageType *image)
virtual void	SetInput (unsigned int, const TInputImage *image)
Public Member Functions inherited from itk::ImageSource< TOutputImage >
OutputImageType *	GetOutput (unsigned int idx)
virtual void	GraftNthOutput (unsigned int idx, DataObject *output)
virtual void	GraftOutput (DataObject *output)
virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
OutputImageType *	GetOutput (void)
const OutputImageType *	GetOutput (void) const
virtual ProcessObject::DataObjectPointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx)
Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
virtual void	EnlargeOutputRequestedRegion (DataObject *)
virtual const bool &	GetAbortGenerateData ()
NameArray	GetInputNames () const
MultiThreader *	GetMultiThreader () const
DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const
DataObjectPointerArraySizeType	GetNumberOfInputs () const
DataObjectPointerArraySizeType	GetNumberOfOutputs () const
virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const
NameArray	GetOutputNames () const
virtual const float &	GetProgress ()
NameArray	GetRequiredInputNames () const
bool	HasInput (const DataObjectIdentifierType &key) const
bool	HasOutput (const DataObjectIdentifierType &key) const
virtual DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)
virtual void	PrepareOutputs ()
virtual void	PropagateRequestedRegion (DataObject *output)
virtual void	ResetPipeline ()
virtual void	SetAbortGenerateData (bool _arg)
virtual void	SetProgress (float _arg)
virtual void	Update ()
virtual void	UpdateLargestPossibleRegion ()
virtual void	UpdateOutputData (DataObject *output)
virtual void	UpdateOutputInformation ()
void	UpdateProgress (float amount)
DataObjectPointerArray	GetInputs ()
DataObjectPointerArray	GetOutputs ()
DataObjectPointerArray	GetIndexedInputs ()
DataObjectPointerArray	GetIndexedOutputs ()
DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const
virtual void	SetReleaseDataFlag (bool flag)
virtual bool	GetReleaseDataFlag () const
void	ReleaseDataFlagOn ()
void	ReleaseDataFlagOff ()
virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)
virtual const bool &	GetReleaseDataBeforeUpdateFlag ()
virtual void	ReleaseDataBeforeUpdateFlagOn ()
virtual void	ReleaseDataBeforeUpdateFlagOff ()
virtual void	SetNumberOfThreads (ThreadIdType _arg)
virtual const ThreadIdType &	GetNumberOfThreads ()
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
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
virtual unsigned long	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
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const
Public Member Functions inherited from itk::LightObject
virtual void	Delete ()
virtual int	GetReferenceCount () const
	itkCloneMacro (Self)
void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()

Protected Member Functions
virtual void	PrintSelf (std::ostream &os, Indent indent) const
	UnsharpMaskLevelSetImageFilter ()
	~UnsharpMaskLevelSetImageFilter ()

virtual bool	Halt ()
Protected Member Functions inherited from itk::SparseFieldFourthOrderLevelSetImageFilter< TInputImage, TOutputImage >
bool	ActiveLayerCheckBand () const
ValueType	ComputeCurvatureFromSparseImageNeighborhood (SparseImageIteratorType &neighborhood) const
void	ComputeCurvatureTarget (const OutputImageType distanceImage, SparseImageType sparseImage) const
void	ProcessNormals ()
	SparseFieldFourthOrderLevelSetImageFilter ()
	~SparseFieldFourthOrderLevelSetImageFilter ()
Protected Member Functions inherited from itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >
void	AllocateUpdateBuffer ()
void	ApplyUpdate (const TimeStepType &dt)
TimeStepType	CalculateChange ()
virtual ValueType	CalculateUpdateValue (const IndexType &, const TimeStepType &dt, const ValueType &value, const ValueType &change)
void	ConstructActiveLayer ()
void	ConstructLayer (StatusType from, StatusType to)
void	CopyInputToOutput ()
virtual ValueType	GetValueOne () const
virtual ValueType	GetValueZero () const
void	Initialize ()
void	InitializeActiveLayerValues ()
virtual void	InitializeBackgroundPixels ()
virtual void	PostProcessOutput ()
void	ProcessOutsideList (LayerType *OutsideList, StatusType ChangeToStatus)
void	ProcessStatusList (LayerType InputList, LayerType OutputList, StatusType ChangeToStatus, StatusType SearchForStatus)
void	PropagateAllLayerValues ()
void	PropagateLayerValues (StatusType from, StatusType to, StatusType promote, int InOrOut)
void	UpdateActiveLayerValues (TimeStepType dt, LayerType StatusUpList, LayerType StatusDownList)
	SparseFieldLevelSetImageFilter ()
	~SparseFieldLevelSetImageFilter ()
Protected Member Functions inherited from itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >
	FiniteDifferenceImageFilter ()
virtual void	GenerateData ()
virtual void	GenerateInputRequestedRegion ()
virtual TimeStepType	ResolveTimeStep (const std::vector< TimeStepType > &timeStepList, const std::vector< bool > &valid) const
virtual void	SetElapsedIterations (IdentifierType _arg)
virtual bool	ThreadedHalt (void *)
virtual	~FiniteDifferenceImageFilter ()
Protected Member Functions inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
virtual void	AllocateOutputs ()
virtual bool	GetRunningInPlace () const
	InPlaceImageFilter ()
virtual void	ReleaseInputs ()
	~InPlaceImageFilter ()
Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
	ImageToImageFilter ()
virtual void	VerifyInputInformation ()
	~ImageToImageFilter ()
void	PushBackInput (const DataObject *input)
void	PushFrontInput (const DataObject *input)
Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void	AfterThreadedGenerateData ()
virtual void	BeforeThreadedGenerateData ()
	ImageSource ()
virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int num, OutputImageRegionType &splitRegion)
virtual void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
virtual	~ImageSource ()
Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)
virtual void	AddOutput (DataObject *output)
bool	AddRequiredInputName (const DataObjectIdentifierType &)
virtual void	CacheInputReleaseDataFlags ()
virtual void	GenerateOutputInformation ()
virtual void	GenerateOutputRequestedRegion (DataObject *output)
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs ()
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs ()
bool	IsIndexedName (const DataObjectIdentifierType &) const
bool	IsRequiredInputName (const DataObjectIdentifierType &) const
	itkLegacyMacro (virtual void RemoveInput(DataObject *input))
	itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
	itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
	itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
DataObjectPointerArraySizeType	MakeIndexFromName (const DataObjectIdentifierType &) const
DataObjectIdentifierType	MakeNameFromIndex (DataObjectPointerArraySizeType) const
	ProcessObject ()
virtual void	PropagateResetPipeline ()
virtual void	RemoveInput (const DataObjectIdentifierType &key)
virtual void	RemoveInput (DataObjectPointerArraySizeType)
virtual void	RemoveOutput (const DataObjectIdentifierType &key)
virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)
bool	RemoveRequiredInputName (const DataObjectIdentifierType &)
virtual void	RestoreInputReleaseDataFlags ()
virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)
virtual void	SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
virtual void	SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
virtual void	SetOutput (const DataObjectIdentifierType &key, DataObject *output)
virtual void	SetPrimaryInput (DataObject *input)
virtual void	SetPrimaryOutput (DataObject *output)
void	SetRequiredInputNames (const NameArray &)
virtual void	VerifyPreconditions ()
	~ProcessObject ()
DataObject *	GetInput (const DataObjectIdentifierType &key)
const DataObject *	GetInput (const DataObjectIdentifierType &key) const
DataObject *	GetInput (DataObjectPointerArraySizeType)
const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryInput ()
const DataObject *	GetPrimaryInput () const
DataObject *	GetOutput (const DataObjectIdentifierType &key)
const DataObject *	GetOutput (const DataObjectIdentifierType &key) const
DataObject *	GetOutput (DataObjectPointerArraySizeType idx)
const DataObject *	GetOutput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryOutput ()
const DataObject *	GetPrimaryOutput () const
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
virtual	~Object ()
Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const
	LightObject ()
virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual	~LightObject ()

Protected Attributes
FunctionType::Pointer	m_Function
unsigned int	m_MaxFilterIteration

Private Member Functions
void	operator= (const Self &)
	UnsharpMaskLevelSetImageFilter (const Self &)

Additional Inherited Members
Static Public Attributes inherited from itk::SparseFieldFourthOrderLevelSetImageFilter< TInputImage, TOutputImage >
static const unsigned int	ImageDimension = Superclass::ImageDimension
Static Public Attributes inherited from itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >
Static Public Attributes inherited from itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >
Static Public Attributes inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
static const unsigned int	InputImageDimension = TInputImage::ImageDimension
static const unsigned int	OutputImageDimension = TOutputImage::ImageDimension
Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
Static Public Attributes inherited from itk::ImageSource< TOutputImage >

Detailed Description

template<class TInputImage, class TOutputImage>
class itk::UnsharpMaskLevelSetImageFilter< TInputImage, TOutputImage >

This class implements a detail enhancing filter by making use of the 4th-order level set isotropic diffusion (smoothing) PDE.

INPUT and OUTPUT: This is a volume to volume filter; however, it is meant to process (smooth) surfaces. The input surface is an isosurface of the input volume. The isosurface value to be processed can be set by calling SetIsoSurfaceValue (default is 0). The output surface is the 0-isosurface of the output volume, regardless of the input isosurface value. To visualize the input/output surfaces to this filter a mesh extraction method such as marching cubes can be used.

: This filter is an example of how the 4th order level set PDE framework can be used for general purpose surface processing. It is motivated by unsharp masking from image processing which is a way of enhancing detail. This filter acts much like the IsotropicFourthOrderLevelSetImageFilter because it first smoothes the normal vectors via isotropic diffusion. However, as a post-processing step we extrapolate from the original normals in the direction opposite to the new processes normals. By refiting the surface to these extrapolated vectors we achieve detail enhancement. This process is not the same as running the isotropic diffusion process in reverse.

IMPORTANT: Because this filters enhances details on the surface, it will also amplify noise! This filter is provided only as an example of graphics oriented post-processing. Do not use it on noisy data.

PARAMETERS: As mentioned before, the IsoSurfaceValue parameter chooses which isosurface of the input to process. The MaxFilterIterations parameter determine the number of iterations for which this filter will run. Since, this filter enhances detail AND noise MaxFilterIterations above a couple of hundred are unreasonable. Finally NormalProcessUnsharpWeight controls the amount of extrapolation (or equivalently the amount of detail enhancement). This value should be in the range [0.1,1] for reasonable results.

Definition at line 67 of file itkUnsharpMaskLevelSetImageFilter.h.