Package org.eclipse.dawnsci.analysis.dataset.roi

Class RectangularROI

java.lang.Object

org.eclipse.dawnsci.analysis.dataset.roi.ROIBase

org.eclipse.dawnsci.analysis.dataset.roi.OrientableROIBase

org.eclipse.dawnsci.analysis.dataset.roi.RectangularROI

All Implemented Interfaces:

Serializable, IOrientableROI, IRectangularROI, IROI, org.eclipse.january.INameable

Direct Known Subclasses:

GridROI, PerimeterBoxROI, SurfacePlotROI, XAxisBoxROI, XAxisLineBoxROI, YAxisBoxROI, YAxisLineBoxROI

public class RectangularROI
extends OrientableROIBase
implements IRectangularROI, Serializable

Class for rectangular region of interest

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected double[]	len

Fields inherited from class org.eclipse.dawnsci.analysis.dataset.roi.OrientableROIBase

ang, cang, sang

Fields inherited from class org.eclipse.dawnsci.analysis.dataset.roi.ROIBase

bounds, fixed, name, plot, spt

Constructor Summary

Constructors

Constructor	Description
RectangularROI()	Default square of 100 pixels
RectangularROI(double[] spt, double[] ept)
RectangularROI(double width, double angle)	Square constructor
RectangularROI(double width, double height, double angle)
RectangularROI(double ptx, double pty, double width, double height, double angle)
RectangularROI(double ptx, double pty, double width, double height, double angle, boolean clip)
RectangularROI(IRectangularROI r)
RectangularROI(RectangularROI orig)	Copy constructor

Method Summary

Modifier and Type	Method	Description
void	addAngle(double angle)	Add an offset to angle
void	addToLengths(double x, double y)
void	adjustKeepDiagonalPoint(double[] cpt, double[] ept, double[] pt, boolean first)	Adjust ROI whilst keeping a diagonal point in place
void	adjustKeepDiagonalPoint(int[] cpt, double[] ept, int[] pt, boolean first)	Adjust ROI whilst keeping a diagonal point in place
IRectangularROI	bounds(IROI roi)	Return a new bounds with encompasses this roi and the bounds of the roi passed in.
boolean	containsPoint(double x, double y)
RectangularROI	copy()
void	downsample(double subFactor)	To account for a down-sampling of the dataset, change ROI
boolean	equals(Object obj)
double[]	findHorizontalIntersections(double y)	Calculate x values at which ROI will intersect horizontal line of given y
double	getAngle()
double	getAngleRelativeToMidPoint(double[] pt)
double	getAngleRelativeToMidPoint(int[] pt)
double	getAngleRelativeToPoint(double fx, double fy, double[] pt)
double	getAngleRelativeToPoint(double fx, double fy, int[] pt)
RectangularROI	getBounds()
double[]	getEndPoint()	End point of rectangle
int	getIntLength(int index)
int[]	getIntLengths()
int[]	getIntPoint(double fx, double fy)	Return point from normalized coordinates within rectangle
double	getLength(int index)
double[]	getLengths()
double[]	getMidPoint()
double[]	getPoint(double fx, double fy)	Return point from normalized coordinates within rectangle
int	hashCode()
boolean	isClippingCompensation()
boolean	isNearOutline(double x, double y, double distance)
void	setAngledegrees(double angle)	For Jython
void	setClippingCompensation(boolean clippingCompensation)
void	setEndPoint(double[] pt)	Start a rotated rectangle with predefined starting point and given end point and determine new starting point and lengths
void	setEndPoint(double[] pt, boolean moveX, boolean moveY)	Start a rotated rectangle with predefined starting point and given end point and determine new starting point and lengths
void	setEndPoint(int[] pt)
void	setEndPoint(int[] pt, boolean moveX, boolean moveY)	Start a rotated rectangle with predefined starting point and given end point and determine new starting point and lengths
void	setEndPointKeepLengths(double[] pt)	Start a rotated rectangle with predefined starting point and given end point and determine new starting point
void	setLengths(double[] len)
void	setLengths(double major, double minor)
void	setMidPoint(double[] mpt)	Change rectangle to have specified mid point
void	setPointKeepEndPoint(double[] dpt, boolean moveX, boolean moveY)	Set start point whilst keeping end point
void	setPointKeepEndPoint(int[] dpt, boolean moveX, boolean moveY)	Set start point whilst keeping end point
void	subPoint(int[] pt)	Subtract an offset from starting point
String	toString()
void	translate(double fx, double fy)	Translate by normalized coordinates (in rotated frame)

Methods inherited from class org.eclipse.dawnsci.analysis.dataset.roi.OrientableROIBase

checkAngle, getAngleDegrees, sanifyAngle, sanifyAngles, setAngle, setAngleDegrees, transformToOriginal, transformToRotated, transformXToOriginal

Methods inherited from class org.eclipse.dawnsci.analysis.dataset.roi.ROIBase

