DicomSCSave¶

MLModule¶

genre	`DICOM`
author	`Wolf Spindler`
package	`FMEstable/ReleaseMeVis`
dll	`MLDicomOutputs`
definition	MLDicomOutputs.def
see also	`DicomEnhancedSave`, `DicomREGSave`, `DicomSRSave`, `DicomFIDSave`, `DirectDicomImport`, `RTObjectSave`, `WEMDicomSave`, `ImageSave`, `itkImageFileWriter`, `MultiFileVolumeListImageOutput`, `MultiFileVolumeListSROutput`, `MultiFileVolumeListRTOutput`, `MultiFileVolumeListWaveformOutput`, `MultiFileVolumeListIteratorOutput`
keywords	`DICOM`, `output`, `save`, `export`, `file`, `screen`, `screenshot`, `snap`, `shot`, `secondary`, `capture`, `report`

Purpose¶

Creates and composes a DICOM file of modality secondary capture (SC). At the required input #0 the image must be connected whose content shall written as secondary capture image data. At optional input #1 an image can be connected from which DICOM tag information shall be copied/inherited.

This class derives much generic DICOM save functionality from DicomSaveBase. It provides options such as inheriting/copying DICOM information from input sources such as ML images, DICOM files, or a DirectDicomImport module.

Apart from a few optional tags only mandatory tags are written by this module.

For further information see DICOM standard

ftp://medical.nema.org/medical/dicom/final/sup57_ft.pdf
http://medical.nema.org/Dicom/2011/11_03pu.pdf, section A.8, Secondary Capture Image Information Definition and section C.8.6, Secondary Capture Modules.

Windows¶

Default Panel¶

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

Input Fields¶

input0¶

name: input0, type: Image¶: At this connector the image content to be saved in the file has to be provided.

input1¶

name: input1, type: Image¶: This is an optionally usable connector from which DICOM information can be inherited.

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.

Parameter Fields¶

Field Index¶

