cdac.medinfo.sdk.dcm30_04.dicommodel.xray

Class BreastTomosynthesisImageIOD

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.xray.BreastTomosynthesisImageIOD

public class BreastTomosynthesisImageIOD
extends ImageIOD

This class defines the Information Object for multi-dimensional reconstructed breast tomosynthesis X-Ray Images that includesthose data elements and information objects necessary for the interchange of multi-dimensional breast tomosynthesis X-Ray volumes

Author:

saloni

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
BreastTomosynthesisImageIOD() Instantiates a Breast Tomosynthesis Image IOD.
BreastTomosynthesisImageIOD(IDataSet objIDataSet_) This constructor accepts the DataSet from the user in its superclass IOD.
BreastTomosynthesisImageIOD(IDictionaryReader objIDictionaryReader_) This constructor initializes the DictionaryReader in its superclass IOD.
BreastTomosynthesisImageIOD(ITransferSyntax objITransferSyntax_) This constructor initializes the TransferSyntax in its superclass IOD.
BreastTomosynthesisImageIOD(ITransferSyntax objITransferSyntax_, IDictionaryReader objIDictionaryReader_) This constructor initializes the TransferSyntax and DictionaryReader in its super class IOD.
BreastTomosynthesisImageIOD(java.lang.String strFileName) Creates BreastTomosynthesisImageIOD IOD from a DICOM file containing BreastTomosynthesisImage DICOM data.

Method Summary

Methods

Modifier and Type	Method and Description
void	dumpDICOMInfo(IDicomStream objIDicomStream) Dumps the Name of IOD,Module and corresponding Attribute of Module.
AcquisitionContextModule	getAcquisitionContextModule() Retrieves pre-initialized instance of Acquisition Context Module.
BreastTomosynthesisAcquisitionModule	getBreastTomosynthesisAcquisitionModule() Retrieves pre-initialized instance of Breast Tomosynthesis Acquisition Module.
BreastTomosynthesisContributingSourcesModule	getBreastTomosynthesisContributingSourcesModule() Retrieves pre-initialized instance of Breast Tomosynthesis Contributing Sources Module.
BreastViewModule	getBreastViewModule() Retrieves pre-initialized instance of Breast View Module.
CommonInstanceReferenceModule	getCommonInstanceReferenceModule() Retrieves pre-initialized instance of Common Instance Reference Module.
DeviceModule	getDeviceModule() Retrieves pre-initialized instance of Device Module.
EnhancedContrastBolusModule	getEnhancedContrastBolusModule() Retrieves pre-initialized instance of Enhanced ContrastBolus Module.
EnhancedGeneralEquipmentModule	getEnhancedGeneralEquipmentModule() Retrieves pre-initialized instance of Enhanced General Equipment Module.
EnhancedMammographySeriesModule	getEnhancedMammographySeriesModule() Retrieves pre-initialized instance of Enhanced Mammography Series Module.
FrameExtractionModule	getFrameExtractionModule() Retrieves pre-initialized instance of Frame Extraction Module.
FrameOfReferenceModule	getFrameOfReferenceModule() Retrieves pre-initialized instance of Frame Of Reference Module.
ImageEquipmentCoordinateRelationshipModule	getImageEquipmentCoordinateRelationshipModule() Retrieves pre-initialized instance of Image Equipment Coordinate Relationship Module.
InterventionModule	getInterventionModule() Retrieves pre-initialized instance of Intervention Module.
MultiFrameDimensionModule	getMultiFrameDimensionModule() Retrieves pre-initialized instance of MultiFrame Dimension Module.
MultiFrameFunctionalGroupsModule	getMultiFrameFunctionalGroupsModule() Retrieves pre-initialized instance of MultiFrame Functional Groups 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.
XRay3DImageModule	getXRay3DImageModule() Retrieves pre-initialized instance of XRay 3D Image Module.
XRay3DReconstructionModule	getXRay3DReconstructionModule() Retrieves pre-initialized instance of XRay 3D Reconstruction Module.
boolean	isModulePresent(java.lang.String strModuleName) Checks whether the Module is present in the IOD or not.
boolean	validate() Validates all the modules 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

