Class DicomTransferSyntax

Namespace

FellowOakDicom

Assembly

fo-dicom.core.dll

Representation of a DICOM transfer syntax.

public class DicomTransferSyntax : DicomParseable

Inheritance

object

DicomParseable

DicomTransferSyntax

Inherited Members

DicomParseable.Parse<T>(string)

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Extension Methods

LinqExtensions.IsOneOf<T>(T, params T[])

Fields

DeflatedExplicitVRLittleEndian

Deflated Explicit VR Little Endian

public static readonly DicomTransferSyntax DeflatedExplicitVRLittleEndian

Field Value

DicomTransferSyntax

ExplicitVRBigEndian

Explicit VR Big Endian

public static readonly DicomTransferSyntax ExplicitVRBigEndian

Field Value

DicomTransferSyntax

ExplicitVRLittleEndian

Explicit VR Little Endian

public static readonly DicomTransferSyntax ExplicitVRLittleEndian

Field Value

DicomTransferSyntax

FragmentableMPEG2

Fragmentable MPEG2 Main Profile @ Main Level

public static readonly DicomTransferSyntax FragmentableMPEG2

Field Value

DicomTransferSyntax

FragmentableMPEG2MainProfileHighLevel

Fragmentable MPEG2 Main Profile / High Level

public static readonly DicomTransferSyntax FragmentableMPEG2MainProfileHighLevel

Field Value

DicomTransferSyntax

FragmentableMPEG4AVCH264BDCompatibleHighProfileLevel41

Fragmentable MPEG-4 AVC/H.264 BD-compatible High Profile / Level 4.1

public static readonly DicomTransferSyntax FragmentableMPEG4AVCH264BDCompatibleHighProfileLevel41

Field Value

DicomTransferSyntax

FragmentableMPEG4AVCH264HighProfileLevel41

Fragmentable MPEG-4 AVC/H.264 High Profile / Level 4.1

public static readonly DicomTransferSyntax FragmentableMPEG4AVCH264HighProfileLevel41

Field Value

DicomTransferSyntax

FragmentableMPEG4AVCH264HighProfileLevel42For2DVideo

Fragmentable MPEG-4 AVC/H.264 High Profile / Level 4.2 For 2D Video

public static readonly DicomTransferSyntax FragmentableMPEG4AVCH264HighProfileLevel42For2DVideo

Field Value

DicomTransferSyntax

FragmentableMPEG4AVCH264HighProfileLevel42For3DVideo

Fragmentable MPEG-4 AVC/H.264 High Profile / Level 4.2 For 3D Video

public static readonly DicomTransferSyntax FragmentableMPEG4AVCH264HighProfileLevel42For3DVideo

Field Value

DicomTransferSyntax

FragmentableMPEG4AVCH264StereoHighProfileLevel42

Fragmentable MPEG-4 AVC/H.264 Stereo High Profile / Level 4.2

public static readonly DicomTransferSyntax FragmentableMPEG4AVCH264StereoHighProfileLevel42

Field Value

DicomTransferSyntax

GEPrivateImplicitVRBigEndian

GE Private Implicit VR Big Endian

public static readonly DicomTransferSyntax GEPrivateImplicitVRBigEndian

Field Value

DicomTransferSyntax

Remarks

Same as Implicit VR Little Endian except for big endian pixel data.

HEVCH265Main10ProfileLevel51

HEVC/H.265 Main 10 Profile / Level 5.1

public static readonly DicomTransferSyntax HEVCH265Main10ProfileLevel51

Field Value

DicomTransferSyntax

HEVCH265MainProfileLevel51

HEVC/H.265 Main Profile / Level 5.1

public static readonly DicomTransferSyntax HEVCH265MainProfileLevel51

Field Value

DicomTransferSyntax

HTJ2K

High-Throughput JPEG 2000 Image Compression

public static readonly DicomTransferSyntax HTJ2K

Field Value

DicomTransferSyntax

HTJ2KLossless

High-Throughput JPEG 2000 Image Compression (Lossless Only)

public static readonly DicomTransferSyntax HTJ2KLossless

Field Value

DicomTransferSyntax

HTJ2KLosslessRPCL

High-Throughput JPEG 2000 with RPCL Options Image Compression (Lossless Only)

public static readonly DicomTransferSyntax HTJ2KLosslessRPCL

Field Value

DicomTransferSyntax

ImplicitVRBigEndian

Virtual transfer syntax for reading datasets improperly encoded in Big Endian format with implicit VR.

