cdac.medinfo.sdk.dcm30_04.baselibs

Class XRay3DGeneralPerProjectionAcquisitionMacro

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Macro

cdac.medinfo.sdk.dcm30_04.baselibs.XRay3DGeneralPerProjectionAcquisitionMacro

All Implemented Interfaces:

IMacro, java.io.Serializable

public class XRay3DGeneralPerProjectionAcquisitionMacro
extends Macro

This class specifies the X-Ray 3D General Per Projection Acquisition Macro that specifies the attributes that are applicablefor a single projection belonging to this acquisition context.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
XRay3DGeneralPerProjectionAcquisitionMacro(IDataSet objDataSet) This constructor constructs a Macro with specified DataSet.
XRay3DGeneralPerProjectionAcquisitionMacro(IDataSet objDataSet, IDictionaryReader objDictionaryReader) This constructor constructs a Macro with specified DataSet and DictionaryReader
XRay3DGeneralPerProjectionAcquisitionMacro(IItem objItem) This constructor constructs a Macro with the specified Item
XRay3DGeneralPerProjectionAcquisitionMacro(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	getCollimatorShape() Return type of Collimator Shape.
double	getFrameAcquisitionDuration() Retrieves Frame Acquisition Duration.
java.lang.String	getKVP() Retrieves KVP.
XRayCollimatorDimensionsMacro	getXRayCollimatorDimensionsMacro() This method returns the X-Ray Collimator Dimensions MacroAttributes with proper initialization.
double	getXRayTubeCurrentInmA() Retrieves the Nominal X-Ray tube current in milliamperes..
void	setCollimatorShape(EnumCollimatorShape enumCollimatorShape) Sets type Collimator Shape.
void	setFrameAcquisitionDuration(double flFrameAcquisitionDuration) Sets Frame Acquisition Duration.Uniquely identifies Frame Acquisition Duration(0018,9220) in Frame Content Sequence(0020,9111).
void	setKVP(java.lang.String strKVP) Sets Peak kilo voltage output of the X-Ray generator used.
void	setXRayTubeCurrentInmA(double dblXRayTubeCurrentInmA) Sets the Nominal X-Ray tube current in milliamperes.
boolean	validate() Validates all the attributes in XRay3DGeneralPerProjectionAcquisitionMacro
static boolean	validate(IDataSet objIDataSet) Validates all the attributes in XRay3DGeneralPerProjectionAcquisitionMacro that are present in the DataSet
static boolean	validate(IItem objIItem) Validates all the attributes in XRay3DGeneralPerProjectionAcquisitionMacro 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

XRay3DGeneralPerProjectionAcquisitionMacro

public XRay3DGeneralPerProjectionAcquisitionMacro(IDataSet objDataSet)

This constructor constructs a Macro with specified DataSet.

Parameters:

objDataSet - Collection of DataElements

XRay3DGeneralPerProjectionAcquisitionMacro

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

XRay3DGeneralPerProjectionAcquisitionMacro

public XRay3DGeneralPerProjectionAcquisitionMacro(IItem objItem)

This constructor constructs a Macro with the specified Item

Parameters:

objItem - specifies instance of Item class

XRay3DGeneralPerProjectionAcquisitionMacro

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

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

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

setFrameAcquisitionDuration

public void setFrameAcquisitionDuration(double flFrameAcquisitionDuration)

Sets Frame Acquisition Duration.Uniquely identifies Frame Acquisition Duration(0018,9220) in Frame Content Sequence(0020,9111).

Parameters:

flFrameAcquisitionDuration - double value of Frame Acquisition Duration.

getFrameAcquisitionDuration

public double getFrameAcquisitionDuration()

Retrieves Frame Acquisition Duration.

Returns:

String - value of Frame Acquisition Duration.

setCollimatorShape

public void setCollimatorShape(EnumCollimatorShape enumCollimatorShape)

Sets type Collimator Shape. Shape(s) of the collimator. Defined Terms: 1) RECTANGULAR. 2) CIRCULAR. 3) POLYGONAL.

Parameters:

enumCollimatorShape - enum value of Collimator Shape.

getCollimatorShape

public java.lang.String getCollimatorShape()

Return type of Collimator Shape. Shape(s) of the collimator.

Returns:

String - value of Collimator Shape.

getXRayCollimatorDimensionsMacro

public XRayCollimatorDimensionsMacro getXRayCollimatorDimensionsMacro()

This method returns the X-Ray Collimator Dimensions MacroAttributes with proper initialization.

Returns:

- instance of XRayCollimatorDimensionsMacro