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

IDLffDICOM::GetElement

IDLffDICOM::GetElement

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

The IDLffDICOM::GetElement function method takes optional DICOM group and/or element arguments and returns an array of DICOM Element numbers for those parameters.

Syntax


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

Return Value


Returns an array of integers representing the DICOM Element numbers for the parameters of the Group and Element arguments. If no arguments or keywords are specified, the returned array contains Element numbers for all elements in the object. The effect of multiple keywords and parameters is to AND their results. If no matching elements can be found, the function returns -1.

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 to search for, 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 element number values.

Examples


obj = OBJ_NEW('IDLffDICOM')
read = obj->Read(DIALOG_PICKFILE(FILTER='*'))
 
; Get references to all elements with "patient" in the description:
refs = obj->GetReference(DESCRIPTION='patient')
 
; Get the element numbers of the elements containing "patient":
FOR i = 0, N_ELEMENTS(refs)-1 DO BEGIN
   num = obj->GetElement(REFERENCE=refs[i])
   PRINT,num
ENDFOR
 
; Get the element numbers from the Patient Info group, 0010:
elements = obj->GetElement('0010'x)
PRINT, elements
 
OBJ_DESTROY,obj

Version History


5.2

Introduced



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