pydicom.tag.BaseTag

class pydicom.tag.BaseTag[source]

Represents a DICOM element (group, element) tag.

Tags are represented as an int.

__init__()

Methods

__init__()

as_integer_ratio()

Return integer ratio.

bit_count()

Number of ones in the binary representation of the absolute value of self.

bit_length()

Number of bits necessary to represent self in binary.

conjugate

Returns self, the complex conjugate of any int.

from_bytes(byteorder, *[, signed])

Return the integer represented by the given array of bytes.

to_bytes(length, byteorder, *[, signed])

Return an array of bytes representing an integer.

Attributes

denominator

the denominator of a rational number in lowest terms

elem

Return the tag's element number as int.

element

Return the tag's element number as int.

group

Return the tag's group number as int.

imag

the imaginary part of a complex number

is_private

Return True if the tag is private (has an odd group number).

is_private_creator

Return True if the tag is a private creator.

json_key

Return the tag value as a JSON key string 'GGGGEEEE'.

numerator

the numerator of a rational number in lowest terms

private_creator

Return the private creator tag for the given tag.

real

the real part of a complex number

as_integer_ratio()

Return integer ratio.

Return a pair of integers, whose ratio is exactly equal to the original int and with a positive denominator.

>>> (10).as_integer_ratio()
(10, 1)
>>> (-10).as_integer_ratio()
(-10, 1)
>>> (0).as_integer_ratio()
(0, 1)
bit_count()

Number of ones in the binary representation of the absolute value of self.

Also known as the population count.

>>> bin(13)
'0b1101'
>>> (13).bit_count()
3
bit_length()

Number of bits necessary to represent self in binary.

>>> bin(37)
'0b100101'
>>> (37).bit_length()
6
conjugate()

Returns self, the complex conjugate of any int.

denominator

the denominator of a rational number in lowest terms

property elem: int

Return the tag’s element number as int.

property element: int

Return the tag’s element number as int.

from_bytes(byteorder, *, signed=False)

Return the integer represented by the given array of bytes.

bytes

Holds the array of bytes to convert. The argument must either support the buffer protocol or be an iterable object producing bytes. Bytes and bytearray are examples of built-in objects that support the buffer protocol.

byteorder

The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.

signed

Indicates whether two’s complement is used to represent the integer.

property group: int

Return the tag’s group number as int.

imag

the imaginary part of a complex number

property is_private: bool

Return True if the tag is private (has an odd group number).

property is_private_creator: bool

Return True if the tag is a private creator.

property json_key: str

Return the tag value as a JSON key string ‘GGGGEEEE’.

numerator

the numerator of a rational number in lowest terms

property private_creator: BaseTag

Return the private creator tag for the given tag. The result is meaningless if this is not a private tag.

Added in version 2.4.

real

the real part of a complex number

to_bytes(length, byteorder, *, signed=False)

Return an array of bytes representing an integer.

length

Length of bytes object to use. An OverflowError is raised if the integer is not representable with the given number of bytes.

byteorder

The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.

signed

Determines whether two’s complement is used to represent the integer. If signed is False and a negative integer is given, an OverflowError is raised.