ITK  4.9.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
itk::GenerateImageSource< TOutputImage > Class Template Reference

#include <itkGenerateImageSource.h>

+ Inheritance diagram for itk::GenerateImageSource< TOutputImage >:
+ Collaboration diagram for itk::GenerateImageSource< TOutputImage >:

Detailed Description

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

a Base class for image sources which need to have image size, and other meta-data set.

This class adds the ability for the user to set the Image's size, spacing, origin, and direction cosines. It is designed to be a base class for other image sources which generate an image, while there is no image input to the source.

Definition at line 40 of file itkGenerateImageSource.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef
OutputImageType::DirectionType 
DirectionType
 
typedef TOutputImage OutputImageType
 
typedef OutputImageType::PixelType PixelType
 
typedef SmartPointer< SelfPointer
 
typedef OutputImageType::PointType PointType
 
typedef OutputImageType::RegionType RegionType
 
typedef GenerateImageSource Self
 
typedef TOutputImage::SizeType SizeType
 
typedef TOutputImage::SizeValueType SizeValueType
 
typedef
OutputImageType::SpacingType 
SpacingType
 
typedef ImageSource< TOutputImage > Superclass
 
- Public Types inherited from itk::ImageSource< TOutputImage >
typedef SmartPointer< const SelfConstPointer
 
typedef
Superclass::DataObjectIdentifierType 
DataObjectIdentifierType
 
typedef DataObject::Pointer DataObjectPointer
 
typedef
Superclass::DataObjectPointerArraySizeType 
DataObjectPointerArraySizeType
 
typedef OutputImageType::PixelType OutputImagePixelType
 
typedef OutputImageType::Pointer OutputImagePointer
 
typedef OutputImageType::RegionType OutputImageRegionType
 
typedef TOutputImage OutputImageType
 
typedef SmartPointer< SelfPointer
 
typedef ImageSource Self
 
typedef ProcessObject Superclass
 
- Public Types inherited from itk::ProcessObject
typedef SmartPointer< const SelfConstPointer
 
typedef
DataObject::DataObjectIdentifierType 
DataObjectIdentifierType
 
typedef DataObject::Pointer DataObjectPointer
 
typedef std::vector
< DataObjectPointer
DataObjectPointerArray
 
typedef
DataObjectPointerArray::size_type 
DataObjectPointerArraySizeType
 
typedef std::vector
< DataObjectIdentifierType
NameArray
 
typedef SmartPointer< SelfPointer
 
typedef ProcessObject Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual const char * GetNameOfClass () const
 
virtual void SetSize (SizeType _arg)
 
virtual const SizeTypeGetSize () const
 
virtual void SetSize (SizeValueType data[])
 
virtual void SetSpacing (SpacingType _arg)
 
virtual const SpacingTypeGetSpacing () const
 
virtual void SetSpacing (const float data[])
 
virtual void SetOrigin (PointType _arg)
 
virtual const PointTypeGetOrigin () const
 
virtual void SetOrigin (const float data[])
 
virtual void SetDirection (DirectionType _arg)
 
virtual const DirectionTypeGetDirection () const
 
- Public Member Functions inherited from itk::ImageSource< TOutputImage >
OutputImageTypeGetOutput (unsigned int idx)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *output)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
 
OutputImageTypeGetOutput ()
 
const OutputImageTypeGetOutput () const
 
virtual void GraftOutput (DataObject *output)
 
virtual
ProcessObject::DataObjectPointer 
MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
 
virtual
ProcessObject::DataObjectPointer 
MakeOutput (const ProcessObject::DataObjectIdentifierType &) override
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreader * GetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual
DataObjectPointerArraySizeType 
GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual const float & GetProgress () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
void SetProgress (float progress)
 
virtual void SetReleaseDataFlag (bool flag)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void ReleaseDataBeforeUpdateFlagOff ()
 
