cdac.medinfo.sdk.dcm30_04.dicommodel.mri

Class MRSpectroscopyIOD

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.mri.MRSpectroscopyIOD

public class MRSpectroscopyIOD
extends NonImageIOD

This class represents MR Spectroscopy Information Object Definition. The instance members suggest that these are the modules contained in the MR Spectroscopy IOD. This class exhibits different functional behavour of the MR Spectroscopy IOD.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
MRSpectroscopyIOD() Instantiates a new mR spectroscopy iod.
MRSpectroscopyIOD(IDataSet objIDataSet_) This constructor accepts the DataSet from the user in its superclass IOD.
MRSpectroscopyIOD(IDictionaryReader objIDictionaryReader_) This constructor initializes the DictionaryReader in its superclass IOD.
MRSpectroscopyIOD(ITransferSyntax objITransferSyntax_) This constructor initializes the TransferSyntax in its superclass IOD.
MRSpectroscopyIOD(ITransferSyntax objITransferSyntax_, IDictionaryReader objIDictionaryReader_) This constructor initializes the TransferSyntax and DictionaryReader in its super class IOD.
MRSpectroscopyIOD(java.lang.String strFileName) Creates MRSpectroscopyIOD IOD from a DICOM file containing MRSpectroscopyIOD 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.
AcquisitionContextModule	getAcquisitionContextModule() Retrieves pre-initialized instance of AcquisitionContextModule.
BulkMotionSynchronizationModule	getBulkMotionSynchronizationModule() Retrieves pre-initialized instance of BulkMotionSynchronizationModule.
CardiacSynchronizationModule	getCardiacSynchronizationModule() Retrieves pre-initialized instance of objCardiacModuleSynchronizationModule.
ClinicalTrialSeriesModule	getClinicalTrialSeriesModule() Retrieves pre-initialized instance of objClinicalTrialSeriesModule.
CommonInstanceReferenceModule	getCommonInstanceReferenceModule() Retrieves pre-initialized instance of objCommon Instance Reference Module.
EnhancedContrastBolusModule	getEnhancedContrastBolusModule() Retrieves pre-initialized instance of EnhancedContrastBolusModule.
EnhancedGeneralEquipmentModule	getEnhancedGeneralEquipmentModule() Retrieves pre-initialized instance of SynchronizationModule.
FrameExtractionModule	getFrameExtractionModule() Retrieves pre-initialized instance of Frame Extraction Module.
FrameOfReferenceModule	getFrameOfReferenceModule() Retrieves pre-initialized instance of FrameOfReferenceModule.
GeneralEquipmentModule	getGeneralEquipmentModule() Retrieves pre-initialized instance of GeneralEquipmentModule.
GeneralSeriesModule	getGeneralSeriesModule() Retrieves pre-initialized instance of GeneralSeriesModule.
GeneralStudyModule	getGeneralStudyModule() Retrieves pre-initialized instance of GeneralStudyModule.
MRSeriesModule	getMRSeriesModule() Retrieves pre-initialized instance of MRSeriesModule.
MRSpectroscopyDataModule	getMRSpectroscopyDataModule() Retrieves pre-initialized instance of MRSpectroscopyDataModule.
MRSpectroscopyModule	getMRSpectroscopyModule() Retrieves pre-initialized instance of MRSpectroscopyModule.
MRSpectroscopyPulseSequenceModule	getMRSpectroscopyModulePulseSequenceModule() Retrieves pre-initialized instance of MRSpectroscopyModulePulseSequenceModule.
MultiFrameDimensionModule	getMultiFrameDimensionModule() Retrieves pre-initialized instance of MultiFrameDimensionModule.
MultiFrameFunctionalGroupsModule	getMultiFrameFunctionalGroupsModule() Retrieves pre-initialized instance of MultiFrameFunctionalGroupsModule.
PatientModule	getPatientModule() Retrieves pre-initialized instance of PatientModule.
PatientStudyModule	getPatientStudyModule() Retrieves pre-initialized instance of PatientStudyModule.
RespiratorySynchronizationModule	getRespiratorySynchronizationModule() Retrieves pre-initialized instance of RespiratorySynchronizationModule.
SOPCommonModule	getSOPCommonModule() Retrieves pre-initialized instance of SOPCommonModule.
SpecimenModule	getSpecimenModule() Retrieves pre-initialized instance of Specimen Module.
SynchronizationModule	getSynchronizationModule() Retrieves pre-initialized instance of SynchronizationModule.
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 MR Spectroscopy 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

MR_SPECTROSCOPY_IOD

public static final java.lang.String MR_SPECTROSCOPY_IOD

The Constant MR_SPECTROSCOPY_IOD.

See Also:

Constant Field Values

Constructor Detail

