tests_dicom_dicomSpatialCoordinate3D.test.js

import {describe, test, assert} from 'vitest';
import {
  SpatialCoordinate3D,
  getSpatialCoordinate3D,
  getDicomSpatialCoordinate3DItem
} from '../../src/dicom/dicomSpatialCoordinate3D.js';
import {DataElement} from '../../src/dicom/dataElement.js';

/**
 * Related DICOM tag keys.
 */
const TagKeys = {
  GraphicData: '00700022',
  GraphicType: '00700023',
  ReferencedFrameofReferenceUID: '30060024',
  FiducialUID: '0070031A'
};

/**
 * Tests for the 'dicom/dicomSpatialCoordinate3D.js' file.
 */

describe('dicom', () => {

  describe('SpatialCoordinate3D', () => {

    /**
     * Tests for {@link SpatialCoordinate3D} undefined.
     *
     * @function module:tests/dicom~spatialcoordinate3d-undefined
     */
    test('undefined', () => {
      const coord = new SpatialCoordinate3D();
      assert.isUndefined(coord.graphicData);
      assert.isUndefined(coord.graphicType);
      assert.isUndefined(coord.referencedFrameofReferenceUID);
      assert.isUndefined(coord.fiducialUID);
    });

    /**
     * Tests for {@link SpatialCoordinate3D} toString.
     *
     * @function module:tests/dicom~spatialcoordinate3d-tostring
     */
    test('toString', () => {
      const coord = new SpatialCoordinate3D();
      coord.graphicType = 'POINT';
      coord.graphicData = ['1.0', '2.0', '3.0'];

      const result = coord.toString();
      assert.equal(result, 'POINT {1.0,2.0,3.0}');
    });

    /**
     * Tests for {@link SpatialCoordinate3D} toString multiple.
     *
     * @function module:tests/dicom~spatialcoordinate3d-tostring-multiple
     */
    test('toString multiple', () => {
      const coord = new SpatialCoordinate3D();
      coord.graphicType = 'POLYLINE';
      coord.graphicData = ['1.0', '2.0', '3.0', '4.0', '5.0', '6.0'];

      const result = coord.toString();
      assert.equal(result, 'POLYLINE {1.0,2.0,3.0,4.0,5.0,6.0}');
    });

    /**
     * Tests for {@link SpatialCoordinate3D} toString empty.
     *
     * @function module:tests/dicom~spatialcoordinate3d-tostring-empty
     */
    test('toString empty', () => {
      const coord = new SpatialCoordinate3D();
      coord.graphicType = 'POINT';
      coord.graphicData = [];

      const result = coord.toString();
      assert.equal(result, 'POINT {}');
    });

    /**
     * Tests for {@link SpatialCoordinate3D} round trip.
     *
     * @function module:tests/dicom~spatialcoordinate3d-round-trip
     */
    test('round trip',
      () => {
        const deGraphicData = new DataElement('OD');
        deGraphicData.value = ['1.5', '2.5', '3.5'];

        const deGraphicType = new DataElement('CS');
        deGraphicType.value = ['POLYLINE'];

        const deFrameUID = new DataElement('UI');
        deFrameUID.value = ['1.2.3.4.5'];

        const deFiducialUID = new DataElement('UI');
        deFiducialUID.value = ['1.2.3.4.6'];

        const dataElements = {
          [TagKeys.GraphicData]: deGraphicData,
          [TagKeys.GraphicType]: deGraphicType,
          [TagKeys.ReferencedFrameofReferenceUID]: deFrameUID,
          [TagKeys.FiducialUID]: deFiducialUID
        };

        const coord1 = getSpatialCoordinate3D(dataElements);
        const item = getDicomSpatialCoordinate3DItem(coord1);

        // recreate SpatialCoordinate3D from item
        const coord2 = new SpatialCoordinate3D();
        if (typeof item.GraphicData !== 'undefined') {
          coord2.graphicData = item.GraphicData;
        }
        if (typeof item.GraphicType !== 'undefined') {
          coord2.graphicType = item.GraphicType;
        }
        if (typeof item.ReferencedFrameofReferenceUID !== 'undefined') {
          coord2.referencedFrameofReferenceUID =
            item.ReferencedFrameofReferenceUID;
        }
        if (typeof item.FiducialUID !== 'undefined') {
          coord2.fiducialUID = item.FiducialUID;
        }

        // verify round-trip
        assert.deepEqual(coord1.graphicData, coord2.graphicData);
        assert.equal(coord1.graphicType, coord2.graphicType);
        assert.equal(coord1.referencedFrameofReferenceUID,
          coord2.referencedFrameofReferenceUID);
        assert.equal(coord1.fiducialUID, coord2.fiducialUID);
      }
    );
  });

  describe('getSpatialCoordinate3D', () => {

    /**
     * Tests for {@link getSpatialCoordinate3D}.
     *
     * @function module:tests/dicom~getspatialcoordinate3d-good-input
     */
    test('good input', () => {
      const deGraphicData = new DataElement('OD');
      deGraphicData.value = ['1.0', '2.0', '3.0'];

      const deGraphicType = new DataElement('CS');
      deGraphicType.value = ['POINT'];

      const deFrameUID = new DataElement('UI');
      deFrameUID.value = ['1.2.3.4.5'];

      const deFiducialUID = new DataElement('UI');
      deFiducialUID.value = ['1.2.3.4.6'];

      const dataElements = {
        [TagKeys.GraphicData]: deGraphicData,
        [TagKeys.GraphicType]: deGraphicType,
        [TagKeys.ReferencedFrameofReferenceUID]: deFrameUID,
        [TagKeys.FiducialUID]: deFiducialUID
      };

      const result = getSpatialCoordinate3D(dataElements);

      assert.deepEqual(result.graphicData, ['1.0', '2.0', '3.0']);
      assert.equal(result.graphicType, 'POINT');
      assert.equal(result.referencedFrameofReferenceUID, '1.2.3.4.5');
      assert.equal(result.fiducialUID, '1.2.3.4.6');
    });

    /**
     * Tests for {@link getSpatialCoordinate3D} with only graphic type and data.
     *
     * @function module:tests/dicom~getspatialcoordinate3d-only-graphic
     */
    test('only graphic', () => {
      const deGraphicData = new DataElement('OD');
      deGraphicData.value = ['1.0', '2.0', '3.0'];

      const deGraphicType = new DataElement('CS');
      deGraphicType.value = ['POLYLINE'];

      const dataElements = {
        [TagKeys.GraphicData]: deGraphicData,
        [TagKeys.GraphicType]: deGraphicType
      };

      const result = getSpatialCoordinate3D(dataElements);

      assert.deepEqual(result.graphicData, ['1.0', '2.0', '3.0']);
      assert.equal(result.graphicType, 'POLYLINE');
      assert.isUndefined(result.referencedFrameofReferenceUID);
      assert.isUndefined(result.fiducialUID);
    });

    /**
     * Tests for {@link getSpatialCoordinate3D} with mulitple values.
     *
     * @function module:tests/dicom~getspatialcoordinate3d-multiple
     */
    test('multiple', () => {
      const deGraphicData = new DataElement('OD');
      deGraphicData.value = [
        '1.0', '2.0', '3.0', '4.0', '5.0', '6.0', '7.0', '8.0', '9.0'
      ];

      const deGraphicType = new DataElement('CS');
      deGraphicType.value = ['POLYGON'];

      const dataElements = {
        [TagKeys.GraphicData]: deGraphicData,
        [TagKeys.GraphicType]: deGraphicType
      };

      const result = getSpatialCoordinate3D(dataElements);

      assert.equal(result.graphicData.length, 9);
      assert.deepEqual(result.graphicData, [
        '1.0', '2.0', '3.0', '4.0', '5.0', '6.0', '7.0', '8.0', '9.0'
      ]);
    });

    /**
     * Tests for {@link getSpatialCoordinate3D} with only frame reference UID.
     *
     * @function module:tests/dicom~getspatialcoordinate3d-only-frame
     */
    test('only frame', () => {
      const deFrameUID = new DataElement('UI');
      deFrameUID.value = ['1.2.3.4.5'];

      const dataElements = {
        [TagKeys.ReferencedFrameofReferenceUID]: deFrameUID
      };

      const result = getSpatialCoordinate3D(dataElements);

      assert.isUndefined(result.graphicData);
      assert.isUndefined(result.graphicType);
      assert.equal(result.referencedFrameofReferenceUID, '1.2.3.4.5');
      assert.isUndefined(result.fiducialUID);
    });

    /**
     * Tests for {@link getSpatialCoordinate3D} with only fiducial UID.
     *
     * @function module:tests/dicom~getspatialcoordinate3d-only-fiducial
     */
    test('only fiducial', () => {
      const deFiducialUID = new DataElement('UI');
      deFiducialUID.value = ['1.2.3.4.6'];

      const dataElements = {
        [TagKeys.FiducialUID]: deFiducialUID
      };

      const result = getSpatialCoordinate3D(dataElements);

      assert.isUndefined(result.graphicData);
      assert.isUndefined(result.graphicType);
      assert.isUndefined(result.referencedFrameofReferenceUID);
      assert.equal(result.fiducialUID, '1.2.3.4.6');
    });

    /**
     * Tests for {@link getSpatialCoordinate3D} empty.
     *
     * @function module:tests/dicom~getspatialcoordinate3d-empty
     */
    test('empty', () => {
      const result = getSpatialCoordinate3D({});

      assert.isUndefined(result.graphicData);
      assert.isUndefined(result.graphicType);
      assert.isUndefined(result.referencedFrameofReferenceUID);
      assert.isUndefined(result.fiducialUID);
    });

    /**
     * Tests for {@link getSpatialCoordinate3D} uses first graphic.
     *
     * @function module:tests/dicom~getspatialcoordinate3d-first-graphic
     */
    test('first graphic', () => {
      const deGraphicType = new DataElement('CS');
      deGraphicType.value = ['POINT', 'EXTRA'];

      const dataElements = {
        [TagKeys.GraphicType]: deGraphicType
      };

      const result = getSpatialCoordinate3D(dataElements);

      assert.equal(result.graphicType, 'POINT');
    });

  });

  describe('getDicomSpatialCoordinate3DItem', () => {

    /**
     * Tests for {@link getDicomSpatialCoordinate3DItem}.
     *
     * @function module:tests/dicom~getdicomspatialcoordinate3ditem-good
     */
    test('good', () => {
      const coord = new SpatialCoordinate3D();
      coord.graphicData = ['1.0', '2.0', '3.0'];
      coord.graphicType = 'POINT';
      coord.referencedFrameofReferenceUID = '1.2.3.4.5';
      coord.fiducialUID = '1.2.3.4.6';

      const item = getDicomSpatialCoordinate3DItem(coord);

      assert.deepEqual(item.GraphicData, ['1.0', '2.0', '3.0']);
      assert.equal(item.GraphicType, 'POINT');
      assert.equal(item.ReferencedFrameofReferenceUID, '1.2.3.4.5');
      assert.equal(item.FiducialUID, '1.2.3.4.6');
    });

    /**
     * Tests for {@link getDicomSpatialCoordinate3DItem} only graphic.
     *
     * @function module:tests/dicom~getdicomspatialcoordinate3ditem-only-graphic
     */
    test('only graphic', () => {
      const coord = new SpatialCoordinate3D();
      coord.graphicData = ['1.0', '2.0', '3.0'];
      coord.graphicType = 'POLYLINE';

      const item = getDicomSpatialCoordinate3DItem(coord);

      assert.deepEqual(item.GraphicData, ['1.0', '2.0', '3.0']);
      assert.equal(item.GraphicType, 'POLYLINE');
      assert.isUndefined(item.ReferencedFrameofReferenceUID);
      assert.isUndefined(item.FiducialUID);
    });

    /**
     * Tests for {@link getDicomSpatialCoordinate3DItem} undefined.
     *
     * @function module:tests/dicom~getdicomspatialcoordinate3ditem-undefined
     */
    test('undefined', () => {
      const coord = new SpatialCoordinate3D();
      coord.graphicType = 'POINT';
      coord.fiducialUID = '1.2.3.4.6';

      const item = getDicomSpatialCoordinate3DItem(coord);

      assert.isUndefined(item.GraphicData);
      assert.equal(item.GraphicType, 'POINT');
      assert.isUndefined(item.ReferencedFrameofReferenceUID);
      assert.equal(item.FiducialUID, '1.2.3.4.6');
    });

    /**
     * Tests for {@link getDicomSpatialCoordinate3DItem} empty.
     *
     * @function module:tests/dicom~getdicomspatialcoordinate3ditem-empty
     */
    test('empty', () => {
      const coord = new SpatialCoordinate3D();
      const item = getDicomSpatialCoordinate3DItem(coord);

      assert.deepEqual(item, {});
    });

    /**
     * Tests for {@link getDicomSpatialCoordinate3DItem}
     * preserves graphic array.
     *
     * @function module:tests/dicom~getdicomspatialcoordinate3ditem-graphic-arr
     */
    test('graphic arr', () => {
      const coord = new SpatialCoordinate3D();
      const graphicArray = ['1.0', '2.0', '3.0', '4.0', '5.0', '6.0'];
      coord.graphicData = graphicArray;

      const item = getDicomSpatialCoordinate3DItem(coord);

      assert.deepEqual(item.GraphicData, graphicArray);
      assert.equal(item.GraphicData.length, 6);
    });

  });

});