mlDicomSegmentItem.h

Go to the documentation of this file.

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

//----------------------------------------------------------------------------------
 
#pragma once
 
#include "MLMLToDicomToolsSystem.h"
#include <mlModuleIncludes.h>
 
ML_START_NAMESPACE
 
// Forward to (in derived instances) internally generated or managed image instances.
class DicomSegmentItemImageBase;

class ML_MLToDicomTools_EXPORT DicomSegmentItem {
  public:
    
    enum SegmentAlgorithmType {
      AUTOMATIC = 0, 
      SEMIAUTOMATIC, 
      MANUAL         
    };

    enum { NumberOfSegmentAlgorithmTypes = 3 };
    
    static const char * const SegmentAlgorithmTypeStrings[NumberOfSegmentAlgorithmTypes];
    
    DicomSegmentItem(unsigned int segNumber = 1u,
                     const std::string& segLabel = "",
                     const std::string& segDescription = "",
                     SegmentAlgorithmType segAlgorithmType = MANUAL,
                     const std::string& segAlgorithmName = "",
                     const Vector3& recommDisplayCIELabValue = Vector3(100.0, 0.0052605, -0.0104082),
                     const double segImageValueRangeMin = 0.999,
                     const double segImageValueRangeMax = ML_DOUBLE_MAX);
    
    virtual ~DicomSegmentItem();
    
    unsigned int segmentNumber;

    std::string segmentLabel;
    
    std::string segmentDescription;
    
    SegmentAlgorithmType segmentAlgorithmType;
    
    std::string segmentAlgorithmName;
    
    Vector3 recommendedDisplayCIELabValue;
    
    double segmentImageValueRangeMin;
    
    double segmentImageValueRangeMax;
    
    // TODO:
    // - Segment Property Category Code Sequence
    //   - Code Sequence Baseline CID 7150 “Segmentation Property Categories”
    // - Segment Property Type Code Sequence
    //   - Code Sequence Baseline CID 7151 “Segmentation Property Types”
    //   - Segment Property TZype Modifier Code Sequence
    //     - Code Sequence Baseline CID 244 “Laterality”
    
    std::string getAlgorithmTypeAsString() const;
    
    virtual const DicomSegmentItemImageBase* getSegmentItemImage();
    
    std::string getAsBase64CodedString() const;

    static std::string getVersionNumber(const std::string& codedFirstLine);

    static size_t getNumCodedLinesPerItem(const std::string& codedFirstLine);
    
    void setFromBase64CodedString(const std::string& codedItem);
    
    static std::string setUpSegmentSequenceFromLines(std::vector<std::string>& inputLines,
                                                     std::vector<DicomSegmentItem>& resultItems);
 
};

typedef std::vector<DicomSegmentItem> DicomSegmentItemVector;
 
ML_END_NAMESPACE