USImageModule

java.lang.Object
- cdac.medinfo.sdk.dcm30_04.dicommodel.modules.Module
- - cdac.medinfo.sdk.dcm30_04.dicommodel.modules.USImageModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable
```
public class USImageModule
extends Module
```
\* This module specifies the Attributes that describe ultrasound images.

Field Summary

Fields
Modifier and Type Field and Description

static ISingleCollection<ITag> objSingleCollection
The obj single collection.

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

Constructor Summary

Constructors
Constructor and Description

USImageModule(IDataSet objIDataSet)
Instantiates a new uS image module.

Constructors
Constructor and Description
`USImageModule(IDataSet objIDataSet)` Instantiates a new uS image module.

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAcquisitionDateTime()` Returns date and time that the acquisition of data that resulted in this image started.
`java.lang.String`	`getBeatRejectionFlag()` Return Beat length sorting has been applied.
`short`	`getBitsAllocated()` Return Number of bits allocated for each pixel sample.
`short`	`getBitsStored()` Number of bits stored for each pixel sample.
`java.lang.String`	`getBoneThermalIndex()` Return the thermal index as defined according to the Standard for Real-Time Display of thermal Index on Diagnostic Ultrasound Equipment.
`java.lang.String`	`getCranialThermalIndex()` Return the thermal index as defined according to the Standard for Real-Time Display of thermal Index on Diagnostic Ultrasound Equipment.
`java.lang.String`	`getDepthOfScanField()` Return the depth, in mm, from the transducer face to the deepest point included in the displayed image the field of view.
`java.lang.String[]`	`getEventElapsedTimes()` An array of values associated with each event timer.
`java.lang.String[]`	`getEventTimerNames()` Return Name that identifies the event timer.
`java.lang.String`	`getFocusDepth()` Return the depth, from the transducer face, of the manufacturer defined beam focus used for the image, in cm.
`ISingleCollection<ITag>`	`getFrameIncrementPointer()` Return a collection of Tags that determine the sequential order of the frames.
`GeneralAnatomyOptionalMacro`	`getGeneralAnatomyOptionalMacro()` Gets the general anatomy optional macro.
`java.lang.String`	`getHeartRate()` Return Beats per minute.
`short`	`getHighBit()` Most significant bit for pixel sample data.
`java.lang.String`	`getHighRRValue()` Return R-R interval high limit for beat rejection, in msec.
`java.lang.String[]`	`getImageType()` Returns Image identification characteristics.
`java.lang.String`	`getIVUSAcquisition()` Return a term that describes the method used to acquire the IVUS Images.
`java.lang.String`	`getIVUSGatedRate()` Return IVUS Gated Rate Specified in units of mm/beat.
`java.lang.String`	`getIVUSPullbackRate()` Return IVUS Pull Back Rate Specified in units of mm/sec.
`java.lang.String`	`getIVUSPullbackStartFrameNumber()` Return IVUS Pullback Start Frame Number.
`java.lang.String`	`getIVUSPullbackStopFrameNumber()` Return IVUS Pullback Stop Frame Number.
`java.lang.String[]`	`getLesionNumber()` Return Identifier(s) of the lesion(s) of interest imaged within the current SOP Instance.
`java.lang.String`	`getLossyImageCompression()` Return whether an Image has undergone lossy compression.
`java.lang.String`	`getLowRRValue()` Return R-R interval low limit for beat rejection, in msec.
`java.lang.String`	`getMechanicalIndex()` Return the mechanical index as defined according to the Standard for Real-Time Display of Mechanical Acoustic Output Index on Diagnostic Ultrasound Equipment.
`java.lang.String`	`getNominalInterval()` Return Average R-R interval used for these data, in msec.
`java.lang.String`	`getNumberOfEventTimers()` Return the number of event timers used at the time of acquisition of a Multi-frame image.
`java.lang.String`	`getNumberOfStages()` Returns Number of Stages in this protocol.
`java.lang.String`	`getNumberOfViewsInStage()` Return Number of views in this Stage.
`OptionalViewandSliceProgressionDirectionMacro`	`getOptionalViewandSliceProgressionDirectionMacro()` This method returns the Optional View and Slice Progression Direction Macro.
`java.lang.String[]`	`getOutputPower()` Return Manufacturer defined character string description of ultrasound output level(s) used in generating a given image.
`java.lang.String`	`getPhotometricInterpretation()` Return the intended interpretation of the pixel data.
`short`	`getPixelRepresentation()` Data representation of the pixel samples.
`short`	`getPlanarConfiguration()` Returns value that indicates whether the pixel data are sent color-by-plane or color-by-pixel.
`java.lang.String`	`getProcessingFunction()` Return Manufacturer defined description of processing of echo information.
`ReferencedCurveSequence`	`getReferencedCurveSequence()` This method provides the pre-initialized object of Referenced Curve Sequence return - object of Referenced Curve Sequence.
`float[]`	`getRWaveTimeVector()` Return the time offset(s) of the reported R Wave peaks, each relative to the time of the start of the acquisition of the first frame in msec.
`short`	`getSamplesPerPixel()` Return the number of separate planes in the image.
`java.lang.String`	`getSoftTissueFocusThermalIndex()` Return the thermal index as defined according to the Standard for Real-Time Display of thermal Index on Diagnostic Ultrasound Equipment.
`java.lang.String`	`getSoftTissueSurfaceThermalIndex()` Return the thermal index as defined according to the Standard for Real-Time Display of thermal Index on Diagnostic Ultrasound Equipment.
`java.lang.String`	`getSoftTissueThermalIndex()` Return the thermal index as defined according to the Standard for Real-Time Display of thermal Index on Diagnostic Ultrasound Equipment.
`StageCodeSequence`	`getStageCodeSequence()` This method provides the pre-initialized object of Stage Code Sequence return - object of Stage Code Sequence.
`java.lang.String`	`getStageName()` Returns Stage.
`java.lang.String`	`getStageNumber()` Returns a number that identifies the Stage.
`java.lang.String[]`	`getTransducerData()` Return Manufacturer defined code or description of ultrasound transducer used.
`TransducerOrientationSequence`	`getTransducerOrientationSequence()` This method provides the pre-initialized object of Transducer Orientation Sequence return - object of Transducer Orientation Sequence.
`java.lang.String`	`getTransducerType()` Return the type ultrasound transducer used.
`java.lang.String`	`getTriggerTime()` Return Time interval measured in msec from the start of the R-wave to the beginning of data taking.
`short`	`getUltrasoundColorDataPresent()` Return element that indicates if any ultrasound color data is present in an image.
`ISingleCollection<ITag>`	`getVectorOfKeys()` This method returns the vector of keys representing the DataElements that belong to this module.
`java.lang.String`	`getViewName()` Returns View Name.A View is a particular combination of the position and orientation when a set of images are acquired.
`java.lang.String`	`getViewNumber()` Return a number that identifies the View.
`void`	`setAcquisitionDateTime(java.lang.String strAcquisitionDatetime)` The date and time that the acquisition of data that resulted in this image started.
`void`	`setBeatRejectionFlag(EnumBeatRejectionFlag enumBeatRejectionFlag)` Beat length sorting has been applied.
`void`	`setBitsAllocated(EnumBitsAllocated enumBitsAllocated)` Number of bits allocated for each pixel sample.
`void`	`setBitsStored(EnumBitsStored enumBitsStored)` Number of bits stored for each pixel sample.
`void`	`setBoneThermalIndex(java.lang.String strBoneThermalIndex)` The thermal index is defined according to the Standard for Real-Time Display of thermal Index on Diagnostic Ultrasound Equipment.
`void`	`setCranialThermalIndex(java.lang.String strCranialThermalIndex)` The thermal index is defined according to the Standard for Real-Time Display of thermal Index on Diagnostic Ultrasound Equipment.
`void`	`setDepthOfScanField(java.lang.String strDepthOfScanField)` The depth, in mm, from the transducer face to the deepest point included in the displayed image the field of view.
`void`	`setEventElapsedTimes(java.lang.String[] arrEventElapsedTimes)` An array of values associated with each event timer.
`void`	`setEventTimerNames(java.lang.String[] arrEventTimerNames)` Name that identifies the event timer.
`void`	`setFocusDepth(java.lang.String strFocusDepth)` The depth, from the transducer face, of the manufacturer defined beam focus used for the image, in cm.
`void`	`setFrameIncrementPointer(ISingleCollection<ITag> objSingleCollection)` Sets value that is Used to specify multiple values for Frame Increment Pointer.
`void`	`setHeartRate(java.lang.String strHeartRate)` Beats per minute.
`void`	`setHighBit(EnumHighBit enumHighBit)` Most significant bit for pixel sample data.
`void`	`setHighRRValue(java.lang.String strHighRRValue)` R-R interval high limit for beat rejection, in msec.
`void`	`setImageType(java.lang.String[] arrStrImageType)` This method is used to set Image identification characteristics.
`void`	`setIVUSAcquisition(EnumIVUSAcquisition enumIVUSAcquisition)` This attribute denotes which of the following defined terms describes the method used to acquire the IVUS Images.
`void`	`setIVUSGatedRate(java.lang.String strIVUSGatedRate)` Required if IVUS Acquisition (0018,3100) value is GATED_PULLBACK.
`void`	`setIVUSPullbackRate(java.lang.String strIVUSPullbackRate)` Required if IVUS Acquisition (0018,3100) value is MOTOR_PULLBACK.
`void`	`setIVUSPullbackStartFrameNumber(java.lang.String strIVUSPullbackStartFrameNumber)` Required if IVUS Acquisition (0018,3100) value is MOTOR_PULLBACK or GATED_PULLBACK.
`void`	`setIVUSPullbackStopFrameNumber(java.lang.String strIVUSPullbackStopFrameNumber)` Required if IVUS Acquisition (0018,3100) value is MOTOR_PULLBACK or GATED_PULLBACK.
`void`	`setLesionNumber(java.lang.String[] arrStrLesionNumber)` Identifier(s) of the lesion(s) of interest imaged within the current SOP Instance.
`void`	`setLossyImageCompression(EnumLossyImageCompression enumLossyImageCompression)` Specifies whether an Image has undergone lossy compression.
`void`	`setLowRRValue(java.lang.String strLowRRValue)` R-R interval low limit for beat rejection, in msec.
`void`	`setMechanicalIndex(java.lang.String strMechanicalIndex)` The mechanical index is defined according to the Standard for Real-Time Display of Mechanical Acoustic Output Index on Diagnostic Ultrasound Equipment.
`void`	`setNominalInterval(java.lang.String strNominalInterval)` Average R-R interval used for these data, in msec.
`void`	`setNumberOfEventTimers(java.lang.String strNumberOfEventTimers)` The number of event timers used at the time of acquisition of a Multi-frame image.
`void`	`setNumberOfStages(java.lang.String strNumberOfStages)` Number of Stages in this protocol.
`void`	`setNumberOfViewsInStage(java.lang.String strNumberOfViewsInStage)` Number of views in this Stage.
`void`	`setOutputPower(java.lang.String[] arrStrOutputPower)` Manufacturer defined character string description of ultrasound output level(s) used in generating a given image.
`void`	`setPhotometricInterpretation(EnumPhotometricInterpretation enumPhotometricInterpretation)` The method is used to set Specifies the intended interpretation of the pixel data.
`void`	`setPixelRepresentation(EnumPixelRepresentation enumPixelRepresentation)` Data representation of the pixel samples.
`void`	`setPlanarConfiguration(short sPlanarConfiguration)` Indicates whether the pixel data are sent color-by-plane or color-by-pixel.
`void`	`setProcessingFunction(java.lang.String strProcessingFunction)` Manufacturer defined description of processing of echo information.
`void`	`setRWaveTimeVector(float[] arrFRWaveTimeVector)` The time offset(s) of the reported R Wave peaks, each relative to the time of the start of the acquisition of the first frame in msec.
`void`	`setSamplesPerPixel(EnumSamplesPerPixel enumSamplesPerPixel)` Samples per Pixel (0028,0002) is the number of separate planes in the image.
`void`	`setSoftTissueFocusThermalIndex(java.lang.String strSoftTissueFocusThermalIndex)` The thermal index is defined according to the Standard for Real-Time Display of thermal Index on Diagnostic Ultrasound Equipment.
`void`	`setSoftTissueSurfaceThermalIndex(java.lang.String strSoftTissueSurfaceThermalIndex)` The thermal index is defined according to the Standard for Real-Time Display of thermal Index on Diagnostic Ultrasound Equipment.
`void`	`setSoftTissueThermalIndex(java.lang.String strSoftTissueThermalIndex)` The thermal index is defined according to the Standard for Real-Time Display of thermal Index on Diagnostic Ultrasound Equipment.
`void`	`setStageName(EnumStageName enumStageName)` A Stage is a particular time slice of a protocol in which a set of images are collected.
`void`	`setStageNumber(java.lang.String strStageNumber)` A number that identifies the Stage.
`void`	`setTransducerData(java.lang.String[] arrStrTransducerData)` Manufacturer defined code or description of ultrasound transducer used.
`void`	`setTransducerType(EnumTransducerType enumTransducerType)` Describes the type ultrasound transducer used.
`void`	`setTriggerTime(java.lang.String strTriggerTime)` Time interval measured in msec from the start of the R-wave to the beginning of data taking.
`void`	`setUltrasoundColorDataPresent(EnumUltrasoundColorDataPresent enumUltrasoundColorDataPresent)` This element indicates if any ultrasound color data is present in an image.
`void`	`setViewName(java.lang.String strViewName)` A View is a particular combination of the position and orientation when a set of images are acquired.
`void`	`setViewNumber(java.lang.String strViewNumber)` A number that identifies the View.
`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
  - USImageModule
