mlDicomFrameSelectionTools.h

Go to the documentation of this file.

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

//----------------------------------------------------------------------------------
 
#pragma once
 
#include "MLDicomToMLToolsSystem.h"
#include <mlModuleIncludes.h>
#include <DCMTree_Lib.h>
 
ML_START_NAMESPACE
 
// Forward of volume representation of DirectDicomImport module.
class _DicomDateTimeTagIds;
class BitImage;

namespace DicomToMLTools {

    enum VoxelDoubleOperations {
      Copy = 0, 
      Add,      
      Multiply  
    };

    enum {
      NumberOfVoxelDoubleOperations = Multiply + 1
    }; 

    extern MLDICOM_TO_ML_TOOLS_EXPORT const char * const VoxelDoubleOperationsStrings[NumberOfVoxelDoubleOperations];

    struct FrameSpecificTags {
      inline FrameSpecificTags(MLint z=0, MLint t=0, MLint u=0): 
          zPosition(z), tPosition(t), uPosition(u), tagMap() {}
      
      MLint zPosition;

      MLint tPosition;
      
      MLint uPosition;
      
      std::map<DCMTree::RawTagId, DCMTree::Const_TagPtr> tagMap;
    };

    typedef std::vector< FrameSpecificTags > FrameSpecificTagsVector;

    struct PositionSpecificDouble {
      inline PositionSpecificDouble(MLint z=0, MLint t=0, MLint u=0, MLdouble v=0.): 
          zPosition(z), tPosition(t), uPosition(u), doubleVal(v) {}
      
      MLint    zPosition;

      MLint    tPosition;
      
      MLint    uPosition;
      
      MLdouble doubleVal;
    };

    typedef std::vector< PositionSpecificDouble > PositionSpecificDoubleVector;
    
    //          any tagId could be found then tagPtr is non nullptr, otherwise nullptr for that frame.
    MLDICOM_TO_ML_TOOLS_EXPORT FrameSpecificTagsVector getFrameSpecificTagSet(const DCMTree::Const_StructuredMFPtr &smfTree,
                                                                              const std::vector<DCMTree::RawTagId> &tagIds);

    //          tagId could be found then tagPtr is non nullptr, otherwise nullptr for that frame.
    MLDICOM_TO_ML_TOOLS_EXPORT FrameSpecificTagsVector getFrameSpecificTags(const DCMTree::Const_StructuredMFPtr &smfTree,
                                                                            DCMTree::RawTagId                    tagId);
    
    MLDICOM_TO_ML_TOOLS_EXPORT size_t convertToFrameSpecificDoubles(const FrameSpecificTagsVector &frameSpecificTags,
                                                                    PositionSpecificDoubleVector  &frameSpecificDoubles);
    
    MLDICOM_TO_ML_TOOLS_EXPORT bool applyFrameSpecificOperation(const VoxelDoubleOperations        &operationMode,
                                                                const SubImage                     &srcSubImage,
                                                                SubImage                           &dstSubImage,
                                                                const PositionSpecificDoubleVector &positionDoubles,
                                                                const VoxelDoubleOperations        dummyOperationMode   = Copy,
                                                                const MLdouble                     dummyOperationValue  = 0.0,
                                                                PositionSpecificDoubleVector       *valueFreePositions  = nullptr,
                                                                bool                               isOldMultiFrameDICOM = false);

    MLDICOM_TO_ML_TOOLS_EXPORT const FrameSpecificTags *getFrameSpecificTagsSet(const FrameSpecificTagsVector &tagSet,
                                                                                MLint z, MLint t, MLint u);
    
    MLDICOM_TO_ML_TOOLS_EXPORT bool isVolumeCovered(const PositionSpecificDoubleVector &positions,
                                                    const SubImageBox                  &volume);

    MLDICOM_TO_ML_TOOLS_EXPORT bool getPositionSpecificDoubleProperties(const PositionSpecificDoubleVector &positions,
                                                                        double                             &rangeMin,
                                                                        double                             &rangeMax,
                                                                        bool                               &hasFractionalParts);
 
};
 
ML_END_NAMESPACE