cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class MRSpectroscopyModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.MRSpectroscopyModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class MRSpectroscopyModule
extends Module

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

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getBaselineCorrection() Retrieves baseline correction techniques.
double[]	getChemicalShiftReference() Retrieves the chemical shift at the transmitter frequency in ppm.
java.lang.String[]	getDeCoupledNucleus() Retrieves type of Nucleus being de-coupled..
java.lang.String	getDeCoupling() Retrieves status of de-coupling.
double[]	getDeCouplingChemicalShiftReference() Retrieves the chemical shift in ppm at the decoupling frequency.
double[]	getDeCouplingFrequency() Retrieves center frequency (Hz) for the decoupling.
java.lang.String	getDeCouplingMethod() Retrieves the de-coupling modulation scheme used.
java.lang.String	getFirstOrderPhaseCorrection() Retrieves of a first order (frequency dependent) phase correction applied to the spectral data.
java.lang.String	getFrequencyCorrection() Retrieves status of operations that were performed to correct resonant frequency of metabolite peaks due to B0 field inhomogeneities.
java.lang.String[]	getImageType() Retrieves spectroscopy data characteristics.
MRImageAndSpectroscopyInstanceMacro	getMRImageAndSpectroscopyInstanceMacro() Returns instance of MRImageAndSpectroscopyInstanceMacro.
MRSpectroscopyDescriptionMacro	getMRSpectroscopyDescriptionMacro() Returns instance of MRSpectroscopyDescriptionMacro.
java.lang.Short[]	getNumberofZeroFills() Retrieves Number of zero fills added to the time domain data before FT.
double[]	getSpectralWidth() Retrieves spectral width in Hz.
java.lang.String[]	getTimeDomainFiltering() Retrieves the de-coupling modulation scheme used.
double[]	getTransmitterFrequency() Retrieves Precession frequency in MHz of the nucleus being addressed for each spectral axis.
ISingleCollection<ITag>	getVectorOfKeys() Returns the collection of keys representing the DataElements that belong to this module.
VolumeLocalizationSequence	getVolumeLocalizationSequence() Retrieves pre-initialized object of Volume Localization 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
java.lang.String	getVolumeLocalizationTechnique() Retrieves Name of volume localization technique used..
java.lang.String	getWaterReferencedPhaseCorrection() Retrieves status of a Water Referenced Phase Correction.
void	setBaselineCorrection(EnumBaselineCorrection enumBaselineCorrection) Sets baseline correction techniques.
void	setChemicalShiftReference(double[] arrdblChemicalShiftReference) Sets the chemical shift at the transmitter frequency in ppm..
void	setDeCoupledNucleus(EnumDeCoupledNucleus[] enumDeCoupledNucleus) Sets type of Nucleus being de-coupled.
void	setDeCoupling(EnumDeCoupling enumDeCoupling) Sets status of de-coupling.
void	setDeCouplingChemicalShiftReference(double[] arrdblDeCouplingChemicalShiftReference) Sets the chemical shift in ppm at the decoupling frequency.
void	setDeCouplingFrequency(double[] arrdblDeCouplingFrequency) Sets center frequency (Hz) for the decoupling.
void	setDeCouplingMethod(EnumDeCouplingMethod enumDeCouplingMethod) Sets the de-coupling modulation scheme used.
void	setFirstOrderPhaseCorrection(EnumFirstOrderPhaseCorrection enumFirstOrderPhaseCorrection) Sets status of a first order (frequency dependent) phase correction applied to the spectral data.
void	setFrequencyCorrection(EnumFrequencyCorrection enumFrequencyCorrection) Sets status of operations that were performed to correct resonant frequency of metabolite peaks due to B0 field inhomogeneities.
void	setImageType(java.lang.String[] arrImageType) Sets spectroscopy data characteristics.
void	setNumberofZeroFills(short[] arrshNumberofZeroFills) Sets Number of zero fills added to the time domain data before FT.
void	setSpectralWidth(double[] arrdblSpectralWidth) Sets spectral width in Hz.
void	setTimeDomainFiltering(EnumTimeDomainFiltering[] enumTimeDomainFiltering) Sets time domain filtering or apodization applied.
void	setTransmitterFrequency(double[] arrdblTransmitterFrequency) Sets Precession frequency in MHz of the nucleus being addressed for each spectral axis.
void	setVolumeLocalizationTechnique(EnumVolumeLocalizationTechnique enumVolumeLocalizationTechnique) Sets Name of volume localization technique used.
void	setWaterReferencedPhaseCorrection(EnumWaterReferencedPhaseCorrection enumWaterReferencedPhaseCorrection) Sets status of a Water Referenced Phase Correction.
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

