cdac.medinfo.sdk.dcm30_04.dicommodel.presentationstate

Class ColorSoftcopyPresentationStateIOD

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.NonImageIOD

cdac.medinfo.sdk.dcm30_04.dicommodel.presentationstate.ColorSoftcopyPresentationStateIOD

public class ColorSoftcopyPresentationStateIOD
extends NonImageIOD

The Color Softcopy Presentation State Information Object Definition (IOD) specifies information that may be used to present (display)color images that are referenced from within the IOD.

Author:

saloni

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
ColorSoftcopyPresentationStateIOD() This constructor initializes the TransferSyntax, Dictionary Reader and data set in its superclass IOD.
ColorSoftcopyPresentationStateIOD(IDataSet objIDataSet_) This constructor accepts the DataSet from the user in its superclass IOD.
ColorSoftcopyPresentationStateIOD(IDictionaryReader objIDictionaryReader_) This constructor initializes the DictionaryReader in its superclass IOD.
ColorSoftcopyPresentationStateIOD(ITransferSyntax objITransferSyntax_) This constructor initializes the TransferSyntax in its superclass IOD.
ColorSoftcopyPresentationStateIOD(ITransferSyntax objITransferSyntax_, IDictionaryReader objIDictionaryReader_) This constructor initializes the TransferSyntax and DictionaryReader in its super class IOD.
ColorSoftcopyPresentationStateIOD(java.lang.String strFileName) Creates ColorSoftcopyPresentationStateIOD IOD from a DICOM file containing ColorSoftcopyPresentationStateIOD DICOM data.

Method Summary

Methods

Modifier and Type	Method and Description
void	dumpDICOMInfo(IDicomStream objIDicomStream) Dumps the Name of IOD,Module and corresponding Attributes of Module.
BitmapDisplayShutterModule	getBitmapDisplayShutterModule() Retrieves pre-initialized instance of Bitmap Display Shutter Module.
ClinicalTrialSeriesModule	getClinicalTrialSeriesModule() Retrieves pre-initialized instance of Clinical Trial Series Module.
DisplayedAreaModule	getDisplayedAreaModule() Retrieves pre-initialized instance of Displayed Area Module.
DisplayShutterModule	getDisplayShutterModule() Retrieves pre-initialized instance of Display Shutter Module.
GeneralEquipmentModule	getGeneralEquipmentModule() Retrieves pre-initialized instance of General Equipment Module.
GeneralSeriesModule	getGeneralSeriesModule() Retrieves pre-initialized instance of General Series Module.
GeneralStudyModule	getGeneralStudyModule() Retrieves pre-initialized instance of General Study Module.
GraphicAnnotationModule	getGraphicAnnotationModule() Retrieves pre-initialized instance of Graphic Annotation Module.
GraphicGroupModule	getGraphicGroupModule() Retrieves pre-initialized instance of Graphic Group Module.
GraphicLayerModule	getGraphicLayerModule() Retrieves pre-initialized instance of Graphic Layer Module.
ICCProfileModule	getICCProfileModule() Retrieves pre-initialized instance of ICC Profile Module.
OverlayPlaneModule	getOverlayPlaneModule() Retrieves pre-initialized instance of Overlay Plane Module.
PatientModule	getPatientModule() Retrieves pre-initialized instance of Patient Module.
PatientStudyModule	getPatientStudyModule() Retrieves pre-initialized instance of Patient Study Module.
PresentationSeriesModule	getPresentationSeriesModule() Retrieves pre-initialized instance of Presentation Series Module.
PresentationStateIdentificationModule	getPresentationStateIdentificationModule() Retrieves pre-initialized instance of Presentation State Identification Module.
PresentationStateRelationshipModule	getPresentationStateRelationshipModule() Retrieves pre-initialized instance of Presentation State Relationship Module.
PresentationStateShutterModule	getPresentationStateShutterModule() Retrieves pre-initialized instance of Presentation State Shutter Module.
SOPCommonModule	getSOPCommonModule() Retrieves pre-initialized instance of SOP Common Module.
SpatialTransformationModule	getSpatialTransformationModule() Retrieves pre-initialized instance of Spatial Transformation Module.
boolean	isModulePresent(java.lang.String strModuleName) Checks whether the Module is present in the IOD or not.
boolean	validate() This method validates Non-Image IOD according to the Module Table given in The DICOM Standard.

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

COLOR_SOFTCOPY_PRESENTATION_STATE_IOD

public static final java.lang.String COLOR_SOFTCOPY_PRESENTATION_STATE_IOD

The Constant COLOR_SOFTCOPY_PRESENTATION_STATE_IOD.

See Also:

Constant Field Values

Constructor Detail

ColorSoftcopyPresentationStateIOD

public ColorSoftcopyPresentationStateIOD()

This constructor initializes the TransferSyntax, Dictionary Reader and data set in its superclass IOD.

ColorSoftcopyPresentationStateIOD

public ColorSoftcopyPresentationStateIOD(ITransferSyntax objITransferSyntax_)

This constructor initializes the TransferSyntax in its superclass IOD.

Parameters:

objITransferSyntax_ - - specifies the DICOM Standard defined TransfeSyntax.

