cdac.medinfo.sdk.dcm30_04.baselibs

Class XRayCollimatorDimensionsMacro

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Macro

cdac.medinfo.sdk.dcm30_04.baselibs.XRayCollimatorDimensionsMacro

All Implemented Interfaces:

IMacro, java.io.Serializable

public class XRayCollimatorDimensionsMacro
extends Macro

This class specifies the default set of attributes encapsulated in the items of X Ray Collimator Dimensions Macro.

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String[]	getCenterOfCircularCollimator() Return Location of the center of the circular Collimator with respect to pixels in the image given as row and column.
java.lang.String	getCollimatorLeftVerticalEdge() Return Location of the left edge of the rectangular collimator with respect to pixels in the image given as column.
java.lang.String	getCollimatorLowerHorizontalEdge() Return location of the lower edge of the rectangular Collimator with respect to pixels in the image given as row.
java.lang.String	getCollimatorRightVerticalEdge() Return Location of the Right edge of the rectangular Collimator with respect to pixels in the image given as column.
java.lang.String	getCollimatorUpperHorizontalEdge() Return location of the upper edge of the rectangular Collimator with respect to pixels in the image given as row.
java.lang.String	getRadiusOfCircularCollimator() Return Location of the center of the circular Collimator with respect to pixels in the image given as row and column.
java.lang.String[]	getVerticesOfPolygonalCollimator() Return Location of the center of the circular Collimator with respect to pixels in the image given as row and column.
XRayCollimatorDimensionsMacro	getXRayCollimatorDimensionsMacro() This method returns the XRayCollimatorDimensionsMacro with proper initialization.
void	setCenterOfCircularCollimator(java.lang.String arrStrCenterOfCircularCollimator) Sets Location of the center of the circular Collimator with respect to pixels in the image given as row and column.
void	setCollimatorLeftVerticalEdge(java.lang.String strCollimatorLeftVerticalEdge) Sets Location of the left edge of the rectangular collimator with respect to pixels in the image given as column.Required if Collimator Shape (0018,1700) is RECTANGULAR.
void	setCollimatorLowerHorizontalEdge(java.lang.String strCollimatorLowerHorizontalEdge) Sets location of the Lower edge of the rectangular Collimator with respect to pixels in the image given as row.
void	setCollimatorRightVerticalEdge(java.lang.String strCollimatorRightVerticalEdge) Sets Location of the right edge of the rectangular collimator with respect to pixels in the image given as column.
void	setCollimatorUpperHorizontalEdge(java.lang.String strCollimatorUpperHorizontalEdge) Sets location of the upper edge of the rectangular Collimator with respect to pixels in the image given as row.
void	setRadiusOfCircularCollimator(java.lang.String strRadiusOfCircularCollimator) Required if Collimator Shape (0018,1600) is CIRCULAR.
void	setVerticesOfPolygonalCollimator(java.lang.String arrStrVerticesOfthePolygonalCollimator) Sets the row and column coordinates of theother vertices of the polygon Collimator.
boolean	validate() Validates all the attributes in XRayCollimatorDimensionsMacro
static boolean	validate(IDataSet objIDataSet) Validates all the attributes in XRayCollimatorDimensionsMacro that are present in the DataSet
static boolean	validate(IItem objIItem) Validates all the attributes in XRayCollimatorDimensionsMacro 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

XRayCollimatorDimensionsMacro

public XRayCollimatorDimensionsMacro(IDataSet objDataSet)

This constructor constructs a Macro with specified DataSet.

Parameters:

objDataSet - Collection of Data Elements

XRayCollimatorDimensionsMacro

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

XRayCollimatorDimensionsMacro

public XRayCollimatorDimensionsMacro(IItem objItem)

This constructor constructs a Macro with the specified Item

Parameters:

objItem - specifies instance of Item class

XRayCollimatorDimensionsMacro

public XRayCollimatorDimensionsMacro(IItem objItem,
                             IDictionaryReader objDictionaryReader)

This constructor constructs a Macro with the specified Item and Dictionary Reader

Parameters:

objItem - specifies instance of Item class

objDictionaryReader - specifies the DICOM Dictionary reader to be used

Method Detail

getXRayCollimatorDimensionsMacro

public XRayCollimatorDimensionsMacro getXRayCollimatorDimensionsMacro()

This method returns the XRayCollimatorDimensionsMacro with proper initialization.

Returns:

- instance of XRayCollimatorDimensionsMacro

setCollimatorLeftVerticalEdge

