cdac.medinfo.sdk.dcm30_04.dicommodel.mri

Class EnhancedMRImageIOD

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

public class EnhancedMRImageIOD
extends ImageIOD

The Enhanced Magnetic Resonance (MR) Image Information Object Definition (IOD) specifies an image, which has been created by a magnetic resonance device.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
EnhancedMRImageIOD() Instantiates a new enhanced mr image iod.
EnhancedMRImageIOD(IDataSet objIDataSet_) This constructor accepts the DataSet from the user in its superclass IOD.
EnhancedMRImageIOD(IDictionaryReader objIDictionaryReader_) This constructor initializes the DictionaryReader in its superclass IOD.
EnhancedMRImageIOD(ITransferSyntax objITransferSyntax_) This constructor initializes the TransferSyntax in its superclass IOD.
EnhancedMRImageIOD(ITransferSyntax objITransferSyntax_, IDictionaryReader objIDictionaryReader_) This constructor initializes the TransferSyntax and DictionaryReader in its super class IOD.
EnhancedMRImageIOD(java.lang.String strFileName) Creates EnhancedMRImageIOD IOD from a DICOM file containing EnhancedMRImageIOD 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 Acquisition Context Module.
BulkMotionSynchronizationModule	getBulkMotionSynchronizationModule() Retrieves pre-initialized instance of Bulk Motion Synchronization Module.
CardiacSynchronizationModule	getCardiacSynchronizationModule() Retrieves pre-initialized instance of Cardiac Synchronization Module.
CommonInstanceReferenceModule	getCommonInstanceReferenceModule() Retrieves pre-initialized instance of objCommon Instance Reference Module.
DeviceModule	getDeviceModule() Retrieves pre-initialized instance of Device Module.
EnhancedContrastBolusModule	getEnhancedContrastBolusModule() Retrieves pre-initialized instance of Enhanced Contrast Bolus Module.
EnhancedMRImageModule	getEnhancedMRImageModule() Retrieves pre-initialized instance of Enhanced MR Image Module.
FrameExtractionModule	getFrameExtractionModule() Retrieves pre-initialized instance of Frame Extraction Module.
FrameOfReferenceModule	getFrameOfReferenceModule() Retrieves pre-initialized instance of Frame Of Reference Module.
ICCProfileModule	getICCProfileModule() Retrieves pre-initialized instance of ICCProfile Module.
MRPulseSequenceModule	getMRPulseSequenceModule() Retrieves pre-initialized instance of MR Pulse Sequence Module.
MRSeriesModule	getMRSeriesModule() Retrieves pre-initialized instance of MR Series Module.
MultiFrameDimensionModule	getMultiFrameDimensionModule() Retrieves pre-initialized instance of Multi Frame Dimension Module.
MultiFrameFunctionalGroupsModule	getMultiFrameFunctionalGroupsModule() Retrieves pre-initialized instance of Multi Frame Functional Groups Module.
RespiratorySynchronizationModule	getRespiratorySynchronizationModule() Retrieves pre-initialized instance of Respiratory Synchronization Module.
SoftcopyPresentationLUTModule	getSoftcopyPresentationLUTModule() Retrieves pre-initialized instance of Softcopy Presentation LUT Module.
SOPCommonModule	getSOPCommonModule() Retrieves pre-initialized instance of SOP Common Module.
SpecimenIdentificationModule	getSpecimenIdentificationModule() Retrieves pre-initialized instance of Specimen Identification Module.
SpecimenModule	getSpecimenModule() Retrieves pre-initialized instance of Specimen Module.
SupplementalPaletteColorLookupTableModule	getSupplementalPaletteColorLookupTableModule() Retrieves pre-initialized instance of Supplemental Palette Color Lookup Table Module.
SynchronizationModule	getSynchronizationModule() Retrieves pre-initialized instance of Synchronization Module.
boolean	isModulePresent(java.lang.String strModuleName) Checks whether the Module is present in the IOD or not.
boolean	validate() This method validates Enhanced MR IOD 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

Field Detail

ENHANCED_MR_IOD

public static final java.lang.String ENHANCED_MR_IOD

The Constant ENHANCED_MR_IOD.

See Also:

Constant Field Values

Constructor Detail

EnhancedMRImageIOD

public EnhancedMRImageIOD()

Instantiates a new enhanced mr image iod.

EnhancedMRImageIOD

public EnhancedMRImageIOD(ITransferSyntax objITransferSyntax_)

This constructor initializes the TransferSyntax in its superclass IOD.

Parameters:

objITransferSyntax_ - - specifies the DICOM Standard defined TransfeSyntax.

EnhancedMRImageIOD

public EnhancedMRImageIOD(IDictionaryReader objIDictionaryReader_)

This constructor initializes the DictionaryReader in its superclass IOD.

Parameters:

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

EnhancedMRImageIOD

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

EnhancedMRImageIOD

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

EnhancedMRImageIOD

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

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

getBulkMotionSynchronizationModule

public BulkMotionSynchronizationModule getBulkMotionSynchronizationModule()

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

BulkMotionSynchronizationModule - instance of BulkMotionSynchronizationModule.

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.

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.

getEnhancedMRImageModule

public EnhancedMRImageModule getEnhancedMRImageModule()

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

EnhancedMRImageModule - instance of EnhancedMRImageModule.

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.

getMRPulseSequenceModule

public MRPulseSequenceModule getMRPulseSequenceModule()

Retrieves pre-initialized instance of MR Pulse Sequence 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:

MRPulseSequenceModule - instance of MRPulseSequenceModule.

getMRSeriesModule

public MRSeriesModule getMRSeriesModule()

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

MRSeriesModule - instance of MRSeriesModule.

getMultiFrameDimensionModule

public MultiFrameDimensionModule getMultiFrameDimensionModule()

Retrieves pre-initialized instance of Multi Frame Dimension 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.

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.

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.

getSoftcopyPresentationLUTModule

public SoftcopyPresentationLUTModule getSoftcopyPresentationLUTModule()

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

SoftcopyPresentationLUTModule - instance of SoftcopyPresentationLUTModule.

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.

getSpecimenIdentificationModule

public SpecimenIdentificationModule getSpecimenIdentificationModule()

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

SpecimenIdentificationModule - instance of SpecimenIdentificationModule.

getSupplementalPaletteColorLookupTableModule

public SupplementalPaletteColorLookupTableModule getSupplementalPaletteColorLookupTableModule()

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

SupplementalPaletteColorLookupTableModule - instance of SupplementalPaletteColorLookupTableModule.

getSynchronizationModule

public SynchronizationModule getSynchronizationModule()

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

SynchronizationModule - instance of SynchronizationModule.

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.

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.

getICCProfileModule

public ICCProfileModule getICCProfileModule()

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

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 Enhanced MR 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 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 Attributs 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.