cdac.medinfo.sdk.dcm30_04.baselibs

Class ImageElement

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.DataElement

cdac.medinfo.sdk.dcm30_04.baselibs.ImageElement

All Implemented Interfaces:

IDataElement, java.io.Serializable

public class ImageElement
extends DataElement

This class contains the Image Element i.e. Data element representing pixel data. This class is written for memory efficiency. It is child of DataElement with an additional functionality of getting bytes of image data. The getBytes function returns the byte array of iNumberOfBytes to the user.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ImageElement(IDataElement objIDataElement) This constructor initializes Image Element object.
ImageElement(ITransferSyntax objITransferSyntax, IDictionaryReader objIDictionaryReader, OBImageObject objOBImageObject) Creates Image Element with specified Transfer syntax and OBImageObject Dicom Data.
ImageElement(ITransferSyntax objITransferSyntax, IDictionaryReader objIDictionaryReader, OWImageObject objOWImageObject) Creates Image Element with specified Transfer syntax and OWImageObject Dicom Data.
ImageElement(ITransferSyntax objITransferSyntax, OBImageObject objOBImageObject) Creates Image Element with specified Transfer syntax and OBImageObject Dicom Data.
ImageElement(ITransferSyntax objITransferSyntax, OWImageObject objOWImageObject) Creates Image Element with specified Transfer syntax and OWImageObject Dicom Data.

Method Summary

Methods

Modifier and Type	Method and Description
void	dispose() This function disposes the Image Element.
byte[]	getBytes(int iNumberOfBytes) The implementation of this method gets the iNumberOfBytes of image element and returns a byte array.
int	getDataElementLength() The implementation of this method gets the length of image element.
ISingleCollection<byte[]>	getValue() This function will retrieve the value of dicom data of the Data Element.
boolean	isAvailable() This method gives information if OB image Object data is available.
int	parse(IDicomStream objIDicomStream) The implementation of this method parses the image element.
int	serialize(IDicomStream objIDicomStream) The implementation of this method serializes the image element.
boolean	validate() This function validates the Image Element.

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

clone, dumpDICOMInfo, equals, getDicomValue, getDictionaryReader, getTag, getTransferSyntax, getValueLength, getValueMultiplicity, setDicomValue, setDictionaryReader, setTag, setTransferSyntax, setValueMultiplicity

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageElement

public ImageElement(ITransferSyntax objITransferSyntax,
            OBImageObject objOBImageObject)
             throws InvalidDataElementException

Creates Image Element with specified Transfer syntax and OBImageObject Dicom Data.

Parameters:

objITransferSyntax - value of Transfer Syntax.

objOBImageObject - populated object of OBImageObject.

Throws:

InvalidDataElementException

ImageElement

public ImageElement(ITransferSyntax objITransferSyntax,
            OWImageObject objOWImageObject)
             throws InvalidDataElementException

Creates Image Element with specified Transfer syntax and OWImageObject Dicom Data.

Parameters:

objITransferSyntax - value of Transfer Syntax.

objOWImageObject - populated object of OWImageObject.

Throws:

InvalidDataElementException

ImageElement

public ImageElement(ITransferSyntax objITransferSyntax,
            IDictionaryReader objIDictionaryReader,
            OBImageObject objOBImageObject)

Creates Image Element with specified Transfer syntax and OBImageObject Dicom Data.

Parameters:

objITransferSyntax - value of Transfer Syntax.

objOBImageObject - populated object of Dicom Data OBImageObject.

objIDictionaryReader - instance of Dictionary Reader.

ImageElement

public ImageElement(ITransferSyntax objITransferSyntax,
            IDictionaryReader objIDictionaryReader,
            OWImageObject objOWImageObject)

Creates Image Element with specified Transfer syntax and OWImageObject Dicom Data.

Parameters:

objITransferSyntax - value of Transfer Syntax.

objOWImageObject - populated object of Dicom Data OWImageObject.

objIDictionaryReader - instance of Dictionary Reader.

ImageElement

public ImageElement(IDataElement objIDataElement)

This constructor initializes Image Element object.

Parameters:

objIDataElement - The object of data element representing image element.

Method Detail

parse

public int parse(IDicomStream objIDicomStream)
          throws InvalidDataElementException,
                 java.io.IOException

The implementation of this method parses the image element.

Specified by:

parse in interface IDataElement

Specified by:

parse in class DataElement

Parameters:

objIDicomStream - stream from which the DataElement is to be parsed and populated

Returns:

int - shows status as success or failure.

Throws:

InvalidDataElementException - If Data Element fails to satisfy Validation Criteria.

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

serialize

public int serialize(IDicomStream objIDicomStream)
              throws InvalidDataElementException,
                     java.io.IOException

The implementation of this method serializes the image element.

Specified by:

serialize in interface IDataElement

Specified by:

serialize in class DataElement

Parameters:

objIDicomStream - stream to which the DataElement is to be serialized.

Returns:

int - shows status as success or failure.

Throws:

InvalidDataElementException - If Data Element fails to satisfy Validation Criteria.

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

getDataElementLength

public int getDataElementLength()

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

Specified by:

getDataElementLength in interface IDataElement

Specified by:

getDataElementLength in class DataElement

Returns:

int - integer value of length of data element.

getBytes

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

The implementation of this method gets the iNumberOfBytes of image element and returns a byte array.

Parameters:

iNumberOfBytes - Number of bytes of image data 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 available.

Returns:

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

Throws:

java.io.IOException - if IO operation fails

validate

public boolean validate()
                 throws InvalidDataElementException

This function validates the Image Element.

Specified by:

validate in interface IDataElement

Overrides:

validate in class DataElement

Returns:

boolean - Result Status, True : Success, False : Failure

Throws:

InvalidDataElementException - Signals if Data Element Validation Fails.

getValue

public ISingleCollection<byte[]> getValue()

Description copied from class: DataElement

This function will retrieve the value of dicom data of the Data Element.

Specified by:

getValue in interface IDataElement

Overrides:

getValue in class DataElement

Returns:

Object - value of dicom data of the Data Element.

dispose

public void dispose()
             throws java.io.IOException

This function disposes the Image Element.

Throws:

java.io.IOException - Signals if an IO Exception occurs.