ITK  4.1.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes
itk::RandomImageSource< TOutputImage > Class Template Reference
Data Sources | MultiThreaded Filters | Module ITKTestKernel

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

Static Public Member Functions

static Pointer New ()

Protected Member Functions

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

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

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:

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 ( ) [protected, virtual]

Generate the information decribing 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 [protected, virtual]

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 
) [protected, virtual]

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 [mutable, private]

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 [mutable, private]

Definition at line 151 of file itkRandomImageSource.h.

The documentation for this class was generated from the following file:
Generated on Fri Mar 2 2012 01:22:00 for ITK by doxygen 1.7.6.1