itk::RandomImageSource< TOutputImage > Class Template Reference

#include <itkRandomImageSource.h>

Inheritance diagram for itk::RandomImageSource< TOutputImage >:

Collaboration diagram for itk::RandomImageSource< TOutputImage >:

List of all members.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef TOutputImage::IndexType	IndexType
typedef TOutputImage::PixelType	OutputImagePixelType
typedef TOutputImage::RegionType	OutputImageRegionType
typedef SmartPointer< Self >	Pointer
typedef TOutputImage::PointType	PointType
typedef PointValueType	PointValueArrayType [TOutputImage::ImageDimension]
typedef TOutputImage::PointValueType	PointValueType
typedef RandomImageSource	Self
typedef TOutputImage::SizeType	SizeType
typedef SizeValueType	SizeValueArrayType [TOutputImage::ImageDimension]
typedef SizeType::SizeValueType	SizeValueType
typedef TOutputImage::SpacingType	SpacingType
typedef SpacingValueType	SpacingValueArrayType [TOutputImage::ImageDimension]
typedef TOutputImage::SpacingValueType	SpacingValueType
typedef ImageSource< TOutputImage >	Superclass
Public Types inherited from itk::ImageSource< TOutputImage >
typedef Superclass::DataObjectIdentifierType	DataObjectIdentifierType
typedef DataObject::Pointer	DataObjectPointer
typedef Superclass::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType
typedef OutputImageType::Pointer	OutputImagePointer
typedef TOutputImage	OutputImageType
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 OutputImagePixelType	GetMin () const
virtual const char *	GetNameOfClass () const
virtual const PointValueType *	GetOrigin () const
virtual const SizeValueType *	GetSize () const
virtual const SpacingValueType *	GetSpacing () const
virtual void	SetMax (OutputImagePixelType _arg)
virtual void	SetMin (OutputImagePixelType _arg)
virtual void	SetSize (SizeType _arg)
virtual void	SetSize (SizeValueArrayType sizeArray)
virtual void	SetSpacing (SpacingType _arg)
virtual void	SetSpacing (SpacingValueArrayType spacingArray)
virtual void	SetOrigin (PointType _arg)
virtual void	SetOrigin (PointValueArrayType originArray)
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	GenerateOutputInformation ()
virtual void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void	AfterThreadedGenerateData ()
virtual void	AllocateOutputs ()
virtual void	BeforeThreadedGenerateData ()
virtual void	GenerateData ()
	ImageSource ()
virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int num, OutputImageRegionType &splitRegion)
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	GenerateInputRequestedRegion ()
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	ReleaseInputs ()
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	VerifyInputInformation ()
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
virtual void	PushBackInput (const DataObject *input)
virtual void	PopBackInput ()
virtual void	PushFrontInput (const DataObject *input)
virtual void	PopFrontInput ()
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
void	operator= (const RandomImageSource &)
	RandomImageSource (const RandomImageSource &)

Private Attributes
TOutputImage::PixelType	m_Max
TOutputImage::PixelType	m_Min
PointType	m_Origin
PointValueArrayType	m_OriginArray
SizeType	m_Size
SpacingType	m_Spacing
SpacingValueArrayType	m_SpacingArray
virtual OutputImagePixelType	GetMax () const
	RandomImageSource ()
	~RandomImageSource ()
void	PrintSelf (std::ostream &os, Indent indent) const

Additional Inherited Members
Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static const unsigned int	OutputImageDimension = TOutputImage::ImageDimension
Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static ITK_THREAD_RETURN_TYPE	ThreaderCallback (void *arg)

---

Detailed Description

template<typename TOutputImage>
class itk::RandomImageSource< TOutputImage >

Generate an n-dimensional image of random pixel values.

RandomImageSource generates an image of random pixel values. This filter uses an inline random number generator since the library drand48, although thread-safe, is very slow in a threaded environment. The output image may be of any dimension. NOTE: To produce deterministic results, set the number of threads to 1.

Wiki Examples:

• All Examples

• Produce an image of noise

Definition at line 54 of file itkRandomImageSource.h.

---

Member Typedef Documentation

template<typename TOutputImage >

typedef SmartPointer< const Self > itk::RandomImageSource< TOutputImage >::ConstPointer

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 61 of file itkRandomImageSource.h.

template<typename TOutputImage >

typedef TOutputImage::IndexType itk::RandomImageSource< TOutputImage >::IndexType

Definition at line 77 of file itkRandomImageSource.h.

template<typename TOutputImage >

typedef TOutputImage::PixelType itk::RandomImageSource< TOutputImage >::OutputImagePixelType

Typedef for the output image PixelType.

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 64 of file itkRandomImageSource.h.

template<typename TOutputImage >

