Generates a hash string from an image. More...

#include <itkHashImageFilter.h>

Inheritance diagram for itk::HashImageFilter< TImageType >:

Collaboration diagram for itk::HashImageFilter< TImageType >:

Public Types
typedef SmartPointer< const Self >	ConstPointer

typedef DataObject::Pointer	DataObjectPointer

typedef ProcessObject::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType

enum	HashFunction { SHA1, MD5 }

typedef SimpleDataObjectDecorator< std::string >	HashObjectType

typedef SmartPointer< Self >	Pointer

typedef TImageType::RegionType	RegionType

typedef HashImageFilter	Self

typedef CastImageFilter< TImageType, TImageType >	Superclass

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

typedef typename TImageType::PixelType	InputPixelType

typedef typename Superclass::OutputImageRegionType	OutputImageRegionType

typedef typename TImageType::PixelType	OutputPixelType

typedef SmartPointer< Self >	Pointer

typedef CastImageFilter	Self

typedef InPlaceImageFilter< TImageType, TImageType >	Superclass

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

typedef typename InputImageType::ConstPointer	InputImageConstPointer

typedef typename InputImageType::PixelType	InputImagePixelType

typedef typename InputImageType::Pointer	InputImagePointer

typedef typename InputImageType::RegionType	InputImageRegionType

typedef TInputImage	InputImageType

typedef typename Superclass::OutputImagePixelType	OutputImagePixelType

typedef typename Superclass::OutputImagePointer	OutputImagePointer

typedef typename Superclass::OutputImageRegionType	OutputImageRegionType

typedef typename Superclass::OutputImageType	OutputImageType

typedef SmartPointer< Self >	Pointer

typedef InPlaceImageFilter	Self

typedef ImageToImageFilter< TInputImage, TOutputImage >	Superclass

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

typedef typename InputImageType::ConstPointer	InputImageConstPointer

typedef typename InputImageType::PixelType	InputImagePixelType

typedef typename InputImageType::Pointer	InputImagePointer

typedef typename InputImageType::RegionType	InputImageRegionType

typedef TInputImage	InputImageType

typedef typename Superclass::OutputImagePixelType	OutputImagePixelType

typedef typename Superclass::OutputImageRegionType	OutputImageRegionType

typedef SmartPointer< Self >	Pointer

typedef ImageToImageFilter	Self

typedef ImageSource< TOutputImage >	Superclass

Public Types inherited from itk::ImageSource< TOutputImage >
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 TOutputImage	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 MultiThreaderBase	MultiThreaderType

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
std::string	GetHash () const

HashObjectType *	GetHashOutput ()

const HashObjectType *	GetHashOutput () const

	itkGetMacro (HashFunction, HashFunction)

	itkNewMacro (Self)

	itkSetMacro (HashFunction, HashFunction)

	itkTypeMacro (HashImageFilter, CastImageFilter)

virtual DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType idx) ITK_OVERRIDE

Public Member Functions inherited from itk::CastImageFilter< TImageType, TImageType >
virtual ::itk::LightObject::Pointer	CreateAnother () const

virtual const char *	GetNameOfClass () const

Public Member Functions inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
virtual bool	CanRunInPlace () const

virtual bool	GetInPlace () const

virtual void	InPlaceOff ()

virtual void	InPlaceOn ()

virtual void	SetInPlace (bool _arg)

Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
virtual double	GetCoordinateTolerance () const

virtual double	GetDirectionTolerance () const

const InputImageType *	GetInput (unsigned int idx) const

const InputImageType *	GetInput () const

void	PopBackInput () override

void	PopFrontInput () override

virtual void	PushBackInput (const InputImageType *image)

virtual void	PushFrontInput (const InputImageType *image)

virtual void	SetCoordinateTolerance (double _arg)

virtual void	SetDirectionTolerance (double _arg)

virtual void	SetInput (const InputImageType *image)

virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)

virtual void	SetInput (unsigned int, const TInputImage *image)

Public Member Functions inherited from itk::ImageSource< TOutputImage >
OutputImageType *	GetOutput ()

OutputImageType *	GetOutput (unsigned int idx)

const OutputImageType *	GetOutput () const

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

virtual void	GraftOutput (DataObject *output)

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

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

MultiThreaderType *	GetMultiThreader () const

DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const

DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const

DataObjectPointerArraySizeType	GetNumberOfInputs () const

DataObjectPointerArraySizeType	GetNumberOfOutputs () const

virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const

virtual const ThreadIdType &	GetNumberOfWorkUnits () const

NameArray	GetOutputNames () const

DataObjectPointerArray	GetOutputs ()

virtual const float &	GetProgress () const

virtual const bool &	GetReleaseDataBeforeUpdateFlag () const

virtual bool	GetReleaseDataFlag () 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	ReleaseDataBeforeUpdateFlagOff ()

