Purpose

The DicomREGSave creates and composes a DICOM file with a Deformable Registration IOD (Information Object Definition) and modality REG. It provides/composes the necessary tags to fulfill the DICOM standard requirements. It derives much generic DICOM save functionality from DicomSaveBase.

One essential feature is to inherit DICOM (tag) information from input sources such as ML images, DICOM files, or a MultiFileVolume as it is created for example by DirectDicomImport.

For further information (especially about the meaning of the tags written in the created output file) see for example DICOM standard http://medical.nema.org/Dicom/2011/11_03pu.pdf section C.20.3, Deformable Spatial Registration.

Usage

The typical way to use this module it to connect a Vector3 typed image at the image input (see input0) and to specify a source of DICOM tags from where settings can be inherited. This often can also be the input image if it contains DICOM information. Then the Inherit DICOM Information (CTRL+R) can be used to initialize most tag value fields. When saving the DICOM file with Save (Ctrl+S) the module applies many checks for DICOM compliance, however this cannot guarantee sensible values. The values usually need a careful revision and completion by the user, because not all settings can be determined or checked automatically.

Windows

Default Panel

../../../Projects/DICOM/MLDicomOutputs/Modules/mhelp/Images/Screenshots/DicomREGSave._default.png

Input Fields

input0

name: input0, type: Image

A connector for the image to be saved. It can also be used to inherit DICOM information and tag values which shall be stored in the created REG modality file.

Notes:

  • that the extent of this image (the first three dimensions) define the extent of the output image (found in the GridDimensions tag).
  • the voxel data of this image is cast to 3D floating vectors and stored in the VectorGridData tag.

inputBase

name: inputBase, type: MLBase

This is a Base connector which can be used to provide the DICOM tree from which tags can be inherited; it is only used if Input Selector is set accordingly. It supports DICOM tree and MultiFileVolumeList Base objects as inputs.

inputModifierList

name: inputModifierList, type: MLBase

This is an optional input where modification plugins can be connected. They are applied as last operation on the final DICOM information directly before it is written to file. This can be used, for example to handle private tags, or to apply final cleanups before the DICOM file is created. See for example DicomModifyTagsPlugin, DicomModifySubTreeSelectorPlugin, or DicomModifyImageTagsPlugin, which are useful for final modifications on the DICOM information.

input1

name: input1, type: Image

A second image input from which some tags can be inherited, see Inherit From for details.

Parameter Fields

Field Index

#Volumes: Integer Input Selector: Enum Referring Physician Name: String
Accession Number: String Laterality: Enum Save (Ctrl+S): Trigger
Annotate: Bool makeCommonInstanceReferenceModuleGUIInsensitive: Bool Series Description: String
Auto (autoCreateStudyInstanceUID): Bool makeFrameOfReferenceGUIInsensitive: Bool Series Instance UID (seriesInstanceUID): String
Auto (autoCreateSeriesInstanceUID): Bool Manufacturer: String Series Instance UID (referencedSeriesSeriesInstanceUID): String
Clear Fields: Trigger Manufacturer Model Name: String Series Instance UID (referencedStudiesSeriesInstanceUID): String
Clear Referenced Series Fields: Trigger Num shown binary bytes: Integer Series Number: String
Clear Referenced Studies Fields: Trigger Patient Birth Date Day: Enum Software Versions: String
Content Creators Name: String Patient Birth Date Day String: String Sop Class UID: String
Content Date: String Patient Birth Date Month: Enum Sop Instance UID: String
Content Description: String Patient Birth Date Month String: String Source Frame Of Reference UID: String
Content Label: String Patient Birth Date Year: Enum Status: String
Content Time: String Patient Birth Date Year String: String Study Date: String
Copy Other Input Tags: Bool Patient ID: String Study Description: String
Create new UID (createStudyInstanceUID): Trigger Patient Sex: Enum Study Instance UID (studyInstanceUID): String
Create new UID (createSeriesInstanceUID): Trigger Patient Sex String: String Study Instance UID (commonInstanceReferenceStudyInstanceUID): String
Device Serial Number: String Patients Name: String Study Time: String
Dump Private Tag Values: Bool Position Reference Indicator: String Study UID: String
File Name (unresolvedFileName): String Post Bad Param Errors: Bool Tag Dump: String
File Name (fileName): String Post Deformation Matrix: Matrix Tag Dump Size: Integer
Filter: String Pre Deformation Matrix: Matrix True File Name: String
Frame Of Reference UID: String Referenced Frame Numbers: String Type (preDeformationMatrixType): Enum
Image Orientation Patient: Vector6 Referenced Segment Numbers: String Type (postDeformationMatrixType): Enum
Image Position Patient: Vector3 Referenced SOP Class UIDs (referencedImageSequenceReferencedSOPClassUIDs): String Update automatically on changes of StudyInstanceUID: Bool
Inherit DICOM Information (CTRL+R): Trigger Referenced SOP Class UIDs (referencedSeriesReferencedSOPClassUIDs): String Update tags of Common Instance Reference IOD Module: Trigger
Inherit From (sourceFrameOfReferenceUIDInheritanceSource): Enum Referenced SOP Class UIDs (referencedStudiesReferencedSOPClassUIDs): String Use Empty Laterality Tag If Not Found On Inheritance: Bool
Inherit From (inputConnectorSelector): Enum Referenced SOP Instance UIDs (referencedImageSequenceReferencedSOPInstanceUIDs): String warnDirectoriesOnBrowsing: Bool
Inherit Referenced Image Sequence Tags: Trigger Referenced SOP Instance UIDs (referencedSeriesReferencedSOPInstanceUIDs): String warnNonExistingFileOnBrowsing: Bool
Inherit Series Number: Bool Referenced SOP Instance UIDs (referencedStudiesReferencedSOPInstanceUIDs): String World Matrix Inheritance Source: Enum
InIdx: Integer referencedImageSequenceClear: Trigger  

