org.youscope.plugin.brentfocussearch

Class BrentFocusSearchConfiguration

java.lang.Object

org.youscope.common.resource.ResourceConfiguration

org.youscope.addon.focussearch.FocusSearchConfiguration

org.youscope.plugin.brentfocussearch.BrentFocusSearchConfiguration

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Configuration

public class BrentFocusSearchConfiguration
extends FocusSearchConfiguration

Author:

Moritz Lang

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONFIGURATION_ID The identifier for this configuration.

Constructor Summary

Constructors

Constructor and Description
BrentFocusSearchConfiguration() Constructor.

Method Summary

Modifier and Type	Method and Description
void	checkConfiguration() Checks the current state of the configuration.
java.lang.Object	clone()
double	getFocusLowerBound() Returns the minimal relative focus.
double	getFocusUpperBound() Returns the maximal relative focus.
int	getMaxSearchSteps() Returns the maximal number of images which should be taken and analyzed to find the optional focal plane
double	getTolerance() Returns the tolerance, in um, for the focal plane position.
java.lang.String	getTypeIdentifier() Returns a unique identifier for this configuration type.
void	setFocusLowerBound(double focusLowerBound) Sets the minimal relative focus.
void	setFocusUpperBound(double focusUpperBound) Sets the maximal relative focus.
void	setMaxSearchSteps(int maxSearchSteps) Sets the maximal number of images which should be taken and analyzed to find the optional focal plane
void	setTolerance(double tolerance) Sets the tolerance, in um, for the focal plane position.

Methods inherited from class java.lang.Object

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

Field Detail

CONFIGURATION_ID

public static final java.lang.String CONFIGURATION_ID

The identifier for this configuration.

See Also:

Constant Field Values

Constructor Detail

BrentFocusSearchConfiguration

public BrentFocusSearchConfiguration()

Constructor.

Method Detail

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Overrides:

clone in class FocusSearchConfiguration

Throws:

java.lang.CloneNotSupportedException

getTypeIdentifier

public java.lang.String getTypeIdentifier()

Description copied from interface: Configuration

Returns a unique identifier for this configuration type. The identifier is used to determine factories and addons to construct and configure jobs, measurements, etc., given a corresponding configuration. Make sure that the ID returned is unique. The returned identifier should conform to "XXX.YYY", where XXX stands for an identifier of the organizational unit or the person who created the configuration (e.g. ETH, Smith, Cindarella), and YYY stands for an identifier of the specific kind of configuration (e.g. AutofocusJob, PlatePosition, MicroplateMeasurement). Optionally, additional hierarchy levels can be defined by additional separators ., e.g. "YouScope.AutofocusJob.Version1.1" The identifier should not contain spaces, non-ASCII characters, or colons (except for hierarchy level separation). Identifiers should start with a capital character, i.e. A-Z. Make sure to not use the same identifier for different configurations, since this might result in unexpected behavior or errors. Make

Returns:

Unique identifier of the configuration type.

setFocusLowerBound

public void setFocusLowerBound(double focusLowerBound)

Sets the minimal relative focus. Must be smaller than the upper bound.

Parameters:

focusLowerBound - lower relative focus bound

getFocusLowerBound

public double getFocusLowerBound()

Returns the minimal relative focus.

Returns:

lower relative focus bound

setFocusUpperBound

public void setFocusUpperBound(double focusUpperBound)

Sets the maximal relative focus. Must be bigger than the lower bound.

Parameters:

focusUpperBound - upper relative focus bound

getFocusUpperBound

public double getFocusUpperBound()

Returns the maximal relative focus.

Returns:

upper relative focus bound

setMaxSearchSteps

public void setMaxSearchSteps(int maxSearchSteps)

Sets the maximal number of images which should be taken and analyzed to find the optional focal plane

Parameters:

maxSearchSteps - maximal number of focus search steps. Must be larger than one.

getMaxSearchSteps

public int getMaxSearchSteps()

Returns the maximal number of images which should be taken and analyzed to find the optional focal plane

Returns:

maximal number of focus search steps.

getTolerance

public double getTolerance()

Returns the tolerance, in um, for the focal plane position.

Returns:

Tolerance

setTolerance

public void setTolerance(double tolerance)

Sets the tolerance, in um, for the focal plane position.

Parameters:

tolerance - tolerance in um. Must be bigger than 0.

checkConfiguration

public void checkConfiguration()
                        throws ConfigurationException

Description copied from interface: Configuration

Checks the current state of the configuration. If the configuration state is valid, the method returns normally. If not, a ConfigurationException is thrown describing the error, and what has to be changed in the configuration, by the user, such that it becomes valid. This error can then e.g. be displayed to the user (see ConfigurationAddonTools.displayConfigurationInvalid(ConfigurationException, YouScopeClient).

Specified by:

checkConfiguration in interface Configuration

Overrides:

checkConfiguration in class ResourceConfiguration

Throws:

ConfigurationException