SaTuneProcess

Process which performs an SA tuning step.
This tuning process sweeps the SaFb value records SaOut at each step.
This sweep is repeated for a series of SaBias values.
Once the sweep is completed the process will determine the SaBias value which results in the largest peak to peak amplitude in the SaFb vs SaOut curve.
For the selected SaBias curve the process will then select the point on the curve with the highest slope.
The resulting curves are available as a dictionary of numpy arrays.

Summary

Variable List

Running
Progress
Message
SaFbLowOffset
SaFbHighOffset
SaFbNumSteps
SaBiasLowOffset
SaBiasHighOffset
SaBiasNumSteps
SetAfterFinish
SaTuneOutput

Command List

Start
Stop

Details

Variables

GroupRoot.Group.SaTuneProcess.Running

Status values indicating if operation is running.

Field	Value
name	Running
path	GroupRoot.Group.SaTuneProcess.Running
enum	{False: ‘False’, True: ‘True’}
typeStr	bool
disp	enum
precision	0
mode	RO

GroupRoot.Group.SaTuneProcess.Progress

Percent complete: 0 - 100 %.

Field	Value
name	Progress
path	GroupRoot.Group.SaTuneProcess.Progress
typeStr	float
disp	{:1.2f}
precision	2
mode	RO
units	Pct
minimum	0.0
maximum	1.0

GroupRoot.Group.SaTuneProcess.Message

Process status message.

Prefixed with ‘Error:’ if an error occurred.

Field	Value
name	Message
path	GroupRoot.Group.SaTuneProcess.Message
typeStr	str
disp	{}
precision	0
mode	RO

GroupRoot.Group.SaTuneProcess.SaFbLowOffset

Starting point offset for SA FB Tuning.
This value is an offset from the currently configured SaFb value.
(well not in the current code, but it should be).

Field	Value
name	SaFbLowOffset
path	GroupRoot.Group.SaTuneProcess.SaFbLowOffset
typeStr	float
disp	{}
precision	8
mode	RW
units	uA

GroupRoot.Group.SaTuneProcess.SaFbHighOffset

Ending point offset for SA FB Tuning.
This value is an offset from the currently configured SaFb value.
(well not in the current code, but it should be).

Field	Value
name	SaFbHighOffset
path	GroupRoot.Group.SaTuneProcess.SaFbHighOffset
typeStr	float
disp	{}
precision	8
mode	RW
units	uA

GroupRoot.Group.SaTuneProcess.SaFbNumSteps

Number of steps between the SaFbLowOffset and SaFbHighOffset, inclusively.

Field	Value
name	SaFbNumSteps
path	GroupRoot.Group.SaTuneProcess.SaFbNumSteps
typeStr	int
disp	{}
precision	0
mode	RW
minimum	1
maximum	10000

GroupRoot.Group.SaTuneProcess.SaBiasLowOffset

Starting point offset for SA Bias Tuning.
This value is an offset from the currently configured SaBias value.
(well not in the current code, but it should be).

Field	Value
name	SaBiasLowOffset
path	GroupRoot.Group.SaTuneProcess.SaBiasLowOffset
typeStr	float
disp	{}
precision	8
mode	RW
units	uA

GroupRoot.Group.SaTuneProcess.SaBiasHighOffset

Ending point offset for SA Bias Tuning.
This value is an offset from the currently configured SaBias value.
(well not in the current code, but it should be).

Field	Value
name	SaBiasHighOffset
path	GroupRoot.Group.SaTuneProcess.SaBiasHighOffset
typeStr	float
disp	{}
precision	8
mode	RW
units	uA

GroupRoot.Group.SaTuneProcess.SaBiasNumSteps

Number of steps between the SaBiasLowOffset and SaBiasHighOffset, inclusively.

Field	Value
name	SaBiasNumSteps
path	GroupRoot.Group.SaTuneProcess.SaBiasNumSteps
typeStr	int
disp	{}
precision	0
mode	RW
minimum	1
maximum	10

GroupRoot.Group.SaTuneProcess.SetAfterFinish

This variale controls if the tuning point found at the end of the process is set back.

Otherwise the previous values of SaFb and SaBias will be restored.

Field	Value
name	SetAfterFinish
path	GroupRoot.Group.SaTuneProcess.SetAfterFinish
enum	{False: ‘False’, True: ‘True’}
typeStr	bool
disp	enum
precision	0
mode	RW

GroupRoot.Group.SaTuneProcess.SaTuneOutput

Results Data From SA Tuning.
This is a list of dictionaries, with one dictionary for each column in the system (ColumBoards * 8).
Each dctionary contains the following fields:.
xValues: x-axis values (SaFb) for each curve.
biasValues: array of SaBias values, one for each SaBias step.
curves: SaOffset vs SaFb curves, one for each SaBias value.
biasOut: Selected SaBias value after fitting.
xOut: Selected SaFb value after fitting.
yOut: SaOut at fitted SaFb point.

Field	Value
name	SaTuneOutput
path	GroupRoot.Group.SaTuneProcess.SaTuneOutput
typeStr	dict
disp	{}
precision	0
mode	RO