```
public USImageModule(IDataSet objIDataSet)
```
    Instantiates a new uS image module.
    
    Parameters:
    objIDataSet - the obj i data set
- 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:
    true, if validate module
    
    Throws:
    
    InvalidModuleException - the invalid module exception
  - setImageType
```
public void setImageType(java.lang.String[] arrStrImageType)
```
    This method is used to set Image identification characteristics. The function accepts a String Value and creates the DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module HashMap
    
    Parameters:
    arrStrImageType - : Image identification characteristics.
  - setAcquisitionDateTime
```
public void setAcquisitionDateTime(java.lang.String strAcquisitionDatetime)
```
    The date and time that the acquisition of data that resulted in this image started. Required if Modality (0008,0060) = IVUS May be present otherwise.
    
    Parameters:
    strAcquisitionDatetime - String value of Acquisition Date Time
  - setStageName
```
public void setStageName(EnumStageName enumStageName)
```
    A Stage is a particular time slice of a protocol in which a set of images are collected. The names can be free form text. Recommended text for Stress Echo stage names are: PRE-EXERCISE,POST-EXERCISE,PEAK-EXERCISE,RECOVERY,BASELINE,LOW DOSE,PEAK DOSE
    
    Parameters:
    enumStageName - Enum value of Stage Name.
  - setStageNumber
