cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class MRPulseSequenceModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.MRPulseSequenceModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class MRPulseSequenceModule
extends Module

\* This module specifies the attributes of the MR Pulse Sequence Module.

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getCoverageOfKSpace() Return Coverage of k-Space.
java.lang.String	getEchoPlanarPulseSequence() Return Echo Planar Pulse Sequence.
java.lang.String	getEchoPulseSequence() Return Echo category of pulse sequences.
java.lang.String	getGeometryOfKSpaceTraversal() Return Geometry category of k-Space traversal.
java.lang.String	getMRAcquisitionType() Return Identification of data encoding scheme.
java.lang.String	getMultiPlanarExcitation() Return technique that simultaneously excites several volumes.
java.lang.String	getMultipleSpinEcho() Return Multiple Spin Echo category of pulse sequence used to collect different lines in k-space for a single frame.
short	getNumberOfKSpaceTrajectories() Return Number of interleaves or shots.
java.lang.String	getOversamplingPhase() Return Oversampling Phase.
java.lang.String	getPhaseContrast() Return phase contrast Pulse sequence is a pulse sequence in which the flowing spins are velocity encoded in phase.
java.lang.String	getPulseSequenceName() Retrieves name of the pulse sequence for annotation purposes.
java.lang.String	getRectilinearPhaseEncodeReordering() Return Rectilinear phase encode reordering.
java.lang.String	getSaturationRecovery() Return Saturation recovery pulse sequence.
java.lang.String	getSegmentedKSpaceTraversal() Return Segmented k-Space traversal.
java.lang.String	getSpectrallySelectedSuppression() Return Spectrally Selected Suppression.
java.lang.String	getSteadyStatePulseSequence() Return Steady State Pulse Sequence.
java.lang.String	getTimeOfFlightContrast() Return Time of Flight contrast is created by the inflow of blood in the saturated plane.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the collection of keys representing the DataElements that belong to this module.
void	setCoverageOfKSpace(EnumCoverageofkSpace enumCoverageOfKSpace) Sets Coverage of k-Space in the ky-kz plane.
void	setEchoPlanarPulseSequence(EnumEchoPlanarPulseSequence enumEchoPlanarPulseSequence) Sets Echo Planar category of Pulse Sequences.
void	setEchoPulseSequence(EnumEchoPulseSequence enumEchoPulseSequence) Sets Echo category of pulse sequences.
void	setGeometryOfKSpaceTraversal(EnumGeometryofk_SpaceTraversal enumGeometryOfKSpaceTraversal) Sets Geometry category of k-Space traversal.
void	setMRAcquisitionType(EnumMRAcquisitionType enumMRAcquisitionType) Sets Identification of spatial data encoding scheme.
void	setMultiPlanarExcitation(EnumMultiplanarExcitation enumMultiPlanarExcitation) Sets 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 for a single frame.
void	setNumberOfKSpaceTrajectories(short shNumberOfKSpaceTrajectories) Sets Number of k-Space Trajectories.
void	setOversamplingPhase(EnumOversamplingPhase enumOversamplingPhase) Sets Oversampling Phase.
void	setPhaseContrast(EnumPhaseContrast enumPhaseContrast) Sets phase contrast Pulse sequence is a pulse sequence in which the flowing spins are velocity encoded in phase.
void	setPulseSequenceName(java.lang.String strPulseSequenceName) Sets name of the pulse sequence for annotation purposes.
void	setRectilinearPhaseEncodeReordering(EnumRectilinearPhaseEncodeReordering enumRectilinearPhaseEncodeReordering) Sets Rectilinear phase encode reordering.
void	setSaturationRecovery(EnumSaturationRecovery enumSaturationRecovery) Sets Saturation recovery pulse sequence.
void	setSegmentedKSpaceTraversal(EnumSegmentedkSpaceTraversal enumSegmentedKSpaceTraversal) Sets Segmented k-Space traversal.
void	setSpectrallySelectedSuppression(EnumSpectrallySelectedSuppression enumSpectrallySelectedSuppression) Sets spectrally Selected Suppression.
void	setSteadyStatePulseSequence(EnumSteadyStatePulseSequence enumSteadyStatePulseSequence) Sets Steady State Sequence.
void	setTimeOfFlightContrast(EnumTimeofFlightContrast enumTimeOfFlightContrast) Sets Time of Flight contrast is created by the inflow of blood in the saturated plane.
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

MRPulseSequenceModule

public MRPulseSequenceModule(IDataSet objIDataSet)

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

- 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. Potentially vendorspecific name.

Parameters:

strPulseSequenceName - - String value of Pulse Sequence Name.

getPulseSequenceName

