Purpose

DicomDOCSave creates and composes a DICOM file encapsulating a document of type PDF (Portable Document Format), CDA (Clinical Document Architecture (HL7)), STL (Stereo Lithography data format), ASCII OBJ (Wavefront .obj), or MTL (Material Library File) and provides/composes the necessary tags to fulfill the DICOM standard requirements. It derives much generic DICOM save functionality from module DicomSaveBase.

Note

It is the user’s authority to guarantee correctly typed and valid content of the files to be encapsulated in the exported DICOM files. DicomDOCSave still does not perform any validation in this direction.

Windows

Default Panel

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

Input Fields

input0

name: input0, type: Image

This input is used as source for DICOM tags to inherit if Input Selector is set to ImageConnector.

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 to BaseConnector 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.

Parameter Fields

Field Index

#Volumes: Integer Document Title: String Patient Birth Date Month: Enum
Accession Number: String Dump Private Tag Values: Bool Patient Birth Date Month String: String
Acquisition Date: String File Name (unresolvedFileName): String Patient Birth Date Year: Enum
Acquisition Time: String File Name (fileName): String Patient Birth Date Year String: String
Annotate: Bool Filter: String Patient ID: String
Auto: Bool Inherit DICOM Information (CTRL+R): Trigger Patient Sex: Enum
autoCreateDeviceSerialNumber: Enum Inherit Series Number: Bool Patient Sex String: String
autoCreateDeviceSerialNumberForContributedEquipmentSequence: Enum Inherit Specific Character Set: Bool patientOrientation: String
autoCreateManufacturer: Enum inheritAndCopyTagsOtherEncapsulatedDocumentSeriesTags: Bool Patients Name: String
autoCreateManufacturerForContributedEquipmentSequence: Enum inheritAndCopyTagsOtherGeneralEquipmentTags: Bool Post Bad Param Errors: Bool
autoCreateManufacturerModelName: Enum inheritAndCopyTagsOtherGeneralEquipmentTagsForContributedEquipmentSequence: Bool recognizableVisualFeatures: Bool
autoCreateManufacturerModelNameForContributedEquipmentSequence: Enum inheritAndCopyTagsOtherGeneralStudyTags: Bool Referring Physician Name: String
autoCreateSeriesInstanceUID: Enum inheritAndCopyTagsOtherManufacturing3DModelModuleTags: Bool Save (Ctrl+S): Trigger
autoCreateSoftwareVersions: Enum inheritAndCopyTagsOtherPatientDemographicTags: Bool Series Description: String
autoCreateSoftwareVersionsForContributedEquipmentSequence: Enum inheritAndCopyTagsOtherPatientIdentificationTags: Bool Series Number: String
burnedInAnnotation: Bool inheritAndCopyTagsOtherPatientMedicalTags: Bool seriesInstanceUID: String
cidEntryCID_7063: Enum inheritAndCopyTagsOtherPatientRelationshipTags: Bool Set Default: Trigger
Content Date: String inheritAndCopyTagsOtherPatientStudyTags: Bool softwareVersions: String
Content Description: String inheritBurnedInAnnotation: Enum softwareVersionsForContributedEquipmentSequence: String
Content Time: String inheritDeviceSerialNumber: Enum Sop Class UID: String
Conversion Type: Enum inheritDeviceSerialNumberForContributedEquipmentSequence: Enum Sop Instance UID: String
Copy Other Input Tags: Bool inheritManufacturer: Enum Specific Character Set: String
Create new UID: Trigger inheritManufacturerForContributedEquipmentSequence: Enum Status: String
Create Or Extend Contributing Equipment Sequence: Bool inheritManufacturerModelName: Enum Study Date: String
createDeviceSerialNumber: Trigger inheritManufacturerModelNameForContributedEquipmentSequence: Enum Study Description: String
createDeviceSerialNumberForContributedEquipmentSequence: Trigger inheritModelMirroring: Enum Study ID: String
createManufacturer: Trigger inheritModelModification: Enum Study Instance UID: String
createManufacturerForContributedEquipmentSequence: Trigger inheritRecognizableVisualFeatures: Enum Study Time: String
createManufacturerModelName: Trigger inheritSeriesInstanceUID: Enum Tag Dump: String
createManufacturerModelNameForContributedEquipmentSequence: Trigger inheritSoftwareVersions: Enum Tag Dump Size: Integer
createSeriesInstanceUID: Trigger inheritSoftwareVersionsForContributedEquipmentSequence: Enum True File Name: String
createSoftwareVersions: Trigger InIdx: Integer Type of Document to Save: Enum
createSoftwareVersionsForContributedEquipmentSequence: Trigger Input Selector: Enum updateWriteOnInheritBurnedInAnnotation: Bool
defaultManufacturer: String Instance Number: String updateWriteOnInheritModelMirroring: Bool
defaultManufacturerForContributedEquipmentSequence: String makeCIDEditGUIInsensitiveCID_7063: Bool updateWriteOnInheritModelModification: Bool
defaultManufacturerModelName: String manufacturer: String updateWriteOnInheritRecognizableVisualFeatures: Bool
defaultManufacturerModelNameForContributedEquipmentSequence: String manufacturerForContributedEquipmentSequence: String useMMSUIDPrefix: Bool
defaultValueBurnedInAnnotation: Bool manufacturerModelName: String warnDirectoriesOnBrowsing: Bool
defaultValueModelMirroring: Bool manufacturerModelNameForContributedEquipmentSequence: String warnNonExistingFileOnBrowsing: Bool
defaultValueModelModification: Bool modelMirroring: Bool Write Specific Character Set: Bool
defaultValueRecognizableVisualFeatures: Bool modelModification: Bool writeBurnedInAnnotation: Bool
deviceSerialNumber: String Num shown binary bytes: Integer writeModelMirroring: Bool
deviceSerialNumberForContributedEquipmentSequence: String Patient Birth Date Day: Enum writeModelModification: Bool
Document File Name: String Patient Birth Date Day String: String writeRecognizableVisualFeatures: Bool

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

