cdac.medinfo.sdk.dcm30_04.dicommodel.cr

Class CRIOD

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.cr.CRIOD

public class CRIOD
extends ImageIOD

This class depicts those components of the DICOM Information Model that directly reference the CR Image IOD.

Constructor Summary

Constructors

Constructor and Description
CRIOD() Instantiates a new cRIOD.
CRIOD(IDataSet objIDataSet_) This constructor accepts the DataSet from the user in its superclass IOD.
CRIOD(IDictionaryReader objIDictionaryReader_) This constructor initializes the DictionaryReader in its superclass IOD.
CRIOD(ITransferSyntax objITransferSyntax_) This constructor initializes the TransferSyntax in its superclass IOD.
CRIOD(ITransferSyntax objITransferSyntax_, IDictionaryReader objIDictionaryReader_) This constructor initializes the TransferSyntax and DictionaryReader in its super class IOD.
CRIOD(java.lang.String strFileName) Creates CRIOD IOD from a DICOM file containing CRIOD 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.
CommonInstanceReferenceModule	getCommonInstanceReferenceModule() Retrieves pre-initialized instance of Common Instance Reference Module.
ContrastBolusModule	getContrastBolusModule() Retrieves pre-initialized instance of Contrast Bolus Module.
CRImageModule	getCRImageModule() Retrieves pre-initialized instance of CR Image Module.
CRSeriesModule	getCRSeriesModule() Retrieves pre-initialized instance of CR Series Module.
DeviceModule	getDeviceModule() Retrieves pre-initialized instance of Device Module.
DisplayShutterModule	getDisplayShutterModule() Retrieves pre-initialized instance of Display Shutter Module.
GeneralImageModule	getGeneralImageModule() Retrieves pre-initialized instance of General Image Module.
ModalityLUTModule	getModalityLUTModule() Retrieves pre-initialized instance of Modality LUT Module.
OverlayPlaneModule	getOverlayPlaneModule() Retrieves pre-initialized instance of Overlay Plane Module.
SOPCommonModule	getSOPCommonModule() Retrieves pre-initialized instance of SOP Common Module.
SpecimenModule	getSpecimenModule() Retrieves pre-initialized instance of Specimen 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 CR 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

CRIOD

public CRIOD()

Instantiates a new cRIOD.

CRIOD

public CRIOD(ITransferSyntax objITransferSyntax_)

This constructor initializes the TransferSyntax in its superclass IOD.

Parameters:

objITransferSyntax_ - - specifies the DICOM Standard defined TransfeSyntax.

CRIOD

public CRIOD(IDictionaryReader objIDictionaryReader_)

This constructor initializes the DictionaryReader in its superclass IOD.

Parameters:

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

CRIOD

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

CRIOD

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

CRIOD

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

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

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.

getContrastBolusModule

public ContrastBolusModule getContrastBolusModule()

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.

Returns:

ContrastBolusModule - instance of ContrastBolusModule.

getCRSeriesModule

public CRSeriesModule getCRSeriesModule()

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

CRSeriesModule - instance of CRSeriesModule.

getCRImageModule

public CRImageModule getCRImageModule()

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

CRImageModule - instance of CRImageModule.

getDisplayShutterModule

public DisplayShutterModule getDisplayShutterModule()

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

DisplayShutterModule - instance of DisplayShutterModule.

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.

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.

getModalityLUTModule

public ModalityLUTModule getModalityLUTModule()

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

ModalityLUTModule - instance of ModalityLUTModule.

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.

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:

CommonInstanceReferenceModule - instance of CommonInstanceReferenceModule.

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