mlDICOMCachedIOTools.h

Go to the documentation of this file.

// Copyright (c) Fraunhofer MEVIS, Germany. All rights reserved.
// **InsertLicense** code
//----------------------------------------------------------------------------------
 
//----------------------------------------------------------------------------------
#pragma once
 
// Local includes
#include "MLDICOMCachedIOSystem.h"
#include "mlTypeDefs.h"
 
#include <FMEThirdPartyWarningsDisable.h>
#include <string>
#include <sstream>
#include <FMEThirdPartyWarningsRestore.h>
 
#include <DCMTree_Lib.h>
 
ML_START_NAMESPACE
 
class Base;
class DicomMessageCollector;
class PagedImage;
 
template<typename CT> class DICOMCachedIOFileHandleBase;
 
 
typedef DICOMCachedIOFileHandleBase<char> DICOMCachedIOFileHandle;
 
namespace DICOMCachedIOTools {
 
MLDICOMCachedIO_EXPORT void pushMessageCollecting();
 
MLDICOMCachedIO_EXPORT void popMessageCollecting(DicomMessageCollector &dcmMsgCollector,
                                                 const std::string     &callersMessage,
                                                 size_t                outStrMaxSize = std::string::npos,
                                                 bool                  addClampInfo  = true);
 
MLDICOMCachedIO_EXPORT void redirectStream(std::ostream   &outputStream,
                                           std::streambuf *&tempBuf,
                                           std::stringbuf *&stringBuffer);
 
MLDICOMCachedIO_EXPORT std::string unRedirectStream(std::ostream   &outputStream,
                                                    std::streambuf *&tmpBuf,
                                                    std::stringbuf *&stringBuffer,
                                                    size_t         outStrMaxSize = std::string::npos,
                                                    bool           addClampInfo  = true);
 
 
MLDICOMCachedIO_EXPORT void makeWarningsWarningsAndErrorsErrors(std::string &messageString);
 
MLDICOMCachedIO_EXPORT void logFileCheckInfos(const std::string &fileName,
                                              DicomMessageCollector &dcmMsgCollector,
                                              bool pedantic = true,
                                              bool doWarnEmpty = false,
                                              bool doWarnFullPathLonger254 = false,
                                              bool doWarnSpaces = false,
                                              bool doWarnUntypicalChars = false,
                                              bool warnBaseNamesLonger31 = false);
 
MLDICOMCachedIO_EXPORT std::string logFileCheckInfosIntoString(const std::string &fileName,
                                                               const std::string &prependMessage = " ",
                                                               bool pedantic = true,
                                                               bool doWarnEmpty = false,
                                                               bool doWarnFullPathLonger254 = false,
                                                               bool doWarnSpaces = false,
                                                               bool doWarnUntypicalChars = false,
                                                               bool warnBaseNamesLonger31 = false);
 
MLDICOMCachedIO_EXPORT DCMTree::TreePtr getDirectDCMTree(const std::string     &fName, 
                                                         DicomMessageCollector &dcmMsgCollector,
                                                         bool                  loadPixelData=false);
 
MLDICOMCachedIO_EXPORT MLErrorCode getDCMTreeFromDICOMFile(const std::string      &dcmFileName,
                                                           DCMTree::Const_TreePtr &treePtr,
                                                           size_t                 &numVols,
                                                           DicomMessageCollector  &dcmMsgCollector);
 
MLDICOMCachedIO_EXPORT MLErrorCode getDCMTreeFromDCMTiffFilePair(const std::string      &dcmTiffFileName,
                                                                 DCMTree::Const_TreePtr &treePtr,
                                                                 size_t                 &numVols,
                                                                 DicomMessageCollector  &dcmMsgCollector);
 
MLDICOMCachedIO_EXPORT void getDCMTreeFromPagedImage(PagedImage             *inImg,
                                                     DCMTree::Const_TreePtr &treePtr,
                                                     size_t                 &numVols);
 
MLDICOMCachedIO_EXPORT void getDCMTreeFromDicomTreeBasePtr(Base                   *basePtr,
                                                           DCMTree::Const_TreePtr &treePtr,
                                                           size_t                 &numVols);
 
enum { NumLosslessTransferSyntaxes = 8 };
 
MLDICOMCachedIO_EXPORT extern const char * const LosslessTransferSyntaxUIDs[NumLosslessTransferSyntaxes];
 
MLDICOMCachedIO_EXPORT extern const char * const LosslessTransferSyntaxNames[NumLosslessTransferSyntaxes];
 
MLDICOMCachedIO_EXPORT extern DCMTree::TransferSyntax LosslessTransferSyntaxCodes[NumLosslessTransferSyntaxes];
 
MLDICOMCachedIO_EXPORT DCMTree::TransferSyntax getLosslessStorageTransferSyntax(DCMTree::Const_TreePtr dcmTree);
 
MLDICOMCachedIO_EXPORT DCMTree::Const_TagPtr getPrivateTag(const std::string      &privateCreatorString,
                                                           unsigned short         groupId,
                                                           DCMTree::RawTagId      lowerEightBitOfElementId,
                                                           DCMTree::Const_TreePtr dcmTree);
 
MLDICOMCachedIO_EXPORT bool isPhilips3D(DCMTree::Const_TreePtr dcmTree, 
                                        MLint *spatialExtent=nullptr);
 
MLDICOMCachedIO_EXPORT unsigned int getNumberOfFrames(DCMTree::Const_TreePtr dcmTree, 
                                                      unsigned int *fromTagOnly=nullptr);
 
MLDICOMCachedIO_EXPORT DCMTree::PixelData getPixelDataPtrFromTree(DCMTree::Const_TreePtr treePtr,
                                                                  size_t                 *valSizeInBytes,
                                                                  DicomMessageCollector  &dcmMsgCollector);
 
MLDICOMCachedIO_EXPORT void removeAssociatedCacheEntries(const DICOMCachedIOFileHandle &fileHandle);
 
MLDICOMCachedIO_EXPORT void clearDICOMCaches();
 
} // namespace DICOMCachedIOTools
 
ML_END_NAMESPACE