cdac.medinfo.sdk.dcm30_04.baselibs

Class MRImageAndSpectroscopyInstanceMacro

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Macro

cdac.medinfo.sdk.dcm30_04.baselibs.MRImageAndSpectroscopyInstanceMacro

All Implemented Interfaces:

IMacro, java.io.Serializable

public class MRImageAndSpectroscopyInstanceMacro
extends Macro

This Macro specifies the common attributes Enhanced MR Image Module and MR Spectroscopy Module.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MRImageAndSpectroscopyInstanceMacro(IDataSet objDataSet) This constructor constructs a Macro with specified DataSet.
MRImageAndSpectroscopyInstanceMacro(IDataSet objDataSet, IDictionaryReader objDictionaryReader) This constructor constructs a Macro with specified DataSet and DictionaryReader
MRImageAndSpectroscopyInstanceMacro(IItem objItem) This constructor constructs a Macro with the specified Item
MRImageAndSpectroscopyInstanceMacro(IItem objItem, IDictionaryReader objDictionaryReader) This constructor constructs a Macro with the specified Item and DictionaryReader

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAcquisitionDatetime() Retrieves the Date and Time of Acquisition
java.lang.String	getAcquisitionNumber() Return the String value of the attribute Acquisition Number.
java.lang.String	getApplicableSafetyStandardAgency() Retrieves agency that established MR safety standard applicable to the acquisition of this Instance.
java.lang.String	getApplicableSafetyStandardDescription() Retrieves agency that established MR safety standard applicable to the acquisition of this Instance.
double	getCardiacRRIntervalSpecified() Retrieves the time in seconds needed to run the prescribed pulse sequence.
java.lang.String	getContentQualification() Retrieves Content Qualification Indicator.
java.lang.String	getImageComments() Retrieves User-defined comments about the image.
java.lang.String	getIsocenterPosition() Retrieves Isocenter coordinates (x,y,z), in mm.
java.lang.String	getKSpaceFiltering() Retrieves Content Qualification Indicator.
java.lang.String	getMagneticFieldStrength() Retrieves nominal field strength of the MR Magnet,in Tesla.
ReferencedRawDataSequence	getReferencedRawDataSequence() Retrieves pre-initialized object of Referenced Raw Data 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
ReferencedWaveformSequence	getReferencedWaveformSequence() Retrieves pre-initialized object of Referenced Waveform 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	getResonantNucleus() Retrieves Nucleus that is resonant at the transmitter frequency.
void	setAcquisitionDatetime(java.lang.String strAcquisitionDatetime) Sets the date and time the acquisition of data that resulted in this image started.
void	setAcquisitionDuration(double dAcquisitionDuration) Sets the time in seconds needed to run the prescribed pulse sequence.
void	setAcquisitionNumber(java.lang.String strAcquisitionNumber) Sets a number identifying the single continuous gathering of data over a period of time which resulted in this image.
void	setApplicableSafetyStandardAgency(java.lang.String strApplicableSafetyStandardAgency) Sets agency that established MR safety standard applicable to the acquisition of this Instance.
void	setApplicableSafetyStandardDescription(java.lang.String strApplicableSafetyStandardDescription) Sets name and Version of the applicable standard.
void	setContentQualification(java.lang.String strContentQualification) Sets Content Qualification Indicator.
void	setImageComments(java.lang.String strImageComments) Sets User-defined comments about the image.
void	setIsocenterPosition(java.lang.String strIsocenterPosition) Sets Isocenter coordinates (x,y,z), in mm.
void	setKSpaceFiltering(java.lang.String strKSpaceFiltering) Sets k-space filtering applied.
void	setMagneticFieldStrength(java.lang.String strMagneticFieldStrength) Sets nominal field strength of the MR Magnet,in Tesla.
void	setResonantNucleus(java.lang.String[] arrStrContentQualification) Sets Nucleus that is resonant at the transmitter frequency.
boolean	validate() Validates all the attributes.
static boolean	validate(IDataSet objIDataSet) Validates all the attributes in CodeSequenceMacro that are present in the DataSet
static boolean	validate(IItem objIItem) Validates all the attributes in CodeSequenceMacro that are present in the DataSet

