plugins.kernel.roi.roi3d

Class ROI3DLine

java.lang.Object

icy.roi.ROI

icy.roi.ROI3D

plugins.kernel.roi.roi3d.ROI3DShape

plugins.kernel.roi.roi3d.ROI3DLine

All Implemented Interfaces:

ChangeListener, XMLPersistent, Shape3D

public class ROI3DLine
extends ROI3DShape

ROI 3D Line.

Author:

Stephane Dallongeville

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ROI3DLine.ROI3DLinePainter

Nested classes/interfaces inherited from class plugins.kernel.roi.roi3d.ROI3DShape

ROI3DShape.ROI3DShapePainter

Nested classes/interfaces inherited from class icy.roi.ROI3D

ROI3D.ROI3DPainter

Nested classes/interfaces inherited from class icy.roi.ROI

ROI.ROIGroupId, ROI.ROIIdComparator, ROI.ROINameComparator, ROI.ROIPainter

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ID_PT1
static java.lang.String	ID_PT2

Fields inherited from class plugins.kernel.roi.roi3d.ROI3DShape

ID_POINT, ID_POINTS

Fields inherited from class icy.roi.ROI3D

ID_C, ID_T

Fields inherited from class icy.roi.ROI

DEFAULT_COLOR, DEFAULT_NORMAL_COLOR, DEFAULT_OPACITY, DEFAULT_STROKE, defaultColor, defaultOpacity, defaultShowName, defaultStroke, ID_CLASSNAME, ID_COLOR, ID_GROUPID, ID_ID, ID_NAME, ID_OPACITY, ID_PROPERTIES, ID_READONLY, ID_ROI, ID_SELECTED, ID_SHOWNAME, ID_STROKE, idComparator, nameComparator, PROPERTY_COLOR, PROPERTY_CREATING, PROPERTY_GROUPID, PROPERTY_ICON, PROPERTY_NAME, PROPERTY_OPACITY, PROPERTY_READONLY, PROPERTY_SHOWNAME, PROPERTY_STROKE, ROI_CHANGED_ALL, ROI_CHANGED_POSITION

Constructor Summary

Constructors

Constructor and Description
ROI3DLine()
ROI3DLine(double x1, double y1, double z1, double x2, double y2, double z2)
ROI3DLine(Line3D line)
ROI3DLine(Point3D pt)
ROI3DLine(Point3D pt1, Point3D pt2)
ROI3DLine(Point5D pt) Generic constructor for interactive mode

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canAddPoint() Return true if this ROI support adding new point
boolean	canRemovePoint() Return true if this ROI support removing point
boolean	canSetBounds() Returns true if this ROI accepts bounds change through the ROI.setBounds5D(Rectangle5D) method.
double	computeNumberOfPoints() Compute and returns the number of point (pixel) contained in the ROI.
boolean	contains(ROI roi) Tests if the ROI entirely contains the specified ROI.
static void	drawLine3DInBooleanMask2D(java.awt.Rectangle bounds2d, boolean[] result, int z, Point3D p1, Point3D p2)
boolean[]	getBooleanMask2D(int x, int y, int width, int height, int z, boolean inclusive) Get the boolean bitmap mask for the specified rectangular area of the roi and for the specified Z position.
java.lang.String	getDefaultName()
Line3D	getLine()
boolean	intersects(ROI r) Tests if the current ROI intersects the specified ROI.
boolean	loadFromXML(org.w3c.dom.Node node) LOAD
boolean	saveToXML(org.w3c.dom.Node node) SAVE
void	setBounds3D(Rectangle3D bounds) Set the ROI 3D bounds.
void	setLine(Line3D line)

Methods inherited from class plugins.kernel.roi.roi3d.ROI3DShape

addNewPoint, addPoint, canTranslate, computeBounds3D, computeNumberOfContourPoints, computeSurfaceArea, contains, contains, contains, contains, controlPointOverlayChanged, controlPointPositionChanged, getControlPoints, getLength, getPoints, getShape, hasSelectedPoint, intersects, intersects, isOverEdge, onChanged, removePoint, removeSelectedPoint, translate, unselectAllPoints

Methods inherited from class icy.roi.ROI3D

canSetPosition, computeBounds5D, contains, contains, getBooleanMask, getBooleanMask2D, getBooleanMask2D, getBooleanMask2D, getBooleanMask2D, getBooleanMask3D, getBounds, getBounds3D, getC, getDimension, getPosition, getPosition3D, getROI3DList, getROI3DList, getSurfaceArea, getSurfaceArea, getT, getVolume, intersects, isActiveFor, isActiveFor, isOverEdge, isOverEdge, isOverEdge, setBounds5D, setC, setPosition3D, setPosition5D, setT

Methods inherited from class icy.roi.ROI