BREAST_TOMOSYNTHESIS_IMAGE_IOD

public static final java.lang.String BREAST_TOMOSYNTHESIS_IMAGE_IOD

The Constant BREAST_TOMOSYNTHESIS_IMAGE_IOD.

See Also:

Constant Field Values

Constructor Detail

BreastTomosynthesisImageIOD

public BreastTomosynthesisImageIOD()

Instantiates a Breast Tomosynthesis Image IOD.

BreastTomosynthesisImageIOD

public BreastTomosynthesisImageIOD(ITransferSyntax objITransferSyntax_)

This constructor initializes the TransferSyntax in its superclass IOD.

Parameters:

objITransferSyntax_ - - specifies the DICOM Standard defined TransfeSyntax.

BreastTomosynthesisImageIOD

public BreastTomosynthesisImageIOD(IDictionaryReader objIDictionaryReader_)

This constructor initializes the DictionaryReader in its superclass IOD.

Parameters:

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

BreastTomosynthesisImageIOD

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

BreastTomosynthesisImageIOD

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

BreastTomosynthesisImageIOD

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

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

getEnhancedMammographySeriesModule

public EnhancedMammographySeriesModule getEnhancedMammographySeriesModule()

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

EnhancedMammographySeriesModule - instance of EnhancedMammographySeriesModule.

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.

getEnhancedGeneralEquipmentModule

public EnhancedGeneralEquipmentModule getEnhancedGeneralEquipmentModule()

Retrieves pre-initialized instance of Enhanced General Equipment 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:

EnhancedGeneralEquipmentModule - instance of EnhancedGeneralEquipmentModule.

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.

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.

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.

getEnhancedContrastBolusModule

public EnhancedContrastBolusModule getEnhancedContrastBolusModule()

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

getInterventionModule

public InterventionModule getInterventionModule()

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

getMultiFrameFunctionalGroupsModule

public MultiFrameFunctionalGroupsModule getMultiFrameFunctionalGroupsModule()

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

getMultiFrameDimensionModule

public MultiFrameDimensionModule getMultiFrameDimensionModule()

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

getImageEquipmentCoordinateRelationshipModule

public ImageEquipmentCoordinateRelationshipModule getImageEquipmentCoordinateRelationshipModule()

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

ImageEquipmentCoordinateRelationshipModule - instance of ImageEquipmentCoordinateRelationshipModule.

getXRay3DImageModule

public XRay3DImageModule getXRay3DImageModule()

Retrieves pre-initialized instance of XRay 3D 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:

XRay3DImageModule - instance of XRay3DImageModule.

getBreastTomosynthesisContributingSourcesModule

public BreastTomosynthesisContributingSourcesModule getBreastTomosynthesisContributingSourcesModule()

Retrieves pre-initialized instance of Breast Tomosynthesis Contributing Sources 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:

BreastTomosynthesisContributingSourcesModule - instance of BreastTomosynthesisContributingSourcesModule.

getBreastTomosynthesisAcquisitionModule

public BreastTomosynthesisAcquisitionModule getBreastTomosynthesisAcquisitionModule()

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

BreastTomosynthesisAcquisitionModule - instance of BreastTomosynthesisAcquisitionModule.

getXRay3DReconstructionModule

public XRay3DReconstructionModule getXRay3DReconstructionModule()

Retrieves pre-initialized instance of XRay 3D 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:

XRay3DReconstructionModule - instance of XRay3DReconstructionModule.

getBreastViewModule

public BreastViewModule getBreastViewModule()

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

BreastViewModule - instance of BreastViewModule.

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

Validates all the modules 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 Attribute 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.