FindPeak

Brief Description

Scans a device over a given range to find device position at which maximum intensity is reached. A number of options can be specified to facilitate curve fitting to data and device positioning at the center of the fit.

Full Command Path

Usage: FindPeak [Device] [Range] [Step size] [Counter] [Preset] [Monitor] -lattice [CORRECTION] -accept -t [TOLERANCE] -f [FLIPPER] -off [FLIPPERVALUE] -func [FUNTYPE] -bragg [BRAGGMOTOR]

Usage: FindPeak [Device] [StartRange] [StopRange] [Step size] [Counter] [Preset] [Monitor] -start -lattice [CORRECTION] -accept -t [TOLERANCE] -f [FLIPPER] -off [FLIPPERVALUE] -func [FUNTYPE] -bragg [BRAGGMOTOR]

Positional Arguments

[Device] is a device selected for the scan.

[Range] is the device range centered at current device position. Option -start allows to specify a range using two values [StartRange] and [StopRange] corresponding to the beginning and end of the range, respectively.

[Step size] is the length between two adjacent device positions in the scan. The number of points in the scan will be set to [Range]/[Step size].

[Counter] allows to select Time or Monitor as a device for which [Preset] counts are measured.

[Preset] is a duration in seconds (if Time is a counter) or number of counts (if Monitor is a counter) till which count is performed at every device position.

[Monitor] allows to select Monitor or Detector as a device whose values are plotted.

Keyword Arguments

-start option allows the range to be supplied using two numeric values [StartRange] and [StopRange], for the start and the end points of the interval. (Optional)

-lattice [CORRECTION] DEPRECATED, use the CorrectLattice Command. Calculates d-spacing of the sample as a product of fit result and [CORRECTION]. If [CORRECTION] is not specified, 1 is used by default. Use command AcceptLattice to redefine sample lattice parameters using calculated value. (Optional)

-accept instructs the server to automatically drive the selected device to the position where maximum intensity is reached, after the scan is completed. (Optional)

-t [TOLERANCE] specifies tolerance of the target device position. This option can be given only with -accept option. (Optional)

-f [FLIPPER] specifies a valid flipper (Optional)

-off [FLIPPERVALUE] specifies flipper off value. (Optional)

-func [FUNTYPE] specifies the function type that will be fitted to the scan data. Possible functions: Gauss, GaussLinear, GaussQuadratic, POLY, POLY0, POLY1, POLY2, POLY3 (0-, 1-, 2-, 3-degree polynomial). By default, Gaussian curve is fitted. (Optional)

-bragg [BRAGGMOTOR] specifies a bragg motor that moves together with the device [Device] with a step size half of that of [Step size]. (Optional)