addPoint, addPoint, addPoint, closelyEq, closelyEq, closelyEqOrGt, closelyEqOrLt, containsPoint, getIntPoint, getName, getPoint, getPointRef, getPointX, getPointY, getValue, intersectHorizontal, isFixed, isNearOutline, isPlot, notClose, setDirty, setFixed, setName, setPlot, setPoint, setPoint, setPoint, setPoint, setValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.january.INameable

getName, setName

Methods inherited from interface org.eclipse.dawnsci.analysis.api.roi.IOrientableROI

getAngleDegrees, setAngle, setAngleDegrees

Methods inherited from interface org.eclipse.dawnsci.analysis.api.roi.IROI

addPoint, addPoint, addPoint, getIntPoint, getPoint, getPointRef, getPointX, getPointY, getValue, isFixed, isPlot, setFixed, setPlot, setPoint, setPoint, setPoint, setPoint, setValue

Field Details

len

protected double[] len

Constructor Details

RectangularROI

public RectangularROI()

Default square of 100 pixels

RectangularROI

public RectangularROI(RectangularROI orig)

Copy constructor

Parameters:

orig -

RectangularROI

public RectangularROI(double width,
 double angle)
               throws IllegalArgumentException

Square constructor

Parameters:

width - A Non-Negative value for the width

angle -

Throws:

IllegalArgumentException - if the width is negative (Not allowed to have negative width or height)

RectangularROI

public RectangularROI(double width,
 double height,
 double angle)
               throws IllegalArgumentException

Parameters:

width - A Non-Negative value for the width

height - A Non-Negative value for the height

angle -

Throws:

IllegalArgumentException - if the width or height is negative (Not allowed to have negative width or height)

RectangularROI

public RectangularROI(double ptx,
 double pty,
 double width,
 double height,
 double angle)
               throws IllegalArgumentException

Parameters:

ptx -

pty -

width - A Non-Negative value for the width

height - A Non-Negative value for the height

angle -

Throws:

IllegalArgumentException - if the width or height is negative (Not allowed to have negative width or height)

RectangularROI

public RectangularROI(double ptx,
 double pty,
 double width,
 double height,
 double angle,
 boolean clip)
               throws IllegalArgumentException

Parameters:

ptx -

pty -

width - A Non-Negative value for the width

height - A Non-Negative value for the height

angle -

clip -

Throws:

IllegalArgumentException - if the width or height is negative (Not allowed to have negative width or height)

RectangularROI

public RectangularROI(double[] spt,
 double[] ept)

Parameters:

spt - start point

ept - end point

RectangularROI

public RectangularROI(IRectangularROI r)

Parameters:

r -

Method Details

setClippingCompensation

public void setClippingCompensation(boolean clippingCompensation)

Parameters:

clippingCompensation - The clippingCompensation to set.

isClippingCompensation

public boolean isClippingCompensation()

Returns:

Returns the clippingCompensation.

setLengths

public void setLengths(double[] len)
                throws IllegalArgumentException

Parameters:

len - (width, height) Non-Negative numbers for the width and height

Throws:

IllegalArgumentException - if the width or height is negative (Not allowed to have negative width or height)

setLengths

public void setLengths(double major,
 double minor)
                throws IllegalArgumentException

Parameters:

major - (width) A Non-Negative value for the width

minor - (height) A Non-Negative value for the height

Throws:

IllegalArgumentException - if the width or height is negative (Not allowed to have negative width or height)

addToLengths

public void addToLengths(double x,
 double y)
                  throws IllegalArgumentException

Parameters:

x - (width)

y - (height)

Throws:

IllegalArgumentException - if the width or height is negative as a result (Not allowed to have negative width or height)

getPoint

public double[] getPoint(double fx,
 double fy)

Return point from normalized coordinates within rectangle

Parameters:

fx -

fy -

Returns:

point

getIntPoint

public int[] getIntPoint(double fx,
 double fy)

Return point from normalized coordinates within rectangle

Parameters:

fx -

fy -

Returns:

point

getEndPoint

public double[] getEndPoint()

Description copied from interface: IRectangularROI

End point of rectangle

Specified by:

getEndPoint in interface IRectangularROI

Returns:

end

getMidPoint

public double[] getMidPoint()

Returns:

mid point

setMidPoint

public void setMidPoint(double[] mpt)

Change rectangle to have specified mid point

Parameters:

mpt -

getLength

public double getLength(int index)

Specified by:

getLength in interface IRectangularROI

Parameters:

index - (0 for width, 1 for height)

Returns:

length

getIntLength

public int getIntLength(int index)

Specified by:

getIntLength in interface IRectangularROI

Parameters:

index -

Returns:

length

getLengths

public double[] getLengths()

Returns:

reference to the lengths

getIntLengths

public int[] getIntLengths()

Specified by:

getIntLengths in interface IRectangularROI

Returns:

integer lengths

getAngle

public double getAngle()

Specified by:

getAngle in interface IOrientableROI

Overrides:

getAngle in class OrientableROIBase

Returns:

Returns the angle

setAngledegrees

public void setAngledegrees(double angle)

For Jython

Parameters:

angle - The angle in degrees to set

