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

IDLffDICOM::GetLength

IDLffDICOM::GetLength

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

The IDLffDICOM::GetLength function method takes optional DICOM group and/or element arguments and returns an array of LONGs.

Syntax


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

Return Value


Returns an array of longword integers. The length is the field length that explicitly exists in the DICOM file, and represents the length of the element value in bytes. If no arguments or keywords are specified, the returned array contains the lengths 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 for which to search, such as ‘0018’x. If this argument is omitted, all DICOM array elements are returned.

Element

An optional argument specified only if the Group argument has also been specified. Set this 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 references from which to return length values.

Examples


obj = OBJ_NEW('IDLffDICOM')
read = obj->Read(DIALOG_PICKFILE(FILTER='*'))
 
; Get the length of the patient name element:
arr = obj->GetLength('0010'x,'0010'x)
PRINT, arr
 
; Get an array of all of the lengths from the patient info group:
arr = obj->GetLength('0010'x)
PRINT, arr
OBJ_DESTROY, obj

Version History


5.2

Introduced



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