org.hkijena.jipipe.extensions.imagejalgorithms.ij1.roi

Enum RoiLabel

java.lang.Object

java.lang.Enum<RoiLabel>

org.hkijena.jipipe.extensions.imagejalgorithms.ij1.roi.RoiLabel

All Implemented Interfaces:

Serializable, Comparable<RoiLabel>

public enum RoiLabel
extends Enum<RoiLabel>

Moved out of the ImageJ algorithms extension

Enum Constant Summary

Enum Constants

Enum Constant and Description
Centroid
Index
Metadata
Name
None

Method Summary

Modifier and Type	Method and Description
String	createLabel(Roi roi, int roiIndex) Generates a string label based on the ROI
void	draw(Graphics2D graphics2D, Roi roi, int roiIndex, Point2D center, double magnification, Color foreground, Color background, Font font, boolean drawBackground)
void	draw(ij.ImagePlus imp, ij.process.ImageProcessor ip, Roi roi, int roiIndex, Rectangle r, Color foreground, Color background, Font font, boolean drawBackground) Draws a label on an image processor
static RoiLabel	valueOf(String name) Returns the enum constant of this type with the specified name.
static RoiLabel[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

None

public static final RoiLabel None

Index

public static final RoiLabel Index

Name

public static final RoiLabel Name

Centroid

public static final RoiLabel Centroid

Metadata

public static final RoiLabel Metadata

Method Detail

values

public static RoiLabel[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (RoiLabel c : RoiLabel.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static RoiLabel valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

draw

public void draw(ij.ImagePlus imp,
                 ij.process.ImageProcessor ip,
                 Roi roi,
                 int roiIndex,
                 Rectangle r,
                 Color foreground,
                 Color background,
                 Font font,
                 boolean drawBackground)

Draws a label on an image processor

Parameters:

imp - the image

ip - the target processor

roi - the ROI

roiIndex - the index of the ROI

r - Rectangle where x and y are the centroid (width, height are zero)

foreground - foreground color

background - background color

font - the font

drawBackground - if a background should be drawn

createLabel

public String createLabel(Roi roi,
                          int roiIndex)

Generates a string label based on the ROI

Parameters:

roi - the roi

roiIndex - the index of the roi

Returns:

the label or null if no label should be generated

draw

public void draw(Graphics2D graphics2D,
                 Roi roi,
                 int roiIndex,
                 Point2D center,
                 double magnification,
                 Color foreground,
                 Color background,
                 Font font,
                 boolean drawBackground)