cdac.medinfo.sdk.dcm30_04.dicommodel.nm

Class NMIOD

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.nm.NMIOD

public class NMIOD
extends ImageIOD

The Nuclear Medicine (NM) Image Information Object Definition (IOD) specifies an image that has been created by a nuclear medicine imaging device. This class exhibits different functional behavour of the NM IOD.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
NMIOD() Instantiates a new nMIOD.
NMIOD(IDataSet objIDataSet_) This constructor accepts the DataSet from the user in its superclass IOD.
NMIOD(IDictionaryReader objIDictionaryReader_) This constructor initializes the DictionaryReader in its superclass IOD.
NMIOD(ITransferSyntax objITransferSyntax_) This constructor initializes the TransferSyntax in its superclass IOD.
NMIOD(ITransferSyntax objITransferSyntax_, IDictionaryReader objIDictionaryReader_) This constructor initializes the TransferSyntax and DictionaryReader in its super class IOD.
NMIOD(java.lang.String strFileName) Creates NMIOD IOD from a DICOM file containing NMIOD 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.
CurveModule	getCurveModule() Retrieves pre-initialized instance of Curve Module.
FrameOfReferenceModule	getFrameOfReferenceModule() Retrieves pre-initialized instance of Frame Of Reference Module.
GeneralImageModule	getGeneralImageModule() Retrieves pre-initialized instance of General Image Module.
MultiFrameModule	getMultiFrameModule() Retrieves pre-initialized instance of Multi Frame Module.
MultiFrameOverlayModule	getMultiFrameOverlayModule() Retrieves pre-initialized instance of Multi Frame Overlay Module.
NMDetectorModule	getNMDetectorModule() Retrieves pre-initialized instance of NM Detector Module.
NMImageModule	getNMImageModule() Retrieves pre-initialized instance of NM Image Module.
NMImagePixelModule	getNMImagePixelModule() Retrieves pre-initialized instance of NM Image Pixel Module.
NMIsotopeModule	getNMIsotopeModule() Retrieves pre-initialized instance of NM Isotope Module.
NMMultiFrameModule	getNMMultiFrameModule() Retrieves pre-initialized instance of NM Multi Frame Module.
NMMultiGatedAcquisitionModule	getNMMultiGatedAcquisitionModule() Retrieves pre-initialized instance of NM Multi Gated Acquisition Module.
NMOrPETPatientOrientationModule	getNMOrPETPatientOrientationModule() Retrieves pre-initialized instance of NM Or PET Patient Orientation Module.
NMPhaseModule	getNMPhaseModule() Retrieves pre-initialized instance of NM Phase Module.
NMReconstructionModule	getNMReconstructionModule() Retrieves pre-initialized instance of NM Reconstruction Module.
NMTOMOAcquisitionModule	getNMTOMOAcquisitionModule() Retrieves pre-initialized instance of NM TO MO Acquisition Module.
OverlayPlaneModule	getOverlayPlaneModule() Retrieves pre-initialized instance of Overlay Plane Module.
SOPCommonModule	getSOPCommonModule() Retrieves pre-initialized instance of SOP Common Module.
SynchronizationModule	getSynchronizationModule() Retrieves pre-initialized instance of Synchronization Module.
VOILUTModule	getVOILUTModule() Retrieves pre-initialized instance of VOI LUT Module.
boolean	isModulePresent(java.lang.String strModuleName) Checks whether the Module is present in the IOD or not.
boolean	validate() This method validates NM 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

NM_IOD

public static final java.lang.String NM_IOD

The Constant NM_IOD.

See Also:

Constant Field Values

Constructor Detail

NMIOD

public NMIOD()

Instantiates a new nMIOD.

NMIOD

public NMIOD(ITransferSyntax objITransferSyntax_)

This constructor initializes the TransferSyntax in its superclass IOD.

Parameters:

objITransferSyntax_ - - specifies the DICOM Standard defined TransfeSyntax.

NMIOD

public NMIOD(IDictionaryReader objIDictionaryReader_)

This constructor initializes the DictionaryReader in its superclass IOD.

Parameters:

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

NMIOD

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

NMIOD

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

NMIOD

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

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

getNMOrPETPatientOrientationModule

public NMOrPETPatientOrientationModule getNMOrPETPatientOrientationModule()

Retrieves pre-initialized instance of NM Or PET Patient Orientation 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:

NMOrPETPatientOrientationModule - instance of NMOrPETPatientOrientationModule.

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.

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.

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.

getOverlayPlaneModule

public OverlayPlaneModule getOverlayPlaneModule()

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

OverlayPlaneModule - instance of OverlayPlaneModule.

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.

getNMImagePixelModule

public NMImagePixelModule getNMImagePixelModule()

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

NMImagePixelModule - instance of NMImagePixelModule.

getMultiFrameModule

public MultiFrameModule getMultiFrameModule()

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

MultiFrameModule - instance of MultiFrameModule.

getNMMultiFrameModule

public NMMultiFrameModule getNMMultiFrameModule()

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

NMMultiFrameModule - instance of NMMultiFrameModule.

getNMImageModule

public NMImageModule getNMImageModule()

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

NMImageModule - instance of NMImageModule.

getNMIsotopeModule

public NMIsotopeModule getNMIsotopeModule()

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

NMIsotopeModule - instance of NMIsotopeModule.

getNMDetectorModule

public NMDetectorModule getNMDetectorModule()

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

NMDetectorModule - instance of NMDetectorModule.

getNMTOMOAcquisitionModule

public NMTOMOAcquisitionModule getNMTOMOAcquisitionModule()

Retrieves pre-initialized instance of NM TO MO Acquisition 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:

NMTOMOAcquisitionModule - instance of NMTOMOAcquisitionModule.

getNMMultiGatedAcquisitionModule

public NMMultiGatedAcquisitionModule getNMMultiGatedAcquisitionModule()

Retrieves pre-initialized instance of NM Multi Gated Acquisition 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:

NMMultiGatedAcquisitionModule - instance of NMMultiGatedAcquisitionModule.

getNMPhaseModule

public NMPhaseModule getNMPhaseModule()

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

NMPhaseModule - instance of NMPhaseModule.

getNMReconstructionModule

public NMReconstructionModule getNMReconstructionModule()

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

NMReconstructionModule - instance of NMReconstructionModule.

getMultiFrameOverlayModule

public MultiFrameOverlayModule getMultiFrameOverlayModule()

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

MultiFrameOverlayModule - instance of MultiFrameOverlayModule.

getCurveModule

public CurveModule getCurveModule()

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

CurveModule - instance of CurveModule.

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.

getVOILUTModule

public VOILUTModule getVOILUTModule()

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

VOILUTModule - instance of VOILUTModule.

validate

public boolean validate()
                 throws InvalidIODException

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