#include <itkTestingHashImageFilter.h>

Inheritance diagram for itk::Testing::HashImageFilter< TImageType >:

Collaboration diagram for itk::Testing::HashImageFilter< TImageType >:

Detailed Description

template<typename TImageType>
class itk::Testing::HashImageFilter< TImageType >

Generates a md5 hash string from an image.

Note: This class utlizes low level buffer pointer access, to work with itk::Image and itk::VectorImage. It is modelled after the access an ImageFileWriter provides to an ImageIO.

Warning: The output is not very useful. This filter is derived from InPlace to prevent a needless copy. If inplace is turned off then the output image bulk data will be allocated, and not set to anything meaningful.

Definition at line 45 of file itkTestingHashImageFilter.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer

typedef DataObject::Pointer	DataObjectPointer

typedef ProcessObject::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType

enum	HashFunction { MD5 }

typedef SimpleDataObjectDecorator < std::string >	HashObjectType

typedef SmartPointer< Self >	Pointer

typedef TImageType::RegionType	RegionType

typedef HashImageFilter	Self

typedef InPlaceImageFilter < TImageType, TImageType >	Superclass

Public Types inherited from itk::InPlaceImageFilter< TImageType, TImageType >
typedef SmartPointer< const Self >	ConstPointer

typedef InputImageType::ConstPointer	InputImageConstPointer

typedef InputImageType::PixelType	InputImagePixelType

typedef InputImageType::Pointer	InputImagePointer

typedef InputImageType::RegionType	InputImageRegionType

typedef TImageType	InputImageType

typedef Superclass::OutputImagePixelType	OutputImagePixelType

typedef Superclass::OutputImagePointer	OutputImagePointer

typedef Superclass::OutputImageRegionType	OutputImageRegionType

typedef Superclass::OutputImageType	OutputImageType

typedef SmartPointer< Self >	Pointer

typedef InPlaceImageFilter	Self

typedef ImageToImageFilter < TImageType, TImageType >	Superclass

Public Types inherited from itk::ImageToImageFilter< TImageType, TImageType >
typedef SmartPointer< const Self >	ConstPointer

typedef InputImageType::ConstPointer	InputImageConstPointer

typedef InputImageType::PixelType	InputImagePixelType

typedef InputImageType::Pointer	InputImagePointer

typedef InputImageType::RegionType	InputImageRegionType

typedef TImageType	InputImageType

typedef Superclass::OutputImagePixelType	OutputImagePixelType

typedef Superclass::OutputImageRegionType	OutputImageRegionType

typedef SmartPointer< Self >	Pointer

typedef ImageToImageFilter	Self

typedef ImageSource< TImageType >	Superclass

Public Types inherited from itk::ImageSource< TImageType >
typedef SmartPointer< const Self >	ConstPointer

typedef Superclass::DataObjectIdentifierType	DataObjectIdentifierType

typedef DataObject::Pointer	DataObjectPointer

typedef Superclass::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType

typedef OutputImageType::PixelType	OutputImagePixelType

typedef OutputImageType::Pointer	OutputImagePointer

typedef OutputImageType::RegionType	OutputImageRegionType

typedef TImageType	OutputImageType

typedef SmartPointer< Self >	Pointer

typedef ImageSource	Self

typedef ProcessObject	Superclass

Public Types inherited from itk::ProcessObject
typedef SmartPointer< const Self >	ConstPointer

typedef DataObject::DataObjectIdentifierType	DataObjectIdentifierType

typedef DataObject::Pointer	DataObjectPointer

typedef std::vector < DataObjectPointer >	DataObjectPointerArray

typedef DataObjectPointerArray::size_type	DataObjectPointerArraySizeType

typedef std::vector < DataObjectIdentifierType >	NameArray

typedef SmartPointer< Self >	Pointer

typedef ProcessObject	Self

typedef Object	Superclass

Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef Object	Self

typedef LightObject	Superclass

Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

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

virtual const char *	GetNameOfClass () const

virtual DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType idx) override


std::string	GetHash () const

HashObjectType *	GetHashOutput ()

