Class DicomPixelData

Namespace

FellowOakDicom.Imaging

Assembly

fo-dicom.core.dll

DICOM Pixel Data abstract class for reading and writing DICOM images pixel data according to the specified transfer syntax

public abstract class DicomPixelData

Inheritance

object

DicomPixelData

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

DicomPixelData(DicomDataset)

Initializes new instance of DicomPixelData using passed dataset.

protected DicomPixelData(DicomDataset dataset)

Parameters

dataset DicomDataset

Properties

BitDepth

Gets new instance of BitDepth using dataset information.

public BitDepth BitDepth { get; }

Property Value

BitDepth

BitsAllocated

Gets number of bits allocated per pixel sample (0028,0100).

public ushort BitsAllocated { get; }

Property Value

ushort

BitsStored

Gets or sets number of bits stored per pixel sample (0028,0101).

public ushort BitsStored { get; set; }

Property Value

ushort

BytesAllocated

Gets number of bytes allocated per pixel sample.

public int BytesAllocated { get; }

Property Value

int

Dataset

Gets the DICOM Dataset containing the pixel data.

public DicomDataset Dataset { get; }

Property Value

DicomDataset

Height

Gets or sets the DICOM image height (rows) in pixels.

public ushort Height { get; set; }

Property Value

ushort

HighBit

Gets or sets index of the most signficant bit (MSB) of pixel sample(0028,0102).

public ushort HighBit { get; set; }

Property Value

ushort

IsLossy

Gets lossy image compression (0028,2110) status, returns true if stored value is "01".

public bool IsLossy { get; }

Property Value

bool

LossyCompressionMethod

Gets lossy image compression method (0028,2114).

public string LossyCompressionMethod { get; }

Property Value

string

LossyCompressionRatio

Gets lossy image compression ratio (0028,2112).

public decimal LossyCompressionRatio { get; }

Property Value

decimal

NumberOfFrames

Gets or sets DICOM image Number of frames. This value usually equals 1 for single frame images.

public int NumberOfFrames { get; set; }

Property Value

int

PaletteColorLUT

Gets palette color LUT, valid for PALETTE COLOR PhotometricInterpretation

public Color32[] PaletteColorLUT { get; }

Property Value

Color32[]

PhotometricInterpretation

Gets or sets photometric Interpretation.

public PhotometricInterpretation PhotometricInterpretation { get; set; }

Property Value

PhotometricInterpretation

PixelRepresentation

Gets or sets, pixel Representation (0028,0103), represents signed/unsigned data of the pixel samples.

public PixelRepresentation PixelRepresentation { get; set; }

Property Value

PixelRepresentation

PlanarConfiguration

Gets or sets planar Configuration (0028,0006), indicates whether the color pixel data are sent color-by-plane or color-by-pixel.

public PlanarConfiguration PlanarConfiguration { get; set; }

Property Value

PlanarConfiguration

SamplesPerPixel

Gets or sets number of samples per pixel (0028,0002), usually 1 for grayscale and 3 for color (RGB and YBR.

public ushort SamplesPerPixel { get; set; }

Property Value

ushort

Syntax

Gets the transfer syntax used to encode the DICOM iamge pixel data

public DicomTransferSyntax Syntax { get; }

Property Value

DicomTransferSyntax

UncompressedFrameSize

Gets uncompressed frame size in bytes.

public int UncompressedFrameSize { get; }

Property Value

int

Width

Gets or sets the DICOM image width (columns) in pixels.

public ushort Width { get; set; }

Property Value

ushort

Methods

AddFrame(IByteBuffer)

Abstract AddFrame method to add new frame into dataset pixel dataset. New frame will be appended to existing frames.

public abstract void AddFrame(IByteBuffer data)

Parameters

data IByteBuffer

Frame byte buffer.

Create(DicomDataset, bool)

A factory method to initialize new instance of DicomPixelData implementation either DicomPixelData.OtherWordPixelData, DicomPixelData.OtherBytePixelData, or DicomPixelData.EncapsulatedPixelData

public static DicomPixelData Create(DicomDataset dataset, bool newPixelData = false)

Parameters

dataset DicomDataset

Source DICOM Dataset

newPixelData bool

true if new DicomPixelDatawill be created for current dataset, false to read DicomPixelData from dataset. Default is false (read)

Returns

DicomPixelData

New instance of DicomPixelData

GetFrame(int)

Abstract GetFrame method to extract specific frame byte buffer frame dataset

public abstract IByteBuffer GetFrame(int frame)

Parameters

frame int

Frame index

Returns

IByteBuffer

Frame byte buffer