Alphabetical Listing

DICOMEX_GETCONFIGFILEPATH

Returns the location of the local or system configuration file associated with the DICOM Network Services utility.

Result = DICOMEX_GETCONFIGFILEPATH([, /SYSTEM])

DICOMEX_GETSTORSCPDIR

Returns the location of the directory associated with the Storage SCP Service of the DICOM Network Services utility.

Result = DICOMEX_GETSTORSCPDIR()

DICOMEX_NET

Launches the DICOM Network Service utility.

DICOMEX_NET [, /SYSTEM]

IDLffDicomEx object

This object allows you to read and write DICOM files. It includes the ability to create a new DICOM file, clone and modify an existing DICOM file, or access elements from a file in read-only mode depending on how the IDLffDicomEx object is created. No superclasses. No subclasses.

Properties:

[, BITS_ALLOCATED{Get, Set}=integer] [, BITS_STORED{Get, Set}=integer] [, COLUMNS{Get, Set}=integer]
[, FILENAME{Get}=string]
[, HIGH_BIT{Get, Set}=integer]
[, IMAGE_TYPE{Get, Set}={ORIGINAL | DERIVED}
{ PRIMARY | SECONDARY}{modality specific characterists}{implementation specific characteristics}] [, INSTANCE_NUMBER{Get, Set}=string] [, MODALITY{Get, Set}=string] [, NO_PIXEL_DATA{Get, Init}=integer] [, NUMBER_OF_FRAMES{Get, Set}=string] [, PHOTOMETRIC_INTERPRETATION{Get, Set}={MONOCHROME1 | MONOCHROME2 | PALETTECOLOR | RGB | HSV | CMYK}] [, PIXEL_ASPECT_RATIO{Get, Set}=string] [, PIXEL_MAX{Get, Set}=integer]
[, PIXEL_MIN{Get, Set}=integer] [, PIXEL_REPRESENTATION{Get, Set}={0 | 1}] [, PIXEL_SPACING{Get, Set}=string] [, PLANAR_CONFIGURATION{Get, Set}={0 | 1}] [, ROWS{Get, Set}=integer] [, SAMPLES_PER_PIXEL{Get, Set}={1 | 3 | 4}] [, SOP_CLASS_UID{Get, Set}=string] [, SOP_INSTANCE_UID{Get, Set}=string] [, TRANSFER_SYNTAX{Get}=string]

IDLffDicomEx::AddGroup

Creates a group within a sequence.

Result = Obj->[IDLffDicomEx::]AddGroup (DicomTag [, PARENTSEQID=integer] )

IDLffDicomEx::AddPrivateGroup

Creates a group within a private sequence.

Result = Obj->[IDLffDicomEx::]AddPrivateGroup (PrivateCode, Group, Element [, PARENTSEQID=integer] )

IDLffDicomEx::AddPrivateSequence

Creates a new private sequence.

Result = Obj->[IDLffDicomEx::]AddPrivateSequence (PrivateCode, Group, Element [, PARENTSEQID=integer] )

IDLffDicomEx::AddSequence

Creates a new sequence.

Result = Obj->[IDLffDicomEx::]AddSequence (DicomTag [, PARENTSEQID=integer] )

IDLffDicomEx::ChangeTransferSyntax

Changes the transfer syntax of the IDLffDicomEx object and its associated pixel data. This allows you to change the compression setting of the pixel data and ensures that the transfer syntax value and pixel data are synchronized.

Obj->[IDLffDicomEx::]ChangeTransferSyntax, NewSyntaxUID [, /LOSSY]

IDLffDicomEx::Cleanup

Performs all cleanup on the object.

OBJ_DESTROY, Obj

or

