DCMTree_MFPixelTag.h

Go to the documentation of this file.

/*************************************************************************************
**
** Copyright 2008, MeVis Medical Solutions AG
**
** The user may use this file in accordance with the license agreement provided with
** the Software or, alternatively, in accordance with the terms contained in a
** written agreement between the user and MeVis Medical Solutions AG.
**
** For further information use the contact form at https://www.mevislab.de/contact
**
**************************************************************************************/
 
#ifndef DCM_TREE_MFPIXEL_TAG_H
#define DCM_TREE_MFPIXEL_TAG_H
 
#include <cstddef>
#include <string>
 
#include <boost/shared_array.hpp>
#include <boost/shared_ptr.hpp>
 
#include "DCMTree_Tag.h"
#include "DCMTree_Value.h"
#include "DCMTree_TagId.h"
#include "DCMTree_FileCache.h"
 
 
namespace DCMTree
{
  // This class manages pixel data access of DICOM multi-frame images.
  // Pixel data is not loaded to memory on creation but can be loaded
  // on demand to a user defined and controlled buffer.
  // This class is an abstract class, as the file handling differs
  // for different parsers - at the moment, dcmtk from OFFIS is supported.
  class DCMTREE_EXPORT MFPixelTag : public Tag
  {
  public:
    typedef DCMTree::pixel_cont_t pixel_cont_t;
    typedef boost::shared_ptr<FileCache> file_cache_t;
 
    MFPixelTag(TagInfo const & tagInfo,
             std::string const & filename,
             boost::uint32_t value_count,
             boost::uint32_t value_size);
 
    ~MFPixelTag() override;

    TagPtr copy() const override = 0;
 
    virtual file_cache_t createFileCache() const =0;
    virtual pixel_cont_t getFrame(boost::uint32_t idx) =0;
    virtual pixel_cont_t getFrame(boost::uint32_t idx, FileCache *cache) =0;
    virtual pixel_cont_t getFrame(boost::uint32_t idx, std::string & colorModel, unsigned int & fragment) =0;
    virtual pixel_cont_t getFrame(boost::uint32_t idx, std::string & colorModel, unsigned int & fragment,
                                  DCMTree::FileCache *cache) =0;
    virtual boost::uint32_t numberOfFrames() const;
    virtual boost::uint32_t frameSize() const;
 
    // ----- DCMTree_Tag Interface -----
    boost::uint32_t numberOfValues() const override;
    boost::uint32_t getValueSize (unsigned int) const override;
    boost::uint32_t getValueSize () const override;
 
  protected:
    boost::uint32_t valueCount() const { return value_count_; }
    boost::uint32_t valueSize()  const { return value_size_; }
    std::string const &  filename()  const { return filename_; }
 
  private:
    boost::uint32_t value_count_;
    boost::uint32_t value_size_;
    std::string filename_;
  };
 
}
 
#endif