Methods inherited from class cdac.medinfo.sdk.dcm30_04.baselibs.Macro

addDataElement, clone, contains, getDataElement, getTransferSyntax

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MRImageAndSpectroscopyInstanceMacro

public MRImageAndSpectroscopyInstanceMacro(IDataSet objDataSet)

This constructor constructs a Macro with specified DataSet.

Parameters:

objDataSet - Collection of DataElements

MRImageAndSpectroscopyInstanceMacro

public MRImageAndSpectroscopyInstanceMacro(IDataSet objDataSet,
                                   IDictionaryReader objDictionaryReader)

This constructor constructs a Macro with specified DataSet and DictionaryReader

Parameters:

objDataSet - specifies the DataSet

objDictionaryReader - specifies the DICOM Dictionary reader to be used

MRImageAndSpectroscopyInstanceMacro

public MRImageAndSpectroscopyInstanceMacro(IItem objItem)

This constructor constructs a Macro with the specified Item

Parameters:

objItem - specifies instance of Item class

MRImageAndSpectroscopyInstanceMacro

public MRImageAndSpectroscopyInstanceMacro(IItem objItem,
                                   IDictionaryReader objDictionaryReader)

This constructor constructs a Macro with the specified Item and DictionaryReader

Parameters:

objItem - specifies instance of Item class

objDictionaryReader - specifies the DICOM Dictionary reader to be used

Method Detail

validate

public boolean validate()
                 throws InvalidMacroException

Validates all the attributes.

Returns:

boolean - Success -true, Failure -false.

Throws:

InvalidMacroException - throws InvalidMacroException If Mandatory or Conditional element fails.

validate

public static boolean validate(IDataSet objIDataSet)
                        throws InvalidMacroException

Validates all the attributes in CodeSequenceMacro that are present in the DataSet

Parameters:

objIDataSet - collection of DataElements

Returns:

boolean - Success -true, Failure - false

Throws:

InvalidMacroException - throws InvalidMacroException If Mandatory or Conditional element fails.

validate

public static boolean validate(IItem objIItem)
                        throws InvalidMacroException

Validates all the attributes in CodeSequenceMacro that are present in the DataSet

Parameters:

objIItem - collection of DataElements in a sequence

Returns:

boolean - Success -true, Failure - false

Throws:

InvalidMacroException - throws InvalidMacroException If Mandatory or Conditional element fails.

setAcquisitionNumber

public void setAcquisitionNumber(java.lang.String strAcquisitionNumber)

Sets a number identifying the single continuous gathering of data over a period of time which resulted in this image.

Parameters:

strAcquisitionNumber - String value of Acquisition Number

getAcquisitionNumber

public java.lang.String getAcquisitionNumber()

Return the String value of the attribute Acquisition Number.

Returns:

String - returns the Acquisition Number

setAcquisitionDatetime

public void setAcquisitionDatetime(java.lang.String strAcquisitionDatetime)

Sets the date and time the acquisition of data that resulted in this image started.

Parameters:

strAcquisitionDatetime - String value of Acquisition Date and Time.

getAcquisitionDatetime

public java.lang.String getAcquisitionDatetime()

Retrieves the Date and Time of Acquisition

Returns:

String - returns the Date and Time of Acquisition

setAcquisitionDuration

public void setAcquisitionDuration(double dAcquisitionDuration)

Sets the time in seconds needed to run the prescribed pulse sequence.

Parameters:

dAcquisitionDuration - double value of Acquisition Duration.

getCardiacRRIntervalSpecified

public double getCardiacRRIntervalSpecified()

Retrieves the time in seconds needed to run the prescribed pulse sequence.

Returns:

double - double value of Acquisition Duration.

getReferencedRawDataSequence

public ReferencedRawDataSequence getReferencedRawDataSequence()

Retrieves pre-initialized object of Referenced Raw Data 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:

ReferencedRawDataSequence - instance of ReferencedRawDataSequence.

getReferencedWaveformSequence

public ReferencedWaveformSequence getReferencedWaveformSequence()

Retrieves pre-initialized object of Referenced Waveform 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:

ReferencedWaveformSequence - instance of ReferencedWaveformSequence.