```
public void setStageNumber(java.lang.String strStageNumber)
```
    A number that identifies the Stage. Stage Number starts at one.
    
    Parameters:
    strStageNumber - String value of Stage Number.
  - setNumberOfStages
```
public void setNumberOfStages(java.lang.String strNumberOfStages)
```
    Number of Stages in this protocol. Required if image was acquired in a Staged protocol.
    
    Parameters:
    strNumberOfStages - String value of Number of Stages.
  - setViewName
```
public void setViewName(java.lang.String strViewName)
```
    A View is a particular combination of the position and orientation when a set of images are acquired. Images are acquired at the same View in different Stages for the purpose of comparison.
    
    Parameters:
    strViewName - String String value of View Name.
  - setViewNumber
```
public void setViewNumber(java.lang.String strViewNumber)
```
    A number that identifies the View. View Number starts at one.
    
    Parameters:
    strViewNumber - String value of View Number.
  - setNumberOfEventTimers
```
public void setNumberOfEventTimers(java.lang.String strNumberOfEventTimers)
```
    The number of event timers used at the time of acquisition of a Multi-frame image.
    
    Parameters:
    strNumberOfEventTimers - String value of Number of Event Timers.
  - setNumberOfViewsInStage
```
public void setNumberOfViewsInStage(java.lang.String strNumberOfViewsInStage)
```
    Number of views in this Stage. Required if image was acquired in a Staged protocol.
    
    Parameters:
    strNumberOfViewsInStage - String value of Number Of Views In Stage
  - setEventElapsedTimes