public static readonly DicomTransferSyntax ImplicitVRBigEndian

Field Value

DicomTransferSyntax

ImplicitVRLittleEndian

Implicit VR Little Endian

public static readonly DicomTransferSyntax ImplicitVRLittleEndian

Field Value

DicomTransferSyntax

JPEG2000Lossless

JPEG 2000 Lossless Image Compression

public static readonly DicomTransferSyntax JPEG2000Lossless

Field Value

DicomTransferSyntax

JPEG2000Lossy

JPEG 2000 Lossy Image Compression

public static readonly DicomTransferSyntax JPEG2000Lossy

Field Value

DicomTransferSyntax

JPEG2000Part2MultiComponent

JPEG 2000 Part 2 Multi-component Image Compression

public static readonly DicomTransferSyntax JPEG2000Part2MultiComponent

Field Value

DicomTransferSyntax

JPEG2000Part2MultiComponentLosslessOnly

JPEG 2000 Part 2 Multi-component Image Compression (Lossless Only)

public static readonly DicomTransferSyntax JPEG2000Part2MultiComponentLosslessOnly

Field Value

DicomTransferSyntax

JPEGLSLossless

JPEG-LS Lossless Image Compression

public static readonly DicomTransferSyntax JPEGLSLossless

Field Value

DicomTransferSyntax

JPEGLSNearLossless

JPEG-LS Lossy (Near-Lossless) Image Compression

public static readonly DicomTransferSyntax JPEGLSNearLossless

Field Value

DicomTransferSyntax

JPEGProcess1

JPEG Baseline (Process 1)

public static readonly DicomTransferSyntax JPEGProcess1

Field Value

DicomTransferSyntax

JPEGProcess10_12Retired

JPEG Full Progression, Non-Hierarchical (Process 10 & 12) (Retired)

public static readonly DicomTransferSyntax JPEGProcess10_12Retired

Field Value

DicomTransferSyntax

JPEGProcess11_13Retired

JPEG Full Progression, Non-Hierarchical (Process 11 & 13) (Retired)

public static readonly DicomTransferSyntax JPEGProcess11_13Retired

Field Value

DicomTransferSyntax

JPEGProcess14

JPEG Lossless, Non-Hierarchical (Process 14)

public static readonly DicomTransferSyntax JPEGProcess14

Field Value

DicomTransferSyntax

JPEGProcess14SV1

JPEG Lossless, Non-Hierarchical, First-Order Prediction (Process 14 [Selection Value 1])

public static readonly DicomTransferSyntax JPEGProcess14SV1

Field Value

DicomTransferSyntax

JPEGProcess15Retired

JPEG Lossless, Non-Hierarchical (Process 15) (Retired)

public static readonly DicomTransferSyntax JPEGProcess15Retired

Field Value

DicomTransferSyntax

JPEGProcess16_18Retired

JPEG Extended, Hierarchical (Process 16 & 18) (Retired)

public static readonly DicomTransferSyntax JPEGProcess16_18Retired

Field Value

DicomTransferSyntax

JPEGProcess17_19Retired

JPEG Extended, Hierarchical (Process 17 & 19) (Retired)

public static readonly DicomTransferSyntax JPEGProcess17_19Retired

Field Value

DicomTransferSyntax

JPEGProcess20_22Retired

JPEG Spectral Selection, Hierarchical (Process 20 & 22) (Retired)

public static readonly DicomTransferSyntax JPEGProcess20_22Retired

Field Value

DicomTransferSyntax

JPEGProcess21_23Retired

JPEG Spectral Selection, Hierarchical (Process 21 & 23) (Retired)

public static readonly DicomTransferSyntax JPEGProcess21_23Retired

Field Value

DicomTransferSyntax

JPEGProcess24_26Retired

JPEG Full Progression, Hierarchical (Process 24 & 26) (Retired)

public static readonly DicomTransferSyntax JPEGProcess24_26Retired

Field Value

DicomTransferSyntax

JPEGProcess25_27Retired

JPEG Full Progression, Hierarchical (Process 25 & 27) (Retired)

public static readonly DicomTransferSyntax JPEGProcess25_27Retired

Field Value

DicomTransferSyntax

JPEGProcess28Retired

JPEG Lossless, Hierarchical (Process 28) (Retired)

public static readonly DicomTransferSyntax JPEGProcess28Retired

Field Value

DicomTransferSyntax

JPEGProcess29Retired