public java.lang.String getPulseSequenceName()

Retrieves name of the pulse sequence for annotation purposes.

Returns:

String - String value of Pulse Sequence Name.

setMRAcquisitionType

public void setMRAcquisitionType(EnumMRAcquisitionType enumMRAcquisitionType)

Sets Identification of spatial data encoding scheme. Defined Terms: 1D,2D,3D.

Parameters:

enumMRAcquisitionType - - enum value of MR Acquisition Type.

getMRAcquisitionType

public java.lang.String getMRAcquisitionType()

Return Identification of data encoding scheme.

Returns:

String - String value of MR Acquisition Type.

setEchoPulseSequence

public void setEchoPulseSequence(EnumEchoPulseSequence enumEchoPulseSequence)

Sets Echo category of pulse sequences. Enumerated Values: 1) SPIN. 2) GRADIENT. 3) BOTH.

Parameters:

enumEchoPulseSequence - - Enum value of Echo Pulse Sequence.

getEchoPulseSequence

public java.lang.String getEchoPulseSequence()

Return Echo category of pulse sequences.

Returns:

String - String value of Echo Pulse Sequence.

setMultipleSpinEcho

public void setMultipleSpinEcho(EnumMultipleSpinEcho enumMultipleSpinEcho)

Sets Multiple Spin Echo category of pulse sequence used to collect different lines in k-space for a single frame. numerated Values: YES,NO.

Parameters:

enumMultipleSpinEcho - - enum value of Multiple Spin Echo.

getMultipleSpinEcho

public java.lang.String getMultipleSpinEcho()

Return Multiple Spin Echo category of pulse sequence used to collect different lines in k-space for a single frame.

Returns:

String - String value of Multiple Spin Echo.

setMultiPlanarExcitation

public void setMultiPlanarExcitation(EnumMultiplanarExcitation enumMultiPlanarExcitation)

Sets technique that simultaneously excites several volumes. Enumerated Values: YES,NO.

Parameters:

enumMultiPlanarExcitation - - Enum value of Multi-planar Excitation.

getMultiPlanarExcitation

public java.lang.String getMultiPlanarExcitation()

Return technique that simultaneously excites several volumes.

Returns:

String - String value of Multi-planar Excitation.

setPhaseContrast

public void setPhaseContrast(EnumPhaseContrast enumPhaseContrast)

Sets phase contrast Pulse sequence is a pulse sequence in which the flowing spins are velocity encoded in phase. Enumerated Values: YES,NO.

Parameters:

enumPhaseContrast - - enum value of Phase Contrast.

getPhaseContrast

public java.lang.String getPhaseContrast()

Return phase contrast Pulse sequence is a pulse sequence in which the flowing spins are velocity encoded in phase.

Returns:

String - String value of Phase Contrast.

setTimeOfFlightContrast

public void setTimeOfFlightContrast(EnumTimeofFlightContrast enumTimeOfFlightContrast)

Sets Time of Flight contrast is created by the inflow of blood in the saturated plane. Enumerated Values: YES,NO.

Parameters:

enumTimeOfFlightContrast - - Enum value of Time of Flight Contrast.

getTimeOfFlightContrast

public java.lang.String getTimeOfFlightContrast()

Return Time of Flight contrast is created by the inflow of blood in the saturated plane.

Returns:

String - String value of Time of Flight Contrast.

setSteadyStatePulseSequence

public void setSteadyStatePulseSequence(EnumSteadyStatePulseSequence enumSteadyStatePulseSequence)

Sets Steady State Sequence. Defined Terms: 1) FREE_PRECESSION. 2) TRANSVERSE. 3) TIME_REVERSED. 4) LONGITUDINAL. 5) NONE.

Parameters:

enumSteadyStatePulseSequence - - Enum value of Steady State Pulse Sequence.

getSteadyStatePulseSequence

public java.lang.String getSteadyStatePulseSequence()

Return Steady State Pulse Sequence.

Returns:

String - String value of Steady State Pulse Sequence.

setEchoPlanarPulseSequence

public void setEchoPlanarPulseSequence(EnumEchoPlanarPulseSequence enumEchoPlanarPulseSequence)

Sets Echo Planar category of Pulse Sequences. Enumerated Values: YES,NO.

Parameters:

enumEchoPlanarPulseSequence - - Enum value of Echo Planar Pulse Sequence.

getEchoPlanarPulseSequence

public java.lang.String getEchoPlanarPulseSequence()

Return Echo Planar Pulse Sequence.

Returns:

String - String value of Echo Planar Pulse Sequence.

setSaturationRecovery

public void setSaturationRecovery(EnumSaturationRecovery enumSaturationRecovery)

