org.youscope.addon.microscopeaccess

Interface AutoFocusDeviceInternal

All Superinterfaces:

DeviceInternal

public interface AutoFocusDeviceInternal
extends DeviceInternal

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(int accessID) Runs a full focus search.
void	runIncrementalFocus(int accessID) Runs an incremental focus search.
void	setEnabled(boolean enable, int accessID) Enables or disables the auto-focus device.
void	setOffset(double offset, int accessID) Sets the current offset.

Methods inherited from interface org.youscope.addon.microscopeaccess.DeviceInternal

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

Method Detail

getLastScore

double getLastScore()
             throws MicroscopeException

Returns the last focus score.

Returns:

Last focus score.

Throws:

MicroscopeException

getCurrentScore

double getCurrentScore()
                throws MicroscopeException

Returns the current focus score

Returns:

Current focus score

Throws:

MicroscopeException

setEnabled

void setEnabled(boolean enable,
                int accessID)
         throws MicroscopeException,
                MicroscopeLockedException

Enables or disables the auto-focus device.

Parameters:

enable - True, if focus should be engabled.

accessID - The access ID of the current microscope object. If the microscope is locked with a different accessID, a MicroscopeLockedException is thrown.

Throws:

MicroscopeException

MicroscopeLockedException

isEnabled

boolean isEnabled()
           throws MicroscopeException

Returns true if the autofocus is enabled.

Returns:

True if enabled.

Throws:

MicroscopeException

isLocked

boolean isLocked()
          throws MicroscopeException

Returns true if auto-focus is locked.

Returns:

True if locked.

Throws:

MicroscopeException

runFullFocus

void runFullFocus(int accessID)
           throws MicroscopeException,
                  MicroscopeLockedException

Runs a full focus search.

Parameters:

accessID - The access ID of the current microscope object. If the microscope is locked with a different accessID, a MicroscopeLockedException is thrown.

Throws:

MicroscopeException

MicroscopeLockedException

runIncrementalFocus

void runIncrementalFocus(int accessID)
                  throws MicroscopeException,
                         MicroscopeLockedException

Runs an incremental focus search.

Parameters:

accessID - The access ID of the current microscope object. If the microscope is locked with a different accessID, a MicroscopeLockedException is thrown.

Throws:

MicroscopeException

MicroscopeLockedException

setOffset

void setOffset(double offset,
               int accessID)
        throws MicroscopeException,
               MicroscopeLockedException

Sets the current offset.

Parameters:

offset - Offset to set.

accessID - The access ID of the current microscope object. If the microscope is locked with a different accessID, a MicroscopeLockedException is thrown.

Throws:

MicroscopeException

MicroscopeLockedException

getOffset

double getOffset()
          throws MicroscopeException

Returns the current offset.

Returns:

Current offset.

Throws:

MicroscopeException