Class DicomOverlayData

DICOM image overlay class

Inheritance

Object

DicomOverlayData

Inherited Members

Object.ToString()

Object.Equals(Object)

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Namespace: Dicom.Imaging

Assembly: cs.temp.dll.dll

Syntax

public class DicomOverlayData

Constructors

DicomOverlayData(DicomDataset, UInt16)

Initializes overlay from DICOM dataset and overlay group.

Declaration

public DicomOverlayData(DicomDataset ds, ushort group)

Parameters

Type	Name	Description
DicomDataset	ds	Dataset
UInt16	group	Overlay group

Exceptions

Type	Condition
DicomImagingException	Thrown if the overlay data is insufficient.

Properties

BitPosition

Gets or sets the bit position of embedded overlay.

Declaration

public int BitPosition { get; set; }

Property Value

Type	Description
Int32

BitsAllocated

Gets or sets the number of bits allocated in overlay data.

Declaration

public int BitsAllocated { get; set; }

Property Value

Type	Description
Int32

Columns

Gets or sets the number of columns in overlay.

Declaration

public int Columns { get; set; }

Property Value

Type	Description
Int32

Data

Gets or sets the overlay data.

Declaration

public IByteBuffer Data { get; set; }

Property Value

Type	Description
IByteBuffer

Dataset

Gets the DICOM Dataset containing the overlay data.

Declaration

public DicomDataset Dataset { get; }

Property Value

Type	Description
DicomDataset

Description

Gets or sets the description of the overlay.

Declaration

public string Description { get; set; }

Property Value

Type	Description
String

Group

Get the overlay group number.

Declaration

public ushort Group { get; }

Property Value

Type	Description
UInt16

Label

Gets or sets the overlay label.

Declaration

public string Label { get; set; }

Property Value

Type	Description
String

NumberOfFrames

Gets or sets the number of frames in the overlay.

Declaration

public int NumberOfFrames { get; set; }

Property Value

Type	Description
Int32

OriginFrame

Gets or sets the first frame of the overlay (frames are numbered from 1).

Declaration

public int OriginFrame { get; set; }

Property Value

Type	Description
Int32

OriginX

Gets or sets the index of the first column of the overlay.

Declaration

public int OriginX { get; set; }

Property Value

Type	Description
Int32

OriginY

Gets or sets the index of the first row of the overlay.

Declaration

public int OriginY { get; set; }

Property Value

Type	Description
Int32

Rows

Gets or sets the number of rows in overlay

Declaration

public int Rows { get; set; }

Property Value

Type	Description
Int32

Subtype

Gets or sets the overlay subtype.

Declaration

public string Subtype { get; set; }

Property Value

Type	Description
String

Type

Gets or sets the overlay type.

Declaration

public DicomOverlayType Type { get; set; }

Property Value

Type	Description
DicomOverlayType

Methods

FromDataset(DicomDataset)

Gets all overlays in a DICOM dataset.

Declaration

public static DicomOverlayData[] FromDataset(DicomDataset ds)

Parameters

Type	Name	Description
DicomDataset	ds	Dataset

Returns

Type	Description
DicomOverlayData[]	Array of overlays

GetOverlayDataS32(Int32, Int32)

Gets the overlay data as Int32 values.

Declaration

public int[] GetOverlayDataS32(int bg, int fg)

Parameters

Type	Name	Description
Int32	bg	Background color
Int32	fg	Foreground color

Returns

Type	Description
Int32[]	Overlay data

HasEmbeddedOverlays(DicomDataset)

Checks whether a dataset contains embedded overlays.

Declaration

public static bool HasEmbeddedOverlays(DicomDataset ds)

Parameters

Type	Name	Description
DicomDataset	ds	Dataset to examine.

Returns

Type	Description
Boolean	True if dataset contains embedded overlays, false otherwise.