Methods Available to a Scan¶
User Interface Methods¶
The following interface methods may be implemented by a scan class to control the execution of a scan.
Listed in order of execution
Method
|
Has Default
Behavior?
|
Runs On
|
Scan Stage
|
Required?
|
Runs When
Scan is Resumed?
|
---|---|---|---|---|---|
yes |
host |
initialization |
no |
no |
|
yes |
host |
initialization |
no |
no |
|
yes |
host |
initialization |
no |
yes |
|
sometimes |
host |
initialization |
yes |
no |
|
yes |
host |
initialization |
no |
no |
|
yes |
host |
initialization |
no |
no |
|
yes |
host |
scan loop |
no |
yes |
|
yes |
portable |
scan loop |
no |
yes |
|
|
no |
portable |
scan loop |
yes |
yes |
|
yes |
host |
scan loop |
no |
yes |
|
yes |
host |
scan loop |
no |
yes |
|
yes |
host |
scan loop |
no |
yes |
|
yes |
host |
analysis |
no |
yes |
|
yes |
host |
analysis |
no |
yes |
User Helper Methods¶
Method
|
Has Default
Behavior?
|
Runs On
|
Scan Stage
|
Required?
|
Runs When
Scan is Resumed?
|
---|---|---|---|---|---|
Extension Interface Methods¶
The following interface methods may be implemented by a scan framework extension classes to control the execution of a scan. These methods should not be implemented by user scan classes and are listed here for reference.
Method
|
Has Default
Behavior?
|
Runs On
|
Scan Stage
|
Required?
|
Runs When
Scan is Resumed?
|
---|---|---|---|---|---|
_offset_points |
no |
host |
initialization |
yes |
no |
_load_points |
no |
host |
initialization |
yes |
no |
_write_datasets |
no |
host |
initialization |
yes |
yes |
_report |
no |
host |
initialization |
no |
no |
do_measure |
yes |
portable |
scan loop |
no |
yes |
calculate_dim0 |
no |
host |
scan loop |
yes |
yes |
_mutate_plot |
no |
host |
scan loop |
yes |
yes |