```
public void setEventElapsedTimes(java.lang.String[] arrEventElapsedTimes)
```
    An array of values associated with each event timer. Units in milliseconds.
    
    Parameters:
    arrEventElapsedTimes - String array of Event Elapsed Times.
  - setEventTimerNames
```
public void setEventTimerNames(java.lang.String[] arrEventTimerNames)
```
    Name that identifies the event timer.
    
    Parameters:
    arrEventTimerNames - String array of Event Timer Names.
  - setTriggerTime
```
public void setTriggerTime(java.lang.String strTriggerTime)
```
    Time interval measured in msec from the start of the R-wave to the beginning of data taking.
    
    Parameters:
    strTriggerTime - String value of Trigger Time.
  - setNominalInterval
```
public void setNominalInterval(java.lang.String strNominalInterval)
```
    Average R-R interval used for these data, in msec.
    
    Parameters:
    strNominalInterval - String value of Nominal Interval.
  - setBeatRejectionFlag
```
public void setBeatRejectionFlag(EnumBeatRejectionFlag enumBeatRejectionFlag)
```
    Beat length sorting has been applied. Enumerated Values:Y = yes,N = no
    
    Parameters:
    enumBeatRejectionFlag - Enum value of Beat Rejection Flag.
  - setLowRRValue
```
public void setLowRRValue(java.lang.String strLowRRValue)
```
    R-R interval low limit for beat rejection, in msec.
    
    Parameters:
    strLowRRValue - String value of Low RR Value.
  - setHighRRValue
```
public void setHighRRValue(java.lang.String strHighRRValue)
```
    R-R interval high limit for beat rejection, in msec.
    
    Parameters:
    strHighRRValue - String value of high RR value.
  - setHeartRate
```
public void setHeartRate(java.lang.String strHeartRate)
```
    Beats per minute.
    
    Parameters:
    strHeartRate - String value of Heart rate.
  - setIVUSAcquisition
```
public void setIVUSAcquisition(EnumIVUSAcquisition enumIVUSAcquisition)
```
    This attribute denotes which of the following defined terms describes the method used to acquire the IVUS Images. Defined Terms: MOTOR_PULLBACK,MANUAL_PULLBACK,SELECTIVE,GATED_PULLBACK
    
    Parameters:
    enumIVUSAcquisition - - enum value of IVUSAcquisition.
  - setIVUSPullbackRate
```
public void setIVUSPullbackRate(java.lang.String strIVUSPullbackRate)
```
    Required if IVUS Acquisition (0018,3100) value is MOTOR_PULLBACK. Specified in units of mm/sec.
    
    Parameters:
    strIVUSPullbackRate - String value of IVUS Pullback Rate.
  - setIVUSGatedRate
```
public void setIVUSGatedRate(java.lang.String strIVUSGatedRate)
```
    Required if IVUS Acquisition (0018,3100) value is GATED_PULLBACK. Specified in units of mm/beat.
    
    Parameters:
    strIVUSGatedRate - String value of IVUS Gated Rate.
  - setIVUSPullbackStartFrameNumber
```
public void setIVUSPullbackStartFrameNumber(java.lang.String strIVUSPullbackStartFrameNumber)
```
    Required if IVUS Acquisition (0018,3100) value is MOTOR_PULLBACK or GATED_PULLBACK.
    
    Parameters:
    strIVUSPullbackStartFrameNumber - String value of IVUS Pullback Start Frame Number.
  - setIVUSPullbackStopFrameNumber
```
public void setIVUSPullbackStopFrameNumber(java.lang.String strIVUSPullbackStopFrameNumber)
```
    Required if IVUS Acquisition (0018,3100) value is MOTOR_PULLBACK or GATED_PULLBACK.
    
    Parameters:
    strIVUSPullbackStopFrameNumber - String value of IVUS Pullback Stop Frame Number.
  - setLesionNumber
```
public void setLesionNumber(java.lang.String[] arrStrLesionNumber)
```
    Identifier(s) of the lesion(s) of interest imaged within the current SOP Instance. Each lesion shall have a unique numeric integer identifier within the study.
    
    Parameters:
    arrStrLesionNumber - String array of Lesion Number.
  - setOutputPower
```
public void setOutputPower(java.lang.String[] arrStrOutputPower)
```
    Manufacturer defined character string description of ultrasound output level(s) used in generating a given image. Data may be expressed in dB, %, W/cm2, etc.
    
    Parameters:
    arrStrOutputPower - String array of Output Power.
  - setTransducerData
```
public void setTransducerData(java.lang.String[] arrStrTransducerData)
```
    Manufacturer defined code or description of ultrasound transducer used.
    
    Parameters:
    arrStrTransducerData - String array of Transducer Data.
  - setFocusDepth
