Class DicomImage

Namespace

FellowOakDicom.Imaging

Assembly

fo-dicom.core.dll

DICOM Image class for image rendering.

public class DicomImage

Inheritance

object

DicomImage

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

DicomImage(DicomDataset, int)

Creates DICOM image object from dataset

public DicomImage(DicomDataset dataset, int frame = 0)

Parameters

dataset DicomDataset

Source dataset

frame int

Zero-based frame index.

DicomImage(string, int)

Creates DICOM image object from file

public DicomImage(string fileName, int frame = 0)

Parameters

fileName string

Source file

frame int

Zero-based frame index.

Properties

AutoApplyLUTToAllFrames

Gets or sets wether the rendering options of all frames shall be updated when a property is changed, or only the rendering options of the current frame.

public bool AutoApplyLUTToAllFrames { get; set; }

Property Value

bool

CacheMode

public CacheType CacheMode { get; set; }

Property Value

CacheType

CurrentFrame

Gets the index of the current frame.

public int CurrentFrame { get; }

Property Value

int

GrayscaleColorMap

Gets or sets the color map to be applied when rendering grayscale images.

public virtual Color32[] GrayscaleColorMap { get; set; }

Property Value

Color32[]

Height

Height of image in pixels

public int Height { get; }

Property Value

int

Invert

Gets or sets whether to render in inverted grey.

public virtual bool Invert { get; set; }

Property Value

bool

IsGrayscale

Gets or sets whether the image is gray scale.

public virtual bool IsGrayscale { get; }

Property Value

bool

NumberOfFrames

Number of frames contained in image data.

public int NumberOfFrames { get; }

Property Value

int

OverlayColor

Gets or sets the color used for displaying DICOM overlays. Default is magenta.

public int OverlayColor { get; set; }

Property Value

int

Scale

Scaling factor of the rendered image

public double Scale { get; set; }

Property Value

double

ShowOverlays

Show or hide DICOM overlays

public bool ShowOverlays { get; set; }

Property Value

bool

UseVOILUT

Gets or sets whether to use VOI LUT.

public virtual bool UseVOILUT { get; set; }

Property Value

bool

Width

Width of image in pixels

public int Width { get; }

Property Value

int

WindowCenter

Gets or sets window center of rendered gray scale image.

public virtual double WindowCenter { get; set; }

Property Value

double

WindowWidth

Gets or sets window width of rendered gray scale image.

public virtual double WindowWidth { get; set; }

Property Value

double

Methods

RenderImage(int)

Renders DICOM image to IImage.

public virtual IImage RenderImage(int frame = 0)

Parameters

frame int

Zero-based frame index.

Returns

IImage

Rendered image