Absolute file path updated from File Name.

Input Selector

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

Selects from which connector a DICOM tree shall be loaded or retrieved.

Values:

Title Name Description
Image Connector ImageConnector DICOM information is inherited from the input0.
Base Connector BaseConnector DICOM information is inherited from the inputBase.
File File DICOM information is inherited from the file specified in File Name / True File Name.

InIdx

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

If a MultiFileVolumeList is connected or loaded then one of multiple volumes can be selected with this field. The number of available volumes is shown in the #Volumes. Otherwise this should always be 0.

#Volumes

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

This read-only field shows the number of available volumes. For most inputs this will be 0 if no DICOM tree is available, 1 if there is any, or any other number for a lists of volumes at inputBase if a MultiFileVolumeListRefCounted base object is connected and selected in Input Selector.

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 DICOM related information is inherited from the input selected in Input Selector. Note that some DICOM tags of the input image are not inherited or removed to avoid that they cause trouble in the output file. See On Inherit: fields for details.

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 the given information from inputs and fields are composed to a DICOM file with modality SEG which is saved in the file determined by File Name.

File Name (fileName)

name: fileName, type: String

The path and name of the 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.

Type of Document to Save

name: docType, type: Enum, default: PDF

Type of content of the document to save. Note that content of the document will not be checked for validity or type.

Values:

Title Name
PDF PDF
CDA CDA
STL STL
OBJ OBJ
MTL MTL

Patients Name

name: patientsName, type: String

DICOM tag: The patient name (0010,0010) to be written. Note that DICOM checkers often complain about typically used names. A typical and standard compliant name is, for example, Familyname^Firstname. See http://dicom.nema.org/dicom/2013/output/chtml/part05/sect_6.2.html for definition and http://dicom.nema.org/dicom/2013/output/chtml/part05/sect_6.2.html#sect_6.2.1.1 for examples.

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).

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).

inheritAndCopyTagsOtherPatientRelationshipTags

name: inheritAndCopyTagsOtherPatientRelationshipTags, type: Bool, default: FALSE

See DicomEnhancedSave.inheritAndCopyTagsOtherPatientRelationshipTags.

inheritAndCopyTagsOtherPatientIdentificationTags

name: inheritAndCopyTagsOtherPatientIdentificationTags, type: Bool, default: FALSE

See DicomEnhancedSave.inheritAndCopyTagsOtherPatientIdentificationTags.

inheritAndCopyTagsOtherPatientDemographicTags

name: inheritAndCopyTagsOtherPatientDemographicTags, type: Bool, default: FALSE

See DicomEnhancedSave.inheritAndCopyTagsOtherPatientDemographicTags.

inheritAndCopyTagsOtherPatientMedicalTags

