itk::MetaArrayReader Class Reference

#include <itkMetaArrayReader.h>

Inheritance diagram for itk::MetaArrayReader:

[legend]

Collaboration diagram for itk::MetaArrayReader:

[legend]

List of all members.

Detailed Description

Definition at line 31 of file itkMetaArrayReader.h.


Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef MetaArrayReader	Self
typedef LightProcessObject	Superclass
Public Member Functions
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
virtual const bool &	GetAbortGenerateData ()
Command *	GetCommand (unsigned long tag)
int	GetCovariantVectorDimension (void) const
MET_ValueEnumType	GetDataType (void) const
bool	GetDebug () const
template<typename TValueType>
void	GetElement (TValueType &value, unsigned int i, unsigned int channel=0) const
virtual const char *	GetFileName () const
MetaArray *	GetMetaArrayPointer (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual unsigned long	GetMTime () const
virtual const char *	GetNameOfClass () const
int	GetNumberOfComponents (void) const
int	GetNumberOfElements (void) const
virtual int	GetReferenceCount () const
int	GetVectorDimension (void) const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
virtual void	Modified () const
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
virtual void	SetAbortGenerateData (bool _arg)
void	SetBuffer (void *_buffer)
void	SetDebug (bool debugFlag) const
virtual void	SetFileName (const char *_arg)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
int	Size (void) const
virtual void	UnRegister () const
void	Update ()
virtual void	UpdateOutputData ()
void	UpdateProgress (float amount)

unsigned long	AddObserver (const EventObject &event, Command *) const
unsigned long	AddObserver (const EventObject &event, Command *)

template<typename TValueType>
void	GetMultiChannelOutput (MET_ValueEnumType _metaElementType, Array< TValueType > *_array)

template<typename TValueType>
void	GetOutput (MET_ValueEnumType _metaElementType, VariableLengthVector< TValueType > *_vector, bool _letVectorManageData=true)

template<typename TValueType, unsigned int VLength>
bool	GetOutput (MET_ValueEnumType, CovariantVector< TValueType, VLength > *_vector)

template<typename TValueType, unsigned int VLength>
bool	GetOutput (MET_ValueEnumType, Vector< TValueType, VLength > *_vector)

template<typename TValueType, unsigned int VLength>
bool	GetOutput (MET_ValueEnumType, FixedArray< TValueType, VLength > *_array)

template<typename TValueType>
void	GetOutput (MET_ValueEnumType _metaElementType, Array< TValueType > *_array, bool _letArrayManageData=true)

virtual const float &	GetProgress ()

virtual void	SetProgress (float _arg)
Static Public Member Functions
static void	BreakOnError ()
static Pointer	New ()

static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static void	SetGlobalWarningDisplay (bool flag)
Protected Types

typedef int	InternalReferenceCountType
Protected Member Functions
virtual void	GenerateData ()
	MetaArrayReader ()
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
virtual	~MetaArrayReader ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
Protected Attributes
InternalReferenceCountType	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock

Member Typedef Documentation

typedef SmartPointer<const Self> itk::MetaArrayReader::ConstPointer

Reimplemented from itk::LightProcessObject.

Definition at line 39 of file itkMetaArrayReader.h.

typedef int itk::LightObject::InternalReferenceCountType [protected, inherited]

Define the type of the reference count according to the target. This allows the use of atomic operations

Definition at line 139 of file itkLightObject.h.

typedef SmartPointer<Self> itk::MetaArrayReader::Pointer

Reimplemented from itk::LightProcessObject.

Definition at line 38 of file itkMetaArrayReader.h.

typedef MetaArrayReader itk::MetaArrayReader::Self

SmartPointer typedef support

Reimplemented from itk::LightProcessObject.

Definition at line 36 of file itkMetaArrayReader.h.

typedef LightProcessObject itk::MetaArrayReader::Superclass

Reimplemented from itk::LightProcessObject.

Definition at line 37 of file itkMetaArrayReader.h.

Constructor & Destructor Documentation

itk::MetaArrayReader::MetaArrayReader ( ) [protected]

virtual itk::MetaArrayReader::~MetaArrayReader ( ) [protected, virtual]

Member Function Documentation

virtual void itk::LightProcessObject::AbortGenerateDataOff ( ) [virtual, inherited]

virtual void itk::LightProcessObject::AbortGenerateDataOn ( ) [virtual, inherited]

Turn on and off the AbortGenerateData flag.

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *
	)			const `[inherited]`

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *
	)			`[inherited]`