Visible Fields

File Name (unresolvedFileName)

name: unresolvedFileName, type: String, deprecated name: unresolvedDcmInputFileName

If a loading operation from disk is selected as input in the Input Selector then the file name from which the DICOM tree shall be loaded is specified here. Otherwise this field is insensitive.

True File Name

name: absoluteFileName, type: String, persistent: no, deprecated name: dcmInputFileName

The path and name of a DICOM file which can be used to inherit DICOM tags to be written in the REG DICOM file.

Input Selector

name: inputSelector, type: Enum, default: ImageConnector #0, deprecated name: inheritanceInput

Selects the input from which DICOM information shall be inherited when Inherit DICOM Information (CTRL+R) is triggered. Be careful, because handwritten DICOM tags values are overwritten!

Values:

Title Name Deprecated Name Description
Image Connector #0 ImageConnector #0 ImageConnector If Input Selector is set to this mode, then the DICOM tree used for inheriting DICOM tags is taken from this image connector.
File File   All DICOM information is retrieved from the file given in field True File Name. It is expected to be a valid DICOM file; otherwise file IO errors will be posted.
Base Connector BaseConnector   If Input Selector is set to this mode, then the DICOM tree used for inheriting DICOM tags is retrieved from the Base connector where DICOM tree or MultiFileVolumeList base objects are allowed.
Image Connector #1 ImageConnector #1    

InIdx

name: inputVolumeIndex, type: Integer, default: 0, minimum: 0, deprecated name: ddiOutVolIdx

This field selects the volume from the connected DirectDicomImport which shall be used as source for DICOM tags.

#Volumes

name: numVolumes, type: Integer, persistent: no, deprecated name: numDDIVolumes

This read-only field shows number of available volumes in the DirectDicomImport.

Tag Dump Size

name: tagDumpSize, type: Integer, default: 10000

Maximum number of characters shown in the Tag Dump field. Note that too large values can degrade performance when viewing the DICOM tag list.

Dump Private Tag Values

name: dumpPrivateTagValues, type: Bool, default: FALSE

If enabled then values of private tags are decoded if decoders are available.

Num shown binary bytes

name: numShownBinaryEntries, type: Integer, default: 8

Number of shown bytes of binary tags.

Annotate

name: annotate, type: Bool, default: FALSE

If enabled then tags are annotated with further descriptive information such as possible types ( 1=Mandatory, 1C=Conditionally Mandatory, 2=Mandatory, may have zero or one item, 2C=Conditionally Mandatory, but may be empty, 3=Optional) and possible meanings of the tag. Note that no context analysis is performed for that information and therefore all possible and perhaps redundant meanings are shown.

Filter

name: regExLineFilter, type: String

If not empty then the regular expression is used to filter all lines of Tag Dump; see that field for more details. Examples:

