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

Go to the documentation of this file.

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

//-----------------------------------------------------------------------------

#ifndef CLASS_DCMTREE_STRUCTUREDMF
#define CLASS_DCMTREE_STRUCTUREDMF

#include "DCMTree_Lib.h"
#include "DCMTree_TagId.h"

#ifdef _MSC_VER
  #pragma warning (push)
  #pragma warning (disable : 4251)
#endif

namespace DCMTree
{
    class DCMTREE_EXPORT StructuredMF
    {
    public:

      typedef std::vector<unsigned int> IndexVector;

      static std::string privateCreator; /* = "MeVis StructuredMF data" */

      // Private group and element id constants used for storing the StructuredMF info
      enum {
        privateGroupId = 0x0041,       

        dimensionsOffset = 1,          
        dimensionSequenceOffset = 2,   
        frameIndexOffset = 3           
      };


      StructuredMF( Const_TreePtr tree );

      StructuredMF( TreePtr tree );

      StructuredMF( TreePtr sharedTagTree, const IndexVector &gridExtent );
      StructuredMF( TreePtr sharedTagTree, unsigned int depth, 
                    unsigned int timePoints = 0, unsigned int u1Size = 0);


      Const_TreePtr tagTree() const;      
      TreePtr tagTree();      

      
      
      TagPtr sharedTag_rw( TagId tagId );
      Const_TagPtr sharedTag( TagId tagId ) const;      
      Const_TagPtr sharedTag( TagId tagId, const std::string& privateCreator, Vr privateVr=UN ) const;      

      TreePtr extractSharedTagTree() const;            
      
      void setSharedTags( TreePtr tree, bool handleFuncGroups = true );

      

      Const_TagPtr tagForGridPosition( TagId tagId, IndexVector gridPosition ) const;
      Const_TagPtr tagForGridPosition( TagId tagId, unsigned int z, unsigned int t = 0, unsigned int u1 = 0 ) const;

      Const_TagPtr tagForGridPosition( TagId tagId, IndexVector gridPosition, const std::string& privateCreator, Vr privateVr=UN ) const;
      Const_TagPtr tagForGridPosition( TagId tagId, const std::string& privateCreator, Vr privateVr, unsigned int z, unsigned int t = 0, unsigned int u1 = 0 ) const;

      int frameIndexForGridPosition( const IndexVector &gridPosition ) const;
      int frameIndexForGridPosition( unsigned int z, unsigned int t = 0, unsigned int u1 = 0 ) const;

      typedef enum {
        ExtractSharedAndSpecific,           
        ExtractSpecific,                    
        ExtractSpecificWithSharedParent     
      } ExtractMode;

      TreePtr extractTagTreeForGridPosition( IndexVector gridPosition, ExtractMode mode = ExtractSharedAndSpecific ) const;
      TreePtr extractTagTreeForGridPosition( unsigned int z, unsigned int t = 0, unsigned int u1 = 0, 
                                             ExtractMode mode = ExtractSharedAndSpecific ) const;
      
      void setTagForGridPosition( TagPtr tag, const IndexVector &gridPosition, const std::string& privateCreator = "", bool skipInvalidPrivateTags = true );
      void setTagForGridPosition( TagPtr tag, unsigned int z, unsigned int t = 0, unsigned int u1 = 0, const std::string& privateCreator = "" );
      
      void setGridPositionSpecificTags( TreePtr tree, const IndexVector &gridPosition, bool skipInvalidPrivateTags = true );
      void setGridPositionSpecificTags( TreePtr tree, unsigned int z, unsigned int t = 0, unsigned int u1 = 0 );
      
      void setFrameIndexForGridPosition( unsigned int frameIndex, const IndexVector &gridPosition );
      void setFrameIndexForGridPosition( unsigned int frameIndex, unsigned int z, unsigned int t = 0, unsigned int u1 = 0 );




      enum StatusCode {
        OK = 0,                        
        NO_PER_FRAME_TAGS,             
        AMBIGUOUS_TAG,                 

        INCONSISTENT_PER_FRAME_TAGS,   

        NUM_STATUS_CODES
      };
      
      void normalizeTagStructure( double tolerance = 0.0, bool compress = true );





      boost::uint32_t getGridDimension() const; 

      const IndexVector& getGridExtent() const;  

      unsigned int getNumberOfFrames() const;

      bool frameExists( const IndexVector& position ) const;

      void getEmptyFrames (std::vector<IndexVector> &positions) const;


    private:
      bool initPrivateTagIds (bool create);
      void clearPrivateTags();
      bool isPrivateTagId (const TagId &tagId) const;
      TagInfo dimensionsTagInfo();
      TagInfo dimensionGroupTagInfo();
      TagInfo frameIndexTagInfo();
      TagInfo defaultCreatorTagInfo();
      void normalizeTagStructure( TreePtr dimTree, double tolerance, bool compress );
      TreePtr gridPositionTagTree( IndexVector gridPosition );
      Const_TreePtr gridPositionTagTree( IndexVector gridPosition ) const;
      void createDimensionSubtree( TagPtr parentSeq, int index);
      void setDimensionsTag();

      IndexVector indexVectorFromIndexes( unsigned int z, unsigned int t, unsigned int u1 ) const;

      bool checkGridPosition( const IndexVector &gridPosition ) const;


      TreePtr _treePtr;
      Const_TreePtr _constTreePtr;
      IndexVector _gridExtent;

      TagId _creatorId, _privateBaseId, _dimensionsId, _dimensionSequenceId, _frameIndexId;
    };
}

#ifdef _MSC_VER
  #pragma warning (pop)
#endif

#endif