images.dicom.decodeUID

Get information about DICOM unique identifier

Syntax

details = images.dicom.decodeUID(uid)

Description

details = images.dicom.decodeUID(uid) returns information about the DICOM unique identifier contained in uid. details contains the name and type of the UID. If uid corresponds to a transfer syntax, then details also contains the endianness and the DICOM value representation (VR) necessary for reading the image pixels, and information about compression.

The images.dicom.decodeUID function can interpret IDs defined in the PS 3.6-1999 specification, with some additions from PS 3.6-2009.

Examples

Decode DICOM UID

Read metadata from a DICOM file and extract a UID field.

info = dicominfo("CT-MONO2-16-ankle.dcm");
uid = info.SOPClassUID;

Decode the UID.

uid_info = images.dicom.decodeUID(uid)

uid_info = struct with fields:
    Value: '1.2.840.10008.5.1.4.1.1.7'
     Name: 'Secondary Capture Image Storage'
     Type: 'SOP Class'

Input Arguments

uid — DICOM unique identifier

character vector | string scalar

DICOM unique identifier, specified as a string or character vector.

Example: "1.2.840.10008.5.1.4.1.1.7"

Data Types: char | string

Output Arguments

details — Information from UID

structure

Information from UID, returned as a structure with these fields:

Field	Description
Value	Value of the UID, returned as a character vector. If uid is not a valid UID, then the value of this field is an empty character vector, ''.
Name	Name of the UID, returned as a character vector.
Type	Type of the UID, returned as a character vector.

For transfer syntaxes, the structure contains these additional fields:

Field	Description
Compressed	Compression, returned as a logical true or false.
Endian	Endianness, returned as 'ieee-be' or 'ieee-le'.
PixelEndian	Pixel endianness, returned as 'ieee-be' or 'ieee-le'.
VR	Value representation (VR), returned as 'Implicit' or 'Explicit'.
LossyCompression	Compression type is lossy, returned as a logical true or false.
CompressionType	Compression type, returned as a character vector.

Extended Capabilities

Thread-Based Environment

Run code in the background using MATLAB® backgroundPool or accelerate code with Parallel Computing Toolbox™ ThreadPool.

This function fully supports thread-based environments. For more information, see Run MATLAB Functions in Thread-Based Environment.

Version History

Introduced in R2017b

R2024b: Support for thread-based environments

images.dicom.decodeUID now supports thread-based environments.