cdac.medinfo.sdk.dcm30_04.dicommodel.us

Class EnhancedUSVolumeIOD

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.us.EnhancedUSVolumeIOD

public class EnhancedUSVolumeIOD
extends ImageIOD

This class contains those components of the DICOM Information Model that comprise the Enhanced US VolumeIOD.

Author:

saloni

Constructor Summary

Constructors

Constructor and Description
EnhancedUSVolumeIOD() Instantiates a new EnhancedUSVolumeIOD.
EnhancedUSVolumeIOD(IDataSet objIDataSet_) This constructor accepts the DataSet from the user in its superclass IOD.
EnhancedUSVolumeIOD(IDictionaryReader objIDictionaryReader_) This constructor initializes the DictionaryReader in its superclass IOD.
EnhancedUSVolumeIOD(ITransferSyntax objITransferSyntax_) This constructor initializes the TransferSyntax in its superclass IOD.
EnhancedUSVolumeIOD(ITransferSyntax objITransferSyntax_, IDictionaryReader objIDictionaryReader_) This constructor initializes the TransferSyntax and DictionaryReader in its super class IOD.
EnhancedUSVolumeIOD(java.lang.String strFileName) Creates EnhancedUSVolumeIOD IOD from a DICOM file containing EnhancedPETImageIOD 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.
AcquisitionContextModule	getAcquisitionContextModule() Retrieves pre-initialized instance of Acquisition Context Module.
CardiacSynchronizationModule	getCardiacSynchronizationModule() Retrieves pre-initialized instance of Cardiac Synchronization Module.
CommonInstanceReferenceModule	getCommonInstanceReferenceModule() Retrieves pre-initialized instance of Common Instance Reference Module.
DeviceModule	getDeviceModule() Retrieves pre-initialized instance of Device Module.
EnhancedContrastBolusModule	getEnhancedContrastBolusModule() Retrieves pre-initialized instance of Enhanced Contrast/Bolus Module.
EnhancedGeneralEquipmentModule	getEnhancedGeneralEquipmentModule() Retrieves pre-initialized instance of Enhanced General Equipment Module.
EnhancedPaletteColorLookupTableModule	getEnhancedPaletteColorLookupTableModule() Retrieves pre-initialized instance of EnhancedPaletteColorLookupTableModule.
EnhancedUSImageModule	getEnhancedUSImageModule() Retrieves pre-initialized instance of EnhancedUSImageModule.
EnhancedUSSeriesModule	getEnhancedUSSeriesModule() Retrieves pre-initialized instance of EnhancedUSSeriesModule.
ExcludedIntervalsModule	getExcludedIntervalsModule() Retrieves pre-initialized instance of ExcludedIntervalsModule.
FrameExtractionModule	getFrameExtractionModule() Retrieves pre-initialized instance of Frame Extraction Module.
FrameOfReferenceModule	getFrameOfReferenceModule() Retrieves pre-initialized instance of Frame of Reference Module.
GeneralImageModule	getGeneralImageModule() Retrieves pre-initialized instance of General Image Module.
ICCProfileModule	getICCProfileModule() Retrieves pre-initialized instance of ICC Profile Module.
IVUSImageModule	getIVUSImageModule() Retrieves pre-initialized instance of IVUSImageModule.
MultiFrameDimensionModule	getMultiFrameDimensionModule() Retrieves pre-initialized instance of Multi-frame Dimension Groups Module.
MultiFrameFunctionalGroupsModule	getMultiFrameFunctionalGroupsModule() Retrieves pre-initialized instance of Multi-frame Functional Groups Module.
RespiratorySynchronizationModule	getRespiratorySynchronizationModule() Retrieves pre-initialized instance of Respiratory Synchronization Module.
SOPCommonModule	getSOPCommonModule() Retrieves pre-initialized instance of SOP Common Module.
SpecimenModule	getSpecimenModule() Retrieves pre-initialized instance of Specimen Module.
SynchronizationModule	getSynchronizationModule() Retrieves pre-initialized instance of SynchronizationModule.
UltrasoundFrameofReferenceModule	getUltrasoundFrameofReferenceModule() Retrieves pre-initialized instance of UltrasoundFrame of Reference Module.
boolean	isModulePresent(java.lang.String strModuleName) Checks whether the Module is present in the IOD or not.
boolean	validate() This method validates EnhancedMRColorImageIOD Modules 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

Constructor Detail

EnhancedUSVolumeIOD

