Table of Contents

Namespace Egami.Formats.Extended.Dicom

Classes

DicomDataset

A DICOM dataset: data elements in file order, read-only, found by tag or by PS3.6 keyword. The file's main dataset, its file meta information and each item of a sequence are datasets.

DicomDetails

What a DICOM load read and did, in FormatDetails: the frame, how its pixels were stored, and the transforms that made the loaded values.

DicomElement

One data element of a DicomDataset: its tag, value representation and value, read as the file stores it and decoded on request by its VR (PS3.5 section 6.2).

DicomFile

A DICOM file (PS3.10) read into its datasets: the file meta information, and the dataset in the file's transfer syntax, every element kept, sequences as nested datasets, encapsulated pixel data as raw fragments. Implicit and explicit VR little endian, explicit VR big endian and deflated files are read, with or without the preamble. In preview: the API may change before it is stable.

DicomFormat

DICOM (PS3.10 files, .dcm): medical images with their dataset. Registered with WithDicom(EgamiContext); in preview. A load gives one frame as a viewer shows it (see DicomReaderOptions), each frame of a multi-frame file is an image of its own for LoadAll(Stream, EgamiContext?, ReaderOptions?), and DicomFile reads every element. A save writes a Secondary Capture image (see DicomWriterOptions).

DicomFragments

Encapsulated pixel data (PS3.5 section A.4): the Basic Offset Table, the fragments that follow it, and the Extended Offset Table when the dataset has one. The fragments are compressed data as stored; a frame may span several.

DicomPersonName

A Person Name (PN) value: up to three component groups, alphabetic, ideographic and phonetic, separated by =; the alphabetic one split into its five components (PS3.5 section 6.2.1).

DicomReaderOptions

Options for reading DICOM: which frame, what values, and which VOI transform shows a monochrome image. Pass them to Load(Stream, EgamiContext?, ReaderOptions?) or LoadFrame(int, DicomReaderOptions?, EgamiContext?).

DicomTransferSyntax

A transfer syntax: how a file encodes its dataset (VR explicit or implicit, byte order, deflate) and its pixel data (native or encapsulated in a codec's codestream), named by a UID of PS3.6 table A-1 (PS3.5 section 10).

DicomUid

DICOM unique identifiers (PS3.5 chapter 9).

DicomWriterOptions

Options for writing DICOM: the transfer syntax, the quality of lossy ones, and the attributes of a Secondary Capture image. Pass them to Save(Stream, FormatInfo, WriterOptions?) with Info, or to Save(Stream, DicomWriterOptions?, EgamiContext?).

Structs

DicomTag

A DICOM data element tag: a group and an element number (PS3.5 section 7.1). Public tags have even groups and are named in PS3.6's data dictionary; odd groups are private.

Enums

DicomOffsetTable

Where encapsulated pixel data says each frame starts (PS3.5 section A.4).

DicomVR

A value representation: how an element's value is encoded (PS3.5 section 6.2).

DicomValues

What a DICOM load gives, for Values.

DicomWindowFunction

A VOI LUT Function (0028,1056): how a window maps modality values to shown values (PS3.3 C.11.2.1.2).