org.youscope.plugin.continousimaging

Class ShortContinuousImagingJobConfiguration

java.lang.Object

org.youscope.common.job.JobConfiguration

org.youscope.plugin.continousimaging.ShortContinuousImagingJobConfiguration

All Implemented Interfaces:

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

public class ShortContinuousImagingJobConfiguration
extends JobConfiguration
implements ImageProducerConfiguration

Author:

Moritz Lang

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
ShortContinuousImagingJobConfiguration()

Method Summary

Modifier and Type	Method and Description
CameraConfiguration	getCamera() Returns the camera with which should be imaged, or null, if imaging with the default camera.
ChannelConfiguration	getChannel() The channel where the images should be made.
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	getImagingPeriod()
int	getNumberOfImages() Returns the number of images which get produced per evaluation of a job initialized with this configuration.
int	getNumImages() Returns the number of images which should be taken.
java.lang.String	getTypeIdentifier() Returns a unique identifier for this configuration type.
boolean	isSaveImages() Returns if the images made by this job should be saved to disk.
void	setCamera(CameraConfiguration camera) Sets the camera with which should be imaged.
void	setChannel(ChannelConfiguration channel) The channel where the images should be made.
void	setExposure(double exposure) Sets the exposure time in ms.
void	setImageSaveName(java.lang.String name) Sets the name under which the images should be saved.
void	setImagingPeriod(int imagingPeriod)
void	setNumImages(int numImages) Sets the number of images which should be taken.
void	setSaveImages(boolean saveImages)

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

checkConfiguration, clone, 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

ShortContinuousImagingJobConfiguration

public ShortContinuousImagingJobConfiguration()

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

Specified by:

getTypeIdentifier in interface Configuration

Returns:

Unique identifier of the configuration type.

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.

setCamera

public void setCamera(CameraConfiguration camera)

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

Parameters:

camera - device, or null.

getCamera

public CameraConfiguration getCamera()

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

Returns:

camera device, or null.

setChannel

public void setChannel(ChannelConfiguration channel)

The channel where the images should be made. Set to null if no device settings should be set for imaging.

Parameters:

channel - The channel.

getChannel

public ChannelConfiguration getChannel()

The channel where the images should be made.

Returns:

The channel.

setExposure

public void setExposure(double exposure)

Sets the exposure time in ms.

Parameters:

exposure - Exposure time in ms.

getExposure

public double getExposure()

Returns:

Exposure time in ms.

setSaveImages

public void setSaveImages(boolean saveImages)

Parameters:

saveImages - the saveImages to set

getImageSaveName

public java.lang.String getImageSaveName()

Returns the name under which the images should be saved.

Returns:

The name of the job.

setImageSaveName

public void setImageSaveName(java.lang.String name)

Sets the name under which the images should be saved.

Parameters:

name - The name of the job.

setImagingPeriod

public void setImagingPeriod(int imagingPeriod)

Parameters:

imagingPeriod - The time between two successive images.

getImagingPeriod

public int getImagingPeriod()

Returns:

The time between two successive images.

isSaveImages

public boolean isSaveImages()

Returns if the images made by this job should be saved to disk.

Returns:

True if images should be saved.

setNumImages

public void setNumImages(int numImages)

Sets the number of images which should be taken.

Parameters:

numImages - Number of images to be taken.

getNumImages

public int getNumImages()

Returns the number of images which should be taken.

Returns:

numImages Number of images to be taken.

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.