Obj->[IDLffDicomEx::]Cleanup (Only in subclass' Cleanup method.)

IDLffDicomEx::Commit

Writes changes to the object to the underlying DICOM file.

Obj->[IDLffDicomEx::]Commit

IDLffDicomEx::CopyTags

Copies specified tags from the source object to the destination object beginning with the DICOM attribute tag specified by the start tag and copying up to the stop tag.

Obj->[IDLffDicomEx::]CopyTags, DestinationObject, Start_Tag, Stop_Tag

IDLffDicomEx::EnumerateTags

Returns an array of structures representing the contents of the DICOM file.

Result = Obj->[IDLffDicomEx::]EnumerateTags ( [, START_TAG=string] [, STOP_TAG=string] [, COUNT=variable] [, FILENAME=string] [, /QUIET] )

IDLffDicomEx::GetDescription

Returns the description associated with a standard, public DICOM attribute.

Result = Obj->[IDLffDICOM::]GetDescription( DicomTag )

IDLffDicomEx::GetPixelData

Returns pixel data from the DICOM image file.

Result = Obj->[IDLffDicomEx::] GetPixelData( [FRAME=integer] [, /ORDER] [, COUNT=variable])

IDLffDicomEx::GetPrivateValue

Returns the value of a private DICOM attribute.

Result = Obj->[IDLffDicomEx::]GetPrivateValue
(PrivateCode, Group, Element [, SEQID=integer] [, COUNT=variable] )

IDLffDicomEx::GetPrivateValueCount

Returns the number of values contained in the value field of a private DICOM attribute.

Result = Obj->[IDLffDicomEx::]GetPrivateValueCount
(PrivateCode, Group, Element [, SEQID=integer] )

IDLffDicomEx::GetPrivateValueLength

Returns the length of all values or of a specified value (in bytes) in a private DICOM attribute.

Result = Obj->[IDLffDicomEx::]GetPrivateValueLength
(PrivateCode, Group, Element [, SEQID=integer] [, VALUEINDEX=integer])

IDLffDicomEx::GetPrivateVR

Returns the value representation (VR) of a private DICOM attribute.

Result = Obj->[IDLffDicomEx::]GetPrivateVR
(PrivateCode, Group, Element [, SEQID=integer] )

IDLffDicomEx::GetProperty

Retrieves the value of an IDLffDicomEx property.

Obj->[IDLffDicomEx::]GetProperty
[, PROPERTY=variable]

IDLffDicomEx::GetValue

Returns the value of a DICOM attribute specified by a standard DICOM attribute tag.

Result = Obj->[IDLffDicomEx::]GetValue(DicomTag [, SEQID=integer] [, COUNT=variable] )

IDLffDicomEx::GetValueCount

Returns the number of values in a public DICOM attribute specified by a standard DICOM attribute tag.

Result = Obj->[IDLffDicomEx::]GetValueCount
(DicomTag [, SEQID=integer] )

IDLffDicomEx::GetValueLength

Returns the length of all values or of a specified value (in bytes) in a DICOM attribute specified by a standard DICOM attribute tag.

Result = Obj->[IDLffDicomEx::]GetValueLength
(DicomTag [, SEQID=integer] [, VALUEINDEX=integer])

IDLffDicomEx::GetVR

Returns the value representation (VR) of a DICOM attribute.

Result = Obj->[IDLffDicomEx::]GetVR(DicomTag [, SEQID=integer] )

IDLffDicomEx::Init

Initializes a IDLffDicomEx object. This method is called when the object is created via OBJ_NEW. The IDLffDicomEx object allows you to read and write DICOM files or create a new DICOM file based on keyword settings.

Obj = OBJ_NEW('IDLffDicomEx', FileName [, CLONE=string] [, /CREATE] [, SOP_CLASS=string] [, /NON_CONFORMING] )

or

Result = Obj->[IDLffDicomEx::]Init( FileName [, CLONE=string] [, /CREATE] [, SOP_CLASS=string] [, /NON_CONFORMING] ) (Only in a subclass' Init method.)

IDLffDicomEx::QueryPrivateValue

Checks a DICOM file for the presence of a specified private attribute. This method allows you to verify the presence of a tag prior to calling a method that requires a DICOM attribute to be present in order to succeed.

Result = Obj->[IDLffDicomEx::]QueryPrivateValue
(PrivateCode, Group, Element [, SEQID=integer] )

IDLffDicomEx::QueryValue

Checks a DICOM file for the presence of a specified attribute. This method allows you to verify the presence of a tag prior to calling a method that requires a DICOM attribute to be present in order to succeed.

Result = Obj->[IDLffDicomEx::]QueryValue(DicomTag [, SEQID=integer] )

IDLffDicomEx::SetPixelData

Writes pixel data to the DICOM image file.

Obj->[IDLffDicomEx::]SetPixelData, PixelData [, FRAME=integer] [, /ORDER] [, BITS_ALLOCATED=integer] [, COLUMNS=integer] [, NUMBER_OF_FRAMES=string] [, PHOTOMETRIC_INTERPRETATION= {MONOCHROME1 | MONOCHROME2 | PALETTECOLOR | RGB | HSV | CMYK}] [, PIXEL_REPRESENTATION={0 | 1}] [, PLANAR_CONFIGURATION={0 | 1}] [, ROWS=integer] [, SAMPLES_PER_PIXEL=
{1 | 3 | 4}]

IDLffDicomEx::SetPrivateValue

Allows you to add and alter private attributes including items contained in private sequences.

Obj->[IDLffDicomEx::]SetPrivateValue, PrivateCode, Group , Element, VR [, Value] [, SEQID=integer] [, /CLEAR] [, /REMOVE] [, /BLOCKREMOVE]

IDLffDicomEx::SetProperty

Specifies a property value.

Obj->[IDLffDicomEx::]SetProperty [, PROPERTY=value]

IDLffDicomEx::SetValue

Allows you to add and alter attributes including items contained in sequences.

Obj->[IDLffDicomEx::]SetValue, DicomTag [, VR] [, Value] [, SEQID=integer] [, /CLEAR] [, /REMOVE]

IDLffDicomExCfg object

This object allows you to set and retrieve the values of IDL DICOM Network Service configuration parameters.No superclasses. No subclasses. No properties.

IDLffDicomExCfg::Cleanup

Performs all cleanup on the object, including closing the associated configuration file.

OBJ_DESTROY, Obj

or

Obj->[IDLffDicomExCfg::]Cleanup()
(In a lifecycle method only.)

IDLffDicomExCfg::Commit

Commits changes made to the object and saves them to the underlying configuration file. Changes are not applied to the current configuration or saved in the configuration file until this method is called.

Obj->[IDLffDicomExCfg::]Commit

IDLffDicomExCfg::Echo

Lets you test the network connection to a remote machine that supports Query SCP or Storage SCP service types.

Result =
Obj->[IDLffDicomExCfg::]Echo(ApplicationEntityName [, COUNT=variable] )

IDLffDicomExCfg::GetApplicationEntities

Returns an array of structures containing the definitions of all the application entities defined or all the application entities of a specified service type.

Result =
Obj->[IDLffDicomExCfg::]GetApplicationEntities( [, COUNT=variable] [, /SERVICE_TYPE=string] )

IDLffDicomExCfg::GetApplicationEntity

Returns a structure containing the parameters for a specific Application Entity.

Result =
Obj->[IDLffDicomExCfg::]GetApplicationEntity(
ApplicatonEntityName)

IDLffDicomExCfg::GetServiceLists

Returns an array of strings containing the names of the service lists that can be assigned to an Application Entity.

Result = Obj->[IDLffDicomExCfg::]GetServcieLists( [, COUNT=variable] )

IDLffDicomExCfg::GetServiceTypes

Returns an array of strings containing the list of service types that can be assigned to an Application Entity.

Result = Obj->[IDLffDicomExCfg::]GetServiceTypes( [, COUNT=variable] )

IDLffDicomExCfg::GetValue

Returns the value for the specified parameter.

Result = Obj->[IDLffDicomExCfg::]GetValue(
ConfigurationParameterName)

IDLffDicomExCfg::Init

Initializes the IDLffDicomExCfg object. The IDLffDicomExCfg object allows you to set and retrieve the values of IDL DICOM Network Service configuration parameters.

Obj = OBJ_NEW('IDLffDicomExCfg' [, /SYSTEM])

or

Result = Obj->[IDLffDicomExCfg::]Init( [, /SYSTEM] )
(In a lifecycle method only.)

IDLffDicomExCfg::IsDirty

Is used to determine if configuration values have been changed since the configuration file was read into the configuration object.

Result = Obj->[IDLffDicomExCfg::]IsDirty( )

IDLffDicomExCfg::RemoveApplicationEntity

Marks a specified Application Entity for removal from the collection of application entities.

Obj->[IDLffDicomExCfg::]RemoveApplicationEntity(
ApplicationEntityName)

IDLffDicomExCfg::SetApplicationEntity

Defines a new Application Entity or modifies the definition of an existing Application Entity.

Obj->[IDLffDicomExCfg::]SetApplicationEntity, ApplicationEntityName, AET, Hostname, Port, ServiceListName, ServiceType

IDLffDicomExCfg::SetValue

Sets the value for the specified parameter.

Obj->[IDLffDicomExCfg::]SetValue, ConfigurationParameterName, Value

IDLffDicomExCfg::StorageScpService

Used to start, stop or check the status of the local IDL Storage SCP service.

Result = Obj->[IDLffDicomExCfg::]StorageScpService(
Command)

IDLffDicomExQuery object

This object allows you to query the contents of a remote DICOM node that has been configured to work with IDL's DICOM Network Service feature, and to retrieve DICOM files available on that node. No superclasses. No subclasses.

Properties:

[, ACCESSION_NUMBER{Get, Set}=string] [, CALLBACK_DATA{Get, Set}=any type] [, CALLBACK_FUNCTION{Get, Set}=string] [, FAMILY_NAME{Get, Set}=string] [, GIVEN_NAME{Get, Set}=string] [, INSTANCE_NUMBER{Get, Set}=string] [, MIDDLE_NAME{Get, Set}=string] [, MODALITY{Get, Set}=string]
[, PATIENT_ID{Get, Set}=string] [, PATIENT_NAME{Get, Set}=string]
[, PREFIX{Get, Set}=string]
[, QUERY_LEVEL{Get, Set}=integer] [, QUERY_MODEL{Get, Set}=integer] [, QUERY_SCP{Get, Set}=string] [, SERIES_INSTANCE_UID{Get, Set}=string] [, SERIES_NUMBER{Get, Set}=string] [, SOP_INSTANCE_UID{Get, Set}=string] [, STORAGE_SCP{Get, Set}=string] [, STUDY_DATE{Get, Set}=string]
[, STUDY_ID{Get, Set}=string] [, STUDY_INSTANCE_UID{Get, Set}=string] [, STUDY_TIME{Get, Set}=string]
[, SUFFIX{Get, Set}=string]

IDLffDicomExQuery::Cleanup

Performs all cleanup on the object.

OBJ_DESTROY, Obj

or

Obj->[IDLffDicomExQuery::]Cleanup( )
(In a lifecycle method only.)

IDLffDicomExQuery::ClearProperties

Used to reset the values of all properties of the IDLffDicomExQuery object to their default values.

Obj->[IDLffDicomExQuery::]ClearProperties

IDLffDicomExQuery::GetProperty

Retrieves the value of an IDLffDicomExQuery property.

Obj->[IDLffDicomExQuery::]GetProperty [, PROPERTY=variable]

IDLffDicomExQuery::Init

Initializes the IDLffDicomExQuery object. The IDLffDicomExQuery object allows you query or retrieve DICOM files from a remote node configured as a Query SCP available in IDL's DICOM Network Service configuration.

Obj = OBJ_NEW('IDLffDicomExQuery' )

or

Result = Obj->[IDLffDicomExQuery::]Init( )
(In a lifecycle method only.)

IDLffDicomExQuery::Query

Used to query a remote Query/Retrieve SCP Application Entity.

Result = Obj->[IDLffDicomExQuery::]Query( [, COUNT=variable] )

IDLffDicomExQuery::QueryModelsSupported

Used to determine what Query/Retrieve services are supported by Query/Retrieve SCP Application Entity defined by the QUERY_SCP property.

Result =
Obj->[IDLffDicomExQuery::]QueryModelsSupported( [, COUNT=variable] )

IDLffDicomExQuery::Retrieve

Moves a DICOM file or files from a source node to a destination node.

Result = Obj->[IDLffDicomExQuery::]Retrieve( [, COUNT=variable] [, PATIENT_ID=string] [, STUDY_INSTANCE_UID=string] [, SERIES_INSTANCE_UID=string] [, SOP_INSTANCE_UID=string] )

IDLffDicomExQuery::SetProperty

Sets the value of a property or group of properties for the IDLffDicomExQuery object.

Obj->[IDLffDicomExQuery::]SetProperty [, PROPERTY=value]

IDLffDicomExStorScu object

This object implements a local DICOM Storage SCU (Service Class User) that allows you to transmit files to a remote destination that is identified as a DICOM Storage SCP (Service Class Provider). No superclasses. No subclasses.

Properties:

[, CALLBACK_DATA{Get, Set}=any type] [, CALLBACK_FUNCTION{Get, Set}=string] [, STORAGE_SCP{Get, Set}=string]

IDLffDicomExStorScu::Cleanup

Performs all cleanup on the object.

OBJ_DESTROY, Obj

or

Obj->[IDLffDicomExStorScu::]Cleanup()
(In a lifecycle method only.)

IDLffDicomExStorScu::ClearProperty

Resets the values of all properties of the IDLffDicomExQuery object to their default values.

Obj->[IDLffDicomExStorScu::]ClearProperties

IDLffDicomExStorScu::GetProperty

Retrieves the value of an IDLffDicomExStorScu property.

Obj->[IDLffDicomExStorScu::]GetProperty [, PROPERTY=variable]

IDLffDicomExStorScu::Init

Initializes the IDLffDicomExStorScu object. The IDLffDicomExStorScu object implements a local DICOM Storage SCU that allows you to transmit files to a remote node that is configured as a DICOM Storage SCP available in IDL's DICOM Network Service configuration.

Obj = OBJ_NEW('IDLffDicomExStorScu')

or

Result = Obj->[IDLffDicomExStorScu::]Init( )
(In a lifecycle method only.)

IDLffDicomExStorScu::Send

Transfers DICOM files to a remote Storage SCP node.

Result = Obj->[IDLffDicomExStorScu::]Send(Files)

IDLffDicomExStorScu::SetProperty

Sets the value of a property or group of properties for the IDLffDicomExStorScu object.

Obj->[IDLffDicomExStorScu::]SetProperty [, PROPERTY=value]