virtual void	ReleaseDataBeforeUpdateFlagOn ()

void	ReleaseDataFlagOff ()

void	ReleaseDataFlagOn ()

virtual void	ResetPipeline ()

virtual void	SetAbortGenerateData (bool _arg)

void	SetMultiThreader (MultiThreaderType *threader)

virtual void	SetNumberOfWorkUnits (ThreadIdType _arg)

virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)

virtual void	SetReleaseDataFlag (bool flag)

virtual void	Update ()

virtual void	UpdateLargestPossibleRegion ()

virtual void	UpdateOutputData (DataObject *output)

virtual void	UpdateOutputInformation ()

void	UpdateProgress (float progress)

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

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &) const

void	InvokeEvent (const EventObject &)

virtual void	Modified () const

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

virtual void	SetObjectName (std::string _arg)

void	SetReferenceCount (int) override

void	UnRegister () const noexcept override

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

Protected Member Functions
void	AfterThreadedGenerateData () ITK_OVERRIDE

void	EnlargeOutputRequestedRegion (DataObject *data) ITK_OVERRIDE

	HashImageFilter ()

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

Protected Member Functions inherited from itk::CastImageFilter< TImageType, TImageType >
	CastImageFilter ()

void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread) override

void	DynamicThreadedGenerateDataDispatched (const OutputImageRegionType &outputRegionForThread)

void	DynamicThreadedGenerateDataDispatched (const OutputImageRegionType &outputRegionForThread)

void	GenerateData () override

void	GenerateOutputInformation () override

	~CastImageFilter () override=default

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

virtual bool	GetRunningInPlace () const

	InPlaceImageFilter ()=default

void	ReleaseInputs () override

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

void	GenerateInputRequestedRegion () override

	ImageToImageFilter ()

void	PushBackInput (const DataObject *input) override

void	PushFrontInput (const DataObject *input) override

void	VerifyInputInformation () ITKv5_CONST override

	~ImageToImageFilter () override

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

void	ClassicMultiThread (ThreadFunctionType callbackFunction)

virtual void	DynamicMultiThreadingOff ()

virtual void	DynamicMultiThreadingOn ()

virtual bool	GetDynamicMultiThreading () const

virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const

	ImageSource ()

virtual void	SetDynamicMultiThreading (bool _arg)

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

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

	~ImageSource () override=default

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	GenerateOutputRequestedRegion (DataObject *output)

DataObject *	GetInput (const DataObjectIdentifierType &key)

const DataObject *	GetInput (const DataObjectIdentifierType &key) const

DataObject *	GetInput (DataObjectPointerArraySizeType idx)

const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () const

DataObject *	GetOutput (const DataObjectIdentifierType &key)

const DataObject *	GetOutput (const DataObjectIdentifierType &key) const

DataObject *	GetOutput (DataObjectPointerArraySizeType idx)

const DataObject *	GetOutput (DataObjectPointerArraySizeType idx) const

DataObject *	GetPrimaryInput ()

const DataObject *	GetPrimaryInput () const

virtual const char *	GetPrimaryInputName () const

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

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

virtual void	RemoveInput (const DataObjectIdentifierType &key)

virtual void	RemoveOutput (const DataObjectIdentifierType &key)

virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)

bool	RemoveRequiredInputName (const DataObjectIdentifierType &)

virtual void	RestoreInputReleaseDataFlags ()

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	SetPrimaryInputName (const DataObjectIdentifierType &key)

virtual void	SetPrimaryOutput (DataObject *output)

virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)

void	SetRequiredInputNames (const NameArray &)

virtual void	VerifyPreconditions () ITKv5_CONST

	~ProcessObject () override

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &time)

	~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 Member Functions
	HashImageFilter (const Self &)

void	operator= (const Self &)

Private Attributes
HashFunction	m_HashFunction

Additional Inherited Members
Static Public Member Functions inherited from itk::CastImageFilter< TImageType, TImageType >
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 flag)

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

static Pointer	New ()

Static Public Attributes inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
static constexpr unsigned int	InputImageDimension

static constexpr unsigned int	OutputImageDimension

Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static constexpr unsigned int	InputImageDimension

static constexpr unsigned int	OutputImageDimension

Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static constexpr unsigned int	OutputImageDimension

Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
typedef ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension >	InputToOutputRegionCopierType

typedef ImageToImageFilterDetail::ImageRegionCopier< Self::InputImageDimension, Self::OutputImageDimension >	OutputToInputRegionCopierType

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

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	ThreaderCallback (void *arg)

Protected Attributes inherited from itk::ImageSource< TOutputImage >
bool	m_DynamicMultiThreading

Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime

bool	m_Updating

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount

Detailed Description

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

Generates a hash string from an image.

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