navigate.model.features.auto_tile_scan.CalculateFocusRange

class navigate.model.features.auto_tile_scan.CalculateFocusRange(model)

Bases: object

CalculateFocusRange class for determining the focus range using autofocus.

This class provides functionality to calculate the focus range of a microscope using autofocus measurements.

Notes:

• This class is used to calculate the focus range of a microscope by utilizing

autofocus measurements. It provides methods for different stages of the calculation process.

• The config_table attribute is a dictionary that defines the configuration for

each stage of the calculation process, including initialization, main execution, and finalization steps.

• The autofocus measurements are performed using an instance of the Autofocus

class, which is initialized with the same model object used for focus range calculation.

• The focus range calculation involves signal acquisition and data acquisition

stages, which are controlled using the provided methods.

• The CalculateFocusRange class can be used to automate the process of

determining the optimal focus range for microscopy experiments.

__init__(model)

Initialize the CalculateFocusRange class.

Parameters:

modelMicroscopeModel

The microscope model object used for focus range calculation.

Methods

__init__(model)	Initialize the CalculateFocusRange class.
end_func_data()	Finalize the data acquisition stage, if applicable.
end_func_signal()	Finalize the signal acquisition stage.
in_func_data([frame_ids])	Perform actions during the data acquisition stage, possibly for specific frame IDs.
in_func_signal()	Perform actions during the signal acquisition stage.
pre_func_data()	Prepare for the data acquisition stage, if applicable.
pre_func_signal()	Prepare for the signal acquisition stage.

Attributes

model	The microscope model object used for focus range
autofocus	The autofocus object used for focus range calculation.

end_func_data()

Finalize the data acquisition stage, if applicable.

This method finalizes the data acquisition stage, and it may involve additional actions or checks.

Returns:

bool

A boolean value indicating whether additional steps are required.

end_func_signal()

Finalize the signal acquisition stage.

This method finalizes the signal acquisition stage and checks if additional steps are needed based on the results of autofocus measurements.

Returns:

bool

A boolean value indicating whether additional steps are required.

in_func_data(frame_ids=[])

Perform actions during the data acquisition stage, possibly for specific frame IDs.

This method performs actions during the data acquisition stage, which may include data acquisition for specific frame IDs if provided.

Parameters:

frame_idslist, optional

A list of frame IDs for which data acquisition should be performed. Default is an empty list.

in_func_signal()

Perform actions during the signal acquisition stage.

This method is responsible for carrying out actions during the signal acquisition stage, such as performing autofocus measurements and calculating focus-related parameters.

pre_func_data()

Prepare for the data acquisition stage, if applicable.

This method prepares for the data acquisition stage, which may involve setting up configurations or performing actions before data acquisition begins.

pre_func_signal()

Prepare for the signal acquisition stage.

This method sets up initial values and configurations before the signal acquisition stage.

autofocus

The autofocus object used for focus range calculation.

Type:

Autofocus

model

The microscope model object used for focus range

Type:

MicroscopeModel