itkValarrayImageContainer.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 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 ITK_NULLPTR;
      }
  }

  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 ITK_OVERRIDE
  {
    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