RTK  2.5.0
Reconstruction Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
rtk::ConstantImageSource< TOutputImage > Class Template Reference

#include <rtkConstantImageSource.h>

+ Inheritance diagram for rtk::ConstantImageSource< TOutputImage >:
+ Collaboration diagram for rtk::ConstantImageSource< TOutputImage >:

Public Types

using ConstPointer = itk::SmartPointer< const Self >
 
using DirectionType = typename TOutputImage::DirectionType
 
using IndexType = typename TOutputImage::IndexType
 
using OutputImagePixelType = typename TOutputImage::PixelType
 
using OutputImageRegionType = typename TOutputImage::RegionType
 
using OutputImageType = TOutputImage
 
using Pointer = itk::SmartPointer< Self >
 
using PointType = typename TOutputImage::PointType
 
typedef PointValueType PointValueArrayType[TOutputImage::ImageDimension]
 
using PointValueType = typename TOutputImage::PointValueType
 
using Self = ConstantImageSource
 
using SizeType = typename TOutputImage::SizeType
 
typedef SizeValueType SizeValueArrayType[TOutputImage::ImageDimension]
 
using SizeValueType = typename SizeType::SizeValueType
 
using SpacingType = typename TOutputImage::SpacingType
 
typedef SpacingValueType SpacingValueArrayType[TOutputImage::ImageDimension]
 
using SpacingValueType = typename TOutputImage::SpacingValueType
 
using Superclass = itk::ImageSource< TOutputImage >
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother () const
 
void SetInformationFromImage (const itk::ImageBase< TOutputImage::ImageDimension > *image)
 
virtual const char * GetNameOfClass () const
 
virtual void SetSize (SizeType _arg)
 
virtual SizeType GetSize ()
 
virtual void SetSize (SizeValueArrayType sizeArray)
 
virtual const SizeValueTypeGetSize () const
 
virtual void SetSpacing (SpacingType _arg)
 
virtual SpacingType GetSpacing ()
 
virtual void SetOrigin (PointType _arg)
 
virtual PointType GetOrigin ()
 
virtual void SetDirection (DirectionType _arg)
 
virtual DirectionType GetDirection ()
 
virtual void SetIndex (IndexType _arg)
 
virtual IndexType GetIndex ()
 
virtual void SetConstant (OutputImagePixelType _arg)
 
virtual OutputImagePixelType GetConstant () const
 

Static Public Member Functions

static Pointer New ()
 

Protected Member Functions

 ConstantImageSource ()
 
void DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread) override
 
void GenerateOutputInformation () override
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
 ~ConstantImageSource () override
 

Protected Attributes

OutputImagePixelType m_Constant
 
DirectionType m_Direction
 
IndexType m_Index
 
PointType m_Origin
 
SizeType m_Size
 
SpacingType m_Spacing
 

Detailed Description

template<typename TOutputImage>
class rtk::ConstantImageSource< TOutputImage >

Generate an n-dimensional image with constant pixel values.

ConstantImageSource generates an image with constant value. The filter is useful to allow streaming of large images with a constant source, e.g., a tomography reconstructed with a filtered backprojection algorithm.

Test:
rtkRaycastInterpolatorForwardProjectionTest.cxx, rtkprojectgeometricphantomtest.cxx, rtkfdktest.cxx, rtksarttest.cxx, rtkrampfiltertest.cxx, rtkamsterdamshroudtest.cxx, rtkdrawgeometricphantomtest.cxx, rtkmotioncompensatedfdktest.cxx, rtkfovtest.cxx, rtkforwardprojectiontest.cxx, rtkdisplaceddetectortest.cxx, rtkshortscantest.cxx
Author
Simon Rit

Definition at line 51 of file rtkConstantImageSource.h.

Member Typedef Documentation

◆ ConstPointer

template<typename TOutputImage >
using rtk::ConstantImageSource< TOutputImage >::ConstPointer = itk::SmartPointer<const Self>

Definition at line 60 of file rtkConstantImageSource.h.

◆ DirectionType

template<typename TOutputImage >
using rtk::ConstantImageSource< TOutputImage >::DirectionType = typename TOutputImage::DirectionType

Definition at line 93 of file rtkConstantImageSource.h.

◆ IndexType

template<typename TOutputImage >
using rtk::ConstantImageSource< TOutputImage >::IndexType = typename TOutputImage::IndexType

Definition at line 84 of file rtkConstantImageSource.h.

◆ OutputImagePixelType

template<typename TOutputImage >
using rtk::ConstantImageSource< TOutputImage >::OutputImagePixelType = typename TOutputImage::PixelType

Typedefs for the output image PixelType.

