org.youscope.plugin.dropletmicrofluidics.defaultobserver

Class DefaultObserverConfiguration

java.lang.Object

org.youscope.common.resource.ResourceConfiguration

org.youscope.addon.dropletmicrofluidics.DropletObserverConfiguration

org.youscope.plugin.dropletmicrofluidics.defaultobserver.DefaultObserverConfiguration

All Implemented Interfaces:

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

public class DefaultObserverConfiguration
extends DropletObserverConfiguration

Configuration for observer based on discrete Fourier transformation.

Author:

Moritz Lang

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TYPE_IDENTIFIER Type identifier.

Constructor Summary

Constructors

Constructor and Description
DefaultObserverConfiguration()

Method Summary

Modifier and Type	Method and Description
void	checkConfiguration() Checks the current state of the configuration.
int	getMicrofluidicChipID() Returns the ID of the chip for which this observer observes the droplet height.
double	getObserverIndividual() Returns learn rate constant of individual droplet heights.
double	getObserverMean() Returns learn rate constant of mean droplet heights.
java.lang.String	getTypeIdentifier() Returns a unique identifier for this configuration type.
void	setMicrofluidicChipID(int microfluidicChipID) Sets the ID of the chip for which this observer observes the droplet height.
void	setObserverIndividual(double observerIndividual) Sets the learn rate constant of individual droplet heights.
void	setObserverMean(double observerMean) Sets the learn rate constant of mean droplet heights.

Methods inherited from class org.youscope.common.resource.ResourceConfiguration

clone

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_IDENTIFIER

public static final java.lang.String TYPE_IDENTIFIER

Type identifier.

See Also:

Constant Field Values

Constructor Detail

DefaultObserverConfiguration

public DefaultObserverConfiguration()

Method Detail

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.

getMicrofluidicChipID

public int getMicrofluidicChipID()

Returns the ID of the chip for which this observer observes the droplet height. All observers having the same chip ID have to be called sequentially and equally often, since they considered to observe the height of droplets on the same chip. Thus, it is possible to observe the droplet heights of several chips by having different IDs.

Returns:

microfluidic chip id.

setMicrofluidicChipID

public void setMicrofluidicChipID(int microfluidicChipID)

Sets the ID of the chip for which this observer observes the droplet height. All observers having the same chip ID have to be called sequentially and equally often, since they considered to observe the height of droplets on the same chip. Thus, it is possible to observe the droplet heights of several chips by having different IDs.

Parameters:

microfluidicChipID - The id of the chip.

getObserverIndividual

public double getObserverIndividual()

Returns learn rate constant of individual droplet heights.

Returns:

Individual droplet height learn rate constant (0-1).

setObserverIndividual

public void setObserverIndividual(double observerIndividual)

Sets the learn rate constant of individual droplet heights.

Parameters:

observerIndividual - Individual droplet height learn rate constant (0-1).

getObserverMean

public double getObserverMean()

Returns learn rate constant of mean droplet heights.

Returns:

Mean droplet height learn rate constant (0-2).

setObserverMean

public void setObserverMean(double observerMean)

Sets the learn rate constant of mean droplet heights.

Parameters:

observerMean - Mean droplet height learn rate constant (0-2).

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