cdac.medinfo.sdk.dcm30_04.dicommodel.ivoct

Class IntravascularOCTIOD

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.ivoct.IntravascularOCTIOD

public class IntravascularOCTIOD
extends ImageIOD

The Intravascular Optical Coherence Tomography Image IOD specifies a multi-frame image acquired on an Intravascular Optical Coherence Tomography modality

Author:

saloni

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
IntravascularOCTIOD() Instantiates a new Intravascular OCT IOD.
IntravascularOCTIOD(IDataSet objIDataSet_) This constructor accepts the DataSet from the user in its superclass IOD.
IntravascularOCTIOD(IDictionaryReader objIDictionaryReader_) This constructor initializes the DictionaryReader in its superclass IOD.
IntravascularOCTIOD(ITransferSyntax objITransferSyntax_) This constructor initializes the TransferSyntax in its superclass IOD.
IntravascularOCTIOD(ITransferSyntax objITransferSyntax_, IDictionaryReader objIDictionaryReader_) This constructor initializes the TransferSyntax and DictionaryReader in its super class IOD.
IntravascularOCTIOD(java.lang.String strFileName) Creates IntravascularOCTIOD IOD from a DICOM file containing IntravascularOCTIOD 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.
CardiacSynchronizationModule	getCardiacSynchronizationModule() Retrieves pre-initialized instance of Cardiac Synchronization 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 Contrast Bolus Module.
EnhancedGeneralEquipmentModule	getEnhancedGeneralEquipmentModule() Retrieves pre-initialized instance of Enhanced General Equipment Module.
FrameExtractionModule	getFrameExtractionModule() Retrieves pre-initialized instance of Frame Extraction Module.
FrameOfReferenceModule	getFrameOfReferenceModule() Retrieves pre-initialized instance of Frame Of Reference Module.
IntravascularImageAcquisitionParametersModule	getIntravascularImageAcquisitionParametersModule() Retrieves pre-initialized instance of Intravascular Image Acquisition Parameters Module.
IntravascularOCTAcquisitionParametersModule	getIntravascularOCTAcquisitionParametersModule() Retrieves pre-initialized instance of Intravascular OCT Acquisition Parameters Module.
IntravascularOCTImageModule	getIntravascularOCTImageModule() Retrieves pre-initialized instance of Intravascular OCT Image Module.
IntravascularOCTProcessingParametersModule	getIntravascularOCTProcessingParametersModule() Retrieves pre-initialized instance of Intravascular OCT Processing Parameters Module.
IntravascularOCTSeriesModule	getIntravascularOCTSeriesModule() Retrieves pre-initialized instance of Intravascular OCT Series Module.
MultiFrameDimensionModule	getMultiFrameDimensionModule() Retrieves pre-initialized instance of Multi Frame Dimension Module.
MultiFrameFunctionalGroupsModule	getMultiFrameFunctionalGroupsModule() Retrieves pre-initialized instance of Multi Frame Functional Groups Module.
SOPCommonModule	getSOPCommonModule() Retrieves pre-initialized instance of SOP Common Module.
SupplementalPaletteColorLookupTableModule	getSupplementalPaletteColorLookupTableModule() Retrieves pre-initialized instance of Supplemental Palette Color Lookup Table Module.
SynchronizationModule	getSynchronizationModule() Retrieves pre-initialized instance of Synchronization Module.
boolean	isModulePresent(java.lang.String strModuleName) Checks whether the Module is present in the IOD or not.
boolean	validate() This method validates Enhanced CT 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

INTRAVASCULAR_OCT_IOD

public static final java.lang.String INTRAVASCULAR_OCT_IOD

The Constant INTRAVASCULAR_OCT_IOD.

See Also:

Constant Field Values

Constructor Detail

IntravascularOCTIOD

public IntravascularOCTIOD()

Instantiates a new Intravascular OCT IOD.

IntravascularOCTIOD

public IntravascularOCTIOD(ITransferSyntax objITransferSyntax_)

This constructor initializes the TransferSyntax in its superclass IOD.

Parameters:

objITransferSyntax_ - - specifies the DICOM Standard defined TransfeSyntax.

IntravascularOCTIOD

public IntravascularOCTIOD(IDictionaryReader objIDictionaryReader_)

This constructor initializes the DictionaryReader in its superclass IOD.

Parameters:

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

IntravascularOCTIOD

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

IntravascularOCTIOD

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

IntravascularOCTIOD

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

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

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.

getCardiacSynchronizationModule

public CardiacSynchronizationModule getCardiacSynchronizationModule()

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

CardiacSynchronizationModule - instance of CardiacSynchronizationModule.

getEnhancedContrastBolusModule

public EnhancedContrastBolusModule getEnhancedContrastBolusModule()

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

EnhancedContrastBolusModule - instance of EnhancedContrastBolusModule.

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.

getMultiFrameDimensionModule

public MultiFrameDimensionModule getMultiFrameDimensionModule()

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

getMultiFrameFunctionalGroupsModule

public MultiFrameFunctionalGroupsModule getMultiFrameFunctionalGroupsModule()

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

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.

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.

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.

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.

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.

getIntravascularOCTSeriesModule

public IntravascularOCTSeriesModule getIntravascularOCTSeriesModule()

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

IntravascularOCTSeriesModule - instance of IntravascularOCTSeriesModule.

getSupplementalPaletteColorLookupTableModule

public SupplementalPaletteColorLookupTableModule getSupplementalPaletteColorLookupTableModule()

Retrieves pre-initialized instance of Supplemental Palette Color Lookup Table 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:

SupplementalPaletteColorLookupTableModule - instance of SupplementalPaletteColorLookupTableModule.

getIntravascularOCTImageModule

public IntravascularOCTImageModule getIntravascularOCTImageModule()

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

IntravascularOCTImageModule - instance of IntravascularOCTImageModule.

getIntravascularOCTAcquisitionParametersModule

public IntravascularOCTAcquisitionParametersModule getIntravascularOCTAcquisitionParametersModule()

Retrieves pre-initialized instance of Intravascular OCT Acquisition Parameters 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:

IntravascularOCTAcquisitionParametersModule - instance of IntravascularOCTAcquisitionParametersModule.

getIntravascularOCTProcessingParametersModule

public IntravascularOCTProcessingParametersModule getIntravascularOCTProcessingParametersModule()

Retrieves pre-initialized instance of Intravascular OCT Processing Parameters 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:

IntravascularOCTProcessingParametersModule - instance of IntravascularOCTProcessingParametersModule.

getIntravascularImageAcquisitionParametersModule

public IntravascularImageAcquisitionParametersModule getIntravascularImageAcquisitionParametersModule()

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

IntravascularImageAcquisitionParametersModule - instance of IntravascularImageAcquisitionParametersModule.

validate

public boolean validate()
                 throws InvalidIODException

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