org.youscope.common.microscope

Interface AutoFocusDevice

All Superinterfaces:

Device, java.rmi.Remote

public interface AutoFocusDevice
extends Device

Author:

Moritz Lang

Method Summary

Modifier and Type	Method and Description
double	getCurrentScore() Returns the current focus score
double	getLastScore() Returns the last focus score.
double	getOffset() Returns the current offset.
boolean	isEnabled() Returns true if the autofocus is enabled.
boolean	isLocked() Returns true if auto-focus is locked.
void	runFullFocus() Runs a full focus search.
void	runIncrementalFocus() Runs an incremental focus search.
void	setEnabled(boolean enable) Enables or disables the auto-focus device.
void	setOffset(double offset) Sets the current offset.

Methods inherited from interface org.youscope.common.microscope.Device

getDeviceID, getDriverID, getEditableProperties, getExplicitDelay, getLibraryID, getProperties, getProperty, getType, setExplicitDelay, waitForDevice

Method Detail

getLastScore

double getLastScore()
             throws MicroscopeException,
                    java.rmi.RemoteException

Returns the last focus score.

Returns:

Last focus score.

Throws:

MicroscopeException

java.rmi.RemoteException

getCurrentScore

double getCurrentScore()
                throws MicroscopeException,
                       java.rmi.RemoteException

Returns the current focus score

Returns:

Current focus score

Throws:

MicroscopeException

java.rmi.RemoteException

setEnabled

void setEnabled(boolean enable)
         throws MicroscopeException,
                MicroscopeLockedException,
                java.rmi.RemoteException

Enables or disables the auto-focus device.

Parameters:

enable - True, if focus should be engabled.

Throws:

MicroscopeException

MicroscopeLockedException

java.rmi.RemoteException

isEnabled

boolean isEnabled()
           throws MicroscopeException,
                  java.rmi.RemoteException

Returns true if the autofocus is enabled.

Returns:

True if enabled.

Throws:

MicroscopeException

java.rmi.RemoteException

isLocked

boolean isLocked()
          throws MicroscopeException,
                 java.rmi.RemoteException

Returns true if auto-focus is locked.

Returns:

True if locked.

Throws:

MicroscopeException

java.rmi.RemoteException

runFullFocus

void runFullFocus()
           throws MicroscopeException,
                  MicroscopeLockedException,
                  java.rmi.RemoteException

Runs a full focus search.

Throws:

MicroscopeException

MicroscopeLockedException

java.rmi.RemoteException

runIncrementalFocus

void runIncrementalFocus()
                  throws MicroscopeException,
                         MicroscopeLockedException,
                         java.rmi.RemoteException

Runs an incremental focus search.

Throws:

MicroscopeException

MicroscopeLockedException

java.rmi.RemoteException

setOffset

void setOffset(double offset)
        throws MicroscopeException,
               MicroscopeLockedException,
               java.rmi.RemoteException

Sets the current offset.

Parameters:

offset - Offset to set.

Throws:

MicroscopeException

MicroscopeLockedException

java.rmi.RemoteException

getOffset

double getOffset()
          throws MicroscopeException,
                 java.rmi.RemoteException

Returns the current offset.

Returns:

Current offset.

Throws:

MicroscopeException

java.rmi.RemoteException