org.youscope.plugin.composedimaging

Class ComposedImagingJobConfiguration

java.lang.Object

org.youscope.common.job.JobConfiguration

org.youscope.plugin.composedimaging.ComposedImagingJobConfiguration

All Implemented Interfaces:

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

public class ComposedImagingJobConfiguration
extends JobConfiguration
implements ImageProducerConfiguration

Author:

langmo

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TYPE_IDENTIFIER The identifier for this job type.

Constructor Summary

Constructors

Constructor and Description
ComposedImagingJobConfiguration()

Method Summary

Modifier and Type	Method and Description
void	checkConfiguration() Checks the current state of the configuration.
java.lang.Object	clone()
java.lang.String	getCameraDevice() Returns the camera device used for imaging.
java.lang.String	getChannel()
java.lang.String	getChannelGroup()
java.lang.String	getDescription() Returns a short description of this job.
double	getExposure()
java.lang.String	getImageSaveName() Returns the name under which images of this job should be saved.
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.awt.Dimension	getNumPixels()
int	getNx()
int	getNy()
double	getOverlap()
double	getPixelSize()
java.lang.String	getPixelSizeID() Returns the ID of the pixel size setting, or null if the pixel size does not correspond to a predefined pixel size setting.
java.lang.String	getTypeIdentifier() Returns a unique identifier for this configuration type.
boolean	isSaveImages()
void	setCameraDevice(java.lang.String cameraDevice) Sets the camera device used for imaging.
void	setChannel(java.lang.String channelGroup, java.lang.String channel) Sets the channel in which the images should be made.
void	setExposure(double exposure)
void	setImageSaveName(java.lang.String name) Sets the name under which images of this job should be saved.
void	setNumPixels(java.awt.Dimension numPixels)
void	setNx(int nx)
void	setNy(int ny)
void	setOverlap(double overlap)
void	setPixelSize(double pixelSize)
void	setPixelSizeID(java.lang.String pixelSizeID) Sets the ID of the pixel size setting, or null if the pixel size does not correspond to a predefined pixel size setting.
void	setSaveImages(boolean saveImages)

Methods inherited from class org.youscope.common.job.JobConfiguration

toString

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_IDENTIFIER

public static final java.lang.String TYPE_IDENTIFIER

The identifier for this job type.

See Also:

Constant Field Values

Constructor Detail

ComposedImagingJobConfiguration

public ComposedImagingJobConfiguration()

Method Detail

getDescription

public java.lang.String getDescription()

Description copied from class: JobConfiguration

Returns a short description of this job.

Specified by:

getDescription in class JobConfiguration

Returns:

Short description of the job.

setChannel

public void setChannel(java.lang.String channelGroup,
                       java.lang.String channel)

Sets the channel in which the images should be made.

Parameters:

channelGroup - The group of the channel.

channel - The channel.

getChannel

public java.lang.String getChannel()

Returns:

The channel in which is imaged.

getChannelGroup

public java.lang.String getChannelGroup()

Returns:

the group of the channel

setExposure

public void setExposure(double exposure)

Parameters:

exposure - the exposure to set

getExposure

public double getExposure()

Returns:

the exposure

setSaveImages

public void setSaveImages(boolean saveImages)

Parameters:

saveImages - the saveImages to set

isSaveImages

public boolean isSaveImages()

Returns:

the saveImages

getImageSaveName

public java.lang.String getImageSaveName()

Returns the name under which images of this job should be saved.

Returns:

Name for images.

setImageSaveName

public void setImageSaveName(java.lang.String name)

Sets the name under which images of this job should be saved.

Parameters:

name - Name for images.

setNx

public void setNx(int nx)

Parameters:

nx - the nx to set

getNx

public int getNx()

Returns:

the nx

setNy

public void setNy(int ny)

Parameters:

ny - the ny to set

getNy

public int getNy()

Returns:

the ny

setPixelSize

public void setPixelSize(double pixelSize)

Parameters:

pixelSize - the pixelSize to set

getPixelSize

public double getPixelSize()

Returns:

the pixelSize

setNumPixels

public void setNumPixels(java.awt.Dimension numPixels)

Parameters:

numPixels - the numPixels to set

getNumPixels

public java.awt.Dimension getNumPixels()

Returns:

the numPixels

setOverlap

public void setOverlap(double overlap)

Parameters:

overlap - the overlap to set

getOverlap

public double getOverlap()

Returns:

the overlap

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

Specified by:

getTypeIdentifier in interface Configuration

Returns:

Unique identifier of the configuration type.

setPixelSizeID

public void setPixelSizeID(java.lang.String pixelSizeID)

Sets the ID of the pixel size setting, or null if the pixel size does not correspond to a predefined pixel size setting.

Parameters:

pixelSizeID - ID of the pixel size setting.

getPixelSizeID

public java.lang.String getPixelSizeID()

Returns the ID of the pixel size setting, or null if the pixel size does not correspond to a predefined pixel size setting.

Returns:

ID of the pixel size setting.

setCameraDevice

public void setCameraDevice(java.lang.String cameraDevice)

Sets the camera device used for imaging.

Parameters:

cameraDevice - Name of the camera device, or null if standard camera should be used.

getCameraDevice

public java.lang.String getCameraDevice()

Returns the camera device used for imaging.

Returns:

Name of the camera device, or null if standard camera should be used.

clone

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

Overrides:

clone in class JobConfiguration

Throws:

java.lang.CloneNotSupportedException

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.

Specified by:

getImageSaveNames in interface ImageProducerConfiguration

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).

Specified by:

getNumberOfImages in interface ImageProducerConfiguration

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.

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 JobConfiguration

Throws:

ConfigurationException