cdac.medinfo.sdk.dcm30_04.baselibs

Class DisplayShutterMacro

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Macro

cdac.medinfo.sdk.dcm30_04.baselibs.DisplayShutterMacro

All Implemented Interfaces:

IMacro, java.io.Serializable

public class DisplayShutterMacro
extends Macro

This Macro contains attributes of Display Shutter Macro.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DisplayShutterMacro(IDataSet objDataSet) This constructor constructs a Macro with specified DataSet.
DisplayShutterMacro(IDataSet objDataSet, IDictionaryReader objDictionaryReader) This constructor constructs a Macro with specified DataSet and DictionaryReader
DisplayShutterMacro(IItem objItem) This constructor constructs a Macro with the specified Item
DisplayShutterMacro(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[]	getCenterOfCircularShutter() Retrieves Center Of Circular Shutter component of a Name/Value pair
java.lang.String	getRadiusOfCircularShutter() Retrieves Referenced Radius of Circular Shutter
java.lang.String	getShutterLeftVerticalEdge() Retrieves Referenced Shutter Left Vertical Edge
java.lang.String	getShutterLowerHorizontalEdge() Retrieves Referenced Shutter Lower HorizontalEdge
short[]	getShutterPresentationColorCIELabValue() Retrieves one or more Shutter Presentation Color CIELab Value.
java.lang.String	getShutterRightVerticalEdge() Retrieves Referenced Shutter Right Vertical Edge
java.lang.String	getShutterShape() Return type of setup device used for Patient alignment.
java.lang.String	getShutterUpperHorizontalEdge() Retrieves Referenced Shutter Upper Horizontal Edge
java.lang.String[]	getVerticesOfThePolygonalShutter() Retrieves Vertices of the Polygonal Shutter.
void	setCenterOfCircularShutter(java.lang.String strCenterOfCircularShutter) Required if Shutter Shape (0018,1600) is CIRCULAR.
void	setRadiusOfCircularShutter(java.lang.String strRadiusOfCircularShutter) Required if Shutter Shape (0018,1600) is CIRCULAR.
void	setShutterLeftVerticalEdge(java.lang.String strShutterLeftVerticalEdge) Required if Shutter Shape (0018,1600) is RECTANGULAR.
void	setShutterLowerHorizontalEdge(java.lang.String strShutterLowerHorizontalEdge) Required if Shutter Shape (0018,1600) is RECTANGULAR.
void	setShutterPresentationColorCIELabValue(short[] arrShShutterPresentationColorCIELabValue) A color triplet value used to replace those parts of the image occluded by the shutter, when rendered on a color display.
void	setShutterPresentationValue(short shShutterPresentationValue) Sets Number of significant bits within the Shutter Presentation Value
void	setShutterRightVerticalEdge(java.lang.String strShutterRightVerticalEdge) Required if Shutter Shape (0018,1600) is RECTANGULAR.
void	setShutterShape(EnumShutterShape enumShutterShape) Shape(s) of the shutter defined for display.
void	setShutterUpperHorizontalEdge(java.lang.String strShutterUpperHorizontalEdge) Required if Shutter Shape (0018,1600) is RECTANGULAR.
void	setVerticesOfThePolygonalShutter(java.lang.String strVerticesOfThePolygonalShutter) Required if Shutter Shape (0018,1600) is POLYGONAL.Multiple Values where the first set of two values are:row of the origin vertexcolumn of the origin vertex Two or more pairs of values follow and are the row and column coordinates of the other vertices of the polygon shutter.
short	ShutterPresentationValue() Retrieves Number of significant bits within the Shutter Presentation Value
boolean	validate() Validates all the attributes in Image SOP Instance Reference Macro
static boolean	validate(IDataSet objIDataSet) Validates all the attributes in Display Shutter Macro Attributes that are present in the DataSet
static boolean	validate(IItem objIItem) Validates all the attributes in Image SOP Instance Reference Macro 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

DisplayShutterMacro

public DisplayShutterMacro(IDataSet objDataSet)

This constructor constructs a Macro with specified DataSet.

Parameters:

objDataSet - Collection of Data Elements

DisplayShutterMacro

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

DisplayShutterMacro

public DisplayShutterMacro(IItem objItem)

This constructor constructs a Macro with the specified Item

Parameters:

objItem - specifies instance of Item class

DisplayShutterMacro

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

setShutterShape

public void setShutterShape(EnumShutterShape enumShutterShape)

Shape(s) of the shutter defined for display. Enumerated Values: RECTANGULAR CIRCULAR POLYGONAL This multi-valued Attribute shall contain at most one of each EnumeratedValue. When multiple values are present, and the shutter is applied to adisplayed image, then all of the shapes shall be combined and appliedsimultaneously, that is, the least amount of image remaining shall be visible

Parameters:

enumSetupDeviceType - enum value of Setup Device Type.

getShutterShape

public java.lang.String getShutterShape()

Return type of setup device used for Patient alignment.

Returns:

String - value of Setup Device Type.

setShutterLeftVerticalEdge

public void setShutterLeftVerticalEdge(java.lang.String strShutterLeftVerticalEdge)

Required if Shutter Shape (0018,1600) is RECTANGULAR. Location of theleft edge of the rectangular shutter with respect to pixels in the image givenas column.

Parameters:

strReferencedReferenceImageNumber - String value of Referenced Reference Image Number.

getShutterLeftVerticalEdge

public java.lang.String getShutterLeftVerticalEdge()

Retrieves Referenced Shutter Left Vertical Edge

Returns:

String - value of Referenced Shutter Left Vertical Edge.

setShutterRightVerticalEdge

public void setShutterRightVerticalEdge(java.lang.String strShutterRightVerticalEdge)

Required if Shutter Shape (0018,1600) is RECTANGULAR. Location of theright edge of the rectangular shutter with respect to pixels in the image givenas column.

Parameters:

strReferencedReferenceImageNumber - String value of Referenced Shutter Right Vertical Edge.

getShutterRightVerticalEdge

public java.lang.String getShutterRightVerticalEdge()

Retrieves Referenced Shutter Right Vertical Edge

Returns:

String - value of Referenced Shutter Right Vertical Edge

setShutterUpperHorizontalEdge

public void setShutterUpperHorizontalEdge(java.lang.String strShutterUpperHorizontalEdge)

Required if Shutter Shape (0018,1600) is RECTANGULAR. Location of theright edge of the rectangular shutter with respect to pixels in the image givenas column.

Parameters:

strReferencedReferenceImageNumber - String value of Shutter Upper Horizontal Edge.

getShutterUpperHorizontalEdge

public java.lang.String getShutterUpperHorizontalEdge()

Retrieves Referenced Shutter Upper Horizontal Edge

Returns:

String - value of Referenced Shutter Upper Horizontal Edge

setShutterLowerHorizontalEdge

public void setShutterLowerHorizontalEdge(java.lang.String strShutterLowerHorizontalEdge)

Required if Shutter Shape (0018,1600) is RECTANGULAR. Location of theright edge of the rectangular shutter with respect to pixels in the image givenas column.

Parameters:

strReferencedReferenceImageNumber - String value of Shutter Lower HorizontalEdge.

getShutterLowerHorizontalEdge

public java.lang.String getShutterLowerHorizontalEdge()

Retrieves Referenced Shutter Lower HorizontalEdge

Returns:

String - value of Referenced Shutter Lower HorizontalEdge

setCenterOfCircularShutter

public void setCenterOfCircularShutter(java.lang.String strCenterOfCircularShutter)

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

Parameters:

strNumericValue - String Value component of a Name/Value pair when the Concept implied by Concept Name Code Sequence (0018,1610) is Center Of Circular Shutter .

getCenterOfCircularShutter

public java.lang.String[] getCenterOfCircularShutter()

Retrieves Center Of Circular Shutter component of a Name/Value pair

Returns:

String Array - Value component of a Name/Value pair when the Concept implied by Concept Name Code Sequence (0018,1610) is a Center Of Circular Shutter.

setRadiusOfCircularShutter

public void setRadiusOfCircularShutter(java.lang.String strRadiusOfCircularShutter)

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

Parameters:

strReferencedReferenceImageNumber - String value of Shutter Lower HorizontalEdge.

getRadiusOfCircularShutter

public java.lang.String getRadiusOfCircularShutter()

Retrieves Referenced Radius of Circular Shutter

Returns:

String - value of Referenced Radius of Circular Shutter

setVerticesOfThePolygonalShutter

public void setVerticesOfThePolygonalShutter(java.lang.String strVerticesOfThePolygonalShutter)

Required if Shutter Shape (0018,1600) is POLYGONAL.Multiple Values where the first set of two values are:row of the origin vertexcolumn of the origin vertex Two or more pairs of values follow and are the row and column coordinates of the other vertices of the polygon shutter. Polygon shutters are implicitly closed from the last vertex to the origin vertex and all edges shall be non-intersecting except at the vertices.

Parameters:

strNumericValue - String Value component of a Name/Value pair when the Concept implied by Concept Name Code Sequence (0018,1620) is Vertices of the Polygonal Shutter.

getVerticesOfThePolygonalShutter

public java.lang.String[] getVerticesOfThePolygonalShutter()

Retrieves Vertices of the Polygonal Shutter. component of a Name/Value pair

Returns:

String Array - Value component of a Name/Value pair when the Concept implied by Concept Name Code Sequence (0018,1620) is a Vertices of the Polygonal Shutter..

setShutterPresentationValue

public void setShutterPresentationValue(short shShutterPresentationValue)

Sets Number of significant bits within the Shutter Presentation Value

Parameters:

shShutterPresentationValue - short value of Number of significant bits

ShutterPresentationValue

public short ShutterPresentationValue()

Retrieves Number of significant bits within the Shutter Presentation Value

Returns:

short - short value of Number of significant bits

setShutterPresentationColorCIELabValue

public void setShutterPresentationColorCIELabValue(short[] arrShShutterPresentationColorCIELabValue)

A color triplet value used to replace those parts of the image occluded by the shutter, when rendered on a color display. The units are specified in PCS-Values, and the value is encoded as CIELab. See Section C.10.7.1.1

Parameters:

arrShShutterPresentationColorCIELabValue -

getShutterPresentationColorCIELabValue

public short[] getShutterPresentationColorCIELabValue()

Retrieves one or more Shutter Presentation Color CIELab Value.

Returns:

short Array - Shutter Presentation Color CIELab Value

validate

public boolean validate()
                 throws InvalidMacroException

Validates all the attributes in Image SOP Instance Reference Macro

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 Display Shutter Macro Attributes 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 Image SOP Instance Reference Macro 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.