Class DicomTransferSyntax

Representation of a DICOM transfer syntax.

Inheritance

Object

DicomParseable

DicomTransferSyntax

Inherited Members

DicomParseable.Parse<T>(String)

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetType()

Object.MemberwiseClone()

Namespace: Dicom

Assembly: cs.temp.dll.dll

Syntax

public class DicomTransferSyntax : DicomParseable

Fields

DeflatedExplicitVRLittleEndian

Deflated Explicit VR Little Endian

Declaration

public static readonly DicomTransferSyntax DeflatedExplicitVRLittleEndian

Field Value

Type	Description
DicomTransferSyntax

ExplicitVRBigEndian

Explicit VR Big Endian

Declaration

public static readonly DicomTransferSyntax ExplicitVRBigEndian

Field Value

Type	Description
DicomTransferSyntax

ExplicitVRLittleEndian

Explicit VR Little Endian

Declaration

public static readonly DicomTransferSyntax ExplicitVRLittleEndian

Field Value

Type	Description
DicomTransferSyntax

GEPrivateImplicitVRBigEndian

GE Private Implicit VR Big Endian

Declaration

public static readonly DicomTransferSyntax GEPrivateImplicitVRBigEndian

Field Value

Type	Description
DicomTransferSyntax

Remarks

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

HEVCH265Main10ProfileLevel51

HEVC/H.265 Main 10 Profile / Level 5.1

Declaration

public static readonly DicomTransferSyntax HEVCH265Main10ProfileLevel51

Field Value

Type	Description
DicomTransferSyntax

HEVCH265MainProfileLevel51

HEVC/H.265 Main Profile / Level 5.1

Declaration

public static readonly DicomTransferSyntax HEVCH265MainProfileLevel51

Field Value

Type	Description
DicomTransferSyntax

ImplicitVRBigEndian

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

Declaration

public static readonly DicomTransferSyntax ImplicitVRBigEndian

Field Value

Type	Description
DicomTransferSyntax

ImplicitVRLittleEndian

Implicit VR Little Endian

Declaration

public static readonly DicomTransferSyntax ImplicitVRLittleEndian

Field Value

Type	Description
DicomTransferSyntax

JPEG2000Lossless

JPEG 2000 Lossless Image Compression

Declaration

public static readonly DicomTransferSyntax JPEG2000Lossless

Field Value

Type	Description
DicomTransferSyntax

JPEG2000Lossy

JPEG 2000 Lossy Image Compression

Declaration

public static readonly DicomTransferSyntax JPEG2000Lossy

Field Value

Type	Description
DicomTransferSyntax

JPEG2000Part2MultiComponent

JPEG 2000 Part 2 Multi-component Image Compression

Declaration

public static readonly DicomTransferSyntax JPEG2000Part2MultiComponent

Field Value

Type	Description
DicomTransferSyntax

JPEG2000Part2MultiComponentLosslessOnly

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

Declaration

public static readonly DicomTransferSyntax JPEG2000Part2MultiComponentLosslessOnly

Field Value

Type	Description
DicomTransferSyntax

JPEGLSLossless

JPEG-LS Lossless Image Compression

Declaration

public static readonly DicomTransferSyntax JPEGLSLossless

Field Value

Type	Description
DicomTransferSyntax

JPEGLSNearLossless

JPEG-LS Lossy (Near-Lossless) Image Compression

Declaration

public static readonly DicomTransferSyntax JPEGLSNearLossless

Field Value

Type	Description
DicomTransferSyntax

JPEGProcess1

JPEG Baseline (Process 1)

Declaration

public static readonly DicomTransferSyntax JPEGProcess1

Field Value

Type	Description
DicomTransferSyntax

JPEGProcess10_12Retired

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

Declaration

public static readonly DicomTransferSyntax JPEGProcess10_12Retired

Field Value

Type	Description
DicomTransferSyntax

JPEGProcess11_13Retired

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

Declaration

public static readonly DicomTransferSyntax JPEGProcess11_13Retired

Field Value

Type	Description
DicomTransferSyntax

JPEGProcess14

JPEG Lossless, Non-Hierarchical (Process 14)

Declaration

public static readonly DicomTransferSyntax JPEGProcess14

Field Value

Type	Description
DicomTransferSyntax

JPEGProcess14SV1

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

Declaration

public static readonly DicomTransferSyntax JPEGProcess14SV1

Field Value

Type	Description
DicomTransferSyntax

JPEGProcess15Retired

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

Declaration

public static readonly DicomTransferSyntax JPEGProcess15Retired

Field Value

Type	Description
DicomTransferSyntax

JPEGProcess16_18Retired

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

Declaration