Definition at line 66 of file rtkConstantImageSource.h.

◆ OutputImageRegionType

template<typename TOutputImage >
using rtk::ConstantImageSource< TOutputImage >::OutputImageRegionType = typename TOutputImage::RegionType

Typedef to describe the output image region type.

Definition at line 69 of file rtkConstantImageSource.h.

◆ OutputImageType

template<typename TOutputImage >
using rtk::ConstantImageSource< TOutputImage >::OutputImageType = TOutputImage

Typedef for the output image type.

Definition at line 63 of file rtkConstantImageSource.h.

◆ Pointer

template<typename TOutputImage >
using rtk::ConstantImageSource< TOutputImage >::Pointer = itk::SmartPointer<Self>

Definition at line 59 of file rtkConstantImageSource.h.

◆ PointType

template<typename TOutputImage >
using rtk::ConstantImageSource< TOutputImage >::PointType = typename TOutputImage::PointType

Definition at line 86 of file rtkConstantImageSource.h.

◆ PointValueArrayType

template<typename TOutputImage >
typedef PointValueType rtk::ConstantImageSource< TOutputImage >::PointValueArrayType[TOutputImage::ImageDimension]

Definition at line 92 of file rtkConstantImageSource.h.

◆ PointValueType

template<typename TOutputImage >
using rtk::ConstantImageSource< TOutputImage >::PointValueType = typename TOutputImage::PointValueType

Definition at line 91 of file rtkConstantImageSource.h.

◆ Self

template<typename TOutputImage >
using rtk::ConstantImageSource< TOutputImage >::Self = ConstantImageSource

Standard class type alias.

Definition at line 57 of file rtkConstantImageSource.h.

◆ SizeType

template<typename TOutputImage >
using rtk::ConstantImageSource< TOutputImage >::SizeType = typename TOutputImage::SizeType

Basic types from the OutputImageType

Definition at line 83 of file rtkConstantImageSource.h.

◆ SizeValueArrayType

template<typename TOutputImage >
typedef SizeValueType rtk::ConstantImageSource< TOutputImage >::SizeValueArrayType[TOutputImage::ImageDimension]

Definition at line 88 of file rtkConstantImageSource.h.

◆ SizeValueType

template<typename TOutputImage >
using rtk::ConstantImageSource< TOutputImage >::SizeValueType = typename SizeType::SizeValueType

Definition at line 87 of file rtkConstantImageSource.h.

◆ SpacingType

template<typename TOutputImage >
using rtk::ConstantImageSource< TOutputImage >::SpacingType = typename TOutputImage::SpacingType

Definition at line 85 of file rtkConstantImageSource.h.

◆ SpacingValueArrayType

template<typename TOutputImage >
typedef SpacingValueType rtk::ConstantImageSource< TOutputImage >::SpacingValueArrayType[TOutputImage::ImageDimension]

Definition at line 90 of file rtkConstantImageSource.h.

◆ SpacingValueType

template<typename TOutputImage >
using rtk::ConstantImageSource< TOutputImage >::SpacingValueType = typename TOutputImage::SpacingValueType

Definition at line 89 of file rtkConstantImageSource.h.

◆ Superclass

template<typename TOutputImage >
using rtk::ConstantImageSource< TOutputImage >::Superclass = itk::ImageSource<TOutputImage>

Definition at line 58 of file rtkConstantImageSource.h.

Constructor & Destructor Documentation

◆ ConstantImageSource()

template<typename TOutputImage >
rtk::ConstantImageSource< TOutputImage >::ConstantImageSource ( )
protected

◆ ~ConstantImageSource()

template<typename TOutputImage >
rtk::ConstantImageSource< TOutputImage >::~ConstantImageSource ( )
overrideprotected

Member Function Documentation

◆ CreateAnother()

template<typename TOutputImage >
virtual::itk::LightObject::Pointer rtk::ConstantImageSource< TOutputImage >::CreateAnother ( ) const
virtual

Reimplemented from itk::Object.

◆ DynamicThreadedGenerateData()

template<typename TOutputImage >
void rtk::ConstantImageSource< TOutputImage >::DynamicThreadedGenerateData ( const OutputImageRegionType outputRegionForThread)
overrideprotectedvirtual

Reimplemented from itk::ImageSource< TOutputImage >.

◆ GenerateOutputInformation()

template<typename TOutputImage >
void rtk::ConstantImageSource< TOutputImage >::GenerateOutputInformation ( )
overrideprotectedvirtual

Reimplemented from itk::ProcessObject.

◆ GetConstant()

template<typename TOutputImage >
virtual OutputImagePixelType rtk::ConstantImageSource< TOutputImage >::GetConstant ( ) const
virtual

