mitkImagePixelAccessor.h

Go to the documentation of this file.

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

The Medical Imaging Interaction Toolkit (MITK)

Copyright (c) German Cancer Research Center,
Division of Medical and Biological Informatics.
All rights reserved.

This software is distributed WITHOUT ANY WARRANTY; without
even the implied warranty of MERCHANTABILITY or FITNESS FOR
A PARTICULAR PURPOSE.

See LICENSE.txt or http://www.mitk.org for details.

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

#ifndef MITKIMAGEPIXELACCESSOR_H
#define MITKIMAGEPIXELACCESSOR_H

#include "mitkImage.h"
#include "mitkImageDataItem.h"

namespace mitk
{
  template <class TPixel, unsigned int VDimension = 3>
  class ImagePixelAccessor
  {
    friend class Image;

  public:
    typedef itk::Index<VDimension> IndexType;
    typedef ImagePixelAccessor<TPixel, VDimension> ImagePixelAccessorType;
    typedef Image::ConstPointer ImageConstPointer;

    int GetDimension(int i) const { return m_ImageDataItem->GetDimension(i); }
  protected:
    ImagePixelAccessor(ImageConstPointer iP, const mitk::ImageDataItem *iDI) : m_ImageDataItem(iDI)
    {
      if (iDI == nullptr)
      {
        m_ImageDataItem = iP->GetChannelData();
      }
      CheckData(iP.GetPointer());
    }

    virtual ~ImagePixelAccessor() {}
    void CheckData(const Image *image)
    {
      // Check if Dimensions are correct
      if (m_ImageDataItem == nullptr)
      {
        if (image->GetDimension() != VDimension)
        {
          mitkThrow() << "Invalid ImageAccessor: The Dimensions of ImageAccessor and Image are not equal. They have to "
                         "be equal if an entire image is requested";
        }
      }
      else
      {
        if (m_ImageDataItem->GetDimension() != VDimension)
        {
          mitkThrow() << "Invalid ImageAccessor: The Dimensions of ImageAccessor and ImageDataItem are not equal.";
        }
      }

      // Check if PixelType is correct
      if (!(image->GetPixelType() == mitk::MakePixelType<itk::Image<TPixel, VDimension>>() ||
            image->GetPixelType() ==
              mitk::MakePixelType<itk::VectorImage<TPixel, VDimension>>(image->GetPixelType().GetNumberOfComponents())))
      {
        mitkThrow() << "Invalid ImageAccessor: PixelTypes of Image and ImageAccessor are not equal";
      }
    }

  protected:
    // protected members

    const ImageDataItem *m_ImageDataItem;

    BaseGeometry::Pointer m_Geometry;

    itk::ImageRegion<VDimension> *m_SubRegion;

    int m_Options;

    unsigned int GetOffset(const IndexType &idx) const
    {
      const unsigned int *imageDims = m_ImageDataItem->m_Dimensions;

      unsigned int offset = 0;
      switch (VDimension)
      {
        case 4:
          offset += idx[3] * imageDims[0] * imageDims[1] * imageDims[2];
        case 3:
          offset += idx[2] * imageDims[0] * imageDims[1];
        case 2:
          offset += idx[0] + idx[1] * imageDims[0];
          break;
      }
      return offset;
    }
  };
}

#endif // MITKIMAGEACCESSOR_H