Class DicomImage

DICOM Image class for image rendering.

Inheritance
System.Object
DicomImage
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: FellowOakDicom.Imaging
Assembly: fo-dicom.core.dll
Syntax
public class DicomImage

Constructors

DicomImage(DicomDataset, Int32)

Creates DICOM image object from dataset

Declaration
public DicomImage(DicomDataset dataset, int frame = 0)
Parameters
Type Name Description
DicomDataset dataset

Source dataset
System.Int32 frame

Zero-based frame index.

DicomImage(String, Int32)

Creates DICOM image object from file

Declaration
public DicomImage(string fileName, int frame = 0)
Parameters
Type Name Description
System.String fileName

Source file
System.Int32 frame

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.

Declaration
public bool AutoApplyLUTToAllFrames { get; set; }
Property Value
Type Description
System.Boolean

CacheMode

Declaration
public CacheType CacheMode { get; set; }
Property Value
Type Description
CacheType

CurrentFrame

Gets the index of the current frame.

Declaration
public int CurrentFrame { get; }
Property Value
Type Description
System.Int32

GrayscaleColorMap

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

Declaration
public virtual Color32[] GrayscaleColorMap { get; set; }
Property Value
Type Description
Color32[]

Height

Height of image in pixels

Declaration
public int Height { get; }
Property Value
Type Description
System.Int32

Invert

Gets or sets whether to render in inverted grey.

Declaration
public virtual bool Invert { get; set; }
Property Value
Type Description
System.Boolean

IsGrayscale

Gets or sets whether the image is gray scale.

Declaration
public virtual bool IsGrayscale { get; }
Property Value
Type Description
System.Boolean

NumberOfFrames

Number of frames contained in image data.

Declaration
public int NumberOfFrames { get; }
Property Value
Type Description
System.Int32

OverlayColor

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

Declaration
public int OverlayColor { get; set; }
Property Value
Type Description
System.Int32

Scale

Scaling factor of the rendered image

Declaration
public double Scale { get; set; }
Property Value
Type Description
System.Double

ShowOverlays

Show or hide DICOM overlays

Declaration
public bool ShowOverlays { get; set; }
Property Value
Type Description
System.Boolean

UseVOILUT

Gets or sets whether to use VOI LUT.

Declaration
public virtual bool UseVOILUT { get; set; }
Property Value
Type Description
System.Boolean

Width

Width of image in pixels

Declaration
public int Width { get; }
Property Value
Type Description
System.Int32

WindowCenter

Gets or sets window center of rendered gray scale image.

Declaration
public virtual double WindowCenter { get; set; }
Property Value
Type Description
System.Double

WindowWidth

Gets or sets window width of rendered gray scale image.

Declaration
public virtual double WindowWidth { get; set; }
Property Value
Type Description
System.Double

Methods

RenderImage(Int32)

Renders DICOM image to IImage.

Declaration
public virtual IImage RenderImage(int frame = 0)
Parameters
Type Name Description
System.Int32 frame

Zero-based frame index.
Returns
Type Description
IImage

Rendered image

Extension Methods