typedef TOutputImage::RegionType itk::RandomImageSource< TOutputImage >::OutputImageRegionType

Typedef to describe the output image region type.

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 67 of file itkRandomImageSource.h.

template<typename TOutputImage >

typedef SmartPointer< Self > itk::RandomImageSource< TOutputImage >::Pointer

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 60 of file itkRandomImageSource.h.

template<typename TOutputImage >

typedef TOutputImage::PointType itk::RandomImageSource< TOutputImage >::PointType

Definition at line 79 of file itkRandomImageSource.h.

template<typename TOutputImage >

typedef PointValueType itk::RandomImageSource< TOutputImage >::PointValueArrayType[TOutputImage::ImageDimension]

Definition at line 85 of file itkRandomImageSource.h.

template<typename TOutputImage >

typedef TOutputImage::PointValueType itk::RandomImageSource< TOutputImage >::PointValueType

Definition at line 84 of file itkRandomImageSource.h.

template<typename TOutputImage >

typedef RandomImageSource itk::RandomImageSource< TOutputImage >::Self

Standard class typedefs.

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 58 of file itkRandomImageSource.h.

template<typename TOutputImage >

typedef TOutputImage::SizeType itk::RandomImageSource< TOutputImage >::SizeType

Basic types from the OutputImageType

Definition at line 73 of file itkRandomImageSource.h.

template<typename TOutputImage >

typedef SizeValueType itk::RandomImageSource< TOutputImage >::SizeValueArrayType[TOutputImage::ImageDimension]

Definition at line 81 of file itkRandomImageSource.h.

template<typename TOutputImage >

typedef SizeType::SizeValueType itk::RandomImageSource< TOutputImage >::SizeValueType

Definition at line 80 of file itkRandomImageSource.h.

template<typename TOutputImage >

typedef TOutputImage::SpacingType itk::RandomImageSource< TOutputImage >::SpacingType

Definition at line 78 of file itkRandomImageSource.h.

template<typename TOutputImage >

typedef SpacingValueType itk::RandomImageSource< TOutputImage >::SpacingValueArrayType[TOutputImage::ImageDimension]

Definition at line 83 of file itkRandomImageSource.h.

template<typename TOutputImage >

typedef TOutputImage::SpacingValueType itk::RandomImageSource< TOutputImage >::SpacingValueType

Definition at line 82 of file itkRandomImageSource.h.

template<typename TOutputImage >

typedef ImageSource< TOutputImage > itk::RandomImageSource< TOutputImage >::Superclass

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 59 of file itkRandomImageSource.h.

---

Constructor & Destructor Documentation

template<typename TOutputImage >

itk::RandomImageSource< TOutputImage >::RandomImageSource ( )

protected

Get the maximum possible pixel value.

template<typename TOutputImage >

itk::RandomImageSource< TOutputImage >::~RandomImageSource ( )

protected

Get the maximum possible pixel value.

template<typename TOutputImage >

itk::RandomImageSource< TOutputImage >::RandomImageSource ( const RandomImageSource< TOutputImage > &  )

private

---

Member Function Documentation

template<typename TOutputImage >

virtual::itk::LightObject::Pointer itk::RandomImageSource< TOutputImage >::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<typename TOutputImage >

virtual void itk::RandomImageSource< TOutputImage >::GenerateOutputInformation ( )

protectedvirtual

Generate the information describing the output data. The default implementation of this method will copy information from the input to the output. A filter may override this method if its output will have different information than its input. For instance, a filter that shrinks an image will need to provide an implementation for this method that changes the spacing of the pixels. Such filters should call their superclass' implementation of this method prior to changing the information values they need (i.e. GenerateOutputInformation() should call Superclass::GenerateOutputInformation() prior to changing the information.

Reimplemented from itk::ProcessObject.

template<typename TOutputImage >

virtual OutputImagePixelType itk::RandomImageSource< TOutputImage >::GetMax ( ) const

virtual

Get the maximum possible pixel value.

template<typename TOutputImage >

virtual OutputImagePixelType itk::RandomImageSource< TOutputImage >::GetMin ( ) const

virtual

Get the minimum possible pixel value.

template<typename TOutputImage >

virtual const char* itk::RandomImageSource< TOutputImage >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageSource< TOutputImage >.

template<typename TOutputImage >

virtual const PointValueType* itk::RandomImageSource< TOutputImage >::GetOrigin ( ) const

virtual

template<typename TOutputImage >

virtual const SizeValueType* itk::RandomImageSource< TOutputImage >::GetSize ( ) const

virtual

template<typename TOutputImage >

virtual const SpacingValueType* itk::RandomImageSource< TOutputImage >::GetSpacing ( ) const

virtual

template<typename TOutputImage >

