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

#include <itkTestingHashImageFilter.h>

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

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

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 Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const char *	GetNameOfClass () const
virtual DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType idx)

std::string	GetHash () const
HashObjectType *	GetHashOutput ()
const HashObjectType *	GetHashOutput () const

virtual void	SetHashFunction (HashFunction _arg)
virtual HashFunction	GetHashFunction ()
Static Public Member Functions
static Pointer	New ()
Protected Member Functions
void	AfterThreadedGenerateData ()
void	EnlargeOutputRequestedRegion (DataObject *data)
	HashImageFilter ()
virtual void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	ThreadedGenerateData (const typename Superclass::OutputImageRegionType &, ThreadIdType)
Private Member Functions
	HashImageFilter (const Self &)
void	operator= (const Self &)
Private Attributes
HashFunction	m_HashFunction

Detailed Description

template<class 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 modeled 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.

Member Typedef Documentation

template<class TImageType >

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

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

Definition at line 53 of file itkTestingHashImageFilter.h.

template<class TImageType >

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

Smart Pointer type to a DataObject.

Reimplemented from itk::ImageSource< TImageType >.

Definition at line 61 of file itkTestingHashImageFilter.h.

template<class TImageType >

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

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

Reimplemented from itk::ImageSource< TImageType >.

Definition at line 80 of file itkTestingHashImageFilter.h.

template<class 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<class TImageType >

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

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

Definition at line 52 of file itkTestingHashImageFilter.h.

template<class TImageType >

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

Definition at line 55 of file itkTestingHashImageFilter.h.

template<class TImageType >

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

Standard Self typedef

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

Definition at line 50 of file itkTestingHashImageFilter.h.

template<class TImageType >

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

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

Definition at line 51 of file itkTestingHashImageFilter.h.

Member Enumeration Documentation

template<class TImageType >

enum itk::Testing::HashImageFilter::HashFunction

Enumerator:

MD5

Definition at line 84 of file itkTestingHashImageFilter.h.

Constructor & Destructor Documentation

template<class TImageType >

itk::Testing::HashImageFilter< TImageType >::HashImageFilter ( ) [protected]

template<class TImageType >

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

Member Function Documentation

template<class TImageType >

void itk::Testing::HashImageFilter< TImageType >::AfterThreadedGenerateData ( void ) [protected, virtual]

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<class TImageType >

virtual::itk::LightObject::Pointer itk::Testing::HashImageFilter< TImageType >::CreateAnother ( void ) 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<class TImageType >

void itk::Testing::HashImageFilter< TImageType >::EnlargeOutputRequestedRegion ( DataObject * ) [protected, virtual]

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<class TImageType >

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

Get the computed Hash values

Definition at line 70 of file itkTestingHashImageFilter.h.

template<class 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<class 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().

template<class 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<class TImageType >

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

Runtime information support.

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

template<class TImageType >

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

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 itkSmartPointer to a DataObject. ImageSource and MeshSource override this method to create the correct type of image and mesh respectively. If a filter has multiple outputs of different types, then that filter must provide an implementation of MakeOutput().

Reimplemented from itk::ImageSource< TImageType >.

template<class TImageType >

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

Method for creation through the object factory.

Reimplemented from itk::Object.

template<class TImageType >

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

PushBackInput(), PushFronInput() in the public section force the input to be the type expected by an ImageToImageFilter. However, these methods end of "hiding" the versions from the superclass (ProcessObject) whose arguments are DataObjects. Here, we re-expose the versions from ProcessObject to avoid warnings about hiding methods from the superclass.

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

template<class TImageType >

virtual void itk::Testing::HashImageFilter< TImageType >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const `[protected, virtual]`

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<class 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<class TImageType >

virtual void itk::Testing::HashImageFilter< TImageType >::ThreadedGenerateData	(	const typename Superclass::OutputImageRegionType &	,
		ThreadIdType
	)		`[inline, protected, virtual]`