MRSpectroscopyModule

public MRSpectroscopyModule(IDataSet objIDataSet)

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

setImageType

public void setImageType(java.lang.String[] arrImageType)

Sets spectroscopy data characteristics.

Parameters:

arrImageType - - String array of spectroscopy data.

getImageType

public java.lang.String[] getImageType()

Retrieves spectroscopy data characteristics.

Returns:

String[] - String array of spectroscopy data.

setTransmitterFrequency

public void setTransmitterFrequency(double[] arrdblTransmitterFrequency)

Sets Precession frequency in MHz of the nucleus being addressed for each spectral axis.

Parameters:

arrdblTransmitterFrequency - the arrdbl transmitter frequency

getTransmitterFrequency

public double[] getTransmitterFrequency()

Retrieves Precession frequency in MHz of the nucleus being addressed for each spectral axis.

Returns:

the transmitter frequency

setSpectralWidth

public void setSpectralWidth(double[] arrdblSpectralWidth)

Sets spectral width in Hz.

Parameters:

arrdblSpectralWidth - the arrdbl spectral width

getSpectralWidth

public double[] getSpectralWidth()

Retrieves spectral width in Hz.

Returns:

the spectral width

setChemicalShiftReference

public void setChemicalShiftReference(double[] arrdblChemicalShiftReference)

Sets the chemical shift at the transmitter frequency in ppm..

Parameters:

arrdblChemicalShiftReference - the arrdbl chemical shift reference

getChemicalShiftReference

public double[] getChemicalShiftReference()

Retrieves the chemical shift at the transmitter frequency in ppm.

Returns:

the chemical shift reference

setVolumeLocalizationTechnique

public void setVolumeLocalizationTechnique(EnumVolumeLocalizationTechnique enumVolumeLocalizationTechnique)

Sets Name of volume localization technique used.

Parameters:

enumVolumeLocalizationTechnique - the enum volume localization technique

getVolumeLocalizationTechnique

public java.lang.String getVolumeLocalizationTechnique()

Retrieves Name of volume localization technique used..

Returns:

String - String array of spectroscopy data.

getVolumeLocalizationSequence

public VolumeLocalizationSequence getVolumeLocalizationSequence()

Retrieves pre-initialized object of Volume Localization 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:

VolumeLocalizationSequence - instance of Volume Localization Sequence.

setDeCoupling

public void setDeCoupling(EnumDeCoupling enumDeCoupling)

Sets status of de-coupling.

Parameters:

enumDeCoupling - the enum de coupling

getDeCoupling

public java.lang.String getDeCoupling()

Retrieves status of de-coupling.

Returns:

String[] - String array of spectroscopy data.

setDeCoupledNucleus

public void setDeCoupledNucleus(EnumDeCoupledNucleus[] enumDeCoupledNucleus)

Sets type of Nucleus being de-coupled.

Parameters:

enumDeCoupledNucleus - the enum de coupled nucleus

getDeCoupledNucleus

public java.lang.String[] getDeCoupledNucleus()

Retrieves type of Nucleus being de-coupled..

Returns:

String[] - String array of spectroscopy data.

setDeCouplingFrequency

public void setDeCouplingFrequency(double[] arrdblDeCouplingFrequency)

Sets center frequency (Hz) for the decoupling.

Parameters:

arrdblDeCouplingFrequency - the arrdbl de coupling frequency

getDeCouplingFrequency

public double[] getDeCouplingFrequency()

Retrieves center frequency (Hz) for the decoupling.

Returns:

the de coupling frequency

setDeCouplingMethod

public void setDeCouplingMethod(EnumDeCouplingMethod enumDeCouplingMethod)

Sets the de-coupling modulation scheme used.

Parameters:

enumDeCouplingMethod - the enum de coupling method

getDeCouplingMethod

public java.lang.String getDeCouplingMethod()

