cdac.medinfo.sdk.dcm30_04.baselibs

Class OWImageObject

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.DicomValue

cdac.medinfo.sdk.dcm30_04.baselibs.OWImageObject

All Implemented Interfaces:

IDicomValue, java.io.Serializable

public class OWImageObject
extends DicomValue

This class is for parsing and serialization of OW data element containing pixel data. Basically this class is for memory efficiency. If the pixel data i.e. tag 0x7FE0, 0x0010 is present then it is parsed and written into a temporary file so that whole data is not into memory at the same time. When the tag is serialized it is read from the file in chunks and written to the Dicom Stream. Additional functionality to get bytes of image data is also provided. If the image is very large then getBytes function of this method can be used to get the OBImageObject data byte by byte.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
OWImageObject() Default constructor initializes VR Type.

Method Summary

Methods

Modifier and Type	Method and Description
void	addFrame(byte[] arrByte) This function will add the frame of the image data.
void	addFrame(Frame objFrame) This function will add the frame of the image data.
void	addFrames(IDicomStream objIDicomStream, int[] iArrSize) This function will add all the frames of the image data present in the Dicom Stream.
void	addFrames(ISingleCollection<byte[]> objFrameCollection) This function will add all the frames of the image data.
void	changeToUndefined() This function sets the Value length to -1.
void	dispose() This function disposes OW Image Object.
void	dumpDICOMInfo(IDicomStream objIDicomStream) Dumps the value of OW Image Object as Hidden to the specified Stream.
byte[]	getBytes(int iNumberOfBytes) The implementation of this method Reads iNumberOfByte bytes from the file stream and returns byte array of iNumberOfByte.
byte[]	getFrame(int index) This method Retrieves the frame specified by the index.
boolean	getFrame(int index, IDicomStream objDicomStream) This function retirves the Frame specified by the index in the Dicom Stream Provided by the User.
int	getImageDataLength() The implementation of this method gets the length of the image data.
long	getMaxLength() Retrieves the max length for OB DataType
int	getNumberOfFrame() The implementation of this method gets number of frames of a image.
java.lang.Object	getValue() This function returns the Image data in vector of byte array.
int[]	getValue(IDicomStream objIDicomStream) This function retirves the Image data in the Dicom Stream Provided by the User.
int	getValueLength() Retrieves Value length of OWImageObject.
boolean	isAvailable() This method gives information if OB image Object data is avalilabe.
boolean	read(IDicomStream objIDicomStream, int iOWLength) This method reads OW in the structure -> OW Basic Offset Table with NO Item Value(Tag and Length) then Item Tag, length and value for each frame specified in the offset table3.
void	setValue(ISingleCollection<byte[]> objFrameCollection) This function set the value of image data provided in vector of byte array.
boolean	validate() Validates OB DataType
boolean	validate(java.lang.Object objValue) Validates OB DataType
int	write(IDicomStream objIDicomStream) This method writes the series of byte buffers present in the OW datatype.

Methods inherited from class cdac.medinfo.sdk.dcm30_04.baselibs.DicomValue

clone, getIVRType, getValueMultiplicity, setIVRType, setValue

Methods inherited from class java.lang.Object

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

Constructor Detail

OWImageObject

public OWImageObject()

Default constructor initializes VR Type.

Method Detail

getNumberOfFrame

public int getNumberOfFrame()

The implementation of this method gets number of frames of a image.

Returns:

int - value of number of frames.

getImageDataLength

public int getImageDataLength()

The implementation of this method gets the length of the image data.

Returns:

int - length of the image data.

getValueLength

public int getValueLength()

Retrieves Value length of OWImageObject.

Specified by:

getValueLength in interface IDicomValue

Specified by:

getValueLength in class DicomValue

Returns:

integer - actual value length of Dicom Data

getValue

public java.lang.Object getValue()

This function returns the Image data in vector of byte array. The size of vector tells the no of frame in the Image Data.

Specified by:

getValue in interface IDicomValue

Overrides:

getValue in class DicomValue

Returns:

ISingleCollection - Vector of byte array containing Image Data.

getValue

public int[] getValue(IDicomStream objIDicomStream)

This function retirves the Image data in the Dicom Stream Provided by the User. The Size of each frame is in Interger array returned.

Parameters:

objIDicomStream - Dicom Stream in which Image Data should be written and given to the user.

Returns:

int[] Interger array containing Size of each frame.

getFrame

public byte[] getFrame(int index)
                throws java.io.IOException

This method Retrieves the frame specified by the index.

Parameters:

index - index number of the frame. This should be between 1 and the no of frame present in the image.

Returns:

byte[] byte array containing the image frame data.

Throws:

java.io.IOException - Signals IOException if IO Operation fails.

getFrame

public boolean getFrame(int index,
               IDicomStream objDicomStream)
                 throws java.io.IOException

This function retirves the Frame specified by the index in the Dicom Stream Provided by the User.

Parameters:

index - index number of the frame. This should be between 1 and the no of frame present in the image.