public static readonly DicomTransferSyntax JPEGProcess16_18Retired

Field Value

Type	Description
DicomTransferSyntax

JPEGProcess17_19Retired

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

Declaration

public static readonly DicomTransferSyntax JPEGProcess17_19Retired

Field Value

Type	Description
DicomTransferSyntax

JPEGProcess2_4

JPEG Extended (Process 2 & 4)

Declaration

public static readonly DicomTransferSyntax JPEGProcess2_4

Field Value

Type	Description
DicomTransferSyntax

JPEGProcess20_22Retired

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

Declaration

public static readonly DicomTransferSyntax JPEGProcess20_22Retired

Field Value

Type	Description
DicomTransferSyntax

JPEGProcess21_23Retired

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

Declaration

public static readonly DicomTransferSyntax JPEGProcess21_23Retired

Field Value

Type	Description
DicomTransferSyntax

JPEGProcess24_26Retired

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

Declaration

public static readonly DicomTransferSyntax JPEGProcess24_26Retired

Field Value

Type	Description
DicomTransferSyntax

JPEGProcess25_27Retired

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

Declaration

public static readonly DicomTransferSyntax JPEGProcess25_27Retired

Field Value

Type	Description
DicomTransferSyntax

JPEGProcess28Retired

JPEG Lossless, Hierarchical (Process 28) (Retired)

Declaration

public static readonly DicomTransferSyntax JPEGProcess28Retired

Field Value

Type	Description
DicomTransferSyntax

JPEGProcess29Retired

JPEG Lossless, Hierarchical (Process 29) (Retired)

Declaration

public static readonly DicomTransferSyntax JPEGProcess29Retired

Field Value

Type	Description
DicomTransferSyntax

JPEGProcess3_5Retired

JPEG Extended (Process 3 & 5) (Retired)

Declaration

public static readonly DicomTransferSyntax JPEGProcess3_5Retired

Field Value

Type	Description
DicomTransferSyntax

JPEGProcess6_8Retired

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

Declaration

public static readonly DicomTransferSyntax JPEGProcess6_8Retired

Field Value

Type	Description
DicomTransferSyntax

JPEGProcess7_9Retired

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

Declaration

public static readonly DicomTransferSyntax JPEGProcess7_9Retired

Field Value

Type	Description
DicomTransferSyntax

JPIPReferenced

JPIP Referenced

Declaration

public static readonly DicomTransferSyntax JPIPReferenced

Field Value

Type	Description
DicomTransferSyntax

JPIPReferencedDeflate

JPIP Referenced Deflate

Declaration

public static readonly DicomTransferSyntax JPIPReferencedDeflate

Field Value

Type	Description
DicomTransferSyntax

MPEG2

MPEG2 Main Profile @ Main Level

Declaration

public static readonly DicomTransferSyntax MPEG2

Field Value

Type	Description
DicomTransferSyntax

MPEG2MainProfileHighLevel

MPEG2 Main Profile / High Level

Declaration

public static readonly DicomTransferSyntax MPEG2MainProfileHighLevel

Field Value

Type	Description
DicomTransferSyntax

MPEG4AVCH264BDCompatibleHighProfileLevel41

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

Declaration

public static readonly DicomTransferSyntax MPEG4AVCH264BDCompatibleHighProfileLevel41

Field Value

Type	Description
DicomTransferSyntax

MPEG4AVCH264HighProfileLevel41

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

Declaration

public static readonly DicomTransferSyntax MPEG4AVCH264HighProfileLevel41

Field Value

Type	Description
DicomTransferSyntax

MPEG4AVCH264HighProfileLevel42For2DVideo

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

Declaration

public static readonly DicomTransferSyntax MPEG4AVCH264HighProfileLevel42For2DVideo

Field Value

Type	Description
DicomTransferSyntax

MPEG4AVCH264HighProfileLevel42For3DVideo

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

Declaration

public static readonly DicomTransferSyntax MPEG4AVCH264HighProfileLevel42For3DVideo

Field Value

Type	Description
DicomTransferSyntax

MPEG4AVCH264StereoHighProfileLevel42

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

Declaration

public static readonly DicomTransferSyntax MPEG4AVCH264StereoHighProfileLevel42

Field Value

Type	Description
DicomTransferSyntax

Papyrus3ImplicitVRLittleEndianRetired

Papyrus 3 Implicit VR Little Endian (Retired)

Declaration

public static readonly DicomTransferSyntax Papyrus3ImplicitVRLittleEndianRetired

Field Value

Type	Description
DicomTransferSyntax

RFC2557MIMEEncapsulation

RFC 2557 MIME encapsulation

Declaration

public static readonly DicomTransferSyntax RFC2557MIMEEncapsulation

