Package ij.io

Class RoiDecoder

java.lang.Object

ij.io.RoiDecoder

public class RoiDecoder
extends Object

Decodes an ImageJ, NIH Image or Scion Image ROI file.

Field Summary

Fields

Modifier and Type	Field	Description
static int	ARROW
static int	ARROW_HEAD_SIZE
static int	ARROW_STYLE
static int	AVAILABLE_BYTE1
static int	BOTTOM
static int	C_POSITION
static int	COORDINATES
static int	COUNTERS_OFFSET
static int	DOUBLE_HEADED
static int	DRAW_OFFSET
static int	ELLIPSE
static int	FILL_COLOR
static int	FLOAT_PARAM
static int	FLOAT_STROKE_WIDTH
static int	HEADER2_OFFSET
static int	HEIGHTD
static int	IMAGE
static int	IMAGE_OPACITY
static int	IMAGE_SIZE
static int	LEFT
static int	N_COORDINATES
static int	NAME_LENGTH
static int	NAME_OFFSET
static int	OPTIONS
static int	OUTLINE
static int	OVERLAY_BACKGROUNDS
static int	OVERLAY_BOLD
static int	OVERLAY_FONT_SIZE
static int	OVERLAY_LABEL_COLOR
static int	OVERLAY_LABELS
static int	OVERLAY_NAMES
static int	POINT_TYPE
static int	POSITION
static int	PROMPT_BEFORE_DELETING
static int	RIGHT
static int	ROI_PROPS_LENGTH
static int	ROI_PROPS_OFFSET
static int	ROTATED_RECT
static int	ROUNDED_RECT_ARC_SIZE
static int	SCALE_LABELS
static int	SHAPE_ROI_SIZE
static int	SHOW_LABELS
static int	SIZE
static int	SPLINE_FIT
static int	STROKE_COLOR
static int	STROKE_WIDTH
static int	SUB_PIXEL_RESOLUTION
static int	SUBTYPE
static int	T_POSITION
static int	TEXT
static int	TOP
static int	TYPE
static int	VERSION_OFFSET
static int	WIDTHD
static int	X1
static int	X2
static int	XD
static int	Y1
static int	Y2
static int	YD
static int	Z_POSITION
static int	ZERO_TRANSPARENT

Constructor Summary

Constructors

Constructor	Description
RoiDecoder(byte[] bytes, String name)	Constructs an RoiDecoder using a byte array.
RoiDecoder(String path)	Constructs an RoiDecoder using a file path.

Method Summary

Modifier and Type	Method	Description
Roi	getRoi()	Returns the ROI.
Roi	getShapeRoi()
static Roi	open(String path)	Opens the Roi at the specified path.
static Roi	openFromByteArray(byte[] bytes)	Opens an ROI from a byte array.

Methods inherited from class java.lang.Object

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

Field Detail

VERSION_OFFSET

public static final int VERSION_OFFSET

See Also:

Constant Field Values

TYPE

public static final int TYPE

See Also:

Constant Field Values

TOP

public static final int TOP

See Also:

Constant Field Values

LEFT

public static final int LEFT

See Also:

Constant Field Values

BOTTOM

public static final int BOTTOM

See Also:

Constant Field Values

RIGHT

public static final int RIGHT

See Also:

Constant Field Values

N_COORDINATES

public static final int N_COORDINATES

See Also:

Constant Field Values

X1

public static final int X1

See Also:

Constant Field Values

Y1

public static final int Y1

See Also:

Constant Field Values

X2

public static final int X2

See Also:

Constant Field Values

Y2

public static final int Y2

See Also:

Constant Field Values

XD

public static final int XD

See Also:

Constant Field Values

YD

public static final int YD

See Also:

Constant Field Values

WIDTHD

public static final int WIDTHD

See Also:

Constant Field Values

HEIGHTD

public static final int HEIGHTD

See Also:

Constant Field Values

SIZE

public static final int SIZE

See Also:

Constant Field Values

STROKE_WIDTH

public static final int STROKE_WIDTH

See Also:

Constant Field Values

SHAPE_ROI_SIZE

public static final int SHAPE_ROI_SIZE

See Also:

Constant Field Values

STROKE_COLOR

public static final int STROKE_COLOR

See Also:

Constant Field Values

FILL_COLOR

public static final int FILL_COLOR

See Also:

Constant Field Values

SUBTYPE

public static final int SUBTYPE

See Also:

Constant Field Values

OPTIONS

public static final int OPTIONS

See Also:

Constant Field Values

ARROW_STYLE

public static final int ARROW_STYLE

See Also:

