DICOM Index¶
This index lists all DICOM related objects and methods.
Note
The message and source object methods listed in this file can be used with DICOM Message Model messages only. In addition to the methods listed here, all methods listed in the Source and Message indexes also apply to DICOM Message Model messages.
message vs source objects:
Many methods exist in both the message and source objects.
- Use
source.*when:- You need to read values from the original incoming message.
- You want to reference the message before any mapping changes.
- Use
message.*when:- You want to read or modify the current working message.
- You are transforming the message during mapping.
- Important: changes made using
message.*do not modify the originalsourcemessage.
Index (signatures)¶
message methods¶
message.changeTransferSyntax(transferSyntax)message.getCalledAET()message.getDICOMBytes(nodePath, instance*)message.getDICOMBytesForFile()message.getDICOMDoubles(nodePath, instance*)message.getDICOMDoublesAsArray(nodePath, instance*)message.getDICOMFloats(nodePath, instance*)message.getDICOMFloatsAsArray(nodePath, instance*)message.getDICOMGroup(group)message.getDICOMGroupSize(group)message.getDICOMPreamble()message.getDICOMSequence(nodePath, instance*)message.getDICOMSignedLongs(nodePath, instance*)message.getDICOMSignedLongsAsArray(nodePath, instance*)message.getDICOMSignedShorts(nodePath, instance*)message.getDICOMSignedShortsAsArray(nodePath, instance*)message.getDICOMStrings(nodePath, instance*)message.getDICOMStringsAsArray(nodePath, instance*)message.getDICOMUnsignedLongs(nodePath, instance*)message.getDICOMUnsignedLongsAsArray(nodePath, instance*)message.getDICOMUnsignedShorts(nodePath, instance*)message.getDICOMUnsignedShortsAsArray(nodePath, instance*)message.getRemoteAET()message.hasDICOMGroup(group)message.mergeDICOM(otherDICOM)message.removeDICOMGroup(group)message.setDICOMBytes(nodePath, value, instance*, forceNode*)message.setDICOMDoubles(nodePath, value, instance*, forceNode*)message.setDICOMFloats(nodePath, value, instance*, forceNode*)message.setDICOMPreamble(bytes)message.setDICOMPrivateDataContent(nodePath, vrName, value, instance*, forceNode*)message.setDICOMSequence(nodePath, value, instance*, forceNode*)message.setDICOMSignedLongs(nodePath, value, instance*, forceNode*)message.setDICOMSignedShorts(nodePath, value, instance*, forceNode*)message.setDICOMStrings(nodePath, value, instance*, forceNode*)message.setDICOMUnsignedLongs(nodePath, value, instance*, forceNode*)message.setDICOMUnsignedShorts(nodePath, value, instance*, forceNode*)message.writeDICOMToFile(filePath)
qie methods¶
qie.convertDICOMPixelDataToJpeg(message)qie.convertDICOMtoJSON(message)qie.convertDICOMtoXML(message)qie.convertToDICOM(input, encoding*)qie.createCEchoRQCommand(sopClass)qie.createCFindRQCommand(sopClass, priority)qie.createCGetRQCommand(sopClass, priority)qie.createCMoveRQCommand(sopClass, priority, destinationAET)qie.createCStoreRQCommand(sopClass, sopInstance, priority, request*)qie.createDICOMFromImage(imageData, mimeType*)qie.createDICOMRequest(sopClass, command, destinationAET*, priority, sopInstance*)qie.createDICOMResponseFromRequest(request, status)qie.generateDICOMInstanceUID()qie.getDICOMConnectionNames()qie.getDICOMTransferSyntaxes(abstractSyntax)qie.getResponseToDICOMRequest(token)qie.parseDICOMBytes(bytes)qie.parseDICOMFile(file, includePixelData*)qie.parseDICOMString(input*)qie.postDICOMRequest(request, connection*, channel*, callingAET*)qie.postDICOMResponse(response, timeout*, returnError*)
source methods¶
source.getCalledAET()source.getDICOMBytes(nodePath, instance*)source.getDICOMDoubles(nodePath, instance*)source.getDICOMDoublesAsArray(nodePath, instance*)source.getDICOMFloats(nodePath, instance*)source.getDICOMFloatsAsArray(nodePath, instance*)source.getDICOMGroup(group)source.getDICOMGroupSize(group)source.getDICOMPreamble()source.getDICOMSequence(nodePath, instance*)source.getDICOMSignedLongs(nodePath, instance*)source.getDICOMSignedLongsAsArray(nodePath, instance*)source.getDICOMSignedShorts(nodePath, instance*)source.getDICOMSignedShortsAsArray(nodePath, instance*)source.getDICOMStrings(nodePath, instance*)source.getDICOMStringsAsArray(nodePath, instance*)source.getDICOMUnsignedLongs(nodePath, instance*)source.getDICOMUnsignedLongsAsArray(nodePath, instance*)source.getDICOMUnsignedShorts(nodePath, instance*)source.getDICOMUnsignedShortsAsArray(nodePath, instance*)source.getRemoteAET()source.hasDICOMGroup(group)source.writeDICOMToFile(filePath)