Set/Get the pixel value of output

◆ GetDirection()

template<typename TOutputImage >
virtual DirectionType rtk::ConstantImageSource< TOutputImage >::GetDirection ( )
virtual

Set/Get direction of the output image

◆ GetIndex()

template<typename TOutputImage >
virtual IndexType rtk::ConstantImageSource< TOutputImage >::GetIndex ( )
virtual

Set/Get index of the output image's largest possible region

◆ GetNameOfClass()

template<typename TOutputImage >
virtual const char* rtk::ConstantImageSource< TOutputImage >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageSource< TOutputImage >.

◆ GetOrigin()

template<typename TOutputImage >
virtual PointType rtk::ConstantImageSource< TOutputImage >::GetOrigin ( )
virtual

Set/Get origin of the output image

◆ GetSize() [1/2]

template<typename TOutputImage >
virtual SizeType rtk::ConstantImageSource< TOutputImage >::GetSize ( )
virtual

Set/Get size of the output image

◆ GetSize() [2/2]

template<typename TOutputImage >
virtual const SizeValueType* rtk::ConstantImageSource< TOutputImage >::GetSize ( ) const
virtual

Set/Get size of the output image

◆ GetSpacing()

template<typename TOutputImage >
virtual SpacingType rtk::ConstantImageSource< TOutputImage >::GetSpacing ( )
virtual

Set/Get spacing of the output image

◆ New()

template<typename TOutputImage >
static Pointer rtk::ConstantImageSource< TOutputImage >::New ( )
static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TOutputImage >
void rtk::ConstantImageSource< TOutputImage >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
overrideprotectedvirtual

Reimplemented from itk::ImageSource< TOutputImage >.

◆ SetConstant()

template<typename TOutputImage >
virtual void rtk::ConstantImageSource< TOutputImage >::SetConstant ( OutputImagePixelType  _arg)
virtual

Set/Get the pixel value of output

◆ SetDirection()

template<typename TOutputImage >
virtual void rtk::ConstantImageSource< TOutputImage >::SetDirection ( DirectionType  _arg)
virtual

Set/Get direction of the output image

◆ SetIndex()

template<typename TOutputImage >
virtual void rtk::ConstantImageSource< TOutputImage >::SetIndex ( IndexType  _arg)
virtual

Set/Get index of the output image's largest possible region

◆ SetInformationFromImage()

template<typename TOutputImage >
void rtk::ConstantImageSource< TOutputImage >::SetInformationFromImage ( const itk::ImageBase< TOutputImage::ImageDimension > *  image)

Set output image information from an existing image

◆ SetOrigin()

template<typename TOutputImage >
virtual void rtk::ConstantImageSource< TOutputImage >::SetOrigin ( PointType  _arg)
virtual

Set/Get origin of the output image

◆ SetSize() [1/2]

template<typename TOutputImage >
virtual void rtk::ConstantImageSource< TOutputImage >::SetSize ( SizeType  _arg)
virtual

Set/Get size of the output image

◆ SetSize() [2/2]

template<typename TOutputImage >
virtual void rtk::ConstantImageSource< TOutputImage >::SetSize ( SizeValueArrayType  sizeArray)
virtual

Set/Get size of the output image

◆ SetSpacing()

template<typename TOutputImage >
virtual void rtk::ConstantImageSource< TOutputImage >::SetSpacing ( SpacingType  _arg)
virtual

Set/Get spacing of the output image

Member Data Documentation

◆ m_Constant

template<typename TOutputImage >
OutputImagePixelType rtk::ConstantImageSource< TOutputImage >::m_Constant
protected

Definition at line 151 of file rtkConstantImageSource.h.

◆ m_Direction

template<typename TOutputImage >
DirectionType rtk::ConstantImageSource< TOutputImage >::m_Direction
protected

Definition at line 148 of file rtkConstantImageSource.h.

◆ m_Index

template<typename TOutputImage >
IndexType rtk::ConstantImageSource< TOutputImage >::m_Index
protected

Definition at line 149 of file rtkConstantImageSource.h.

◆ m_Origin

template<typename TOutputImage >
PointType rtk::ConstantImageSource< TOutputImage >::m_Origin
protected

Definition at line 147 of file rtkConstantImageSource.h.

◆ m_Size

template<typename TOutputImage >
SizeType rtk::ConstantImageSource< TOutputImage >::m_Size
protected

Definition at line 145 of file rtkConstantImageSource.h.

◆ m_Spacing

template<typename TOutputImage >
SpacingType rtk::ConstantImageSource< TOutputImage >::m_Spacing
protected

Definition at line 146 of file rtkConstantImageSource.h.


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