AutoFocusJobConfiguration

java.lang.Object
- org.youscope.common.job.JobConfiguration
- - org.youscope.plugin.autofocus.AutoFocusJobConfiguration

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Configuration, ImageProducerConfiguration, JobContainerConfiguration, TableProducerConfiguration
```
public class AutoFocusJobConfiguration
extends JobConfiguration
implements ImageProducerConfiguration, JobContainerConfiguration, TableProducerConfiguration
```
Configuration for a job which automatically searches for the focal plane.

Author:

Moritz Lang

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`FOCUS_TABLE_DEFAULT_NAME` Default name for focus table.
`static java.lang.String`	`IMAGE_SAVE_NAME_DEFAULT` Default name for focus images.
`static java.lang.String`	`TYPE_IDENTIFIER` The identifier for this job type.

Constructor Summary

Constructors
Constructor and Description

AutoFocusJobConfiguration()

Constructors
Constructor and Description
`AutoFocusJobConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addJob(JobConfiguration job)` Adds a job to the job list.
`void`	`addJob(JobConfiguration job, int index)` Adds a job to the job list.
`void`	`checkConfiguration()` Checks the current state of the configuration.
`void`	`clearJobs()` Removes all jobs from the job list.
`java.lang.Object`	`clone()`
`java.lang.String`	`getChannel()`
`java.lang.String`	`getChannelGroup()`
`java.lang.String`	`getDescription()` Returns a short description of this job.
`double`	`getExposure()`
`FocusConfiguration`	`getFocusConfiguration()`
`FocusScoreConfiguration`	`getFocusScoreAlgorithm()` Returns the focus algorithm with which it is detected if the focus of an image made at a give focus position is better than the other.
`FocusSearchConfiguration`	`getFocusSearchAlgorithm()` Returns the focus search algorithm.
`java.lang.String`	`getFocusTableSaveName()` Returns the name under which the focus-table is saved, or null, if it is not saved.
`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.
`JobConfiguration[]`	`getJobs()` Returns the job list which might be edited by the caller.
`int`	`getNumberOfImages()` Returns the number of images which get produced per evaluation of a job initialized with this configuration.
`TableDefinition`	`getProducedTableDefinition()` Returns the definition of the table layout of the tables produced by this producer, e.g.
`java.lang.String`	`getTypeIdentifier()` Returns a unique identifier for this configuration type.
`boolean`	`isRememberFocus()` Returns true if next focus search should be centered around the last iterations maximal focal plane.
`boolean`	`isResetFocusAfterSearch()` Defines if the focus should be reset to its original value after the job (and all sub-jobs) finished.
`void`	`removeJobAt(int index)` Removes the job at the given index.
`void`	`setChannel(java.lang.String channelGroup, java.lang.String channel)` Sets the channel which should be imaged.
`void`	`setExposure(double exposure)`
`void`	`setFocusConfiguration(FocusConfiguration focusConfiguration)`
`void`	`setFocusScoreAlgorithm(FocusScoreConfiguration focusScoreAlgorithm)` Sets the focus algorithm with which it is detected if the focus of an image made at a give focus position is better than the other.
`void`	`setFocusSearchAlgorithm(FocusSearchConfiguration focusSearchAlgorithm)` sets the focus search algorithm.
`void`	`setFocusTableSaveName(java.lang.String focusTableSaveName)` Sets the name under which the focus-table should be saved.
`void`	`setImageSaveName(java.lang.String name)` Sets the name under which the images should be saved.
`void`	`setJobs(JobConfiguration[] jobs)` Sets the job list to the given list.
`void`	`setRememberFocus(boolean rememberFocus)` Set to true if next focus search should be centered around the last iterations maximal focal plane.
`void`	`setResetFocusAfterSearch(boolean resetFocusAfterSearch)` Defines if the focus should be reset to its original value after the job (and all sub-jobs) finished.

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
  - FOCUS_TABLE_DEFAULT_NAME
```
public static final java.lang.String FOCUS_TABLE_DEFAULT_NAME
```
    Default name for focus table.
    
    See Also:
    
    Constant Field Values
  - IMAGE_SAVE_NAME_DEFAULT
```
public static final java.lang.String IMAGE_SAVE_NAME_DEFAULT
```
    Default name for focus images.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AutoFocusJobConfiguration
```
public AutoFocusJobConfiguration()
```
- 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.
  - getFocusSearchAlgorithm
```
public FocusSearchConfiguration getFocusSearchAlgorithm()
```
    Returns the focus search algorithm.
    
    Returns:
    
    focus search algorithm.
  - setFocusSearchAlgorithm
```
public void setFocusSearchAlgorithm(FocusSearchConfiguration focusSearchAlgorithm)
```
    sets the focus search algorithm.
    
    Parameters:
    
    focusSearchAlgorithm - focus search algorithm.
  - setFocusConfiguration
```
public void setFocusConfiguration(FocusConfiguration focusConfiguration)
```
    Parameters:
    
    focusConfiguration - The configuration of the focus .
  - getFocusConfiguration
```
public FocusConfiguration getFocusConfiguration()
```
    Returns:
    
    The configuration of the focus.
  - 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 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.
  - 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
  - getImageSaveName
```
public java.lang.String getImageSaveName()
```
    Returns the name under which the images should be saved.
    
    Returns:
    
    Name of imaging job.
  - setImageSaveName
```
public void setImageSaveName(java.lang.String name)
```
    Sets the name under which the images should be saved.
    
    Parameters:
    
    name - Name of imaging job.
  - 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.
  - getJobs
```
public JobConfiguration[] getJobs()
```
    Description copied from interface: JobContainerConfiguration
    
    Returns the job list which might be edited by the caller.
    
    Specified by:
    
    getJobs in interface JobContainerConfiguration
    
    Returns:
    
    Job list.
  - setJobs
```
public void setJobs(JobConfiguration[] jobs)
```
    Description copied from interface: JobContainerConfiguration
    
    Sets the job list to the given list.
    
    Specified by:
    
    setJobs in interface JobContainerConfiguration
    
    Parameters:
    
    jobs - New job list.
  - addJob
```
public void addJob(JobConfiguration job)
```
    Description copied from interface: JobContainerConfiguration
    
    Adds a job to the job list.
    
    Specified by:
    
    addJob in interface JobContainerConfiguration
    
    Parameters:
    
    job - Job to be added.
  - clearJobs
```
public void clearJobs()
```
    Description copied from interface: JobContainerConfiguration
    
    Removes all jobs from the job list.
    
    Specified by:
    
    clearJobs in interface JobContainerConfiguration
  - removeJobAt
```
public void removeJobAt(int index)
```
    Description copied from interface: JobContainerConfiguration
    
    Removes the job at the given index.
    
    Specified by:
    
    removeJobAt in interface JobContainerConfiguration
    
    Parameters:
    
    index - Index of the job to be removed.
  - addJob
```
public void addJob(JobConfiguration job,
                   int index)