```
public void setFocusDepth(java.lang.String strFocusDepth)
```
    The depth, from the transducer face, of the manufacturer defined beam focus used for the image, in cm.
    
    Parameters:
    strFocusDepth - String value of Focus Depth.
  - setProcessingFunction
```
public void setProcessingFunction(java.lang.String strProcessingFunction)
```
    Manufacturer defined description of processing of echo information. Data may include code or description of gain (initial,overall, TGC, dynamic range, etc.), preprocessing, postprocessing, Doppler processing parameters, e.g. cutoff filters, etc., as used in generating a given image.
    
    Parameters:
    strProcessingFunction - String value of Processing Function.
  - setMechanicalIndex
```
public void setMechanicalIndex(java.lang.String strMechanicalIndex)
```
    The mechanical index is defined according to the Standard for Real-Time Display of Mechanical Acoustic Output Index on Diagnostic Ultrasound Equipment.
    
    Parameters:
    strMechanicalIndex - String value of Mechanical Index.
  - setBoneThermalIndex
```
public void setBoneThermalIndex(java.lang.String strBoneThermalIndex)
```
    The thermal index is defined according to the Standard for Real-Time Display of thermal Index on Diagnostic Ultrasound Equipment.
    
    Parameters:
    strBoneThermalIndex - String value of Bone Thermal Index.
  - setCranialThermalIndex
```
public void setCranialThermalIndex(java.lang.String strCranialThermalIndex)
```
    The thermal index is defined according to the Standard for Real-Time Display of thermal Index on Diagnostic Ultrasound Equipment.
    
    Parameters:
    strCranialThermalIndex - String value of Cranial Thermal Index.
  - setSoftTissueThermalIndex
```
public void setSoftTissueThermalIndex(java.lang.String strSoftTissueThermalIndex)
```
    The thermal index is defined according to the Standard for Real-Time Display of thermal Index on Diagnostic Ultrasound Equipment.
    
    Parameters:
    strSoftTissueThermalIndex - String value of Soft Tissue Thermal Index.
  - setSoftTissueFocusThermalIndex
```
public void setSoftTissueFocusThermalIndex(java.lang.String strSoftTissueFocusThermalIndex)
```
    The thermal index is defined according to the Standard for Real-Time Display of thermal Index on Diagnostic Ultrasound Equipment.
    
    Parameters:
    strSoftTissueFocusThermalIndex - String value of Soft Tissue-focus Thermal Index
  - setSoftTissueSurfaceThermalIndex
```
public void setSoftTissueSurfaceThermalIndex(java.lang.String strSoftTissueSurfaceThermalIndex)
```
    The thermal index is defined according to the Standard for Real-Time Display of thermal Index on Diagnostic Ultrasound Equipment.
    
    Parameters:
    strSoftTissueSurfaceThermalIndex - String value of Soft Tissue Surface Thermal Index.
  - setDepthOfScanField
```
public void setDepthOfScanField(java.lang.String strDepthOfScanField)
```
    The depth, in mm, from the transducer face to the deepest point included in the displayed image the field of view.
    
    Parameters:
    strDepthOfScanField - String value of Depth of Scan Field.
  - setTransducerType
```
public void setTransducerType(EnumTransducerType enumTransducerType)
```
    Describes the type ultrasound transducer used. Defined Terms:SECTOR_PHASED,SECTOR_MECH,SECTOR_ANNULAR,LINEAR,CURVED LINEAR,SINGLE CRYSTAL,SPLIT XTAL CWD, IV_PHASED,IV_ROT XTAL,IV_ROT MIRROR,ENDOCAV_PA,ENDOCAV_MECH,ENDOCAV_CLA,ENDOCAV_AA,ENDOCAV_LINEAR,VECTOR_PHASED
    
    Parameters:
    enumTransducerType - enum value of Transducer Type.
  - setRWaveTimeVector
```
public void setRWaveTimeVector(float[] arrFRWaveTimeVector)
```
    The time offset(s) of the reported R Wave peaks, each relative to the time of the start of the acquisition of the first frame in msec. Multi-valued, with one value per reported R Wave.
    
    Parameters:
    arrFRWaveTimeVector - Float array of FR Wave Time Vector.
  - setSamplesPerPixel
```
public void setSamplesPerPixel(EnumSamplesPerPixel enumSamplesPerPixel)
```
    Samples per Pixel (0028,0002) is the number of separate planes in the image. One, three, and four image planes are defined. For monochrome (gray scale) and palette color images, the number of planes is 1. For RGB and other three vector color models, the value of this attribute is 3. For four vector color models, the value of this attribute is 4.
    
    Parameters:
    enumSamplesPerPixel - Number of samples (planes) in this image.
  - setPhotometricInterpretation
```
public void setPhotometricInterpretation(EnumPhotometricInterpretation enumPhotometricInterpretation)
```
    The method is used to set Specifies the intended interpretation of the pixel data. The function accepts a String Value and creates the DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module HashMap
    
    Parameters:
    enumPhotometricInterpretation - : Enum value of Photometric Interpretation
  - setPlanarConfiguration
```
public void setPlanarConfiguration(short sPlanarConfiguration)
```
    Indicates whether the pixel data are sent color-by-plane or color-by-pixel.
    
    Parameters:
    sPlanarConfiguration - Short value of Planar Configuration.
  - setFrameIncrementPointer
