Merge pull request #2428 from willend/main

Expand Monitor_nD to 10 uservars + other work on monitors

Author: willend

docs/manuals/mcstas/comp_abstract.tex

@@ -188,9 +188,6 @@ \section{A short overview of the \MCS component library}
 %                    covers the whole cylinder (360 degrees). \\
 %PSDlin\_monitor   &   Rectangular 1D PSD, measuring intensity vs.
 %                    vertical position, x. \\
-PreMonitor\_nD    &   This component is a PreMonitor that is to be
-                    used with one Monitor\_nD,
-                    in order to record some neutron parameter correlations. \\
 TOFLambda\_monitor &  Time-of-flight vs. wavelength monitor. \\
 %TOF\_cylPSD\_monitor & Cylindrical (2pi) PSD Time-of-flight monitor. \\
 TOF\_monitor     &    Rectangular Time-of-flight monitor. \\

docs/manuals/mcstas/monitors/Monitor_nD.tex

@@ -342,27 +342,38 @@ \subsubsection{Example: Number of neutron bounces in a guide}
 (...)
 \end{lstlisting}
 
-\subsection{Monitoring neutron parameter correlations, PreMonitor\_nD}
+\subsection{Monitoring neutron parameter correlations via USERVARS}
 
-The first imediate usage of the Monitor\_nD component is when one requires to identify cross-correlations between some neutron parameters, e.g. position and divergence (\textit{aka} phase-space diagram). This latter monitor would be merely obtained with:\index{Monitors!Neutron parameter correlations, PreMonitor\_nD}
+The first imediate usage of the Monitor\_nD component is when one requires to identify cross-correlations between some neutron parameters, e.g. position and divergence (\textit{aka} phase-space diagram). 
 \begin{lstlisting}
 options="x dx, auto", bins=30
 \end{lstlisting}
 This example records the correlation between position and divergence of neutrons at a given instrument location.
 
-\component{PreMonitor\_nD}{System, E. Farhi}{comp}{}{}
+But it is also possible to search for cross-correlation between two part of the instrument simulation. One example is the acceptance phase-diagram, which shows the neutron caracteristics at the input required to reach the end of the simulation. This \emph{spatial} correlation may be revealed using \index{Monitors!Neutron parameter correlations, USERVARS}\ref{s:monnd:user} initialised in an \textbf{EXTEND} block of an earlier component. \textbf{USERVARS} may store neutron parameters at a given instrument location, to be used with a later Monitor\_nD location for monitoring:
 
-But it is also possible to search for cross-correlation between two part of the instrument simulation. One example is the acceptance phase-diagram, which shows the neutron caracteristics at the input required to reach the end of the simulation. This \emph{spatial} correlation may be revealed using the \textbf{PreMonitor\_nD} component. This latter stores the neutron parameters at a given instrument location, to be used at an other Monitor\_nD location for monitoring.
-
-The only parameter of \textbf{PreMonitor\_nD} is the name of the associated Monitor\_nD instance, which should use the \verb+premonitor+ option, as in the following example:
 \begin{lstlisting}
-COMPONENT CorrelationLocation = PreMonitor_nD(comp = CorrelationMonitor)
+USERVARS \%{
+  double x_in;
+  double xdiv_in;
+\%}
+
+TRACE
+
+COMPONENT CorrelationLocation = Arm()
 AT (...)
+EXTEND \%{
+  x_in=x;
+  // Calculate divergence wrt. z
+  xdiv_in = RAD2DEG * atan2 (vx, vz);
+\%}
 
   (... e.g. a guide system )
 
-COMPONENT CorrelationMonitor  = Monitor_nD(
-   options="x dx, auto, all bins=30, premonitor")
+  COMPONENT CorrelationMonitor  = Monitor_nD(
+   user1=''x_in'', user2=''xdiv_in'',
+   username1=''Upstream pos'',  username2=''Upstream div''
+   options="user1 user2, auto, all bins=30")
 AT (...)
 \end{lstlisting}
-which performs the same monitoring as the previous example, but with a spatial correlation constrain. Indeed, it records the position \textit{vs} the divergence of neutrons at the correlation location, but only if they reach the monitoring position. All usual Monitor\_nD variables may be used, except the user variables. These latter may be defined as described in section \ref{s:monnd:user} in an EXTEND block.
+which performs the same monitoring as the previous example, but with a spatial correlation constrain. Indeed, it records the position \textit{vs} the divergence of neutrons at the correlation location, but only if they reach the monitoring position.

docs/manuals/mcxtrace/comp_abstract.tex

@@ -138,9 +138,6 @@ \section{A short overview of the \MCX\ component library}
 %                    covers the whole cylinder (360 degrees). \\
 %PSDlin\_monitor   &   Rectangular 1D PSD, measuring intensity vs.
 %                    vertical position, x. \\
-PreMonitor\_nD    &   This component is a PreMonitor that is to be
-                    used with one Monitor\_nD,
-                    in order to record some photon parameter correlations. \\
 TOFLambda\_monitor &  Time-of-flight vs. wavelength monitor. \\
 %TOF\_cylPSD\_monitor & Cylindrical (2pi) PSD Time-of-flight monitor. \\
 TOF\_monitor     &    Rectangular Time-of-flight monitor. \\

docs/manuals/mcxtrace/monitors/PreMonitor_nD.tex

@@ -63,4 +63,3 @@ \chapter{Monitors and detectors}
 
 \newpage
 \input{monitors/Monitor_nD}
-\input{monitors/PreMonitor_nD}

docs/manuals/mcxtrace/monitors/monitors.tex

@@ -3,7 +3,6 @@ EPSD_monitor
 L_monitor
 Monitor
 Monitor_nD
-PreMonitor_nD
 PSD_monitor_4PI
 PSD_monitor_coh
 PSD_monitor