Appendix

Positional Arguments

• nodeName [REQUIRED]
  • The name of the node to scan. For some devices (such as power supplies), the current value for the quantity being scanned is read back on a different node.
• quickRange [OPTIONAL]
  • A positional version of the "range" keyword argument, for fast typing.
• quickStepSize [OPTIONAL]
  • A positional version of the "stepSize" keyword argument, for fast typing.
• quickCountAgainst [OPTIONAL]
  • A positional way to specify what you want to count against.Positive values count against monitor, negative values count against time.

Keyword Arguments

• --center
•  -c
  • The center of the peak scan, this is an alternate way to specify initial and/or final, via the relation "center = (initial + final)/2". If a range is explicitly specified (but not the center, initial, or final) then center is defaulted to the current position.
• --channel
  • If the node specified with the "--data" option is of list type (such as an area detector), this option must be used to specify the index of the list element you are interested in. Defaults to zero.
• --data
  • The node id for the data to fit against. It may be a list node (such as an array of count channels) or a single-valued node (like the monitor node). If the node is a list node, you must also use the "--channel" option to specify the index of the list element you are interested in. The default is the last value specified by a run of either the findPeak or rapidScan command.
• --detector
•  -d
  • Logical counter name when counting against ROI.
• --filePrefix
  • Prefix name for the find peak data file.
• --final
•  -f
  • Specifies the final position of the peak scan. If the stepSize is explicitly specified, the final position may be rounded to an achievable position consistent with the stepSize and other parameters.
• --fit
  • The function to fit against. The default is GaussianPlusBackground.
• --initial
•  -i
  • Specifies the initial position of the peak scan. If the stepSize is explicitly specified, then the initial position may be rounded to an achievable position consistent with the stepSize and other parameters. 
• --monitor
•  -m
  • How many monitor counts to count for at each point.
• --numPoints
•  -n
  • The number of points in the scan. Defaults to 11
• --prefactor
•  -p
  • Not available yet!
• --range
•  -r
  • The total distance to scan the device, defined by the relation "range = end - start". Negative ranges are allowed, and correspond to an end position less than the start position.
• --reZeroPosition
•  -x
  • Motors ONLY! Same as reZero except that the motor's zero is changed such that "fit position" is redefined to the specified value.
• --roi
  • How many ROI counts to count for at each point.
• --stepSize
•  -s
  • Specifies the magnitude of the difference in position of successive points in the scan. The stepSize is always positive, even if the scan is moving in the negative direction.
• --time
•  -t
  • The number of seconds to count for at each point. Defaults to 1.0.if neither monitor or ROI is specified.
• --tolerance
•  --tol
  • Motors ONLY! When re-zeroing, do not change the zero if the "fit position" is within tolerance of the specified re-zero position.

Flags

• --ignoreScanDomain
  • If the move to fit option is used, this flag will remove the safety which prevents the move to fit from going outside the scan domain.
• --moveToFit
•  -v
  • Causes the device to move to the fit position when the scan finishes, rather than back to its original position.
• --reZero
•  -z
  • Motors ONLY! When the scan finishes it will produce a "fit position". For example, if the fitFunction is Gaussian, the "fit position" will be the center. If this flag is present, the zero on the scanned motor will be changed such that the "fit position" is redefined to the center of the scanned region. If the difference between "fit position" and the center of the scanned region is less than tolerance, then no re-zeroing will occur.
• --useBadFit
  • If the rezero or move to fit options are used, this flag will cause the check for bad fits to be skipped (a bad fit will otherwise prevent a rezero or move to fit from being performed).