const HashObjectType *	GetHashOutput () const


virtual void	SetHashFunction (HashFunction _arg)

virtual HashFunction	GetHashFunction ()

Public Member Functions inherited from itk::InPlaceImageFilter< TImageType, TImageType >
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< TImageType, TImageType >
const InputImageType *	GetInput () const

const InputImageType *	GetInput (unsigned int idx) const

virtual void	PopBackInput () override

virtual void	PopFrontInput () override

virtual void	PushBackInput (const InputImageType *image)

virtual void	PushFrontInput (const InputImageType *image)

virtual void	SetInput (const InputImageType *image)

virtual void	SetInput (unsigned int, const TImageType *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< TImageType >
OutputImageType *	GetOutput (unsigned int idx)

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

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

OutputImageType *	GetOutput ()

const OutputImageType *	GetOutput () const

virtual void	GraftOutput (DataObject *output)

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

Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOff ()

virtual void	AbortGenerateDataOn ()

virtual const bool &	GetAbortGenerateData () const

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

NameArray	GetInputNames () const

DataObjectPointerArray	GetInputs ()

MultiThreader *	GetMultiThreader () const

DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const

DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const

DataObjectPointerArraySizeType	GetNumberOfInputs () const

DataObjectPointerArraySizeType	GetNumberOfOutputs () const

virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const

NameArray	GetOutputNames () const

DataObjectPointerArray	GetOutputs ()

virtual const float &	GetProgress () const

NameArray	GetRequiredInputNames () const

bool	HasInput (const DataObjectIdentifierType &key) const

bool	HasOutput (const DataObjectIdentifierType &key) const

virtual void	PrepareOutputs ()

virtual void	PropagateRequestedRegion (DataObject *output)

virtual void	ResetPipeline ()

virtual void	SetAbortGenerateData (bool _arg)

virtual void	Update ()

virtual void	UpdateLargestPossibleRegion ()

virtual void	UpdateOutputData (DataObject *output)

virtual void	UpdateOutputInformation ()

void	UpdateProgress (float progress)

void	SetProgress (float progress)

virtual void	SetReleaseDataFlag (bool flag)

virtual bool	GetReleaseDataFlag () const

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)

virtual const bool &	GetReleaseDataBeforeUpdateFlag () const

virtual void	ReleaseDataBeforeUpdateFlagOn ()

virtual void	ReleaseDataBeforeUpdateFlagOff ()

virtual void	SetNumberOfThreads (ThreadIdType _arg)

virtual const ThreadIdType &	GetNumberOfThreads () const

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

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

virtual void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void	SetReferenceCount (int) override

virtual void	UnRegister () const noexceptoverride

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () 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 ()

Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool flag)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Protected Member Functions
void	AfterThreadedGenerateData () override

void	EnlargeOutputRequestedRegion (DataObject *data) override

	HashImageFilter ()

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

virtual void	ThreadedGenerateData (const typename Superclass::OutputImageRegionType &, ThreadIdType) override

Protected Member Functions inherited from itk::InPlaceImageFilter< TImageType, TImageType >
virtual void	AllocateOutputs () override

virtual bool	GetRunningInPlace () const

	InPlaceImageFilter ()

virtual void	ReleaseInputs () override

	~InPlaceImageFilter ()

Protected Member Functions inherited from itk::ImageToImageFilter< TImageType, TImageType >
virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)

virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)

virtual void	GenerateInputRequestedRegion () override

	ImageToImageFilter ()

virtual void	VerifyInputInformation () override

	~ImageToImageFilter ()

void	PushBackInput (const DataObject *input) override

void	PushFrontInput (const DataObject *input) override

Protected Member Functions inherited from itk::ImageSource< TImageType >
virtual void	BeforeThreadedGenerateData ()

virtual void	GenerateData () override

virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const

	ImageSource ()

virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int pieces, 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 &)

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

	itkLegacyMacro (virtual void RemoveOutput(DataObject *output))

	itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))

	itkLegacyMacro (virtual void RemoveInput(DataObject *input))

	itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))

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	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 (DataObjectPointerArraySizeType idx)

