DicomObjects.NET.8.48 Documentation
DicomObjects Namespace / DicomImage Class / Read Method / Read(String,ReadBehaviours) Method

The name of the file to read.

This is passed unmodified to the operating system, and it is therefore the container�s responsibility to ensure either that the file exists within the current directory, or that a fully qualified filename is provided.

The behaviours to be used when reading this stream
Example

In This Topic
    Read(String,ReadBehaviours) Method
    In This Topic
    Reads from an external DICOM file
    Syntax
    'Declaration
 

    Public Overloads Sub Read( _
   ByVal FileName As System.String, _
   Optional ByVal readBehaviours As ReadBehaviours _
) 
    public void Read( 
   System.string FileName,
   ReadBehaviours readBehaviours
)

    Parameters

    FileName

    The name of the file to read.

    This is passed unmodified to the operating system, and it is therefore the container�s responsibility to ensure either that the file exists within the current directory, or that a fully qualified filename is provided.

    readBehaviours
    The behaviours to be used when reading this stream
    Remarks

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


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

    By default, pixel data is read only when it is required, greatly speeding the display of multi-frame images, and reducing memory requirements. However, a side effect of this is that any elements after the pixel data (7FE0,0010) will not be read. This should not affect most applications, but if necessary, this behavior may be over-ridden using the CloseFilesAfterReading property.

    Another effect of file mapping is that files read using this method cannot be deleted until the image object is released. This method creates two references to the newly created DicomImage object (one in the collection, and one as the return value), and both must be released before the file can be deleted.

    Example
    DicomImage image = new DicomImage();
image.Read("your_dicom_image.dcm"); // Default call
                    
ReadBehaviours behaviours = new ReadBehaviours() { IgnoreAfterPixels = true, IgnoreBOT = true }; // ReadBehaviours behaviours option
image.Read("your_dicom_image.dcm", behaviours);
    Requirements

    Target Platforms: .NET CLR 4.8 or higher

    See Also

    Reference

    DicomImage Class
    DicomImage Members
    Overload List

    Send Feedback