```
public void setFrameIncrementPointer(ISingleCollection<ITag> objSingleCollection)
```
    Sets value that is Used to specify multiple values for Frame Increment Pointer.
    
    Parameters:
    objSingleCollection - - Collection of Tags (GroupNumber and ElementNumbers)
  - setUltrasoundColorDataPresent
```
public void setUltrasoundColorDataPresent(EnumUltrasoundColorDataPresent enumUltrasoundColorDataPresent)
```
    This element indicates if any ultrasound color data is present in an image. Enumerated Values: 00 = Ultrasound color data not present in image, 01 = Ultrasound color data is present in image.
    
    Parameters:
    enumUltrasoundColorDataPresent - enum value of Ultrasound Color Data Present.
  - setBitsAllocated
```
public void setBitsAllocated(EnumBitsAllocated enumBitsAllocated)
```
    Number of bits allocated for each pixel sample. Each sample shall have the same number of bits allocated.
    
    Parameters:
    enumBitsAllocated - Enum value of Bits Allocated.
  - setBitsStored
```
public void setBitsStored(EnumBitsStored enumBitsStored)
```
    Number of bits stored for each pixel sample. Each sample shall have the same number of bits stored.
    
    Parameters:
    enumBitsStored - Enum value of Bits Stored.
  - setHighBit
```
public void setHighBit(EnumHighBit enumHighBit)
```
    Most significant bit for pixel sample data. Each sample shall have the same high bit.
    
    Parameters:
    enumHighBit - Enum value of high bit.
  - setPixelRepresentation
```
public void setPixelRepresentation(EnumPixelRepresentation enumPixelRepresentation)
```
    Data representation of the pixel samples. Each sample shall have the same pixel representation. Enumerated Values: 0000H = unsigned integer. 0001H = 2's complement
    
    Parameters:
    enumPixelRepresentation - Enum value of Pixel Representation.
  - setLossyImageCompression
```
public void setLossyImageCompression(EnumLossyImageCompression enumLossyImageCompression)
```
    Specifies whether an Image has undergone lossy compression. Enumerated Values: 00 = Image has NOT been subjected to lossy compression, 01 = Image has been subjected to lossy compression.
    
    Parameters:
    enumLossyImageCompression - Enum value of Lossy Image Compression.
  - getImageType
```
public java.lang.String[] getImageType()
```
    Returns Image identification characteristics.
    
    Returns:
    String[] - String value of Image type.
  - getAcquisitionDateTime
```
public java.lang.String getAcquisitionDateTime()
```
    Returns date and time that the acquisition of data that resulted in this image started.
    
    Returns:
    String - String value of Acquisition Date Time.
  - getReferencedCurveSequence
```
public ReferencedCurveSequence getReferencedCurveSequence()
```
    This method provides the pre-initialized object of Referenced Curve Sequence return - object of Referenced Curve Sequence. If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence
    
    Returns:
    the referenced curve sequence
  - getStageName
```
public java.lang.String getStageName()
```
    Returns Stage. A Stage is a particular time slice of a protocol in which a set of images are collected.
    
    Returns:
    String - String value of Stage Name.
  - getStageNumber
```
public java.lang.String getStageNumber()
```
    Returns a number that identifies the Stage.
    
    Returns:
    String - String value of Stage Number.
  - getNumberOfStages
```
public java.lang.String getNumberOfStages()
```
    Returns Number of Stages in this protocol.
    
    Returns:
    String - String value of Number of Stages.
  - getViewName
```
public java.lang.String getViewName()
```
    Returns View Name.A View is a particular combination of the position and orientation when a set of images are acquired.
    
    Returns:
    String - String value of View Name.
  - getViewNumber
```
public java.lang.String getViewNumber()
```
    Return a number that identifies the View.
    
    Returns:
    String - String value of View Number.
  - getNumberOfEventTimers
```
public java.lang.String getNumberOfEventTimers()
```
    Return the number of event timers used at the time of acquisition of a Multi-frame image.
    
    Returns:
    String - String value of Number of event Timers.
  - getNumberOfViewsInStage
```
public java.lang.String getNumberOfViewsInStage()
```
    Return Number of views in this Stage.
    
    Returns:
    String - String value of Number of Views In Stage.
  - getEventElapsedTimes
```
public java.lang.String[] getEventElapsedTimes()
```
    An array of values associated with each event timer. Units in milliseconds.
    
    Returns:
    String[] - String array of Event Elapsed Times.
  - getEventTimerNames
```
public java.lang.String[] getEventTimerNames()
```
    Return Name that identifies the event timer.
    
    Returns:
    String[] - String array of Event Timer Names.
  - getTransducerOrientationSequence
```
public TransducerOrientationSequence getTransducerOrientationSequence()
```
    This method provides the pre-initialized object of Transducer Orientation Sequence return - object of Transducer Orientation Sequence. If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence
    
    Returns:
    the transducer orientation sequence
  - getTriggerTime
```
public java.lang.String getTriggerTime()
```
    Return Time interval measured in msec from the start of the R-wave to the beginning of data taking.
    
    Returns:
    String - String value of Trigger time.
  - getNominalInterval
```
public java.lang.String getNominalInterval()
```
    Return Average R-R interval used for these data, in msec.
    
    Returns:
    String - String value of Nominal Interval.
  - getBeatRejectionFlag
