Package org.anchoranalysis.image.io.bean.object.draw

Class Outline

Object

AnchorBean<DrawObject>

DrawObject

Outline

public class Outline
extends DrawObject

Draws the outline of each object-mask.

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
Outline()	Creates with an outline-width of 1 voxel.
Outline(int outlineWidth)	Create with a particular outline-width.
Outline(int outlineWidth, boolean includeZ)	Creates a new Outline instance.

Method Summary

Modifier and Type	Method	Description
void	drawSingle(ObjectWithProperties object, RGBStack stack, ObjectDrawAttributes attributes, int iteration, BoundingBox restrictTo)	Draws a single-object on top of a RGB-stack.
int	getOutlineWidth()	The size of the outline, in terms of the number of voxels.
boolean	isIncludeZ()	If true the outline is also applied in the z-dimension, otherwise this is ignored as possible boundary
void	setIncludeZ(boolean includeZ)	If true the outline is also applied in the z-dimension, otherwise this is ignored as possible boundary
void	setOutlineWidth(int outlineWidth)	The size of the outline, in terms of the number of voxels.

Methods inherited from class org.anchoranalysis.overlay.bean.DrawObject

drawCollection, drawCollection

Methods inherited from class org.anchoranalysis.bean.AnchorBean

checkMisconfigured, describeBean, describeChildren, duplicateBean, fields, findFieldsOfClass, getBeanName, getLocalPath, localise, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

Outline

public Outline()

Creates with an outline-width of 1 voxel.

Outline

public Outline(int outlineWidth)

Create with a particular outline-width.

Parameters:

outlineWidth - the size of the outline, in terms of the number of voxels.

Outline

public Outline(int outlineWidth,
 boolean includeZ)

Creates a new Outline instance.

Parameters:

outlineWidth - The size of the outline, in terms of the number of voxels.

includeZ - If true the outline is also applied in the z-dimension, otherwise this is ignored as possible boundary

Method Details

drawSingle

public void drawSingle(ObjectWithProperties object,
 RGBStack stack,
 ObjectDrawAttributes attributes,
 int iteration,
 BoundingBox restrictTo)
                throws OperationFailedException

Description copied from class: DrawObject

Draws a single-object on top of a RGB-stack.

Specified by:

drawSingle in class DrawObject

Parameters:

object - the object to draw.

stack - the image to draw on.

attributes - attributes for each object when drawing.

iteration - the current iteration.

restrictTo - a restriction on which part of stack we draw onto to (considered in terms of the possibly-zoomed pixel coordinates).

Throws:

OperationFailedException - if the object cannot be successfully drawn.

getOutlineWidth

public int getOutlineWidth()

The size of the outline, in terms of the number of voxels.

setOutlineWidth

public void setOutlineWidth(int outlineWidth)

The size of the outline, in terms of the number of voxels.

isIncludeZ

public boolean isIncludeZ()

If true the outline is also applied in the z-dimension, otherwise this is ignored as possible boundary

setIncludeZ

public void setIncludeZ(boolean includeZ)

If true the outline is also applied in the z-dimension, otherwise this is ignored as possible boundary