pydicom.uid.UID

class pydicom.uid.UID(val: str, validation_mode: int | None = None)[source]

Human friendly UIDs as a Python str subclass.

Private Transfer Syntaxes

If creating a private transfer syntax UID, then you must also use set_private_encoding() to set the corresponding dataset encoding.

Examples

General usage:

>>> from pydicom.uid import UID
>>> uid = UID('1.2.840.10008.1.2.4.50')
>>> uid
'1.2.840.10008.1.2.4.50'
>>> uid.is_implicit_VR
False
>>> uid.is_little_endian
True
>>> uid.is_transfer_syntax
True
>>> uid.name
'JPEG Baseline (Process 1)'
>>> uid.keyword
JPEGBaseline8Bit

Setting the encoding to explicit VR little endian for a private transfer syntax:

>>> uid = UID("1.2.3.4")
>>> uid.set_private_encoding(False, True)
__init__()

Methods

__init__()

capitalize()

Return a capitalized version of the string.

casefold()

Return a version of the string suitable for caseless comparisons.

center(width[, fillchar])

Return a centered string of length width.

count(sub[, start[, end]])

Return the number of non-overlapping occurrences of substring sub in string S[start:end].

encode([encoding, errors])

Encode the string using the codec registered for encoding.

endswith(suffix[, start[, end]])

Return True if S ends with the specified suffix, False otherwise.

expandtabs([tabsize])

Return a copy where all tab characters are expanded using spaces.

find(sub[, start[, end]])

Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end].

format(*args, **kwargs)

Return a formatted version of S, using substitutions from args and kwargs.

format_map(mapping)

Return a formatted version of S, using substitutions from mapping.

index(sub[, start[, end]])

Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end].

isalnum()

Return True if the string is an alpha-numeric string, False otherwise.

isalpha()

Return True if the string is an alphabetic string, False otherwise.

isascii()

Return True if all characters in the string are ASCII, False otherwise.

isdecimal()

Return True if the string is a decimal string, False otherwise.

isdigit()

Return True if the string is a digit string, False otherwise.

isidentifier()

Return True if the string is a valid Python identifier, False otherwise.

islower()

Return True if the string is a lowercase string, False otherwise.

isnumeric()

Return True if the string is a numeric string, False otherwise.

isprintable()

Return True if the string is printable, False otherwise.

isspace()

Return True if the string is a whitespace string, False otherwise.

istitle()

Return True if the string is a title-cased string, False otherwise.

isupper()

Return True if the string is an uppercase string, False otherwise.

join(iterable, /)

Concatenate any number of strings.

ljust(width[, fillchar])

Return a left-justified string of length width.

lower()

Return a copy of the string converted to lowercase.

lstrip([chars])

Return a copy of the string with leading whitespace removed.

maketrans

Return a translation table usable for str.translate().

partition(sep, /)

Partition the string into three parts using the given separator.

removeprefix(prefix, /)

Return a str with the given prefix string removed if present.

removesuffix(suffix, /)

Return a str with the given suffix string removed if present.

replace(old, new[, count])

Return a copy with all occurrences of substring old replaced by new.

rfind(sub[, start[, end]])

Return the highest index in S where substring sub is found, such that sub is contained within S[start:end].

rindex(sub[, start[, end]])

Return the highest index in S where substring sub is found, such that sub is contained within S[start:end].

rjust(width[, fillchar])

Return a right-justified string of length width.

rpartition(sep, /)

Partition the string into three parts using the given separator.

rsplit([sep, maxsplit])

Return a list of the substrings in the string, using sep as the separator string.

rstrip([chars])

Return a copy of the string with trailing whitespace removed.

set_private_encoding(implicit_vr, little_endian)

Set the corresponding dataset encoding for a privately defined transfer syntax.

split([sep, maxsplit])

Return a list of the substrings in the string, using sep as the separator string.

splitlines([keepends])

Return a list of the lines in the string, breaking at line boundaries.

startswith(prefix[, start[, end]])

Return True if S starts with the specified prefix, False otherwise.

strip([chars])

Return a copy of the string with leading and trailing whitespace removed.

swapcase()

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title()

Return a version of the string where each word is titlecased.

translate(table, /)

Replace each character in the string using the given translation table.

upper()

Return a copy of the string converted to uppercase.

zfill(width, /)

Pad a numeric string with zeros on the left, to fill a field of the given width.

Attributes

info

Return the UID info from the UID dictionary.

is_compressed

Return True if a compressed transfer syntax UID.

is_deflated

Return True if a deflated transfer syntax UID.

is_encapsulated

Return True if an encasulated transfer syntax UID.

is_implicit_VR

Return True if an implicit VR transfer syntax UID.

is_little_endian

Return True if a little endian transfer syntax UID.

is_private

Return True if the UID isn't an officially registered DICOM UID.

is_retired

Return True if the UID is retired, False otherwise or if private.

is_transfer_syntax

Return True if a transfer syntax UID.

is_valid

Return True if self is a valid UID, False otherwise.

keyword

Return the UID keyword from the UID dictionary.

name

Return the UID name from the UID dictionary.

type

Return the UID type from the UID dictionary.

property info: str

Return the UID info from the UID dictionary.

property is_compressed: bool

Return True if a compressed transfer syntax UID.

property is_deflated: bool

Return True if a deflated transfer syntax UID.

property is_encapsulated: bool

Return True if an encasulated transfer syntax UID.

property is_implicit_VR: bool

Return True if an implicit VR transfer syntax UID.

property is_little_endian: bool

Return True if a little endian transfer syntax UID.

property is_private: bool

Return True if the UID isn’t an officially registered DICOM UID.

property is_retired: bool

Return True if the UID is retired, False otherwise or if private.

property is_transfer_syntax: bool

Return True if a transfer syntax UID.

property is_valid: bool

Return True if self is a valid UID, False otherwise.

property keyword: str

Return the UID keyword from the UID dictionary.

property name: str

Return the UID name from the UID dictionary.

set_private_encoding(implicit_vr: bool, little_endian: bool) None[source]

Set the corresponding dataset encoding for a privately defined transfer syntax.

New in version 3.0.

Parameters:
  • implicit_vr (bool) – True if the corresponding dataset encoding uses implicit VR, False for explicit VR.

  • little_endian (bool) – True if the corresponding dataset encoding uses little endian byte order, False for big endian byte order.

property type: str

Return the UID type from the UID dictionary.