Allow people to add/remove/invoke observers (callbacks) to any ITK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and an itk::Command to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. The memory for the Command becomes the responsibility of this object, so don't pass the same instance of a command to two different objects

static void itk::LightObject::BreakOnError ( ) [static, inherited]

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

virtual LightObject::Pointer itk::Object::CreateAnother ( ) const [virtual, inherited]

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

virtual void itk::Object::DebugOff ( ) const [virtual, inherited]

Turn debugging output off.

virtual void itk::Object::DebugOn ( ) const [virtual, inherited]

Turn debugging output on.

virtual void itk::LightObject::Delete ( ) [virtual, inherited]

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

virtual void itk::LightProcessObject::GenerateData ( void ) [inline, protected, virtual, inherited]

This method causes the filter to generate its output.

Reimplemented in itk::ClassifierBase< TDataContainer >, itk::ImageClassifierBase< TInputImage, TClassifiedImage >, itk::ImageGaussianModelEstimator< TInputImage, TMembershipFunction, TTrainingImage >, itk::ImageKmeansModelEstimator< TInputImage, TMembershipFunction >, itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >, itk::LevelSetNeighborhoodExtractor< TLevelSet >, itk::Statistics::SampleClassifier< TSample >, itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >, itk::ClassifierBase< TInputImage >, and itk::ClassifierBase< TSample >.

Definition at line 123 of file itkLightProcessObject.h.

virtual const bool& itk::LightProcessObject::GetAbortGenerateData ( ) [virtual, inherited]

Get the AbortGenerateData flag for the process object. Process objects may handle premature termination of execution in different ways.

Command* itk::Object::GetCommand ( unsigned long tag ) [inherited]

Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used.

int itk::MetaArrayReader::GetCovariantVectorDimension ( void ) const [inline]

GetCovariantVectorDimension is used by itkVector

Definition at line 94 of file itkMetaArrayReader.h.

MET_ValueEnumType itk::MetaArrayReader::GetDataType ( void ) const [inline]

Return the MetaIO type that corresponds to the element type

Definition at line 64 of file itkMetaArrayReader.h.

bool itk::Object::GetDebug ( ) const [inherited]

Get the value of the debug flag.

template<typename TValueType>

void itk::MetaArrayReader::GetElement	(	TValueType &	value,
		unsigned int	i,
		unsigned int	channel = `0`
	)			const `[inline]`

GetElement is used by itkArray, itkFixedArray, and VariableLengthVector

Definition at line 101 of file itkMetaArrayReader.h.

Referenced by GetOutput().

virtual const char* itk::MetaArrayReader::GetFileName ( ) const [virtual]

Get the filename

static bool itk::Object::GetGlobalWarningDisplay ( ) [static, inherited]

MetaArray* itk::MetaArrayReader::GetMetaArrayPointer ( void )

Get a pointer to the metaArray so that you can change metaArray options (e.g., add comments and user-defined fields

const MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void ) const [inherited]

Returns:: A constant reference to this objects MetaDataDictionary.

MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void ) [inherited]

Returns:: A reference to this objects MetaDataDictionary.

Warning:: This reference may be changed.

virtual unsigned long itk::Object::GetMTime ( ) const [virtual, inherited]

Return this objects modified time.

Referenced by itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >::GetObjectMTime().

template<typename TValueType>

void itk::MetaArrayReader::GetMultiChannelOutput	(	MET_ValueEnumType	_metaElementType,
		Array< TValueType > *	_array
	)			`[inline]`

Get an itk Array of Arrays, itk::Array< itk::Array<short> >. Assumes all sub-arrays have the same length. Specify the MetaType of the elements of the Array< Array< * > > and provide a pointer to the Array of arrays. Elements are copied into the array of arrays.

