#include <itkCSVNumericObjectFileWriter.h>

Inheritance diagram for itk::CSVNumericObjectFileWriter< TValueType, NRows, NColumns >:

Collaboration diagram for itk::CSVNumericObjectFileWriter< TValueType, NRows, NColumns >:

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef itk::Matrix < TValueType, NRows, NColumns >	itkMatrixType
typedef SmartPointer< Self >	Pointer
typedef CSVNumericObjectFileWriter	Self
typedef itk::Size < 2 >::SizeValueType	SizeValueType
typedef std::vector< std::string >	StringVectorType
typedef LightProcessObject	Superclass
typedef vnl_matrix_fixed < TValueType, NRows, NColumns >	vnlFixedMatrixType
typedef vnl_matrix< TValueType >	vnlMatrixType
Public Types inherited from itk::LightProcessObject
Public Types inherited from itk::Object
Public Types inherited from itk::LightObject

Public Member Functions
void	ColumnHeadersPushBack (const std::string &)
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const char *	GetNameOfClass () const
void	PrepareForWriting ()
void	RowHeadersPushBack (const std::string &)
void	SetColumnHeaders (const StringVectorType &columnheaders)
virtual void	SetFieldDelimiterCharacter (char _arg)
virtual void	SetFileName (const char *_arg)
void	SetInput (const vnlMatrixType *obj)
void	SetInput (const vnlFixedMatrixType *obj)
void	SetInput (const itkMatrixType *obj)
void	SetRowHeaders (const StringVectorType &rowheaders)
virtual void	Update ()
virtual void	Write ()
Public Member Functions inherited from itk::LightProcessObject
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
virtual const bool &	GetAbortGenerateData ()
virtual void	SetAbortGenerateData (bool _arg)
virtual void	UpdateOutputData ()
void	UpdateProgress (float amount)
virtual void	SetProgress (float _arg)
virtual const float &	GetProgress ()
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
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
virtual unsigned long	GetMTime () const
virtual const TimeStamp &	GetTimeStamp () 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 Member Functions
static Pointer	New ()

Protected Member Functions
	CSVNumericObjectFileWriter ()
void	PrintSelf (std::ostream &os, Indent indent) const
virtual	~CSVNumericObjectFileWriter ()
Protected Member Functions inherited from itk::LightProcessObject
	LightProcessObject ()
	~LightProcessObject ()
virtual void	GenerateData ()
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
	CSVNumericObjectFileWriter (const Self &)
void	operator= (const Self &)

Private Attributes
StringVectorType	m_ColumnHeaders
SizeValueType	m_Columns
char	m_FieldDelimiterCharacter
std::string	m_FileName
TValueType *	m_InputObject
StringVectorType	m_RowHeaders
SizeValueType	m_Rows

Detailed Description

template<class TValueType, unsigned int NRows = 0, unsigned int NColumns = 0>
class itk::CSVNumericObjectFileWriter< TValueType, NRows, NColumns >

Writes out numeric itk data objects to a csv file.

CSVNumericObjectFileWriter writes numeric data from an itk object into a csv file. It is templated over the type of data being written, the number of rows and the number of columns. The writer uses the datablock member from vnl_matrix or vnl_matrix_fixed. As of now the objects itkMatrix, itkArray2D, and any vnl_matrix based objects are supported.

The user specifies the file name and the field delimiter character using the Set macro method for each. The user can also write out row and column headers. The methods ColumnHeadersPushBack() and RowHeadersPushBack() can be used to push strings into the vectors for row and column headers. The row and column headers can also be set using the Set macro methods for each if vectors for the headers are already set. The SetInput() method is overloaded to allow various itk objects to be set as input.

The method Write() is used to output the object data to a csv file.

The writer will output a warning if the number of row headers is not consistent with the number of rows in the input object or if the number of column headers is not consistent with the number of columns in the input object. It is up to the user to check this.

Definition at line 61 of file itkCSVNumericObjectFileWriter.h.