#include <rtkTotalVariationImageFilter.h>

Inheritance diagram for rtk::TotalVariationImageFilter< TInputImage >:

Collaboration diagram for rtk::TotalVariationImageFilter< TInputImage >:

Public Types
using	ConstPointer = itk::SmartPointer< const Self >

using	DataObjectPointer = typename itk::DataObject::Pointer

using	DataObjectPointerArraySizeType = itk::ProcessObject::DataObjectPointerArraySizeType

using	IndexType = typename TInputImage::IndexType

using	InputImagePointer = typename TInputImage::Pointer

using	PixelType = typename TInputImage::PixelType

using	Pointer = itk::SmartPointer< Self >

using	RealObjectType = itk::SimpleDataObjectDecorator< RealType >

using	RealType = typename itk::NumericTraits< PixelType >::RealType

using	RegionType = typename TInputImage::RegionType

using	Self = TotalVariationImageFilter

using	SizeType = typename TInputImage::SizeType

using	Superclass = itk::ImageToImageFilter< TInputImage, TInputImage >

Public Types inherited from ImageSource< TInputImage >
typedef SmartPointer< const Self >	ConstPointer

typedef Superclass::DataObjectIdentifierType	DataObjectIdentifierType

typedef DataObject::Pointer	DataObjectPointer

typedef Superclass::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType

typedef typename OutputImageType::PixelType	OutputImagePixelType

typedef typename OutputImageType::Pointer	OutputImagePointer

typedef typename OutputImageType::RegionType	OutputImageRegionType

typedef TInputImage	OutputImageType

typedef SmartPointer< Self >	Pointer

typedef ImageSource	Self

typedef ProcessObject	Superclass

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother () const

const RealObjectType *	GetTotalVariationOutput () const

DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType output) override

void	SetUseImageSpacingOff ()

void	SetUseImageSpacingOn ()


virtual const char *	GetNameOfClass () const


RealType	GetTotalVariation () const

RealObjectType *	GetTotalVariationOutput ()


virtual void	SetUseImageSpacing (bool _arg)

virtual bool	GetUseImageSpacing () const

Public Member Functions inherited from ImageSource< TInputImage >
OutputImageType *	GetOutput (unsigned int idx)

const OutputImageType *	GetOutput () const

OutputImageType *	GetOutput ()

const OutputImageType *	GetOutput () const

OutputImageType *	GetOutput ()

virtual void	GraftNthOutput (unsigned int idx, DataObject *graft)

virtual void	GraftNthOutput (unsigned int idx, DataObject *graft)

virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *graft)

virtual void	GraftOutput (DataObject *graft)

virtual void	GraftOutput (DataObject *graft)

virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *graft)

ProcessObject::DataObjectPointer	MakeOutput (const ProcessObject::DataObjectIdentifierType &) override

ProcessObject::DataObjectPointer	MakeOutput (const ProcessObject::DataObjectIdentifierType &) override

ProcessObject::DataObjectPointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override

ProcessObject::DataObjectPointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override

Static Public Member Functions
static Pointer	New ()

Static Public Attributes
static constexpr unsigned int	ImageDimension = TInputImage::ImageDimension

Static Public Attributes inherited from ImageSource< TInputImage >
static constexpr unsigned int	OutputImageDimension

Protected Member Functions
void	AfterThreadedGenerateData () override

void	AllocateOutputs () override

void	BeforeThreadedGenerateData () override

void	EnlargeOutputRequestedRegion (itk::DataObject *data) override

void	GenerateInputRequestedRegion () override

void	PrintSelf (std::ostream &os, itk::Indent indent) const override

void	ThreadedGenerateData (const RegionType &outputRegionForThread, itk::ThreadIdType threadId) override

	TotalVariationImageFilter ()

	~TotalVariationImageFilter () override=default

Protected Member Functions inherited from ImageSource< TInputImage >
void	ClassicMultiThread (ThreadFunctionType callbackFunction)

virtual void	DynamicMultiThreadingOn ()

virtual void	DynamicMultiThreadingOn ()

virtual void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)

virtual void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)

void	GenerateData () override

virtual bool	GetDynamicMultiThreading () const

virtual bool	GetDynamicMultiThreading () const

virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const

	ImageSource ()

void	PrintSelf (std::ostream &os, Indent indent) const override

virtual void	SetDynamicMultiThreading (bool _arg)

virtual void	SetDynamicMultiThreading (bool _arg)

virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)

virtual void	ThreadedGenerateData (const OutputImageRegionType &region, ThreadIdType threadId)

virtual void	ThreadedGenerateData (const OutputImageRegionType &region, ThreadIdType threadId)

	~ImageSource () override=default

Protected Attributes
bool	m_UseImageSpacing

Protected Attributes inherited from ImageSource< TInputImage >
bool	m_DynamicMultiThreading

Private Attributes
itk::Array< RealType >	m_SumOfSquareRoots

Additional Inherited Members
Static Protected Member Functions inherited from ImageSource< TInputImage >
static const ImageRegionSplitterBase *	GetGlobalDefaultSplitter ()

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	ThreaderCallback (void *arg)

Detailed Description

template<typename TInputImage>
class rtk::TotalVariationImageFilter< TInputImage >

Compute the total variation of an Image.

TotalVariationImageFilter computes the total variation, defined as the L1 norm of the image of the L2 norm of the gradient, of an image. The filter needs all of its input image. It behaves as a filter with an input and output. Thus it can be inserted in a pipeline with other filters and the total variation will only be recomputed if a downstream filter changes.

The filter passes its input through unmodified. The filter is threaded.

Definition at line 50 of file rtkTotalVariationImageFilter.h.