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

#include <itkLandmarksReader.h>

+ Inheritance diagram for itk::LandmarksReader< NDimension >:
+ Collaboration diagram for itk::LandmarksReader< NDimension >:

Detailed Description

template<unsigned int NDimension>
class itk::LandmarksReader< NDimension >

Class that reads a file containing spatial object landmarks.

A LandmarkSpatialObject is produced as output.

Definition at line 37 of file itkLandmarksReader.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LandmarksReader Self
 
typedef SpatialObjectType::Pointer SpatialObjectPointer
 
typedef LandmarkSpatialObject
< NDimension > 
SpatialObjectType
 
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 ::itk::LightObject::Pointer CreateAnother () const
 
virtual const char * GetNameOfClass () const
 
const SpatialObjectTypeGetOutput () const
 
virtual void SetFileName (const char *_arg)
 
virtual const char * GetFileName () const
 
- 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 DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx)
 
virtual DataObjectPointer MakeOutput (const DataObjectIdentifierType &)
 
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 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 Member Functions

static Pointer New ()
 
- 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 Public Attributes

static const unsigned int Dimension = NDimension
 

Protected Member Functions

void GenerateData ()
 
 LandmarksReader ()
 
void PrintSelf (std::ostream &os, Indent indent) const
 
virtual ~LandmarksReader ()
 
- 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 GenerateOutputInformation ()
 
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 Types

typedef SceneType::ObjectListType ObjectListType
 
typedef
SpatialObjectReaderType::SceneType 
SceneType
 
typedef
SpatialObjectReaderType::Pointer 
SpatialObjectReaderPointer
 
typedef SpatialObjectReader
< NDimension, unsigned short > 
SpatialObjectReaderType
 

Private Member Functions

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

Private Attributes

std::string m_FileName
 
SpatialObjectReaderPointer m_SpatialObjectReader
 

Additional Inherited Members

- 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<unsigned int NDimension>
typedef SmartPointer<const Self> itk::LandmarksReader< NDimension >::ConstPointer

Definition at line 44 of file itkLandmarksReader.h.

template<unsigned int NDimension>
typedef SceneType::ObjectListType itk::LandmarksReader< NDimension >::ObjectListType
private

Definition at line 84 of file itkLandmarksReader.h.

template<unsigned int NDimension>
typedef SmartPointer<Self> itk::LandmarksReader< NDimension >::Pointer

Definition at line 43 of file itkLandmarksReader.h.

template<unsigned int NDimension>
typedef SpatialObjectReaderType::SceneType itk::LandmarksReader< NDimension >::SceneType
private

Definition at line 83 of file itkLandmarksReader.h.

template<unsigned int NDimension>
typedef LandmarksReader itk::LandmarksReader< NDimension >::Self

Standard class typedefs.

Definition at line 41 of file itkLandmarksReader.h.

template<unsigned int NDimension>
typedef SpatialObjectType::Pointer itk::LandmarksReader< NDimension >::SpatialObjectPointer

Definition at line 58 of file itkLandmarksReader.h.

template<unsigned int NDimension>
typedef SpatialObjectReaderType::Pointer itk::LandmarksReader< NDimension >::SpatialObjectReaderPointer
private

Definition at line 82 of file itkLandmarksReader.h.

template<unsigned int NDimension>
typedef SpatialObjectReader< NDimension, unsigned short > itk::LandmarksReader< NDimension >::SpatialObjectReaderType
private

Definition at line 81 of file itkLandmarksReader.h.

template<unsigned int NDimension>
typedef LandmarkSpatialObject< NDimension > itk::LandmarksReader< NDimension >::SpatialObjectType

Type of spatialObject that will be passed as input and output of this segmentation method.

Definition at line 57 of file itkLandmarksReader.h.

template<unsigned int NDimension>
typedef ProcessObject itk::LandmarksReader< NDimension >::Superclass

Definition at line 42 of file itkLandmarksReader.h.

Constructor & Destructor Documentation

template<unsigned int NDimension>
itk::LandmarksReader< NDimension >::LandmarksReader ( )
protected
template<unsigned int NDimension>
virtual itk::LandmarksReader< NDimension >::~LandmarksReader ( )
protectedvirtual
template<unsigned int NDimension>
itk::LandmarksReader< NDimension >::LandmarksReader ( const Self )
private

Member Function Documentation

template<unsigned int NDimension>
virtual::itk::LightObject::Pointer itk::LandmarksReader< NDimension >::CreateAnother ( ) 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<unsigned int NDimension>
void itk::LandmarksReader< NDimension >::GenerateData ( void  )
protectedvirtual

This method causes the filter to generate its output.

Reimplemented from itk::ProcessObject.

template<unsigned int NDimension>
virtual const char* itk::LandmarksReader< NDimension >::GetFileName ( ) const
virtual

Set / Get the input filename

template<unsigned int NDimension>
virtual const char* itk::LandmarksReader< NDimension >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::ProcessObject.

template<unsigned int NDimension>
const SpatialObjectType* itk::LandmarksReader< NDimension >::GetOutput ( ) const

Output data that carries the feature in the form of a SpatialObject.

template<unsigned int NDimension>
static Pointer itk::LandmarksReader< NDimension >::New ( )
static

Method for creation through the object factory.

template<unsigned int NDimension>
void itk::LandmarksReader< NDimension >::operator= ( const Self )
private
template<unsigned int NDimension>
void itk::LandmarksReader< NDimension >::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::ProcessObject.

template<unsigned int NDimension>
virtual void itk::LandmarksReader< NDimension >::SetFileName ( const char *  _arg)
virtual

Set / Get the input filename

Member Data Documentation

template<unsigned int NDimension>
const unsigned int itk::LandmarksReader< NDimension >::Dimension = NDimension
static

Dimension of the space

Definition at line 53 of file itkLandmarksReader.h.

template<unsigned int NDimension>
std::string itk::LandmarksReader< NDimension >::m_FileName
private

Definition at line 86 of file itkLandmarksReader.h.

template<unsigned int NDimension>
SpatialObjectReaderPointer itk::LandmarksReader< NDimension >::m_SpatialObjectReader
private

Definition at line 87 of file itkLandmarksReader.h.


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