`#Volumes`: `Integer`	`File Name (unresolvedFileName)`: `String`	`Patient Birth Date Month String`: `String`
`Accession Number`: `String`	`File Name (fileName)`: `String`	`Patient Birth Date Year`: `Enum`
`Add Image Plane Module`: `Bool`	`Filter`: `String`	`Patient Birth Date Year String`: `String`
`Annotate`: `Bool`	`Image Orientation Patient`: `Vector6`	`Patient ID`: `String`
`Auto`: `Bool`	`Image Position Patient`: `Vector3`	`Patient Orientation`: `String`
`autoCreateDeviceSerialNumber`: `Enum`	`Inherit DICOM Information (CTRL+R)`: `Trigger`	`Patient Sex`: `Enum`
`autoCreateDeviceSerialNumberForContributedEquipmentSequence`: `Enum`	`Inherit Series Number`: `Bool`	`Patient Sex String`: `String`
`autoCreateManufacturer`: `Enum`	`Inherit Specific Character Set`: `Bool`	`Patients Name`: `String`
`autoCreateManufacturerForContributedEquipmentSequence`: `Enum`	`inheritAndCopyTagsOtherGeneralEquipmentTags`: `Bool`	`Pixel Spacing`: `Vector2`
`autoCreateManufacturerModelName`: `Enum`	`inheritAndCopyTagsOtherGeneralEquipmentTagsForContributedEquipmentSequence`: `Bool`	`Post Bad Param Errors`: `Bool`
`autoCreateManufacturerModelNameForContributedEquipmentSequence`: `Enum`	`inheritAndCopyTagsOtherGeneralStudyTags`: `Bool`	`Referring Physician Name`: `String`
`autoCreateSeriesInstanceUID`: `Enum`	`inheritAndCopyTagsOtherPatientDemographicTags`: `Bool`	`Save (Ctrl+S)`: `Trigger`
`autoCreateSoftwareVersions`: `Enum`	`inheritAndCopyTagsOtherPatientIdentificationTags`: `Bool`	`Series Description`: `String`
`autoCreateSoftwareVersionsForContributedEquipmentSequence`: `Enum`	`inheritAndCopyTagsOtherPatientMedicalTags`: `Bool`	`Series Number`: `String`
`Body Part Examined`: `String`	`inheritAndCopyTagsOtherPatientRelationshipTags`: `Bool`	`seriesInstanceUID`: `String`
`bodyPartExaminedValues`: `String`	`inheritAndCopyTagsOtherPatientStudyTags`: `Bool`	`Set Default`: `Trigger`
`Burned In Annotation`: `Enum`	`inheritDeviceSerialNumber`: `Enum`	`Slice Thickness`: `Double`
`Content Date`: `String`	`inheritDeviceSerialNumberForContributedEquipmentSequence`: `Enum`	`softwareVersions`: `String`
`Content Time`: `String`	`inheritManufacturer`: `Enum`	`softwareVersionsForContributedEquipmentSequence`: `String`
`Conversion Type`: `Enum`	`inheritManufacturerForContributedEquipmentSequence`: `Enum`	`Sop Class UID`: `String`
`Copy Other Input Tags`: `Bool`	`inheritManufacturerModelName`: `Enum`	`Sop Instance UID`: `String`
`Create new UID`: `Trigger`	`inheritManufacturerModelNameForContributedEquipmentSequence`: `Enum`	`Specific Character Set`: `String`
`Create Or Extend Contributing Equipment Sequence`: `Bool`	`inheritSeriesInstanceUID`: `Enum`	`Status`: `String`
`createDeviceSerialNumber`: `Trigger`	`inheritSoftwareVersions`: `Enum`	`Study Date`: `String`
`createDeviceSerialNumberForContributedEquipmentSequence`: `Trigger`	`inheritSoftwareVersionsForContributedEquipmentSequence`: `Enum`	`Study Description`: `String`
`createManufacturer`: `Trigger`	`InIdx`: `Integer`	`Study ID`: `String`
`createManufacturerForContributedEquipmentSequence`: `Trigger`	`Input Selector`: `Enum`	`Study Instance UID`: `String`
`createManufacturerModelName`: `Trigger`	`Instance Number`: `String`	`Study Time`: `String`
`createManufacturerModelNameForContributedEquipmentSequence`: `Trigger`	`Laterality`: `Enum`	`Tag Dump`: `String`
`createSeriesInstanceUID`: `Trigger`	`Laterality Checks`: `Enum`	`Tag Dump Size`: `Integer`
`createSoftwareVersions`: `Trigger`	`manufacturer`: `String`	`True File Name`: `String`
`createSoftwareVersionsForContributedEquipmentSequence`: `Trigger`	`manufacturerForContributedEquipmentSequence`: `String`	`Use Empty Laterality Tag If Not Found On Inheritance`: `Bool`
`defaultManufacturer`: `String`	`manufacturerModelName`: `String`	`useMMSUIDPrefix`: `Bool`
`defaultManufacturerForContributedEquipmentSequence`: `String`	`manufacturerModelNameForContributedEquipmentSequence`: `String`	`warnDirectoriesOnBrowsing`: `Bool`
`defaultManufacturerModelName`: `String`	`Nominal Scanned Pixel Spacing`: `Vector2`	`warnNonExistingFileOnBrowsing`: `Bool`
`defaultManufacturerModelNameForContributedEquipmentSequence`: `String`	`Num shown binary bytes`: `Integer`	`Write Body Part Examined`: `Bool`
`deviceSerialNumber`: `String`	`Patient Birth Date Day`: `Enum`	`Write Specific Character Set`: `Bool`
`deviceSerialNumberForContributedEquipmentSequence`: `String`	`Patient Birth Date Day String`: `String`
`Dump Private Tag Values`: `Bool`	`Patient Birth Date Month`: `Enum`

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 the structured report file to be written.

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	Description
Image Connector #0	ImageConnector #0	If `Input Selector` is set to this mode, then the DICOM tree used for inheriting DICOM tags is taken from the first image connector.
Image Connector #1	ImageConnector #1	If `Input Selector` is set to this mode, then the DICOM tree used for inheriting DICOM tags is taken from the second image connector.
File	File	If `Input Selector` is set to this mode, then the DICOM tree used for inheriting DICOM tags is loaded from the file specified in `File Name`.
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.

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 pressed then the DICOM information is saved in file with name given 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 information, messages and errors.

Patients Name¶

name: patientsName, type: String¶: DICOM tag: The patient name (0010,0010) to be written.

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

Values:

