Package gda.device.detector.nxdetector.roi

Class MutableRectangularIntegerROI

java.lang.Object

gda.factory.FindableBase

gda.device.detector.nxdetector.roi.MutableRectangularIntegerROI

All Implemented Interfaces:

RectangularROI<Integer>, RectangularROIProvider<Integer>, Findable

public class MutableRectangularIntegerROI
extends FindableBase
implements RectangularROI<Integer>, RectangularROIProvider<Integer>

This class provides a mutable rectangular ROI which is also findable to allow the ROI on a area detector to be adjusted from the GDA command line/scripts. To use on the command line it will need to be obtained using the Finder. To make it easier to integrate with ADRoiStatsPairFactory it also implements RectangularROIProvider returning itself.

Example Spring XML:

 
 <bean id="cam1_roi" class="gda.device.detector.nxdetector.roi.MutableRectangularIntegerROI">
	 <property name="xstart" value="0" />
	 <property name="ystart" value="0" />
	 <property name="xsize" value="500" />
	 <property name="ysize" value="500" />
 </bean>
 
 

Constructor Summary

Constructors

Constructor	Description
MutableRectangularIntegerROI()
MutableRectangularIntegerROI(RectangularROI<Integer> roi)	Convenience constructor to create a MutableRectangularIntegerROI from an existing RectangularROI.

Method Summary

Modifier and Type	Method	Description
RectangularROI<Integer>	getRoi()	Return a RectangularROI, or null if none is available/enabled.
Integer	getXsize()
Integer	getXstart()
Integer	getYsize()
Integer	getYstart()
void	setROI(RectangularROI<Integer> roi)	Change this ROI to match a existing RectangularROI
void	setXsize(Integer xsize)
void	setXstart(Integer xstart)
void	setYsize(Integer ysize)
void	setYstart(Integer ystart)

Methods inherited from class gda.factory.FindableBase

equals, getName, hashCode, setName

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface gda.device.detector.nxdetector.roi.RectangularROI

getName

Constructor Details

MutableRectangularIntegerROI

public MutableRectangularIntegerROI()

MutableRectangularIntegerROI

public MutableRectangularIntegerROI(RectangularROI<Integer> roi)

Convenience constructor to create a MutableRectangularIntegerROI from an existing RectangularROI.

Parameters:

roi - Existing RectangularROI

Method Details

getXstart

public Integer getXstart()

Specified by:

getXstart in interface RectangularROI<Integer>

setXstart

public void setXstart(Integer xstart)

getYstart

public Integer getYstart()

Specified by:

getYstart in interface RectangularROI<Integer>

setYstart

public void setYstart(Integer ystart)

getXsize

public Integer getXsize()

Specified by:

getXsize in interface RectangularROI<Integer>

setXsize

public void setXsize(Integer xsize)

getYsize

public Integer getYsize()

Specified by:

getYsize in interface RectangularROI<Integer>

setYsize

public void setYsize(Integer ysize)

getRoi

public RectangularROI<Integer> getRoi()
                               throws IllegalArgumentException,
IndexOutOfBoundsException,
Exception

Description copied from interface: RectangularROIProvider

Return a RectangularROI, or null if none is available/enabled.

Specified by:

getRoi in interface RectangularROIProvider<Integer>

Returns:

an roi or null if none available/active

Throws:

IllegalArgumentException - if the index is out of bounds

IndexOutOfBoundsException

Exception - If the RCPPlotter.getBean throws an exception

setROI

public void setROI(RectangularROI<Integer> roi)

Change this ROI to match a existing RectangularROI

Parameters:

roi - Existing RectangularROI