cdac.medinfo.sdk.dcm30_04.dicommodel.presentationstate

Class BlendingSoftcopyPresentationStateIOD

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

public class BlendingSoftcopyPresentationStateIOD
extends NonImageIOD

The Blending Softcopy Presentation State Information Object Definition (IOD) specifies information that may be used to blend two sets of images that are referenced from within the IOD for the purpose of presentation (display).

Author:

saloni

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	dumpDICOMInfo(IDicomStream objIDicomStream) Dumps the Name of Module and corresponding Attributs of IOD.
ClinicalTrialSeriesModule	getClinicalTrialSeriesModule() Gets the clinical trial series module.
ClinicalTrialStudyModule	getClinicalTrialStudyModule() This method returns the ClinicalTrialStudyModule with preinitializing it.
ClinicalTrialSubjectModule	getClinicalTrialSubjectModule() This method returns the ClinicalTrialSubjectModule with preinitializing it.
DisplayedAreaModule	getDisplayedAreaModule() Retrieves pre-initialized instance of DisplayedAreaModule.
EnhancedGeneralEquipmentModule	getEnhancedGeneralEquipmentModule() Retrieves pre-initialized instance of Enhanced General Equipment Module.
GeneralEquipmentModule	getGeneralEquipmentModule() This method returns the GeneralEquipmentModule with preinitializing it.
GeneralSeriesModule	getGeneralSeriesModule() This method returns the GeneralSeriesModule with preinitializing it.
GeneralStudyModule	getGeneralStudyModule() This method returns the GeneralStudyModule with preinitializing it.
GraphicAnnotationModule	getGraphicAnnotationModule() Retrieves pre-initialized instance of GraphicAnnotationModule.
GraphicGroupModule	getGraphicGroupModule() Retrieves pre-initialized instance of Graphic Group Module.
GraphicLayerModule	getGraphicLayerModule() Retrieves pre-initialized instance of GraphicLayerModule.
ICCProfileModule	getICCProfileModule() Retrieves pre-initialized instance of ICC Profile Module.
PaletteColorLookupTableModule	getPaletteColorLookupTableModule() Retrieves pre-initialized instance of Palette Color Lookup Table Module.
PatientModule	getPatientModule() This method returns the PatientModule with preinitializing it.
PatientStudyModule	getPatientStudyModule() This method returns the PatientStudyModule with preinitializing it.
PresentationStateBlendingModule	getPresentationStateBlendingModule() Retrieves pre-initialized instance of StructuredDisplayImageBoxModule.
PresentationStateIdentificationModule	getPresentationStateIdentificationModule() Retrieves pre-initialized instance of Presentation State Identification Module.
SOPCommonModule	getSOPCommonModule() Retrieves pre-initialized instance of SOP Common Module.
SpatialTransformationModule	getSpatialTransformationModule() Retrieves pre-initialized instance of SpatialTransformationModule.
StructuredDisplayAnnotationModule	getStructuredDisplayAnnotationModule() Retrieves pre-initialized instance of StructuredDisplayAnnotationModule .
boolean	isModulePresent(java.lang.String strModuleName) Checks whether the Module is present in the IOD or not.
boolean	validate() This method validates Image IOD according to the Module Table given in The DICOM Standard.

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

BLENDING_SOFT_COPY_PRESENTATION_STATE_IOD

public static final java.lang.String BLENDING_SOFT_COPY_PRESENTATION_STATE_IOD

The Constant BLENDING_SOFT_COPY_PRESENTATION_STATE_IOD.

See Also:

Constant Field Values

Constructor Detail

BlendingSoftcopyPresentationStateIOD

public BlendingSoftcopyPresentationStateIOD()

Instantiates a new image iod.

BlendingSoftcopyPresentationStateIOD

public BlendingSoftcopyPresentationStateIOD(ITransferSyntax objITransferSyntax_)

This constructor initializes the TransferSyntax in its superclass IOD.

Parameters:

objITransferSyntax_ - Transfer Syntax of IOD.

BlendingSoftcopyPresentationStateIOD

public BlendingSoftcopyPresentationStateIOD(IDictionaryReader objIDictionaryReader_)

This constructor initializes DictionaryReader in its superclass IOD.

Parameters:

objIDictionaryReader_ - Dictionary Reader used by the IOD.

BlendingSoftcopyPresentationStateIOD

public BlendingSoftcopyPresentationStateIOD(ITransferSyntax objITransferSyntax_,
                                    IDictionaryReader objIDictionaryReader_)

This constructor accepts the DictionaryReader and TransferSyntax from the user in its superclass IOD.

Parameters:

objITransferSyntax_ - Transfer Syntax of IOD.

objIDictionaryReader_ - Dictionary Reader used by the IOD.

BlendingSoftcopyPresentationStateIOD

public BlendingSoftcopyPresentationStateIOD(IDataSet objIDataSet_)

This constructor accepts the Data set from the user in its superclass IOD.

Parameters:

objIDataSet_ - the obj i data set_

BlendingSoftcopyPresentationStateIOD

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

Creates IOD from a DICOM file containing corresponding DICOM data.

Parameters:

strFileName - DICOM File with absolute path.

Throws:

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

ParseException - signals if some parse exceptions occurred.

InvalidIODException

Method Detail

getPatientModule

public PatientModule getPatientModule()

This method returns the PatientModule with preinitializing it.

Returns:

the patient module

getGeneralStudyModule

public GeneralStudyModule getGeneralStudyModule()

This method returns the GeneralStudyModule with preinitializing it.

Returns:

the general study module

getPatientStudyModule

public PatientStudyModule getPatientStudyModule()

This method returns the PatientStudyModule with preinitializing it.

Returns:

the patient study module

getClinicalTrialSeriesModule

public ClinicalTrialSeriesModule getClinicalTrialSeriesModule()

Gets the clinical trial series module.

Returns:

the clinical trial series module

getGeneralSeriesModule

public GeneralSeriesModule getGeneralSeriesModule()

This method returns the GeneralSeriesModule with preinitializing it.

Returns:

the general series module

getPaletteColorLookupTableModule

public PaletteColorLookupTableModule getPaletteColorLookupTableModule()

Retrieves pre-initialized instance of Palette Color Lookup Table 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:

PaletteColorLookupTableModule - instance of PaletteColorLookupTableModule.

getGeneralEquipmentModule

public GeneralEquipmentModule getGeneralEquipmentModule()

This method returns the GeneralEquipmentModule with preinitializing it.

Returns:

the general equipment module

getClinicalTrialSubjectModule

public ClinicalTrialSubjectModule getClinicalTrialSubjectModule()

This method returns the ClinicalTrialSubjectModule with preinitializing it.

Overrides:

getClinicalTrialSubjectModule in class CompositeIOD

Returns:

the clinical trial subject module

getClinicalTrialStudyModule

public ClinicalTrialStudyModule getClinicalTrialStudyModule()

This method returns the ClinicalTrialStudyModule with preinitializing it.

Overrides:

getClinicalTrialStudyModule in class CompositeIOD

Returns:

the clinical trial study module

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.

getEnhancedGeneralEquipmentModule

public EnhancedGeneralEquipmentModule getEnhancedGeneralEquipmentModule()

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

EnhancedGeneralEquipmentModule - instance of EnhancedGeneralEquipmentModule.

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.

getPresentationStateBlendingModule

public PresentationStateBlendingModule getPresentationStateBlendingModule()

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

PresentationStateBlendingModule - instance of PresentationStateBlendingModule.

getStructuredDisplayAnnotationModule

public StructuredDisplayAnnotationModule getStructuredDisplayAnnotationModule()

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

StructuredDisplayAnnotationModule - instance of StructuredDisplayAnnotationModule.

getDisplayedAreaModule

public DisplayedAreaModule getDisplayedAreaModule()

Retrieves pre-initialized instance of DisplayedAreaModule. 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 GraphicAnnotationModule. 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.

getGraphicLayerModule

public GraphicLayerModule getGraphicLayerModule()

Retrieves pre-initialized instance of GraphicLayerModule. 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.

getSpatialTransformationModule

public SpatialTransformationModule getSpatialTransformationModule()

Retrieves pre-initialized instance of SpatialTransformationModule. 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.

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 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:

- status of validation as success or failure

Throws:

InvalidIODException - the invalid iod exception

dumpDICOMInfo

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

Dumps the Name of Module and corresponding Attributs of IOD.

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.