This is the Logic class for optimizing scanner position on bright features. More...
Inheritance diagram for optimizer_logic.OptimizerLogic:
Collaboration diagram for optimizer_logic.OptimizerLogic:
Public Member Functions | |
| def | __init__ (self, config, kwargs) |
| def | on_activate (self) |
| Initialisation performed during activation of the module. More... | |
| def | on_deactivate (self) |
| Reverse steps of activation. More... | |
| def | check_optimization_sequence (self) |
| Check the sequence of scan events for the optimization. | |
| def | get_scanner_count_channels (self) |
| Get lis of counting channels from scanning device. More... | |
| def | set_clock_frequency (self, clock_frequency) |
| Sets the frequency of the clock. More... | |
| def | set_refocus_XY_size (self, size) |
| Set the number of pixels in the refocus image for X and Y directions. More... | |
| def | set_refocus_Z_size (self, size) |
| Set the number of values for Z refocus. More... | |
| def | start_refocus (self, initial_pos=None, caller_tag='unknown', tag='logic') |
| Starts the optimization scan around initial_pos. More... | |
| def | stop_refocus (self) |
| Stops refocus. More... | |
| def | do_z_optimization (self) |
| Do the z axis optimization. More... | |
| def | finish_refocus (self) |
| Finishes up and releases hardware after the optimizer scans. More... | |
| def | start_scanner (self) |
| Setting up the scanner device. More... | |
| def | kill_scanner (self) |
| Closing the scanner device. More... | |
| def | set_position (self, tag, x=None, y=None, z=None, a=None) |
| Set focus position. More... | |
Public Attributes | |
| threadlock | |
| stopRequested | |
| is_crosshair | |
| x_range | |
| y_range | |
| z_range | |
| optim_pos_x | |
| optim_pos_y | |
| optim_pos_z | |
| optim_sigma_x | |
| optim_sigma_y | |
| optim_sigma_z | |
| z_params | |
| Fit Params and Settings #. | |
| use_custom_params | |
| xy_refocus_image | |
| z_refocus_line | |
| z_fit_data | |
Static Public Attributes | |
| confocalscanner1 = Connector(interface='ConfocalScannerInterface') | |
| fitlogic = Connector(interface='FitLogic') | |
| return_slowness = StatusVar(default=20) | |
| refocus_XY_size = StatusVar('xy_size', 0.6e-6) | |
| optimizer_XY_res = StatusVar('xy_resolution', 10) | |
| refocus_Z_size = StatusVar('z_size', 2e-6) | |
| optimizer_Z_res = StatusVar('z_resolution', 30) | |
| hw_settle_time = StatusVar('settle_time', 0.1) | |
| optimization_sequence = StatusVar(default=['XY', 'Z']) | |
| do_surface_subtraction = StatusVar('surface_subtraction', False) | |
| surface_subtr_scan_offset = StatusVar('surface_subtraction_offset', 1e-6) | |
| opt_channel = StatusVar('optimization_channel', 0) | |
| sigImageUpdated = QtCore.Signal() | |
| sigRefocusStarted = QtCore.Signal(str) | |
| sigRefocusXySizeChanged = QtCore.Signal() | |
| sigRefocusZSizeChanged = QtCore.Signal() | |
| sigRefocusFinished = QtCore.Signal(str, list) | |
| sigClockFrequencyChanged = QtCore.Signal(int) | |
| sigPositionChanged = QtCore.Signal(float, float, float) | |
Detailed Description
This is the Logic class for optimizing scanner position on bright features.
Member Function Documentation
◆ do_z_optimization()
| def optimizer_logic.OptimizerLogic.do_z_optimization | ( | self | ) |
Do the z axis optimization.
◆ finish_refocus()
| def optimizer_logic.OptimizerLogic.finish_refocus | ( | self | ) |
Finishes up and releases hardware after the optimizer scans.
◆ get_scanner_count_channels()
| def optimizer_logic.OptimizerLogic.get_scanner_count_channels | ( | self | ) |
Get lis of counting channels from scanning device.
- Returns
- list(str): names of counter channels
◆ kill_scanner()
| def optimizer_logic.OptimizerLogic.kill_scanner | ( | self | ) |
Closing the scanner device.
- Returns
- int: error code (0:OK, -1:error)
◆ on_activate()
| def optimizer_logic.OptimizerLogic.on_activate | ( | self | ) |
Initialisation performed during activation of the module.
- Returns
- int: error code (0:OK, -1:error)
◆ on_deactivate()
| def optimizer_logic.OptimizerLogic.on_deactivate | ( | self | ) |
Reverse steps of activation.
- Returns
- int: error code (0:OK, -1:error)
◆ set_clock_frequency()
| def optimizer_logic.OptimizerLogic.set_clock_frequency | ( | self, | |
| clock_frequency | |||
| ) |
Sets the frequency of the clock.
- Parameters
-
int clock_frequency: desired frequency of the clock
- Returns
- int: error code (0:OK, -1:error)
◆ set_position()
| def optimizer_logic.OptimizerLogic.set_position | ( | self, | |
| tag, | |||
x = None, |
|||
y = None, |
|||
z = None, |
|||
a = None |
|||
| ) |
Set focus position.
- Parameters
-
str tag: sting indicating who caused position change float x: x axis position in m float y: y axis position in m float z: z axis position in m float a: a axis position in m
◆ set_refocus_XY_size()
| def optimizer_logic.OptimizerLogic.set_refocus_XY_size | ( | self, | |
| size | |||
| ) |
Set the number of pixels in the refocus image for X and Y directions.
- Parameters
-
int size: XY image size in pixels
◆ set_refocus_Z_size()
| def optimizer_logic.OptimizerLogic.set_refocus_Z_size | ( | self, | |
| size | |||
| ) |
Set the number of values for Z refocus.
- Parameters
-
int size: number of values for Z refocus
◆ start_refocus()
| def optimizer_logic.OptimizerLogic.start_refocus | ( | self, | |
initial_pos = None, |
|||
caller_tag = 'unknown', |
|||
tag = 'logic' |
|||
| ) |
Starts the optimization scan around initial_pos.
- Parameters
-
list initial_pos: with the structure [float, float, float] str caller_tag: str tag:
◆ start_scanner()
| def optimizer_logic.OptimizerLogic.start_scanner | ( | self | ) |
Setting up the scanner device.
- Returns
- int: error code (0:OK, -1:error)
◆ stop_refocus()
| def optimizer_logic.OptimizerLogic.stop_refocus | ( | self | ) |
Stops refocus.
The documentation for this class was generated from the following file:
- logic/optimizer_logic.py
