net.imagej.legacy.convert.roi.box

Class RoiWrapper

java.lang.Object

net.imagej.legacy.convert.roi.box.RoiWrapper

All Implemented Interfaces:

Predicate<net.imglib2.RealLocalizable>, IJRealRoiWrapper<ij.gui.Roi>, IJRoiWrapper<ij.gui.Roi,net.imglib2.RealLocalizable>, net.imglib2.EuclideanSpace, net.imglib2.RealInterval, net.imglib2.roi.geom.real.Box, net.imglib2.roi.geom.real.WritableBox, net.imglib2.roi.MaskPredicate<net.imglib2.RealLocalizable>, net.imglib2.roi.RealMask, net.imglib2.roi.RealMaskRealInterval

public class RoiWrapper
extends Object
implements IJRealRoiWrapper<ij.gui.Roi>, net.imglib2.roi.geom.real.WritableBox

Wraps an ImageJ 1.x Roi as an ImgLib2 Box. Even though all ImageJ 1.x ROIs are Rois, this class should only be used to wrap ROIs intended to be rectangles.

Author:

Alison Walter

Constructor Summary

Constructors

Constructor and Description
RoiWrapper(double x, double y, double width, double height) Creates an ImageJ 1.x Roi and then wraps it as an ImgLib2 Box.
RoiWrapper(ij.gui.Roi roi) Wraps an ImageJ 1.x Roi as an ImgLib2 Box.

Method Summary

Modifier and Type	Method and Description
net.imglib2.roi.util.RealLocalizableRealPositionable	center()
boolean	equals(Object obj)
ij.gui.Roi	getRoi() Returns the backing ImageJ 1.x Roi.
int	hashCode()
double	realMax(int d)
double	realMin(int d)
void	setSideLength(int d, double length) This will always throw an UnsupportedOperationException.
double	sideLength(int d)
boolean	test(net.imglib2.RealLocalizable t) In an attempt to be consistent with ImageJ 1.x Roi.contains(int, int), only some of the edges are considered "contained" by this rectangle.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.imagej.legacy.convert.roi.IJRoiWrapper

numDimensions

Methods inherited from interface net.imglib2.roi.geom.real.Box

equals, hashCode, maskType

Methods inherited from interface net.imglib2.roi.RealMaskRealInterval

and, isEmpty, minus, or, realMax, realMax, realMin, realMin, transform, xor

Methods inherited from interface net.imglib2.roi.RealMask

negate, or, transform, xor

Methods inherited from interface net.imglib2.roi.MaskPredicate

boundaryType, isAll, knownConstant

Methods inherited from interface java.util.function.Predicate

isEqual

Methods inherited from interface net.imglib2.RealInterval

maxAsDoubleArray, maxAsRealPoint, minAsDoubleArray, minAsRealPoint

Constructor Detail

RoiWrapper

public RoiWrapper(double x,
                  double y,
                  double width,
                  double height)

Creates an ImageJ 1.x Roi and then wraps it as an ImgLib2 Box.

Parameters:

x - x coordinate of upper left corner

y - y coordinate of upper left corner

width - width of rectangle

height - height of rectangle

RoiWrapper

public RoiWrapper(ij.gui.Roi roi)

Wraps an ImageJ 1.x Roi as an ImgLib2 Box.

Parameters:

roi - the Roi to be wrapped

Method Detail

test

public boolean test(net.imglib2.RealLocalizable t)

In an attempt to be consistent with ImageJ 1.x Roi.contains(int, int), only some of the edges are considered "contained" by this rectangle. Therefore, this Box has unspecified boundary behavior.

Specified by:

test in interface Predicate<net.imglib2.RealLocalizable>

realMin

public double realMin(int d)

Specified by:

realMin in interface net.imglib2.RealInterval

realMax

public double realMax(int d)

Specified by:

realMax in interface net.imglib2.RealInterval

sideLength

public double sideLength(int d)

Specified by:

sideLength in interface net.imglib2.roi.geom.real.Box

center

public net.imglib2.roi.util.RealLocalizableRealPositionable center()

Specified by:

center in interface net.imglib2.roi.geom.real.Box

Specified by:

center in interface net.imglib2.roi.geom.real.WritableBox

setSideLength

public void setSideLength(int d,
                          double length)

This will always throw an UnsupportedOperationException.

Specified by:

setSideLength in interface net.imglib2.roi.geom.real.WritableBox

Throws:

UnsupportedOperationException - cannot modify width/height of underlying Roi

getRoi

public ij.gui.Roi getRoi()

Description copied from interface: IJRoiWrapper

Returns the backing ImageJ 1.x Roi.

Specified by:

getRoi in interface IJRoiWrapper<ij.gui.Roi,net.imglib2.RealLocalizable>

Returns:

ImageJ 1.x Roi

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Specified by:

equals in interface net.imglib2.roi.geom.real.Box

Specified by:

equals in interface net.imglib2.roi.MaskPredicate<net.imglib2.RealLocalizable>

Overrides:

equals in class Object