cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class MRSpectroscopyPulseSequenceModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.MRSpectroscopyPulseSequenceModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class MRSpectroscopyPulseSequenceModule
extends Module

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

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
MRSpectroscopyPulseSequenceModule(IDataSet objIDataSet) Instantiates a new mR spectroscopy pulse sequence module.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getCoverageofkSpace() Retrieves value of Coverage of k-Space.
java.lang.String	getEchoPeakPosition() Retrieves Echo Peak Position.
java.lang.String	getEchoPlanarPulseSequence() Retrieves value of echo Planar category of pulse sequences.
java.lang.String	getEchoPulseSequence() Retrieves echo category of pulse sequences.
java.lang.String	getGeometryofkSpaceTraversal() Retrieves value of Geometry of k-Space Traversal.
java.lang.String	getMRSpectroscopyAcquisitionType() Retrieves identification of data encoding scheme.
java.lang.String	getMultiplanarExcitation() Retrieves value of technique that simultaneously excites several volumes.
java.lang.String	getMultipleSpinEcho() Retrieves multiple Spin Echo category of pulse sequence used to collect different lines in k-space.
short	getNumberofkSpaceTrajectories() Retrieves value of Number of k-Space Trajectories.
java.lang.String	getPulseSequenceName() Retrieves name of the pulse sequence for annotation purposes.
java.lang.String	getRectilinearPhaseEncodeReordering() Retrieves value of Rectilinear Phase Encode Reordering.
java.lang.String	getSegmentedkSpacetraversal() Retrieves value of Segmented k-Space traversal.
java.lang.String	getSpectrallySelectedSuppression() Retrieves value of Spectrally Selected Suppression.
java.lang.String	getSteadyStatePulseSequence() Retrieves Steady State Sequence.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector of keys representing the DataElements that belong to this module.
void	setCoverageofkSpace(EnumCoverageofkSpace enumCoverageofkSpace) Sets value of Coverage of k-Space.
void	setEchoPeakPosition(java.lang.String strEchoPeakPosition)
void	setEchoPlanarPulseSequence(EnumEchoPlanarPulseSequence enumEchoPlanarPulseSequence) Sets value of echo Planar category of pulse sequences.
void	setEchoPulseSequence(EnumEchoPulseSequence enumEchoPulseSequence) Sets echo category of pulse sequences.
void	setGeometryofkSpaceTraversal(EnumGeometryofk_SpaceTraversal enumGeometryofk_SpaceTraversal) Sets value of Geometry of k-Space Traversal.
void	setMRSpectroscopyAcquisitionType(EnumMRSpectroscopyAcquisitionType enumMRSpectroscopyAcquisitionType) Sets identification of data encoding scheme.
void	setMultiplanarExcitation(EnumMultiplanarExcitation enumMultiPlanarExcitation) Sets value of technique that simultaneously excites several volumes.
void	setMultipleSpinEcho(EnumMultipleSpinEcho enumMultipleSpinEcho) Sets multiple Spin Echo category of pulse sequence used to collect different lines in k-space.
void	setNumberofkSpaceTrajectories(short shNumberOfKSpaceTrajectories) Sets value of Number of k-Space Trajectories.
void	setPulseSequenceName(java.lang.String strPulseSequenceName) Sets name of the pulse sequence for annotation purposes.
void	setRectilinearPhaseEncodeReordering(EnumRectilinearPhaseEncodeReordering enumRectilinearPhaseEncodeReordering) Sets value of Rectilinear Phase Encode Reordering.
void	setSegmentedkSpacetraversal(EnumSegmentedkSpaceTraversal enumSegmentedkSpaceTraversal) Sets value of Segmented k-Space traversal.
void	setSpectrallySelectedSuppression(EnumSpectrallySelectedSuppression enumSpectrallySelectedSuppression) Sets value of Spectrally Selected Suppression.
void	setSteadyStatePulseSequence(EnumSteadyStatePulseSequence enumSteadyStatePulseSequence) Sets Steady State Sequence.
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

MRSpectroscopyPulseSequenceModule

public MRSpectroscopyPulseSequenceModule(IDataSet objIDataSet)

Instantiates a new mR spectroscopy pulse sequence 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

setPulseSequenceName

public void setPulseSequenceName(java.lang.String strPulseSequenceName)

Sets name of the pulse sequence for annotation purposes.

Parameters:

strPulseSequenceName - - string form of name of the pulse sequence for annotation purposes.

getPulseSequenceName

public java.lang.String getPulseSequenceName()

Retrieves name of the pulse sequence for annotation purposes.

Returns:

String - String form of name of the pulse sequence for annotation purposes.

setMRSpectroscopyAcquisitionType

public void setMRSpectroscopyAcquisitionType(EnumMRSpectroscopyAcquisitionType enumMRSpectroscopyAcquisitionType)

Sets identification of data encoding scheme.

Parameters:

enumMRSpectroscopyAcquisitionType - - enumeration of identification of data encoding scheme

getMRSpectroscopyAcquisitionType

public java.lang.String getMRSpectroscopyAcquisitionType()

Retrieves identification of data encoding scheme.

Returns:

String - String form of identification of data encoding scheme.

setEchoPulseSequence

public void setEchoPulseSequence(EnumEchoPulseSequence enumEchoPulseSequence)

Sets echo category of pulse sequences.

Parameters:

enumEchoPulseSequence - - enumeration of echo category of pulse sequences.

getEchoPulseSequence

public java.lang.String getEchoPulseSequence()

