cdac.medinfo.sdk.dcm30_04.dicommodel.parametricmap

Class ParametricMapIOD

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.parametricmap.ParametricMapIOD

public class ParametricMapIOD
extends ImageIOD

The Parametric Map Information Object Definition (IOD) specifies a multi-frame image representing pixels with real world values.Parametric Maps are either integer or floating point.

Author:

saloni

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
ParametricMapIOD() Instantiates a new ParametricMapIOD
ParametricMapIOD(IDataSet objIDataSet_) This constructor accepts the DataSet from the user in its superclass IOD.
ParametricMapIOD(IDictionaryReader objIDictionaryReader_) This constructor initializes the DictionaryReader in its superclass IOD.
ParametricMapIOD(ITransferSyntax objITransferSyntax_) This constructor initializes the TransferSyntax in its superclass IOD.
ParametricMapIOD(ITransferSyntax objITransferSyntax_, IDictionaryReader objIDictionaryReader_) This constructor initializes the TransferSyntax and DictionaryReader in its super class IOD.
ParametricMapIOD(java.lang.String strFileName) Creates ParametricMapIOD IOD from a DICOM file containing ParametricMapIOD 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.
BulkMotionSynchronizationModule	getBulkMotionSynchronizationModule() Retrieves pre-initialized instance of Bulk Motion Synchronization Module.
CardiacSynchronizationModule	getCardiacSynchronizationModule() Retrieves pre-initialized instance of Cardiac Synchronization Module.
ClinicalTrialSeriesModule	getClinicalTrialSeriesModule() Retrieves pre-initialized instance of Contrast Bolus Module.
CommonInstanceReferenceModule	getCommonInstanceReferenceModule() Retrieves pre-initialized instance of objCommon Instance Reference Module.
DeviceModule	getDeviceModule() Retrieves pre-initialized instance of Device Module.
DoubleFloatingPointImagePixelModule	getDoubleFloatingPointImagePixelModule() Retrieves pre-initialized instance of DoubleFloatingPointImagePixel Module.
EnhancedGeneralEquipmentModule	getEnhancedGeneralEquipmentModule() Retrieves pre-initialized instance of SynchronizationModule.
FloatingPointImagePixelModule	getFloatingPointImagePixelModule() Retrieves pre-initialized instance of FloatingPointImagePixel Module.
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.
MultiFrameDimensionModule	getMultiFrameDimensionModule() Retrieves pre-initialized instance of Multi Frame Dimension Module.
MultiFrameFunctionalGroupsModule	getMultiFrameFunctionalGroupsModule() Retrieves pre-initialized instance of Multi Frame Functional Groups Module.
ParametricMapImageModule	getParametricMapImageModule() Retrieves pre-initialized instance of ParametricMapImage Module.
ParametricMapSeriesModule	getParametricMapSeriesModule() Retrieves pre-initialized instance of ParametricMapSeries 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.
boolean	isModulePresent(java.lang.String strModuleName) Checks whether the Module is present in the IOD or not.
boolean	validate() This method validates ParametricMapIOD 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

PARAMETRIC_MAP_IOD

public static final java.lang.String PARAMETRIC_MAP_IOD

The Constant ENHANCED_MR_IOD.

See Also:

Constant Field Values

Constructor Detail

ParametricMapIOD

public ParametricMapIOD()

Instantiates a new ParametricMapIOD

ParametricMapIOD

public ParametricMapIOD(ITransferSyntax objITransferSyntax_)

This constructor initializes the TransferSyntax in its superclass IOD.

Parameters:

objITransferSyntax_ - - specifies the DICOM Standard defined TransfeSyntax.

ParametricMapIOD

public ParametricMapIOD(IDictionaryReader objIDictionaryReader_)

This constructor initializes the DictionaryReader in its superclass IOD.

Parameters:

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

ParametricMapIOD

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

ParametricMapIOD

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

ParametricMapIOD

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

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

getClinicalTrialSeriesModule

public ClinicalTrialSeriesModule getClinicalTrialSeriesModule()

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

Overrides:

getClinicalTrialSeriesModule in class ImageIOD

Returns:

ContrastBolusModule - instance of ContrastBolusModule.

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.

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.

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.

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.

getFloatingPointImagePixelModule

public FloatingPointImagePixelModule getFloatingPointImagePixelModule()

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

FloatingPointImagePixelModule - instance of FloatingPointImagePixelModule.

getDoubleFloatingPointImagePixelModule

public DoubleFloatingPointImagePixelModule getDoubleFloatingPointImagePixelModule()

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

DoubleFloatingPointImagePixelModule - instance of DoubleFloatingPointImagePixelModule.

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.

getParametricMapImageModule

public ParametricMapImageModule getParametricMapImageModule()

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

ParametricMapImageModule - instance of ParametricMapImageModule.

getParametricMapSeriesModule

public ParametricMapSeriesModule getParametricMapSeriesModule()

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

ParametricMapSeriesModule - instance of ParametricMapSeriesModule.

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.

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.

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.

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