Rectangle Mode Data - Revision history

Dvw at 01:55, 1 September 2016

2016-09-01T01:55:03Z

Dvw at 00:48, 31 August 2016

2016-08-31T00:48:28Z

Dvw at 23:06, 30 August 2016

2016-08-30T23:06:59Z

Dvw at 02:26, 24 June 2016

2016-06-24T02:26:18Z

Dvw at 20:12, 24 September 2014

2014-09-24T20:12:41Z

Dvw at 20:11, 24 September 2014

2014-09-24T20:11:49Z

Mhasse at 19:59, 19 February 2013

2013-02-19T19:59:20Z

Mhasse: /* Script Differences Between v4.x.x and v5.x.x */

2012-07-31T18:28:30Z

‎Script Differences Between v4.x.x and v5.x.x

Dvw at 02:19, 12 January 2012

2012-01-12T02:19:42Z

Mhasse: /* Readout limitations */

2011-11-18T21:27:45Z

‎Readout limitations

@@ Line 174: / Line 174: @@
    wb rca readout_col_index 0     //power-on default = 0
-[[Category:Firmware]]
+[[Category:Clock Card Firmware]]
 [[Category:MCE Script]]
 [[Category:Python]]

← Older revision		Revision as of 00:48, 31 August 2016
Line 175:		Line 175:

	[[Category:Firmware]]		[[Category:Firmware]]
−	[[Category:~~Software~~]]	+	[[Category:MCE Script]]
		+	[[Category:Python]]

← Older revision		Revision as of 23:06, 30 August 2016
Line 173:		Line 173:
	wb rca readout_row_index 0 //power-on default as above		wb rca readout_row_index 0 //power-on default as above
	wb rca readout_col_index 0 //power-on default = 0		wb rca readout_col_index 0 //power-on default = 0
		+
		+	[[Category:Firmware]]
		+	[[Category:Software]]

@@ Line 60: / Line 60: @@
   MCE configuration:
-   cc_rcs   ( cc, {{param|cc|cards_to_report_data|rcs_to_report_data}} ):     60
+   cc_rcs   ( cc, {{param|cc|rcs_to_report_data}} ):     60
    cc_dec   ( cc, {{param|cc|data_rate}} ):             256
    cc_nmux  ( cc, {{param|sys|num_rows}} ):               33

@@ Line 60: / Line 60: @@
   MCE configuration:
-   cc_rcs   ( cc, {{param|cc|rcs_to_report_data}} ):     60
+   cc_rcs   ( cc, {{param|cc|cards_to_report_data|rcs_to_report_data}} ):     60
    cc_dec   ( cc, {{param|cc|data_rate}} ):             256
-   cc_nmux  ( cc, {{param|cc|num_rows}} ):               33
+   cc_nmux  ( cc, {{param|sys|num_rows}} ):               33
-   cc_cmux  ( cc, {{param|cc|row_len}} ):               100
+   cc_cmux  ( cc, {{param|sys|row_len}} ):               100
    cc_nr    ( cc, {{param|cc|num_rows_reported}} ):      32
    cc_nc    ( cc, {{param|cc|num_cols_reported}} ):       8

@@ Line 1: / Line 1: @@
-"Rectangle Mode" refers to the sampling of a subset of the full array, typically at a kHz data rate.  The data from the Readout Cards is packed into output frames efficiently to minimize overhead.
+'''Rectangle Mode''' refers to the sampling of a subset of the full array, typically at a kHz data rate.  The data from the Readout Cards is packed into output frames efficiently to minimize overhead.
 Rectangle mode eliminates strain on the acquisition system during fast acquisitions by eliminating read-out overhead.  This means that the 'difficulty' of read-out is a fairly linear function of (sampling frequency) x (number of detectors read out) rather than depending on each.
-The hardware limit on readout is roughly 4 MB/s.  Since MCE data are 32-bit words, this permits 1e6 detector-samples to be read out per second.
+The hardware limit on readout is roughly 4 MB/s.  Since MCE data are 32-bit words, this permits 10<sup>6</sup> detector samples to be read out per second.
-So the maximum number of detectors that can be sampled at some frequency F is
+So the maximum number of detectors ''D'' that can be sampled at some frequency ''F'' is
-  D = (1 MHz) / F
+ ''D'' = (1 MHz) / ''F''
 You can't sample at 1 MHz.  But you could probably do a detector or two at 250 kHz.
@@ Line 13: / Line 13: @@
 The steps for configuring a rectangle mode acquisition are:
