Click or drag to resize

DicomDecoder Class

DicomDecoder is a MultiFramedImagedDecoder that can decode images from a DICOM File.
Inheritance Hierarchy

Namespace:  Atalasoft.Imaging.Codec.Dicom
Assembly:  Atalasoft.dotImage.Dicom (in Atalasoft.dotImage.Dicom.dll) Version: 11.0.0.0.0.297 (.NET 4.5.2, x86)
Syntax
public class DicomDecoder : MultiFramedImageDecoder, 
	IDisposable

The DicomDecoder type exposes the following members.

Constructors
  NameDescription
Public methodDicomDecoder
Initializes a new instance of the DicomDecoder class
Top
Properties
  NameDescription
Public propertySupportedImageType Obsolete.
Returns the ImageType that the implemented decoder class supports.
(Inherited from ImageDecoder.)
Top
Methods
  NameDescription
Public method{dtor}
Public methodDispose
Disposes the resources allocated by this object. It must be called when you are done with the object.
Protected methodDispose(Boolean)
Releases the unmanaged resources used by the DicomDecoder and optionally releases the managed resources
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize (Overrides ObjectFinalize.)
Protected methodGetDefaultResolution
Public methodGetFrameCount
Gets the number of images stored in a DICOM file.
(Overrides MultiFramedImageDecoderGetFrameCount(Stream).)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetImageInfo(Stream)
Gets an ImageInfo object representing information about the first image in a DICOM file.
(Overrides ImageDecoderGetImageInfo(Stream).)
Public methodGetImageInfo(Stream, Int32)
Gets an ImageInfo object representing information about a specific image in a DICOM file.
(Overrides MultiFramedImageDecoderGetImageInfo(Stream, Int32).)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsValidFormat
This method will determine if a stream is DICOM file.
(Overrides ImageDecoderIsValidFormat(Stream).)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodRead(Stream, ProgressEventHandler)
This method will decode the first image from a DICOM file.
(Overrides ImageDecoderRead(Stream, ProgressEventHandler).)
Public methodRead(Stream, Int32, ProgressEventHandler)
This method will decode a single image from a DICOM file.
(Overrides MultiFramedImageDecoderRead(Stream, Int32, ProgressEventHandler).)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Remarks

Usage of this class requires a License for the DICOM Codec Add-on.

To add the ability to decode DICOM images, add an instance of this class to the RegisteredDecoders collection as shown in the example.

Examples
RegisteredDecoders.Decoders.Add(new DicomDecoder());
See Also