======================= ==================================
Expression              Description
======================= ==================================
.*                     Matches all string/lines.
.*(0008,0032).*        Matches all lines containing this tag ID.
.*logo.*               Matches anything containing 'logo' (case sensitive)
.*[lL][oO][gG][oO].*   Matches anything containing 'logo' (case insensitive)
.*.[jJ][pP][gG]        Matches anything ending with .jpg where jpg is case insensitive.
.*.JPG|.*.jpg          Matches all paths ending with either '.jpg' or with '.JPG'.
.*\d.*                 Matches all paths containing at least one digit.
.*[[:digit:]].*        Same as above.
.*[[:xdigit:]].*       Matches all paths containing at least one hexadecimal digit.
.*\l.*                 Matches all paths containing at least one lower case character.
.*[[:lower:]].*        Same as above.
.*\u.*                 Matches all paths containing at least one upper case character.
.*[[:upper:]].*        Same as above.
.*\s.*                 Matches all paths containing at least one white space character.
.*[[:space:]].*        Same as above.
.*[[:blank:]].*        Matches all paths containing at least one non-line-separating whitespace.
.*[[:word:]].*         Matches all paths containing at least one word character (alphanumeric characters plus the underscore).
.*[[:w:]].*            Same as above.
.*[[:graph:]].*        Matches all paths containing at least one graphical character.
.*[5-7].*              Matches all paths containing at least one of the digits 5, 6 or 7.
======================= ==================================

Tag Dump

name: tagDump, type: String, persistent: no

Shows a dump of the DICOM tags; if necessary it will be clamped at a size given by Tag Dump Size and the message ‘tag list shortened and not shown completely’ is appended.

Inherit DICOM Information (CTRL+R)

name: inheritDICOMTags, type: Trigger

If notified then all DICOM related information is inherited from the selected input. Note that some DICOM tags of the input image are removed to avoid that they cause trouble when they are found when the saved image is imported somewhere else.

Copy Other Input Tags

name: copyOtherInputTags, type: Bool, default: FALSE

If disabled then only the required and important DICOM tags are written into the output file. If enabled then all other tags from the input are also copied even if they are not related to the written modality. WARNING: IF THIS IS ENABLED ALSO INAPPROPRIATE TAGS MIGHT BE COPIED TO THE CREATED FILE!

Save (Ctrl+S)

name: save, type: Trigger

If this button is pressed then all tags are composed to a DICOM file with modality REG, the deformation field and saved in the file determined by File Name.

File Name (fileName)

name: fileName, type: String

The path and name of the REG modality file to be written.

Post Bad Param Errors

name: postBadParamErrors, type: Bool, default: TRUE

If enabled then bad parameters are posted as ML error, otherwise they are only shown in status field.

Status

name: status, type: String, persistent: no

Shows general information and messages.

Patients Name

name: patientsName, type: String

The name of the patient this report is created for.

Patient ID

name: patientID, type: String

DICOM tag: String/number used to identify the patient see tag (0010,0020).

Patient Birth Date Year

name: patientBirthDateYearEnum, type: Enum, default: 1900

The selectable year of birth of the patient; ‘User Defined’ allows manual specification. See DICOM tag Patient’s Birth Day (0010,0030).

Patient Birth Date Year String

name: patientBirthDateYearString, type: String, default: 1900

The year of the patient birth as string. Can be modified manually only if ‘Patient Sex’ is ‘User Defined’. See DICOM tag Patient’s Birth Day (0010,0030).

Patient Birth Date Month

name: patientBirthDateMonthEnum, type: Enum, default: 01-January

The selectable month of birth of the patient; ‘User Defined’ allows manual specification. For convenience the module also allows and translates values such as “03-March” or “March” to the required value component “03”, respectively. See DICOM tag Patient’s Birth Day (0010,0030).

Patient Birth Date Month String

name: patientBirthDateMonthString, type: String, default: 01-January

The month of birth of the patient; ‘User Defined’ allows manual specification. For convenience the module also allows and translates values such as “03-March” or “March” to the required value component “03”, respectively. See DICOM tag Patient’s Birth Day (0010,0030).

Patient Birth Date Day

name: patientBirthDateDayEnum, type: Enum, default: 01

The selectable Day of birth of the patient; ‘User Defined’ allows manual specification. See DICOM tag Patient’s Birth Day (0010,0030).

Patient Birth Date Day String

name: patientBirthDateDayString, type: String, default: 01

The day of the patient birth as string. Can be modified manually only if ‘Patient Birth Date Day’ is ‘User Defined’. See DICOM tag Patient’s Birth Day (0010,0030).

Patient Sex

name: patientSexEnum, type: Enum, default: Other

The selectable sex of the patient; ‘User Defined’ allows manual specification. See DICOM tag Patient Sex (0010,0040).

Values:

Title Name
Other Other
Female Female
Male Male
User Defined User Defined

Patient Sex String

name: patientSexString, type: String, default: Other

The sex of the patient as string. Can be modified manually only if ‘Patient Sex’ is ‘User Defined’. See DICOM tag Patient Sex (0010,0040).

Study Instance UID (studyInstanceUID)

name: studyInstanceUID, type: String

DICOM tag: Study Instance UID (0020,000D) Unique identifier for the study. If available then see Update automatically on changes of StudyInstanceUID and C.12.2 Common Instance Reference Module in the DICOM standard for details and important dependent settings. Must contain up to 64 characters from ‘0’-‘9’ or ‘.’.

Create new UID (createStudyInstanceUID)

name: createStudyInstanceUID, type: Trigger

Creates a new Study Instance UID

Auto (autoCreateStudyInstanceUID)

name: autoCreateStudyInstanceUID, type: Bool, default: TRUE

If enabled for each written file a new Study Instance UID is created. If disabled the currently set one is used.

Study Date

name: studyDate, type: String

DICOM tag: Study Date (0008,0020). The date the study started. May be empty.

Study Time

name: studyTime, type: String

DICOM tag: Study Time (0008,0030). The time the study started. May be empty.

Referring Physician Name

name: referringPhysicianName, type: String

DICOM tag: Referring Physician’s Name (0008,0090). Name of the patient’s referring physician. May be empty.

Study UID

name: studyUID, type: String

DICOM tag: Study UID (0020,0010). User or equipment generated study ID. May be empty.

Accession Number

name: accessionNumber, type: String

DICOM tag: Accession Number (0008,0050). A RIS generated number that identifies the order of the Study. May be empty.

Study Description

name: studyDescription, type: String

DICOM tag: Study Description (0008,1030). Institution-generated description or classification of the Study (component) performed. Optional, may be empty.

Series Instance UID (seriesInstanceUID)

name: seriesInstanceUID, type: String

DICOM tag: Series Instance UID (0020,000E). Unique identifier of the series, must be non-empty in case of some enhanced contexts. Must contain up to 64 characters from ‘0’-‘9’ or ‘.’.

Create new UID (createSeriesInstanceUID)

name: createSeriesInstanceUID, type: Trigger

Creates a new Series Instance UID

Auto (autoCreateSeriesInstanceUID)

name: autoCreateSeriesInstanceUID, type: Bool, default: TRUE

If enabled for each written file a new Series Instance UID is created. If disabled the currently set one is used.

Series Number

name: seriesNumber, type: String

DICOM tag: Series Number (0020,0011). Integer number with at most 12 digits; tag must exist and in most contexts it must have a non-empty value; in a few IODs it is allowed to be empty.

Inherit Series Number

name: inheritSeriesNumber, type: Bool, default: TRUE

Sometimes it is not desired to inherit the Series Number tag from the input, because it may be set by the module user. For this purpose it can be disabled.

Laterality

name: laterality, type: Enum, default: WriteEmptyTagValue

DICOM tag: Laterality (0020,0060). Allowed values: ‘L’ (Left), ‘R’ (Right), and empty value (WriteEmptyTagValue). Note that not writing the tag value may violate the DICOM standard under some circumstances.

Values:

Title Name
Do Not Write Tag Value DoNotWriteTagValue
Write Empty Tag Value WriteEmptyTagValue
L L
R R

Use Empty Laterality Tag If Not Found On Inheritance

name: useEmptyLateralityTagIfNotFoundOnInheritance, type: Bool, default: TRUE

In may contexts the Laterality tag (0020,0060) must be available but is allowed to be empty, however, often it cannot be inherited since it is not part of the DICOM source. This field allow to inherit a state that always an empty tag value is written instead of skipping it which perhaps would violate the DICOM standard. Also depends on other Laterality tags.

Series Description

name: seriesDescription, type: String

DICOM tag: Series Description (0008,103E). Optional, may be empty.

Frame Of Reference UID

name: frameOfReferenceUID, type: String

