itkCSVNumericObjectFileWriter.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         https://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
 
#ifndef itkCSVNumericObjectFileWriter_h
#define itkCSVNumericObjectFileWriter_h
 
#include "itkLightProcessObject.h"
#include "itkMacro.h"
#include "itkArray2D.h"
#include "vnl/vnl_matrix.h"
#include "vnl/vnl_matrix_fixed.h"
#include "itkMatrix.h"
#include <vector>
#include "itkSize.h"
 
namespace itk
{
template <typename TValue, unsigned int VRows = 0, unsigned int VColumns = 0>
class ITK_TEMPLATE_EXPORT CSVNumericObjectFileWriter : public LightProcessObject
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(CSVNumericObjectFileWriter);

  using Self = CSVNumericObjectFileWriter;
  using Superclass = LightProcessObject;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(CSVNumericObjectFileWriter);
 
  // Matrix types
  using vnlMatrixType = vnl_matrix<TValue>;
  using vnlFixedMatrixType = vnl_matrix_fixed<TValue, VRows, VColumns>;
  using itkMatrixType = itk::Matrix<TValue, VRows, VColumns>;
 
  using StringVectorType = std::vector<std::string>;
 
  using SizeValueType = itk::Size<2>::SizeValueType;
 
  /* Specify the name of the output file */
  itkSetStringMacro(FileName);
  itkSetMacro(FieldDelimiterCharacter, char);

  void
  SetInput(const vnlMatrixType * obj);

  void
  SetInput(const vnlFixedMatrixType * obj);

  void
  SetInput(const itkMatrixType * obj);
 
  void
  ColumnHeadersPushBack(const std::string &);
  void
  RowHeadersPushBack(const std::string &);
  void
  SetColumnHeaders(const StringVectorType & columnheaders);
  void
  SetRowHeaders(const StringVectorType & rowheaders);
 
  /* Checks that all essential components are plugged in */
  void
  PrepareForWriting();

  virtual void
  Write();

  virtual void
  Update();
 
protected:
  CSVNumericObjectFileWriter();
  ~CSVNumericObjectFileWriter() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
private:
  std::string      m_FileName{};
  TValue *         m_InputObject{};
  char             m_FieldDelimiterCharacter{};
  SizeValueType    m_Rows{};
  SizeValueType    m_Columns{};
  StringVectorType m_ColumnHeaders{};
  StringVectorType m_RowHeaders{};
};
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkCSVNumericObjectFileWriter.hxx"
#endif
 
#endif