Sets Saturation recovery pulse sequence. Enumerated Values: YES,NO.

Parameters:

enumSaturationRecovery - the enum saturation recovery

getSaturationRecovery

public java.lang.String getSaturationRecovery()

Return Saturation recovery pulse sequence.

Returns:

String - String value of Saturation Recovery.

setSpectrallySelectedSuppression

public void setSpectrallySelectedSuppression(EnumSpectrallySelectedSuppression enumSpectrallySelectedSuppression)

Sets spectrally Selected Suppression. Defined Terms: 1) FAT. 2) WATER. 3) FAT_AND_WATER. 4) SILICON_GEL. 5) NONE.

Parameters:

enumSpectrallySelectedSuppression - - Enum value of spectrally Selected Suppression.

getSpectrallySelectedSuppression

public java.lang.String getSpectrallySelectedSuppression()

Return Spectrally Selected Suppression.

Returns:

String - String value of Spectrally Selected Suppression.

setOversamplingPhase

public void setOversamplingPhase(EnumOversamplingPhase enumOversamplingPhase)

Sets Oversampling Phase. Enumerated Values: 1) 2D = phase direction 2) 3D = out of plane direction 3) 2D_3D = both. 4) NONE.

Parameters:

enumOversamplingPhase - - Enum value of Oversampling Phase.

getOversamplingPhase

public java.lang.String getOversamplingPhase()

Return Oversampling Phase.

Returns:

String - String value of Oversampling Phase.

setGeometryOfKSpaceTraversal

public void setGeometryOfKSpaceTraversal(EnumGeometryofk_SpaceTraversal enumGeometryOfKSpaceTraversal)

Sets Geometry category of k-Space traversal. Defined Terms: 1) RECTILINEAR. 2) RADIAL. 3) SPIRAL.

Parameters:

enumGeometryOfKSpaceTraversal - - Enum value of Geometry of k-Space Traversal.

getGeometryOfKSpaceTraversal

public java.lang.String getGeometryOfKSpaceTraversal()

Return Geometry category of k-Space traversal.

Returns:

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

setRectilinearPhaseEncodeReordering

public void setRectilinearPhaseEncodeReordering(EnumRectilinearPhaseEncodeReordering enumRectilinearPhaseEncodeReordering)

Sets Rectilinear phase encode reordering. Defined Terms: 1) LINEAR. 2) CENTRIC. 3) SEGMENTED. 4) REVERSE_LINEAR. 5) REVERSE_CENTRIC.

Parameters:

enumRectilinearPhaseEncodeReordering - - Enum value of Rectilinear Phase Encode Reordering.

getRectilinearPhaseEncodeReordering

public java.lang.String getRectilinearPhaseEncodeReordering()

Return Rectilinear phase encode reordering.

Returns:

String - String value of Rectilinear Phase Encode Reordering.

setSegmentedKSpaceTraversal

public void setSegmentedKSpaceTraversal(EnumSegmentedkSpaceTraversal enumSegmentedKSpaceTraversal)

Sets Segmented k-Space traversal. If Geometry of k-Space Traversal is rectilinear, multiple lines can be acquired at one time. If Geometry of k-Space Traversal is spiral or radial, paths can be interleaved and acquired at one time. Enumerated Values: 1) SINGLE = successive single echo coverage. 2) PARTIAL = segmented coverage. 3) FULL = single shot full coverage.

Parameters:

enumSegmentedKSpaceTraversal - - enum value of Segmented k-Space Traversal.

getSegmentedKSpaceTraversal

public java.lang.String getSegmentedKSpaceTraversal()

Return Segmented k-Space traversal.

Returns:

String - String value of Segmented k-Space Traversal.

setCoverageOfKSpace

public void setCoverageOfKSpace(EnumCoverageofkSpace enumCoverageOfKSpace)

Sets Coverage of k-Space in the ky-kz plane. Defined Terms: 1) FULL. 2) ELLIPTICAL. 3) WEIGHTED.

Parameters:

enumCoverageOfKSpace - - Enum value of Coverage of k-Space.

getCoverageOfKSpace

public java.lang.String getCoverageOfKSpace()

Return Coverage of k-Space.

Returns:

String - String value of Coverage of k-Space.

setNumberOfKSpaceTrajectories

public void setNumberOfKSpaceTrajectories(short shNumberOfKSpaceTrajectories)

Sets Number of k-Space Trajectories.

Parameters:

shNumberOfKSpaceTrajectories - - short value of Number of k-Space Trajectories.

getNumberOfKSpaceTrajectories

public short getNumberOfKSpaceTrajectories()

Return Number of interleaves or shots.

Returns:

short - short value of Number of k-Space Trajectories.

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 of tags