org.youscope.common.image

Interface ImageProducerConfiguration

All Known Implementing Classes:

AutoFocusJobConfiguration, CellVisualizationConfiguration, ComposedImagingJobConfiguration, ContinuousImagingJobConfiguration, GlowVisualizerConfiguration, ImagingJobConfiguration, LabelVisualizerConfiguration, OutOfFocusJobConfiguration, ParallelImagingJobConfiguration, ShortContinuousImagingJobConfiguration, SlimJobConfiguration

public interface ImageProducerConfiguration

Interface each job configuration should implement to indicate that its corresponding job produces images. By implementing this interface one accepts the contract that each job created by the respective configuration also implements the ImageProducer interface. By implementing this interface one furthermore allows for validity checks, e.g. if the images produced by several different jobs are not tried to be saved in one common file.

Author:

Moritz Lang

Method Summary

Modifier and Type	Method and Description
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.

Method Detail

getImageSaveNames

java.lang.String[] getImageSaveNames()

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

int getNumberOfImages()

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.