cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class SCImageModule

java.lang.Object

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.Module

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.SCImageModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class SCImageModule
extends Module

\* This module contains IOD Attributes that describe Secondary Capture Images.

Field Summary

Fields

Modifier and Type	Field and Description
static ISingleCollection<ITag>	objSingleCollection The obj single collection.

Constructor Summary

Constructors

Constructor and Description
SCImageModule(IDataSet objIDataSet)

Method Summary

Methods

Modifier and Type	Method and Description
BasicPixelSpacingCalibrationMacro	getBasicPixelSpacingCalibrationMacro() Returns instance of Basic Pixel Spacing Calibration Macro.
java.lang.String	getDateOfSecondaryCapture() Retrieves the date the Secondary Capture Image was captured.
DocumentClassCodeSequence	getDocumentClassCodeSequence() Sequence of Repeating Items that describe the energy window groups used.
java.lang.String[]	getNominalScannedPixelSpacing() Retrieves Nominal Scanned Pixel Spacing
OptionalViewandSliceProgressionDirectionMacro	getOptionalViewandSliceProgressionDirectionMacro() This method returns the Basic Pixel Spacing Calibration Macro
java.lang.String	getTimeOfSecondaryCapture() Retrieves the time the Secondary Capture Image was captured.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector of keys representing the DataElements that belong to this module.
void	setDateOfSecondaryCapture(java.lang.String strDateOfSecondaryCapture) Sets the date the Secondary Capture Image was captured.
void	setNominalScannedPixelSpacing(java.lang.String[] strNominalScannedPixelSpacing) Sets Nominal Scanned Pixel Spacing
void	setTimeOfSecondaryCapture(java.lang.String strTimeOfSecondaryCapture) Sets the time the Secondary Capture Image was captured.
boolean	validateModule() This method validates each Attribute in the Module according to the Type of the Attribute.Attributes are of 5 types.

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

add, dumpDICOMInfo, getDictionaryReader, getTransferSyntax, isPresent, isPresent, iterator, remove

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

objSingleCollection

public static ISingleCollection<ITag> objSingleCollection

The obj single collection.

Constructor Detail

SCImageModule

public SCImageModule(IDataSet objIDataSet)

Method Detail

validateModule

public boolean validateModule()
                       throws InvalidModuleException

This method validates each Attribute in the Module according to the Type of the Attribute.Attributes are of 5 types. Type 1,Type 2 are Mandatory: Mandatory Attributes have to present in the Module. Type 1C,2C are Conditional: Conditional Attributes' presence depend on a condition. If the condition is satisfied the Attribute has to be present. Type 3 are Optional Optional Attributes can be added as and when required.

Specified by:

validateModule in interface IModule

Specified by:

validateModule in class Module

Returns:

boolean - returns validation status as success or failure

Throws:

InvalidModuleException - - If validation of Module fails

setDateOfSecondaryCapture

public void setDateOfSecondaryCapture(java.lang.String strDateOfSecondaryCapture)

Sets the date the Secondary Capture Image was captured.

Parameters:

strDateOfSecondaryCapture - - String value of Date of Secondary Capture.

getDateOfSecondaryCapture

public java.lang.String getDateOfSecondaryCapture()

Retrieves the date the Secondary Capture Image was captured.

Returns:

String - String value of Date of Secondary Capture.

setTimeOfSecondaryCapture

public void setTimeOfSecondaryCapture(java.lang.String strTimeOfSecondaryCapture)

Sets the time the Secondary Capture Image was captured.

Parameters:

strTimeOfSecondaryCapture - the str time of secondary capture

getTimeOfSecondaryCapture

public java.lang.String getTimeOfSecondaryCapture()

Retrieves the time the Secondary Capture Image was captured.

Returns:

String - String value of Time of Secondary Capture.

setNominalScannedPixelSpacing

public void setNominalScannedPixelSpacing(java.lang.String[] strNominalScannedPixelSpacing)

Sets Nominal Scanned Pixel Spacing

Parameters:

strNominalScannedPixelSpacing - String value of Nominal Scanned Pixel Spacing

getNominalScannedPixelSpacing

public java.lang.String[] getNominalScannedPixelSpacing()

Retrieves Nominal Scanned Pixel Spacing

Returns:

String - value of Nominal Scanned Pixel Spacing

getDocumentClassCodeSequence

public DocumentClassCodeSequence getDocumentClassCodeSequence()

Sequence of Repeating Items that describe the energy window groups used. The number of items shall be equal to Number of Energy Windows (0054,0011). The first item corresponds to frames with value of 1 in the Energy Window Vector (0054,0010), the second item with value 2, etc.

Returns:

the Document Class Code Sequence

getBasicPixelSpacingCalibrationMacro

public BasicPixelSpacingCalibrationMacro getBasicPixelSpacingCalibrationMacro()

Returns instance of Basic Pixel Spacing Calibration Macro.

Returns:

Instance of Basic Pixel Spacing Calibration Macro

getOptionalViewandSliceProgressionDirectionMacro

public OptionalViewandSliceProgressionDirectionMacro getOptionalViewandSliceProgressionDirectionMacro()

This method returns the Basic Pixel Spacing Calibration Macro

Returns:

OptionalViewandSliceProgressionDirectionMacro - object representing Basic Pixel Spacing Calibration Macro

getVectorOfKeys

public ISingleCollection<ITag> getVectorOfKeys()

This method returns the vector of keys representing the DataElements that belong to this module.

Overrides:

getVectorOfKeys in class Module

Returns:

vector of Tags - returns the vector containing the collection of tags.