Class DicomOverlayData

Namespace

FellowOakDicom.Imaging

Assembly

fo-dicom.core.dll

DICOM image overlay class

public class DicomOverlayData

Inheritance

object

DicomOverlayData

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

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

Constructors

DicomOverlayData(DicomDataset, ushort)

Initializes overlay from DICOM dataset and overlay group.

public DicomOverlayData(DicomDataset ds, ushort group)

Parameters

ds DicomDataset

Dataset

group ushort

Overlay group

Exceptions

DicomImagingException

Thrown if the overlay data is insufficient.

Properties

BitPosition

Gets or sets the bit position of embedded overlay.

public int BitPosition { get; set; }

Property Value

int

BitsAllocated

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

public int BitsAllocated { get; set; }

Property Value

int

Columns

Gets or sets the number of columns in overlay.

public int Columns { get; set; }

Property Value

int

Data

Gets or sets the overlay data.

public IByteBuffer Data { get; set; }

Property Value

IByteBuffer

Dataset

Gets the DICOM Dataset containing the overlay data.

public DicomDataset Dataset { get; }

Property Value

DicomDataset

Description

Gets or sets the description of the overlay.

public string Description { get; set; }

Property Value

string

Group

Get the overlay group number.

public ushort Group { get; }

Property Value

ushort

Label

Gets or sets the overlay label.

public string Label { get; set; }

Property Value

string

NumberOfFrames

Gets or sets the number of frames in the overlay.

public int NumberOfFrames { get; set; }

Property Value

int

OriginFrame

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

public int OriginFrame { get; set; }

Property Value

int

OriginX

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

public int OriginX { get; set; }

Property Value

int

OriginY

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

public int OriginY { get; set; }

Property Value

int

Rows

Gets or sets the number of rows in overlay

public int Rows { get; set; }

Property Value

int

Subtype

Gets or sets the overlay subtype.

public string Subtype { get; set; }

Property Value

string

Type

Gets or sets the overlay type.

public DicomOverlayType Type { get; set; }

Property Value

DicomOverlayType

Methods

FromDataset(DicomDataset)

Gets all overlays in a DICOM dataset.

public static DicomOverlayData[] FromDataset(DicomDataset ds)

Parameters

ds DicomDataset

Dataset

Returns

DicomOverlayData[]

Array of overlays

GetOverlayDataS32(int, int)

Gets the overlay data as int values.

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

Parameters

bg int

Background color

fg int

Foreground color

Returns

int[]

Overlay data

HasEmbeddedOverlays(DicomDataset)

Checks whether a dataset contains embedded overlays.

public static bool HasEmbeddedOverlays(DicomDataset ds)

Parameters

ds DicomDataset

Dataset to examine.

Returns

bool

True if dataset contains embedded overlays, false otherwise.