objDicomStream - Dicom Stream provided by the user.

Returns:

boolean - return true if frame data is written to the Dicom Stream. false if fails to write frame data to Dicom Stream.

Throws:

java.io.IOException - Signals IOException if IO Operation fails.

addFrame

public void addFrame(byte[] arrByte)
              throws java.io.IOException

This function will add the frame of the image data.

Parameters:

arrByte - Byte array contianing the image data.

Throws:

java.io.IOException - throws IOException if the IO Operation fails.

addFrame

public void addFrame(Frame objFrame)
              throws java.io.IOException

This function will add the frame of the image data.

Parameters:

objFrame - Object of Frame representing one frame of a image.

Throws:

java.io.IOException - throws IOException if the IO Operation fails.

addFrames

public void addFrames(ISingleCollection<byte[]> objFrameCollection)
               throws java.io.IOException

This function will add all the frames of the image data.

Parameters:

objFrameCollection - Vector of byte array containing the image data.

Throws:

java.io.IOException - throws IOException if the IO Operation fails.

addFrames

public void addFrames(IDicomStream objIDicomStream,
             int[] iArrSize)
               throws java.io.IOException

This function will add all the frames of the image data present in the Dicom Stream. The size of each frame should be given in the integer array.

Parameters:

objIDicomStream - Dicom Stream provided by the user.

iArrSize - Integer array containing the Size of each frame.

Throws:

java.io.IOException - throws IOException if the IO Operation fails.

setValue

public void setValue(ISingleCollection<byte[]> objFrameCollection)
              throws java.io.IOException

This function set the value of image data provided in vector of byte array.

Parameters:

objFrameCollection - Vector of byte array containing the image data.

Throws:

java.io.IOException - throws IOException if the IO Operation fails.

read

public boolean read(IDicomStream objIDicomStream,
           int iOWLength)
             throws InvalidDataTypeException,
                    java.io.IOException

This method reads OW in the structure -> OW Basic Offset Table with NO Item Value(Tag and Length) then Item Tag, length and value for each frame specified in the offset table3. All the data read is written into a temporary file.

Specified by:

read in interface IDicomValue

Specified by:

read in class DicomValue

Parameters:

objIDicomStream - stream from which the Item is to be written

iOBLength - length of the DicomValue to be read from the stream

Returns:

integer - returns status success/failure

Throws:

InvalidDataTypeException - If data type validation fails.

java.io.IOException - If Input/Output operation fails.

write

public int write(IDicomStream objIDicomStream)
          throws java.io.IOException

This method writes the series of byte buffers present in the OW datatype. For this purpose it writes them in the structure specified in the Dicom standard.

Specified by:

write in interface IDicomValue

Specified by:

write in class DicomValue

Parameters:

objIDicomStream - stream on which to write the DataElements

Returns:

integer - status indicating success/failure

Throws:

java.io.IOException - If Input/Output operation fails.

getBytes

public byte[] getBytes(int iNumberOfBytes)
                throws java.io.IOException

The implementation of this method Reads iNumberOfByte bytes from the file stream and returns byte array of iNumberOfByte.

Parameters:

iNumberOfBytes - iNumberOfByte integer value of number of bytes required.

Returns:

byte[] - byte array of iNumberOFBytes.

Throws:

java.io.IOException - If IO operation fails

isAvailable

public boolean isAvailable()
                    throws java.io.IOException

This method gives information if OB image Object data is avalilabe.

Returns:

boolean - true if OB image Object data is avalilable false if OB image Object data is not avalilable

Throws:

java.io.IOException - if IO operation fails

validate

public boolean validate(java.lang.Object objValue)
                 throws ValidationException

Validates OB DataType

Specified by:

validate in interface IDicomValue

Specified by:

validate in class DicomValue

Parameters:

objValue - value of OB to be validated

Returns:

boolean status indicating success/failure

Throws:

ValidationException - If validation of DataType fails.

validate

public boolean validate()
                 throws ValidationException

Validates OB DataType

Specified by:

validate in interface IDicomValue

Specified by:

validate in class DicomValue

Returns:

boolean status indicating success/failure

Throws:

ValidationException - If validation of DataType fails.

getMaxLength

public long getMaxLength()

Retrieves the max length for OB DataType

Returns:

integer - max length for OB DataType

dispose

public void dispose()
             throws java.io.IOException

This function disposes OW Image Object. It closes the File Stream and Deletes the temporary file.

Throws:

java.io.IOException - Signals if IO Operation fails.

dumpDICOMInfo

public void dumpDICOMInfo(IDicomStream objIDicomStream)
                   throws java.io.IOException

Dumps the value of OW Image Object as Hidden to the specified Stream.

Parameters:

objIDicomStream - - the Stream on which the Data is to be written.

Throws:

java.io.IOException - - Exception is thrown indicating runtime failure of writing operation.

changeToUndefined

public void changeToUndefined()

This function sets the Value length to -1. If this function is called then then length of value is undefined length(-1)