copy

public RectangularROI copy()

Specified by:

copy in interface IOrientableROI

Specified by:

copy in interface IRectangularROI

Specified by:

copy in interface IROI

Overrides:

copy in class OrientableROIBase

Returns:

a copy of ROI

getAngleRelativeToMidPoint

public double getAngleRelativeToMidPoint(int[] pt)

Parameters:

pt -

Returns:

angle as measured from midpoint to given point

getAngleRelativeToMidPoint

public double getAngleRelativeToMidPoint(double[] pt)

Parameters:

pt -

Returns:

angle as measured from midpoint to given point

getAngleRelativeToPoint

public double getAngleRelativeToPoint(double fx,
 double fy,
 int[] pt)

Parameters:

fx -

fy -

pt -

Returns:

angle as measured from normalized coordinates within rectangle to given point

getAngleRelativeToPoint

public double getAngleRelativeToPoint(double fx,
 double fy,
 double[] pt)

Parameters:

fx -

fy -

pt -

Returns:

angle as measured from normalized coordinates within rectangle to given point

setEndPointKeepLengths

public void setEndPointKeepLengths(double[] pt)

Start a rotated rectangle with predefined starting point and given end point and determine new starting point

Parameters:

pt -

setEndPoint

public void setEndPoint(int[] pt)

Parameters:

pt -

setEndPoint

public void setEndPoint(double[] pt)

Start a rotated rectangle with predefined starting point and given end point and determine new starting point and lengths

Parameters:

pt -

setEndPoint

public void setEndPoint(int[] pt,
 boolean moveX,
 boolean moveY)

Start a rotated rectangle with predefined starting point and given end point and determine new starting point and lengths

Parameters:

pt -

moveX -

moveY -

setEndPoint

public void setEndPoint(double[] pt,
 boolean moveX,
 boolean moveY)

Start a rotated rectangle with predefined starting point and given end point and determine new starting point and lengths

Parameters:

pt -

moveX -

moveY -

addAngle

public void addAngle(double angle)

Add an offset to angle

Parameters:

angle -

subPoint

public void subPoint(int[] pt)

Subtract an offset from starting point

Parameters:

pt -

translate

public void translate(double fx,
 double fy)

Translate by normalized coordinates (in rotated frame)

Parameters:

fx -

fy -

setPointKeepEndPoint

public void setPointKeepEndPoint(int[] dpt,
 boolean moveX,
 boolean moveY)

Set start point whilst keeping end point

Parameters:

dpt - change in start point

moveX -

moveY -

setPointKeepEndPoint

public void setPointKeepEndPoint(double[] dpt,
 boolean moveX,
 boolean moveY)

Set start point whilst keeping end point

Parameters:

dpt - change in start point

moveX -

moveY -

adjustKeepDiagonalPoint

public void adjustKeepDiagonalPoint(int[] cpt,
 double[] ept,
 int[] pt,
 boolean first)

Adjust ROI whilst keeping a diagonal point in place

Parameters:

cpt -

ept -

pt -

first -

adjustKeepDiagonalPoint

public void adjustKeepDiagonalPoint(double[] cpt,
 double[] ept,
 double[] pt,
 boolean first)

Adjust ROI whilst keeping a diagonal point in place

Parameters:

cpt -

ept -

pt -

first -

getBounds

public RectangularROI getBounds()

Specified by:

getBounds in interface IROI

Overrides:

getBounds in class ROIBase

Returns:

bounding box as rectangular ROI

containsPoint

public boolean containsPoint(double x,
 double y)

Specified by:

containsPoint in interface IROI

Overrides:

containsPoint in class ROIBase

Parameters:

x -

y -

Returns:

true if given point is in ROI

isNearOutline

public boolean isNearOutline(double x,
 double y,
 double distance)

Specified by:

isNearOutline in interface IROI

Overrides:

isNearOutline in class ROIBase

Parameters:

x -

y -

distance -

Returns:

true if given point within distance of outline of ROI

downsample

public void downsample(double subFactor)

Description copied from interface: IROI

To account for a down-sampling of the dataset, change ROI

Specified by:

downsample in interface IROI

Overrides:

downsample in class ROIBase

Parameters:

subFactor -

toString

public String toString()

Overrides:

toString in class ROIBase

findHorizontalIntersections

public double[] findHorizontalIntersections(double y)

Description copied from interface: IROI

Calculate x values at which ROI will intersect horizontal line of given y

Specified by:

findHorizontalIntersections in interface IROI

Overrides:

findHorizontalIntersections in class ROIBase

Parameters:

y -

Returns:

x values in ascending order, is null in the non-intersecting case

hashCode

public int hashCode()

Overrides:

hashCode in class OrientableROIBase

equals

public boolean equals(Object obj)

Overrides:

equals in class OrientableROIBase

bounds

public IRectangularROI bounds(IROI roi)

Description copied from interface: IRectangularROI

Return a new bounds with encompasses this roi and the bounds of the roi passed in.

Specified by:

bounds in interface IRectangularROI

Parameters:

roi -