org.youscope.plugin.labelvisualizer

Class LabelVisualizerConfiguration

java.lang.Object

org.youscope.common.resource.ResourceConfiguration

org.youscope.addon.celldetection.CellVisualizationConfiguration

org.youscope.plugin.labelvisualizer.LabelVisualizerConfiguration

All Implemented Interfaces:

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

public class LabelVisualizerConfiguration
extends CellVisualizationConfiguration

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
LabelVisualizerConfiguration() Constructor.

Method Summary

Modifier and Type	Method and Description
void	checkConfiguration() Checks the current state of the configuration.
java.lang.Object	clone()
java.lang.String[]	getImageSaveNames() Should return the names of all images produced by this job and which should be saved to disk.
int	getNumberOfImages() Returns the number of images which get produced per evaluation of a job initialized with this configuration.
java.lang.String	getTypeIdentifier() Returns a unique identifier for this configuration type.
boolean	isDrawCellInformation() Returns true if information about each detected cell is drawn next to the cell.
boolean	isDrawIntoOrgImage() Returns if the borders of the cells should be drawn into the original image (true), or the shape of the cell into a new image (false).
void	setDrawCellInformation(boolean drawCellInformation) Set to true to draw information about each detected cell next to the cell.
void	setDrawIntoOrgImage(boolean drawIntoOrgImage) Sets if the borders of the cells should be drawn into the original image (true), or the shape of the cell into a new image (false).

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

LabelVisualizerConfiguration

public LabelVisualizerConfiguration()

Constructor.

Method Detail

clone

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

Overrides:

clone in class CellVisualizationConfiguration

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.

setDrawCellInformation

public void setDrawCellInformation(boolean drawCellInformation)

Set to true to draw information about each detected cell next to the cell.

Parameters:

drawCellInformation - True to draw information, false otherwise.

isDrawCellInformation

public boolean isDrawCellInformation()

Returns true if information about each detected cell is drawn next to the cell.

Returns:

True if information is drawn.

setDrawIntoOrgImage

public void setDrawIntoOrgImage(boolean drawIntoOrgImage)

Sets if the borders of the cells should be drawn into the original image (true), or the shape of the cell into a new image (false).

Parameters:

drawIntoOrgImage - True to draw into original image.

isDrawIntoOrgImage

public boolean isDrawIntoOrgImage()

Returns if the borders of the cells should be drawn into the original image (true), or the shape of the cell into a new image (false).

Returns:

True to draw into original image.

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 CellVisualizationConfiguration

Throws:

ConfigurationException

getImageSaveNames

public java.lang.String[] getImageSaveNames()

Description copied from interface: ImageProducerConfiguration

Should return the names of all images produced by this job and which should be saved to disk. Allows to check YouScope if two jobs will later on try to save their images to the same file, thus erasing each other's result. Only names of images which are stored by YouScope's standard storage algorithm have to be returned.

Returns:

Array of all image names produced by this job configuration, or null.

getNumberOfImages

public int getNumberOfImages()

Description copied from interface: ImageProducerConfiguration

Returns the number of images which get produced per evaluation of a job initialized with this configuration. Typically, this is one. However, some jobs can produce more than one image, and the number of the produced images may or may not depend on the configuration. Some jobs might even produce no images at all for certain configurations (but usually for other configurations they produce images, otherwise this interface would not make sense to implement).

Returns:

Number of produced images. Zero indicate that no images are produced by this job type at all. Negative numbers indicate that the number of images is not known, or that it might even vary.