mitkImageDescriptor.h

Go to the documentation of this file.

/*============================================================================
 
The Medical Imaging Interaction Toolkit (MITK)
 
Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.
 
Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.
 
============================================================================*/
 
#ifndef mitkImageDescriptor_h
#define mitkImageDescriptor_h
 
#include <itkObjectFactory.h>
 
#include <string>
#include <vector>
 
#include <mitkChannelDescriptor.h>
#include <mitkCommon.h>
 
#define MAX_IMAGE_DIMENSIONS 8
 
namespace mitk
{
  class MITKCORE_EXPORT ImageDescriptor : public itk::Object
  {
  public:
    mitkClassMacroItkParent(ImageDescriptor, itk::Object);
 
    itkFactorylessNewMacro(Self);
 
    itkCloneMacro(Self);
 
    void AddNewChannel(mitk::PixelType ptype, const char *name = nullptr);
 
    void Initialize(const unsigned int *dims, const unsigned int dim);
 
    void Initialize(const ImageDescriptor::Pointer refDescriptor, unsigned int channel = 0);
 
    const unsigned int *GetDimensions() const { return m_Dimensions; }
 
    unsigned int GetNumberOfDimensions() const { return m_NumberOfDimensions; }
 
    const std::string GetChannelName(unsigned int id) const;
 
    PixelType GetChannelTypeByName(const char *name) const;
 
    PixelType GetChannelTypeById(unsigned int id) const;
 
    ChannelDescriptor GetChannelDescriptor(unsigned int id = 0) const;
 
    unsigned int GetNumberOfChannels() const { return m_NumberOfChannels; }
  protected:
    ImageDescriptor();
 
    ~ImageDescriptor() override{};
 
  private:
    std::vector<ChannelDescriptor> m_ChannelDesc;
 
    std::vector<std::string> m_ChannelNames;
 
    typedef std::vector<std::string>::const_iterator ConstChannelNamesIter;
 
    typedef std::vector<ChannelDescriptor>::const_iterator ConstChannelsIter;
 
    unsigned int m_NumberOfChannels;
 
    unsigned int m_NumberOfDimensions;
 
    unsigned int m_Dimensions[MAX_IMAGE_DIMENSIONS];
  };
 
} // end namespace
#endif