cdac.medinfo.sdk.dcm30_04.baselibs

Class XRay3DGeneralSharedAcquisitionMacro

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Macro

cdac.medinfo.sdk.dcm30_04.baselibs.XRay3DGeneralSharedAcquisitionMacro

All Implemented Interfaces:

IMacro, java.io.Serializable

public class XRay3DGeneralSharedAcquisitionMacro
extends Macro

This class specifies the X-Ray 3D General Shared Acquisition Macro that specifies the attributes that are applicable for all the projection images belonging to this acquisition context.

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
ContrastBolusAgentSequence	getContrastBolusAgentSequence() Retrieves pre-initialized object of Contrast/Bolus AgentSequence.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
short	getContrastOrBolusAgentNumber() Retrieves Identifying number, unique within this SOP Instance, of the agent administered.
java.lang.String	getEndAcquisitionDatetime() Retrieves the End Date and Time of Acquisition
double	getExposureInmAs() Retrieves The exposure expressed in milliampere seconds.
java.lang.String	getExposureTimeinms() Retrieves Exposure Time in ms.
float[]	getFieldOfViewDimensionsInFloat() Retrieves Field of ViewDimension(s) in Float.
java.lang.String	getFieldOfViewHorizontalFlip() Return type of Field of View HorizontalFlip.
java.lang.String[]	getFieldOfViewOrigin() Retrieves Field of View Origin.
java.lang.String	getFieldOfViewRotation() Return type of Field of View Rotation.
int[]	getGridDimensions() Retrieves Grid Dimensions.
java.lang.String	getKVP() Retrieves KVP.
SourceImageSequence	getSourceImageSequence() Retrieves pre-initialized object of Source Image 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	getStartAcquisitionDatetime() Retrieves the Start Date and Time of Acquisition
XRayGridDescriptionMacro	getXRayGridDescriptionMacro() This method returns the X Ray Grid Description Macro with proper initialization.
double	getXRayTubeCurrentInmA() Retrieves the Nominal X-Ray tube current in milliamperes..
void	setContrastOrBolusAgentNumber(short shContrastOrBolusAgentNumber) Sets Identifying number, unique within this SOP Instance, of the agent administered.
void	setEndAcquisitionDatetime(java.lang.String strEndAcquisitionDatetime) Sets End date and time of that part of an acquisition used for this acquisition context.
void	setExposureInmAs(double dblExposureInmAs) Sets The exposure expressed in milliampere seconds.
void	setExposureTimeinms(java.lang.String strExposureTimeinms) Sets Exposure Time in ms.
void	setFieldOfViewDescription(java.lang.String strFieldOfViewDescription) Sets Manufacturer defined description of the field of view selected duringacquisition.
void	setFieldOfViewDimensionsInFloat(float[] arrFFieldOfViewDimensionsInFloat) Sets Dimensions in mm of the Field of View, that is the image pixels stored inPixel Data (7FE0,0010).
void	setFieldOfViewHorizontalFlip(EnumFieldOfViewHorizontalFlip enumFieldOfViewHorizontalFlip) Sets whether or not a horizontal flip has been applied to the Field of View, i.e.,the image pixels stored in Pixel Data (7FE0,0010), after rotation relative tothe physical detector as described in Field of View Rotation (0018,7032).
void	setFieldOfViewOrigin(java.lang.String[] strFieldOfViewOrigin) Sets the Offset of the TLHC of a rectangle circumscribing the Field of View, i.e., theimage pixels stored in Pixel Data (7FE0,0010) before rotation or flipping,from the TLHC of the physical detector area measured in physical detectorpixels as a row offset followed by a column offset.
void	setFieldOfViewRotation(EnumFieldOfViewRotation enumFieldOfViewRotation) Sets Clockwise rotation in degrees of Field of View, i.e., the image pixels storedin Pixel Data (7FE0,0010), relative to the physical detector.
void	setGridDimensions(int[] lArrGridDimensions) Sets Grid Dimensions.
void	setKVP(java.lang.String strKVP) Sets Peak kilo voltage output of the X-Ray generator used.
void	setStartAcquisitionDateTime(java.lang.String strStartAcquisitionDatetime) Sets Start date and time of that part of an acquisition used for this acquisitioncontext.
void	setXRayTubeCurrentInmA(double dblXRayTubeCurrentInmA) Sets the Nominal X-Ray tube current in milliamperes.
boolean	validate() Validates all the attributes in XRay3DGeneralSharedAcquisitionMacro
static boolean	validate(IDataSet objIDataSet) Validates all the attributes in XRay3DGeneralSharedAcquisitionMacro that are present in the DataSet
static boolean	validate(IItem objIItem) Validates all the attributes in XRay3DGeneralSharedAcquisitionMacro 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