virtual void SetNumberOfThreads (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfThreads () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () 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 Attributes

static const unsigned int NDimensions = TOutputImage::ImageDimension
 
- Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static const unsigned int OutputImageDimension = TOutputImage::ImageDimension
 

Protected Member Functions

 GenerateImageSource ()
 
virtual void GenerateOutputInformation () override
 
virtual void PrintSelf (std::ostream &os, Indent indent) const override
 
- Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void AfterThreadedGenerateData ()
 
virtual void AllocateOutputs ()
 
virtual void BeforeThreadedGenerateData ()
 
virtual void GenerateData () override
 
virtual const
ImageRegionSplitterBase
GetImageRegionSplitter () const
 
 ImageSource ()
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
 
virtual void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
 
virtual ~ImageSource ()
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
virtual void AddOutput (DataObject *output)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateInputRequestedRegion ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredInputs () const
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredOutputs () const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
 itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
 
 itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
 
 itkLegacyMacro (virtual void RemoveInput(DataObject *input))
 
 itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
virtual void PopBackInput ()
 
virtual void PopFrontInput ()
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PushFrontInput (const DataObject *input)
 
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 ()
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName (void) const
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName (void) const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
- 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

 GenerateImageSource (const GenerateImageSource &) ITK_DELETE_FUNCTION
 
void operator= (const GenerateImageSource &) ITK_DELETE_FUNCTION
 

Private Attributes

DirectionType m_Direction
 
PointType m_Origin
 
SizeType m_Size
 
SpacingType m_Spacing
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 
- Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const
ImageRegionSplitterBase
GetGlobalDefaultSplitter ()
 
static ITK_THREAD_RETURN_TYPE ThreaderCallback (void *arg)
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime
 
bool m_Updating
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Member Typedef Documentation

template<typename TOutputImage >
typedef SmartPointer< const Self> itk::GenerateImageSource< TOutputImage >::ConstPointer

Definition at line 47 of file itkGenerateImageSource.h.

template<typename TOutputImage >
typedef OutputImageType::DirectionType itk::GenerateImageSource< TOutputImage >::DirectionType

Definition at line 55 of file itkGenerateImageSource.h.

template<typename TOutputImage >
typedef TOutputImage itk::GenerateImageSource< TOutputImage >::OutputImageType

Output image typedefs

Definition at line 50 of file itkGenerateImageSource.h.

template<typename TOutputImage >
typedef OutputImageType::PixelType itk::GenerateImageSource< TOutputImage >::PixelType

Definition at line 51 of file itkGenerateImageSource.h.

template<typename TOutputImage >
typedef SmartPointer< Self > itk::GenerateImageSource< TOutputImage >::Pointer

Definition at line 46 of file itkGenerateImageSource.h.

template<typename TOutputImage >
typedef OutputImageType::PointType itk::GenerateImageSource< TOutputImage >::PointType

Definition at line 54 of file itkGenerateImageSource.h.

template<typename TOutputImage >
typedef OutputImageType::RegionType itk::GenerateImageSource< TOutputImage >::RegionType

Definition at line 52 of file itkGenerateImageSource.h.

template<typename TOutputImage >
typedef GenerateImageSource itk::GenerateImageSource< TOutputImage >::Self

Definition at line 44 of file itkGenerateImageSource.h.

template<typename TOutputImage >
typedef TOutputImage::SizeType itk::GenerateImageSource< TOutputImage >::SizeType

Definition at line 58 of file itkGenerateImageSource.h.

template<typename TOutputImage >
typedef TOutputImage::SizeValueType itk::GenerateImageSource< TOutputImage >::SizeValueType

Definition at line 59 of file itkGenerateImageSource.h.

template<typename TOutputImage >
typedef OutputImageType::SpacingType itk::GenerateImageSource< TOutputImage >::SpacingType

Definition at line 53 of file itkGenerateImageSource.h.

template<typename TOutputImage >
typedef ImageSource< TOutputImage > itk::GenerateImageSource< TOutputImage >::Superclass

Definition at line 45 of file itkGenerateImageSource.h.

Constructor & Destructor Documentation

template<typename TOutputImage >
itk::GenerateImageSource< TOutputImage >::GenerateImageSource ( )
protected
template<typename TOutputImage >
itk::GenerateImageSource< TOutputImage >::GenerateImageSource ( const GenerateImageSource< TOutputImage > &  )
private

Member Function Documentation

template<typename TOutputImage >
virtual void itk::GenerateImageSource< TOutputImage >::GenerateOutputInformation ( )
overrideprotectedvirtual

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.

Reimplemented in itk::PhysicalPointImageSource< TOutputImage >.

template<typename TOutputImage >
virtual const DirectionType& itk::GenerateImageSource< TOutputImage >::GetDirection ( ) const
virtual

Set/Get the output image direction cosine. This parameter defaults to the identity matrix.

template<typename TOutputImage >
virtual const char* itk::GenerateImageSource< TOutputImage >::GetNameOfClass ( ) const
virtual
template<typename TOutputImage >
virtual const PointType& itk::GenerateImageSource< TOutputImage >::GetOrigin ( ) const
virtual

Set/Get the output image origin. This parameter defaults to all zeros.

template<typename TOutputImage >
virtual const SizeType& itk::GenerateImageSource< TOutputImage >::GetSize ( ) const
virtual

Set/Get the size of the output image

template<typename TOutputImage >
virtual const SpacingType& itk::GenerateImageSource< TOutputImage >::GetSpacing ( ) const
virtual

Set/Get the output image spacing. This parameter defaults to all ones.

template<typename TOutputImage >
void itk::GenerateImageSource< TOutputImage >::operator= ( const GenerateImageSource< TOutputImage > &  )
private
template<typename TOutputImage >
virtual void itk::GenerateImageSource< TOutputImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

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::ProcessObject.

Reimplemented in itk::GaussianImageSource< TOutputImage >, itk::GridImageSource< TOutputImage >, itk::GaborImageSource< TOutputImage >, and itk::ParametricImageSource< TOutputImage >.

template<typename TOutputImage >
virtual void itk::GenerateImageSource< TOutputImage >::SetDirection ( DirectionType  _arg)
virtual

Set/Get the output image direction cosine. This parameter defaults to the identity matrix.

template<typename TOutputImage >
virtual void itk::GenerateImageSource< TOutputImage >::SetOrigin ( PointType  _arg)
virtual

Set/Get the output image origin. This parameter defaults to all zeros.

template<typename TOutputImage >
virtual void itk::GenerateImageSource< TOutputImage >::SetOrigin ( const float  data[])
virtual

Set/Get the output image origin. This parameter defaults to all zeros.

template<typename TOutputImage >
virtual void itk::GenerateImageSource< TOutputImage >::SetSize ( SizeType  _arg)
virtual

Set/Get the size of the output image

template<typename TOutputImage >
virtual void itk::GenerateImageSource< TOutputImage >::SetSize ( SizeValueType  data[])
virtual

Set/Get the size of the output image

template<typename TOutputImage >
virtual void itk::GenerateImageSource< TOutputImage >::SetSpacing ( SpacingType  _arg)
virtual

Set/Get the output image spacing. This parameter defaults to all ones.

template<typename TOutputImage >
virtual void itk::GenerateImageSource< TOutputImage >::SetSpacing ( const float  data[])
virtual

Set/Get the output image spacing. This parameter defaults to all ones.

Member Data Documentation

template<typename TOutputImage >
DirectionType itk::GenerateImageSource< TOutputImage >::m_Direction
private

Definition at line 114 of file itkGenerateImageSource.h.

template<typename TOutputImage >
PointType itk::GenerateImageSource< TOutputImage >::m_Origin
private

Definition at line 113 of file itkGenerateImageSource.h.

template<typename TOutputImage >
SizeType itk::GenerateImageSource< TOutputImage >::m_Size
private

Definition at line 111 of file itkGenerateImageSource.h.

template<typename TOutputImage >
SpacingType itk::GenerateImageSource< TOutputImage >::m_Spacing
private

Definition at line 112 of file itkGenerateImageSource.h.

template<typename TOutputImage >
const unsigned int itk::GenerateImageSource< TOutputImage >::NDimensions = TOutputImage::ImageDimension
static

Dimensionality of the output image

Definition at line 62 of file itkGenerateImageSource.h.


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