ColorSoftcopyPresentationStateIOD

public ColorSoftcopyPresentationStateIOD(IDictionaryReader objIDictionaryReader_)

This constructor initializes the DictionaryReader in its superclass IOD.

Parameters:

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

ColorSoftcopyPresentationStateIOD

public ColorSoftcopyPresentationStateIOD(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.

ColorSoftcopyPresentationStateIOD

public ColorSoftcopyPresentationStateIOD(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 .

ColorSoftcopyPresentationStateIOD

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

Creates ColorSoftcopyPresentationStateIOD IOD from a DICOM file containing ColorSoftcopyPresentationStateIOD 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

getPatientModule

public PatientModule getPatientModule()

Retrieves pre-initialized instance of Patient 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:

PatientModule - instance of PatientModule.

getGeneralStudyModule

public GeneralStudyModule getGeneralStudyModule()

Retrieves pre-initialized instance of General Study 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:

GeneralStudyModule - instance of GeneralStudyModule.

getPatientStudyModule

public PatientStudyModule getPatientStudyModule()

Retrieves pre-initialized instance of Patient Study 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:

PatientStudyModule - instance of PatientStudyModule.

getGeneralSeriesModule

public GeneralSeriesModule getGeneralSeriesModule()

Retrieves pre-initialized instance of General Series 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:

GeneralSeriesModule - instance of GeneralSeriesModule.

getClinicalTrialSeriesModule

public ClinicalTrialSeriesModule getClinicalTrialSeriesModule()

Retrieves pre-initialized instance of Clinical Trial Series 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:

ClinicalTrialSeriesModule - instance of ClinicalTrialSeriesModule.

getGeneralEquipmentModule

public GeneralEquipmentModule getGeneralEquipmentModule()

Retrieves pre-initialized instance of General 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:

GeneralEquipmentModule - instance of GeneralEquipmentModule.

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.

getPresentationSeriesModule

public PresentationSeriesModule getPresentationSeriesModule()

Retrieves pre-initialized instance of Presentation Series 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:

PresentationSeriesModule - instance of PresentationSeriesModule.

getPresentationStateIdentificationModule

public PresentationStateIdentificationModule getPresentationStateIdentificationModule()

Retrieves pre-initialized instance of Presentation State Identification 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:

PresentationStateIdentificationModule - instance of PresentationStateIdentificationModule.

getPresentationStateRelationshipModule

public PresentationStateRelationshipModule getPresentationStateRelationshipModule()

Retrieves pre-initialized instance of Presentation State Relationship 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:

PresentationStateRelationshipModule - instance of PresentationStateRelationshipModule.

getPresentationStateShutterModule

public PresentationStateShutterModule getPresentationStateShutterModule()

Retrieves pre-initialized instance of Presentation State Shutter 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:

PresentationStateShutterModule - instance of PresentationStateShutterModule.

getDisplayShutterModule

public DisplayShutterModule getDisplayShutterModule()

Retrieves pre-initialized instance of Display Shutter 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:

DisplayShutterModule - instance of DisplayShutterModule.

getBitmapDisplayShutterModule

public BitmapDisplayShutterModule getBitmapDisplayShutterModule()

Retrieves pre-initialized instance of Bitmap Display Shutter 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:

BitmapDisplayShutterModule - instance of BitmapDisplayShutterModule.

getOverlayPlaneModule

public OverlayPlaneModule getOverlayPlaneModule()

Retrieves pre-initialized instance of Overlay Plane 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:

OverlayPlaneModule - instance of OverlayPlaneModule.

getDisplayedAreaModule

public DisplayedAreaModule getDisplayedAreaModule()

Retrieves pre-initialized instance of Displayed Area 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:

DisplayedAreaModule - instance of DisplayedAreaModule.

getGraphicAnnotationModule

public GraphicAnnotationModule getGraphicAnnotationModule()

Retrieves pre-initialized instance of Graphic Annotation 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:

GraphicAnnotationModule - instance of GraphicAnnotationModule.

getSpatialTransformationModule

public SpatialTransformationModule getSpatialTransformationModule()

Retrieves pre-initialized instance of Spatial Transformation 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:

SpatialTransformationModule - instance of SpatialTransformationModule.

getGraphicLayerModule

public GraphicLayerModule getGraphicLayerModule()

Retrieves pre-initialized instance of Graphic Layer 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:

GraphicLayerModule - instance of GraphicLayerModule.

getGraphicGroupModule

public GraphicGroupModule getGraphicGroupModule()

Retrieves pre-initialized instance of Graphic Group 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:

GraphicGroupModule - instance of GraphicGroupModule.

getICCProfileModule

public ICCProfileModule getICCProfileModule()

Retrieves pre-initialized instance of ICC Profile 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:

ICCProfileModule - instance of ICCProfileModule.

validate

public boolean validate()
                 throws InvalidIODException

This method validates Non-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 NonImageIOD

Returns:

boolean - status of validation as 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 Attributes of Module.

Overrides:

dumpDICOMInfo in class CompositeIOD

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 NonImageIOD

Parameters:

strModuleName - String value of module name

Returns:

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