XRay3DGeneralSharedAcquisitionMacro

public XRay3DGeneralSharedAcquisitionMacro(IDataSet objDataSet)

This constructor constructs a Macro with specified DataSet.

Parameters:

objDataSet - Collection of DataElements

XRay3DGeneralSharedAcquisitionMacro

public XRay3DGeneralSharedAcquisitionMacro(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

XRay3DGeneralSharedAcquisitionMacro

public XRay3DGeneralSharedAcquisitionMacro(IItem objItem)

This constructor constructs a Macro with the specified Item

Parameters:

objItem - specifies instance of Item class

XRay3DGeneralSharedAcquisitionMacro

public XRay3DGeneralSharedAcquisitionMacro(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 in XRay3DGeneralSharedAcquisitionMacro

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 XRay3DGeneralSharedAcquisitionMacro 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 XRay3DGeneralSharedAcquisitionMacro 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.

getXRayGridDescriptionMacro

public XRayGridDescriptionMacro getXRayGridDescriptionMacro()

This method returns the X Ray Grid Description Macro with proper initialization.

Returns:

- instance of XRayGridDescriptionMacro

getSourceImageSequence

public SourceImageSequence getSourceImageSequence()

Retrieves pre-initialized object of Source Image 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:

SourceImageSequence - instance of SourceImageSequence.

setFieldOfViewDimensionsInFloat

public void setFieldOfViewDimensionsInFloat(float[] arrFFieldOfViewDimensionsInFloat)

Sets Dimensions in mm of the Field of View, that is the image pixels stored inPixel Data (7FE0,0010).

Parameters:

arrFFieldOfViewDimensionsInFloat - pair of floating point numbers

getFieldOfViewDimensionsInFloat

public float[] getFieldOfViewDimensionsInFloat()

Retrieves Field of ViewDimension(s) in Float.

Returns:

float[] - Float array of Field of ViewDimension(s) in Float.

setFieldOfViewOrigin

public void setFieldOfViewOrigin(java.lang.String[] strFieldOfViewOrigin)

Sets the Offset of the TLHC of a rectangle circumscribing the Field of View, i.e., theimage pixels stored in Pixel Data (7FE0,0010) before rotation or flipping,from the TLHC of the physical detector area measured in physical detectorpixels as a row offset followed by a column offset.

Parameters:

strFieldOfViewOrigin - String value of Field of View Origin.

getFieldOfViewOrigin

public java.lang.String[] getFieldOfViewOrigin()

Retrieves Field of View Origin.

Returns:

String - value of Field of View Origin.

setFieldOfViewRotation

public void setFieldOfViewRotation(EnumFieldOfViewRotation enumFieldOfViewRotation)

Sets Clockwise rotation in degrees of Field of View, i.e., the image pixels storedin Pixel Data (7FE0,0010), relative to the physical detector. Enumerated Values: 0 90 180 270

Parameters:

enumFieldOfViewRotation - enum value of Field of View Rotation.

getFieldOfViewRotation

public java.lang.String getFieldOfViewRotation()

Return type of Field of View Rotation.

Returns:

String - value of Field of View Rotation.

setFieldOfViewHorizontalFlip

public void setFieldOfViewHorizontalFlip(EnumFieldOfViewHorizontalFlip enumFieldOfViewHorizontalFlip)

Sets whether or not a horizontal flip has been applied to the Field of View, i.e.,the image pixels stored in Pixel Data (7FE0,0010), after rotation relative tothe physical detector as described in Field of View Rotation (0018,7032). Enumerated Values: NO YES

Parameters:

enumFieldOfViewHorizontalFlip - enum value of Setup Device Type.

getFieldOfViewHorizontalFlip

public java.lang.String getFieldOfViewHorizontalFlip()

Return type of Field of View HorizontalFlip.

Returns:

String - value of Field of View HorizontalFlip.

setFieldOfViewDescription

public void setFieldOfViewDescription(java.lang.String strFieldOfViewDescription)

Sets Manufacturer defined description of the field of view selected duringacquisition.

Parameters:

strFieldOfViewDescription - String value of Field of View Description.

setGridDimensions

public void setGridDimensions(int[] lArrGridDimensions)

Sets Grid Dimensions. The dimensions of the grid, in voxels. A triple representing the number of voxels along the X, Y, and Z axes.

Parameters:

lArrGridDimensions - Long value of Grid Dimensions

getGridDimensions

public int[] getGridDimensions()

Retrieves Grid Dimensions. The dimensions of the grid, in voxels. A triple representing the number of voxels along the X, Y, and Z axes.

Returns:

long[] - long value of Grid Dimensions.

setKVP

public void setKVP(java.lang.String strKVP)

Sets Peak kilo voltage output of the X-Ray generator used.

Parameters:

strKVP - String value of KVP.

getKVP

public java.lang.String getKVP()

Retrieves KVP.

Returns:

String - value of KVP.

setXRayTubeCurrentInmA

public void setXRayTubeCurrentInmA(double dblXRayTubeCurrentInmA)

Sets the Nominal X-Ray tube current in milliamperes.

Parameters:

dblXRayTubeCurrentInmA - Double value of coordinates

getXRayTubeCurrentInmA

public double getXRayTubeCurrentInmA()

Retrieves the Nominal X-Ray tube current in milliamperes..

Returns:

double - double value of XRayTubeCurrentInmA

setExposureTimeinms

public void setExposureTimeinms(java.lang.String strExposureTimeinms)

Sets Exposure Time in ms.

Parameters:

strExposureTimeinms - String value of Exposure Time in ms

getExposureTimeinms

public java.lang.String getExposureTimeinms()

Retrieves Exposure Time in ms.

Returns:

String - value of Exposure Time in ms

setExposureInmAs

public void setExposureInmAs(double dblExposureInmAs)

Sets The exposure expressed in milliampere seconds.

Parameters:

dblExposureInmAs - Double value of coordinates

getExposureInmAs

public double getExposureInmAs()

Retrieves The exposure expressed in milliampere seconds.

Returns:

double - double value of ExposureInmAs

setContrastOrBolusAgentNumber

public void setContrastOrBolusAgentNumber(short shContrastOrBolusAgentNumber)

Sets Identifying number, unique within this SOP Instance, of the agent administered.

Parameters:

shContrastOrBolusAgentNumber - short value of number

getContrastOrBolusAgentNumber

public short getContrastOrBolusAgentNumber()

Retrieves Identifying number, unique within this SOP Instance, of the agent administered.

Returns:

short - short value of number.

getContrastBolusAgentSequence

public ContrastBolusAgentSequence getContrastBolusAgentSequence()

Retrieves pre-initialized object of Contrast/Bolus AgentSequence.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:

ContrastOrBolusAgentSequence - instance of Contrast/Bolus AgentSequence.

setStartAcquisitionDateTime

public void setStartAcquisitionDateTime(java.lang.String strStartAcquisitionDatetime)

Sets Start date and time of that part of an acquisition used for this acquisitioncontext.

Parameters:

strStartAcquisitionDatetime - String value of Acquisition Date and Time.

getStartAcquisitionDatetime

public java.lang.String getStartAcquisitionDatetime()

Retrieves the Start Date and Time of Acquisition

Returns:

String - returns the Date and Time of Acquisition

setEndAcquisitionDatetime

public void setEndAcquisitionDatetime(java.lang.String strEndAcquisitionDatetime)

Sets End date and time of that part of an acquisition used for this acquisition context.

Parameters:

strEndAcquisitionDatetime - String value of End Acquisition Date and Time.

getEndAcquisitionDatetime

public java.lang.String getEndAcquisitionDatetime()

Retrieves the End Date and Time of Acquisition

Returns:

String - returns the End Date and Time of Acquisition