Definition at line 229 of file itkMetaArrayReader.h.

References itk::Array< TValueType >::SetSize().

virtual const char* itk::MetaArrayReader::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::LightProcessObject.

int itk::MetaArrayReader::GetNumberOfComponents ( void ) const [inline]

GetNumberOfComponents is used by itkVector and itkCovariantVector

Definition at line 88 of file itkMetaArrayReader.h.

int itk::MetaArrayReader::GetNumberOfElements ( void ) const [inline]

GetNumberOfElements is used by itkArray and VariableLengthVector

Definition at line 76 of file itkMetaArrayReader.h.

template<typename TValueType>

void itk::MetaArrayReader::GetOutput	(	MET_ValueEnumType	_metaElementType,
		VariableLengthVector< TValueType > *	_vector,
		bool	_letVectorManageData = `true`
	)			`[inline]`

Get itk VariableLengthVector Specify the MetaType of the elements of the VariableLengthVector and provide a pointer to the VariableLengthVector. The buffer of the VariableLengthVector is replaced by the buffer into which the data was directly read (a copy does not occur). If _letVectorManageData is true, the buffer persists even after this MetaArrayReader is destroyed. Otherwise, the buffer (and therefore the validity of the dat ain the VariableLengthVector) is destroyed when the MetaArrayReader is dstroyed.

Definition at line 205 of file itkMetaArrayReader.h.

References itk::VariableLengthVector< TValueType >::SetData().

template<typename TValueType, unsigned int VLength>

bool itk::MetaArrayReader::GetOutput	(	MET_ValueEnumType	,
		CovariantVector< TValueType, VLength > *	_vector
	)			`[inline]`

Get itk CovariantVector Specify the MetaType of the elements of the itkCovariantVector and provide a pointer to the itkCovariantVector into which the data should be copied

Definition at line 179 of file itkMetaArrayReader.h.

References GetElement().

template<typename TValueType, unsigned int VLength>

bool itk::MetaArrayReader::GetOutput	(	MET_ValueEnumType	,
		Vector< TValueType, VLength > *	_vector
	)			`[inline]`

Get itk Vector Specify the MetaType of the elements of the itkVector and provide a pointer to the itkVector into which the data should be copied

Definition at line 157 of file itkMetaArrayReader.h.

References GetElement().

template<typename TValueType, unsigned int VLength>

bool itk::MetaArrayReader::GetOutput	(	MET_ValueEnumType	,
		FixedArray< TValueType, VLength > *	_array
	)			`[inline]`

Get itk FixedArray

Definition at line 137 of file itkMetaArrayReader.h.

References GetElement().

template<typename TValueType>

void itk::MetaArrayReader::GetOutput	(	MET_ValueEnumType	_metaElementType,
		Array< TValueType > *	_array,
		bool	_letArrayManageData = `true`
	)			`[inline]`

Get itk Array Specify the MetaType of the elements of the Array and provide a pointer to the Array. The buffer of the Array is replaced by the buffer into which the data was directly read (a copy does not occur). If _letVectorManageData is true, the buffer persists even after this MetaArrayReader is destroyed. Otherwise, the buffer (and therefore the validity of the dat ain the Array) is destroyed when the MetaArrayReader is dstroyed.

Definition at line 117 of file itkMetaArrayReader.h.

References itk::Array< TValueType >::SetData().

virtual const float& itk::LightProcessObject::GetProgress ( ) [virtual, inherited]

Get the execution progress of a process object. The progress is a floating number between (0,1), 0 meaning no progress; 1 meaning the filter has completed execution.

virtual int itk::LightObject::GetReferenceCount ( ) const [inline, virtual, inherited]

Gets the reference count on this object.

Definition at line 106 of file itkLightObject.h.

int itk::MetaArrayReader::GetVectorDimension ( void ) const [inline]

GetVectorDimension is used by itkVector

Definition at line 82 of file itkMetaArrayReader.h.

static void itk::Object::GlobalWarningDisplayOff ( ) [inline, static, inherited]

Definition at line 100 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

static void itk::Object::GlobalWarningDisplayOn ( ) [inline, static, inherited]

