Class OverlayData

Class OverlayData

Namespace: Aspose.Medical.Dicom.Imaging.Overlays
Assembly: Aspose.Medical.dll (25.11.0)

DICOM image overlay. An Overlay Plane describes graphics or bit-mapped text that is associated with an Image. It may also describe a Region of Interest in an Image. See https://dicom.nema.org/medical/dicom/current/output/chtml/part03/sect_C.9.2.html for details.

public abstract class OverlayData

Inheritance

object OverlayData

Inherited Members

object.GetType() , object.MemberwiseClone() , object.ToString() , object.Equals(object?) , object.Equals(object?, object?) , object.ReferenceEquals(object?, object?) , object.GetHashCode()

Constructors

OverlayData(ushort, Dataset)

DICOM image overlay. An Overlay Plane describes graphics or bit-mapped text that is associated with an Image. It may also describe a Region of Interest in an Image. See https://dicom.nema.org/medical/dicom/current/output/chtml/part03/sect_C.9.2.html for details.

protected OverlayData(ushort group, Dataset dataset)

Parameters

group ushort

dataset Dataset

Properties

BitPosition

The bit position of embedded overlay. Read/Write System.Int32.

public int BitPosition { get; set; }

Property Value

int

BitsAllocated

The number of bits allocated in overlay data. Read/Write System.Int32.

public int BitsAllocated { get; set; }

Property Value

int

Columns

The number of columns in overlay. Read/Write System.Int32.

public int Columns { get; set; }

Property Value

int

Dataset

The DICOM Dataset containing the overlay data. Read-only Aspose.Medical.Dicom.Imaging.Overlays.OverlayData.Dataset.

protected Dataset Dataset { get; }

Property Value

Dataset

Description

The description of the overlay. Read/Write System.String.

public string Description { get; set; }

Property Value

string

Label

The overlay label. Read/Write System.String.

public string Label { get; set; }

Property Value

string

NumberOfFrames

The number of frames in the overlay. Read/Write System.Int32.

public int NumberOfFrames { get; set; }

Property Value

int

OriginFrame

The first frame of the overlay (frames are numbered from 1). Read/Write System.Int32.

public int OriginFrame { get; set; }

Property Value

int

OriginX

The index of the first column of the overlay. Read/Write System.Int32.

public int OriginX { get; set; }

Property Value

int

OriginY

The index of the first row of the overlay. Read/Write System.Int32.

public int OriginY { get; set; }

Property Value

int

Rows

The number of rows in overlay. Read/Write System.Int32.

public int Rows { get; set; }

Property Value

int

Subtype

The overlay subtype. Read/Write System.String.

public string Subtype { get; set; }

Property Value

string

Type

The overlay type. Read/Write Aspose.Medical.Dicom.Imaging.Overlays.OverlayType.

public OverlayType Type { get; set; }

Property Value

OverlayType