org.youscope.plugin.imagingjob

Class ImagingJobConfiguration

java.lang.Object

org.youscope.common.job.JobConfiguration

org.youscope.plugin.imagingjob.ImagingJobConfiguration

All Implemented Interfaces:

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

public class ImagingJobConfiguration
extends JobConfiguration
implements ImageProducerConfiguration

This job/task makes images in a certain channel in regular intervals.

Author:

Moritz Lang

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ImagingJobConfiguration()

Method Summary

Modifier and Type	Method and Description
void	checkConfiguration() Checks the current state of the configuration.
java.lang.Object	clone()
java.lang.String	getCamera() Returns the ID of the camera with which should be imaged, or null, if imaging with the default camera.
CameraConfiguration	getCameraConfiguration() Returns the camera configuration,.
java.lang.String	getChannel() Returns the channel in which should be imaged.
ChannelConfiguration	getChannelConfiguration() Returns the channel configuration.
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 the images 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.lang.String	getTypeIdentifier() Returns a unique identifier for this configuration type.
boolean	isSaveImages()
void	setCamera(java.lang.String camera) Sets the camera with which should be imaged.
void	setCameraConfiguration(CameraConfiguration cameraConfiguration) Sets the configuration of the camera.
void	setChannel(java.lang.String channelGroup, java.lang.String channel) Sets the channel and channel group in which should be imaged.
void	setChannelConfiguration(ChannelConfiguration channelConfiguration) Sets the channel configuration.
void	setExposure(double exposure)
void	setImageSaveName(java.lang.String name) The name under which the images should be saved.
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

Constructor Detail

ImagingJobConfiguration

public ImagingJobConfiguration()

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 and channel group in which should be imaged.

Parameters:

channelGroup - The group of the channel.

channel - The channel.

getChannel

public java.lang.String getChannel()

Returns the channel in which should be imaged.

Returns:

the channel.

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 the images should be saved.

Returns:

Name of the job.

setImageSaveName

public void setImageSaveName(java.lang.String name)

The name under which the images should be saved.

Parameters:

name - Name of the job.

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.

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.

setCamera

public void setCamera(java.lang.String camera)

Sets the camera with which should be imaged. Set to null to use the default camera.

Parameters:

camera - ID of camera device, or null.

getCamera

public java.lang.String getCamera()

Returns the ID of the camera with which should be imaged, or null, if imaging with the default camera.

Returns:

ID of camera, or null.

getChannelConfiguration

public ChannelConfiguration getChannelConfiguration()

Returns the channel configuration.

Returns:

Channel configuration.

setChannelConfiguration

public void setChannelConfiguration(ChannelConfiguration channelConfiguration)

Sets the channel configuration. Set to null to image in currently active channel.

Parameters:

channelConfiguration - The channel configuration.

getCameraConfiguration

public CameraConfiguration getCameraConfiguration()

Returns the camera configuration,.

Returns:

Camera configuration

setCameraConfiguration

public void setCameraConfiguration(CameraConfiguration cameraConfiguration)

Sets the configuration of the camera. Set to null to use default camera.

Parameters:

cameraConfiguration - The configuration of the camera.

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