DTObs.py

#!/usr/bin/env python3

import sys
import csv
import logging
from configparser import ConfigParser
import subprocess
import traceback
import time
import os.path
import numpy as np

from PyQt5 import QtGui
from PyQt5.QtCore import QRunnable, QObject, pyqtSignal, pyqtSlot, QThreadPool
from PyQt5.QtWidgets import (QFileDialog, QApplication, QMainWindow, QTableWidgetItem, QWidget)
from ui.dtobswindow import Ui_mainWindow

from astropy import units as u
from astropy.coordinates import SkyCoord

from telescope import telescope
from measurements import Measurements
from metadata import MetaData
from backend import Backend
from createpointings import CreatePointings
#from createpointings import CreatePointings

'''
Setup config ini
'''
config = ConfigParser()
config.readfp(open(os.path.join(os.path.dirname(__file__), 'dtobsgui.ini')))

'''
Setup logging
'''
logger = logging.getLogger('root')
FORMAT = "[%(asctime)s%(filename)s:%(lineno)s - %(funcName)20s() ] %(message)s,filename='dtobsgui.log',filemode='w'"
logging.basicConfig(format=FORMAT)
logger.setLevel(logging.DEBUG)


class WorkerSignals(QObject):
    """
    Defines the signals available from a running worker thread.

    Supported signals are:

    finished
        `int` of the setpoint number

    error
        `tuple` (exctype, value, traceback.format_exc() )

    result
        `object` data returned from processing, anything

    progress
        `int` inicating % progress
    """

    finished = pyqtSignal(int, str)
    allfinished = pyqtSignal()
    # error = pyqtSignal(tuple)
    # result = pyqtSignal(object)
    progress = pyqtSignal(int, int, str) # meas_num, percent_complete, remaining

class Worker(QRunnable):
    """ Execute a function asynchronously, connect to signals """

    def __init__(self, function_to_run, *args, **kwargs):
        super(Worker, self).__init__()
        # Store arguments
        self.function_to_run = function_to_run
        self.args = args
        self.kwargs = kwargs
        self.signals = WorkerSignals()

        self.kwargs['oneSetpointCompleteSignal'] = self.signals.finished
        self.kwargs['progressSignal'] = self.signals.progress

    @pyqtSlot()
    def run(self):
        """ Initialize the runner function with passed args, kwargs """

        self.function_to_run(*self.args, **self.kwargs)
        self.signals.allfinished.emit()

