ITK  4.1.0
Insight Segmentation and Registration Toolkit
Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Member Functions | Private Attributes
itk::TileImageFilter< TInputImage, TOutputImage > Class Template Reference

#include <itkTileImageFilter.h>

+ Inheritance diagram for itk::TileImageFilter< TInputImage, TOutputImage >:
+ Collaboration diagram for itk::TileImageFilter< TInputImage, TOutputImage >:

List of all members.

Classes

class  TileInfo

Public Types

typedef SmartPointer< const SelfConstPointer
typedef TInputImage::Pointer InputImagePointer
typedef TInputImage::RegionType InputImageRegionType
typedef TInputImage::IndexType InputIndexType
typedef TInputImage::PixelType InputPixelType
typedef TInputImage::SizeType InputSizeType
typedef FixedArray< unsigned
int, itkGetStaticConstMacro(OutputImageDimension) > 
LayoutArrayType
typedef TOutputImage::Pointer OutputImagePointer
typedef TOutputImage::RegionType OutputImageRegionType
typedef TOutputImage::IndexType OutputIndexType
typedef TOutputImage::PixelType OutputPixelType
typedef TOutputImage::SizeType OutputSizeType
typedef SmartPointer< SelfPointer
typedef TileImageFilter Self
typedef ImageToImageFilter
< TInputImage, TOutputImage > 
Superclass
typedef Image< TileInfo,
itkGetStaticConstMacro(OutputImageDimension) > 
TileImageType

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
virtual const char * GetNameOfClass () const
 itkConceptMacro (OutputEqualityComparableCheck,(Concept::EqualityComparable< OutputPixelType >))
 itkConceptMacro (SameTypeCheck,(Concept::SameType< InputPixelType, OutputPixelType >))
 itkConceptMacro (OutputOStreamWritableCheck,(Concept::OStreamWritable< OutputPixelType >))
 itkGetConstMacro (DefaultPixelValue, OutputPixelType)
 itkSetMacro (DefaultPixelValue, OutputPixelType)
 itkStaticConstMacro (InputImageDimension, unsigned int, TInputImage::ImageDimension)
 itkStaticConstMacro (OutputImageDimension, unsigned int, TOutputImage::ImageDimension)
 itkSetMacro (Layout, LayoutArrayType)
 itkGetConstMacro (Layout, LayoutArrayType)

Static Public Member Functions

static Pointer New ()

Static Public Attributes

static const unsigned int InputImageDimension = TInputImage::ImageDimension
static const unsigned int OutputImageDimension = TOutputImage::ImageDimension

Protected Member Functions

void GenerateData ()
void GenerateInputRequestedRegion ()
void GenerateOutputInformation ()
void PrintSelf (std::ostream &os, Indent indent) const
 TileImageFilter ()
virtual void VerifyInputInformation ()

Private Member Functions

void operator= (const Self &)
 TileImageFilter (const Self &)

Private Attributes

OutputPixelType m_DefaultPixelValue
LayoutArrayType m_Layout
TileImageType::Pointer m_TileImage

Detailed Description

template<class TInputImage, class TOutputImage>
class itk::TileImageFilter< TInputImage, TOutputImage >

Tile multiple input images into a single output image.

This filter will tile multiple images using a user-specified layout. The tile sizes will be large enough to accommodate the largest image for each tile. The layout is specified with the SetLayout method. The layout has the same dimension as the output image. If all entries of the layout are positive, the tiled output will contain the exact number of tiles. If the layout contains a 0 in the last dimension, the filter will compute a size that will accommodate all of the images. Empty tiles are filled with the value specified with the SetDefault value method. The input images must have a dimension less than or equal to the output image. The output image have a larger dimension than the input images. This filter can be used to create a volume from a series of inputs by specifying a layout of 1,1,0.

Wiki Examples:

Definition at line 52 of file itkTileImageFilter.h.


Member Typedef Documentation

template<class TInputImage , class TOutputImage >
typedef SmartPointer< const Self > itk::TileImageFilter< TInputImage, TOutputImage >::ConstPointer

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Definition at line 60 of file itkTileImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef TInputImage::Pointer itk::TileImageFilter< TInputImage, TOutputImage >::InputImagePointer

Image related typedefs.

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Definition at line 73 of file itkTileImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef TInputImage::RegionType itk::TileImageFilter< TInputImage, TOutputImage >::InputImageRegionType

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Definition at line 78 of file itkTileImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef TInputImage::IndexType itk::TileImageFilter< TInputImage, TOutputImage >::InputIndexType

