pydicom.uid.UID

class pydicom.uid.UID

Human friendly UIDs as a Python str subclass.

Examples

>>> 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)'
__init__()

Initialize self. See help(type(self)) for accurate signature.

Methods

capitalize Return a capitalized version of the string.
casefold Return a version of the string suitable for caseless comparisons.
center 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 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 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 Concatenate any number of strings.
ljust Return a left-justified string of length width.
lower Return a copy of the string converted to lowercase.
lstrip Return a copy of the string with leading whitespace removed.
maketrans Return a translation table usable for str.translate().
partition Partition the string into three parts using the given separator.
replace 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 Return a right-justified string of length width.
rpartition Partition the string into three parts using the given separator.
rsplit Return a list of the words in the string, using sep as the delimiter string.
rstrip Return a copy of the string with trailing whitespace removed.
split Return a list of the words in the string, using sep as the delimiter string.
splitlines 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 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 Replace each character in the string using the given translation table.
upper Return a copy of the string converted to uppercase.
zfill 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.
name Return the UID name from the UID dictionary.
type Return the UID type from the UID dictionary.
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.

name

Return the UID name from the UID dictionary.

type

Return the UID type from the UID dictionary.