Source: segment.js

  1. const _attrs = Symbol('attrs')
  3. /**
  4.  * A segment.
  5.  *
  6.  * Describes an item of the Segment Sequence of a DICOM Segmentation instance.
  7.  *
  8.  * @class
  9.  * @memberof segment
  10.  */
  11. class Segment {
  12.   /**
  13.    * @param {Object} options - Options for construction of Segment
  14.    * @param {string} options.uid - Unique tracking identifier
  15.    * @param {number} options.number - Segment Number (one-based index value)
  16.    * @param {string} options.label - Segment Label
  17.    * @param {string} options.algorithmName - Segment Algorithm Name
  18.    * @param {Object} options.algorithmType - Segment Algorithm Type
  19.    * @param {Object} options.propertyCategory - Segmented Property Category Code
  20.    * @param {Object} options.propertyType - Segmented Property Type Code
  21.    * @param {string} options.studyInstanceUID - Study Instance UID of DICOM
  22.    * Segmentation instances
  23.    * @param {string} options.seriesInstanceUID - Series Instance UID of DICOM
  24.    * Segmentation instances
  25.    * @param {string[]} options.sopInstanceUIDs - SOP Instance UIDs of DICOM
  26.    * Segmentation instances
  27.    * @param {string|undefined} options.paletteColorLookupTableUID - Palette
  28.    * Color Lookup Table UID
  29.    */
  30.   constructor ({
  31.     uid,
  32.     number,
  33.     label,
  34.     propertyCategory,
  35.     propertyType,
  36.     algorithmType,
  37.     algorithmName,
  38.     studyInstanceUID,
  39.     seriesInstanceUID,
  40.     sopInstanceUIDs,
  41.     paletteColorLookupTableUID
  42.   }) {
  43.     this[_attrs] = {}
  44.     if (uid === undefined) {
  45.       throw new Error('Unique Tracking Identifier is required.')
  46.     } else {
  47.       this[_attrs].uid = uid
  48.     }
  50.     if (number === undefined) {
  51.       throw new Error('Segment Number is required.')
  52.     }
  53.     this[_attrs].number = number
  55.     if (label === undefined) {
  56.       throw new Error('Segment Label is required.')
  57.     }
  58.     this[_attrs].label = label
  60.     if (propertyCategory === undefined) {
  61.       throw new Error('Segmented Property Category Code is required.')
  62.     }
  63.     this[_attrs].propertyCategory = propertyCategory
  65.     if (propertyType === undefined) {
  66.       throw new Error('Segmented Property Type Code is required.')
  67.     }
  68.     this[_attrs].propertyType = propertyType
  70.     if (algorithmName === undefined) {
  71.       throw new Error('Segment Algorithm Name is required.')
  72.     }
  73.     this[_attrs].algorithmType = algorithmType
  75.     if (algorithmType === undefined) {
  76.       throw new Error('Segment Algorithm Type is required.')
  77.     }
  78.     this[_attrs].algorithmName = algorithmName
  80.     if (studyInstanceUID === undefined) {
  81.       throw new Error('Study Instance UID is required.')
  82.     }
  83.     this[_attrs].studyInstanceUID = studyInstanceUID
  85.     if (seriesInstanceUID === undefined) {
  86.       throw new Error('Series Instance UID is required.')
  87.     }
  88.     this[_attrs].seriesInstanceUID = seriesInstanceUID
  90.     if (sopInstanceUIDs === undefined) {
  91.       throw new Error('SOP Instance UIDs are required.')
  92.     }
  93.     this[_attrs].sopInstanceUIDs = sopInstanceUIDs
  95.     this[_attrs].paletteColorLookupTableUID = paletteColorLookupTableUID
  97.     Object.freeze(this)
  98.   }
  100.   /**
  101.    * Unique Tracking Identifier
  102.    *
  103.    * @type string
  104.    */
  105.   get uid () {
  106.     return this[_attrs].uid
  107.   }
  109.   /**
  110.    * Segment Number.
  111.    *
  112.    * @type number
  113.    */
  114.   get number () {
  115.     return this[_attrs].number
  116.   }
  118.   /**
  119.    * Segment Label
  120.    *
  121.    * @type string
  122.    */
  123.   get label () {
  124.     return this[_attrs].label
  125.   }
  127.   /**
  128.    * Segment Algorithm Name
  129.    *
  130.    * @type string
  131.    */
  132.   get algorithmName () {
  133.     return this[_attrs].algorithmName
  134.   }
  136.   /**
  137.    * Segment Algorithm Type
  138.    *
  139.    * @type object
  140.    */
  141.   get algorithmType () {
  142.     return this[_attrs].algorithmType
  143.   }
  145.   /**
  146.    * Segmented Property Category Code
  147.    *
  148.    * @type object
  149.    */
  150.   get propertyCategory () {
  151.     return this[_attrs].propertyCategory
  152.   }
  154.   /**
  155.    * Segmented Property Type Code
  156.    *
  157.    * @type object
  158.    */
  159.   get propertyType () {
  160.     return this[_attrs].propertyType
  161.   }
  163.   /**
  164.    * Study Instance UID of DICOM Segmentation instances.
  165.    *
  166.    * @type string
  167.    */
  168.   get studyInstanceUID () {
  169.     return this[_attrs].studyInstanceUID
  170.   }
  172.   /**
  173.    * Series Instance UID of DICOM Segmentation instances.
  174.    *
  175.    * @type string
  176.    */
  177.   get seriesInstanceUID () {
  178.     return this[_attrs].seriesInstanceUID
  179.   }
  181.   /**
  182.    * SOP Instance UIDs of DICOM Segmentation instances.
  183.    *
  184.    * @type string[]
  185.    */
  186.   get sopInstanceUIDs () {
  187.     return this[_attrs].sopInstanceUIDs
  188.   }
  190.   /**
  191.    * Palette Color Lookup Table UID.
  192.    *
  193.    * @type string
  194.    */
  195.   get paletteColorLookupTableUID () {
  196.     return this[_attrs].paletteColorLookupTableUID
  197.   }
  198. }
  200. export { Segment }