class DTObservationProgram(Ui_mainWindow):    
  
    def __init__(self, mainWindow):
        logger.info('Initialization of DTObsGUI')
        self.demo = config.getboolean('TestConfig','demo')
        
        if consoleHost is None:
            consoleHost = config.get('Console','HostName')
        if consoleHost == 'console':
            if socket.gethostname()=="mercurius":
                logging.warning("You are using the actual console, not a demo!")
            else:
                raise ValueError("Talking to the actual console can only be done from mercurius")
        
        logger.debug('Demo status is: {}'.format(self.demo))
     
        if not self.demo:
            self.myDT = telescope(setmode='J2000', consoleHost=consoleHost)
            '''
            telescopeMode and telescopeOffser required for meta data
            '''
            self.telescopeMode = 'J2000'
            self.telescopeOffset = Non
            
            '''
            As part of the init the current setpoint will be loaded as a single shot measurement.
            This enables the operator to manually define the setpoint using the Console
            '''
            self.myDT.setRaDec(self.myDT.getSetpoint_RaDec)
            self.radec = SkyCoord(self.myDT.getSetpoint_RaDec)
            (raStr, decStr)  = self.radec.to_string('hmsdms').split()
              
            self.tableWidgetPointings.insertRow(rowPosition)
            self.tableWidgetPointings.setItem(rowPosition, 0, QTableWidgetItem(raStr))
            self.tableWidgetPointings.setItem(rowPosition, 1, QTableWidgetItem(decStr))
            self.tableWidgetPointings.setItem(rowPosition, 2, QTableWidgetItem(""))
            self.tableWidgetPointings.setItem(rowPosition, 3, QTableWidgetItem(""))
            
        else:
            self.telescopeMode = None
            self.telescopeOffset = None
            

        self.myMeas = Measurements()
        self.myMetaData = MetaData()
        self.myBackend = Backend(setmode='Pulsar')
        
        self.radec = None
        self.measProgramma = None
        self.integrationTime = None
        self.inputFile = None
        self.outputDir = None
        self.outputFile = None
        self.GUIbackendMode = None

        Ui_mainWindow.__init__(self)
        self.setupUi(mainWindow)
        self.homedir = os.environ['HOME']
        self.lineEditOutputDir.setText(self.homedir)
        self.formCreatePointings = QWidget()
        
        '''
        Define slot and connections for GUI
        '''
        self.actionNew.triggered.connect(self.newPointingsDialog)
        self.actionOpen.triggered.connect(self.openFileNameDialog)
        self.actionSave_As.triggered.connect(self.saveFileNameDialog)
        self.actionClose.triggered.connect(self.closeMeasurement)
        self.actionQuit.triggered.connect(self.quitDTObs)
        self.pushButtonStartMeasurement.clicked.connect(self.startMeasurement)
        self.pushButtonStopMeasurement.clicked.connect(self.stopMeasurement)
        self.pushButtonOutputDirectory.clicked.connect(self.selectOutputDirectory)
        self.tableWidgetPointings.itemDoubleClicked.connect(self.viewResultMeasurement)

        '''
        Read the available tools from measurement Class and store them in the 
        comboBoxProgramma for selection.
        '''
        indexNR=0
        for tool in self.myMeas.getTools():
            self.comboBoxProgramma.setItemText(indexNR, tool)
            indexNR+=1

        self.threadpool = QThreadPool()
    
    def newPointingsDialog(self):
        self.myForm = CreatePointings(self.formCreatePointings)
        self.formCreatePointings.show()
        
    def openFileNameDialog(self):
        '''
        Clear tableWidget and read pointings from file
        '''
        self.inputFile,_ = QFileDialog.getOpenFileName(None, 'Open File', "templates","Pointing Files (*.pnt);;All Files (*)")
        if self.inputFile:
            self.loadPointingsInTable(self.inputFile)
        logger.info('Selected data file is: {}'.format(self.inputFile))
    
    def saveFileNameDialog(self):
        '''
        Clear tableWidget and read pointings from file
        '''
        saveFile,_ = QFileDialog.getSaveFileName(None, '|Save File', "templates","Pointing Files (*.pnt);;All Files (*)")
        saveFile = open(saveFile,'w')
        for meas in range(0,self.tableWidgetPointings.rowCount()):
            ra  = self.tableWidgetPointings.item(meas, 0).text()
            dec = self.tableWidgetPointings.item(meas, 1).text()
            pointing = SkyCoord(ra, dec, frame='icrs')
            saveFile.write('{}\t{}\t{}\n'.format(meas, pointing.ra.deg, pointing.dec.deg))
            logger.debug('{}\t{}\t{}\n'.format(meas, ra, dec))                 
            saveFile.flush()   
            
        logger.info('Save file as is: {}'.format(saveFile))
    
    def loadPointingsInTable(self,fileName):
        reader = csv.reader(open(self.inputFile),delimiter='\t')
        rowPosition = self.tableWidgetPointings.rowCount()    
        for meas, ra, dec in reader:
            self.radec = SkyCoord(float(ra)*u.degree, float(dec)*u.degree, frame='icrs')
            (raStr, decStr)  = self.radec.to_string('hmsdms').split()
              
            self.tableWidgetPointings.insertRow(rowPosition)
            self.tableWidgetPointings.setItem(rowPosition, 0, QTableWidgetItem(raStr))
            self.tableWidgetPointings.setItem(rowPosition, 1, QTableWidgetItem(decStr))
            self.tableWidgetPointings.setItem(rowPosition, 2, QTableWidgetItem(""))
            self.tableWidgetPointings.setItem(rowPosition, 3, QTableWidgetItem(""))

            rowPosition += 1

        self.tableWidgetPointings.resizeColumnsToContents()
        logger.info('Imported {} pointings'.format(rowPosition))
        
    def selectOutputDirectory(self):
        '''
        Select the output directory to store the measurements
        '''
        dialog = QFileDialog()
        folder_path = dialog.getExistingDirectory(None, "Select Folder",self.homedir)
        self.lineEditOutputDir.setText(folder_path)
        
    def closeMeasurement(self):
        for rowPosition in range(self.tableWidgetPointings.rowCount(),-1,-1):
            self.tableWidgetPointings.removeRow(rowPosition)

    def quitDTObs(self):
        logger.shutdown()
        sys.exit(app.exec_())

    def allCompleted(self):
        """ Callback function when all pointings completed """
        logger.info("All pointings completed")

    def measCompleted(self, meas_num, status):
        """ Make the meas_num-th row of the table green """
        colors = {'Completed': QtGui.QColor('green'),
                  'Slewing'  : QtGui.QColor('yellow'),
                  'Measuring': QtGui.QColor('cyan')}
        self.tableWidgetPointings.item(meas_num, 2).setText(status)
        self.tableWidgetPointings.setItem(meas_num, 3, QTableWidgetItem(self.outputFile))
        
        '''
        TODO
        '''
        #self.tableWidgetPointings.item(meas_num, 3).setText(measFile.name))

        for column in range(4):
            self.tableWidgetPointings.item(meas_num,column).setBackground(colors[status])
        self.tableWidgetPointings.resizeColumnsToContents()

    def goToSetpoints(self, setpoints, oneSetpointCompleteSignal=None, progressSignal=None):
        """ Send a list of setpoints to the telescope """
        for setpoint_nr, setpoint in enumerate(setpoints):
            if self.demo == False:
                self.myDT.setRaDec(setpoint)
                oneSetpointCompleteSignal.emit(setpoint_nr, 'Slewing')
                time.sleep(3)
                dist = np.sqrt(self.myDT.dist_el**2+self.myDT.dist_az**2)
                firstDist = dist
                while not dist < 0.01*u.deg:
                    percentSlew = max(100 - dist/firstDist*100, 0)
                    progressSignal.emit(setpoint_nr, percentSlew, "{:.3f}°".format(dist.value))
                    #print("{:.3f}".format(dist))
                    #print("{:2.0f}".format(percentSlew.value))
                    self.myDT.getDistance(waitForUpdate=True)
                    dist = np.sqrt(self.myDT.dist_el**2+self.myDT.dist_az**2)
                    
            oneSetpointCompleteSignal.emit(setpoint_nr, 'Measuring')
            self.doMeasurement(setpoint_nr, progressSignal=progressSignal)
            oneSetpointCompleteSignal.emit(setpoint_nr, 'Completed')

    def updateProgress(self, meas_num, progress_percent, remaining_str):
        """
        Update the table with some progress indicator

        meas_num: the row which needs to be updated
        progress_percent: integer giving the percentage complete
        remaining_str: string indicating how much remaining, e.g. "1:30" or "3°"
        """
        #self.tableWidgetPointings.item(meas_num, 2).setText(remaining_str)
        self.tableWidgetPointings.item(meas_num, 2).setText(str(progress_percent)+"%")

    def setMetaData(self):
        '''
        Define metadata
        '''   
        self.myMetaData.description = self.textEditDescription.toPlainText()
        self.myMetaData.startTime = time.strftime("%Y%m%d-%H%M%S")
        self.myMetaData.operator1 = self.lineEditOperator1.text()
        self.myMetaData.operator2 = self.lineEditOperator2.text()
        self.myMetaData.operator3 = self.lineEditOperator3.text()
        self.myMetaData.tool = self.measProgramme 
        self.myMetaData.integrationTime = self.integrationTime        
        self.myMetaData.outputDirectory = self.outputDir
        self.myMetaData.outputFile = self.outputFile
        self.myMetaData.radecSetpoint = self.radec
        self.myMetaData.radecActual = self.radec
        self.myMetaData.telescopeMode = self.telescopeMode
        self.myMetaData.telescopeOffset = self.telescopeOffset
        
        '''
        TODO: read radec Actual from telescope class
        '''
        self.myMetaData.refractionEnabled = self.checkBoxRefraction.isChecked()
        logger.debug('checkBoxRefraction Setting is {}:'.format(self.checkBoxRefraction.isChecked()))
        self.myMetaData.DTModelEnabled = self.checkBoxDTModel.isChecked()
        self.myMetaData.mode = self.GUIbackendMode
        self.myMetaData.LSREnabled = self.radioButtonLSR.isChecked()

    def writeMetaData(self,file):
        myMetaData = self.myMetaData.getMetaData()
        for data in myMetaData:
            logger.info('#{:20}: {:40}'.format(data[0],str(data[1])))
            file.write('#{:20}: {:40}\n'.format(data[0],str(data[1])))      
 
    def doMeasurement(self, measnum, progressSignal=None):
        """ 
        Dumping data into file including meta-data
        measProgramme: cli command read from comboBoxProgramma
        integrationTime: string read from spinBoxIntTime
        measurement: result of measurement of which 
        data: is the stdout result which need to be stored line by line
        measFile: result file storing the stdout results including meta data
        """
        self.integrationTime = self.spinBoxIntTime.value()
        self.centralFrequency = self.spinBoxCentralFrequency.value()
        self.measProgramme = self.comboBoxProgramma.currentText()
        self.outputDir = self.lineEditOutputDir.text() + '/'
        self.outputFile = 'DT-' + '{:03d}'.format(measnum) + '-' + time.strftime("%Y%m%d") + '.dat'
        measFile = open(self.outputDir + self.outputFile,'w')
        
        self.setMetaData()
        self.writeMetaData(measFile)
                
        logger.info("Output to file: {}".format(measFile))
        
        self.myMeas.startMeasurement(self.measProgramme, self.centralFrequency, self.integrationTime, measFile)

        for sec in range(self.integrationTime):
            remainstring =  str(int((self.integrationTime-sec)/60)) + ":"
            remainstring += "{:02}".format((self.integrationTime-sec)%60)
            progressSignal.emit(measnum, int(float(sec)/self.integrationTime*100), remainstring)
            time.sleep(1)
        measFile.close()      
    
    def readGUIBackendMode(self):
        '''
        Read the selected Backend mode from the GUI backend checkbox group
        '''
        if self.radioButtonPulsar.isChecked():
            self.GUIbackendMode = 'Pulsar'
        if self.radioButtonHydrogenLine.isChecked():
            self.GUIbackendMode = 'Hydrogen'
        if self.radioButtonSDR.isChecked():
            self.GUIbackendMode = 'SDR'
        if self.radioButtonRaw.isChecked():
            self.GUIbackendMode = 'Raw'
                    
    def startMeasurement(self):
        '''
        Put backend in proper mode
        '''
        logger.info('Start Measurement')
        self.readGUIBackendMode()
        self.myBackend.setMode(self.GUIbackendMode)       
        
        setpoints = []
        for meas in range(0,self.tableWidgetPointings.rowCount()):
            ra  = self.tableWidgetPointings.item(meas, 0).text()
            dec = self.tableWidgetPointings.item(meas, 1).text()

            self.tableWidgetPointings.item(meas, 2).setText("Scheduled")
            self.tableWidgetPointings.resizeColumnsToContents()
            setpoint = SkyCoord(ra, dec, frame='icrs')
            setpoints.append(setpoint)

        worker = Worker(self.goToSetpoints, setpoints)
        worker.signals.finished.connect(self.measCompleted)
        worker.signals.allfinished.connect(self.allCompleted)
        worker.signals.progress.connect(self.updateProgress)
        self.threadpool.start(worker)

    def stopMeasurement(self):
        worker.signals.allfinished.connect(self.allCompleted)
        logger.info("Measurement stopped")

    def viewResultMeasurement(self):
        currentRow = self.tableWidgetPointings.currentRow()
        resultFile = self.tableWidgetPointings.item(currentRow,3).text()
        logger.debug('Selected row is: {}'.format(currentRow))
        logger.info('Show result in gnuplot for file: {}'.format(resultFile))
        '''
        TODO:
        Create a plot file:
        marc@gamma2:~> cat temp.plg 
        set title datafile
        set grid
        plot datafile w l
        pause -1

        and call gnuplot as:
        gnuplot -e "datafile='DT-002-20171029.dat'" temp.plg
        '''
               
if __name__ == '__main__':
    app = QApplication(sys.argv)
    mainWindow = QMainWindow()
    prog = DTObservationProgram(mainWindow)
    mainWindow.show()

    sys.exit(app.exec_())