ScannerSequence.evaluate

ScannerSequence.evaluate#

ScannerSequence.evaluate()#

Evaluate a requested protocol, or refuse it by raising.

The hook a subclass overrides to check a protocol and to state what the console shows with it. Returning None is returning Evaluation(protocol). An exception makes the protocol invalid, as validate() describes.

The default accepts the protocol unchanged with no scan time estimate, and does not call the sequence function.

Parameters:
  • system – The scanner limits the sequence is designed under.

  • protocol – The requested protocol, in the units of the sequence function’s arguments.

Returns:

The protocol to show back, the scan time and a note.

Return type:

Evaluation or None