cdac.medinfo.sdk.dcm30_04.baselibs

Class ExposureControlSensingRegionsSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.ExposureControlSensingRegionsSequenceItem

All Implemented Interfaces:

IItem, ICollectionIterable<IDataElement>, java.io.Serializable, java.lang.Iterable<IDataElement>

public class ExposureControlSensingRegionsSequenceItem
extends Item

This item class contains the methods to set, get and validate the attribute present in Exposure Control Sensing Regions Sequence .

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
short[]	getCenterOfCircularExposureControlSensingRegion() Returns the Location of the center of the circular Exposure ControlSensing Region expressed as effective pixel row and column
short	getExposureControlSensingRegionLeftVerticalEdge() Retrieves the location of the left edge of the rectangular ExposureControl Sensing Region expressed as effective pixel column.
short	getExposureControlSensingRegionLowerHorizontalEdge() Retrieves the location of the lower edge of the rectangular ExposureControl Sensing Region expressed as effective pixel column.
short	getExposureControlSensingRegionRightVerticalEdge() Retrieves the location of the right edge of the rectangular ExposureControl Sensing Region expressed as effective pixel column.
java.lang.String	getExposureControlSensingRegionShape() Return type of Exposure Control Sensing Region Shape.
short	getExposureControlSensingRegionUpperHorizontalEdge() Retrieves the location of the upper edge of the rectangular ExposureControl Sensing Region expressed as effective pixel column.
short	getRadiusOfCircularExposureControlSensingRegion() Retrieves the Radius of the circular Exposure Control Sensing Regionexpressed as effective number of pixels along the row direction.
short[]	getVerticesOfThePolygonalExposureControlSensingRegion() Returns the Vertices of the PolygonalExposure Control Sensing Region.
void	setCenterOfCircularExposureControlSensingRegion(short[] sCenterOfCircularExposureControlSensingRegion) Sets the Location of the center of the circular Exposure ControlSensing Region expressed as effective pixel row and column.
void	setExposureControlSensingRegionLeftVerticalEdge(short shExposureControlSensingRegionLeftVerticalEdge) Sets the location of the left edge of the rectangular ExposureControl Sensing Region expressed as effective pixel column.
void	setExposureControlSensingRegionLowerHorizontalEdge(short shExposureControlSensingRegionLowerHorizontalEdge) Sets the location of the lower edge of the rectangular ExposureControl Sensing Region expressed as effective pixel column.
void	setExposureControlSensingRegionRightVerticalEdge(short shExposureControlSensingRegionRightVerticalEdge) Sets the location of the right edge of the rectangular ExposureControl Sensing Region expressed as effective pixel column.
void	setExposureControlSensingRegionShape(EnumExposureControlSensingRegionShape enumExposureControlSensingRegionShape) Sets the shape of the Exposure Control Sensing Region.
void	setExposureControlSensingRegionUpperHorizontalEdge(short shExposureControlSensingRegionUpperHorizontalEdge) Sets the location of the upper edge of the rectangular ExposureControl Sensing Region expressed as effective pixel column.
void	setVerticesOfThePolygonalExposureControlSensingRegion(short[] sVerticesOfThePolygonalExposureControlSensingRegion) Sets the Vertices of the PolygonalExposure Control Sensing Region
void	setWaveformBitsStored(short shRadiusOfCircularExposureControlSensingRegion) Sets the Radius of the circular Exposure Control Sensing Regionexpressed as effective number of pixels along the row direction.
boolean	validateForModule() Validates all the attributes in FieldOfViewSequenceItem that are present in the DataSet

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

addDataElement, changeToUndefined, clone, contains, dumpDICOMInfo, getDataForTag, getDictionaryReader, getItemLength, getTransferSyntax, getValue, getValueLength, iterator, read, setDictionaryReader, setTransferSyntax, setValue, sortedIterator, validate, write

Methods inherited from class java.lang.Object

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

Method Detail

validateForModule

public boolean validateForModule()
                          throws InvalidItemException

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

Specified by:

validateForModule in interface IItem

Overrides:

validateForModule in class Item

Returns:

boolean - Success -true, Failure - false

Throws:

InvalidItemException - throws InvalidItemException If Mandatory or Conditional element fails.

setExposureControlSensingRegionShape

public void setExposureControlSensingRegionShape(EnumExposureControlSensingRegionShape enumExposureControlSensingRegionShape)

Sets the shape of the Exposure Control Sensing Region. Enumerated Values: RECTANGULAR CIRCULAR POLYGONAL

Parameters:

enumExposureControlSensingRegionShape - enum value of Field Of View Shape.

getExposureControlSensingRegionShape

public java.lang.String getExposureControlSensingRegionShape()

Return type of Exposure Control Sensing Region Shape.

Returns:

String - value of ExposureControlSensingRegionShape.

setExposureControlSensingRegionLeftVerticalEdge