public void setCollimatorLeftVerticalEdge(java.lang.String strCollimatorLeftVerticalEdge)

Sets Location of the left edge of the rectangular collimator with respect to pixels in the image given as column.Required if Collimator Shape (0018,1700) is RECTANGULAR.

Parameters:

strCollimatorLeftVerticalEdge - String value of Collimator Left Vertical Edge

getCollimatorLeftVerticalEdge

public java.lang.String getCollimatorLeftVerticalEdge()

Return Location of the left edge of the rectangular collimator with respect to pixels in the image given as column.

Returns:

String - String value of Collimator Left Vertical Edge

setCollimatorRightVerticalEdge

public void setCollimatorRightVerticalEdge(java.lang.String strCollimatorRightVerticalEdge)

Sets Location of the right edge of the rectangular collimator with respect to pixels in the image given as column. Required if Collimator Shape (0018,1700) is RECTANGULAR.

Parameters:

strCollimatorRightVerticalEdge - String value of Collimator Right Vertical Edge

getCollimatorRightVerticalEdge

public java.lang.String getCollimatorRightVerticalEdge()

Return Location of the Right edge of the rectangular Collimator with respect to pixels in the image given as column.

Returns:

String - String value of Collimator Right Vertical Edge.

setCollimatorUpperHorizontalEdge

public void setCollimatorUpperHorizontalEdge(java.lang.String strCollimatorUpperHorizontalEdge)

Sets location of the upper edge of the rectangular Collimator with respect to pixels in the image given as row. Required if Collimator Shape (0018,1600) is RECTANGULAR.

Parameters:

strCollimatorUpperHorizontalEdge - String value of Collimator Upper Horizontal Edge

getCollimatorUpperHorizontalEdge

public java.lang.String getCollimatorUpperHorizontalEdge()

Return location of the upper edge of the rectangular Collimator with respect to pixels in the image given as row.

Returns:

String - String value of Collimator Upper Horizontal Edge.

setCollimatorLowerHorizontalEdge

public void setCollimatorLowerHorizontalEdge(java.lang.String strCollimatorLowerHorizontalEdge)

Sets location of the Lower edge of the rectangular Collimator with respect to pixels in the image given as row. Required if Collimator Shape (0018,1600) is RECTANGULAR.

Parameters:

strCollimatorLowerHorizontalEdge - the str collimator lower horizontal edge

getCollimatorLowerHorizontalEdge

public java.lang.String getCollimatorLowerHorizontalEdge()

Return location of the lower edge of the rectangular Collimator with respect to pixels in the image given as row.

Returns:

String - String value of Collimator Lower Horizontal Edge

setCenterOfCircularCollimator

public void setCenterOfCircularCollimator(java.lang.String arrStrCenterOfCircularCollimator)

Sets Location of the center of the circular Collimator with respect to pixels in the image given as row and column. Required if Collimator Shape (0018,1600) is CIRCULAR.

Parameters:

arrStrCenterOfCircularCollimator - the arr str center of circular collimator

getCenterOfCircularCollimator

public java.lang.String[] getCenterOfCircularCollimator()

Return Location of the center of the circular Collimator with respect to pixels in the image given as row and column.

Returns:

String[] - String array of Center Of Circular Collimator

setRadiusOfCircularCollimator

public void setRadiusOfCircularCollimator(java.lang.String strRadiusOfCircularCollimator)

Required if Collimator Shape (0018,1600) is CIRCULAR. Radius of the circular Collimator with respect to pixels in the image given as a number of pixels along the row direction.

Parameters:

strRadiusOfCircularCollimator - the str radius of circular collimator

getRadiusOfCircularCollimator

public java.lang.String getRadiusOfCircularCollimator()

Return Location of the center of the circular Collimator with respect to pixels in the image given as row and column.

Returns:

String - String value of Radius Of Circular Collimator.

setVerticesOfPolygonalCollimator

public void setVerticesOfPolygonalCollimator(java.lang.String arrStrVerticesOfthePolygonalCollimator)

Sets the row and column coordinates of theother vertices of the polygon Collimator.

Parameters:

arrStrVerticesOfthePolygonalCollimator - the arr str vertices ofthe polygonal collimator

getVerticesOfPolygonalCollimator

public java.lang.String[] getVerticesOfPolygonalCollimator()

Return Location of the center of the circular Collimator with respect to pixels in the image given as row and column.

Returns:

String[] - String array of Vertices Of Polygonal Collimator.

validate

public boolean validate()
                 throws InvalidMacroException

Validates all the attributes in XRayCollimatorDimensionsMacro

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