MeVis/Foundation/Sources/DicomTree/MLDicomTree/DCMTree_MFPixelTag.h

Go to the documentation of this file.

// **InsertLicense** code
//-----------------------------------------------------------------------------

#ifndef DCMTREE_PIXELTAG_H
#define DCMTREE_PIXELTAG_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 multiframe images
  // pixel data is not loaded to memory on creation but can be loaded 
  // demand to a user defined and controlled buffer.
  // This class is an abstract class because the file handling differs
  // for different parsers - for the moment dcmtk from OFFIS is supported
  class DCMTREE_EXPORT MFPixelTag : public Tag
  {
  public:
    typedef boost::shared_array<unsigned char> 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);
    
    virtual ~MFPixelTag();

    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 -----
    // has a reasonable meaning and therefore a reasonable implementation
    virtual boost::uint32_t numberOfValues() const;
    virtual boost::uint32_t getValueSize (unsigned int) const;
    virtual boost::uint32_t getValueSize () const;

    // for these functions there is no reasonable semantic in the multiframe case
    virtual Value &addValue();
    virtual void fromStream (std::istream &);
    virtual void toStream (std::ostream &) const;
    // addValue - schwierig, weil es eine Referenz auf ein Value-Objekt zurueck gibt
    // setValue - ok, rangeChecking wirft Exception
    // Value & getValue(); - ok, rangeChecking wirft Exception
    // deepCopy  kann funktionieren
    // toString ? to...
    // de-/serialize - wird nicht gebraucht, kann aber funktionieren
    // compare ?
  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