public EnhancedUSVolumeIOD()

Instantiates a new EnhancedUSVolumeIOD.

EnhancedUSVolumeIOD

public EnhancedUSVolumeIOD(ITransferSyntax objITransferSyntax_)

This constructor initializes the TransferSyntax in its superclass IOD.

Parameters:

objITransferSyntax_ - - specifies the DICOM Standard defined TransfeSyntax.

EnhancedUSVolumeIOD

public EnhancedUSVolumeIOD(IDictionaryReader objIDictionaryReader_)

This constructor initializes the DictionaryReader in its superclass IOD.

Parameters:

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

EnhancedUSVolumeIOD

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

EnhancedUSVolumeIOD

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

EnhancedUSVolumeIOD

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

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

getEnhancedUSSeriesModule

public EnhancedUSSeriesModule getEnhancedUSSeriesModule()

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

EnhancedPETSeriesModule - instance of EnhancedUSSeriesModule.

getFrameOfReferenceModule

public FrameOfReferenceModule getFrameOfReferenceModule()

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

FrameOfReferenceModule - instance of FrameOfReferenceModule.

getUltrasoundFrameofReferenceModule

public UltrasoundFrameofReferenceModule getUltrasoundFrameofReferenceModule()

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

UltrasoundFrameofReferenceModule - instance of UltrasoundFrameofReferenceModule.

getSynchronizationModule

public SynchronizationModule getSynchronizationModule()

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

SynchronizationModule - instance of SynchronizationModule.

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.

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.

getEnhancedContrastBolusModule

public EnhancedContrastBolusModule getEnhancedContrastBolusModule()

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

EnhancedContrastBolusModule - instance of EnhancedContrastBolusModule.

getMultiFrameFunctionalGroupsModule

public MultiFrameFunctionalGroupsModule getMultiFrameFunctionalGroupsModule()

Retrieves pre-initialized instance of Multi-frame Functional Groups 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:

MultiFrameFunctionalGroupsModule - instance of MultiFrameFunctionalGroupsModule.

getMultiFrameDimensionModule

public MultiFrameDimensionModule getMultiFrameDimensionModule()

Retrieves pre-initialized instance of Multi-frame Dimension Groups 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:

MultiFrameDimensionModule - instance of MultiFrameDimensionModule.

getCardiacSynchronizationModule

public CardiacSynchronizationModule getCardiacSynchronizationModule()

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

CardiacSynchronizationModule - instance of CardiacSynchronizationModule.

getRespiratorySynchronizationModule

public RespiratorySynchronizationModule getRespiratorySynchronizationModule()

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

RespiratorySynchronizationModule - instance of RespiratorySynchronizationModule.

getAcquisitionContextModule

public AcquisitionContextModule getAcquisitionContextModule()

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

AcquisitionContextModule - instance of AcquisitionContextModule.

getSpecimenModule

public SpecimenModule getSpecimenModule()

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

SpecimenModule - instance of SpecimenModule.

getDeviceModule

public DeviceModule getDeviceModule()

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

DeviceModule - instance of DeviceModule.

getEnhancedPaletteColorLookupTableModule

public EnhancedPaletteColorLookupTableModule getEnhancedPaletteColorLookupTableModule()

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

EnhancedPaletteColorLookupTableModule - instance of EnhancedPaletteColorLookupTableModule.

getEnhancedUSImageModule

public EnhancedUSImageModule getEnhancedUSImageModule()

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

EnhancedUSImageModule - instance of EnhancedUSImageModule.

getIVUSImageModule

public IVUSImageModule getIVUSImageModule()

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

IVUSImageModule - instance of IVUSImageModule.

getExcludedIntervalsModule

public ExcludedIntervalsModule getExcludedIntervalsModule()

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

ExcludedIntervalsModule - instance of ExcludedIntervalsModule.

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.

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:

objSOPCommonModule - instance of objSOPCommonModule.

getCommonInstanceReferenceModule

public CommonInstanceReferenceModule getCommonInstanceReferenceModule()

Retrieves pre-initialized instance of Common Instance Reference 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:

objSOPCommonModule - instance of CommonInstanceReferenceModule.

getFrameExtractionModule

public FrameExtractionModule getFrameExtractionModule()

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

objFrameExtractionModule - instance of FrameExtractionModule.

validate

public boolean validate()
                 throws InvalidIODException

This method validates EnhancedMRColorImageIOD Modules 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 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.