Title	Name
User Defined	User Defined
1900	1900
1901	1901
1902	1902
1903	1903
1904	1904
1905	1905
1906	1906
1907	1907
1908	1908
1909	1909
1910	1910
1911	1911
1912	1912
1913	1913
1914	1914
1915	1915
1916	1916
1917	1917
1918	1918
1919	1919
1920	1920
1921	1921
1922	1922
1923	1923
1924	1924
1925	1925
1926	1926
1927	1927
1928	1928
1929	1929
1930	1930
1931	1931
1932	1932
1933	1933
1934	1934
1935	1935
1936	1936
1937	1937
1938	1938
1939	1939
1940	1940
1941	1941
1942	1942
1943	1943
1944	1944
1945	1945
1946	1946
1947	1947
1948	1948
1949	1949
1950	1950
1951	1951
1952	1952
1953	1953
1954	1954
1955	1955
1956	1956
1957	1957
1958	1958
1959	1959
1960	1960
1961	1961
1962	1962
1963	1963
1964	1964
1965	1965
1966	1966
1967	1967
1968	1968
1969	1969
1970	1970
1971	1971
1972	1972
1973	1973
1974	1974
1975	1975
1976	1976
1977	1977
1978	1978
1979	1979
1980	1980
1981	1981
1982	1982
1983	1983
1984	1984
1985	1985
1986	1986
1987	1987
1988	1988
1989	1989
1990	1990
1991	1991
1992	1992
1993	1993
1994	1994
1995	1995
1996	1996
1997	1997
1998	1998
1999	1999
2000	2000
2001	2001
2002	2002
2003	2003
2004	2004
2005	2005
2006	2006
2007	2007
2008	2008
2009	2009
2010	2010
2011	2011
2012	2012
2013	2013
2014	2014
2015	2015
2016	2016
2017	2017
2018	2018
2019	2019
2020	2020
2021	2021
2022	2022
2023	2023
2024	2024
2025	2025
2026	2026
2027	2027
2028	2028
2029	2029
2030	2030
2031	2031
2032	2032
2033	2033
2034	2034
2035	2035
2036	2036
2037	2037
2038	2038
2039	2039
2040	2040
2041	2041
2042	2042
2043	2043
2044	2044
2045	2045
2046	2046
2047	2047
2048	2048
2049	2049
2050	2050
2051	2051
2052	2052
2053	2053
2054	2054
2055	2055
2056	2056
2057	2057
2058	2058
2059	2059

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

Values:

Title	Name
User Defined	User Defined
01-January	01-January
02-February	02-February
03-March	03-March
04-April	04-April
05-May	05-May
06-June	06-June
07-July	07-July
08-August	08-August
09-September	09-September
10-October	10-October
11-November	11-November
12-December	12-December

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

Values:

Title	Name
User Defined	User Defined
01	01
02	02
03	03
04	04
05	05
06	06
07	07
08	08
09	09
10	10
11	11
12	12
13	13
14	14
15	15
16	16
17	17
18	18
19	19
20	20
21	21
22	22
23	23
24	24
25	25
26	26
27	27
28	28
29	29
30	30
31	31

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

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 Auto 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¶

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.

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, deprecated name: studyUID¶: 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.

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¶: See DicomEnhancedSave.seriesInstanceUID.

inheritSeriesInstanceUID¶

name: inheritSeriesInstanceUID, type: Enum, default: CreateNew¶: See DicomEnhancedSave.inheritSeriesInstanceUID.

Values:

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

autoCreateSeriesInstanceUID¶

name: autoCreateSeriesInstanceUID, type: Enum, default: CreateIfNeeded¶: See DicomEnhancedSave.autoCreateSeriesInstanceUID.

Values:

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

createSeriesInstanceUID¶

name: createSeriesInstanceUID, type: Trigger¶: See DicomEnhancedSave.createSeriesInstanceUID.

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.

Laterality¶

name: laterality, type: Enum, default: DoNotWriteTagValue¶: 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. This field allows 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.

Laterality Checks¶

name: lateralityChecks, type: Enum, default: AsWarning¶: The combinations of values of Laterality tag(s) and BodyPartExamined cannot be checked reliably in all situations; therefore a deactivation or only warning logs may be useful in some cases.

Values:

Title	Name
As Error	AsError
As Warning	AsWarning
Ignore	Ignore

Series Description¶

name: seriesDescription, type: String¶: DICOM tag: Series Description (0008,103E). Optional, may be empty.

Write Body Part Examined¶

name: writeBodyPartExamined, type: Bool, default: FALSE¶: If enabled Then the Body Part Examined (0018,0015) tag is written into output files, otherwise not.

Body Part Examined¶

name: bodyPartExamined, type: String¶: DICOM tag: Body Part Examined (0018,0015). Text description of the part of the body examined. See Annex L ‘Correspondence of Anatomic Region Codes and Body Part Examined Defined Terms’ in PS3.16 for Defined Terms

