cdac.medinfo.sdk.dcm30_04.dicommodel.sc

Class MultiFrameGrayscaleWordSCImageIOD

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.sc.MultiFrameGrayscaleWordSCImageIOD

public class MultiFrameGrayscaleWordSCImageIOD
extends ImageIOD

The Multi-frame Grayscale Word Secondary Capture (SC) Image Information Object Definition (IOD) specifies Grayscale Word images that are converted from a non-DICOM format to a modality independent DICOM format. This IOD is typically used for screen captured images for modalities that have pixel values greater than 8 bits.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
MultiFrameGrayscaleWordSCImageIOD() Instantiates a new multi frame grayscale word sc image iod.
MultiFrameGrayscaleWordSCImageIOD(IDataSet objIDataSet_) This constructor accepts the DataSet from the user in its superclass IOD.
MultiFrameGrayscaleWordSCImageIOD(IDictionaryReader objIDictionaryReader_) This constructor initializes the DictionaryReader in its superclass IOD.
MultiFrameGrayscaleWordSCImageIOD(ITransferSyntax objITransferSyntax_) This constructor initializes the TransferSyntax in its superclass IOD.
MultiFrameGrayscaleWordSCImageIOD(ITransferSyntax objITransferSyntax_, IDictionaryReader objIDictionaryReader_) This constructor initializes the TransferSyntax and DictionaryReader in its super class IOD.
MultiFrameGrayscaleWordSCImageIOD(java.lang.String strFileName) Creates MultiFrameGrayscaleWordSCImageIOD IOD from a DICOM file containing MultiFrameGrayscaleWordSCImageIOD 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.
CineModule	getCineModule() Retrieves pre-initialized instance of Cine Module.
CommonInstanceReferenceModule	getCommonInstanceReferenceModule() Retrieves pre-initialized instance of Common Instance Reference Module.
DeviceModule	getDeviceModule() Retrieves pre-initialized instance of Device Module.
FrameExtractionModule	getFrameExtractionModule() Retrieves pre-initialized instance of Frame Extraction Module.
FrameOfReferenceModule	getFrameOfReferenceModule() Retrieves pre-initialized instance of Frame Of Reference Module.
FramePointersModule	getFramePointersModule() Retrieves pre-initialized instance of Frame Pointers Module .
GeneralImageModule	getGeneralImageModule() Retrieves pre-initialized instance of General Image Module.
MultiFrameDimensionModule	getMultiFrameDimensionModule() Retrieves pre-initialized instance of MultiFrame Dimension Module.
MultiFrameFunctionalGroupsModule	getMultiFrameFunctionalGroupsModule() Retrieves pre-initialized instance of MultiFrame Functional Groups Module.
MultiFrameModule	getMultiFrameModule() Retrieves pre-initialized instance of Multi Frame Module .
SCEquipmentModule	getSCEquipmentModule() Retrieves pre-initialized instance of SC Equipment Module.
SCImageModule	getSCImageModule() Retrieves pre-initialized instance of SC Image Module .
SCMultiFrameImageModule	getSCMultiFrameImageModule() Retrieves pre-initialized instance of SC Multi Frame Image Module.
SCMultiFrameVectorModule	getSCMultiFrameVectorModule() Retrieves pre-initialized instance of SC Multi Frame Vector 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.
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 Multi Frame Grayscale Word SC Image 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

MULTI_FRAME_GRAYSCALE_WORD_SC_IMAGE_IOD

public static final java.lang.String MULTI_FRAME_GRAYSCALE_WORD_SC_IMAGE_IOD

The Constant MULTI_FRAME_GRAYSCALE_WORD_SC_IMAGE_IOD.

See Also:

Constant Field Values

Constructor Detail

MultiFrameGrayscaleWordSCImageIOD

public MultiFrameGrayscaleWordSCImageIOD()

Instantiates a new multi frame grayscale word sc image iod.

MultiFrameGrayscaleWordSCImageIOD

public MultiFrameGrayscaleWordSCImageIOD(ITransferSyntax objITransferSyntax_)

This constructor initializes the TransferSyntax in its superclass IOD.

Parameters:

objITransferSyntax_ - - specifies the DICOM Standard defined TransfeSyntax.

MultiFrameGrayscaleWordSCImageIOD

public MultiFrameGrayscaleWordSCImageIOD(IDictionaryReader objIDictionaryReader_)

This constructor initializes the DictionaryReader in its superclass IOD.

Parameters:

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

MultiFrameGrayscaleWordSCImageIOD

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

MultiFrameGrayscaleWordSCImageIOD

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

MultiFrameGrayscaleWordSCImageIOD

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

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

validate

public boolean validate()
                 throws InvalidIODException

This method validates Multi Frame Grayscale Word SC Image 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 the IOD is invalid.

getSCEquipmentModule

public SCEquipmentModule getSCEquipmentModule()

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

SCEquipmentModule - instance of SCEquipmentModule.

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.

getCineModule

public CineModule getCineModule()

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

CineModule - instance of CineModule.

getMultiFrameModule

public MultiFrameModule getMultiFrameModule()

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

MultiFrameModule - instance of MultiFrameModule.

getFramePointersModule

public FramePointersModule getFramePointersModule()

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

FramePointersModule - instance of FramePointersModule.

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.

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.

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.

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.

getSCImageModule

public SCImageModule getSCImageModule()

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

SCImageModule - instance of SCImageModule.

getSCMultiFrameVectorModule

public SCMultiFrameVectorModule getSCMultiFrameVectorModule()

Retrieves pre-initialized instance of SC Multi Frame Vector 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:

SCMultiFrameVectorModule - instance of SCMultiFrameVectorModule.

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.

getSCMultiFrameImageModule

public SCMultiFrameImageModule getSCMultiFrameImageModule()

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

SCMultiFrameImageModule - instance of SCMultiFrameImageModule.

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.

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.

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.