com.emphysic.myriad.core.data.roi

Class ROI

java.lang.Object

com.emphysic.myriad.core.data.roi.ROI

All Implemented Interfaces:

java.io.Serializable

public class ROI
extends java.lang.Object
implements java.io.Serializable

Region Of Interest (ROI) - an object, signal, anomaly, etc. in a larger dataset. The purpose of a typical Myriad application is to find ROI(s) in this data automatically. Examples of ROIs include: - NDE flaw signals e.g. corrosion pitting, cracks, delaminations; - Faces and people in images; - Anomalies in acoustic data or video frames.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Dataset	dataset The underlying data that represents a region of interest
protected java.lang.String	metadata A text tag for including descriptive metadata
protected java.util.List<java.lang.Integer>	origin A list of coordinates for the ROI, used to define a "bounding box" that describes the position of the ROI.

Constructor Summary

Constructors

Constructor and Description
ROI(Dataset dataset, int start, int... coords) Creates a new Region of Interest from the specified data.

Method Summary

Modifier and Type	Method and Description
Dataset	getDataset() Retrieve the ROI data
java.lang.String	getMetadata() Returns the current metadata for this ROI
java.util.List<java.lang.Integer>	getOrigin() Returns the origin for the ROI
void	setMetadata(java.lang.String metadata) Sets the descriptive metadata for this ROI
void	setOrigin(int start, int... coords) Sets the bounding box origin for the ROI.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

dataset

protected Dataset dataset

The underlying data that represents a region of interest

origin

protected java.util.List<java.lang.Integer> origin

A list of coordinates for the ROI, used to define a "bounding box" that describes the position of the ROI.

metadata

protected java.lang.String metadata

A text tag for including descriptive metadata

Constructor Detail

ROI

public ROI(Dataset dataset,
           int start,
           int... coords)

Creates a new Region of Interest from the specified data.

Parameters:

dataset - data containing the ROI

start - the starting coordinate of the ROI within the data

coords - the remainder of the ROI bounding box

Method Detail

setOrigin

public void setOrigin(int start,
                      int... coords)

Sets the bounding box origin for the ROI. Examples: setOrigin(left) : 1D data, starts at "left" setOrigin(x, y) : 2D data, bounding box is (x, y)-(x + dataset.getWidth(), y + dataset.getHeight())

Parameters:

start - coordinate of the first dimension in the bounding box e.g. left or x-coordinate of top left corner.

coords - additional (start, stop) coordinates for the remaining dimensions of the bounding box.

getOrigin

public java.util.List<java.lang.Integer> getOrigin()

Returns the origin for the ROI

Returns:

list of indices

setMetadata

public void setMetadata(java.lang.String metadata)

Sets the descriptive metadata for this ROI

Parameters:

metadata - new metadata

getMetadata

public java.lang.String getMetadata()

Returns the current metadata for this ROI

Returns:

current metadata

getDataset

public Dataset getDataset()

Retrieve the ROI data

Returns:

Dataset that contains the ROI

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object