Definition at line 77 of file itkTileImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef TInputImage::PixelType itk::TileImageFilter< TInputImage, TOutputImage >::InputPixelType

Image pixel value typedef.

Definition at line 66 of file itkTileImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef TInputImage::SizeType itk::TileImageFilter< TInputImage, TOutputImage >::InputSizeType

Definition at line 76 of file itkTileImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef FixedArray< unsigned int, itkGetStaticConstMacro(OutputImageDimension) > itk::TileImageFilter< TInputImage, TOutputImage >::LayoutArrayType

LayoutArray type.

Definition at line 110 of file itkTileImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef TOutputImage::Pointer itk::TileImageFilter< TInputImage, TOutputImage >::OutputImagePointer

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 74 of file itkTileImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef TOutputImage::RegionType itk::TileImageFilter< TInputImage, TOutputImage >::OutputImageRegionType

Superclass typedefs.

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Definition at line 81 of file itkTileImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef TOutputImage::IndexType itk::TileImageFilter< TInputImage, TOutputImage >::OutputIndexType

Definition at line 80 of file itkTileImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef TOutputImage::PixelType itk::TileImageFilter< TInputImage, TOutputImage >::OutputPixelType

Definition at line 70 of file itkTileImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef TOutputImage::SizeType itk::TileImageFilter< TInputImage, TOutputImage >::OutputSizeType

Definition at line 79 of file itkTileImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef SmartPointer< Self > itk::TileImageFilter< TInputImage, TOutputImage >::Pointer

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Definition at line 59 of file itkTileImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef TileImageFilter itk::TileImageFilter< TInputImage, TOutputImage >::Self

Standard Self typedef

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Definition at line 57 of file itkTileImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef ImageToImageFilter< TInputImage, TOutputImage > itk::TileImageFilter< TInputImage, TOutputImage >::Superclass

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Definition at line 58 of file itkTileImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef Image< TileInfo, itkGetStaticConstMacro(OutputImageDimension) > itk::TileImageFilter< TInputImage, TOutputImage >::TileImageType

Definition at line 107 of file itkTileImageFilter.h.


Constructor & Destructor Documentation

template<class TInputImage , class TOutputImage >
itk::TileImageFilter< TInputImage, TOutputImage >::TileImageFilter ( ) [protected]

End concept checking

template<class TInputImage , class TOutputImage >
itk::TileImageFilter< TInputImage, TOutputImage >::TileImageFilter ( const Self ) [private]

Member Function Documentation

template<class TInputImage , class TOutputImage >
virtual::itk::LightObject::Pointer itk::TileImageFilter< TInputImage, 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<class TInputImage , class TOutputImage >
void itk::TileImageFilter< TInputImage, TOutputImage >::GenerateData ( ) [protected, virtual]

A version of GenerateData() specific for image processing filters. This implementation will split the processing across multiple threads. The buffer is allocated by this method. Then the BeforeThreadedGenerateData() method is called (if provided). Then, a series of threads are spawned each calling ThreadedGenerateData(). After all the threads have completed processing, the AfterThreadedGenerateData() method is called (if provided). If an image processing filter cannot be threaded, the filter should provide an implementation of GenerateData(). That implementation is responsible for allocating the output buffer. If a filter an be threaded, it should NOT provide a GenerateData() method but should provide a ThreadedGenerateData() instead.

See also:
ThreadedGenerateData()

Reimplemented from itk::ImageSource< TOutputImage >.

template<class TInputImage , class TOutputImage >
void itk::TileImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion ( ) [protected, virtual]

What is the input requested region that is required to produce the output requested region? The base assumption for image processing filters is that the input requested region can be set to match the output requested region. If a filter requires more input (for instance a filter that uses neighborhoods needs more input than output to avoid introducing artificial boundary conditions) or less input (for instance a magnify filter) will have to override this method. In doing so, it should call its superclass' implementation as its first step. Note that imaging filters operate differently than the classes to this point in the class hierachy. Up till now, the base assumption has been that the largest possible region will be requested of the input.

This implementation of GenerateInputRequestedRegion() only processes the inputs that are a subclass of the ImageBase<InputImageDimension>. If an input is another type of DataObject (including an Image of a different dimension), they are skipped by this method. The subclasses of ImageToImageFilter are responsible for providing an implementation of GenerateInputRequestedRegion() when there are multiple inputs of different types.

See also:
ProcessObject::GenerateInputRequestedRegion(), ImageSource::GenerateInputRequestedRegion()

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

template<class TInputImage , class TOutputImage >
void itk::TileImageFilter< TInputImage, 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<class TInputImage , class TOutputImage >
virtual const char* itk::TileImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const [virtual]