-# Set the multiplexing rate using num_rows and row_len
+# Set the multiplexing rate using {{param|sys|num_rows}} and {{param|sys|row_len}}
-# If necessary, adjust row_order to mux the channels of interest (you can only read out rows you are multiplexing...).  If you do not intend to re-tune the array with the adjusted num_rows / row_order, you must also change the first entries of rc* adc_offset* to correspond to the desired rows and, for fast SQ2 switching, change row_order on the BAC/BC2.
+# If necessary, adjust row_order to mux the channels of interest (you can only read out rows you are multiplexing...).  If you do not intend to re-tune the array with the adjusted num_rows / row_order, you must also change the first entries of {{param|rc|adc_offset0|rc''#'' adc_offset''#''}} to correspond to the desired rows and, for fast SQ2 switching, change {{param|bc|row_order}} on BC2 (or [[BAC]]).
 # Identify a rectangle of detectors on the readout card to read out by setting the RC parameters
-#* num_rows_reported, num_cols_reported, readout_row_index, readout_col_index
+#* {{param|rc|num_rows_reported}}, {{param|rc|num_cols_reported}}, {{param|rc|readout_row_index}}, {{param|rc|readout_col_index}}
 # Set the size of the readout frame by setting the CC parameters
-#* num_rows_reported, num_cols_reported
+#* {{param|cc|num_rows_reported}}, {{param|cc|num_cols_reported}}
-# Set the CC decimation factor 'data_rate' so that the RC rectangles will stack perfectly into the CC readout frame.
+# Set the CC decimation factor {{param|cc|data_rate}} so that the RC rectangles will stack perfectly into the CC readout frame.
 #* e.g. suppose
-#** RC num_rows_reported x num_cols_reported =  1x4
+#** RC: {{param|rc|num_rows_reported}} x {{param|rc|num_cols_reported}} =  1x4
-#** CC num_rows_reported x num_cols_reported = 33x8
+#** CC: {{param|cc|num_rows_reported}} x {{param|cc|num_cols_reported}} = 33x8
 #* then we set
-#** CC data_rate = (33 x 8) / (1 x 4) = 66
+#** CC: {{param|cc|data_rate}} = (33 x 8) / (1 x 4) = 66
 = Readout limitations =
@@ Line 35: / Line 35: @@
 Other things to remember:
-* num_rows >= 2 is encouraged.
+* {{param|sys|num_rows}} &ge; 2 is encouraged.
 * you can't sample a detector faster than it is being visited in the multiplexing cycle.
 * In RC firmware prior to 5.1.7, the following condition has to be met:
-  (230 + 2 * cc_num_rows_reported * cc_num_cols_reported) < (num_rows * row_len)
+  (230 + 2 * {{param|cc|num_rows_reported|cc&nbsp;num_rows_reported}} * {{param|cc|num_cols_reported|cc&nbsp;num_cols_reported}}) < ({{param|sys|num_rows}} * {{param|sys|row_len}})
 otherwise, the data is corrupted. This problem is fixed in RC firmware 5.1.7 (See [[Readout Card firmware]])
 = Checking MCE configuration using rect_check.py =
-Use the utility @rect_check.py@ to verify that data will be / were acquired reasonably.
+Use the utility <tt>rect_check.py</tt> to verify that data will be / were acquired reasonably.
 e.g. To check the state of the MCE (requires python MCE bindings), run
@@ Line 60: / Line 60: @@
   MCE configuration:
-   cc_rcs   ( cc, rcs_to_report_data ):     60
+   cc_rcs   ( cc, {{param|cc|rcs_to_report_data}} ):     60
-   cc_dec   ( cc, data_rate ):             256
+   cc_dec   ( cc, {{param|cc|data_rate}} ):             256
-   cc_nmux  ( cc, num_rows ):               33
+   cc_nmux  ( cc, {{param|cc|num_rows}} ):               33
-   cc_cmux  ( cc, row_len ):               100
+   cc_cmux  ( cc, {{param|cc|row_len}} ):               100
-   cc_nr    ( cc, num_rows_reported ):      32
+   cc_nr    ( cc, {{param|cc|num_rows_reported}} ):      32
-   cc_nc    ( cc, num_cols_reported ):       8
+   cc_nc    ( cc, {{param|cc|num_cols_reported}} ):       8
-   rc_nmux  ( rca, num_rows ):              33
+   rc_nmux  ( rca, {{param|sys|num_rows}} ):              33
-   rc_cmux  ( rca, row_len ):              100
+   rc_cmux  ( rca, {{param|sys|row_len}} ):              100
-   rc_nr    ( rca, num_rows_reported ):      1
+   rc_nr    ( rca, {{param|rc|num_rows_reported}} ):      1
-   rc_nc    ( rca, num_cols_reported ):      1
+   rc_nc    ( rca, {{param|rc|num_cols_reported}} ):      1
-   rc_r0    ( rca, readout_row_index ):      0
+   rc_r0    ( rca, {{param|rc|readout_row_index}} ):      0
-   rc_c0    ( rca, readout_col_index ):      0
+   rc_c0    ( rca, {{param|rc|readout_col_index}} ):      0
   Framing:
@@ Line 100: / Line 100: @@
 * 'Bizarro': the rectangle defined in the RC does not fit evenly into the readout frame.
 ** e.g. you have set up an 8x8 rectangle but you're reading CC frames that are 33x8.  Don't do this.  I'm not even sure what you'd get out.
-* 'Bounded': the rectangle defined in the RC corresponds to detectors that are actually getting read/servoed.  This basically just checks that rc? readout_row_index makes any sense at all given num_rows and num_rows_reported.
+* 'Bounded': the rectangle defined in the RC corresponds to detectors that are actually getting read/servoed.  This basically just checks that rc''#'' {{param|rc|readout_row_index}} makes any sense at all given {{param|sys|num_rows}} and {{param|rc|num_rows_reported}}.
 ** This must be "yes" or your data could be weird.
 Note that it is possible to be none of Complete, Contiguous, or Bizarro.  For example, you could read out the first 33 of every 66 multiplexing cycles for 8 detectors, packing them efficiently into a 33 x 8 read-out frame.  Maybe that should be called Bizarro.  But right now, it isn't.
-It is unlikely, but possible, to be both Contiguous and Complete.
+It is unlikely, but possible, to be both Contiguous and Complete.  If you are Bizarro, you are neither Contiguous nor Complete.  See Euler diagram below.
 [[Image:reasonable_rectangles.png]]
@@ Line 166: / Line 164: @@
 *In v4.x.x: The array patch-size is flexible in terms of the number of rows, and the row start index.
    wb cc num_rows_reported 41     //power-on default = 41
-   wb rcs readout_row_index 0     //power-on default = 0
+   wb rca readout_row_index 0     //power-on default = 0
 *In v5.x.x: The array patch-size is now also flexible in terms of the number of columns, and the column start index.  Note that matching parameters on the Readout Cards and the Clock Card must be consistent.
    wb cc num_rows_reported 41     //power-on default as above
    wb cc num_cols_reported 8      //power-on default = 8
-   wb rcs num_rows_reported 41    //power-on default = 41
+   wb rca num_rows_reported 41    //power-on default = 41
-   wb rcs num_cols_reported 8     //power-on default = 8
+   wb rca num_cols_reported 8     //power-on default = 8
-   wb rcs readout_row_index 0     //power-on default as above
+   wb rca readout_row_index 0     //power-on default as above
-   wb rcs readout_col_index 0     //power-on default = 0
+   wb rca readout_col_index 0     //power-on default = 0

@@ Line 8: / Line 8: @@
    D = (1 MHz) / F
-You can't sample at 1 MHz.  (Do your squids settle in 1us?  Didn't think so.)  But you could probably do a detector or two at 250 kHz.
+You can't sample at 1 MHz.  But you could probably do a detector or two at 250 kHz.
 = Configuration =

← Older revision		Revision as of 18:28, 31 July 2012
Line 159:		Line 159:

	= Script Differences Between v4.x.x and v5.x.x =		= Script Differences Between v4.x.x and v5.x.x =
		+
		+	This section describes the minimal configuration changes necessary to operate v5 firmware as though it were v4 firmware. If you use MAS, then stop reading now.
		+
	The differences between basic frame setup in v4.x.x and v5.x.x are described here. The data frame structure has been made more flexible. A user can read out an arbitrarily rectangular patch of the array. The patch-size is specified using new commands.		The differences between basic frame setup in v4.x.x and v5.x.x are described here. The data frame structure has been made more flexible. A user can read out an arbitrarily rectangular patch of the array. The patch-size is specified using new commands.

@@ Line 32: / Line 32: @@
 * Read-out frequency must not exceed 20 kHz
 * The multiplexing frame rate must not be set so fast that the MCE cannot communicate with the readout cards.  This limit is probably in the 100s of kHz.
 Other things to remember: