cdac.medinfo.sdk.dcm30_04.dicommodel.hardcopy

Class HardcopyColorImageIOD

java.lang.Object

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.IOD

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.CompositeIOD

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.ImageIOD

cdac.medinfo.sdk.dcm30_04.dicommodel.hardcopy.HardcopyColorImageIOD

public class HardcopyColorImageIOD
extends ImageIOD

The Hardcopy Color IOD is an abstraction of a printable 8 bit color image where annotation, overlays, and graphics may be burned in.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	HARDCOPY_COLOR_IMAGE_IOD The Constant HARDCOPY_COLOR_IMAGE_IOD.

Constructor Summary

Constructors

Constructor and Description
HardcopyColorImageIOD() Instantiates a new hardcopy color image iod.
HardcopyColorImageIOD(IDataSet objIDataSet_) This constructor accepts the DataSet from the user in its superclass IOD.
HardcopyColorImageIOD(IDictionaryReader objIDictionaryReader_) This constructor initializes the DictionaryReader in its superclass IOD.
HardcopyColorImageIOD(ITransferSyntax objITransferSyntax_) This constructor initializes the TransferSyntax in its superclass IOD.
HardcopyColorImageIOD(ITransferSyntax objITransferSyntax_, IDictionaryReader objIDictionaryReader_) This constructor initializes the TransferSyntax and DictionaryReader in its super class IOD.
HardcopyColorImageIOD(java.lang.String strFileName) Creates HardcopyColorImageIOD IOD from a DICOM file containing HardcopyColorImageIOD DICOM data.

Method Summary

Methods

Modifier and Type	Method and Description
void	dumpDICOMInfo(IDicomStream objIDicomStream) Dumps the Name of IOD,Module and corresponding Attributs of Module.
GeneralImageModule	getGeneralImageModule() Retrieves pre-initialized instance of General Image Module.
HardcopyEquipmentModule	getHardcopyEquipmentModule() Retrieves pre-initialized instance of Hardcopy Equipment Module.
HCColorImageModule	getHCColorImageModule() Retrieves pre-initialized instance of HC Color Image Module.
SOPCommonModule	getSOPCommonModule() Retrieves pre-initialized instance of SOP Common Module.
boolean	isModulePresent(java.lang.String strModuleName) Checks whether the Module is present in the IOD or not.
boolean	validate() This method validates Hardcopy Color Image IOD according to the Module Table given in The DICOM Standard.

Methods inherited from class cdac.medinfo.sdk.dcm30_04.dicommodel.modules.ImageIOD

getClinicalTrialSeriesModule, getGeneralEquipmentModule, getGeneralSeriesModule, getGeneralStudyModule, getImagePixelModule, getPatientModule, getPatientStudyModule

Methods inherited from class cdac.medinfo.sdk.dcm30_04.dicommodel.modules.CompositeIOD

getClinicalTrialStudyModule, getClinicalTrialSubjectModule

Methods inherited from class cdac.medinfo.sdk.dcm30_04.dicommodel.modules.IOD

addDataElement, getDataSet, getTransferSyntax, isPresent, removeDataElement, removeModule

Methods inherited from class java.lang.Object

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

Field Detail

HARDCOPY_COLOR_IMAGE_IOD

public static final java.lang.String HARDCOPY_COLOR_IMAGE_IOD

The Constant HARDCOPY_COLOR_IMAGE_IOD.

See Also:

Constant Field Values

Constructor Detail

HardcopyColorImageIOD

public HardcopyColorImageIOD()

Instantiates a new hardcopy color image iod.

HardcopyColorImageIOD

public HardcopyColorImageIOD(ITransferSyntax objITransferSyntax_)

This constructor initializes the TransferSyntax in its superclass IOD.

Parameters:

objITransferSyntax_ - - specifies the DICOM Standard defined TransfeSyntax.

HardcopyColorImageIOD

public HardcopyColorImageIOD(IDictionaryReader objIDictionaryReader_)

This constructor initializes the DictionaryReader in its superclass IOD.

Parameters:

objIDictionaryReader_ - - specifies the DICOM Dictionary reader to be used .

HardcopyColorImageIOD

public HardcopyColorImageIOD(IDataSet objIDataSet_)

This constructor accepts the DataSet from the user in its superclass IOD.

Parameters:

objIDataSet_ - - specifies the data set to be set in the IOD.

HardcopyColorImageIOD

public HardcopyColorImageIOD(ITransferSyntax objITransferSyntax_,
                     IDictionaryReader objIDictionaryReader_)

This constructor initializes the TransferSyntax and DictionaryReader in its super class IOD.

Parameters:

objITransferSyntax_ - specifies the DICOM Standard defined TransfeSyntax.

objIDictionaryReader_ - specifies the DICOM Dictionary reader to be used .

HardcopyColorImageIOD

public HardcopyColorImageIOD(java.lang.String strFileName)
                      throws java.io.IOException,
                             InvalidIODException

Creates HardcopyColorImageIOD IOD from a DICOM file containing HardcopyColorImageIOD DICOM data.

Parameters:

strFileName - DICOM File with absolute path.

Throws:

java.io.IOException - Exception caused due to wrong I/O operations.

ParseException - signals if some parse exceptions are occurred.

InvalidIODException - signals if some IOD exceptions are occurred.

Method Detail

getGeneralImageModule

public GeneralImageModule getGeneralImageModule()

Retrieves pre-initialized instance of General Image Module. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.

Returns:

GeneralImageModule - instance of GeneralImageModule.

getHardcopyEquipmentModule

public HardcopyEquipmentModule getHardcopyEquipmentModule()

Retrieves pre-initialized instance of Hardcopy Equipment Module. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.

Returns:

HardcopyEquipmentModule - instance of HardcopyEquipmentModule.

getHCColorImageModule

public HCColorImageModule getHCColorImageModule()

Retrieves pre-initialized instance of HC Color Image Module. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.

Returns:

HCColorImageModule - instance of HCColorImageModule.

getSOPCommonModule

public SOPCommonModule getSOPCommonModule()

Retrieves pre-initialized instance of SOP Common Module. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.

Returns:

SOPCommonModule - instance of SOPCommonModule.

validate

public boolean validate()
                 throws InvalidIODException

This method validates Hardcopy Color Image IOD according to the Module Table given in The DICOM Standard. The validate method fails if one of the mandatory modules are absent or any of the modules are invalid. The validate method also checks for conditional modules.

Overrides:

validate in class ImageIOD

Returns:

boolean - function status indicating success or failure

Throws:

InvalidIODException - - throws when the IOD is invalid.

dumpDICOMInfo

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

Dumps the Name of IOD,Module and corresponding Attributs of Module.

Overrides:

dumpDICOMInfo in class ImageIOD

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.

isModulePresent

public boolean isModulePresent(java.lang.String strModuleName)

Checks whether the Module is present in the IOD or not.

Overrides:

isModulePresent in class ImageIOD

Parameters:

strModuleName - String value of module name

Returns:

boolean - true if the module is present in the IOD, else false is returned.