name: inheritAndCopyTagsOtherPatientMedicalTags, type: Bool, default: FALSE

See DicomEnhancedSave.inheritAndCopyTagsOtherPatientMedicalTags.

Study Instance UID

name: studyInstanceUID, type: String

DICOM tag: Study Instance UID (0020,000D) Unique identifier for the study. If available then see field autoUpdateOnStudyInstanceUIDChanges 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 ‘.’. This field is insensitive if Auto (Auto) is enabled.

Create new UID

name: createStudyInstanceUID, type: Trigger

Creates a new Study Instance UID

Auto

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. Makes Study Instance UID (Study Instance UID) insensitive if enabled.

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 ID

name: studyID, type: String

DICOM tag: Study ID (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.

inheritAndCopyTagsOtherGeneralStudyTags

name: inheritAndCopyTagsOtherGeneralStudyTags, type: Bool, default: FALSE

See DicomEnhancedSave.inheritAndCopyTagsOtherGeneralStudyTags.

inheritAndCopyTagsOtherPatientStudyTags

name: inheritAndCopyTagsOtherPatientStudyTags, type: Bool, default: FALSE

See DicomEnhancedSave.inheritAndCopyTagsOtherPatientStudyTags.

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 ‘.’. Maybe insensitive dependent on the state of autoCreateSeriesInstanceUID (On Save).

inheritSeriesInstanceUID

name: inheritSeriesInstanceUID, type: Enum, default: CreateNew

Which value to set on inheriting:

DoNotInherit: Do not inherit SeriesInstanceUID from input and leave value unchanged.

InheritFromTopLevel: Inherit SeriesInstanceUID from top level of input DCMTree; value is set empty if not found.

InheritRecursively: Inherit SeriesInstanceUID from recursive search in input DCMTree; value is set empty if not found.

CreateNew: Create a new SeriesInstanceUID instead of inheriting one.

CreateNewIfNeeded: Same as CreateNew, but only if SeriesInstanceUID is empty.

autoCreateSeriesInstanceUID

name: autoCreateSeriesInstanceUID, type: Enum, default: CreateIfNeeded

Which value to use on saving:

DoNotAutoCreate: Do not create a new SeriesInstanceUID, just use the current value, and value is left unchanged.

AutoCreateAlways: Always create a new SeriesInstanceUID even if another one is set (value is overwritten).

CreateIfNeeded: Create a new SeriesInstanceUID if value is empty (value is overwritten).

createSeriesInstanceUID

name: createSeriesInstanceUID, type: Trigger

Creates a new unique SeriesInstanceUID value.

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: FALSE

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

Series Description

name: seriesDescription, type: String

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

inheritAndCopyTagsOtherEncapsulatedDocumentSeriesTags

name: inheritAndCopyTagsOtherEncapsulatedDocumentSeriesTags, type: Bool, default: FALSE

If enabled then other input Encapsulated Document Series tags are buffered during Inherit DICOM Information (CTRL+R) and added to the output during Save (Ctrl+S); otherwise only the mandatory tags and/or fields are added to the output.

manufacturer

name: manufacturer, type: String

DICOM tag: Manufacturer (0008,0070). Company creating the DICOM file. In enhanced contexts it must have a value but in some other contexts it may be empty.

Defaults to ‘Fraunhofer MEVIS’ if not set otherwise in hidden defaultManufacturer field. Maybe insensitive dependent on the state of autoCreateManufacturer (On Save).

inheritManufacturer

name: inheritManufacturer, type: Enum, default: CreateNewIfNeeded

See inheritSeriesInstanceUID.

autoCreateManufacturer

name: autoCreateManufacturer, type: Enum, default: CreateIfNeeded

See autoCreateSeriesInstanceUID.

createManufacturer

name: createManufacturer, type: Trigger

See createSeriesInstanceUID.

manufacturerModelName

name: manufacturerModelName, type: String

DICOM tag: Manufacturers Model Name (0008,1090) determined by the manufacturer. In enhanced contexts it must have a value but in some other contexts it may be empty.

Defaults to ‘MeVisLab’ if not set otherwise in hidden ‘defaultManufacturerModelName’ field. Maybe insensitive dependent on the state of autoCreateManufacturerModelName (On Save).

inheritManufacturerModelName

name: inheritManufacturerModelName, type: Enum, default: CreateNewIfNeeded

See inheritSeriesInstanceUID.

autoCreateManufacturerModelName

name: autoCreateManufacturerModelName, type: Enum, default: CreateIfNeeded

See autoCreateSeriesInstanceUID.

createManufacturerModelName

name: createManufacturerModelName, type: Trigger

See createSeriesInstanceUID.

deviceSerialNumber

name: deviceSerialNumber, type: String

DICOM tag: Device Serial Number (0018,1000). The serial number of the device. In enhanced contexts it must have a value but in some other contexts it may be empty.

Generated numbers have the format

‘SN’ + ‘_’ + MeVisLabVersion + ‘_’ + Platform + ‘_’ + Compiler + ‘_’ + Bitness + ‘_’ + MAC + ‘_’ + ‘FM’

where

‘SN’ stands for Serial Number’+

MeVisLabVersion is the coded MEVISLAB_VERSION compiler definition (e.g. 305 for MeVisLab 3.5)

Platform is ‘0’ for unknown, ‘1’ for Windows, ‘2’ for Linux, ‘3’ for MACOS,

Compiler:

  • MSC: ‘1-’ + MSCVER
  • gcc: ‘2-’ + gcc-mayor+’.’+gcc-minor+’.’+gcc-patchlevel (or 0 if not available)
  • apple-clang: ‘3-’ + __clang_version__
  • other clang: ‘4-’ + __clang_version__
  • or ‘0’ otherwise.

Bitness is ‘32’ or ‘64’ according to 32 or 64 bit systems

MAC is a decimal coded MAC address of the device if available

and ‘FM’ stands for (for Fraunhofer MEVIS). Maybe insensitive dependent on the state of autoCreateDeviceSerialNumber (On Save).

inheritDeviceSerialNumber

name: inheritDeviceSerialNumber, type: Enum, default: CreateNew

See inheritSeriesInstanceUID.

autoCreateDeviceSerialNumber

name: autoCreateDeviceSerialNumber, type: Enum, default: CreateIfNeeded

See autoCreateSeriesInstanceUID.

createDeviceSerialNumber

name: createDeviceSerialNumber, type: Trigger

See createSeriesInstanceUID.

softwareVersions

name: softwareVersions, type: String

DICOM tag: Manufacturer’s software version (0018,1020). In enhanced contexts it must have a value but in some other contexts it may be empty.

Defaults to ‘MeVisLab ‘ + current version number. Maybe insensitive dependent on the state of autoCreateSoftwareVersions (On Save).

inheritSoftwareVersions

name: inheritSoftwareVersions, type: Enum, default: CreateNew

See inheritSeriesInstanceUID.

autoCreateSoftwareVersions

name: autoCreateSoftwareVersions, type: Enum, default: CreateIfNeeded

See autoCreateSeriesInstanceUID.

createSoftwareVersions

name: createSoftwareVersions, type: Trigger

See createSeriesInstanceUID.

inheritAndCopyTagsOtherGeneralEquipmentTags

name: inheritAndCopyTagsOtherGeneralEquipmentTags, type: Bool, default: FALSE

See DicomEnhancedSave.inheritAndCopyTagsOtherGeneralEquipmentTags.

Conversion Type

name: conversionType, type: Enum, default: WSD

DICOM tag: Conversion Type (0008,0064). Describes the kind of image conversion: DV = Digitized Video DI = Digital Interface DF = Digitized Film WSD = Workstation SD = Scanned Document SI = Scanned Image DRW = Drawing SYN = Synthetic Image

Values:

Title Name
Dv DV
Di DI
Df DF
Wsd WSD
Sd SD
Si SI
Drw DRW
Syn SYN

Instance Number

name: instanceNumber, type: String

DICOM tag: Instance Number (0020,0013). Mandatory number that identifies this SOP Instance. The value shall be unique within a Series.

Content Date

name: contentDate, type: String

DICOM tag: Content Date (0008,0023). The data the image pixel data creation started. May be empty only if not used in enhanced multi-frame contexts.

Content Time

name: contentTime, type: String

DICOM tag: Content Time (0008,0033). The time the image pixel data creation started. May be empty only if not used in enhanced multi-frame contexts.

Acquisition Date

name: acquisitionDate, type: String

DICOM tag: Date part of Acquisition Date Time (0020,002A). The date the original generation of the data in the document started.

Acquisition Time

name: acquisitionTime, type: String

DICOM tag: Time part of Acquisition Date Time (0020,002A). The time the original generation of the data in the document started.

burnedInAnnotation

name: burnedInAnnotation, type: Bool, default: FALSE

Mandatory value which indicates whether or not image contains sufficient burned in annotation to identify the patient and date the image was acquired. If this Attribute is absent, then the image may or may not contain burned in annotation.

inheritBurnedInAnnotation

name: inheritBurnedInAnnotation, type: Enum, default: InheritFromTopLevel

Which value to set on inheriting:

DoNotInherit: Do not inherit Burned In Annotation (0028,0301) from input and leave value unchanged.

InheritFromTopLevel: Inherit Burned In Annotation (0028,0301) from top level of input DCMTree; use default if invalid or not found.

InheritRecursively: Inherit Burned In Annotation (0028,0301) from recursive search in input DCMTree; use default if invalid or not found.

defaultValueBurnedInAnnotation

name: defaultValueBurnedInAnnotation, type: Bool, default: FALSE

Used value if no valid value can be inherited.

recognizableVisualFeatures

name: recognizableVisualFeatures, type: Bool, default: FALSE

Indicates whether or not the image contains sufficiently recognizable visual features to allow the image or a reconstruction from a set of images to identify the Patient. If this Attribute is absent, then the image may or may not contain recognizable visual features.

inheritRecognizableVisualFeatures

name: inheritRecognizableVisualFeatures, type: Enum, default: InheritFromTopLevel

Which value to set on inheriting:

DoNotInherit: Do not inherit Recognizable Visual Features (0028,0302) from input and leave value unchanged.

InheritFromTopLevel: Inherit Recognizable Visual Features (0028,0302) from top level of input DCMTree; use default if invalid or not found.

InheritRecursively: Inherit Recognizable Visual Features (0028,0302) from recursive search in input DCMTree; use default if invalid or not found.

writeRecognizableVisualFeatures

name: writeRecognizableVisualFeatures, type: Bool, default: FALSE

Selects whether the tag is added to output or not.

defaultValueRecognizableVisualFeatures

name: defaultValueRecognizableVisualFeatures, type: Bool, default: FALSE

Used value if no valid value can be inherited.

updateWriteOnInheritRecognizableVisualFeatures

name: updateWriteOnInheritRecognizableVisualFeatures, type: Bool, default: TRUE

Enable/Disable ‘Write’ on valid/invalid value inheritance.

Document Title

name: documentTitle, type: String

DICOM tag: Document Title (0042,0010). The title of the document, may be empty. In the case of a PDF encapsulated document, this may be the value of the ‘Title’ entry in the ‘Document Information Directory’ as encoded in the PDF data.

inheritAndCopyTagsOtherManufacturing3DModelModuleTags

name: inheritAndCopyTagsOtherManufacturing3DModelModuleTags, type: Bool, default: FALSE

If enabled then other input Manufacturing 3D Module Module tags are buffered during Inherit DICOM Information (CTRL+R) and added to the output during Save (Ctrl+S); otherwise only the mandatory tags and/or fields are added to the output.

makeCIDEditGUIInsensitiveCID_7063

name: makeCIDEditGUIInsensitiveCID_7063, type: Bool, default: FALSE

Hidden field, not to be used manually: internally used field to control sensitivity of the Measurement Units Code Sequence, C.35.1, CDI 7063 tab and to indicate that it is perhaps temporarily not used; it does not affect any internal functionality.

cidEntryCID_7063

name: cidEntryCID_7063, type: Enum, default: mm - mm

Possible values for Measurement Units Code Sequence, C.35.1, CID 7063.

modelModification

name: modelModification, type: Bool, default: FALSE

DICOM tag: Model Modification (0068,7001). specifies whether a modification of the observed anatomy (other than mirroring) was used to create the model (e.g. simulating an expected surgical result). In the negative, the model follows the observed patient anatomy in the source data.

inheritModelModification

name: inheritModelModification, type: Enum, default: InheritFromTopLevel

Which value to set on inheriting:

DoNotInherit: Do not inherit Model Modification (0068,7001) from input and leave value unchanged.

InheritFromTopLevel: Inherit Model Modification (0068,7001) from top level of input DCMTree; use default if invalid or not found.

InheritRecursively: Inherit Model Modification (0068,7001) from recursive search in input DCMTree; use default if invalid or not found.

Values:

Title Name
Do Not Inherit DoNotInherit
Inherit From Top Level InheritFromTopLevel
Inherit Recursively InheritRecursively

writeModelModification

name: writeModelModification, type: Bool, default: FALSE

Selects whether the tag is added to output or not.

defaultValueModelModification

name: defaultValueModelModification, type: Bool, default: FALSE

Used value if no valid value can be inherited.

updateWriteOnInheritModelModification

name: updateWriteOnInheritModelModification, type: Bool, default: TRUE

Enable/Disable ‘Write’ on valid/invalid value inheritance.

modelMirroring

name: modelMirroring, type: Bool, default: FALSE

DICOM tag: Model Mirroring (0068,7002). specifies whether mirroring of anatomy from the other side of the patient was used to create the model.

inheritModelMirroring

name: inheritModelMirroring, type: Enum, default: InheritFromTopLevel

Which value to set on inheriting:

DoNotInherit: Do not inherit Model Mirroring (0068,7002) from input and leave value unchanged.

InheritFromTopLevel: Inherit Model Mirroring (0068,7002) from top level of input DCMTree; use default if invalid or not found.

InheritRecursively: Inherit Model Mirroring (0068,7002) from recursive search in input DCMTree; use default if invalid or not found.

writeModelMirroring

name: writeModelMirroring, type: Bool, default: FALSE

Selects whether the tag is added to output or not.

defaultValueModelMirroring

name: defaultValueModelMirroring, type: Bool, default: FALSE

Used value if no valid value can be inherited.

updateWriteOnInheritModelMirroring

name: updateWriteOnInheritModelMirroring, type: Bool, default: TRUE

Enable/Disable ‘Write’ on valid/invalid value inheritance.

Content Description

name: contentDescription, type: String

DICOM tag: Content Description (0070,0081). A description of the model (without ‘', maximum 64 bytes).

Sop Class UID

name: sopClassUID, type: String, default: 1.2.840.10008.5.1.4.1.1.104.1

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 ‘.’.

Specific Character Set

name: specificCharacterSet, type: String, default: ISO_IR 192

Specific Character Set (0008,0005) identifies the Character Set that expands or replaces the Basic Graphic Set (ISO 646) for values of Data Elements that have Value Representation of SH, LO, ST, PN, LT, UC or UT.

Recommended is ISO_IR 192 (which corresponds to the internal MeVisLab representation) or disable tag writing at all which also uses this term.

Enabling this term may cause that inconvertible characters are silently lost.

Currently supported values are

  • ISO_IR 6 // ASCII, not a real term but will drop to default, i.e. no tag will be written.
  • ISO_IR 100 // Latin alphabet No. 1
  • ISO_IR 101 // Latin alphabet No. 2
  • ISO_IR 109 // Latin alphabet No. 3
  • ISO_IR 110 // Latin alphabet No. 4
  • ISO_IR 144 // Cyrillic
  • ISO_IR 127 // Arabic
  • ISO_IR 126 // Greek
  • ISO_IR 138 // Hebrew
  • ISO_IR 148 // Latin alphabet No. 5
  • ISO_IR 13 // Japanese
  • ISO_IR 166 // Thai
  • ISO_IR 192 // Unicode in UTF-8 (multi-byte)
  • GB18030 // Chinese (multi-byte)
  • GBK // Chinese (multi-byte, subset of GB 18030

Write Specific Character Set

name: writeSpecificCharacterSet, type: Bool, default: FALSE

If enabled then Specific Character Set (0008,0005) is written into the output file, otherwise not.

Off is recomended for this field and for ‘Inherit Specific Character Set’ which then automatically uses ISO_IR 192 (=’UTF-8’ which is the internal MeVisLab representation).

Enabling this may cause that inconvertible characters are silently lost during save.

Inherit Specific Character Set

name: inheritSpecificCharacterSet, type: Bool, default: FALSE

If enabled then ‘Specific Character Set (0008,0005)’ and ‘Write specific character set’ are updated on inheritance according to the input data set.

Off is recomended for this field and for ‘Write specific character set’ which then automatically uses ISO_IR 192 (=’UTF-8’ which is the internal MeVisLab representation).

Enabling this may cause that non-ISO_IR 192 character sets are inherited and written and inconvertible characters from input are silently lost.

Set Default

name: setDefaultSpecificCharacterSet, type: Trigger

Sets the recommended ‘ISO_IR 192’ character set as default which matches the internal UTF-8 coding in MeVisLab and reduces risk of losing inconvertible characters.

manufacturerForContributedEquipmentSequence

name: manufacturerForContributedEquipmentSequence, type: String

See DicomEnhancedSave.manufacturerForContributedEquipmentSequence.

inheritManufacturerForContributedEquipmentSequence

name: inheritManufacturerForContributedEquipmentSequence, type: Enum, default: CreateNewIfNeeded

See DicomEnhancedSave.inheritManufacturerForContributedEquipmentSequence.

Values:

Title Name
Do Not Inherit DoNotInherit
Inherit From Top Level InheritFromTopLevel
Inherit Recursively InheritRecursively
Create New CreateNew
Create New If Needed CreateNewIfNeeded

autoCreateManufacturerForContributedEquipmentSequence

name: autoCreateManufacturerForContributedEquipmentSequence, type: Enum, default: CreateIfNeeded

See DicomEnhancedSave.autoCreateManufacturerForContributedEquipmentSequence.

Values:

Title Name
Do Not Auto Create DoNotAutoCreate
Auto Create Always AutoCreateAlways
Create If Needed CreateIfNeeded

createManufacturerForContributedEquipmentSequence

name: createManufacturerForContributedEquipmentSequence, type: Trigger

See DicomEnhancedSave.createManufacturerForContributedEquipmentSequence.

manufacturerModelNameForContributedEquipmentSequence

name: manufacturerModelNameForContributedEquipmentSequence, type: String

See DicomEnhancedSave.manufacturerModelNameForContributedEquipmentSequence.

inheritManufacturerModelNameForContributedEquipmentSequence

name: inheritManufacturerModelNameForContributedEquipmentSequence, type: Enum, default: CreateNewIfNeeded

See DicomEnhancedSave.inheritManufacturerModelNameForContributedEquipmentSequence.

Values:

Title Name
Do Not Inherit DoNotInherit
Inherit From Top Level InheritFromTopLevel
Inherit Recursively InheritRecursively
Create New CreateNew
Create New If Needed CreateNewIfNeeded

autoCreateManufacturerModelNameForContributedEquipmentSequence

name: autoCreateManufacturerModelNameForContributedEquipmentSequence, type: Enum, default: CreateIfNeeded

See DicomEnhancedSave.autoCreateManufacturerModelNameForContributedEquipmentSequence.

Values:

Title Name
Do Not Auto Create DoNotAutoCreate
Auto Create Always AutoCreateAlways
Create If Needed CreateIfNeeded

createManufacturerModelNameForContributedEquipmentSequence

name: createManufacturerModelNameForContributedEquipmentSequence, type: Trigger

See DicomEnhancedSave.createManufacturerModelNameForContributedEquipmentSequence.

deviceSerialNumberForContributedEquipmentSequence

name: deviceSerialNumberForContributedEquipmentSequence, type: String

See DicomEnhancedSave.deviceSerialNumberForContributedEquipmentSequence.

inheritDeviceSerialNumberForContributedEquipmentSequence

name: inheritDeviceSerialNumberForContributedEquipmentSequence, type: Enum, default: CreateNew

See DicomEnhancedSave.inheritDeviceSerialNumberForContributedEquipmentSequence.

Values:

Title Name
Do Not Inherit DoNotInherit
Inherit From Top Level InheritFromTopLevel
Inherit Recursively InheritRecursively
Create New CreateNew
Create New If Needed CreateNewIfNeeded

autoCreateDeviceSerialNumberForContributedEquipmentSequence

name: autoCreateDeviceSerialNumberForContributedEquipmentSequence, type: Enum, default: CreateIfNeeded

See DicomEnhancedSave.autoCreateDeviceSerialNumberForContributedEquipmentSequence.

Values:

Title Name
Do Not Auto Create DoNotAutoCreate
Auto Create Always AutoCreateAlways
Create If Needed CreateIfNeeded

createDeviceSerialNumberForContributedEquipmentSequence

name: createDeviceSerialNumberForContributedEquipmentSequence, type: Trigger

See DicomEnhancedSave.createDeviceSerialNumberForContributedEquipmentSequence.

softwareVersionsForContributedEquipmentSequence

name: softwareVersionsForContributedEquipmentSequence, type: String

See DicomEnhancedSave.softwareVersionsForContributedEquipmentSequence.

inheritSoftwareVersionsForContributedEquipmentSequence

name: inheritSoftwareVersionsForContributedEquipmentSequence, type: Enum, default: CreateNew

See DicomEnhancedSave.inheritSoftwareVersionsForContributedEquipmentSequence.

Values:

Title Name
Do Not Inherit DoNotInherit
Inherit From Top Level InheritFromTopLevel
Inherit Recursively InheritRecursively
Create New CreateNew
Create New If Needed CreateNewIfNeeded

autoCreateSoftwareVersionsForContributedEquipmentSequence

name: autoCreateSoftwareVersionsForContributedEquipmentSequence, type: Enum, default: CreateIfNeeded

See DicomEnhancedSave.autoCreateSoftwareVersionsForContributedEquipmentSequence.

Values:

Title Name
Do Not Auto Create DoNotAutoCreate
Auto Create Always AutoCreateAlways
Create If Needed CreateIfNeeded

createSoftwareVersionsForContributedEquipmentSequence

name: createSoftwareVersionsForContributedEquipmentSequence, type: Trigger

See DicomEnhancedSave.createSoftwareVersionsForContributedEquipmentSequence.

inheritAndCopyTagsOtherGeneralEquipmentTagsForContributedEquipmentSequence

name: inheritAndCopyTagsOtherGeneralEquipmentTagsForContributedEquipmentSequence, type: Bool, default: FALSE

See DicomEnhancedSave.inheritAndCopyTagsOtherGeneralEquipmentTagsForContributedEquipmentSequence.

Create Or Extend Contributing Equipment Sequence

name: createOrExtendContributingEquipmentSequence, type: Bool, default: FALSE

If enabled then a new entry is appended to the inherited Contributing Equipment Sequence (0018,A001) or a new one is generated if there is none in the input. Contributing Equipment Sequence (0018,A001) is of Type 3 (not required) but according to PS3.4 ‘C.3.5 New Instance Creation for Enhanced Multi-Frame Image Conversion’ ‘The new Composite Instance shall contain the Contributing Equipment Sequence (0018,A001)’ e.g. on LegacyEnhanced creation.

Document File Name

name: documentFileName, type: String

The absolute path to the document to save. Note that content of the document will not be checked for validity or match with the document type.

Hidden Fields

warnNonExistingFileOnBrowsing

name: warnNonExistingFileOnBrowsing, type: Bool, default: TRUE

Internal field to control whether selected non-existing files are warned or not, not to be used manually.

warnDirectoriesOnBrowsing

name: warnDirectoriesOnBrowsing, type: Bool, default: TRUE

Internal field to control whether selected directories are warned or not, not to be used manually.

defaultManufacturer

name: defaultManufacturer, type: String, default: Fraunhofer MEVIS

This hidden field contains the default value for manufacturer if a new value is created with createManufacturer, during inheritance or saving. It can be changed by the application if the module is run by another manufacturer.

defaultManufacturerModelName

name: defaultManufacturerModelName, type: String, default: MeVisLab

This hidden field contains the default value for manufacturerModelName if a new value is created with createManufacturerModelName, during inheritance or saving. It can be changed by the application if the module is run by another manufacturer an/or on another model.

patientOrientation

name: patientOrientation, type: String

DICOM tag: Patient Orientation (0020,0020). May be empty. Must obey value representation CS (Uppercase characters, ‘0’-‘9’, the SPACE character, and underscore ‘_’, of the Default Character Repertoire, 16 bytes maximum).

writeBurnedInAnnotation

name: writeBurnedInAnnotation, type: Bool, default: TRUE

Tag is mandatory, thus the value is always written, disabling is ignored.

updateWriteOnInheritBurnedInAnnotation

name: updateWriteOnInheritBurnedInAnnotation, type: Bool, default: FALSE

Enable/Disable ‘Write’ on valid/invalid value inheritance, which, however, is always handled as true.

useMMSUIDPrefix

name: useMMSUIDPrefix, type: Bool, default: TRUE

If false then the UID prefix for Fraunhofer MEVIS is used instead(not recommended), if true (the recommended default) then the MMS prefix is used.

defaultManufacturerForContributedEquipmentSequence

name: defaultManufacturerForContributedEquipmentSequence, type: String, default: Fraunhofer MEVIS

See DicomEnhancedSave.defaultManufacturerForContributedEquipmentSequence.

defaultManufacturerModelNameForContributedEquipmentSequence

name: defaultManufacturerModelNameForContributedEquipmentSequence, type: String, default: MeVisLab

See DicomEnhancedSave.defaultManufacturerModelNameForContributedEquipmentSequence.