cdac.medinfo.sdk.dcm30_04.dicommodel.grayscalesoftcopy

Class XAOrXRFGrayscaleSoftcopyPresentationStateIOD

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.grayscalesoftcopy.XAOrXRFGrayscaleSoftcopyPresentationStateIOD

public class XAOrXRFGrayscaleSoftcopyPresentationStateIOD
extends ImageIOD

The XA/XRF Grayscale Softcopy Presentation State Information Object Definition (IOD) specifies information that may be used topresent angiographic projection images that are referenced from within the IOD.

Author:

saloni

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
XAOrXRFGrayscaleSoftcopyPresentationStateIOD() Instantiates a new XAOrXRFGrayscaleSoftcopyPresentationStateIOD
XAOrXRFGrayscaleSoftcopyPresentationStateIOD(IDataSet objIDataSet_) This constructor accepts the DataSet from the user in its superclass IOD.
XAOrXRFGrayscaleSoftcopyPresentationStateIOD(IDictionaryReader objIDictionaryReader_) This constructor initializes the DictionaryReader in its superclass IOD.
XAOrXRFGrayscaleSoftcopyPresentationStateIOD(ITransferSyntax objITransferSyntax_) This constructor initializes the TransferSyntax in its superclass IOD.
XAOrXRFGrayscaleSoftcopyPresentationStateIOD(ITransferSyntax objITransferSyntax_, IDictionaryReader objIDictionaryReader_) This constructor initializes the TransferSyntax and DictionaryReader in its super class IOD.
XAOrXRFGrayscaleSoftcopyPresentationStateIOD(java.lang.String strFileName) Creates XAOrXRFGrayscaleSoftcopyPresentationStateIOD IOD from a DICOM file containing XAOrXRFGrayscaleSoftcopyPresentationStateIOD 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 ClinicalTrialSeriesModule.
DisplayedAreaModule	getDisplayedAreaModule() Retrieves pre-initialized instance of DisplayedAreaModule.
EnhancedGeneralEquipmentModule	getEnhancedGeneralEquipmentModule() Retrieves pre-initialized instance of EnhancedGeneralEquipmentModule.
GraphicAnnotationModule	getGraphicAnnotationModule() Retrieves pre-initialized instance of GraphicAnnotationModule.
GraphicLayerModule	getGraphicLayerModule() Retrieves pre-initialized instance of GraphicLayerModule.
OverlayActivationModule	getOverlayActivationModule() Retrieves pre-initialized instance of OverlayActivationModule.
OverlayPlaneModule	getOverlayPlaneModule() Retrieves pre-initialized instance of OverlayPlaneModule.
PresentationSeriesModule	getPresentationSeriesModule() Retrieves pre-initialized instance of PresentationSeriesModule.
PresentationStateIdentificationModule	getPresentationStateIdentificationModule() Retrieves pre-initialized instance of PresentationStateIdentificationModule.
PresentationStateRelationshipModule	getPresentationStateRelationshipModule() Retrieves pre-initialized instance of Presentation State RelationshipModule.
PresentationStateShutterModule	getPresentationStateShutterModule() Retrieves pre-initialized instance of Presentation State Shutter Module.
SoftcopyPresentationLUTModule	getSoftcopyPresentationLUTModule() Retrieves pre-initialized instance of SoftcopyPresentationLUTModule.
SoftcopyVOILUTModule	getSoftcopyVOILUTModule() Retrieves pre-initialized instance of SoftcopyVOILUTModule.
SOPCommonModule	getSOPCommonModule() Retrieves pre-initialized instance of SOPCommonModule.
SpatialTransformationModule	getSpatialTransformationModule() Retrieves pre-initialized instance of SpatialTransformationModule.
XAXRFPresentationStateMaskModule	getXAXRFPresentationStateMaskModule() Retrieves pre-initialized instance of XAXRFPresentationStateMaskModule.
XAXRFPresentationStatePresentationModule	getXAXRFPresentationStatePresentationModule() Retrieves pre-initialized instance of XAXRFPresentationStatePresentationModule.
XAXRFPresentationStateShutterModule	getXAXRFPresentationStateShutterModule() Retrieves pre-initialized instance of XAXRFPresentationStateShutterModule.
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 PseudoColorSoftcopyPresentationStateIOD according to the Module Table given in The DICOM Standard.

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

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