Unique ID referencing the DICOM frame on which the saved data set is based. It should reference the UID of the frame on which this file ‘bases’; usually derived from the ‘FrameOfReferenceUID’ tag of the connected input image. Must contain up to 64 characters from ‘0’-‘9’ or ‘.’.

Position Reference Indicator

name: positionReferenceIndicator, type: String

Part of the imaging target used as a reference. See C.7.4.1.1.2 in DICOM standard; usually derived from the ‘PositionReferenceIndicator’ tag of the connected input image..

Manufacturer

name: manufacturer, type: String

DICOM tag: Manufacturer (0008,0070). Company creating this report. May be empty.

Manufacturer Model Name

name: manufacturerModelName, type: String

DICOM tag: Manufacturer Model Name (0008,1090) determined by the manufacturer.

Device Serial Number

name: deviceSerialNumber, type: String

DICOM tag: Device Serial Number (0018,1000). The serial number of the device.

Software Versions

name: softwareVersions, type: String

DICOM tag: Manufacturer’s software version (0018,1020).

Content Date

name: contentDate, type: String

DICOM tag: Content Date (0008,0023). The data the image pixel data creation started. May be empty.

Content Time

name: contentTime, type: String

DICOM tag: Content Time (0008,0033). The time the image pixel data creation started. May be empty.

Content Label

name: contentLabel, type: String

DICOM tag: Content Label (0070,0080). A label that is used to identify this SOP instance. Must obey value representation CS (Uppercase characters, ‘0’-‘9’, the SPACE character, and underscore ‘_’, of the Default Character Repertoire, 16 bytes maximum).

Content Description

name: contentDescription, type: String

DICOM tag: Content Description (0070,0081). A description of the content of this SOP instance.

Content Creators Name

name: contentCreatorsName, type: String

DICOM tag: Content Creator’s Name (0070,0084). Name of operator (such as a technologist or physician) creating the content of the SOP instance. May be empty.

Source Frame Of Reference UID

name: sourceFrameOfReferenceUID, type: String

DICOM tag: SourceFrameOfReferenceUID (0064,0003). Unique ID referencing the DICOM frame on which the saved data set is based. It should reference the file on which this deformation file ‘lives’; usually derived from the ‘FrameOfReferenceUID’ tag of the connected input image.

World Matrix Inheritance Source

name: worldMatrixInheritanceSource, type: Enum, default: DICOM_INPUT

Determines from where the values of Image Position Patient and Image Orientation Patient are inherited from when Inherit DICOM Information (CTRL+R) is touched: from the connected input DICOM file or from the connected input image world matrix.

Values:

Title Name
Dicom Input DICOM_INPUT
Image Input IMAGE_INPUT

Inherit From (sourceFrameOfReferenceUIDInheritanceSource)

name: sourceFrameOfReferenceUIDInheritanceSource, type: Enum, default: IMAGE_INPUT

Determines from where the value of Frame Of Reference UID is inherited from when Inherit DICOM Information (CTRL+R) is touched: from the connected input DICOM file or from the connected input image DICOM extension.

Values:

Title Name
Dicom Input DICOM_INPUT
Image Input IMAGE_INPUT

Image Position Patient

name: imagePositionPatient, type: Vector3, default: 0 0 0

DICOM tag: The ImagePositionPatient (0020,0032) of the Deformable Registration Grid Sequence (0064,0002); usually derived from the connected input image.

Image Orientation Patient

name: imageOrientationPatient, type: Vector6, default: 1 0 0 0 1 0

DICOM tag: The ImageOrientationPatient (0020,0037) of the Deformable Registration Grid Sequence (0064,0002); usually derived from the connected input image.

Pre Deformation Matrix

name: preDeformationMatrix, type: Matrix, default: 1 0 0 0, 0 1 0 0, 0 0 1 0, 0 0 0 1

DICOM tag: The Frame of Reference Transformation Matrix (3006,006C) specified in the Pre Deformation Matrix Registration Sequence (0064,000F).

Type (preDeformationMatrixType)

name: preDeformationMatrixType, type: Enum, default: RIGID

DICOM tag: Frame of Reference Transformation Matrix Type (0070,030C) specified in the Pre Deformation Matrix Registration Sequence (0064,000F).

Values:

Title Name
Rigid RIGID
Rigid Scale RIGID_SCALE
Affine AFFINE

Post Deformation Matrix