bodyPartExaminedValues¶

name: bodyPartExaminedValues, type: String, default: ABDOMEN,ABDOMENPELVIS,ADRENAL,ANKLE,AORTA,ARM,ATLANTOAXIAL,ATLANTOOCCIPITAL,AXILLA,BACK,BLADDER,BRAIN,BREAST,BRONCHUS,BUTTOCK,CALCANEUS,CALF,CAROTID,CARPUS,CEREBELLUM,CERVIX,CHEEK,CHEST,CHESTABDOMEN,CHESTABDPELVIS,CIRCLEOFWILLIS,CLAVICLE,COCCYX,COLON,CORNEA,CORONARYARTERY,CSPINE,CTSPINE,DIGIT,DISTALPHALANX,DUODENUM,EAR,ELBOW,ESOPHAGUS,EXTREMITY,EYE,EYELID,FACE,FEMUR,FIBULA,FINGER,FOOT,FOREFETLOCK,FOREFOOT,FORENAVICULAR,FOREPASTERN,FRONTALSINUS,GALLBLADDER,HAND,HEAD,HEADNECK,HEART,HINDFETLOCK,HINDFOOT,HINDNAVICULAR,HINDPASTERN,HIP,HUMERUS,IAC,ILEUM,ILIUM,JAW,JEJUNUM,KIDNEY,KNEE,LARYNX,LEG,LEGS,LIVER,LSPINE,LSSPINE,LUNG,MAXILLA,MEDIASTINUM,METACARPUS,METATARSUS,MOUTH,NECK,NECKCHEST,NECKCHESTABDOMEN,NECKCHESTABDPELV,NOSE,ORBIT,OVARY,PANCREAS,PAROTID,PATELLA,PELVIS,PENIS,PHARYNX,PROSTATE,RADIUS,RADIUSULNA,RECTUM,RIB,SCALP,SCAPULA,SCLERA,SCROTUM,SHOULDER,SKULL,SPINE,SPLEEN,SSPINE,STERNUM,STIFLE,STOMACH,SUBMANDIBULAR,TAIL,TARSUS,TESTIS,THIGH,THUMB,THYMUS,THYROID,TIBIA,TIBIAFIBULA,TLSPINE,TMJ,TOE,TONGUE,TRACHEA,TSPINE,UGITRACT,ULNA,URETER,URETHRA,URINARYTRACT,UTERUS,VAGINA,VULVA,WHOLEBODY,WING,WRIST,ZYGOMA¶: See DicomEnhancedSave.bodyPartExaminedValues.

manufacturer¶

name: manufacturer, type: String¶: See DicomEnhancedSave.manufacturer.

inheritManufacturer¶

name: inheritManufacturer, type: Enum, default: CreateNewIfNeeded¶: See DicomEnhancedSave.inheritManufacturer.

Values:

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

autoCreateManufacturer¶

name: autoCreateManufacturer, type: Enum, default: CreateIfNeeded¶: See DicomEnhancedSave.autoCreateManufacturer.

Values:

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

createManufacturer¶

name: createManufacturer, type: Trigger¶: See DicomEnhancedSave.createManufacturer.

defaultManufacturer¶

name: defaultManufacturer, type: String, default: Fraunhofer MEVIS¶: See DicomEnhancedSave.defaultManufacturer.

manufacturerModelName¶

name: manufacturerModelName, type: String¶: See DicomEnhancedSave.manufacturerModelName.

inheritManufacturerModelName¶

name: inheritManufacturerModelName, type: Enum, default: CreateNewIfNeeded¶: See DicomEnhancedSave.inheritManufacturerModelName.

Values:

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

autoCreateManufacturerModelName¶

name: autoCreateManufacturerModelName, type: Enum, default: CreateIfNeeded¶: See DicomEnhancedSave.autoCreateManufacturerModelName.

Values:

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

createManufacturerModelName¶

name: createManufacturerModelName, type: Trigger¶: See DicomEnhancedSave.createManufacturerModelName.

defaultManufacturerModelName¶

name: defaultManufacturerModelName, type: String, default: MeVisLab¶: See DicomEnhancedSave.defaultManufacturerModelName.

deviceSerialNumber¶

name: deviceSerialNumber, type: String¶: See DicomEnhancedSave.deviceSerialNumber.

inheritDeviceSerialNumber¶

name: inheritDeviceSerialNumber, type: Enum, default: CreateNew¶: See DicomEnhancedSave.inheritDeviceSerialNumber.

