itkValarrayImageContainer.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkValarrayImageContainer.h,v $
  Language:  C++
  Date:      $Date: 2009-03-03 15:11:20 $
  Version:   $Revision: 1.15 $

  Copyright (c) Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even 
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/
#ifndef __itkValarrayImageContainer_h
#define __itkValarrayImageContainer_h

#include "itkObject.h"
#include "itkObjectFactory.h"

#include <utility>
#include <valarray>

namespace itk
{

template <
  typename TElementIdentifier,
  typename TElement
  >
class ValarrayImageContainer: 
  public Object,
  private std::valarray<TElement>
{
public:
  typedef ValarrayImageContainer     Self;
  typedef Object                     Superclass;
  typedef SmartPointer<Self>         Pointer;
  typedef SmartPointer<const Self>   ConstPointer;

  typedef TElementIdentifier  ElementIdentifier;
  typedef TElement            Element;

private:
  typedef std::valarray<Element>  ValarrayType;

protected:
  ValarrayImageContainer():
    ValarrayType() {}
  ValarrayImageContainer(unsigned long n):
    ValarrayType(n) {}
  ValarrayImageContainer(unsigned long n, const Element& x):
    ValarrayType(n, x) {}
  ValarrayImageContainer(const Self& r):
    ValarrayType(r) {}

public:
  itkNewMacro(Self);

  itkTypeMacro(ValarrayImageContainer, Object);

  TElement & operator[](const ElementIdentifier id)
    { return this->ValarrayType::operator[](id); };

  const TElement & operator[](const ElementIdentifier id) const
    { return this->ValarrayType::operator[](id); };

  TElement *GetBufferPointer() 
    {
    if (this->Size() > 0)
      {
      return &(this->ValarrayType::operator[](0));
      }
    else
      {
      return NULL;
      }
    };

  unsigned long Size(void) const
    { return static_cast<unsigned long>(this->ValarrayType::size()); }

  void Reserve(ElementIdentifier num)
    { this->ValarrayType::resize(num); }

  void Squeeze(void)
    { this->ValarrayType::resize( this->ValarrayType::size() ); }

  void Initialize(void)
    { this->ValarrayType::resize( 0 ); }

  void Fill(const TElement & value)
    { this->ValarrayType::operator=( value ); }

public:
  virtual void PrintSelf(std::ostream& os, Indent indent) const
    {
    Object::PrintSelf(os, indent);
    // Print out the pointer to bulk data memory. We use const_cast<> to
    // cast away the constness so we can call GetBufferPointer()
    os << indent << "Pointer: "
       << const_cast<ValarrayImageContainer*>(this)->GetBufferPointer()
       << std::endl;

    os << indent << "Size: " << this->Size() << std::endl;
    }
  
};

} // end namespace itk
  
#endif