static Pointer itk::RandomImageSource< TOutputImage >::New ( )

static

Method for creation through the object factory.

Reimplemented from itk::Object.

template<typename TOutputImage >

void itk::RandomImageSource< TOutputImage >::operator= ( const RandomImageSource< TOutputImage > &  )

private

template<typename TOutputImage >

void itk::RandomImageSource< TOutputImage >::PrintSelf ( std::ostream &  os, Indent  indent  ) const

protectedvirtual

Get the maximum possible pixel value.

Reimplemented from itk::ProcessObject.

template<typename TOutputImage >

virtual void itk::RandomImageSource< TOutputImage >::SetMax ( OutputImagePixelType  _arg )

virtual

Set the maximum possible pixel value. By default, it is NumericTraits<TOutputImage::PixelType>::max().

template<typename TOutputImage >

virtual void itk::RandomImageSource< TOutputImage >::SetMin ( OutputImagePixelType  _arg )

virtual

Set the minimum possible pixel value. By default, it is NumericTraits<TOutputImage::PixelType>::min().

template<typename TOutputImage >

virtual void itk::RandomImageSource< TOutputImage >::SetOrigin ( PointType  _arg )

virtual

Set/Get origin of the output image

template<typename TOutputImage >

virtual void itk::RandomImageSource< TOutputImage >::SetOrigin ( PointValueArrayType  originArray )

virtual

Set/Get origin of the output image

template<typename TOutputImage >

virtual void itk::RandomImageSource< TOutputImage >::SetSize ( SizeType  _arg )

virtual

Set/Get size of the output image

template<typename TOutputImage >

virtual void itk::RandomImageSource< TOutputImage >::SetSize ( SizeValueArrayType  sizeArray )

virtual

Set/Get size of the output image

template<typename TOutputImage >

virtual void itk::RandomImageSource< TOutputImage >::SetSpacing ( SpacingType  _arg )

virtual

Set/Get spacing of the output image

template<typename TOutputImage >

virtual void itk::RandomImageSource< TOutputImage >::SetSpacing ( SpacingValueArrayType  spacingArray )

virtual

Set/Get spacing of the output image

template<typename TOutputImage >

virtual void itk::RandomImageSource< TOutputImage >::ThreadedGenerateData ( const OutputImageRegionType &  outputRegionForThread, ThreadIdType  threadId  )

protectedvirtual

If an imaging filter can be implemented as a multithreaded algorithm, the filter will provide an implementation of ThreadedGenerateData(). This superclass will automatically split the output image into a number of pieces, spawn multiple threads, and call ThreadedGenerateData() in each thread. Prior to spawning threads, the BeforeThreadedGenerateData() method is called. After all the threads have completed, the AfterThreadedGenerateData() method is called. If an image processing filter cannot support threading, that filter should provide an implementation of the GenerateData() method instead of providing an implementation of ThreadedGenerateData(). If a filter provides a GenerateData() method as its implementation, then the filter is responsible for allocating the output data. If a filter provides a ThreadedGenerateData() method as its implementation, then the output memory will allocated automatically by this superclass. The ThreadedGenerateData() method should only produce the output specified by "outputThreadRegion" parameter. ThreadedGenerateData() cannot write to any other portion of the output image (as this is responsibility of a different thread).

See also:

GenerateData(), SplitRequestedRegion()

Reimplemented from itk::ImageSource< TOutputImage >.

---

Member Data Documentation

template<typename TOutputImage >

TOutputImage::PixelType itk::RandomImageSource< TOutputImage >::m_Max

private

Definition at line 146 of file itkRandomImageSource.h.

template<typename TOutputImage >

TOutputImage::PixelType itk::RandomImageSource< TOutputImage >::m_Min

private

Definition at line 145 of file itkRandomImageSource.h.

template<typename TOutputImage >

PointType itk::RandomImageSource< TOutputImage >::m_Origin

private

Definition at line 143 of file itkRandomImageSource.h.

template<typename TOutputImage >

PointValueArrayType itk::RandomImageSource< TOutputImage >::m_OriginArray

mutableprivate

Definition at line 150 of file itkRandomImageSource.h.

template<typename TOutputImage >

SizeType itk::RandomImageSource< TOutputImage >::m_Size

private

Definition at line 141 of file itkRandomImageSource.h.

template<typename TOutputImage >

SpacingType itk::RandomImageSource< TOutputImage >::m_Spacing

private

Definition at line 142 of file itkRandomImageSource.h.

template<typename TOutputImage >

SpacingValueArrayType itk::RandomImageSource< TOutputImage >::m_SpacingArray

mutableprivate

Definition at line 151 of file itkRandomImageSource.h.

---

The documentation for this class was generated from the following file:

• itkRandomImageSource.h