cdac.medinfo.sdk.dcm30_04.dicommodel.visiblelight

Class VLWholeSlideMicroscopyImageIOD

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.visiblelight.VLWholeSlideMicroscopyImageIOD

public class VLWholeSlideMicroscopyImageIOD
extends ImageIOD

The VL Whole Slide Microscopy Image IOD specifies the Attributes of a multi-frame visible light whole slide microscopy image encodedas a tiled decomposition.

Author:

saloni

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
VLWholeSlideMicroscopyImageIOD() Instantiates a new VL Whole Slide Microscopy Image IOD.
VLWholeSlideMicroscopyImageIOD(IDataSet objIDataSet_) This constructor accepts the DataSet from the user in its superclass IOD.
VLWholeSlideMicroscopyImageIOD(IDictionaryReader objIDictionaryReader_) This constructor initializes the DictionaryReader in its superclass IOD.
VLWholeSlideMicroscopyImageIOD(ITransferSyntax objITransferSyntax_) This constructor initializes the TransferSyntax in its superclass IOD.
VLWholeSlideMicroscopyImageIOD(ITransferSyntax objITransferSyntax_, IDictionaryReader objIDictionaryReader_) This constructor initializes the TransferSyntax and DictionaryReader in its super class IOD.
VLWholeSlideMicroscopyImageIOD(java.lang.String strFileName) Creates VLWholeSlideMicroscopyImageIOD IOD from a DICOM file containing VLWholeSlideMicroscopyImageIOD 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 AcquisitionContextModule.
ClinicalTrialSeriesModule	getClinicalTrialSeriesModule() Retrieves pre-initialized instance of objClinicalTrialSeriesModule.
CommonInstanceReferenceModule	getCommonInstanceReferenceModule() Retrieves pre-initialized instance of Common Instance Reference Module.
EnhancedGeneralEquipmentModule	getEnhancedGeneralEquipmentModule() Retrieves pre-initialized instance of EnhancedGeneralEquipmentModule.
FrameExtractionModule	getFrameExtractionModule() Retrieves pre-initialized instance of Frame Extraction Module .
FrameOfReferenceModule	getFrameOfReferenceModule() Retrieves pre-initialized instance of Frame Of Reference Module.
GeneralEquipmentModule	getGeneralEquipmentModule() Retrieves pre-initialized instance of GeneralEquipmentModule.
GeneralImageModule	getGeneralImageModule() Retrieves pre-initialized instance of General Image Module.
MultiFrameDimensionModule	getMultiFrameDimensionModule()
MultiFrameFunctionalGroupsModule	getMultiFrameFunctionalGroupsModule() Retrieves pre-initialized instance of MultiFrameFunctionalGroupsModule.
MultiResolutionNavigationModule	getMultiResolutionNavigationModule() Retrieves pre-initialized instance of Respiratory Synchronization Module.
OpticalPathModule	getOpticalPathModule() Retrieves pre-initialized instance of Optical Path Module.
SlideLabelModule	getSlideLabelModule() Retrieves pre-initialized instance of Slide Label Module .
SOPCommonModule	getSOPCommonModule() Retrieves pre-initialized instance of SOP Common Module.
SpecimenModule	getSpecimenModule() Retrieves pre-initialized instance of Specimen Identification Module.
WholeSlideMicroscopyImageModule	getWholeSlideMicroscopyImageModule() Retrieves pre-initialized instance of Whole Slide Microscopy Image Module.
WholeSlideMicroscopySeriesModule	getWholeSlideMicroscopySeriesModule() Retrieves pre-initialized instance of Whole Slide Microscopy Series Module.
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 MR Spectroscopy IOD according to the Module Table given in The DICOM Standard.

Methods inherited from class cdac.medinfo.sdk.dcm30_04.dicommodel.modules.ImageIOD

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

VL_WHOLE_SLIDE_MICROSCOPY_IMAGE_IOD

public static final java.lang.String VL_WHOLE_SLIDE_MICROSCOPY_IMAGE_IOD

The Constant VL_WHOLE_SLIDE_MICROSCOPY_IMAGE_IOD.

See Also:

Constant Field Values

Constructor Detail

VLWholeSlideMicroscopyImageIOD

public VLWholeSlideMicroscopyImageIOD()

Instantiates a new VL Whole Slide Microscopy Image IOD.

VLWholeSlideMicroscopyImageIOD

public VLWholeSlideMicroscopyImageIOD(ITransferSyntax objITransferSyntax_)

This constructor initializes the TransferSyntax in its superclass IOD.

Parameters:

objITransferSyntax_ - - specifies the DICOM Standard defined TransfeSyntax.

VLWholeSlideMicroscopyImageIOD

public VLWholeSlideMicroscopyImageIOD(IDictionaryReader objIDictionaryReader_)

This constructor initializes the DictionaryReader in its superclass IOD.

Parameters:

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

VLWholeSlideMicroscopyImageIOD

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

VLWholeSlideMicroscopyImageIOD

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

VLWholeSlideMicroscopyImageIOD

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

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

getClinicalTrialSeriesModule

public ClinicalTrialSeriesModule getClinicalTrialSeriesModule()

Retrieves pre-initialized instance of objClinicalTrialSeriesModule. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.

Overrides:

getClinicalTrialSeriesModule in class ImageIOD

Returns:

objClinicalTrialSeriesModule - instance of objClinicalTrialSeriesModule.

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.

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.

Overrides:

getGeneralEquipmentModule in class ImageIOD

Returns:

GeneralEquipmentModule - instance of GeneralEquipmentModule.

getEnhancedGeneralEquipmentModule

public EnhancedGeneralEquipmentModule getEnhancedGeneralEquipmentModule()

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

getWholeSlideMicroscopySeriesModule

public WholeSlideMicroscopySeriesModule getWholeSlideMicroscopySeriesModule()

Retrieves pre-initialized instance of Whole Slide Microscopy 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:

WholeSlideMicroscopySeriesModule - instance of WholeSlideMicroscopySeriesModule.

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.

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.

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:

- instance of FrameExtractionModule.

getMultiFrameDimensionModule

public MultiFrameDimensionModule getMultiFrameDimensionModule()

getMultiFrameFunctionalGroupsModule

public MultiFrameFunctionalGroupsModule getMultiFrameFunctionalGroupsModule()

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

objMultiFrameFunctionalGroupsModule - instance of MultiFrameFunctionalGroupsModule.

getAcquisitionContextModule

public AcquisitionContextModule getAcquisitionContextModule()

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

objAcquisitionContextModule - instance of AcquisitionContextModule.

getSpecimenModule

public SpecimenModule getSpecimenModule()

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

getWholeSlideMicroscopyImageModule

public WholeSlideMicroscopyImageModule getWholeSlideMicroscopyImageModule()

Retrieves pre-initialized instance of Whole Slide Microscopy 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:

WholeSlideMicroscopyImageModule - instance of WholeSlideMicroscopyImageModule.

getOpticalPathModule

public OpticalPathModule getOpticalPathModule()

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

OpticalPathModule - instance of OpticalPathModule.

getMultiResolutionNavigationModule

public MultiResolutionNavigationModule getMultiResolutionNavigationModule()

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

MultiResolutionNavigationModule - instance of MultiResolutionNavigationModule.

getSlideLabelModule

public SlideLabelModule getSlideLabelModule()

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

SlideLabelModule - instance of SlideLabelModule.

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.

validate

public boolean validate()
                 throws InvalidIODException

This method validates Non-Image IOD MR Spectroscopy 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 - 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 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.