```
public java.lang.String getBeatRejectionFlag()
```
    Return Beat length sorting has been applied. Enumerated Values:Y = yes,N = no
    
    Returns:
    String - String value of Beat Rejection Flag.
  - getLowRRValue
```
public java.lang.String getLowRRValue()
```
    Return R-R interval low limit for beat rejection, in msec.
    
    Returns:
    String - String value of Low RR Value.
  - getHighRRValue
```
public java.lang.String getHighRRValue()
```
    Return R-R interval high limit for beat rejection, in msec.
    
    Returns:
    String - String value of High RR Value.
  - getHeartRate
```
public java.lang.String getHeartRate()
```
    Return Beats per minute.
    
    Returns:
    String - String value of Heart Rate.
  - getIVUSAcquisition
```
public java.lang.String getIVUSAcquisition()
```
    Return a term that describes the method used to acquire the IVUS Images. Defined Terms: MOTOR_PULLBACK,MANUAL_PULLBACK,SELECTIVE,GATED_PULLBACK
    
    Returns:
    String - String value of IVUS Acquisition.
  - getIVUSPullbackRate
```
public java.lang.String getIVUSPullbackRate()
```
    Return IVUS Pull Back Rate Specified in units of mm/sec.
    
    Returns:
    String - String value of IVUS Pullback Rate.
  - getIVUSGatedRate
```
public java.lang.String getIVUSGatedRate()
```
    Return IVUS Gated Rate Specified in units of mm/beat.
    
    Returns:
    String - String value of IVUS Gated Rate.
  - getIVUSPullbackStartFrameNumber
```
public java.lang.String getIVUSPullbackStartFrameNumber()
```
    Return IVUS Pullback Start Frame Number.
    
    Returns:
    String - String value of IVUS Pullback Start Frame Number.
  - getIVUSPullbackStopFrameNumber
```
public java.lang.String getIVUSPullbackStopFrameNumber()
```
    Return IVUS Pullback Stop Frame Number.
    
    Returns:
    String - String value of IVUS Pullback Stop Frame Number.
  - getLesionNumber
```
public java.lang.String[] getLesionNumber()
```
    Return Identifier(s) of the lesion(s) of interest imaged within the current SOP Instance.
    
    Returns:
    String[] - String value of Lesion Number.
  - getOutputPower
```
public java.lang.String[] getOutputPower()
```
    Return Manufacturer defined character string description of ultrasound output level(s) used in generating a given image.
    
    Returns:
    String[] - String array of Output Power.
  - getTransducerData
```
public java.lang.String[] getTransducerData()
```
    Return Manufacturer defined code or description of ultrasound transducer used.
    
    Returns:
    String[] - String array of Transducer Data.
  - getFocusDepth
```
public java.lang.String getFocusDepth()
```
    Return the depth, from the transducer face, of the manufacturer defined beam focus used for the image, in cm.
    
    Returns:
    the focus depth
  - getProcessingFunction
```
public java.lang.String getProcessingFunction()
```
    Return Manufacturer defined description of processing of echo information.
    
    Returns:
    String - String value of Preprocessing Function.
  - getMechanicalIndex
```
public java.lang.String getMechanicalIndex()
```
    Return the mechanical index as defined according to the Standard for Real-Time Display of Mechanical Acoustic Output Index on Diagnostic Ultrasound Equipment.
    
    Returns:
    String - String value of Mechanical Index.
  - getBoneThermalIndex
```
public java.lang.String getBoneThermalIndex()
```
    Return the thermal index as defined according to the Standard for Real-Time Display of thermal Index on Diagnostic Ultrasound Equipment.
    
    Returns:
    String - String value of Bone Thermal Index.
  - getCranialThermalIndex
```
public java.lang.String getCranialThermalIndex()
```
    Return the thermal index as defined according to the Standard for Real-Time Display of thermal Index on Diagnostic Ultrasound Equipment.
    
    Returns:
    the cranial thermal index
  - getSoftTissueThermalIndex
```
public java.lang.String getSoftTissueThermalIndex()
```
    Return the thermal index as defined according to the Standard for Real-Time Display of thermal Index on Diagnostic Ultrasound Equipment.
    
    Returns:
    String - String value of Soft Tissue Thermal Index.
  - getSoftTissueFocusThermalIndex
```
public java.lang.String getSoftTissueFocusThermalIndex()
```
    Return the thermal index as defined according to the Standard for Real-Time Display of thermal Index on Diagnostic Ultrasound Equipment.
    
    Returns:
    String - String value of Soft Tissue-focus Thermal Index.
  - getSoftTissueSurfaceThermalIndex
```
public java.lang.String getSoftTissueSurfaceThermalIndex()
```
    Return the thermal index as defined according to the Standard for Real-Time Display of thermal Index on Diagnostic Ultrasound Equipment.
    
    Returns:
    String - String value of Soft Tissue Thermal Index.
  - getDepthOfScanField
```
public java.lang.String getDepthOfScanField()
```
    Return the depth, in mm, from the transducer face to the deepest point included in the displayed image the field of view.
    
    Returns:
    String - String value of Depth of Scan Field.
  - getTransducerType
