cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class IntravascularOCTAcquisitionParametersModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.IntravascularOCTAcquisitionParametersModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class IntravascularOCTAcquisitionParametersModule
extends Module

\* This module describes attributes in Intravascular OCT Acquisition Parameters Module.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
IntravascularOCTAcquisitionParametersModule(IDataSet objIDataSet) Creates Intravascular OCT Acquisition Parameters Module with default initialization.

Method Summary

Methods

Modifier and Type	Method and Description
double	getAlineRate() Retrieves A-line Rate.
short	getAlinesPerFrame() Retrieves the A-lines Per Frame.
double	getAxialResolution() Retrieves Axial Resolution.
double	getBeamSpotSize() Retrieves Beam Spot Size.
double	getEffectiveRefractiveIndex() Retrieves Effective Refractive Index.
java.lang.String	getOCTAcquisitionDomain() Retrieves OCT Acquisition Domain.
double	getOCTFocalDistance() Retrieves OCT Focal Distance.
double	getOCTOpticalCenterWavelength() Retrieves OCT Optical Center Wavelength.
double	getRangingDepth() Retrieves Ranging Depth.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the collection of keys representing the DataElements that belong to this module.
void	setAlineRate(double dAlineRate) Sets A-line Rate.
void	setAlinesPerFrame(short sAlinesPerFrame) Sets the A-lines Per Frame.
void	setAxialResolution(double dAxialResolution) Sets Axial Resolution.
void	setBeamSpotSize(double dBeamSpotSize) Sets Beam Spot Size.
void	setEffectiveRefractiveIndex(double dEffectiveRefractiveIndex) Sets Effective Refractive Index.
void	setOCTAcquisitionDomain(EnumOCTAcquisitionDomain enumOCTAcquisitionDomain) Sets OCT Acquisition Domain.
void	setOCTFocalDistance(double dOCTFocalDistance) Sets OCT Focal Distance.
void	setOCTOpticalCenterWavelength(double dOCTOpticalCenterWavelength) Sets OCT Optical Center Wavelength.
void	setRangingDepth(double dRangingDepth) Sets Ranging Depth.
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

IntravascularOCTAcquisitionParametersModule

public IntravascularOCTAcquisitionParametersModule(IDataSet objIDataSet)

Creates Intravascular OCT Acquisition Parameters Module with default initialization.

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 - - If validation of Module fails

setOCTFocalDistance

public void setOCTFocalDistance(double dOCTFocalDistance)

Sets OCT Focal Distance. Distance from focal point to center of catheter, in mm (measured in air).

Parameters:

dOCTFocalDistance - double value of OCT Focal Distance.

getOCTFocalDistance

public double getOCTFocalDistance()

Retrieves OCT Focal Distance.

Returns:

double - double value of OCT Focal Distance.

setBeamSpotSize

public void setBeamSpotSize(double dBeamSpotSize)

Sets Beam Spot Size. Distance from focal point to center of catheter, in mm (measured in air).

Parameters:

dBeamSpotSize - double value of Beam Spot Size.

getBeamSpotSize

public double getBeamSpotSize()

Retrieves Beam Spot Size.

Returns:

double - double value of Beam Spot Size.

setEffectiveRefractiveIndex

public void setEffectiveRefractiveIndex(double dEffectiveRefractiveIndex)

Sets Effective Refractive Index. Index of refraction of the tissue and flush medias used during the Intravascular OCT acquisition.

Parameters:

dEffectiveRefractiveIndex - double value of Effective Refractive Index.

getEffectiveRefractiveIndex

public double getEffectiveRefractiveIndex()

Retrieves Effective Refractive Index.

Returns:

double - double value of Effective Refractive Index.

setOCTAcquisitionDomain

public void setOCTAcquisitionDomain(EnumOCTAcquisitionDomain enumOCTAcquisitionDomain)

Sets OCT Acquisition Domain. Enumerated Values: 1) TIME 2) FREQUENCY 3) SPECTRAL

Parameters:

enumOCTAcquisitionDomain - the enum OCT Acquisition Domain

getOCTAcquisitionDomain

public java.lang.String getOCTAcquisitionDomain()

Retrieves OCT Acquisition Domain.

Returns:

String - String value of OCT Acquisition Domain.

setOCTOpticalCenterWavelength

public void setOCTOpticalCenterWavelength(double dOCTOpticalCenterWavelength)

Sets OCT Optical Center Wavelength. Center optical wavelength of the OCT light source, in μm.

Parameters:

dOCTOpticalCenterWavelength - double value of OCT Optical Center Wavelength.

getOCTOpticalCenterWavelength

public double getOCTOpticalCenterWavelength()

Retrieves OCT Optical Center Wavelength. Center optical wavelength of the OCT light source, in μm.

Returns:

double - double value of OCT Optical Center Wavelength.

setAxialResolution

public void setAxialResolution(double dAxialResolution)

Sets Axial Resolution. The full width at half maximum (FWHM) of the axial plane responsefunction, in μm (measured in air)

Parameters:

dAxialResolution - double value of Axial Resolution.

getAxialResolution

public double getAxialResolution()

Retrieves Axial Resolution. The full width at half maximum (FWHM) of the axial plane responsefunction, in μm (measured in air)

Returns:

double - double value of Axial Resolution.

setRangingDepth

public void setRangingDepth(double dRangingDepth)

Sets Ranging Depth. Maximum detectable sample-to-reference path displacement, in mm(measured in air).

Parameters:

dRangingDepth - double value of Ranging Depth.

getRangingDepth

public double getRangingDepth()

Retrieves Ranging Depth. Maximum detectable sample-to-reference path displacement, in mm(measured in air).

Returns:

double - double value of Ranging Depth.

setAlineRate

public void setAlineRate(double dAlineRate)

Sets A-line Rate. The number of IVOCT A-lines acquired per second in Hz.

Parameters:

dAlineRate - double value of A-line Rate.

getAlineRate

public double getAlineRate()

Retrieves A-line Rate. The number of IVOCT A-lines acquired per second in Hz.

Returns:

double - double value of A-line Rate.

setAlinesPerFrame

public void setAlinesPerFrame(short sAlinesPerFrame)

Sets the A-lines Per Frame. Number of A-lines acquired in an IVOCT frame, including unused(padded) A-lines.

Parameters:

sAlinesPerFrame - short value of A-lines Per Frame.

getAlinesPerFrame

public short getAlinesPerFrame()

Retrieves the A-lines Per Frame.

Returns:

short - short value of A-lines Per Frame.

getVectorOfKeys

public ISingleCollection<ITag> getVectorOfKeys()

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

Overrides:

getVectorOfKeys in class Module

Returns:

Collection of Tags - returns the collection containing the tags