org.youscope.plugin.nonoptimizedpath

Class NonOptimizedOptimizer

java.lang.Object

org.youscope.plugin.nonoptimizedpath.NonOptimizedOptimizer

All Implemented Interfaces:

PathOptimizer

public class NonOptimizedOptimizer
extends java.lang.Object
implements PathOptimizer

This optimizer actually does not really optimize the path in any way, but just iterates through all wells from left to right and from top to bottom. The same for the positions in a well.

Author:

Moritz Lang

Constructor Summary

Constructors

Constructor and Description
NonOptimizedOptimizer()

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

NonOptimizedOptimizer

public NonOptimizedOptimizer()

Method Detail

getPath

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

Description copied from interface: PathOptimizer

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

Specified by:

getPath in interface PathOptimizer

Parameters:

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

Returns:

optimized path, or null.

isApplicable

public boolean isApplicable(MicroplatePositionConfiguration posConf)

Description copied from interface: PathOptimizer

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

Specified by:

isApplicable in interface PathOptimizer

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

public double getSpecificity(MicroplatePositionConfiguration posConf)

Description copied from interface: PathOptimizer

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.

Specified by:

getSpecificity in interface PathOptimizer

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

public java.lang.String getName()

Description copied from interface: PathOptimizer

Returns a human readable short name of the optimizer.

Specified by:

getName in interface PathOptimizer

Returns:

Human readable short name.

getOptimizerID

public java.lang.String getOptimizerID()

Description copied from interface: PathOptimizer

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

Specified by:

getOptimizerID in interface PathOptimizer

Returns:

ID of the optimizer.