Retrieves the de-coupling modulation scheme used.

Returns:

String[] - String array of spectroscopy data.

setDeCouplingChemicalShiftReference

public void setDeCouplingChemicalShiftReference(double[] arrdblDeCouplingChemicalShiftReference)

Sets the chemical shift in ppm at the decoupling frequency.

Parameters:

arrdblDeCouplingChemicalShiftReference - the arrdbl de coupling chemical shift reference

getDeCouplingChemicalShiftReference

public double[] getDeCouplingChemicalShiftReference()

Retrieves the chemical shift in ppm at the decoupling frequency.

Returns:

the de coupling chemical shift reference

setTimeDomainFiltering

public void setTimeDomainFiltering(EnumTimeDomainFiltering[] enumTimeDomainFiltering)

Sets time domain filtering or apodization applied.

Parameters:

enumTimeDomainFiltering - the enum time domain filtering

getTimeDomainFiltering

public java.lang.String[] getTimeDomainFiltering()

Retrieves the de-coupling modulation scheme used.

Returns:

String[] - String array of spectroscopy data.

setNumberofZeroFills

public void setNumberofZeroFills(short[] arrshNumberofZeroFills)

Sets Number of zero fills added to the time domain data before FT.

Parameters:

arrshNumberofZeroFills - the arrsh numberof zero fills

getNumberofZeroFills

public java.lang.Short[] getNumberofZeroFills()

Retrieves Number of zero fills added to the time domain data before FT.

Returns:

Short[] - String array of spectroscopy data.

setBaselineCorrection

public void setBaselineCorrection(EnumBaselineCorrection enumBaselineCorrection)

Sets baseline correction techniques.

Parameters:

enumBaselineCorrection - - Enumeration for baseline correction techniques

getBaselineCorrection

public java.lang.String getBaselineCorrection()

Retrieves baseline correction techniques.

Returns:

String - String value of baseline correction techniques.

setFrequencyCorrection

public void setFrequencyCorrection(EnumFrequencyCorrection enumFrequencyCorrection)

Sets status of operations that were performed to correct resonant frequency of metabolite peaks due to B0 field inhomogeneities.

Parameters:

enumFrequencyCorrection - - enumeration status of Frequency Correction

getFrequencyCorrection

public java.lang.String getFrequencyCorrection()

Retrieves status of operations that were performed to correct resonant frequency of metabolite peaks due to B0 field inhomogeneities.

Returns:

String - status of Frequency Correction.

setFirstOrderPhaseCorrection

public void setFirstOrderPhaseCorrection(EnumFirstOrderPhaseCorrection enumFirstOrderPhaseCorrection)

Sets status of a first order (frequency dependent) phase correction applied to the spectral data.

Parameters:

enumFirstOrderPhaseCorrection - - enumeration status of first order (frequency dependent) phase correction

getFirstOrderPhaseCorrection

public java.lang.String getFirstOrderPhaseCorrection()

Retrieves of a first order (frequency dependent) phase correction applied to the spectral data.

Returns:

String - status of first order (frequency dependent) phase correction

setWaterReferencedPhaseCorrection

public void setWaterReferencedPhaseCorrection(EnumWaterReferencedPhaseCorrection enumWaterReferencedPhaseCorrection)

Sets status of a Water Referenced Phase Correction.

Parameters:

enumWaterReferencedPhaseCorrection - the enum water referenced phase correction

getWaterReferencedPhaseCorrection

public java.lang.String getWaterReferencedPhaseCorrection()

Retrieves status of a Water Referenced Phase Correction.

Returns:

String - status of a Water Referenced Phase Correction.

getMRImageAndSpectroscopyInstanceMacro

public MRImageAndSpectroscopyInstanceMacro getMRImageAndSpectroscopyInstanceMacro()

Returns instance of MRImageAndSpectroscopyInstanceMacro.

Returns:

Instance of MRImageAndSpectroscopyInstanceMacro

getMRSpectroscopyDescriptionMacro

public MRSpectroscopyDescriptionMacro getMRSpectroscopyDescriptionMacro()

Returns instance of MRSpectroscopyDescriptionMacro.

Returns:

Instance of MRSpectroscopyDescriptionMacro

getVectorOfKeys

public ISingleCollection<ITag> getVectorOfKeys()

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