JPEG Lossless, Hierarchical (Process 29) (Retired)

public static readonly DicomTransferSyntax JPEGProcess29Retired

Field Value

DicomTransferSyntax

JPEGProcess2_4

JPEG Extended (Process 2 & 4)

public static readonly DicomTransferSyntax JPEGProcess2_4

Field Value

DicomTransferSyntax

JPEGProcess3_5Retired

JPEG Extended (Process 3 & 5) (Retired)

public static readonly DicomTransferSyntax JPEGProcess3_5Retired

Field Value

DicomTransferSyntax

JPEGProcess6_8Retired

JPEG Spectral Selection, Non-Hierarchical (Process 6 & 8) (Retired)

public static readonly DicomTransferSyntax JPEGProcess6_8Retired

Field Value

DicomTransferSyntax

JPEGProcess7_9Retired

JPEG Spectral Selection, Non-Hierarchical (Process 7 & 9) (Retired)

public static readonly DicomTransferSyntax JPEGProcess7_9Retired

Field Value

DicomTransferSyntax

JPIPHTJ2KReferenced

JPIP HTJ2K Referenced

public static readonly DicomTransferSyntax JPIPHTJ2KReferenced

Field Value

DicomTransferSyntax

JPIPHTJ2KReferencedDeflate

JPIP HTJ2K Referenced Deflate

public static readonly DicomTransferSyntax JPIPHTJ2KReferencedDeflate

Field Value

DicomTransferSyntax

JPIPReferenced

JPIP Referenced

public static readonly DicomTransferSyntax JPIPReferenced

Field Value

DicomTransferSyntax

JPIPReferencedDeflate

JPIP Referenced Deflate

public static readonly DicomTransferSyntax JPIPReferencedDeflate

Field Value

DicomTransferSyntax

MPEG2

MPEG2 Main Profile @ Main Level

public static readonly DicomTransferSyntax MPEG2

Field Value

DicomTransferSyntax

MPEG2MainProfileHighLevel

MPEG2 Main Profile / High Level

public static readonly DicomTransferSyntax MPEG2MainProfileHighLevel

Field Value

DicomTransferSyntax

MPEG4AVCH264BDCompatibleHighProfileLevel41

MPEG-4 AVC/H.264 BD-compatible High Profile / Level 4.1

public static readonly DicomTransferSyntax MPEG4AVCH264BDCompatibleHighProfileLevel41

Field Value

DicomTransferSyntax

MPEG4AVCH264HighProfileLevel41

MPEG-4 AVC/H.264 High Profile / Level 4.1

public static readonly DicomTransferSyntax MPEG4AVCH264HighProfileLevel41

Field Value

DicomTransferSyntax

MPEG4AVCH264HighProfileLevel42For2DVideo

MPEG-4 AVC/H.264 High Profile / Level 4.2 For 2D Video

public static readonly DicomTransferSyntax MPEG4AVCH264HighProfileLevel42For2DVideo

Field Value

DicomTransferSyntax

MPEG4AVCH264HighProfileLevel42For3DVideo

MPEG-4 AVC/H.264 High Profile / Level 4.2 For 3D Video

public static readonly DicomTransferSyntax MPEG4AVCH264HighProfileLevel42For3DVideo

Field Value

DicomTransferSyntax

MPEG4AVCH264StereoHighProfileLevel42

MPEG-4 AVC/H.264 Stereo High Profile / Level 4.2

public static readonly DicomTransferSyntax MPEG4AVCH264StereoHighProfileLevel42

Field Value

DicomTransferSyntax

Papyrus3ImplicitVRLittleEndianRetired

Papyrus 3 Implicit VR Little Endian (Retired)

public static readonly DicomTransferSyntax Papyrus3ImplicitVRLittleEndianRetired

Field Value

DicomTransferSyntax

RFC2557MIMEEncapsulation

RFC 2557 MIME encapsulation

public static readonly DicomTransferSyntax RFC2557MIMEEncapsulation

Field Value

DicomTransferSyntax

RLELossless

RLE Lossless

public static readonly DicomTransferSyntax RLELossless

Field Value

DicomTransferSyntax

XMLEncoding

XML Encoding

public static readonly DicomTransferSyntax XMLEncoding

Field Value

DicomTransferSyntax

Properties

Endian

Gets the endianness of the transfer syntax.

public Endian Endian { get; }

Property Value

Endian

IsDeflate

Gets whether or not the transfer syntax represents deflatable objects.

