org.youscope.addon.pathoptimizer

Interface PathOptimizer

All Known Implementing Classes:

FullMicroplateOptimizer, NonOptimizedOptimizer, ZigZagPathOptimizer

public interface PathOptimizer

A path optimizer is a method to optimize the path of a microplate measurement, such that the distances between the measured wells/ positions is minimal.

Author:

Moritz Lang

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName() Returns a human readable short name of the optimizer.
java.lang.String	getOptimizerID() Returns the ID of this optimizer.
java.lang.Iterable<PathOptimizerPosition>	getPath(MicroplatePositionConfiguration posConf) Returns the optimized path for a given position configuration, or zero if not applicable.
double	getSpecificity(MicroplatePositionConfiguration posConf) Returns a value in between 0 and 1 indicating how specific the given optimizer is, i.e.
boolean	isApplicable(MicroplatePositionConfiguration posConf) Returns true if this optimizer can be used to optimize the path for the positions in the respective configuration.

Method Detail

getPath

java.lang.Iterable<PathOptimizerPosition> getPath(MicroplatePositionConfiguration posConf)

Returns the optimized path for a given position configuration, or zero if not applicable.

Parameters:

posConf - Configuration of which positions should be in the path.

Returns:

optimized path, or null.

isApplicable

boolean isApplicable(MicroplatePositionConfiguration posConf)

Returns true if this optimizer can be used to optimize the path for the positions in the respective configuration.

Parameters:

posConf - Configuration of the positions which should be in the path.

Returns:

TRUE if this optimizer can be used for the given path.

getSpecificity

double getSpecificity(MicroplatePositionConfiguration posConf)

Returns a value in between 0 and 1 indicating how specific the given optimizer is, i.e. how "optimal" the calculated path can be expected to be. A value of 0 indicates an unspecific (i.e. probably bad path), a value of 1 a very specific (i.e. the optimal path). In general, for a given problem the optimizer which returns the highest specificity should be preferred, if measurement speed is important. In general, calculating the optimal path is NP hard. Most optimizers therefore either do not return the global optimal path, but only a path which is expected to be good, or, impose certain requirements on the selected wells and positions.

Parameters:

posConf - The position configuration for which the optimal path should be calculated.

Returns:

The specificity (0-1) of the optimizer for the given position configuration, or -1, if the optimizer can not be used to calculate the path for the given position configuration.

getName

java.lang.String getName()

Returns a human readable short name of the optimizer.

Returns:

Human readable short name.

getOptimizerID

java.lang.String getOptimizerID()

Returns the ID of this optimizer. The ID should be unique.

Returns:

ID of the optimizer.