@spec all() :: [t()]

Returns a sorted list of all 34 VR atoms.

Examples

iex> :PN in Dicom.VR.all()
true

iex> length(Dicom.VR.all())
34

@spec binary?(t()) :: boolean()

Returns true if the VR represents binary/pixel data.

@spec binary_vrs() :: [t()]

Returns the list of binary VR atoms.

@spec description(t()) :: String.t()

Returns the human-readable description for a VR per PS3.5 Table 6.2-1.

Examples

iex> Dicom.VR.description(:PN)
"Person Name"

iex> Dicom.VR.description(:DA)
"Date"

@spec fixed_length?(t()) :: boolean()

Returns true if the VR has a fixed byte length (AT, FL, FD, SL, SS, UL, US, SV, UV).

@spec from_binary(binary()) :: {:ok, t()} | {:error, :unknown_vr}

Parses a 2-byte VR string into an atom.

Examples

iex> Dicom.VR.from_binary("PN")
{:ok, :PN}

iex> Dicom.VR.from_binary("XX")
{:error, :unknown_vr}

@spec long_length?(t()) :: boolean()

Returns true if the VR uses explicit length encoding with a 4-byte length field (the "long" VRs that use 2 reserved bytes + 4-byte length in Explicit VR).

@spec max_length(t()) :: pos_integer() | :unlimited

Returns the maximum character/byte length for a VR, or :unlimited.

Examples

iex> Dicom.VR.max_length(:PN)
64

iex> Dicom.VR.max_length(:UT)
:unlimited

@spec numeric?(t()) :: boolean()

Returns true if the VR represents a numeric type.

@spec numeric_vrs() :: [t()]

Returns the list of numeric VR atoms.

@spec pad_value(binary(), t()) :: binary()

Pads a binary value to even length per DICOM requirements.

All DICOM value fields must have even length. If the value has odd length, a single padding byte is appended based on the VR.

@spec padding_byte(t()) :: byte()

Returns the padding byte for this VR.

Per PS3.5 Section 6.2: UI values are padded with NULL (0x00), other string VRs are padded with SPACE (0x20), and binary VRs are padded with 0x00.

@spec string?(t()) :: boolean()

Returns true if the VR represents a string type.

@spec string_vrs() :: [t()]

Returns the list of string VR atoms.

@spec to_binary(t()) :: binary()

Converts a VR atom to its 2-byte binary representation.