name: postDeformationMatrix, type: Matrix, default: 1 0 0 0, 0 1 0 0, 0 0 1 0, 0 0 0 1

DICOM tag: The Frame of Reference Transformation Matrix (3006,006C) specified in the Post Deformation Matrix Registration Sequence (0064,0010).

Type (postDeformationMatrixType)

name: postDeformationMatrixType, type: Enum, default: RIGID

DICOM tag: The Frame of Reference Transformation Matrix Type (0070,030C) specified in the Post Deformation Matrix Registration Sequence (0064,0010).

Values:

Title Name
Rigid RIGID
Rigid Scale RIGID_SCALE
Affine AFFINE

Inherit From (inputConnectorSelector)

name: inputConnectorSelector, type: Enum, default: ImageConnector #1

Determines from which input the UIDs of the Referenced SOP Class UIDs, and Referenced SOP Instance UIDs are inherited.

Values:

Title Name Description
ImageConnector #0 ImageConnector #0 Contents of Referenced SOP Class UIDs, and Referenced SOP Instance UIDs are inherited from input0.
ImageConnector #1 ImageConnector #1 Contents of Referenced SOP Class UIDs, and Referenced SOP Instance UIDs are inherited from input1.

Clear Fields

name: clearReferencedImageSequenceFields, type: Trigger

Clears all contents of Referenced Frame Numbers, Referenced Segment Numbers, Referenced SOP Class UIDs, and Referenced SOP Instance UIDs.

Inherit Referenced Image Sequence Tags

name: updateReferencedImageSequenceUIDInheritance, type: Trigger

Inherits contents of Referenced SOP Class UIDs and Referenced SOP Instance UIDs from the input which is specified in Inherit From.

Referenced Frame Numbers

name: referencedFrameNumbers, type: String

The values of the Referenced Frame Numer (0008,1160) tags of the Image SOP Instance Reference Macro Attributes of the entries of the Referenced Image Sequence (0008,1140) tag of the Deformable Spatial Registration Module. Can be left empty under some circumstances, should be empty for non multi-frame sources. Lists of ‘print-list’ like formatted numbers for the ‘Referenced Frame Number (0008,1160)’ tags in the sequence items. If string is empty then no tag is added. Lists for sequence items are separated with colons, such as ‘1-2,4,6 : 1 2 3 4 : 1’ results in 1,2,4,6 for first sequence item, 1,2,3,4 for second sequence item, and 1 for third sequence item. First frame index is denoted by 1, 0 is not allowed.

Referenced Segment Numbers

name: referencedSegmentNumbers, type: String

The values of the Referenced Segment Numer (0062,000B) tags of the Image SOP Instance Reference Macro Attributes of the entries of the Referenced Image Sequence (0008,1140) tag of the Deformable Spatial Registration Module. May be non-empty only for Segmentation sources. Lists of ‘print-list’ like formatted numbers for the ‘Referenced Segment Numbers(0062,000B)’ tags in the sequence items. If string is empty then no tag is added. Lists for sequence items are separated with colons, such as ‘3-5,7 : 1,2,3,4 : 3’ results in 3,4,5,7 for first sequence item, 1,2,3,4 for second sequence item, and 3 for third sequence item. First frame index is denoted by 1, 0 is not allowed.

Referenced SOP Class UIDs (referencedImageSequenceReferencedSOPClassUIDs)

name: referencedImageSequenceReferencedSOPClassUIDs, type: String

The newline-separated Referenced SOP Class UID’s (0008,1150) of the (Image) SOP Instance Reference Macro Attributes of the entries of the Referenced Image Sequence (0008,1140) tag of the Deformable Spatial Registration Module.

Referenced SOP Instance UIDs (referencedImageSequenceReferencedSOPInstanceUIDs)

name: referencedImageSequenceReferencedSOPInstanceUIDs, type: String

The newline-separated Referenced SOP Instance UID’s (0008,1155) of the (Image) SOP Instance Reference Macro Attributes of the entries of the Referenced Image Sequence (0008,1140) tag of the Deformable Spatial Registration Module.

Update automatically on changes of StudyInstanceUID

name: autoUpdateOnStudyInstanceUIDChanges, type: Bool, default: TRUE

Automatically update tags of Common Instance Reference IOD Module on changes of StudyInstanceUID.

Update tags of Common Instance Reference IOD Module

name: updateUIDInheritance, type: Trigger

