#include <itkCSVNumericObjectFileWriter.h>

Detailed Description

template<typename TValue, unsigned int VRows = 0, unsigned int VColumns = 0>
class itk::CSVNumericObjectFileWriter< TValue, VRows, VColumns >

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 62 of file itkCSVNumericObjectFileWriter.h.

Inheritance diagram for itk::CSVNumericObjectFileWriter< TValue, VRows, VColumns >:

Collaboration diagram for itk::CSVNumericObjectFileWriter< TValue, VRows, VColumns >:

Public Types
using	ConstPointer = SmartPointer< const Self >

using	itkMatrixType = itk::Matrix< TValue, VRows, VColumns >

using	Pointer = SmartPointer< Self >

using	Self = CSVNumericObjectFileWriter

using	SizeValueType = itk::Size< 2 >::SizeValueType

using	StringVectorType = std::vector< std::string >

using	Superclass = LightProcessObject

using	vnlFixedMatrixType = vnl_matrix_fixed< TValue, VRows, VColumns >

using	vnlMatrixType = vnl_matrix< TValue >

Public Types inherited from itk::LightProcessObject
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = LightProcessObject

using	Superclass = Object

Public Types inherited from itk::Object
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = Object

using	Superclass = LightObject

Public Types inherited from itk::LightObject
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = LightObject

Public Member Functions
void	ColumnHeadersPushBack (const std::string &)

const char *	GetNameOfClass () const override

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 itkMatrixType *obj)

void	SetInput (const vnlFixedMatrixType *obj)

void	SetInput (const vnlMatrixType *obj)

void	SetRowHeaders (const StringVectorType &rowheaders)

virtual void	Update ()

virtual void	Write ()

Public Member Functions inherited from itk::LightProcessObject
virtual void	AbortGenerateDataOn ()

virtual const bool &	GetAbortGenerateData () const

virtual void	SetAbortGenerateData (bool _arg)

virtual void	UpdateOutputData ()

void	UpdateProgress (float amount)

virtual void	SetProgress (float _arg)

virtual const float &	GetProgress () const

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *cmd) const

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const

LightObject::Pointer	CreateAnother () const override

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	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

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag) const

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexcept override

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
Pointer	Clone () const

virtual void	Delete ()

virtual int	GetReferenceCount () const

void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::LightProcessObject
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 val)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Protected Member Functions
	CSVNumericObjectFileWriter ()

void	PrintSelf (std::ostream &os, Indent indent) const override

	~CSVNumericObjectFileWriter () override=default

Protected Member Functions inherited from itk::LightProcessObject
virtual void	GenerateData ()

	LightProcessObject ()

	~LightProcessObject () override

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

	~Object () override

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 Attributes
StringVectorType	m_ColumnHeaders {}

SizeValueType	m_Columns {}

char	m_FieldDelimiterCharacter {}

std::string	m_FileName {}

TValue *	m_InputObject {}

StringVectorType	m_RowHeaders {}

SizeValueType	m_Rows {}

Additional Inherited Members
Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}