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

#include <itkParametricImageSource.h>

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

Detailed Description

template<class TOutputImage>
class itk::ParametricImageSource< TOutputImage >

Base class for all parametric image sources.

This abstract class specifies an interface than enables parameters to be set through a vector of values using the SetParameters() method. This interface makes it easier to include parameterized image sources within ITK's optimization/registration framework.

Concrete subclasses must impelement the methods SetParameters(), GetParameters() and GetNumberOfParameters().

Definition at line 44 of file itkParametricImageSource.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef DataObject::Pointer DataObjectPointer
 
typedef OutputImageType::PixelType OutputImagePixelType
 
typedef OutputImageType::Pointer OutputImagePointer
 
typedef TOutputImage OutputImageType
 
typedef Array
< ParametersValueType
ParametersType
 
typedef double ParametersValueType
 
typedef SmartPointer< SelfPointer
 
typedef ParametricImageSource Self
 
typedef GenerateImageSource
< TOutputImage > 
Superclass
 
- Public Types inherited from itk::GenerateImageSource< TOutputImage >
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 unsigned int GetNumberOfParameters () const =0
 
virtual ParametersType GetParameters () const =0
 
virtual void SetParameters (const ParametersType &parameters)=0
 
- Public Member Functions inherited from itk::GenerateImageSource< TOutputImage >
virtual void SetSize (SizeType _arg)
 
virtual const SizeTypeGetSize ()
 
virtual void SetSize (SizeValueType data[])
 
virtual void SetSpacing (SpacingType _arg)
 
virtual const SpacingTypeGetSpacing ()
 
virtual void SetSpacing (const float data[])
 
virtual void SetOrigin (PointType _arg)
 
virtual const PointTypeGetOrigin ()
 
virtual void SetOrigin (const float data[])
 
virtual void SetDirection (DirectionType _arg)
 
virtual const DirectionTypeGetDirection ()
 
- Public Member Functions inherited from itk::ImageSource< TOutputImage >
OutputImageTypeGetOutput (unsigned int idx)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *output)
 
virtual void GraftOutput (DataObject *output)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
 
OutputImageTypeGetOutput (void)
 
const OutputImageTypeGetOutput (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 ThreadIdTypeGetNumberOfThreads ()
 
- 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
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary (void)
 
const MetaDataDictionaryGetMetaDataDictionary (void) 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
 
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 Attributes

static const unsigned int OutputImageDimension = TOutputImage::ImageDimension
 
- Static Public Attributes inherited from itk::GenerateImageSource< TOutputImage >
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

 ParametricImageSource ()
 
void PrintSelf (std::ostream &os, Indent indent) const
 
virtual ~ParametricImageSource ()
 
- Protected Member Functions inherited from itk::GenerateImageSource< TOutputImage >
 GenerateImageSource ()
 
virtual void GenerateOutputInformation ()
 
- Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void AfterThreadedGenerateData ()
 
virtual void AllocateOutputs ()
 
virtual void BeforeThreadedGenerateData ()
 
virtual void GenerateData ()
 
virtual const
ImageRegionSplitterBase
GetImageRegionSplitter (void) const
 
 ImageSource ()
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int num, 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)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateInputRequestedRegion ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredOutputs ()
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (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
 
 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)
 
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 SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *input)
 
virtual void SetPrimaryOutput (DataObject *output)
 
virtual void VerifyInputInformation ()
 
virtual void VerifyPreconditions ()
 
 ~ProcessObject ()
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PopBackInput ()
 
virtual void PushFrontInput (const DataObject *input)
 
virtual void PopFrontInput ()
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName (void) const
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredInputs ()
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
void SetRequiredInputNames (const NameArray &)
 
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

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

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)
 
- Protected Types inherited from itk::LightObject
typedef int InternalReferenceCountType
 
- 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
 

Member Typedef Documentation

template<class TOutputImage >
typedef SmartPointer<const Self> itk::ParametricImageSource< TOutputImage >::ConstPointer