XAXRF_Grayscale_Softcopy_Presentation_State_IOD

public static final java.lang.String XAXRF_Grayscale_Softcopy_Presentation_State_IOD

The Constant Pseudo_Color_Softcopy_Presentation_State_IOD.

See Also:

Constant Field Values

Constructor Detail

XAOrXRFGrayscaleSoftcopyPresentationStateIOD

public XAOrXRFGrayscaleSoftcopyPresentationStateIOD()

Instantiates a new XAOrXRFGrayscaleSoftcopyPresentationStateIOD

XAOrXRFGrayscaleSoftcopyPresentationStateIOD

public XAOrXRFGrayscaleSoftcopyPresentationStateIOD(ITransferSyntax objITransferSyntax_)

This constructor initializes the TransferSyntax in its superclass IOD.

Parameters:

objITransferSyntax_ - - specifies the DICOM Standard defined TransfeSyntax.

XAOrXRFGrayscaleSoftcopyPresentationStateIOD

public XAOrXRFGrayscaleSoftcopyPresentationStateIOD(IDictionaryReader objIDictionaryReader_)

This constructor initializes the DictionaryReader in its superclass IOD.

Parameters:

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

XAOrXRFGrayscaleSoftcopyPresentationStateIOD

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

XAOrXRFGrayscaleSoftcopyPresentationStateIOD

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

XAOrXRFGrayscaleSoftcopyPresentationStateIOD

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

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

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.

getClinicalTrialSeriesModule

public ClinicalTrialSeriesModule getClinicalTrialSeriesModule()

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

Overrides:

getClinicalTrialSeriesModule in class ImageIOD

Returns:

ClinicalTrialSeriesModule - instance of ClinicalTrialSeriesModule.

getPresentationSeriesModule

public PresentationSeriesModule getPresentationSeriesModule()

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

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.

getXAXRFPresentationStatePresentationModule

public XAXRFPresentationStatePresentationModule getXAXRFPresentationStatePresentationModule()

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

XAXRFPresentationStatePresentationModule - instance of DisplayShutterModule.

getEnhancedGeneralEquipmentModule

public EnhancedGeneralEquipmentModule getEnhancedGeneralEquipmentModule()

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

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.

getXAXRFPresentationStateMaskModule

public XAXRFPresentationStateMaskModule getXAXRFPresentationStateMaskModule()

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

XAXRFPresentationStateMaskModule - instance of XAXRFPresentationStateMaskModule.

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.

getXAXRFPresentationStateShutterModule

public XAXRFPresentationStateShutterModule getXAXRFPresentationStateShutterModule()

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

XAXRFPresentationStateShutterModule - instance of XAXRFPresentationStateShutterModule.

getOverlayActivationModule

public OverlayActivationModule getOverlayActivationModule()

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

OverlayActivationModule - instance of OverlayActivationModule.

getOverlayPlaneModule

public OverlayPlaneModule getOverlayPlaneModule()

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

getSoftcopyPresentationLUTModule

public SoftcopyPresentationLUTModule getSoftcopyPresentationLUTModule()

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

SoftcopyPresentationLUTModule - instance of SoftcopyPresentationLUTModule.

getPresentationStateIdentificationModule

public PresentationStateIdentificationModule getPresentationStateIdentificationModule()

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

getSoftcopyVOILUTModule

public SoftcopyVOILUTModule getSoftcopyVOILUTModule()

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

SoftcopyVOILUTModule - instance of SoftcopyVOILUTModule.

getSOPCommonModule

public SOPCommonModule getSOPCommonModule()

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

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.

getPresentationStateRelationshipModule

public PresentationStateRelationshipModule getPresentationStateRelationshipModule()

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

validate

public boolean validate()
                 throws InvalidIODException

This method validates Non-Image IOD PseudoColorSoftcopyPresentationStateIOD 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 - 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 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.