MRSpectroscopyIOD

public MRSpectroscopyIOD()

Instantiates a new mR spectroscopy iod.

MRSpectroscopyIOD

public MRSpectroscopyIOD(ITransferSyntax objITransferSyntax_)

This constructor initializes the TransferSyntax in its superclass IOD.

Parameters:

objITransferSyntax_ - - specifies the DICOM Standard defined TransfeSyntax.

MRSpectroscopyIOD

public MRSpectroscopyIOD(IDictionaryReader objIDictionaryReader_)

This constructor initializes the DictionaryReader in its superclass IOD.

Parameters:

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

MRSpectroscopyIOD

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

MRSpectroscopyIOD

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

MRSpectroscopyIOD

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

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

getAcquisitionContextModule

public AcquisitionContextModule getAcquisitionContextModule()

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

objAcquisitionContextModule - instance of AcquisitionContextModule.

getBulkMotionSynchronizationModule

public BulkMotionSynchronizationModule getBulkMotionSynchronizationModule()

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

objBulkMotionSynchronizationModule - instance of BulkMotionSynchronizationModule.

getCardiacSynchronizationModule

public CardiacSynchronizationModule getCardiacSynchronizationModule()

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

objCardiacModuleSynchronizationModule - instance of objCardiacModuleSynchronizationModule.

getClinicalTrialSeriesModule

public ClinicalTrialSeriesModule getClinicalTrialSeriesModule()

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

objClinicalTrialSeriesModule - instance of objClinicalTrialSeriesModule.

getEnhancedContrastBolusModule

public EnhancedContrastBolusModule getEnhancedContrastBolusModule()

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

objEnhancedContrastBolusModule - instance of EnhancedContrastBolusModule.

getFrameOfReferenceModule

public FrameOfReferenceModule getFrameOfReferenceModule()

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

objFrameOfReferenceModule - instance of FrameOfReferenceModule.

getGeneralEquipmentModule

public GeneralEquipmentModule getGeneralEquipmentModule()

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

objGeneralEquipmentModule - instance of objGeneralEquipmentModule.

getGeneralSeriesModule

public GeneralSeriesModule getGeneralSeriesModule()

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

objGeneralSeriesModule - instance of GeneralSeriesModule.

getGeneralStudyModule

public GeneralStudyModule getGeneralStudyModule()

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

objGeneralStudyModule - instance of GeneralStudyModule.

getMRSeriesModule

public MRSeriesModule getMRSeriesModule()

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

objMRSeriesModule - instance of MRSeriesModule.

getMRSpectroscopyDataModule

public MRSpectroscopyDataModule getMRSpectroscopyDataModule()

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

objMRSpectroscopyDataModule - instance of MRSpectroscopyDataModule.

getMRSpectroscopyModule

public MRSpectroscopyModule getMRSpectroscopyModule()

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

objMRSpectroscopyModule - instance of MRSpectroscopyModule.

getMRSpectroscopyModulePulseSequenceModule

public MRSpectroscopyPulseSequenceModule getMRSpectroscopyModulePulseSequenceModule()

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

objMRSpectroscopyModulePulseSequenceModule - instance of MRSpectroscopyModulePulseSequenceModule.

getMultiFrameDimensionModule

public MultiFrameDimensionModule getMultiFrameDimensionModule()

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

objMultiFrameDimensionModule - instance of MultiFrameDimensionModule.

getMultiFrameFunctionalGroupsModule

public MultiFrameFunctionalGroupsModule getMultiFrameFunctionalGroupsModule()

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

objMultiFrameFunctionalGroupsModule - instance of MultiFrameFunctionalGroupsModule.

getPatientModule

public PatientModule getPatientModule()

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

objPatientModule - instance of PatientModule.

getPatientStudyModule

public PatientStudyModule getPatientStudyModule()

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

objPatientStudyModule - instance of PatientStudyModule.

getRespiratorySynchronizationModule

public RespiratorySynchronizationModule getRespiratorySynchronizationModule()

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

objRespiratorySynchronizationModule - instance of RespiratorySynchronizationModule.

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:

objSOPCommonModule - instance of SOPCommonModule.

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:

objSynchronizationModule - instance of SynchronizationModule.

getEnhancedGeneralEquipmentModule

public EnhancedGeneralEquipmentModule getEnhancedGeneralEquipmentModule()

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:

objSynchronizationModule - instance of SynchronizationModule.

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.

getCommonInstanceReferenceModule

public CommonInstanceReferenceModule getCommonInstanceReferenceModule()

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

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

FrameExtractionModule - instance of FrameExtractionModule.

validate

public boolean validate()
                 throws InvalidIODException

This method validates Non-Image IOD MR Spectroscopy 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 Attributs 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.