cdac.medinfo.sdk.dcm30_04.dicommodel.pet

Class PETIOD

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.pet.PETIOD

public class PETIOD
extends ImageIOD

The Positron Emission Tomography (PET) Image Information Object Definition specifies an image that has been created by a Positron Tomograph imaging device, including dedicated PET cameras and Nuclear Medicine imaging devices operating in coincidence mode. This includes data created by external detection devices that create images of the distribution of administered radioactive materials, specifically positron emitters, in the body. Depending on the specific radiopharmaceuticals administered and the particular imaging procedure performed, problems involving changes in metabolism, function, or physiology can be investigated and various region pathologies can be studied. For these problems, quantitation of image data in absolute activity and physiological units is important. In addition, the PET Image IOD specifies attenuation (transmission) images used for correction and anatomical reference of emission images.

Constructor Summary

Constructors

Constructor and Description
PETIOD() Instantiates a new pETIOD.
PETIOD(IDataSet objIDataSet_) This constructor accepts the DataSet from the user in its superclass IOD.
PETIOD(IDictionaryReader objIDictionaryReader_) This constructor initializes the DictionaryReader in its superclass IOD.
PETIOD(ITransferSyntax objITransferSyntax_) This constructor initializes the TransferSyntax in its superclass IOD.
PETIOD(ITransferSyntax objITransferSyntax_, IDictionaryReader objIDictionaryReader_) This constructor initializes the TransferSyntax and DictionaryReader in its super class IOD.
PETIOD(java.lang.String strFileName) Creates PETIOD IOD from a DICOM file containing PETIOD 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.
CommonInstanceReferenceModule	getCommonInstanceReferenceModule() Retrieves pre-initialized instance of Common Instance Reference Module.
DeviceModule	getDeviceModule() Retrieves pre-initialized instance of Device Module.
FrameOfReferenceModule	getFrameOfReferenceModule() Retrieves pre-initialized instance of Frame Of Reference Module.
GeneralImageModule	getGeneralImageModule() Retrieves pre-initialized instance of General Image Module.
ImagePlaneModule	getImagePlaneModule() Retrieves pre-initialized instance of Image Plane Module.
NMOrPETPatientOrientationModule	getNMOrPETPatientOrientationModule() Retrieves pre-initialized instance of NM Or PET Patient Orientation Module.
OverlayPlaneModule	getOverlayPlaneModule() Retrieves pre-initialized instance of Overlay Plane Module.
PETImageModule	getPETImageModule() Retrieves pre-initialized instance of PET Image Module.
PETIsotopeModule	getPETIsotopeModule() Retrieves pre-initialized instance of PET Isotope Module.
PETMultiGatedAcquisitionModule	getPETMultiGatedAcquisitionModule() Retrieves pre-initialized instance of PET Multi Gated Acquisition Module.
PETSeriesModule	getPETSeriesModule() Retrieves pre-initialized instance of PET Series 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 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 PET 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

Constructor Detail

PETIOD

public PETIOD()

Instantiates a new pETIOD.

PETIOD

public PETIOD(ITransferSyntax objITransferSyntax_)

This constructor initializes the TransferSyntax in its superclass IOD.

Parameters:

objITransferSyntax_ - - specifies the DICOM Standard defined TransfeSyntax.

PETIOD

public PETIOD(IDictionaryReader objIDictionaryReader_)

This constructor initializes the DictionaryReader in its superclass IOD.

Parameters:

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

PETIOD

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

PETIOD

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

PETIOD

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

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

getPETSeriesModule

public PETSeriesModule getPETSeriesModule()

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

PETSeriesModule - instance of PETSeriesModule.

getPETIsotopeModule

public PETIsotopeModule getPETIsotopeModule()

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

PETIsotopeModule - instance of PETIsotopeModule.

getPETMultiGatedAcquisitionModule

public PETMultiGatedAcquisitionModule getPETMultiGatedAcquisitionModule()

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

PETMultiGatedAcquisitionModule - instance of PETMultiGatedAcquisitionModule.

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.

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.

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.

getImagePlaneModule

public ImagePlaneModule getImagePlaneModule()

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

ImagePlaneModule - instance of ImagePlaneModule.

getPETImageModule

public PETImageModule getPETImageModule()

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

PETImageModule - instance of PETImageModule.

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.

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.

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.

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

- instance of CommonInstanceReferenceModule.

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.

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.

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.

validate

public boolean validate()
                 throws InvalidIODException

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