org.micromanager

Interface AutofocusManager

public interface AutofocusManager

This entity provides access to methods for controlling autofocus of the microscope. You can access it via Studio.getAutofocusManager().

Method Summary

Modifier and Type	Method and Description
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.
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.

Method Detail

setAutofocusMethod

void setAutofocusMethod(AutofocusPlugin plugin)

Set the current AutofocusPlugin to use for performing autofocus actions.

Parameters:

plugin - AutofocusPlugin to use for autofocus.

setAutofocusMethodByName

void setAutofocusMethodByName(java.lang.String name)

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).

Parameters:

name - Name of autofocus method to use.

getAutofocusMethod

AutofocusPlugin getAutofocusMethod()

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.

Returns:

AutofocusPlugin currently selected.

getAllAutofocusMethods

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

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).

Returns:

List of valid autofocus names.

refresh

void refresh()

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

initialize

void initialize()

Initializes all known autofocus plugins.