Retrieves echo category of pulse sequences.

Returns:

String - String form of echo category of pulse sequences.

setMultipleSpinEcho

public void setMultipleSpinEcho(EnumMultipleSpinEcho enumMultipleSpinEcho)

Sets multiple Spin Echo category of pulse sequence used to collect different lines in k-space.

Parameters:

enumMultipleSpinEcho - - enumeration of Spin Echo category of pulse sequence.

getMultipleSpinEcho

public java.lang.String getMultipleSpinEcho()

Retrieves multiple Spin Echo category of pulse sequence used to collect different lines in k-space.

Returns:

String - String form of Spin Echo category of pulse sequence.

setMultiplanarExcitation

public void setMultiplanarExcitation(EnumMultiplanarExcitation enumMultiPlanarExcitation)

Sets value of technique that simultaneously excites several volumes.

Parameters:

enumMultiplanarExcitation - - enumeration of value of technique that simultaneously excites several volumes.

getMultiplanarExcitation

public java.lang.String getMultiplanarExcitation()

Retrieves value of technique that simultaneously excites several volumes.

Returns:

String - String value of technique that simultaneously excites several volumes.

setSteadyStatePulseSequence

public void setSteadyStatePulseSequence(EnumSteadyStatePulseSequence enumSteadyStatePulseSequence)

Sets Steady State Sequence.

Parameters:

enumSteadyStatePulseSequence - the enum steady state pulse sequence

getSteadyStatePulseSequence

public java.lang.String getSteadyStatePulseSequence()

Retrieves Steady State Sequence.

Returns:

String - String value of Steady State Sequence.

setEchoPlanarPulseSequence

public void setEchoPlanarPulseSequence(EnumEchoPlanarPulseSequence enumEchoPlanarPulseSequence)

Sets value of echo Planar category of pulse sequences.

Parameters:

enumEchoPlanarPulseSequence - the enum echo planar pulse sequence

getEchoPlanarPulseSequence

public java.lang.String getEchoPlanarPulseSequence()

Retrieves value of echo Planar category of pulse sequences.

Returns:

String - String value of echo Planar category of pulse sequences

setSpectrallySelectedSuppression

public void setSpectrallySelectedSuppression(EnumSpectrallySelectedSuppression enumSpectrallySelectedSuppression)

Sets value of Spectrally Selected Suppression.

Parameters:

enumSpectrallySelectedSuppression - the enum spectrally selected suppression

getSpectrallySelectedSuppression

public java.lang.String getSpectrallySelectedSuppression()

Retrieves value of Spectrally Selected Suppression.

Returns:

String - String value of Spectrally Selected Suppression.

setGeometryofkSpaceTraversal

public void setGeometryofkSpaceTraversal(EnumGeometryofk_SpaceTraversal enumGeometryofk_SpaceTraversal)

Sets value of Geometry of k-Space Traversal.

Parameters:

enumGeometryofk_SpaceTraversal - the enum geometryofk_ space traversal

getGeometryofkSpaceTraversal

public java.lang.String getGeometryofkSpaceTraversal()

Retrieves value of Geometry of k-Space Traversal.

Returns:

String - String value of Geometry of k-Space Traversal.

setRectilinearPhaseEncodeReordering

public void setRectilinearPhaseEncodeReordering(EnumRectilinearPhaseEncodeReordering enumRectilinearPhaseEncodeReordering)

Sets value of Rectilinear Phase Encode Reordering.

Parameters:

enumRectilinearPhaseEncodeReordering - the enum rectilinear phase encode reordering

getRectilinearPhaseEncodeReordering

public java.lang.String getRectilinearPhaseEncodeReordering()

Retrieves value of Rectilinear Phase Encode Reordering.

Returns:

String - String value of Rectilinear Phase Encode Reordering

setSegmentedkSpacetraversal

public void setSegmentedkSpacetraversal(EnumSegmentedkSpaceTraversal enumSegmentedkSpaceTraversal)

Sets value of Segmented k-Space traversal.

Parameters:

enumSegmentedkSpaceTraversal - the enum segmentedk space traversal

getSegmentedkSpacetraversal

public java.lang.String getSegmentedkSpacetraversal()

Retrieves value of Segmented k-Space traversal.

Returns:

String - String value of Segmented k-Space traversal.

setCoverageofkSpace

public void setCoverageofkSpace(EnumCoverageofkSpace enumCoverageofkSpace)

Sets value of Coverage of k-Space.

Parameters:

enumCoverageofkSpace - the enum coverageofk space

getCoverageofkSpace

public java.lang.String getCoverageofkSpace()

Retrieves value of Coverage of k-Space.

Returns:

String - String value of Coverage of k-Space

setNumberofkSpaceTrajectories

public void setNumberofkSpaceTrajectories(short shNumberOfKSpaceTrajectories)

Sets value of Number of k-Space Trajectories.

Parameters:

shCoverageofkSpaceTrajectories - the sh coverageofk space trajectories

getNumberofkSpaceTrajectories

public short getNumberofkSpaceTrajectories()

Retrieves value of Number of k-Space Trajectories.

Returns:

short - short value of Number of k-Space Trajectories

setEchoPeakPosition

public void setEchoPeakPosition(java.lang.String strEchoPeakPosition)

Parameters:

strEchoPeakPosition - String value of Echo Peak Position.

getEchoPeakPosition

public java.lang.String getEchoPeakPosition()

Retrieves Echo Peak Position.

Returns:

String - value of Referenced Reference Image Number.

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