com.archimed.dicom
Class DicomReader

java.lang.Object
  com.archimed.dicom.DicomReader

public class DicomReader
extends java.lang.Object

A factory class for creating DicomObject objects out of DICOM files and DICOM streams.
TagReadListeners for specific data elements and TagReadListeners to listen to the reading of all data elements can be added to the DicomReader. TagReadListeners notify when individual data elements are read and give the opportunity to modify the read behaviour of individual data elements.
TagReadListener that are registered for listening to all data elements read, fire before TagReadListeners that are registered for listening to the reading of specific Data Elements.

Since:

1.6

See Also:

TagReadListener,TagReadEvent

Field Summary

protected JdtLogger

log

Constructor Summary

DicomReader()

Method Summary

void	addSequenceItemReadListener(SequenceItemReadListener listener) adds a SequenceItemReadListener for every data element read
void	addSequenceItemReadListener(SequenceItemReadListener listener, int tag) adds a SequenceItemReadListener for a specific data element specified by a tag constant.
void	addSequenceItemReadListener(SequenceItemReadListener listener, int group, int element) adds a SequenceItemReadListener for a specific data element specified by a group element pair
void	addTagReadListener(TagReadListener listener) adds a TagReadListener for every data element read
void	addTagReadListener(TagReadListener listener, int tag) adds a TagReadListener for a specific data element specified by a tag constant.
void	addTagReadListener(TagReadListener listener, int group, int element) adds a TagReadListener for a specific data element specified by a group element pair
boolean	checkIfDicomFile(java.io.InputStream f) Checks if this InputStream contains a valid DICOM File (having a preamble and DICOM Prefix (see Part 3.10))
DicomObject	read(java.io.InputStream in) reads a DICOM dataset from an InputStream.
DicomObject	read(java.io.InputStream in, boolean readpixels) reads a DICOM dataset or DICOM file from an InputStream.
DicomObject	read(java.io.InputStream in, int transfersyntax, boolean readpixels) reads a DICOM dataset from an InputStream.
DicomObject	readSequenceItem(java.io.InputStream in, int transferSyntax) reads a single sequence item and returns it as an independent DicomObject without a parent.
void	removeSequenceItemReadListener(SequenceItemReadListener listener) removes a SequenceItemReadListener.
void	removeSequenceItemReadListener(SequenceItemReadListener listener, int tag) removes a SequenceItemReadListener.
void	removeSequenceItemReadListener(SequenceItemReadListener listener, int group, int element) removes a SequenceItemReadListener.
void	removeTagReadListener(TagReadListener listener) removes a TagReadListener.
void	removeTagReadListener(TagReadListener listener, int tag) removes a TagReadListener.
void	removeTagReadListener(TagReadListener listener, int group, int element) removes a TagReadListener.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

log

protected JdtLogger log

Constructor Detail

DicomReader

public DicomReader()

Method Detail

addTagReadListener

public void addTagReadListener(TagReadListener listener,
                               int tag)

adds a TagReadListener for a specific data element specified by a tag constant.

Parameters:

listener - TagReadListener

tag - int

addTagReadListener

public void addTagReadListener(TagReadListener listener,
                               int group,
                               int element)

adds a TagReadListener for a specific data element specified by a group element pair

Parameters:

listener -

group -

element -

addTagReadListener

public void addTagReadListener(TagReadListener listener)

adds a TagReadListener for every data element read

Parameters:

listener - TagReadListener

removeTagReadListener

public void removeTagReadListener(TagReadListener listener,
                                  int tag)

removes a TagReadListener.

Parameters:

listener -

tag -

removeTagReadListener

public void removeTagReadListener(TagReadListener listener,
                                  int group,
                                  int element)

removes a TagReadListener.

Parameters:

listener -

group -

element -

removeTagReadListener

public void removeTagReadListener(TagReadListener listener)

removes a TagReadListener.

Parameters:

listener - TagReadListener

addSequenceItemReadListener

public void addSequenceItemReadListener(SequenceItemReadListener listener,
                                        int tag)

adds a SequenceItemReadListener for a specific data element specified by a tag constant.

Parameters:

listener - SequenceItemReadListener

tag - int

addSequenceItemReadListener

public void addSequenceItemReadListener(SequenceItemReadListener listener,
                                        int group,
                                        int element)

adds a SequenceItemReadListener for a specific data element specified by a group element pair

Parameters:

listener -

group -

element -

addSequenceItemReadListener

public void addSequenceItemReadListener(SequenceItemReadListener listener)

adds a SequenceItemReadListener for every data element read

Parameters:

listener - SequenceItemReadListener

removeSequenceItemReadListener

public void removeSequenceItemReadListener(SequenceItemReadListener listener,
                                           int tag)

removes a SequenceItemReadListener.

Parameters:

listener -

tag -

removeSequenceItemReadListener

public void removeSequenceItemReadListener(SequenceItemReadListener listener,
                                           int group,
                                           int element)

removes a SequenceItemReadListener.

Parameters:

listener -

group -

element -

removeSequenceItemReadListener

public void removeSequenceItemReadListener(SequenceItemReadListener listener)

removes a SequenceItemReadListener.

Parameters:

listener - SequenceItemReadListener

read

public DicomObject read(java.io.InputStream in)
                 throws java.io.IOException,
                        DicomException

reads a DICOM dataset from an InputStream. This method calls read(in, readpixels), with the 'readpixels' boolean set to true.

Throws:

java.io.IOException

DicomException

read

public DicomObject read(java.io.InputStream in,
                        int transfersyntax,
                        boolean readpixels)
                 throws java.io.IOException,
                        DicomException

reads a DICOM dataset from an InputStream. The transfer syntax must be specified and is not detected as with DICOM files.

Parameters:

in - an InputStream to a DICOM dataset

transfersyntax - the transfer syntax with which this Dataset is encoded

Returns:

the DicomObject filled with data from the stream

Throws:

java.io.IOException

DicomException

See Also:

TransferSyntax

read

public DicomObject read(java.io.InputStream in,
                        boolean readpixels)
                 throws java.io.IOException,
                        DicomException

reads a DICOM dataset or DICOM file from an InputStream.
The method automatically detects if the InputStream holds a DICOM file or a DICOM stream. If none of the above are the case, an exception is thrown.

Parameters:

in - an InputStream to a DICOM dataset or DICOM file

readpixels - A boolean indicating whether to parse the Pixel Data or not

Returns:

the DicomObject filled with data from the stream

Throws:

java.io.IOException

DicomException

readSequenceItem

public DicomObject readSequenceItem(java.io.InputStream in,
                                    int transferSyntax)
                             throws java.io.IOException,
                                    DicomException

reads a single sequence item and returns it as an independent DicomObject without a parent. The inputstream must be positioned at the beginning of the item tag (FFFE,E000) . This method is useful for reading individial sequence items in a DICOMDIR after moving a the inputstream to the correct position with the aid of the record offsets available in the DICOMDIR.

Throws:

java.io.IOException

DicomException

checkIfDicomFile

public boolean checkIfDicomFile(java.io.InputStream f)
                         throws java.io.IOException,
                                DicomException

Checks if this InputStream contains a valid DICOM File (having a preamble and DICOM Prefix (see Part 3.10))

Throws:

java.io.IOException

DicomException