Read(Stream,ReadBehaviours) Method

In This Topic

Reads a DICOM file from a Stream

Syntax

Visual Basic
C#

'Declaration
 
Public Overloads Function Read( _
   ByVal Stream As System.IO.Stream, _
   Optional ByVal ReadBehaviour As ReadBehaviours _
) As DicomImage

public DicomImage Read( 
   System.IO.Stream Stream,
   ReadBehaviours ReadBehaviour
)

Parameters

Stream: The Stream from which to read.
ReadBehaviour: The behaviours to be used when reading this stream

Return Value

If successful, a DicomImage Object is returned, and is added to the appropriate collection. If unsuccessful, an appropriate error is thrown.

Remarks

This method can read streams in either official "Part10" format, with the 128 byte header, or unofficial "Part5" format, without a header. Detection of the type is automatic.

The stream may have been written by the Write method or by other DICOM software.

Example

DicomImageCollection imageCollection = new DicomImageCollection();
                    
using (FileStream fs = new FileStream("your_dicom_image.dcm", FileMode.Open, FileAccess.Read))
{
   imageCollection.Read(fs);
   
   // Or with read behaviours
   imageCollection.Read(fs, new ReadBehaviours() { CloseFilesAfterReading = true });
}

Requirements

Target Platforms: .NET CLR 4.8 or higher

Reference

DicomImageCollection Class
DicomImageCollection Members
Overload List

Send Feedback