const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const

DataObject *	GetPrimaryInput ()

const DataObject *	GetPrimaryInput () const

virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryInputName (void) const

DataObject *	GetOutput (const DataObjectIdentifierType &key)

const DataObject *	GetOutput (const DataObjectIdentifierType &key) const

virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryOutputName (void) 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 ()

Private Member Functions
	HashImageFilter (const Self &)

void	operator= (const Self &)

Private Attributes
HashFunction	m_HashFunction

Additional Inherited Members
Static Public Attributes inherited from itk::InPlaceImageFilter< TImageType, TImageType >
static const unsigned int	InputImageDimension

static const unsigned int	OutputImageDimension

Static Public Attributes inherited from itk::ImageToImageFilter< TImageType, TImageType >
static const unsigned int	InputImageDimension

static const unsigned int	OutputImageDimension

Static Public Attributes inherited from itk::ImageSource< TImageType >
static const unsigned int	OutputImageDimension

Protected Types inherited from itk::ImageToImageFilter< TImageType, TImageType >
typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(OutputImageDimension), itkGetStaticConstMacro(InputImageDimension) >	InputToOutputRegionCopierType

typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(OutputImageDimension) >	OutputToInputRegionCopierType

Static Protected Member Functions inherited from itk::ImageSource< TImageType >
static const ImageRegionSplitterBase *	GetGlobalDefaultSplitter ()

static ITK_THREAD_RETURN_TYPE	ThreaderCallback (void *arg)

Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime

bool	m_Updating

Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount

Member Typedef Documentation

template<typename TImageType >

typedef SmartPointer< const Self > itk::Testing::HashImageFilter< TImageType >::ConstPointer

Definition at line 53 of file itkTestingHashImageFilter.h.

template<typename TImageType >

typedef DataObject::Pointer itk::Testing::HashImageFilter< TImageType >::DataObjectPointer

Smart Pointer type to a DataObject.

Definition at line 61 of file itkTestingHashImageFilter.h.

template<typename TImageType >

typedef ProcessObject::DataObjectPointerArraySizeType itk::Testing::HashImageFilter< TImageType >::DataObjectPointerArraySizeType

Make a DataObject of the correct type to be used as the specified output.

Definition at line 80 of file itkTestingHashImageFilter.h.

template<typename TImageType >

typedef SimpleDataObjectDecorator< std::string > itk::Testing::HashImageFilter< TImageType >::HashObjectType

Type of DataObjects used for scalar outputs

Definition at line 67 of file itkTestingHashImageFilter.h.

template<typename TImageType >

typedef SmartPointer< Self > itk::Testing::HashImageFilter< TImageType >::Pointer

Definition at line 52 of file itkTestingHashImageFilter.h.

template<typename TImageType >

typedef TImageType::RegionType itk::Testing::HashImageFilter< TImageType >::RegionType

Definition at line 55 of file itkTestingHashImageFilter.h.

template<typename TImageType >

typedef HashImageFilter itk::Testing::HashImageFilter< TImageType >::Self

Standard Self typedef

Definition at line 50 of file itkTestingHashImageFilter.h.

template<typename TImageType >

typedef InPlaceImageFilter< TImageType, TImageType > itk::Testing::HashImageFilter< TImageType >::Superclass

Definition at line 51 of file itkTestingHashImageFilter.h.

Member Enumeration Documentation

template<typename TImageType >

enum itk::Testing::HashImageFilter::HashFunction

Enumerator
MD5

Definition at line 84 of file itkTestingHashImageFilter.h.

Constructor & Destructor Documentation

template<typename TImageType >

itk::Testing::HashImageFilter< TImageType >::HashImageFilter ( )

protected

template<typename TImageType >

itk::Testing::HashImageFilter< TImageType >::HashImageFilter ( const Self & )

private

Member Function Documentation

template<typename TImageType >

void itk::Testing::HashImageFilter< TImageType >::AfterThreadedGenerateData ( void )

overrideprotectedvirtual

