CosMO-detector/Threshold_scan.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {
    "collapsed": true
   },
   "source": [
    "# Threshold scanner"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### This python script can record arbitrary data from a serial connection. For a set time even. Please note that the outputted data is likely formatted in mac line endings (because that is what Arduinos send). So if you want to use the data in another program, especially the analysis program, conversion to Linux line endings must be done. On Windows Notepad++ can do this.\n",
    "\n",
    "\n",
    "Note: the maximum output speed of the DAQ-card is about 30 events per second "
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 2,
   "metadata": {
    "collapsed": true
   },
   "outputs": [],
   "source": [
    "import serial\n",
    "import time"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 3,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "Output file name: 20171115-1444_Thresh_scan_start-10_stop-600_step-10_sec_per_rec_120_detector_mode_2E.txt\n"
     ]
    }
   ],
   "source": [
    "# settings\n",
    "\n",
    "recording_secs_per_setting = 60*2\n",
    "\n",
    "start_threshold = 10\n",
    "stop_threshold = 600\n",
    "step_size = 10\n",
    "\n",
    "detector_mode = \"2E\" # Coincidence (threefold) and Channels (1,2,3), no veto\n",
    "#detector_mode = \"2E\" # Coincidence (threefold) and Channels (1,2,3), no veto\n",
    "\n",
    "output_file = time.strftime(\"%Y%m%d-%H%M\")+\"_Thresh_scan\"\n",
    "output_file += \"_start-\"+str(start_threshold)+\"_stop-\"+str(stop_threshold)+\"_step-\"+str(step_size)\n",
    "output_file += \"_sec_per_rec_\"+str(recording_secs_per_setting)\n",
    "output_file += \"_detector_mode_\"+str(detector_mode)+\".txt\"\n",
    "print(\"Output file name: \" + output_file)\n",
    "serial_port = 'COM14'\n",
    "baud_rate = 115200"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 5,
   "metadata": {},
   "outputs": [],
   "source": [
    "# start the serial connection\n",
    "ser = serial.Serial(serial_port, baud_rate, timeout=0.5)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 8,
   "metadata": {
    "collapsed": true
   },
   "outputs": [],
   "source": [
    "# Functions\n",
    "\n",
    "def turn_off_auto_reset():\n",
    "    commands = \"ST 0\\r\"\n",
    "    setting_successfull = False\n",
    "    while setting_successfull == False:\n",
    "        ser.write(commands)\n",
    "        # check if everything was recieved as prompted\n",
    "        curr_line = str(ser.readline())\n",
    "        curr_line = str(ser.readline())\n",
    "        checking_line = curr_line\n",
    "        if \"ST Disabled\" in checking_line:\n",
    "            setting_successfull = True\n",
    "            print(\"Disabling of the auto reset was sucessfull\")\n",
    "            break\n",
    "        else:\n",
    "            print(\"Disabling of the auto reset mode failed! Retring now.\")\n",
    "            setting_successfull = False\n",
    "            continue\n",
    "\n",
    "def set_detector_mode(detector_mode):\n",
    "    commands = \"WC 00 \"+detector_mode+\"\\r\"\n",
    "    setting_successfull = False\n",
    "    while setting_successfull == False:\n",
    "        ser.write(commands)\n",
    "        # check if everything was recieved as prompted\n",
    "        curr_line = str(ser.readline())\n",
    "        curr_line = str(ser.readline())\n",
    "        checking_line = curr_line\n",
    "        returned_parameters = checking_line.split(\"=\")\n",
    "        result_setting = returned_parameters[1].replace('\\r\\n', '')\n",
    "        if (result_setting == detector_mode):\n",
    "            setting_successfull = True\n",
    "            print(\"Setting of the coincidence mode was sucessfull\")\n",
    "            break\n",
    "        else:\n",
    "            print(\"Setting of the coincidence mode failed! Retring now.\")\n",
    "            setting_successfull = False\n",
    "            continue\n",
    "    \n",
    "\n",
    "def set_thresh(threshs):\n",
    "    setting_successfull = False\n",
    "    while setting_successfull == False:\n",
    "        commands = \"TL 0 \"+str(threshs[0])+\"\\rTL 1 \"+str(threshs[1])+\"\\rTL 2 \"+str(threshs[2])+\"\\rTL 3 \"+str(threshs[3])+\"\\r\"\n",
    "        ser.write(commands)\n",
    "        # poll until all commands were recieved\n",
    "        curr_line = ser.readline()\n",
    "        while not (curr_line == ''):\n",
    "            curr_line = ser.readline()\n",
    "        # check if everything was recieved as prompted\n",
    "        ser.write(\"TL\\r\")\n",
    "        curr_line = str(ser.readline())\n",
    "        curr_line = str(ser.readline())\n",
    "        checking_line = curr_line\n",
    "        checking_line = checking_line.replace(\"L0\",\"\").replace(\"L1\",\"\").replace(\"L2\",\"\").replace(\"L3\",\"\")\n",
    "        returned_parameters = checking_line.split(\"=\")\n",
    "        for i in range(len(threshs)):\n",
    "            if(int(returned_parameters[i+1]) != int(threshs[i])):\n",
    "                print(\"Setting of thresholds failed! Retring now.\")\n",
    "                setting_successfull = False\n",
    "                continue\n",
    "        setting_successfull = True\n",
    "        print(\"Setting of thresholds was sucessfull. Set to: \"+str(threshs))\n",
    "        break\n",
    "        \n",
    "def stop_detector_output():\n",
    "    # stop the output from the detector and poll last lines\n",
    "    print(\"Stopping detector output\")\n",
    "    ser.write(\"CD\\r\")\n",
    "    curr_line = ser.readline()\n",
    "    while not (curr_line == ''):\n",
    "        curr_line = ser.readline()\n",
    "    print(\"Detector output stopped\")"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 9,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "Disabling of the auto reset was sucessfull\n",
      "Stopping detector output\n",
      "Detector output stopped\n",
      "Setting of thresholds was sucessfull. Set to: [10, 10, 10, 10]\n",
      "Setting of the coincidence mode was sucessfull\n"
     ]
    }
   ],
   "source": [
    "turn_off_auto_reset()\n",
    "stop_detector_output()\n",
    "# setup the detector\n",
    "set_thresh([start_threshold for i in range(4)])\n",
    "set_detector_mode(detector_mode)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 10,
   "metadata": {
    "scrolled": false
   },
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "Setting of thresholds was sucessfull. Set to: [10, 10, 10, 10]\n",
      "Estimated leftover runtime: 118.0 [min]\n",
      "Setting of thresholds was sucessfull. Set to: [20, 20, 20, 20]\n",
      "Estimated leftover runtime: 116.0 [min]\n",
      "Setting of thresholds was sucessfull. Set to: [30, 30, 30, 30]\n",
      "Estimated leftover runtime: 114.0 [min]\n",
      "Setting of thresholds was sucessfull. Set to: [40, 40, 40, 40]\n",
      "Estimated leftover runtime: 112.0 [min]\n",
      "Setting of thresholds was sucessfull. Set to: [50, 50, 50, 50]\n",
      "Estimated leftover runtime: 110.0 [min]\n",
      "Setting of thresholds was sucessfull. Set to: [60, 60, 60, 60]\n",
      "Estimated leftover runtime: 108.0 [min]\n",
      "Setting of thresholds was sucessfull. Set to: [70, 70, 70, 70]\n",
      "Estimated leftover runtime: 106.0 [min]\n",
      "Setting of thresholds was sucessfull. Set to: [80, 80, 80, 80]\n",
      "Estimated leftover runtime: 104.0 [min]\n",
      "Setting of thresholds was sucessfull. Set to: [90, 90, 90, 90]\n",
      "Estimated leftover runtime: 102.0 [min]\n",
      "Setting of thresholds was sucessfull. Set to: [100, 100, 100, 100]\n",
      "Estimated leftover runtime: 100.0 [min]\n",
      "Setting of thresholds was sucessfull. Set to: [110, 110, 110, 110]\n",
      "Estimated leftover runtime: 98.0 [min]\n",
      "Setting of thresholds was sucessfull. Set to: [120, 120, 120, 120]\n",
      "Estimated leftover runtime: 96.0 [min]\n",
      "Setting of thresholds was sucessfull. Set to: [130, 130, 130, 130]\n",
      "Estimated leftover runtime: 94.0 [min]\n",
      "Setting of thresholds was sucessfull. Set to: [140, 140, 140, 140]\n",
      "Estimated leftover runtime: 92.0 [min]\n",
      "Setting of thresholds was sucessfull. Set to: [150, 150, 150, 150]\n",
      "Estimated leftover runtime: 90.0 [min]\n",
      "Setting of thresholds was sucessfull. Set to: [160, 160, 160, 160]\n",
      "Estimated leftover runtime: 88.0 [min]\n",
      "Setting of thresholds was sucessfull. Set to: [170, 170, 170, 170]\n",
      "Estimated leftover runtime: 86.0 [min]\n",
      "Setting of thresholds was sucessfull. Set to: [180, 180, 180, 180]\n",
      "Estimated leftover runtime: 84.0 [min]\n",
      "Setting of thresholds was sucessfull. Set to: [190, 190, 190, 190]\n",
      "Estimated leftover runtime: 82.0 [min]\n",
      "Setting of thresholds was sucessfull. Set to: [200, 200, 200, 200]\n",
      "Estimated leftover runtime: 80.0 [min]\n",
      "Setting of thresholds was sucessfull. Set to: [210, 210, 210, 210]\n",
      "Estimated leftover runtime: 78.0 [min]\n",
      "Setting of thresholds was sucessfull. Set to: [220, 220, 220, 220]\n",
      "Estimated leftover runtime: 76.0 [min]\n",
      "Setting of thresholds was sucessfull. Set to: [230, 230, 230, 230]\n",
      "Estimated leftover runtime: 74.0 [min]\n",
      "Setting of thresholds was sucessfull. Set to: [240, 240, 240, 240]\n",
      "Estimated leftover runtime: 72.0 [min]\n",
      "Setting of thresholds was sucessfull. Set to: [250, 250, 250, 250]\n",
      "Estimated leftover runtime: 70.0 [min]\n",
      "Setting of thresholds was sucessfull. Set to: [260, 260, 260, 260]\n",
      "Estimated leftover runtime: 68.0 [min]\n",
      "Setting of thresholds was sucessfull. Set to: [270, 270, 270, 270]\n",
      "Estimated leftover runtime: 66.0 [min]\n",
      "Setting of thresholds was sucessfull. Set to: [280, 280, 280, 280]\n",
      "Estimated leftover runtime: 64.0 [min]\n",
      "Setting of thresholds was sucessfull. Set to: [290, 290, 290, 290]\n",
      "Estimated leftover runtime: 62.0 [min]\n",
      "Setting of thresholds was sucessfull. Set to: [300, 300, 300, 300]\n",
      "Estimated leftover runtime: 60.0 [min]\n",
      "Setting of thresholds was sucessfull. Set to: [310, 310, 310, 310]\n",
      "Estimated leftover runtime: 58.0 [min]\n",
      "Setting of thresholds was sucessfull. Set to: [320, 320, 320, 320]\n",
      "Estimated leftover runtime: 56.0 [min]\n",
      "Setting of thresholds was sucessfull. Set to: [330, 330, 330, 330]\n",
      "Estimated leftover runtime: 54.0 [min]\n",
      "Setting of thresholds was sucessfull. Set to: [340, 340, 340, 340]\n",
      "Estimated leftover runtime: 52.0 [min]\n",
      "Setting of thresholds was sucessfull. Set to: [350, 350, 350, 350]\n",
      "Estimated leftover runtime: 50.0 [min]\n",
      "Setting of thresholds was sucessfull. Set to: [360, 360, 360, 360]\n",
      "Estimated leftover runtime: 48.0 [min]\n",
      "Setting of thresholds was sucessfull. Set to: [370, 370, 370, 370]\n",
      "Estimated leftover runtime: 46.0 [min]\n",
      "Setting of thresholds was sucessfull. Set to: [380, 380, 380, 380]\n",
      "Estimated leftover runtime: 44.0 [min]\n",
      "Setting of thresholds was sucessfull. Set to: [390, 390, 390, 390]\n",
      "Estimated leftover runtime: 42.0 [min]\n",
      "Setting of thresholds was sucessfull. Set to: [400, 400, 400, 400]\n",
      "Estimated leftover runtime: 40.0 [min]\n",
      "Setting of thresholds was sucessfull. Set to: [410, 410, 410, 410]\n",
      "Estimated leftover runtime: 38.0 [min]\n",
      "Setting of thresholds was sucessfull. Set to: [420, 420, 420, 420]\n",
      "Estimated leftover runtime: 36.0 [min]\n",
      "Setting of thresholds was sucessfull. Set to: [430, 430, 430, 430]\n",
      "Estimated leftover runtime: 34.0 [min]\n",
      "Setting of thresholds was sucessfull. Set to: [440, 440, 440, 440]\n",
      "Estimated leftover runtime: 32.0 [min]\n",
      "Setting of thresholds was sucessfull. Set to: [450, 450, 450, 450]\n",
      "Estimated leftover runtime: 30.0 [min]\n",
      "Setting of thresholds was sucessfull. Set to: [460, 460, 460, 460]\n",
      "Estimated leftover runtime: 28.0 [min]\n",
      "Setting of thresholds was sucessfull. Set to: [470, 470, 470, 470]\n",
      "Estimated leftover runtime: 26.0 [min]\n",
      "Setting of thresholds was sucessfull. Set to: [480, 480, 480, 480]\n",
      "Estimated leftover runtime: 24.0 [min]\n",
      "Setting of thresholds was sucessfull. Set to: [490, 490, 490, 490]\n",
      "Estimated leftover runtime: 22.0 [min]\n",
      "Setting of thresholds was sucessfull. Set to: [500, 500, 500, 500]\n",
      "Estimated leftover runtime: 20.0 [min]\n",
      "Setting of thresholds was sucessfull. Set to: [510, 510, 510, 510]\n",
      "Estimated leftover runtime: 18.0 [min]\n",
      "Setting of thresholds was sucessfull. Set to: [520, 520, 520, 520]\n",
      "Estimated leftover runtime: 16.0 [min]\n",
      "Setting of thresholds was sucessfull. Set to: [530, 530, 530, 530]\n",
      "Estimated leftover runtime: 14.0 [min]\n",
      "Setting of thresholds was sucessfull. Set to: [540, 540, 540, 540]\n",
      "Estimated leftover runtime: 12.0 [min]\n",
      "Setting of thresholds was sucessfull. Set to: [550, 550, 550, 550]\n",
      "Estimated leftover runtime: 10.0 [min]\n",
      "Setting of thresholds was sucessfull. Set to: [560, 560, 560, 560]\n",
      "Estimated leftover runtime: 8.0 [min]\n",
      "Setting of thresholds was sucessfull. Set to: [570, 570, 570, 570]\n",
      "Estimated leftover runtime: 6.0 [min]\n",
      "Setting of thresholds was sucessfull. Set to: [580, 580, 580, 580]\n",
      "Estimated leftover runtime: 4.0 [min]\n",
      "Setting of thresholds was sucessfull. Set to: [590, 590, 590, 590]\n",
      "Estimated leftover runtime: 2.0 [min]\n",
      "Setting of thresholds was sucessfull. Set to: [600, 600, 600, 600]\n",
      "Estimated leftover runtime: 0.0 [min]\n"
     ]
    }
   ],
   "source": [
    "current_thresh = start_threshold\n",
    "# write into output file\n",
    "with open(output_file, 'w') as f:\n",
    "    f.write(\"recording_secs_per_setting: \"+str(recording_secs_per_setting)+\"\\r\\r\")\n",
    "    while current_thresh <= stop_threshold:\n",
    "        # set new thresholds\n",
    "        set_thresh([current_thresh for i in range(4)])\n",
    "        f.write(\"Current Threshold: \"+str(current_thresh)+\"\\r\\r\")\n",
    "        # reset the detector counters\n",
    "        ser.write(\"RB\\r\")\n",
    "        # start the timer\n",
    "        start_time = time.time()\n",
    "        # wait unit we can stop\n",
    "        while time.time() < (start_time+recording_secs_per_setting):\n",
    "            time.sleep(0.001)\n",
    "        # read the counters\n",
    "        ser.write(\"DS\\r\")\n",
    "        # write lines into file:\n",
    "        curr_line = ser.readline()\n",
    "        while not (curr_line == ''):\n",
    "            # remove the \\n at the end\n",
    "            curr_line = curr_line.split('\\n')[0]\n",
    "            f.write(curr_line)\n",
    "            curr_line = ser.readline()\n",
    "        f.flush()\n",
    "        \n",
    "        # increment the threshold\n",
    "        current_thresh += step_size\n",
    "        \n",
    "        steps_left = (stop_threshold-current_thresh+step_size)/step_size\n",
    "        time_left = recording_secs_per_setting * steps_left\n",
    "        print(\"Estimated leftover runtime: {:.1f} [min]\".format(time_left/60.0))\n",
    "    "
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {
    "collapsed": true
   },
   "outputs": [],
   "source": []
  }
 ],
 "metadata": {
  "anaconda-cloud": {},
  "kernelspec": {
   "display_name": "Python [conda root]",
   "language": "python",
   "name": "conda-root-py"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 2
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython2",
   "version": "2.7.14"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 2
}