```
public java.lang.String getTransducerType()
```
    Return the type ultrasound transducer used. Defined Terms:SECTOR_PHASED,SECTOR_MECH,SECTOR_ANNULAR,LINEAR,CURVED LINEAR,SINGLE CRYSTAL,SPLIT XTAL CWD, IV_PHASED,IV_ROT XTAL,IV_ROT MIRROR,ENDOCAV_PA,ENDOCAV_MECH,ENDOCAV_CLA,ENDOCAV_AA,ENDOCAV_LINEAR,VECTOR_PHASED
    
    Returns:
    String - String value of Transducer Type.
  - getRWaveTimeVector
```
public float[] getRWaveTimeVector()
```
    Return the time offset(s) of the reported R Wave peaks, each relative to the time of the start of the acquisition of the first frame in msec. Multi-valued, with one value per reported R Wave.
    
    Returns:
    float[] - Float array of R Wave Time Vector.
  - getSamplesPerPixel
```
public short getSamplesPerPixel()
```
    Return the number of separate planes in the image.
    
    Returns:
    short - Short value of Samples Per Pixel.
  - getPhotometricInterpretation
```
public java.lang.String getPhotometricInterpretation()
```
    Return the intended interpretation of the pixel data.
    
    Returns:
    String - String value of Photometric Interpretation.
  - getPlanarConfiguration
```
public short getPlanarConfiguration()
```
    Returns value that indicates whether the pixel data are sent color-by-plane or color-by-pixel.
    
    Returns:
    short - short value of Planar Configuration.
  - getFrameIncrementPointer
```
public ISingleCollection<ITag> getFrameIncrementPointer()
```
    Return a collection of Tags that determine the sequential order of the frames.
    
    Returns:
    ISingleCollection - collection of tags.
  - getUltrasoundColorDataPresent
```
public short getUltrasoundColorDataPresent()
```
    Return element that indicates if any ultrasound color data is present in an image. Enumerated Values: 00 = Ultrasound color data not present in image, 01 = Ultrasound color data is present in image.
    
    Returns:
    short - Short value of Ultrasound Color Data Present.
  - getBitsAllocated
```
public short getBitsAllocated()
```
    Return Number of bits allocated for each pixel sample.
    
    Returns:
    short - Short value of Bits Allocated.
  - getBitsStored
```
public short getBitsStored()
```
    Number of bits stored for each pixel sample.
    
    Returns:
    short - short value of Bits Stored.
  - getHighBit
```
public short getHighBit()
```
    Most significant bit for pixel sample data.
    
    Returns:
    short - Short value of High Bit.
  - getPixelRepresentation
```
public short getPixelRepresentation()
```
    Data representation of the pixel samples.
    
    Returns:
    the pixel representation
  - getLossyImageCompression
```
public java.lang.String getLossyImageCompression()
```
    Return whether an Image has undergone lossy compression.
    
    Returns:
    String - String value of Lossy Image Compression.
  - getStageCodeSequence
```
public StageCodeSequence getStageCodeSequence()
```
    This method provides the pre-initialized object of Stage Code Sequence return - object of Stage Code Sequence. If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence
    
    Returns:
    the stage code sequence
  - getGeneralAnatomyOptionalMacro
```
public GeneralAnatomyOptionalMacro getGeneralAnatomyOptionalMacro()
```
    Gets the general anatomy optional macro.
    
    Returns:
    the general anatomy optional macro
  - getOptionalViewandSliceProgressionDirectionMacro
```
public OptionalViewandSliceProgressionDirectionMacro getOptionalViewandSliceProgressionDirectionMacro()
```
    This method returns the Optional View and Slice Progression Direction Macro.
    
    Returns:
    OptionalViewandSliceProgressionDirectionMacro - object representing Optional View and Slice Progression Direction 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

Class USImageModule

Field Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

objSingleCollection

Constructor Detail

USImageModule

Method Detail

validateModule

setImageType

setAcquisitionDateTime

setStageName

setStageNumber

setNumberOfStages

setViewName

setViewNumber

setNumberOfEventTimers

setNumberOfViewsInStage

setEventElapsedTimes

setEventTimerNames

setTriggerTime

setNominalInterval

setBeatRejectionFlag

setLowRRValue

setHighRRValue

setHeartRate

setIVUSAcquisition

setIVUSPullbackRate

setIVUSGatedRate

setIVUSPullbackStartFrameNumber

setIVUSPullbackStopFrameNumber

setLesionNumber

setOutputPower

setTransducerData

setFocusDepth

setProcessingFunction

setMechanicalIndex

setBoneThermalIndex

setCranialThermalIndex

setSoftTissueThermalIndex

setSoftTissueFocusThermalIndex

setSoftTissueSurfaceThermalIndex

setDepthOfScanField

setTransducerType

setRWaveTimeVector

setSamplesPerPixel

setPhotometricInterpretation

setPlanarConfiguration

setFrameIncrementPointer

setUltrasoundColorDataPresent

setBitsAllocated

setBitsStored

setHighBit

setPixelRepresentation

setLossyImageCompression

getImageType

getAcquisitionDateTime

getReferencedCurveSequence

getStageName

getStageNumber

getNumberOfStages

getViewName

getViewNumber

getNumberOfEventTimers

getNumberOfViewsInStage

getEventElapsedTimes

getEventTimerNames

getTransducerOrientationSequence

getTriggerTime

getNominalInterval

getBeatRejectionFlag

getLowRRValue

getHighRRValue

getHeartRate

getIVUSAcquisition

getIVUSPullbackRate

getIVUSGatedRate