If an imaging filter needs to perform processing after all processing threads have completed, the filter can can provide an implementation for AfterThreadedGenerateData(). The execution flow in the default GenerateData() method will be: 1) Allocate the output buffer 2) Call BeforeThreadedGenerateData() 3) Spawn threads, calling ThreadedGenerateData() in each thread. 4) Call AfterThreadedGenerateData() Note that this flow of control is only available if a filter provides a ThreadedGenerateData() method and NOT a GenerateData() method.

Reimplemented from itk::ImageSource< TImageType >.

template<typename TImageType >

virtual::itk::LightObject::Pointer itk::Testing::HashImageFilter< TImageType >::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.

template<typename TImageType >

void itk::Testing::HashImageFilter< TImageType >::EnlargeOutputRequestedRegion ( DataObject * )

overrideprotectedvirtual

Give the process object a chance to indictate that it will produce more output than it was requested to produce. For example, many imaging filters must compute the entire output at once or can only produce output in complete slices. Such filters cannot handle smaller requested regions. These filters must provide an implementation of this method, setting the output requested region to the size they will produce. By default, a process object does not modify the size of the output requested region.

Reimplemented from itk::ProcessObject.

template<typename TImageType >

std::string itk::Testing::HashImageFilter< TImageType >::GetHash ( ) const

inline

Get the computed Hash values

Definition at line 70 of file itkTestingHashImageFilter.h.

References itk::SimpleDataObjectDecorator< T >::Get(), and itk::Testing::HashImageFilter< TImageType >::GetHashOutput().

template<typename TImageType >

virtual HashFunction itk::Testing::HashImageFilter< TImageType >::GetHashFunction ( )

virtual

Set/Get The hash function type. Currently only MD5 is supported and this value is ignores.

template<typename TImageType >

HashObjectType* itk::Testing::HashImageFilter< TImageType >::GetHashOutput ( )

inline

Get the computed Hash values

Definition at line 72 of file itkTestingHashImageFilter.h.

References itk::ProcessObject::GetOutput().

Referenced by itk::Testing::HashImageFilter< TImageType >::GetHash().

template<typename TImageType >

const HashObjectType* itk::Testing::HashImageFilter< TImageType >::GetHashOutput ( ) const

inline

Get the computed Hash values

Definition at line 74 of file itkTestingHashImageFilter.h.

References itk::ProcessObject::GetOutput().

template<typename TImageType >

virtual const char* itk::Testing::HashImageFilter< TImageType >::GetNameOfClass ( ) const

virtual

Runtime information support.

Reimplemented from itk::InPlaceImageFilter< TImageType, TImageType >.

template<typename TImageType >

virtual DataObjectPointer itk::Testing::HashImageFilter< TImageType >::MakeOutput ( DataObjectPointerArraySizeType idx )

overridevirtual

Make a DataObject of the correct type to used as the specified output. Every ProcessObject subclass must be able to create a DataObject that can be used as a specified output. This method is automatically called when DataObject::DisconnectPipeline() is called. DataObject::DisconnectPipeline, disconnects a data object from being an output of its current source. When the data object is disconnected, the ProcessObject needs to construct a replacement output data object so that the ProcessObject is in a valid state. So DataObject::DisconnectPipeline eventually calls ProcessObject::MakeOutput. Note that MakeOutput always returns a SmartPointer to a DataObject. If a subclass of ImageSource has multiple outputs of different types, then that class must provide an implementation of MakeOutput().

Reimplemented from itk::ImageSource< TImageType >.

template<typename TImageType >

static Pointer itk::Testing::HashImageFilter< TImageType >::New ( )

static

Method for creation through the object factory.

template<typename TImageType >

void itk::Testing::HashImageFilter< TImageType >::operator= ( const Self & )

private

template<typename TImageType >

virtual void itk::Testing::HashImageFilter< TImageType >::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::InPlaceImageFilter< TImageType, TImageType >.

template<typename TImageType >

virtual void itk::Testing::HashImageFilter< TImageType >::SetHashFunction ( HashFunction _arg )

virtual

Set/Get The hash function type. Currently only MD5 is supported and this value is ignores.

template<typename TImageType >