Values:

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

autoCreateDeviceSerialNumber¶

name: autoCreateDeviceSerialNumber, type: Enum, default: CreateIfNeeded¶: See DicomEnhancedSave.autoCreateDeviceSerialNumber.

Values:

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

createDeviceSerialNumber¶

name: createDeviceSerialNumber, type: Trigger¶: See DicomEnhancedSave.createDeviceSerialNumber.

softwareVersions¶

name: softwareVersions, type: String¶: See DicomEnhancedSave.softwareVersions.

inheritSoftwareVersions¶

name: inheritSoftwareVersions, type: Enum, default: CreateNew¶: See DicomEnhancedSave.inheritSoftwareVersions.

Values:

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

autoCreateSoftwareVersions¶

name: autoCreateSoftwareVersions, type: Enum, default: CreateIfNeeded¶: See DicomEnhancedSave.autoCreateSoftwareVersions.

Values:

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

createSoftwareVersions¶

name: createSoftwareVersions, type: Trigger¶: See DicomEnhancedSave.createSoftwareVersions.

inheritAndCopyTagsOtherGeneralEquipmentTags¶

name: inheritAndCopyTagsOtherGeneralEquipmentTags, type: Bool, default: FALSE¶: See DicomEnhancedSave.inheritAndCopyTagsOtherGeneralEquipmentTags.

Instance Number¶

name: instanceNumber, type: String¶: DICOM tag: Instance Number (0020,0013). A number that identifies this image. May be empty.

Patient Orientation¶

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

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.

Add Image Plane Module¶

name: addImagePlaneModule, type: Bool, default: FALSE¶: If disabled then the image plane module is suppressed. WARNING: WETHER THE ADDITION OF IMAGE PLANE MODULE IS ALLOWED FOR SPECIFIC SC IMAGE SHOULD BE CHECKED CAREFULLY!

Pixel Spacing¶

name: pixelSpacing, type: Vector2, default: 1 1¶: DICOM tag: The PixelSpacing (0028,0030) to be written into the SC image, usually derived from the connected input image.

Slice Thickness¶

name: sliceThickness, type: Double, default: 1¶: DICOM tag: The SliceThickness (0018,0050) to be written into the image, manually defined or derived from the connected input image.

Image Position Patient¶

name: imagePositionPatient, type: Vector3, default: 0 0 0¶: DICOM tag: The ImagePositionPatient (0020,0032) to be written into the image, 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) to be written into the image, usually derived from the connected input image.

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

Burned In Annotation¶

name: burnedInAnnotation, type: Enum, default: NO¶: DICOM tag: Burned-In Annotation (0028,0301). Indicates whether or not image contains sufficient burned in annotation to identify the patient and date the image was acquired.

Values:

Title	Name
Yes	YES
No	NO

Nominal Scanned Pixel Spacing¶

name: nominalScannedPixelSpacing, type: Vector2, default: 1 1¶: DICOM tag: Nominal Scanned Pixel Spacing (0018,2010). The NominalScannedPixelSpacing tag to be written into the SC image in the case that ‘Conversion Type’ is ‘DF = Digitized Film’.

Sop Class UID¶

name: sopClassUID, type: String, default: 1.2.840.10008.5.1.4.1.1.7.4¶: 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.

useMMSUIDPrefix¶

name: useMMSUIDPrefix, type: Bool, default: TRUE¶: See DicomEnhancedSave.useMMSUIDPrefix.

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.

defaultManufacturerForContributedEquipmentSequence¶

name: defaultManufacturerForContributedEquipmentSequence, type: String, default: Fraunhofer MEVIS¶: See DicomEnhancedSave.defaultManufacturerForContributedEquipmentSequence.

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.

defaultManufacturerModelNameForContributedEquipmentSequence¶

name: defaultManufacturerModelNameForContributedEquipmentSequence, type: String, default: MeVisLab¶: See DicomEnhancedSave.defaultManufacturerModelNameForContributedEquipmentSequence.

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.

Hidden Fields¶

warnNonExistingFileOnBrowsing¶

name: warnNonExistingFileOnBrowsing, type: Bool, default: TRUE¶: See DicomEnhancedSave.warnOnExistingFileOnBrowsing.

warnDirectoriesOnBrowsing¶

name: warnDirectoriesOnBrowsing, type: Bool, default: TRUE¶: See DicomEnhancedSave.warnDirectoriesOnBrowsing.