Welcome to the Harris Geospatial product documentation center. Here you will find reference guides, help documents, and product libraries.


Harris Geospatial / Docs Center / IDL Reference / DICOM Toolkit / IDLffDICOM::GetDescription

IDLffDICOM::GetDescription

IDLffDICOM::GetDescription

Syntax | Return Value | Arguments | Keywords | Examples | Version History

The IDLffDICOM::GetDescription function method takes optional DICOM group and element arguments and returns an array of STRING descriptions.

Syntax


Result = Obj->[IDLffDICOM::]GetDescription([Group [, Element]] [, REFERENCE=list of element references])

Return Value


Returns an array of strings describing the field’s contents as per the data dictionary in the DICOM specification PS 3.6. If no arguments or keywords are specified, the returned array contains the descriptions for all elements in the object. The effect of multiple keywords and parameters is to AND their results. If no DICOM elements can be found matching the search criteria, -1 will be returned.

Arguments


Group

An optional argument representing the value for the DICOM group to search for, i.e. ‘0018’x. If this argument is omitted, then all of the DICOM array elements are returned.

Element

An optional argument specified only if the Group argument has also been specified. Set this argument to the value for the DICOM element for which to search, such as ‘0010’x. If this argument is omitted and the Group argument was specified, then all elements of the specified Group are returned.

Keywords


REFERENCE

Set this keyword to a list of element reference values from which to return description values.

Examples


obj = OBJ_NEW('IDLffDICOM')
read = obj->Read(DIALOG_PICKFILE(FILTER='*'))
 
; Get the description of the patient name element:
arr = obj->GetDescription('0010'x,'0010'x)
PRINT, arr
 
; Get array of all of the descriptions from the patient info group:
arr = obj->GetDescription('0010'x)
FOR i = 0, N_ELEMENTS(arr)-1 DO BEGIN
   PRINT, arr[i]
ENDFOR
 
OBJ_DESTROY, obj

Version History


5.2

Introduced



© 2017 Exelis Visual Information Solutions, Inc. |  Legal
My Account    |    Buy    |    Contact Us