Scan Howlong Command

Brief Description

The command will compute how long a scan will run. It uses a 3rd degree polynomial parameterization of the monitor rate as a function of an instrument-specific device (A2 for triple axes) to estimate the rate at each point of the scan. The monitor rate predicted by the parameterization is scaled according to the stored monitor rate and the value of A2 it was measured at.

The Rate command should be run before Scan Howlong. If it has not been run when Scan Howlong is run, it will be run automatically before a result is given, unless a scan is in progress, in which case Scan Howlong will fail.

Full Command Path

Scan HOWLONG [name] [-s] [-o] [overhead]

Positional Arguments

[name] is the name of a scan to run the command on.

Keyword Arguments

[-s] will cause the result to be in seconds.

Keyword Arguments

[-o] [overhead] will set a default overhead, in seconds, to add to the time for each point. If there is a device with a higher movement overhead than the specified overhead, then that device's overhead will be added instead.

Notes and Warnings

  • See also: Device SetOverhead and Device GetOverhead commands.