Field Value

Type	Description
DicomTransferSyntax

RLELossless

RLE Lossless

Declaration

public static readonly DicomTransferSyntax RLELossless

Field Value

Type	Description
DicomTransferSyntax

XMLEncoding

XML Encoding

Declaration

public static readonly DicomTransferSyntax XMLEncoding

Field Value

Type	Description
DicomTransferSyntax

Properties

Endian

Gets the endianness of the transfer syntax.

Declaration

public Endian Endian { get; }

Property Value

Type	Description
Endian

IsDeflate

Gets whether or not the transfer syntax represents deflatable objects.

Declaration

public bool IsDeflate { get; }

Property Value

Type	Description
Boolean

IsEncapsulated

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

Declaration

public bool IsEncapsulated { get; }

Property Value

Type	Description
Boolean

IsExplicitVR

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

Declaration

public bool IsExplicitVR { get; }

Property Value

Type	Description
Boolean

IsLossy

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

Declaration

public bool IsLossy { get; }

Property Value

Type	Description
Boolean

IsRetired

Gets whether or not the transfer syntax is declared retired.

Declaration

public bool IsRetired { get; }

Property Value

Type	Description
Boolean

LossyCompressionMethod

Gets the lossy compression method identifier.

Declaration

public string LossyCompressionMethod { get; }

Property Value

Type	Description
String

SwapPixelData

Gets whether or not the pixel data requires swapping.

Declaration

public bool SwapPixelData { get; }

Property Value

Type	Description
Boolean

UID

Gets the unique identifier of the transfer syntax.

Declaration

public DicomUID UID { get; }

Property Value

Type	Description
DicomUID

Methods

Equals(Object)

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
Object	obj

Returns

Type	Description
Boolean

Overrides

Object.Equals(Object)

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
Int32

Overrides

Object.GetHashCode()

Lookup(DicomUID)

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

Declaration

public static DicomTransferSyntax Lookup(DicomUID uid)

Parameters

Type	Name	Description
DicomUID	uid	Transfer syntax UID.

Returns

Type	Description
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.

Exceptions

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

Parse(String)

Get the transfer syntax from the specified uid string.

Declaration

public static DicomTransferSyntax Parse(string uid)

Parameters

Type	Name	Description
String	uid	String representing transfer syntax UID.

Returns

Type	Description
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.

Declaration

public static DicomTransferSyntax Query(DicomUID uid)

Parameters

Type	Name	Description
DicomUID	uid

Returns

Type	Description
DicomTransferSyntax

Register(DicomUID)

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

Declaration

public static DicomTransferSyntax Register(DicomUID uid)

Parameters

Type	Name	Description
DicomUID	uid

Returns

Type	Description
DicomTransferSyntax

Register(DicomUID, Endian, Boolean, Boolean)

register transfer syntax into internal dictionary.

Declaration

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

Parameters

Type	Name	Description
DicomUID	uid
Endian	endian
Boolean	isExplicitVR
Boolean	isEncapsulated

Returns

Type	Description
DicomTransferSyntax

ToString()

Declaration

public override string ToString()

Returns

Type	Description
String

Overrides

Object.ToString()

Unregister(DicomTransferSyntax)

unregister transfer syntax from internal dictionary.

Declaration

public static bool Unregister(DicomTransferSyntax ts)

Parameters

Type	Name	Description
DicomTransferSyntax	ts

Returns

Type	Description
Boolean

Unregister(DicomUID)

unregister transfer syntax from internal dictionary.

Declaration

public static bool Unregister(DicomUID uid)

Parameters

Type	Name	Description
DicomUID	uid

Returns

Type	Description
Boolean

Operators

Equality(DicomTransferSyntax, DicomTransferSyntax)

Equivalence operator for DicomTransferSyntax objects.

Declaration

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

Parameters

Type	Name	Description
DicomTransferSyntax	a	Left-hand side DicomTransferSyntax to check for equivalence.
DicomTransferSyntax	b	Right-hand side DicomTransferSyntax to check for equivalence.

Returns

Type	Description
Boolean	true if UID of DicomTransferSyntax objects are equivalent or if both objects are null , false otherwise.

Inequality(DicomTransferSyntax, DicomTransferSyntax)

Non-equivalence operator for DicomTransferSyntax objects.

Declaration

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

Parameters

Type	Name	Description
DicomTransferSyntax	a	Left-hand side DicomTransferSyntax to check for non-eequivalence.
DicomTransferSyntax	b	Right-hand side DicomTransferSyntax to check for non-equivalence.

Returns

Type	Description
Boolean	true if UID of DicomTransferSyntax objects are non-equivalent or exactly one of the objects are null , false otherwise.