org.youscope.plugin.autofocus

Interface AutoFocusJob

All Superinterfaces:

Component, EditableJobContainer, ImageProducer, Job, JobContainer, java.rmi.Remote, TableProducer

public interface AutoFocusJob
extends Job, EditableJobContainer, ImageProducer, TableProducer

Interface of a measurement job which automatically adjusts the focus.

Author:

Moritz Lang

Method Summary

Modifier and Type	Method and Description
java.lang.String	getChannel() Gets the channel.
java.lang.String	getChannelGroup() Gets the channel group.
double	getExposure() Gets the exposure.
int	getFocusAdjustmentTime() Returns the focus adjustment time (the time the microscope is paused after the new focus position was set) in ms.
java.lang.String	getFocusDevice() Returns the focus device name for which the position should be changed.
FocusScoreResource	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.
FocusSearchResource	getFocusSearchAlgorithm() Returns the algorithm with which it is determined at which focus positions images are made to determine the best focal plane.
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	setChannel(java.lang.String deviceGroup, java.lang.String channel) Sets the channel.
void	setExposure(double exposure) Sets the exposure.
void	setFocusAdjustmentTime(int adjustmentTime) Sets the focus adjustment time (the time the microscope is paused after the new focus position was set) in ms.
void	setFocusDevice(java.lang.String focusDevice) Sets the focus device name for which the position should be changed.
void	setFocusScoreAlgorithm(FocusScoreResource focusScoreAlgorithm) Sets the algorithm with which the score of an image is calculated (i.e.
void	setFocusSearchAlgorithm(FocusSearchResource focusSearchAlgorithm) Sets the algorithm with which it is determined at which focus positions images are made to determine the best focal plane.
void	setImageDescription(java.lang.String description) Sets a short string describing the images which are made by this job.
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 interface org.youscope.common.job.Job

addJobListener, executeJob, initializeJob, removeJobListener, uninitializeJob

Methods inherited from interface org.youscope.common.Component

addMessageListener, getName, getPositionInformation, getUUID, removeMessageListener, setName

Methods inherited from interface org.youscope.common.job.EditableJobContainer

addJob, clearJobs, insertJob, removeJob

Methods inherited from interface org.youscope.common.job.JobContainer

getJob, getJobs, getNumJobs

Methods inherited from interface org.youscope.common.image.ImageProducer

addImageListener, getImageDescription, getNumberOfImages, removeImageListener

Methods inherited from interface org.youscope.common.table.TableProducer

addTableListener, getProducedTableDefinition, removeTableListener

Method Detail

setChannel

void setChannel(java.lang.String deviceGroup,
                java.lang.String channel)
         throws java.rmi.RemoteException,
                MeasurementRunningException

Sets the channel.

Parameters:

deviceGroup - The device group where the channel is defined.

channel - The channel.

Throws:

java.rmi.RemoteException

MeasurementRunningException

getChannel

java.lang.String getChannel()
                     throws java.rmi.RemoteException

Gets the channel.

Returns:

The channel.

Throws:

java.rmi.RemoteException

getChannelGroup

java.lang.String getChannelGroup()
                          throws java.rmi.RemoteException

Gets the channel group.

Returns:

The channel group.

Throws:

java.rmi.RemoteException

setExposure

void setExposure(double exposure)
          throws java.rmi.RemoteException,
                 MeasurementRunningException

Sets the exposure. If more than one camera is initialized, it sets the exposure of all cameras. Set to -1 if exposure should not be set.

Parameters:

exposure - The exposure.

Throws:

java.rmi.RemoteException

MeasurementRunningException

getExposure

double getExposure()
            throws java.rmi.RemoteException

Gets the exposure. If more than one camera is initialized, returns the exposure of the first camera.

Returns:

The exposure.

Throws:

java.rmi.RemoteException

setResetFocusAfterSearch

void setResetFocusAfterSearch(boolean resetFocusAfterSearch)
                       throws java.rmi.RemoteException,
                              MeasurementRunningException

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.

Throws:

java.rmi.RemoteException

MeasurementRunningException

setRememberFocus

void setRememberFocus(boolean rememberFocus)
               throws java.rmi.RemoteException,
                      MeasurementRunningException

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.

Throws:

java.rmi.RemoteException

MeasurementRunningException

isRememberFocus

boolean isRememberFocus()
                 throws java.rmi.RemoteException

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.

Throws:

java.rmi.RemoteException

isResetFocusAfterSearch

boolean isResetFocusAfterSearch()
                         throws java.rmi.RemoteException

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.

Throws:

java.rmi.RemoteException

getFocusAdjustmentTime

int getFocusAdjustmentTime()
                    throws java.rmi.RemoteException

Returns the focus adjustment time (the time the microscope is paused after the new focus position was set) in ms.

Returns:

Focus adjustment time.

Throws:

java.rmi.RemoteException

setFocusAdjustmentTime

void setFocusAdjustmentTime(int adjustmentTime)
                     throws java.rmi.RemoteException,
                            MeasurementRunningException

Sets the focus adjustment time (the time the microscope is paused after the new focus position was set) in ms.

Parameters:

adjustmentTime - Focus adjustment time.

Throws:

java.rmi.RemoteException

MeasurementRunningException

getFocusDevice

java.lang.String getFocusDevice()
                         throws java.rmi.RemoteException

Returns the focus device name for which the position should be changed.

Returns:

Focus device name, or null, if the currently active focus device should be changed.

Throws:

java.rmi.RemoteException

setFocusDevice

void setFocusDevice(java.lang.String focusDevice)
             throws java.rmi.RemoteException,
                    MeasurementRunningException

Sets the focus device name for which the position should be changed. Initialized to be null.

Parameters:

focusDevice - Focus device name, or null, if the currently active focus device should be changed.

Throws:

java.rmi.RemoteException

MeasurementRunningException

setFocusScoreAlgorithm

void setFocusScoreAlgorithm(FocusScoreResource focusScoreAlgorithm)
                     throws java.rmi.RemoteException,
                            MeasurementRunningException

Sets the algorithm with which the score of an image is calculated (i.e. with which it is determined if an image made at a give focus position is better than an image made in another).

Parameters:

focusScoreAlgorithm -

Throws:

java.rmi.RemoteException

MeasurementRunningException

setFocusSearchAlgorithm

void setFocusSearchAlgorithm(FocusSearchResource focusSearchAlgorithm)
                      throws java.rmi.RemoteException,
                             MeasurementRunningException

Sets the algorithm with which it is determined at which focus positions images are made to determine the best focal plane. This decision in general depends on the scores of the images already made in different focal positions.

Parameters:

focusSearchAlgorithm -

Throws:

java.rmi.RemoteException

MeasurementRunningException

getFocusScoreAlgorithm

FocusScoreResource getFocusScoreAlgorithm()
                                   throws java.rmi.RemoteException

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.

Throws:

java.rmi.RemoteException

getFocusSearchAlgorithm

FocusSearchResource getFocusSearchAlgorithm()
                                     throws java.rmi.RemoteException

Returns the algorithm with which it is determined at which focus positions images are made to determine the best focal plane. This decision in general depends on the scores of the images already made in different focal positions.

Returns:

focus search algorithm configuration, or null.

Throws:

java.rmi.RemoteException

setImageDescription

void setImageDescription(java.lang.String description)
                  throws java.rmi.RemoteException,
                         MeasurementRunningException

Sets a short string describing the images which are made by this job.

Parameters:

description - The description which should be returned for the images produced by this job, or null, to switch to the default description.

Throws:

java.rmi.RemoteException

MeasurementRunningException