org.micromanager.internal.utils

Class DefaultAutofocusManager

java.lang.Object

org.micromanager.internal.utils.DefaultAutofocusManager

All Implemented Interfaces:

AutofocusManager

public final class DefaultAutofocusManager
extends java.lang.Object
implements AutofocusManager

Manages different instances of autofocus devices, both Java plugin and MMCore based. The class is designed to be instantiated in the top level gui and used to obtain the list of available focusing devices, as well as for selecting a default one.

Constructor Summary

Constructors

Constructor and Description
DefaultAutofocusManager(Studio studio)

Method Summary

Modifier and Type	Method and Description
void	closeOptionsDialog()
java.lang.String[]	getAfDevices() Returns a list of available af device names NOTE: we operate based on the "device name" rather than the plugin class name, because the latter is the same for all autofocus device adapters (it's always CoreAutofocus).
java.util.List<java.lang.String>	getAllAutofocusMethods() Return a list of the current valid autofocus names, suitable for use in setAutofocusMethodByName().
AutofocusPlugin	getAutofocusMethod() Return the current AutofocusPlugin being used to run autofocus.
boolean	hasDevice(java.lang.String dev) NOTE: we operate based on the "device name" rather than the plugin class name, because the latter is the same for all autofocus device adapters (it's always CoreAutofocus).
void	initialize() Initializes all known autofocus plugins.
void	refresh() Update the list of available autofocus devices by scanning the system for autofocus device adapters and AutofocusPlugins.
void	setAutofocusMethod(AutofocusPlugin plugin) Set the current AutofocusPlugin to use for performing autofocus actions.
void	setAutofocusMethodByName(java.lang.String name) Set the current AutofocusPlugin by name.
void	showOptionsDialog()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultAutofocusManager

public DefaultAutofocusManager(Studio studio)

Method Detail

setAutofocusMethod

public void setAutofocusMethod(AutofocusPlugin plugin)

Description copied from interface: AutofocusManager

Set the current AutofocusPlugin to use for performing autofocus actions.

Specified by:

setAutofocusMethod in interface AutofocusManager

Parameters:

plugin - AutofocusPlugin to use for autofocus.

setAutofocusMethodByName

public void setAutofocusMethodByName(java.lang.String name)

Description copied from interface: AutofocusManager

Set the current AutofocusPlugin by name. This will throw an IllegalArgumentException if there is no AutofocusPlugin with the specified name (as per the value returned by its getName() method).

Specified by:

setAutofocusMethodByName in interface AutofocusManager

Parameters:

name - Name of autofocus method to use.

getAutofocusMethod

public AutofocusPlugin getAutofocusMethod()

Description copied from interface: AutofocusManager

Return the current AutofocusPlugin being used to run autofocus. It is recommended that callers invoke this method whenever the current autofocus plugin is required, rather than storing its results.

Specified by:

getAutofocusMethod in interface AutofocusManager

Returns:

AutofocusPlugin currently selected.

getAllAutofocusMethods

public java.util.List<java.lang.String> getAllAutofocusMethods()

Description copied from interface: AutofocusManager

Return a list of the current valid autofocus names, suitable for use in setAutofocusMethodByName(). This includes both software AutofocusPlugins (which are accessible via the PluginManager) and hardware autofocus devices (which are not).

Specified by:

getAllAutofocusMethods in interface AutofocusManager

Returns:

List of valid autofocus names.

refresh

public void refresh()

Description copied from interface: AutofocusManager

Update the list of available autofocus devices by scanning the system for autofocus device adapters and AutofocusPlugins.

Specified by:

refresh in interface AutofocusManager

showOptionsDialog

public void showOptionsDialog()

closeOptionsDialog

public void closeOptionsDialog()

getAfDevices

public java.lang.String[] getAfDevices()

Returns a list of available af device names NOTE: we operate based on the "device name" rather than the plugin class name, because the latter is the same for all autofocus device adapters (it's always CoreAutofocus).

Returns:

- array of af names

hasDevice

public boolean hasDevice(java.lang.String dev)

NOTE: we operate based on the "device name" rather than the plugin class name, because the latter is the same for all autofocus device adapters (it's always CoreAutofocus).

initialize

public void initialize()

Description copied from interface: AutofocusManager

Initializes all known autofocus plugins.

Specified by:

initialize in interface AutofocusManager