Runtime information support.

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

template<class TInputImage , class TOutputImage >
itk::TileImageFilter< TInputImage, TOutputImage >::itkConceptMacro ( OutputEqualityComparableCheck  ,
(Concept::EqualityComparable< OutputPixelType >)   
)

Begin concept checking

template<class TInputImage , class TOutputImage >
itk::TileImageFilter< TInputImage, TOutputImage >::itkConceptMacro ( SameTypeCheck  ,
(Concept::SameType< InputPixelType, OutputPixelType >)   
)
template<class TInputImage , class TOutputImage >
itk::TileImageFilter< TInputImage, TOutputImage >::itkConceptMacro ( OutputOStreamWritableCheck  ,
(Concept::OStreamWritable< OutputPixelType >)   
)
template<class TInputImage , class TOutputImage >
itk::TileImageFilter< TInputImage, TOutputImage >::itkGetConstMacro ( Layout  ,
LayoutArrayType   
)

Set/Get the layout of the tiles. If the last Layout value is 0, the filter will compute a value that will acoomodate all of the images.

template<class TInputImage , class TOutputImage >
itk::TileImageFilter< TInputImage, TOutputImage >::itkGetConstMacro ( DefaultPixelValue  ,
OutputPixelType   
)

Get the pixel value for locations that are not covered by an input image.

template<class TInputImage , class TOutputImage >
itk::TileImageFilter< TInputImage, TOutputImage >::itkSetMacro ( Layout  ,
LayoutArrayType   
)

Set/Get the layout of the tiles. If the last Layout value is 0, the filter will compute a value that will acoomodate all of the images.

template<class TInputImage , class TOutputImage >
itk::TileImageFilter< TInputImage, TOutputImage >::itkSetMacro ( DefaultPixelValue  ,
OutputPixelType   
)

Set the pixel value for locations that are not covered by an input image. The default default pixel value is Zero.

template<class TInputImage , class TOutputImage >
itk::TileImageFilter< TInputImage, TOutputImage >::itkStaticConstMacro ( InputImageDimension  ,
unsigned  int,
TInputImage::ImageDimension   
)
template<class TInputImage , class TOutputImage >
itk::TileImageFilter< TInputImage, TOutputImage >::itkStaticConstMacro ( OutputImageDimension  ,
unsigned  int,
TOutputImage::ImageDimension   
)
template<class TInputImage , class TOutputImage >
static Pointer itk::TileImageFilter< TInputImage, TOutputImage >::New ( ) [static]

Method for creation through the object factory.

Reimplemented from itk::Object.

template<class TInputImage , class TOutputImage >
void itk::TileImageFilter< TInputImage, TOutputImage >::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::ImageToImageFilter< TInputImage, TOutputImage >.

template<class TInputImage , class TOutputImage >
void itk::TileImageFilter< TInputImage, TOutputImage >::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::ImageToImageFilter< TInputImage, TOutputImage >.

template<class TInputImage , class TOutputImage >
virtual void itk::TileImageFilter< TInputImage, TOutputImage >::VerifyInputInformation ( ) [inline, protected, virtual]

Override VeriyInputInformation() since this filter's inputs do not need to occoupy the same physical space.

See also:
ProcessObject::VerifyInputInformation

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Definition at line 155 of file itkTileImageFilter.h.


Member Data Documentation

template<class TInputImage , class TOutputImage >
const unsigned int itk::TileImageFilter< TInputImage, TOutputImage >::InputImageDimension = TInputImage::ImageDimension [static]

Image related typedefs.

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Definition at line 85 of file itkTileImageFilter.h.

template<class TInputImage , class TOutputImage >
OutputPixelType itk::TileImageFilter< TInputImage, TOutputImage >::m_DefaultPixelValue [private]

Definition at line 163 of file itkTileImageFilter.h.

template<class TInputImage , class TOutputImage >
LayoutArrayType itk::TileImageFilter< TInputImage, TOutputImage >::m_Layout [private]

Definition at line 165 of file itkTileImageFilter.h.

template<class TInputImage , class TOutputImage >
TileImageType::Pointer itk::TileImageFilter< TInputImage, TOutputImage >::m_TileImage [private]

Definition at line 161 of file itkTileImageFilter.h.

template<class TInputImage , class TOutputImage >
const unsigned int itk::TileImageFilter< TInputImage, TOutputImage >::OutputImageDimension = TOutputImage::ImageDimension [static]

ImageDimension constants

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Definition at line 87 of file itkTileImageFilter.h.


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