```
    Description copied from interface: JobContainerConfiguration
    
    Adds a job to the job list. The job is added such that it has the given index. Jobs having a higher or equal index before the operation are moved downwards.
    
    Specified by:
    
    addJob in interface JobContainerConfiguration
    
    Parameters:
    
    job - Job to be added.
    
    index - Index where the job should be added.
  - setFocusScoreAlgorithm
```
public void setFocusScoreAlgorithm(FocusScoreConfiguration focusScoreAlgorithm)
```
    Sets the focus algorithm with which it is detected if the focus of an image made at a give focus position is better than the other.
    
    Parameters:
    
    focusScoreAlgorithm -
  - getFocusScoreAlgorithm
```
public FocusScoreConfiguration getFocusScoreAlgorithm()
```
    Returns the focus algorithm with which it is detected if the focus of an image made at a give focus position is better than the other.
    
    Returns:
    
    focus score algorithm 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.
  - setResetFocusAfterSearch
```
public void setResetFocusAfterSearch(boolean resetFocusAfterSearch)
```
    Defines if the focus should be reset to its original value after the job (and all sub-jobs) finished.
    
    Parameters:
    
    resetFocusAfterSearch - Set to true to return to original value.
  - isResetFocusAfterSearch
```
public boolean isResetFocusAfterSearch()
```
    Defines if the focus should be reset to its original value after the job (and all sub-jobs) finished.
    
    Returns:
    
    true if returning to original value.
  - setFocusTableSaveName
```
public void setFocusTableSaveName(java.lang.String focusTableSaveName)
```
    Sets the name under which the focus-table should be saved. Set to null to not save the focus table.
    
    Parameters:
    
    focusTableSaveName - Name for the focus table (without extension), or null.
  - getFocusTableSaveName
```
public java.lang.String getFocusTableSaveName()
```
    Returns the name under which the focus-table is saved, or null, if it is not saved.
    
    Returns:
    
    Name for the focus table (without extension), or null.
  - setRememberFocus
```
public void setRememberFocus(boolean rememberFocus)
```
    Set to true if next focus search should be centered around the last iterations maximal focal plane. If false, it always starts from focus before the job.
    
    Parameters:
    
    rememberFocus - True if next focus search should be centered around last maximum.
  - isRememberFocus
```
public boolean isRememberFocus()
```
    Returns true if next focus search should be centered around the last iterations maximal focal plane. If false, it always starts from focus before the job.
    
    Returns:
    
    True if next focus search is centered around last maximum.
  - getProducedTableDefinition
```
public TableDefinition getProducedTableDefinition()
```
    Description copied from interface: TableProducerConfiguration
    
    Returns the definition of the table layout of the tables produced by this producer, e.g. the number and types of its columns. This function should return the same TableDefinition as is returned by a measurement component created by this configuration, see TableProducer.getProducedTableDefinition().
    
    Specified by:
    
    getProducedTableDefinition in interface TableProducerConfiguration
    
    Returns:
    
    Information about of the produced tables.
  - 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

Class AutoFocusJobConfiguration

Field Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

TYPE_IDENTIFIER

FOCUS_TABLE_DEFAULT_NAME

IMAGE_SAVE_NAME_DEFAULT

Constructor Detail

AutoFocusJobConfiguration

Method Detail

getTypeIdentifier

getFocusSearchAlgorithm

setFocusSearchAlgorithm

setFocusConfiguration

getFocusConfiguration

getDescription

setChannel

getChannel

getChannelGroup

setExposure

getExposure

getImageSaveName

setImageSaveName

clone

getImageSaveNames

getJobs

setJobs

addJob

clearJobs

removeJobAt

addJob

setFocusScoreAlgorithm

getFocusScoreAlgorithm

getNumberOfImages

setResetFocusAfterSearch

isResetFocusAfterSearch

setFocusTableSaveName

getFocusTableSaveName

setRememberFocus

isRememberFocus

getProducedTableDefinition

checkConfiguration