public bool IsDeflate { get; }

Property Value

bool

IsEncapsulated

Gets whether or not the transfer syntax data representation is encapsulated.

public bool IsEncapsulated { get; }

Property Value

bool

IsExplicitVR

Gets whether or not the Value Representation of the transfer syntax is explicit.

public bool IsExplicitVR { get; }

Property Value

bool

IsLossy

Gets whether or not the transfer syntax data representation is lossy.

public bool IsLossy { get; }

Property Value

bool

IsRetired

Gets whether or not the transfer syntax is declared retired.

public bool IsRetired { get; }

Property Value

bool

KnownEntries

public static IEnumerable<DicomTransferSyntax> KnownEntries { get; }

Property Value

IEnumerable<DicomTransferSyntax>

LossyCompressionMethod

Gets the lossy compression method identifier.

public string LossyCompressionMethod { get; }

Property Value

string

SwapPixelData

Gets whether or not the pixel data requires swapping.

public bool SwapPixelData { get; }

Property Value

bool

UID

Gets the unique identifier of the transfer syntax.

public DicomUID UID { get; }

Property Value

DicomUID

Methods

Equals(object)

public override bool Equals(object obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

Lookup(DicomUID)

Get transfer syntax (pre-defined or built on-the-fly) for the specified uid.

public static DicomTransferSyntax Lookup(DicomUID uid)

Parameters

uid DicomUID

Transfer syntax UID.

Returns

DicomTransferSyntax

Transfer syntax object, either pre-defined or built on-the-fly.

Remarks

If transfer syntax object is built on-the-fly, value representation is set to Explicit, encapsulation is set to

true

and endianness is set to Little Endian.

Exceptions

DicomDataException

Thrown in the specified UID is not a transfer syntax type.

Parse(string)

Get the transfer syntax from the specified uid string.

public static DicomTransferSyntax Parse(string uid)

Parameters

uid string

String representing transfer syntax UID.

Returns

DicomTransferSyntax

DicomTransferSyntax object corresponding to uid.

Remarks

Parse(string) is a wrapper around Lookup(DicomUID) for string based uid.

Query(DicomUID)

Query DicomTransferSyntax by UID. returns null if not found.

public static DicomTransferSyntax Query(DicomUID uid)

Parameters

uid DicomUID

Returns

DicomTransferSyntax

Register(DicomUID)

register transfer syntax into internal dictionary, assuming Little Endian and Explicit VR.

public static DicomTransferSyntax Register(DicomUID uid)

Parameters

uid DicomUID

Returns

DicomTransferSyntax

Register(DicomUID, Endian, bool, bool)

register transfer syntax into internal dictionary.

public static DicomTransferSyntax Register(DicomUID uid, Endian endian, bool isExplicitVR = true, bool isEncapsulated = true)

Parameters

uid DicomUID

endian Endian

isExplicitVR bool

isEncapsulated bool

Returns

DicomTransferSyntax

ToString()

public override string ToString()

Returns

string

Unregister(DicomTransferSyntax)

unregister transfer syntax from internal dictionary.

public static bool Unregister(DicomTransferSyntax ts)

Parameters

ts DicomTransferSyntax

Returns

bool

Unregister(DicomUID)

unregister transfer syntax from internal dictionary.

public static bool Unregister(DicomUID uid)

Parameters

uid DicomUID

Returns

bool

Operators

operator ==(DicomTransferSyntax, DicomTransferSyntax)

Equivalence operator for DicomTransferSyntax objects.

public static bool operator ==(DicomTransferSyntax a, DicomTransferSyntax b)

Parameters

a DicomTransferSyntax

Left-hand side DicomTransferSyntax to check for equivalence.

b DicomTransferSyntax

Right-hand side DicomTransferSyntax to check for equivalence.

Returns

bool

true if UID of DicomTransferSyntax objects are equivalent or if both objects are

null

, false otherwise.

operator !=(DicomTransferSyntax, DicomTransferSyntax)

Non-equivalence operator for DicomTransferSyntax objects.

public static bool operator !=(DicomTransferSyntax a, DicomTransferSyntax b)

Parameters

a DicomTransferSyntax

Left-hand side DicomTransferSyntax to check for non-eequivalence.

b DicomTransferSyntax

Right-hand side DicomTransferSyntax to check for non-equivalence.

Returns

bool

true if UID of DicomTransferSyntax objects are non-equivalent or exactly one of the objects are

null

, false otherwise.