After updating the StudyInstanceUID tag (to be used in the destination file) it may be required to update the UIDs referenced by the destination file. In this case clearing the UIDs and inheriting them anew may be needed.

Clear Referenced Series Fields

name: referencedSeriesClear, type: Trigger

Clears all contents of Referenced SOP Class UIDs, Series Instance UID, and Referenced SOP Instance UIDs.

Referenced SOP Class UIDs (referencedSeriesReferencedSOPClassUIDs)

name: referencedSeriesReferencedSOPClassUIDs, type: String

The newline-separated UIDs of the Referenced Instance Sequence (0008,114A) of the entry of the Referenced Series Sequence (0008,1115) tag of the Common Instance Reference Module

Referenced SOP Instance UIDs (referencedSeriesReferencedSOPInstanceUIDs)

name: referencedSeriesReferencedSOPInstanceUIDs, type: String

The newline-separated UIDs of the Referenced Instance Sequence (0008,114A) of the entry of the Referenced Series Sequence (0008,1115) tag of the Common Instance Reference Module

Series Instance UID (referencedSeriesSeriesInstanceUID)

name: referencedSeriesSeriesInstanceUID, type: String

The Series Instance UID (0020,000E) of the entry of the Referenced Series Sequence (0008,1115) tag of the Common Instance Reference Module

Clear Referenced Studies Fields

name: referencedStudiesClear, type: Trigger

Clears the contents of Study Instance UID, Series Instance UID, Referenced SOP Class UIDs, and Referenced SOP Instance UIDs.

Referenced SOP Class UIDs (referencedStudiesReferencedSOPClassUIDs)

name: referencedStudiesReferencedSOPClassUIDs, type: String

The newline-separated UIDs of the Referenced Instance Sequence (0008,114A) of the entry of the Studies Containing Other Referenced Instances Sequence (0008,1200) tag of the Common Instance Reference Module. Each line must only contain up to 64 characters from ‘0’-‘9’ or ‘.’.

Referenced SOP Instance UIDs (referencedStudiesReferencedSOPInstanceUIDs)

name: referencedStudiesReferencedSOPInstanceUIDs, type: String
The newline-separated UIDs of the
Referenced Instance Sequence (0008,114A) of the entry of the Studies Containing Other Referenced Instances Sequence (0008,1200) tag of the Common Instance Reference Module

Study Instance UID (commonInstanceReferenceStudyInstanceUID)

name: commonInstanceReferenceStudyInstanceUID, type: String

The Study Instance UID (0020,000D) of the entry of the Studies Containing Other Referenced Instances Sequence (0008,1200) tag of the Common Instance Reference Module. Must contain up to 64 characters from ‘0’-‘9’ or ‘.’.

Series Instance UID (referencedStudiesSeriesInstanceUID)

name: referencedStudiesSeriesInstanceUID, type: String

The Series Instance UID (0020,000E) of the entry of the Studies Containing Other Referenced Instances Sequence (0008,1200) tag of the Common Instance Reference Module. Must contain up to 64 characters from ‘0’-‘9’ or ‘.’.

Sop Class UID

name: sopClassUID, type: String, default: 1.2.840.10008.5.1.4.1.1.66.3

Read-only value: Uniquely defines the DICOM SOP class to be written by this module as described in DICOM Standard C.12.1.1.1 SOP Class UID, SOP Instance UID. Must contain up to 64 characters from ‘0’-‘9’ or ‘.’.

Sop Instance UID

name: sopInstanceUID, type: String

Read-only value: Uniquely defines the DICOM SOP Instance UID written by this module as described in DICOM Standard C.12.1.1.1 SOP Class UID, SOP Instance UID. Must contain up to 64 characters from ‘0’-‘9’ or ‘.’.

Hidden Fields

warnNonExistingFileOnBrowsing

name: warnNonExistingFileOnBrowsing, type: Bool, default: FALSE

warnDirectoriesOnBrowsing

name: warnDirectoriesOnBrowsing, type: Bool, default: TRUE

makeFrameOfReferenceGUIInsensitive

name: makeFrameOfReferenceGUIInsensitive, type: Bool, default: FALSE

referencedImageSequenceClear

name: referencedImageSequenceClear, type: Trigger

makeCommonInstanceReferenceModuleGUIInsensitive

name: makeCommonInstanceReferenceModuleGUIInsensitive, type: Bool, default: FALSE