public void setExposureControlSensingRegionLeftVerticalEdge(short shExposureControlSensingRegionLeftVerticalEdge)

Sets the location of the left edge of the rectangular ExposureControl Sensing Region expressed as effective pixel column.

Parameters:

shExposureControlSensingRegionLeftVerticalEdge - short value of Exposure Control SensingRegion Left Vertical Edge.

getExposureControlSensingRegionLeftVerticalEdge

public short getExposureControlSensingRegionLeftVerticalEdge()

Retrieves the location of the left edge of the rectangular ExposureControl Sensing Region expressed as effective pixel column.

Returns:

short - short value of Exposure Control SensingRegion Left Vertical Edge.

setExposureControlSensingRegionRightVerticalEdge

public void setExposureControlSensingRegionRightVerticalEdge(short shExposureControlSensingRegionRightVerticalEdge)

Sets the location of the right edge of the rectangular ExposureControl Sensing Region expressed as effective pixel column.

Parameters:

shExposureControlSensingRegionRightVerticalEdge - short value of Exposure Control SensingRegion Right Vertical Edge.

getExposureControlSensingRegionRightVerticalEdge

public short getExposureControlSensingRegionRightVerticalEdge()

Retrieves the location of the right edge of the rectangular ExposureControl Sensing Region expressed as effective pixel column.

Returns:

short - short value of Exposure Control SensingRegion Right Vertical Edge.

setExposureControlSensingRegionUpperHorizontalEdge

public void setExposureControlSensingRegionUpperHorizontalEdge(short shExposureControlSensingRegionUpperHorizontalEdge)

Sets the location of the upper edge of the rectangular ExposureControl Sensing Region expressed as effective pixel column.

Parameters:

shExposureControlSensingRegionUpperHorizontalEdge - short value of Exposure Control SensingRegion Upper Vertical Edge.

getExposureControlSensingRegionUpperHorizontalEdge

public short getExposureControlSensingRegionUpperHorizontalEdge()

Retrieves the location of the upper edge of the rectangular ExposureControl Sensing Region expressed as effective pixel column.

Returns:

short - short value of Exposure Control SensingRegion Upper Vertical Edge.

setExposureControlSensingRegionLowerHorizontalEdge

public void setExposureControlSensingRegionLowerHorizontalEdge(short shExposureControlSensingRegionLowerHorizontalEdge)

Sets the location of the lower edge of the rectangular ExposureControl Sensing Region expressed as effective pixel column.

Parameters:

shExposureControlSensingRegionLowerHorizontalEdge - short value of Exposure Control SensingRegion lower Vertical Edge.

getExposureControlSensingRegionLowerHorizontalEdge

public short getExposureControlSensingRegionLowerHorizontalEdge()

Retrieves the location of the lower edge of the rectangular ExposureControl Sensing Region expressed as effective pixel column.

Returns:

short - short value of Exposure Control SensingRegion Lower Vertical Edge.

setCenterOfCircularExposureControlSensingRegion

public void setCenterOfCircularExposureControlSensingRegion(short[] sCenterOfCircularExposureControlSensingRegion)

Sets the Location of the center of the circular Exposure ControlSensing Region expressed as effective pixel row and column.

Parameters:

sCenterOfCircularExposureControlSensingRegion - short array of Center of Circular ExposureControl Sensing Region.

getCenterOfCircularExposureControlSensingRegion

public short[] getCenterOfCircularExposureControlSensingRegion()

Returns the Location of the center of the circular Exposure ControlSensing Region expressed as effective pixel row and column

Returns:

short[] - short array of Center of Circular ExposureControl Sensing Region.

setWaveformBitsStored

public void setWaveformBitsStored(short shRadiusOfCircularExposureControlSensingRegion)

Sets the Radius of the circular Exposure Control Sensing Regionexpressed as effective number of pixels along the row direction.

Parameters:

shRadiusOfCircularExposureControlSensingRegion - short value of Radius of Circular ExposureControl Sensing Region

getRadiusOfCircularExposureControlSensingRegion

public short getRadiusOfCircularExposureControlSensingRegion()

Retrieves the Radius of the circular Exposure Control Sensing Regionexpressed as effective number of pixels along the row direction.

Returns:

short - short value of Radius of Circular ExposureControl Sensing Region

setVerticesOfThePolygonalExposureControlSensingRegion

public void setVerticesOfThePolygonalExposureControlSensingRegion(short[] sVerticesOfThePolygonalExposureControlSensingRegion)

Sets the Vertices of the PolygonalExposure Control Sensing Region

Parameters:

sVerticesOfThePolygonalExposureControlSensingRegion - short array of Vertices of the PolygonalExposure Control Sensing Region.

getVerticesOfThePolygonalExposureControlSensingRegion

public short[] getVerticesOfThePolygonalExposureControlSensingRegion()

Returns the Vertices of the PolygonalExposure Control Sensing Region.

Returns:

short[] - short array of Vertices of the PolygonalExposure Control Sensing Region.