setContentQualification

public void setContentQualification(java.lang.String strContentQualification)

Sets Content Qualification Indicator. Enumerated Values: 1) PRODUCT. 2) RESEARCH. 3) SERVICE.

Parameters:

strContentQualification - String value of Content Qualification.

getContentQualification

public java.lang.String getContentQualification()

Retrieves Content Qualification Indicator.

Returns:

String - value of Content Qualification.

setResonantNucleus

public void setResonantNucleus(java.lang.String[] arrStrContentQualification)

Sets Nucleus that is resonant at the transmitter frequency. Defined Terms: 1H,3HE,7LI,13C,19F,23NA,31P,129XE.

Parameters:

arrStrContentQualification - String value of Resonant Nucleus.

getResonantNucleus

public java.lang.String getResonantNucleus()

Retrieves Nucleus that is resonant at the transmitter frequency.

Returns:

String - value of Resonant Nucleus.

setKSpaceFiltering

public void setKSpaceFiltering(java.lang.String strKSpaceFiltering)

Sets k-space filtering applied. Shall be NONE if no k-space filter. Defined Terms: 1) COSINE. 2) COSINE_SQUARED. 3) FERMI. 4) GAUSSIAN. 5) HAMMING. 6) HANNING. 7) LORENTZIAN. 8) LRNTZ_GSS_TRNSFM. 9) RIESZ. 10) TUKEY. 11) NONE.

Parameters:

strKSpaceFiltering - String value of k-space Filtering.

getKSpaceFiltering

public java.lang.String getKSpaceFiltering()

Retrieves Content Qualification Indicator.

Returns:

String - value of k-space Filtering.

setMagneticFieldStrength

public void setMagneticFieldStrength(java.lang.String strMagneticFieldStrength)

Sets nominal field strength of the MR Magnet,in Tesla.

Parameters:

strMagneticFieldStrength - String value of Magnetic Field Strength.

getMagneticFieldStrength

public java.lang.String getMagneticFieldStrength()

Retrieves nominal field strength of the MR Magnet,in Tesla.

Returns:

String - value of Magnetic Field Strength.

setApplicableSafetyStandardAgency

public void setApplicableSafetyStandardAgency(java.lang.String strApplicableSafetyStandardAgency)

Sets agency that established MR safety standard applicable to the acquisition of this Instance. Defined Terms: 1) IEC. 2) FDA. 3) MHW.

Parameters:

strApplicableSafetyStandardAgency - String value of Applicable Safety Standard Agency.

getApplicableSafetyStandardAgency

public java.lang.String getApplicableSafetyStandardAgency()

Retrieves agency that established MR safety standard applicable to the acquisition of this Instance.

Returns:

String - value of Applicable Safety Standard Agency.

setApplicableSafetyStandardDescription

public void setApplicableSafetyStandardDescription(java.lang.String strApplicableSafetyStandardDescription)

Sets name and Version of the applicable standard.

Parameters:

strApplicableSafetyStandardDescription - String value of Applicable Safety Standard Description.

getApplicableSafetyStandardDescription

public java.lang.String getApplicableSafetyStandardDescription()

Retrieves agency that established MR safety standard applicable to the acquisition of this Instance.

Returns:

String - value of Applicable Safety Standard Description.

setImageComments

public void setImageComments(java.lang.String strImageComments)

Sets User-defined comments about the image.

Parameters:

strImageComments - String value of Image Comments.

getImageComments

public java.lang.String getImageComments()

Retrieves User-defined comments about the image.

Returns:

String - value of Image Comments.

setIsocenterPosition

public void setIsocenterPosition(java.lang.String strIsocenterPosition)

Sets Isocenter coordinates (x,y,z), in mm. Specifies the location of themachine isocenter in the patient-based coordinate system associatedwith the Frame of Reference.

Parameters:

strIsocenterPosition - String value of Slice Thickness.

getIsocenterPosition

public java.lang.String getIsocenterPosition()

Retrieves Isocenter coordinates (x,y,z), in mm. Specifies the location of themachine isocenter in the patient-based coordinate system associatedwith the Frame of Reference.

Returns:

String - value of Slice Thickness.