itkCSVArray2DDataObject.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 itkCSVArray2DDataObject_h
#define itkCSVArray2DDataObject_h
 
#include "itkObjectFactory.h"
#include "itkDataObject.h"
#include "itkArray2D.h"
#include "itkMacro.h"
#include <vector>
 
namespace itk
{
 
template <typename TData>
class ITK_TEMPLATE_EXPORT CSVArray2DDataObject : public DataObject
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(CSVArray2DDataObject);
 
  /* Standard class type aliases */
  using Self = CSVArray2DDataObject;
  using Superclass = DataObject;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(CSVArray2DDataObject);
 
  /* Vector type alias. */
  using NumericVectorType = typename std::vector<TData>;
  using StringVectorType = typename std::vector<std::string>;

  using MatrixType = typename itk::Array2D<TData>;

  itkSetMacro(HasColumnHeaders, bool);
  itkSetMacro(HasRowHeaders, bool);
  itkBooleanMacro(HasColumnHeaders);
  itkBooleanMacro(HasRowHeaders);

  itkGetConstMacro(HasColumnHeaders, bool);
  itkGetConstMacro(HasRowHeaders, bool);

  itkGetMacro(Matrix, MatrixType);

  StringVectorType
  GetColumnHeaders() const;

  StringVectorType
  GetRowHeaders() const;

  unsigned int
  GetRowIndexByName(const std::string &) const;

  unsigned int
  GetColumnIndexByName(const std::string &) const;

  NumericVectorType
  GetRow(const std::string &) const;

  NumericVectorType
  GetRow(const unsigned int) const;

  NumericVectorType
  GetColumn(const std::string &) const;

  NumericVectorType
  GetColumn(const unsigned int) const;

  TData
  GetData(const std::string &, const std::string &) const;

  TData
  GetData(const unsigned int, const unsigned int) const;

  TData
  GetColumnData(const std::string &, const unsigned int) const;

  TData
  GetRowData(const std::string &, const unsigned int) const;

  TData
  operator()(const std::string &, const std::string &) const;

  TData
  operator()(const unsigned int, const unsigned int) const;

  void
  SetMatrixSize(unsigned int, unsigned int);

  void
  FillMatrix(TData value);

  void
  SetMatrixData(unsigned int, unsigned int, TData);

  void
  RowHeadersPushBack(const std::string &);

  void
  ColumnHeadersPushBack(const std::string &);

  void
  EraseFirstColumnHeader();
 
protected:
  CSVArray2DDataObject() = default;
  ~CSVArray2DDataObject() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
private:
  MatrixType       m_Matrix{};
  StringVectorType m_ColumnHeaders{};
  StringVectorType m_RowHeaders{};
  bool             m_HasRowHeaders{ false };
  bool             m_HasColumnHeaders{ false };
};
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkCSVArray2DDataObject.hxx"
#endif
 
#endif