Definition at line 98 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

bool itk::Object::HasObserver ( const EventObject & event ) const [inherited]

Return true if an observer is registered for this event.

void itk::Object::InvokeEvent ( const EventObject & ) const [inherited]

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

void itk::Object::InvokeEvent ( const EventObject & ) [inherited]

Call Execute on all the Commands observing this event id.

virtual void itk::Object::Modified ( ) const [virtual, inherited]

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data.

Referenced by itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::InsertNarrowBandNode(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBand(), itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandInnerRadius(), itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandTotalRadius(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::NonUniformBSpline< TDimension >::SetSplineOrder(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

static Pointer itk::MetaArrayReader::New ( ) [static]

Method for creation through the object factory

Reimplemented from itk::LightProcessObject.

void itk::LightObject::Print	(	std::ostream &	os,
		Indent	indent = `0`
	)			const `[inherited]`

Cause the object to print itself out.

Referenced by itk::WeakPointer< itk::ProcessObject >::Print(), and itk::SmartPointer< itk::MutualInformationImageToImageMetric >::Print().

virtual void itk::LightObject::PrintHeader	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual, inherited]`

bool itk::Object::PrintObservers	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, inherited]`

void itk::LightProcessObject::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual, inherited]`

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

virtual void itk::LightObject::PrintTrailer	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual, inherited]`

virtual void itk::Object::Register ( ) const [virtual, inherited]

Increase the reference count (mark as used by another object).

Reimplemented from itk::LightObject.

void itk::Object::RemoveAllObservers ( ) [inherited]

Remove all observers .

void itk::Object::RemoveObserver ( unsigned long tag ) [inherited]

Remove the observer with this tag value.

virtual void itk::LightProcessObject::SetAbortGenerateData ( bool _arg ) [virtual, inherited]

Set the AbortGenerateData flag for the process object. Process objects may handle premature termination of execution in different ways.

void itk::MetaArrayReader::SetBuffer ( void * _buffer )

Specify the buffer (already allocated) into which data should be read

void itk::Object::SetDebug ( bool debugFlag ) const [inherited]

Set the value of the debug flag. A non-zero value turns debugging on.

virtual void itk::MetaArrayReader::SetFileName ( const char * _arg ) [virtual]

Set the filename

static void itk::Object::SetGlobalWarningDisplay ( bool flag ) [static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

void itk::Object::SetMetaDataDictionary ( const MetaDataDictionary & rhs ) [inherited]

Returns:: Set the MetaDataDictionary

virtual void itk::LightProcessObject::SetProgress ( float _arg ) [virtual, inherited]

Set the execution progress of a process object. The progress is a floating number between (0,1), 0 meaning no progress; 1 meaning the filter has completed execution.

virtual void itk::Object::SetReferenceCount ( int ) [virtual, inherited]

Sets the reference count (use with care)

Reimplemented from itk::LightObject.

int itk::MetaArrayReader::Size ( void ) const [inline]

Size is used by itkArray and VariableLengthVector

Definition at line 70 of file itkMetaArrayReader.h.

virtual void itk::Object::UnRegister ( ) const [virtual, inherited]

Decrease the reference count (release by another object).

Reimplemented from itk::LightObject.

Referenced by itk::SmartPointer< itk::MutualInformationImageToImageMetric >::operator=().

void itk::MetaArrayReader::Update ( )

Read the Array in MetaIO format

virtual void itk::LightProcessObject::UpdateOutputData ( ) [virtual, inherited]

Actually generate new output.

void itk::LightProcessObject::UpdateProgress ( float amount ) [inherited]

Update the progress of the process object. If a ProgressMethod exists, executes it. Then set the Progress ivar to amount. The parameter amount should range between (0,1).

Member Data Documentation

InternalReferenceCountType itk::LightObject::m_ReferenceCount [mutable, protected, inherited]

Number of uses of this object by other objects.

Definition at line 144 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock [mutable, protected, inherited]

Mutex lock to protect modification to the reference count

Definition at line 147 of file itkLightObject.h.

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

itkMetaArrayReader.h

itk::MetaArrayReader Class Reference

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation