itkArray2D.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  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
 *
 *         http://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 __itkArray2D_h
#define __itkArray2D_h

#include "itkMacro.h"
#include "vnl/vnl_matrix.h"

namespace itk
{
template< typename TValueType >
class Array2D:public vnl_matrix< TValueType >
{
public:

  typedef TValueType               ValueType;
  typedef Array2D                  Self;
  typedef vnl_matrix< TValueType > VnlMatrixType;
public:

  Array2D();
  Array2D(unsigned int rows, unsigned int cols);
  Array2D(const Self & array);
  Array2D(const VnlMatrixType & matrix);

  const Self & operator=(const Self & array);

  const Self & operator=(const VnlMatrixType & matrix);

  void Fill(TValueType const & v) { this->fill(v); }

  void SetSize(unsigned int m, unsigned int n);

  ~Array2D() {}
};

template< typename TValueType >
std::ostream & operator<<(std::ostream & os, const Array2D< TValueType > & arr)
{
  const unsigned int numberOfColumns = arr.cols();
  const unsigned int numberOfRows    = arr.rows();
  const signed int   lastColumn = (signed int)numberOfColumns - 1;

  for ( unsigned int r = 0; r < numberOfRows; ++r )
    {
    os << "[";
    for ( signed int c = 0; c < lastColumn; ++c )
      {
      os << arr(r, c) << ", ";
      }
    if ( numberOfColumns >= 1 )
      {
      os << arr(r, lastColumn);
      }
    os << "]" << std::endl;
    }

  return os;
}
} // namespace itk

// Define instantiation macro for this template.
#define ITK_TEMPLATE_Array2D(_, EXPORT, TypeX, TypeY)                                  \
  namespace itk                                                                        \
  {                                                                                    \
  _( 1 ( class EXPORT Array2D< ITK_TEMPLATE_1 TypeX > ) )                              \
  _( 1 ( EXPORT std::ostream & operator<<(std::ostream &,                              \
                                          const Array2D< ITK_TEMPLATE_1 TypeX > &) ) ) \
  namespace Templates                                                                  \
  {                                                                                    \
  typedef Array2D< ITK_TEMPLATE_1 TypeX > Array2D##TypeY;                            \
  }                                                                                    \
  }

#if ITK_TEMPLATE_EXPLICIT
#include "Templates/itkArray2D+-.h"
#endif

#if ITK_TEMPLATE_TXX
#include "itkArray2D.hxx"
#endif

#endif