cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class MRSpectroscopyDataModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.MRSpectroscopyDataModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class MRSpectroscopyDataModule
extends Module

\* This module specifies the attributes of the MR Spectroscopy Data Module.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
MRSpectroscopyDataModule(IDataSet objIDataSet) Instantiates a new mR spectroscopy data module.

Method Summary

Methods

Modifier and Type	Method and Description
short	getColumns() Retrieves Number of voxels in the vertical direction in the frame.
long	getDataPointColumns() Retrieves Number of columns of data points in spectroscopic data.
long	getDataPointRows() Retrieves Number of rows of data points in spectroscopic data.
java.lang.String	getDataRepresentation() Retrieves value Data representation of the data points.
float	getFirstOrderPhaseCorrectionAngle() Retrieves Number of columns of data points in spectroscopic data.
short	getRows() Retrieves Number of voxels in the vertical direction in the frame.
java.lang.String	getSignalDomainColumns() Retrieves value of Domain of represented signal in column direction.
java.lang.String	getSignalDomainRows() Retrieves value of Domain of represented signal in row direction.
float	getSpectroscopyData() Retrieves A data stream of the signal intensities that comprise the spectroscopic data.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector of keys representing the DataElements that belong to this module.
void	setColumns(short shColumns) Sets Number of voxels in the horizontal direction in the frame.
void	setDataPointColumns(long lDataPointColumns) Sets Number of columns of data points in spectroscopic data.
void	setDataPointRows(long lDataPointRows) Sets Number of rows of data points in spectroscopic data.
void	setDataRepresentation(EnumDataRepresentation enumDataRepresentation) Sets value of Data representation of the data points.
void	setFirstOrderPhaseCorrectionAngle(float fFirstOrderPhaseCorrectionAngle) Sets Number of columns of data points in spectroscopic data.
void	setRows(short shRows) Sets Number of voxels in the vertical direction in the frame.
void	setSignalDomainColumns(EnumSignalDomainColumns enumSignalDomainColumns) Sets value of Domain of represented signal in column direction.
void	setSignalDomainRows(EnumSignalDomainRows enumSignalDomainColumns) Sets value of Domain of represented signal in row direction.
void	setSpectroscopyData(float fSpectroscopyData) Sets A data stream of the signal intensities that comprise the spectroscopic data.
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

MRSpectroscopyDataModule

public MRSpectroscopyDataModule(IDataSet objIDataSet)

Instantiates a new mR spectroscopy data 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:

boolean - returns validation status as success or failure

Throws:

InvalidModuleException - - If validation of Module fails

setRows

public void setRows(short shRows)

Sets Number of voxels in the vertical direction in the frame.

Parameters:

shRows - - short Number of voxels in the vertical direction in the frame.

getRows

public short getRows()

Retrieves Number of voxels in the vertical direction in the frame.

Returns:

short - Number of voxels in the vertical direction in the frame.

setColumns

public void setColumns(short shColumns)

Sets Number of voxels in the horizontal direction in the frame.

Parameters:

shColumns - - short Number of voxels in the horizontal direction in the frame.

getColumns

public short getColumns()

Retrieves Number of voxels in the vertical direction in the frame.

Returns:

short - Number of voxels in the vertical direction in the frame.

setDataPointRows

public void setDataPointRows(long lDataPointRows)

Sets Number of rows of data points in spectroscopic data.

Parameters:

lDataPointRows - - long Number of rows of data points in spectroscopic data.

getDataPointRows

public long getDataPointRows()

Retrieves Number of rows of data points in spectroscopic data.

Returns:

long - Number of rows of data points in spectroscopic data.

setDataPointColumns

public void setDataPointColumns(long lDataPointColumns)

Sets Number of columns of data points in spectroscopic data.

Parameters:

lDataPointColumns - the l data point columns

getDataPointColumns

public long getDataPointColumns()

Retrieves Number of columns of data points in spectroscopic data.

Returns:

long - Number of columns of data points in spectroscopic data.

setDataRepresentation

public void setDataRepresentation(EnumDataRepresentation enumDataRepresentation)

Sets value of Data representation of the data points.

Parameters:

enumDataRepresentation - the enum data representation

getDataRepresentation

public java.lang.String getDataRepresentation()

Retrieves value Data representation of the data points.

Returns:

String - String value of Data representation of the data points.

setSignalDomainColumns

public void setSignalDomainColumns(EnumSignalDomainColumns enumSignalDomainColumns)

Sets value of Domain of represented signal in column direction.

Parameters:

enumSignalDomainColumns - the enum signal domain columns

getSignalDomainColumns

public java.lang.String getSignalDomainColumns()

Retrieves value of Domain of represented signal in column direction.

Returns:

String - String value of Domain of represented signal in column direction.

setSignalDomainRows

public void setSignalDomainRows(EnumSignalDomainRows enumSignalDomainColumns)

Sets value of Domain of represented signal in row direction.

Parameters:

enumSignalDomainColumns - the enum signal domain columns

getSignalDomainRows

public java.lang.String getSignalDomainRows()

Retrieves value of Domain of represented signal in row direction.

Returns:

String - String value of Domain of represented signal in row direction.

setFirstOrderPhaseCorrectionAngle

public void setFirstOrderPhaseCorrectionAngle(float fFirstOrderPhaseCorrectionAngle)

Sets Number of columns of data points in spectroscopic data.

Parameters:

fFirstOrderPhaseCorrectionAngle - the f first order phase correction angle

getFirstOrderPhaseCorrectionAngle

public float getFirstOrderPhaseCorrectionAngle()

Retrieves Number of columns of data points in spectroscopic data.

Returns:

float - Number of columns of data points in spectroscopic data.

setSpectroscopyData

public void setSpectroscopyData(float fSpectroscopyData)

Sets A data stream of the signal intensities that comprise the spectroscopic data.

Parameters:

fSpectroscopyData - - float value of A data stream of the signal intensities that comprise the spectroscopic data.

getSpectroscopyData

public float getSpectroscopyData()

Retrieves A data stream of the signal intensities that comprise the spectroscopic data.

Returns:

float - Number of columns of data points in spectroscopic data.

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