com.emphysic.myriad.core.data.roi

Class ROIBundle

java.lang.Object

com.emphysic.myriad.core.data.roi.ROIBundle

All Implemented Interfaces:

ROIFinder, ObjectMap, com.esotericsoftware.kryo.KryoSerializable

public class ROIBundle
extends java.lang.Object
implements ROIFinder

ROIBundle - bundles an ROIFinder, a preprocessing DatasetOperation, and assorted metadata into a single "black box" Region Of Interest finder for easier serialization and distribution of trained models. Created by ccoughlin on 4/16/17.

Constructor Summary

Constructors

Constructor and Description
ROIBundle()
ROIBundle(ROIFinder roiFinder)
ROIBundle(ROIFinder roiFinder, DatasetOperation preprocessor)

Method Summary

Modifier and Type	Method and Description
ROIFinder	getFinder()
java.util.Map<java.lang.String,java.lang.String>	getMetadata()
java.lang.String	getMetadataEntry(java.lang.String key)
java.util.Map<java.lang.String,java.lang.Object>	getObjectMap() Creates a map of the important fields for the instance, suitable for serialization.
DatasetOperation	getPreproc()
long	getSerializationVersion() Returns the current version of the serialization format.
int	getVersion() Returns the current class version.
void	initCurrentVersion(java.util.Map<java.lang.String,java.lang.Object> objectMap) Initializes an instance with a current-version object graph.
boolean	isROI(Dataset dataset) Examine and reports on whether the data appears to contain a Region Of Interest (ROI).
boolean	isROI(double[] data) Examine and reports on whether the data appears to contain a Region Of Interest (ROI).
void	setFinder(ROIFinder finder)
void	setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)
void	setMetadataEntry(java.lang.String key, java.lang.String val)
void	setPreproc(DatasetOperation preproc)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.emphysic.myriad.core.data.roi.ROIFinder

fromFile

Methods inherited from interface com.emphysic.myriad.core.data.util.ObjectMap

init, initPreviousVersion, initUnknownVersion, load, read, save, write

Constructor Detail

ROIBundle

public ROIBundle(ROIFinder roiFinder,
                 DatasetOperation preprocessor)

ROIBundle

public ROIBundle(ROIFinder roiFinder)

ROIBundle

public ROIBundle()

Method Detail

getMetadataEntry

public java.lang.String getMetadataEntry(java.lang.String key)

setMetadataEntry

public void setMetadataEntry(java.lang.String key,
                             java.lang.String val)

isROI

public boolean isROI(double[] data)

Examine and reports on whether the data appears to contain a Region Of Interest (ROI). Assumes any required preprocessing has already been performed.

Specified by:

isROI in interface ROIFinder

Parameters:

data - raw data to examine (WILL NOT run preprocessor if defined!)

Returns:

true if the data contains a Region Of Interest, false if it does not or no ROIFinder has been set.

isROI

public boolean isROI(Dataset dataset)

Examine and reports on whether the data appears to contain a Region Of Interest (ROI). Runs the preprocessing operation (if any) prior to examining the data.

Specified by:

isROI in interface ROIFinder

Parameters:

dataset - data to examine (WILL run preprocessor if defined!)

Returns:

true if the data contains a Region Of Interest, false if it does not or no ROIFinder has been set.

getSerializationVersion

public long getSerializationVersion()

Description copied from interface: ObjectMap

Returns the current version of the serialization format. Increments when the serialization format changes, i.e. backwards compatibility is broken.

Specified by:

getSerializationVersion in interface ObjectMap

Returns:

serialization version

getVersion

public int getVersion()

Description copied from interface: ObjectMap

Returns the current class version. Class version increments when the class changes but doesn't necessarily break compatibility with serialization.

Specified by:

getVersion in interface ObjectMap

Returns:

class version

getObjectMap

public java.util.Map<java.lang.String,java.lang.Object> getObjectMap()

Description copied from interface: ObjectMap

Creates a map of the important fields for the instance, suitable for serialization.

Specified by:

getObjectMap in interface ObjectMap

Returns:

"object map" of the instance

initCurrentVersion

public void initCurrentVersion(java.util.Map<java.lang.String,java.lang.Object> objectMap)

Description copied from interface: ObjectMap

Initializes an instance with a current-version object graph.

Specified by:

initCurrentVersion in interface ObjectMap

Parameters:

objectMap - object graph for initialization

getFinder

public ROIFinder getFinder()

setFinder

public void setFinder(ROIFinder finder)

getPreproc

public DatasetOperation getPreproc()

setPreproc

public void setPreproc(DatasetOperation preproc)

getMetadata

public java.util.Map<java.lang.String,java.lang.String> getMetadata()

setMetadata

public void setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)