cdac.medinfo.sdk.dcm30_04.dicommodel.spatialfiducials

Class SpatialFiducialsIOD

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

cdac.medinfo.sdk.dcm30_04.dicommodel.spatialfiducials.SpatialFiducialsIOD

public class SpatialFiducialsIOD
extends NonImageIOD

The Fiducials IOD specifies the spatial relationship between the Composite Fiducial instance, to one or more images.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
SpatialFiducialsIOD() Instantiates a new spatial fiducials iod.
SpatialFiducialsIOD(IDataSet objIDataSet_) This constructor accepts the DataSet from the user in its superclass IOD.
SpatialFiducialsIOD(IDictionaryReader objIDictionaryReader_) This constructor initializes the DictionaryReader in its superclass IOD.
SpatialFiducialsIOD(ITransferSyntax objITransferSyntax_) This constructor initializes the TransferSyntax in its superclass IOD.
SpatialFiducialsIOD(ITransferSyntax objITransferSyntax_, IDictionaryReader objIDictionaryReader_) This constructor initializes the TransferSyntax and DictionaryReader in its super class IOD.
SpatialFiducialsIOD(java.lang.String strFileName) Creates SpatialFiducialsIOD IOD from a DICOM file containing SpatialFiducialsIOD 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.
ClinicalTrialSeriesModule	getClinicalTrialSeriesModule() Retrieves pre-initialized instance of ClinicalTrialSeriesModule.
CommonInstanceReferenceModule	getCommonInstanceReferenceModule() Retrieves pre-initialized instance of CommonInstanceReferenceModule.
GeneralEquipmentModule	getGeneralEquipmentModule() Retrieves pre-initialized instance of GeneralEquipmentModule.
GeneralSeriesModule	getGeneralSeriesModule() Retrieves pre-initialized instance of GeneralSeriesModule.
GeneralStudyModule	getGeneralStudyModule() Retrieves pre-initialized instance of GeneralStudyModule.
PatientModule	getPatientModule() Retrieves pre-initialized instance of PatientModule.
PatientStudyModule	getPatientStudyModule() Retrieves pre-initialized instance of PatientStudyModule.
SOPCommonModule	getSOPCommonModule() Retrieves pre-initialized instance of SOPCommonModule.
SpatialFiducialsModule	getSpatialFiducialsModule() Retrieves pre-initialized instance of SpatialFiducialsModule.
SpatialFiducialsSeriesModule	getSpatialFiducialsSeriesModule() Retrieves pre-initialized instance of SpatialFiducialsSeriesModule.
boolean	isModulePresent(java.lang.String strModuleName) Checks whether the Module is present in the IOD or not.
boolean	validate() This method validates Non-Image IOD Spatial Fiducials IOD according to the Module Table given in The DICOM Standard.

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

SPATIAL_FIDUCIALS_IOD

public static final java.lang.String SPATIAL_FIDUCIALS_IOD

The Constant SPATIAL_FIDUCIALS_IOD.

See Also:

Constant Field Values

Constructor Detail

SpatialFiducialsIOD

public SpatialFiducialsIOD()

Instantiates a new spatial fiducials iod.

SpatialFiducialsIOD

public SpatialFiducialsIOD(ITransferSyntax objITransferSyntax_)

This constructor initializes the TransferSyntax in its superclass IOD.

Parameters:

objITransferSyntax_ - - specifies the DICOM Standard defined TransfeSyntax.

SpatialFiducialsIOD

public SpatialFiducialsIOD(IDictionaryReader objIDictionaryReader_)

This constructor initializes the DictionaryReader in its superclass IOD.

Parameters:

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

SpatialFiducialsIOD

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

SpatialFiducialsIOD

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

SpatialFiducialsIOD

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

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

getPatientModule

public PatientModule getPatientModule()

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

PatientModule - instance of PatientModule.

getGeneralStudyModule

public GeneralStudyModule getGeneralStudyModule()

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

GeneralStudyModule - instance of GeneralStudyModule.

getPatientStudyModule

public PatientStudyModule getPatientStudyModule()

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

PatientStudyModule - instance of PatientStudyModule.

getClinicalTrialSeriesModule

public ClinicalTrialSeriesModule getClinicalTrialSeriesModule()

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

ClinicalTrialSeriesModule - instance of ClinicalTrialSeriesModule.

getGeneralSeriesModule

public GeneralSeriesModule getGeneralSeriesModule()

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

GeneralSeriesModule - instance of GeneralSeriesModule.

getGeneralEquipmentModule

public GeneralEquipmentModule getGeneralEquipmentModule()

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

GeneralEquipmentModule - instance of GeneralEquipmentModule.

getSOPCommonModule

public SOPCommonModule getSOPCommonModule()

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

getSpatialFiducialsSeriesModule

public SpatialFiducialsSeriesModule getSpatialFiducialsSeriesModule()

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

SpatialFiducialsSeriesModule - instance of SpatialFiducialsSeriesModule.

getSpatialFiducialsModule

public SpatialFiducialsModule getSpatialFiducialsModule()

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

SpatialFiducialsModule - instance of SpatialFiducialsModule.

getCommonInstanceReferenceModule

public CommonInstanceReferenceModule getCommonInstanceReferenceModule()

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

validate

public boolean validate()
                 throws InvalidIODException

This method validates Non-Image IOD Spatial Fiducials 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 NonImageIOD

Returns:

boolean - status of validation as 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 CompositeIOD

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 NonImageIOD

Parameters:

strModuleName - String value of module name

Returns:

boolean - true if the module is present in the IOD, else false is returned.