Constant Field Values

FLOAT_PARAM

public static final int FLOAT_PARAM

See Also:

Constant Field Values

POINT_TYPE

public static final int POINT_TYPE

See Also:

Constant Field Values

ARROW_HEAD_SIZE

public static final int ARROW_HEAD_SIZE

See Also:

Constant Field Values

ROUNDED_RECT_ARC_SIZE

public static final int ROUNDED_RECT_ARC_SIZE

See Also:

Constant Field Values

POSITION

public static final int POSITION

See Also:

Constant Field Values

HEADER2_OFFSET

public static final int HEADER2_OFFSET

See Also:

Constant Field Values

COORDINATES

public static final int COORDINATES

See Also:

Constant Field Values

C_POSITION

public static final int C_POSITION

See Also:

Constant Field Values

Z_POSITION

public static final int Z_POSITION

See Also:

Constant Field Values

T_POSITION

public static final int T_POSITION

See Also:

Constant Field Values

NAME_OFFSET

public static final int NAME_OFFSET

See Also:

Constant Field Values

NAME_LENGTH

public static final int NAME_LENGTH

See Also:

Constant Field Values

OVERLAY_LABEL_COLOR

public static final int OVERLAY_LABEL_COLOR

See Also:

Constant Field Values

OVERLAY_FONT_SIZE

public static final int OVERLAY_FONT_SIZE

See Also:

Constant Field Values

AVAILABLE_BYTE1

public static final int AVAILABLE_BYTE1

See Also:

Constant Field Values

IMAGE_OPACITY

public static final int IMAGE_OPACITY

See Also:

Constant Field Values

IMAGE_SIZE

public static final int IMAGE_SIZE

See Also:

Constant Field Values

FLOAT_STROKE_WIDTH

public static final int FLOAT_STROKE_WIDTH

See Also:

Constant Field Values

ROI_PROPS_OFFSET

public static final int ROI_PROPS_OFFSET

See Also:

Constant Field Values

ROI_PROPS_LENGTH

public static final int ROI_PROPS_LENGTH

See Also:

Constant Field Values

COUNTERS_OFFSET

public static final int COUNTERS_OFFSET

See Also:

Constant Field Values

TEXT

public static final int TEXT

See Also:

Constant Field Values

ARROW

public static final int ARROW

See Also:

Constant Field Values

ELLIPSE

public static final int ELLIPSE

See Also:

Constant Field Values

IMAGE

public static final int IMAGE

See Also:

Constant Field Values

ROTATED_RECT

public static final int ROTATED_RECT

See Also:

Constant Field Values

SPLINE_FIT

public static final int SPLINE_FIT

See Also:

Constant Field Values

DOUBLE_HEADED

public static final int DOUBLE_HEADED

See Also:

Constant Field Values

OUTLINE

public static final int OUTLINE

See Also:

Constant Field Values

OVERLAY_LABELS

public static final int OVERLAY_LABELS

See Also:

Constant Field Values

OVERLAY_NAMES

public static final int OVERLAY_NAMES

See Also:

Constant Field Values

OVERLAY_BACKGROUNDS

public static final int OVERLAY_BACKGROUNDS

See Also:

Constant Field Values

OVERLAY_BOLD

public static final int OVERLAY_BOLD

See Also:

Constant Field Values

SUB_PIXEL_RESOLUTION

public static final int SUB_PIXEL_RESOLUTION

See Also:

Constant Field Values

DRAW_OFFSET

public static final int DRAW_OFFSET

See Also:

Constant Field Values

ZERO_TRANSPARENT

public static final int ZERO_TRANSPARENT

See Also:

Constant Field Values

SHOW_LABELS

public static final int SHOW_LABELS

See Also:

Constant Field Values

SCALE_LABELS

public static final int SCALE_LABELS

See Also:

Constant Field Values

PROMPT_BEFORE_DELETING

public static final int PROMPT_BEFORE_DELETING

See Also:

Constant Field Values

Constructor Detail

RoiDecoder

public RoiDecoder(String path)

Constructs an RoiDecoder using a file path.

RoiDecoder

public RoiDecoder(byte[] bytes,
                  String name)

Constructs an RoiDecoder using a byte array.

Method Detail

open

public static Roi open(String path)

Opens the Roi at the specified path. Returns null if there is an error.

getRoi

public Roi getRoi()
           throws IOException

Returns the ROI.

Throws:

IOException

getShapeRoi

public Roi getShapeRoi()
                throws IOException

Throws:

IOException

openFromByteArray

public static Roi openFromByteArray(byte[] bytes)

Opens an ROI from a byte array.