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?
create_logger	yes	host	initialization	no	no
build	yes	host	initialization	no	no
run	yes	host	initialization	no	yes
get_scan_points	sometimes	host	initialization	yes	no
get_warmup_points	yes	host	initialization	no	no
report	yes	host	initialization	no	no
_yield	yes	host	scan loop	no	yes
warmup	yes	portable	scan loop	no	yes
measure	no	portable	scan loop	yes	yes
mutate_datasets	yes	host	scan loop	no	yes
_calculate_all	yes	host	scan loop	no	yes
_calculate_all	yes	host	scan loop	no	yes
analyze	yes	host	analysis	no	yes
_analyze	yes	host	analysis	no	yes

User Helper Methods

Method	Has Default Behavior?	Runs On	Scan Stage	Required?	Runs When Scan is Resumed?
register_model
setattr_argument
scan_arguments
register_model
_run_scan_host
_run_scan_core
simulate_measure

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