Definition at line 52 of file itkParametricImageSource.h.

template<class TOutputImage >
typedef DataObject::Pointer itk::ParametricImageSource< TOutputImage >::DataObjectPointer

Smart Pointer type to a DataObject.

Definition at line 55 of file itkParametricImageSource.h.

template<class TOutputImage >
typedef OutputImageType::PixelType itk::ParametricImageSource< TOutputImage >::OutputImagePixelType

Definition at line 60 of file itkParametricImageSource.h.

template<class TOutputImage >
typedef OutputImageType::Pointer itk::ParametricImageSource< TOutputImage >::OutputImagePointer

Definition at line 59 of file itkParametricImageSource.h.

template<class TOutputImage >
typedef TOutputImage itk::ParametricImageSource< TOutputImage >::OutputImageType

Some convenient typedefs.

Definition at line 58 of file itkParametricImageSource.h.

template<class TOutputImage >
typedef Array< ParametersValueType > itk::ParametricImageSource< TOutputImage >::ParametersType

Definition at line 63 of file itkParametricImageSource.h.

template<class TOutputImage >
typedef double itk::ParametricImageSource< TOutputImage >::ParametersValueType

Definition at line 62 of file itkParametricImageSource.h.

template<class TOutputImage >
typedef SmartPointer<Self> itk::ParametricImageSource< TOutputImage >::Pointer

Definition at line 51 of file itkParametricImageSource.h.

template<class TOutputImage >
typedef ParametricImageSource itk::ParametricImageSource< TOutputImage >::Self

Standard class typedefs.

Definition at line 49 of file itkParametricImageSource.h.

template<class TOutputImage >
typedef GenerateImageSource<TOutputImage> itk::ParametricImageSource< TOutputImage >::Superclass

Definition at line 50 of file itkParametricImageSource.h.

Constructor & Destructor Documentation

template<class TOutputImage >
itk::ParametricImageSource< TOutputImage >::ParametricImageSource ( )
inlineprotected

Definition at line 87 of file itkParametricImageSource.h.

template<class TOutputImage >
virtual itk::ParametricImageSource< TOutputImage >::~ParametricImageSource ( )
inlineprotectedvirtual

Definition at line 88 of file itkParametricImageSource.h.

template<class TOutputImage >
itk::ParametricImageSource< TOutputImage >::ParametricImageSource ( const Self )
private

Member Function Documentation

template<class TOutputImage >
virtual const char* itk::ParametricImageSource< TOutputImage >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::GenerateImageSource< TOutputImage >.

Reimplemented in itk::GaussianImageSource< TOutputImage >.

template<class TOutputImage >
virtual unsigned int itk::ParametricImageSource< TOutputImage >::GetNumberOfParameters ( ) const
pure virtual

Get the number of parameters.

Implemented in itk::GaussianImageSource< TOutputImage >.

template<class TOutputImage >
virtual ParametersType itk::ParametricImageSource< TOutputImage >::GetParameters ( ) const
pure virtual

Get the parameters for this source.

Implemented in itk::GaussianImageSource< TOutputImage >.

template<class TOutputImage >
void itk::ParametricImageSource< TOutputImage >::operator= ( const Self )
private
template<class TOutputImage >
void itk::ParametricImageSource< TOutputImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
protectedvirtual

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::GenerateImageSource< TOutputImage >.

template<class TOutputImage >
virtual void itk::ParametricImageSource< TOutputImage >::SetParameters ( const ParametersType parameters)
pure virtual

Set the parameters for this source. Setting the parameters does not mark the image source as modified; subclasses should override this method to forward parameters through setters that call Modified().

Member Data Documentation

template<class TOutputImage >
const unsigned int itk::ParametricImageSource< TOutputImage >::OutputImageDimension = TOutputImage::ImageDimension
static

ImageDimension constant

Definition at line 68 of file itkParametricImageSource.h.


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