BNMR: Custom Settings page: Difference between revisions

From DaqWiki
Jump to navigation Jump to search
m (Bsmith moved page DaqWiki:BNMR: Custom Parameters page to BNMR: Custom Parameters page without leaving a redirect)
No edit summary
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Pagelinks}}
{{Pagelinks}}
= Links =
== Links ==
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
* [[BNMR: Custom pages|BNMR/BNQR Custom pages]]
* [[BNMR: Custom pages|BNMR/BNQR Custom pages]]
* [[BNMR: Custom Status page|Custom Status page]]
* [[BNMR: Custom Status page|Custom Status page]]
* [[BNMR: Custom Parameters page|Custom Parameters page]]
* [[BNMR: Custom Settings page|Custom Settings page]]
* [[BNMR: Custom PPG Mode 2e Graphical page|Custom PPG Mode 2e Graphical page]]
* [[BNMR: Custom Logging page|Custom Logging page]]
* [[BNMR: Custom PPG Mode 20 Setup page|Custom PPG Mode 20 RF Setup page]]
* [[BNMR: Custom Modes page|Custom Modes page]]
* [[BNMR: PSM (Pol Synth Module)|PSM]]
* [[BNMR: Custom Expert page|Custom Expert page]]
* [[BNMR: Experimental Modes|Experimental (PPG) Modes]]
* [[BNMR: Getting Started|Getting Started]]
</div>
</div>
== Introduction ==
== Introduction ==
After selecting the Experimental (PPG) Mode by [[BNMR: Starting a run#Select Experimental (PPG) Mode|pressing a button]] on the
The settings page allows the user to:
[[BNMR: Custom Status page|Custom Status page]], the experimenter will need to review the [[BNMR Mode Parameters|parameters]] relevant to the selected  Experimental (PPG) Mode.
* change which experimental mode is being used
 
* change whether a run is "real" or "test" data
Each of the Experimental (PPG) Modes is associated with a list of '''Mode Parameters'''. This parameter list is displayed on the Custom Parameters Page,
* edit parameters that affect the PPG timing, PSM RF, parameter scanning etc
which can be accessed from the Custom Status Page by any of the following:
* save the current settings to be reloaded later
* clicking the RunParams button at the top of the page
* load settings that were previously saved
* clicking the same button used to select the PPG Mode
* load settings from a MUD file
* clicking the link PPG/PSM Parameters
* view the PPG timing scheme based on the current settings
 
* view the PSM RF I,Q pairs based on the current settings
If the selected mode includes RF, the [[BNMR Mode Parameters#PSM Parameters]] will also be displayed on the Custom Parameters Page. When the run is stopped, the user may change these parameters as desired by clicking on a button or link. When the run is in progress, the parameter values are shown, but cannot be changed.


== Examples of the Custom Parameter Page ==
Settings are editable while a run is stopped, and may not be edited while a run is in progress.
=== PPG Mode 2e (run stopped) ===
Figure 1 shows the Custom Parameter Page for Experimental (PPG) Mode 2e. The run is stopped, and parameters may be entered by clicking on the appropriate link. PPG Mode 2e include RF, so the [[BNMR Mode Parameters#PSM Parameters]] as well as the [[BNMR Mode Parameters#Mode Parameters]] are shown. Note that in the PSM Parameters, Quadrature Modulation Mode is enabled, so that a number of extra parameters are shown. Compare with the PSM parameters for [[BNMR Mode Parameters#Mode 1f(Freq)|Mode 1f]] where Single Tone Mode is enabled.
[[Image:bnqr_2e_param_page.png|left|frame|Figure 1:Parameter page for Mode 2e with run stopped]]
<br clear=all>


=== PPG Mode 2e (run in progress) ===
== Implementation ==
Figure 2 shows the same page as [[#PPG Mode 2e (run stopped)|Figure 1]] except the run is now in progress. The parameter values are shown, but may not be changed. The run state window has changed from "Stopped" to "Running" and the Tune lines are not shown.
[[Image:bnqr_2e_param_page_running.png|left|frame|Figure 2:Parameter page for Mode 2e with run in progress]]
<br clear=all>


;NOTE : PPG Mode 2e parameters can also be input graphically using the [[BNMR: Custom PPG Mode 2e Graphical page|PPG Mode 2e Graphical page]].
The page uses [https://daq00.triumf.ca/MidasWiki/index.php/Mjsonrpc Midas JRPC] calls to talk to:
* the <code>mode_changer.py</code> program for changing modes, loading/saving settings, and changing between real/test runs
* the <code>rf_calculator_fe.py</code> program for visualizing the PPG and PSM settings as plots


== Features of the Custom Parameters page ==
The page uses standard [https://daq00.triumf.ca/MidasWiki/index.php/Custom_Page Midas custom page] tools for editing ODB settings.


; Start/stop runs
== Example screenshot ==
: Buttons at the top of the page allow the user to start and stop runs without returning to the custom status page.
; Access to other MIDAS pages
: Buttons at the top of the page give access to other MIDAS pages including the custom status page.
; Timing Diagram link
: an alias-link provides access to the Timing Diagram for the selected Experimental (PPG) Mode
; Run status
: A coloured box indicates the run status, e.g. Stopped, Running, Transition in progress.
; Zaher's Calculator
: A button near the top of the page give access to Zaher's calculator for conversion from bandwidth to pulse duration for the  [[BNMR: PSM (Pol Synth Module)|PSM]]
; Mode 20 RF Setup page
: For PPG Mode 20 only, a button near the top of the page gives access to the [[BNMR: Custom PPG Mode 20 Setup page|Mode 20 RF Setup page]].
; Mode 2e graphical page
: For PPG Mode 2e only, a button at the top of the PPG Parameters Table gives access to the  [[BNMR: Custom PPG Mode 2e Graphical page|PPG Mode 2e Graphical page]].
; Read data/progress status line
: This line gives the status of the asynchronous ODB data read and page update. This is mainly used for debugging.
; Tunes line
: Load, save, create a tune. See [[BNMR: Tunes]] for details.
; Debug
: Checkboxes at the bottom of the screen allow various debugging to be turned on.
:* PSM debug - shows the values written to the PSM profile registers.  To see this, scroll the page down.
:* PPG debug - shows the "true" parameter values, i.e. the run parameter values written at the last "begin-of-run"
:* Show PSM Gate Params - these are usually hidden as they are set to the default values
:* Global debug - debugging for the Javascript. To see this, scroll the page down.


Note that the specific elements that are visible vary based on the current experimental mode. Some modes have extra tools (e.g. sliders) to simplify setting the PPG parameters to valid values.


== Programming Information ==
[[Image:Custom_settings.png|left|thumb|800px|Figure 1:Settings page for Mode 1f with run stopped]]
The Custom Parameters page is a MIDAS custom page. Custom pages must be listed in the {{Odbpath|path=/Custom}} ODB tree. Keys in this tree define the paths of the files containing external stylesheets, html and javascript code used by the  {{bnmqr|join=and}} experiments. See [[BNMR: Keys in /Custom ODB tree|Keys in /Custom ODB tree]] for details.


The Custom Parameters page and [[BNMR: Custom Status page|Custom Status page]] both use keys defined in the [[BNMR: Keys in /Custom ODB tree#Hidden subtree|/Custom/hidden subtree]] for communication.


[[Category:BNMR]] [[Category:Webserver]]  [[Category:Experiment (PPG) Modes]]
[[Category:BNMR]] [[Category:Webserver]]  [[Category:Experiment (PPG) Modes]]

Latest revision as of 10:51, 2 May 2022

Links

Introduction

The settings page allows the user to:

  • change which experimental mode is being used
  • change whether a run is "real" or "test" data
  • edit parameters that affect the PPG timing, PSM RF, parameter scanning etc
  • save the current settings to be reloaded later
  • load settings that were previously saved
  • load settings from a MUD file
  • view the PPG timing scheme based on the current settings
  • view the PSM RF I,Q pairs based on the current settings

Settings are editable while a run is stopped, and may not be edited while a run is in progress.

Implementation

The page uses Midas JRPC calls to talk to:

  • the mode_changer.py program for changing modes, loading/saving settings, and changing between real/test runs
  • the rf_calculator_fe.py program for visualizing the PPG and PSM settings as plots

The page uses standard Midas custom page tools for editing ODB settings.

Example screenshot

Note that the specific elements that are visible vary based on the current experimental mode. Some modes have extra tools (e.g. sliders) to simplify setting the PPG parameters to valid values.

Figure 1:Settings page for Mode 1f with run stopped
Retrieved from "https://daq00.triumf.ca/DaqWiki/index.php?title=BNMR:_Custom_Settings_page&oldid=6338"