mlDicomToMLSubImageCopyParameters.h

Go to the documentation of this file.

// Copyright (c) Fraunhofer MEVIS, Germany. All rights reserved.
// **InsertLicense** code
//----------------------------------------------------------------------------------

//----------------------------------------------------------------------------------
#pragma once
 
// Local includes
#include "MLDicomToMLToolsSystem.h"
 
// Handle to reference DICOM files or URLS. 
#include "mlDICOMCachedIOFileHandle.h"
#include "mlDICOMCachedIOProxies.h"
 
// DICOM tree prototypes.
#include <DCMTree_Lib.h>
 
// ML includes
#include <mlModuleIncludes.h>
 
ML_START_NAMESPACE
 
// Forwards
class DicomMessageCollector;
 
namespace DicomToMLTools {
 
//----------------------------------------------------------------------------------
//----------------------------------------------------------------------------------
struct DICOMPixelReadAndCopyParameterResults {
  DCMTree::Const_TreePtr    dcmTree;
  DCMTree::PixelData        pixelData;
  bool                      pixelDataIsAFrameFromMFCache;
  const DCMTree::MFPixelTag *mfPixelDataTag;
  MLDataType                srcPixelDataType;
  bool                      isInterleaved;
  bool                      isDICOMBitImg;
  MLint                     timeUnrollSteps;
  size_t                    dimIdx;
  SubImageBox               readFrameBox;
  ImageVector               frameShift;
  MLErrorCode               errorCode;
};
 
//----------------------------------------------------------------------------------
//----------------------------------------------------------------------------------
class DICOMPixelReadAndCopyParameters
{
public:
  DICOMPixelReadAndCopyParameters(const DICOMCachedIOFileHandle &dcmFileHandleIn,
                                  DCMTree::Const_TreePtr        alternativeDCMTreeIn,
                                  const bool                    allowMemoryCompatibleColorModelsIn,
                                  SubImage                      &outSubImgIn,
                                  DicomMessageCollector         &dcmMsgCollectorIn): 
    cacheProxies(),
    dcmFileHandle(dcmFileHandleIn),
    alternativeDCMTree(alternativeDCMTreeIn),
    allowMemoryCompatibleColorModels(allowMemoryCompatibleColorModelsIn),
    outSubImg(outSubImgIn),
    dcmMsgCollector(dcmMsgCollectorIn),
    
    results(_validateResults())
  {}

  MLDICOMCachedIOProxies        cacheProxies;
  
  const DICOMCachedIOFileHandle &dcmFileHandle;
  
  DCMTree::Const_TreePtr        alternativeDCMTree;
  
  const bool                    allowMemoryCompatibleColorModels;
  
  SubImage                      &outSubImg;

  DicomMessageCollector         &dcmMsgCollector;
  
  const DICOMPixelReadAndCopyParameterResults results;

  std::vector<boost::shared_array<unsigned char> > fileNameFreeFrameDataCache;
  
private:
  DICOMPixelReadAndCopyParameters(const DICOMPixelReadAndCopyParameters &); 

  DICOMPixelReadAndCopyParameters &operator=(const DICOMPixelReadAndCopyParameters &); 
  
  DICOMPixelReadAndCopyParameterResults _validateResults();
  
  MLErrorCode _getDCMTreeAndPixelDataFromFileHandle(DCMTree::Const_TreePtr     &dcmTree, 
                                                    DCMTree::PixelData         &pixelData,
                                                    bool                       &isPixelDataFromMFCache,
                                                    size_t                     &pixelDataSize,
                                                    const DCMTree::MFPixelTag *&mfPixelDataTag);
};
 
};
 
ML_END_NAMESPACE