ITK
4.6.0
Insight Segmentation and Registration Toolkit
|
#include <itkCSVNumericObjectFileWriter.h>
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.
Public Types | |
typedef SmartPointer< const Self > | ConstPointer |
typedef itk::Matrix< TValue, 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 < TValue, NRows, NColumns > | vnlFixedMatrixType |
typedef vnl_matrix< TValue > | vnlMatrixType |
Public Types inherited from itk::LightProcessObject | |
typedef SmartPointer< const Self > | ConstPointer |
typedef SmartPointer< Self > | Pointer |
typedef LightProcessObject | Self |
typedef Object | Superclass |
Public Types inherited from itk::Object | |
typedef SmartPointer< const Self > | ConstPointer |
typedef SmartPointer< Self > | Pointer |
typedef Object | Self |
typedef LightObject | Superclass |
Public Types inherited from itk::LightObject | |
typedef SmartPointer< const Self > | ConstPointer |
typedef SmartPointer< Self > | Pointer |
typedef LightObject | Self |
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 () 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 *) |
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 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 |
virtual void | Register () const ITK_OVERRIDE |
void | RemoveAllObservers () |
void | RemoveObserver (unsigned long tag) |
void | SetDebug (bool debugFlag) const |
void | SetMetaDataDictionary (const MetaDataDictionary &rhs) |
virtual void | SetReferenceCount (int) ITK_OVERRIDE |
virtual void | UnRegister () const ITK_OVERRIDE |
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::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 flag) |
Static Public Member Functions inherited from itk::LightObject | |
static void | BreakOnError () |
static Pointer | New () |
Protected Member Functions | |
CSVNumericObjectFileWriter () | |
virtual void | PrintSelf (std::ostream &os, Indent indent) const ITK_OVERRIDE |
virtual | ~CSVNumericObjectFileWriter () |
Protected Member Functions inherited from itk::LightProcessObject | |
virtual void | GenerateData () |
LightProcessObject () | |
~LightProcessObject () | |
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 |
TValue * | m_InputObject |
StringVectorType | m_RowHeaders |
SizeValueType | m_Rows |
Additional Inherited Members | |
Protected Types inherited from itk::LightObject | |
typedef int | InternalReferenceCountType |
Protected Attributes inherited from itk::LightObject | |
InternalReferenceCountType | m_ReferenceCount |
SimpleFastMutexLock | m_ReferenceCountLock |
typedef SmartPointer<const Self> itk::CSVNumericObjectFileWriter< TValue, NRows, NColumns >::ConstPointer |
Definition at line 68 of file itkCSVNumericObjectFileWriter.h.
typedef itk::Matrix<TValue,NRows,NColumns> itk::CSVNumericObjectFileWriter< TValue, NRows, NColumns >::itkMatrixType |
Definition at line 79 of file itkCSVNumericObjectFileWriter.h.
typedef SmartPointer<Self> itk::CSVNumericObjectFileWriter< TValue, NRows, NColumns >::Pointer |
Definition at line 67 of file itkCSVNumericObjectFileWriter.h.
typedef CSVNumericObjectFileWriter itk::CSVNumericObjectFileWriter< TValue, NRows, NColumns >::Self |
Standard class typedefs
Definition at line 65 of file itkCSVNumericObjectFileWriter.h.
typedef itk::Size<2>::SizeValueType itk::CSVNumericObjectFileWriter< TValue, NRows, NColumns >::SizeValueType |
Definition at line 83 of file itkCSVNumericObjectFileWriter.h.
typedef std::vector<std::string> itk::CSVNumericObjectFileWriter< TValue, NRows, NColumns >::StringVectorType |
Definition at line 81 of file itkCSVNumericObjectFileWriter.h.
typedef LightProcessObject itk::CSVNumericObjectFileWriter< TValue, NRows, NColumns >::Superclass |
Definition at line 66 of file itkCSVNumericObjectFileWriter.h.
typedef vnl_matrix_fixed<TValue, NRows, NColumns> itk::CSVNumericObjectFileWriter< TValue, NRows, NColumns >::vnlFixedMatrixType |
Definition at line 78 of file itkCSVNumericObjectFileWriter.h.
typedef vnl_matrix<TValue> itk::CSVNumericObjectFileWriter< TValue, NRows, NColumns >::vnlMatrixType |
Definition at line 74 of file itkCSVNumericObjectFileWriter.h.
|
protected |
|
inlineprotectedvirtual |
Definition at line 116 of file itkCSVNumericObjectFileWriter.h.
|
private |
void itk::CSVNumericObjectFileWriter< TValue, NRows, NColumns >::ColumnHeadersPushBack | ( | const std::string & | ) |
|
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::LightProcessObject.
|
virtual |
Run-time type information (and related methods).
Reimplemented from itk::LightProcessObject.
|
static |
Method for creation through the object factory.
|
private |
void itk::CSVNumericObjectFileWriter< TValue, NRows, NColumns >::PrepareForWriting | ( | ) |
|
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::LightProcessObject.
void itk::CSVNumericObjectFileWriter< TValue, NRows, NColumns >::RowHeadersPushBack | ( | const std::string & | ) |
void itk::CSVNumericObjectFileWriter< TValue, NRows, NColumns >::SetColumnHeaders | ( | const StringVectorType & | columnheaders | ) |
|
virtual |
|
virtual |
void itk::CSVNumericObjectFileWriter< TValue, NRows, NColumns >::SetInput | ( | const vnlMatrixType * | obj | ) |
Set the input object if the matrix is of vnl_matrix type or Array2D.
void itk::CSVNumericObjectFileWriter< TValue, NRows, NColumns >::SetInput | ( | const vnlFixedMatrixType * | obj | ) |
Set the input object if the matrix is of vnl_matrix_fixed type.
void itk::CSVNumericObjectFileWriter< TValue, NRows, NColumns >::SetInput | ( | const itkMatrixType * | obj | ) |
Set the input object if the matrix is of itkMatrixType.
void itk::CSVNumericObjectFileWriter< TValue, NRows, NColumns >::SetRowHeaders | ( | const StringVectorType & | rowheaders | ) |
|
virtual |
Aliased to the Write() method to be consistent with the rest of the pipeline.
|
virtual |
Write out the object
|
private |
Definition at line 125 of file itkCSVNumericObjectFileWriter.h.
|
private |
Definition at line 124 of file itkCSVNumericObjectFileWriter.h.
|
private |
Definition at line 122 of file itkCSVNumericObjectFileWriter.h.
|
private |
Definition at line 120 of file itkCSVNumericObjectFileWriter.h.
|
private |
Definition at line 121 of file itkCSVNumericObjectFileWriter.h.
|
private |
Definition at line 126 of file itkCSVNumericObjectFileWriter.h.
|
private |
Definition at line 123 of file itkCSVNumericObjectFileWriter.h.