add, addListener, attachTo, beginUpdate, canvasToImageDeltaX, canvasToImageDeltaY, canvasToImageLogDeltaX, canvasToImageLogDeltaX, canvasToImageLogDeltaX, canvasToImageLogDeltaX, canvasToImageLogDeltaY, canvasToImageLogDeltaY, canvasToImageLogDeltaY, canvasToImageLogDeltaY, contains, contains, copyFrom, create, create, create, create, createFromXML, delete, delete, detachFrom, detachFromAll, detachFromAll, endUpdate, exclusiveAdd, focusChanged, getAdjustedStroke, getAdjustedStroke, getBooleanMask2D, getBounds5D, getClassName, getColor, getCopy, getDefaultColor, getDefaultOpacity, getDefaultShowName, getDefaultStroke, getDisplayColor, getExclusiveUnion, getFirstSequence, getFocusedColor, getGroupId, getIcon, getId, getIntersection, getName, getNameSuffix, getNumberOfContourPoints, getNumberOfPoints, getOpacity, getOverlay, getPainter, getPerimeter, getPosition5D, getProperties, getProperty, getPropertyValue, getROICount, getROIList, getROIList, getROIList, getROIsFromXML, getSelectedColor, getSequences, getShowName, getSimpleClassName, getStroke, getSubROI, getSubtraction, getUnion, internalFocus, internalSelect, internalUnfocus, internalUnselect, intersect, intersects, isAttached, isCreating, isDefaultName, isEditable, isEmpty, isFocused, isReadOnly, isSelected, isUpdating, loadFromXML, loadROIsFromXML, merge, mergeWith, nameChanged, painterChanged, propertyChanged, remove, remove, removeListener, roiChanged, roiChanged, roiChanged, saveROIsToXML, selectionChanged, setColor, setCreating, setDefaultColor, setDefaultOpacity, setDefaultShowName, setDefaultStroke, setEditable, setFocused, setGroupId, setIcon, setMousePos, setName, setOpacity, setProperty, setPropertyValue, setReadOnly, setROIsFromXML, setSelected, setSelected, setSelectedColor, setShowName, setStroke, subtract

Methods inherited from class java.lang.Object

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

Methods inherited from interface icy.type.geom.Shape3D

getBounds

Field Detail

ID_PT1

public static final java.lang.String ID_PT1

See Also:

Constant Field Values

ID_PT2

public static final java.lang.String ID_PT2

See Also:

Constant Field Values

Constructor Detail

ROI3DLine

public ROI3DLine(Point3D pt1,
         Point3D pt2)

ROI3DLine

public ROI3DLine(Line3D line)

ROI3DLine

public ROI3DLine(Point3D pt)

ROI3DLine

public ROI3DLine(Point5D pt)

Generic constructor for interactive mode

ROI3DLine

public ROI3DLine(double x1,
         double y1,
         double z1,
         double x2,
         double y2,
         double z2)

ROI3DLine

public ROI3DLine()

Method Detail

getDefaultName

public java.lang.String getDefaultName()

Overrides:

getDefaultName in class ROI3DShape

Returns:

the default name for this ROI class

getLine

public Line3D getLine()

canAddPoint

public boolean canAddPoint()

Description copied from class: ROI3DShape

Return true if this ROI support adding new point

Overrides:

canAddPoint in class ROI3DShape

canRemovePoint

public boolean canRemovePoint()

Description copied from class: ROI3DShape

Return true if this ROI support removing point

Overrides:

canRemovePoint in class ROI3DShape

canSetBounds

public boolean canSetBounds()

Description copied from class: ROI

Returns true if this ROI accepts bounds change through the ROI.setBounds5D(Rectangle5D) method.

Overrides:

canSetBounds in class ROI3D

setBounds3D

public void setBounds3D(Rectangle3D bounds)

Description copied from class: ROI3D

Set the ROI 3D bounds.
Note that not all ROI supports bounds modification and you should call ROI3D.canSetBounds() first to test if the operation is supported.

Overrides:

setBounds3D in class ROI3D

Parameters:

bounds - new ROI 3D bounds

setLine

public void setLine(Line3D line)

getBooleanMask2D

public boolean[] getBooleanMask2D(int x,
                         int y,
                         int width,
                         int height,
                         int z,
                         boolean inclusive)

Description copied from class: ROI3D

Get the boolean bitmap mask for the specified rectangular area of the roi and for the specified Z position.
if the pixel (x,y) is contained in the roi Z position then result[(y * width) + x] = true
if the pixel (x,y) is not contained in the roi Z position then result[(y * width) + x] = false

Overrides:

getBooleanMask2D in class ROI3D

Parameters:

x - the X coordinate of the upper-left corner of the specified rectangular area

y - the Y coordinate of the upper-left corner of the specified rectangular area

width - the width of the specified rectangular area

height - the height of the specified rectangular area

z - Z position we want to retrieve the boolean mask

inclusive - If true then all partially contained (intersected) pixels are included in the mask.

Returns:

the boolean bitmap mask

drawLine3DInBooleanMask2D

public static void drawLine3DInBooleanMask2D(java.awt.Rectangle bounds2d,
                             boolean[] result,
                             int z,
                             Point3D p1,
                             Point3D p2)

computeNumberOfPoints

public double computeNumberOfPoints()

Description copied from class: ROI

Compute and returns the number of point (pixel) contained in the ROI.

Overrides:

computeNumberOfPoints in class ROI3DShape

contains

public boolean contains(ROI roi)

Description copied from class: ROI

Tests if the ROI entirely contains the specified ROI. WARNING: this method may be "pixel accurate" only depending the internal implementation.

Overrides:

contains in class ROI3D

Returns:

true if the current ROI entirely contains the specified ROI; false otherwise.

intersects

public boolean intersects(ROI r)

Description copied from class: ROI

Tests if the current ROI intersects the specified ROI.
Note that this method may be "pixel accurate" only depending the internal implementation.

Overrides:

intersects in class ROI3D

Returns:

true if ROI intersect, false otherwise.

loadFromXML

public boolean loadFromXML(org.w3c.dom.Node node)

Description copied from interface: XMLPersistent

LOAD

Specified by:

loadFromXML in interface XMLPersistent

Overrides:

loadFromXML in class ROI3DShape

saveToXML

public boolean saveToXML(org.w3c.dom.Node node)

Description copied from interface: XMLPersistent

SAVE

Specified by:

saveToXML in interface XMLPersistent

Overrides:

saveToXML in class ROI3D