`9Sc@smddlZddlZddlZddlZddlTddlmZdgZde fdYZ dS(iN(t*(ttxtt MatlabProcesscBseZdZeZeeZeeZdZ ddZ dZ dZ ddZdZdZd Zd Zed Zedd Zed ZdZdZdZdZdZdZRS(s Base class for wrappers around standalone optimization procedures implemented in Matlab language. Call 'startRetrieval' to launch the Matlab process; use 'getErrorMessage' and 'getRetrievalOutput' to get the retrieval results upon completion. Signals: - 'retrievalFinished': the retrieval process has either successfully completed or terminated with an error. - 'outputAvailable(outputLine)': new line of text has been printed by the Malab application to either standard output or standard error stream. - 'iterationCompleted(iterCount)': a new iteration has been completed by the optimization process. 'iterCount' is the number of the iteration, starting with 0 for the initial approximation. Matlab scripts (named '.m') are assumed to be stored in the 'code/binary/MATLAB' subdirectory of the program package root, so that compiled Matlab executables are placed in 'code/binary/MATLAB//distrib'. Auxiliary data files in HDF5 format (with a predefined structure) are used to pass input data as well as optimization results (including the whole set of intermediate data that realized during the steps of the iterative process) to and from the Matlab program. Data type used to represent the retrieval results is not predetermined; the value returned by 'readOutputData' actually defines it. Redefine 'getMatlabProgramName' method to specify the name of the Matlab application. Redefine 'writeInputData' along with 'readOutputData' to implement the procedure of passing the data to and from the auxiliary data file. Use 'extendArray', 'readArray', and 'readScalar' for assistance in the process of data preparation and extraction, if required.cCstj|tjjd|jd}tjj||jd|_tjj|d|_t|_ |j j tj |j j j |j|j jj |j|j jj |jd|_d|_dS(Nscode/binary/MATLABtdistribs.exesdata.h5(tQObjectt__init__tostpathtjointgetMatlabProgramNametapplicationFilePatht dataFilePathtQProcesst matlabProcesstsetProcessChannelModetMergedChannelst readyReadtconnecttonOutputAvailableterrortonProcessErrortfinishedtonProcessFinishedtNonet errorMessagetretrievalOutputs(tselft matlabDir((scode\MatlabProcess.pyRGs     cCs|dk r,||_tjd|jdSy|jWn6tjk rr}|j|_tjd|jdSX|j j t j j |j|j j|jdS(sLaunch the optimization process and return immediately. If 'errorMessage' is not 'None', the optimization process won't start, and 'retrievalFinished' signal will be fired as soon as program control returns to the application event loop (with 'getErrorMessage' returning the specified error message). The same thing will happen (but with a different error message) if problems would arise during initialization of the auxiliary data file.iN(RRtQTimert singleShott onInitFailedtwriteMatlabInputRtErrorttextR tsetWorkingDirectoryRRtdirnameR tstartR (RRte((scode\MatlabProcess.pytstartRetrieval`s    cCs=|jjj|j|jjj|j|jjdS(saStop the running retrieval process or do nothing if the process has not been started yet.N(R Rt disconnectRRRtkill(R((scode\MatlabProcess.pytcancelRetrievalscCs|jS(sReturn a rich text message describing a failed retrieval or 'None' if the retrieval has succeeded or has not finished yet.(R(R((scode\MatlabProcess.pytgetErrorMessagesicCs|jdkrdS|j|S(sRReturn a data instance (specific to the particular optimization procedure) describing a successful retrieval, or 'None' if the retrieval has failed or has not finished yet. If 'iteration' is not '-1', optimization process snapshot at the given iteration is returned instead of the final retrieval results.N(RR(Rt iteration((scode\MatlabProcess.pytgetRetrievalOutputscCs|jS(sReturn the complete list of the output data instances (specific to the particular optimization procedure), representing optimization process snapshots for all the iterations.(R(R((scode\MatlabProcess.pytgetAllRetrievalOutputsscCsdS(spReturn the name of the Matlab script performing the optimization procedure (without the '.m' extension).N(R(R((scode\MatlabProcess.pyR scCsdS(s)Write data required by the optimization process to the 'input' subgroup of the auxiliary HDF5 file. The 'input' HDF group (passed as the argument) is opened for writing. Apart from the name of the group, there are no restrictions imposed on the format of the data.N((RthdfGroup((scode\MatlabProcess.pytwriteInputDatascCsdS(sExtract data describing the given iteration of the optimization process from the 'output' subgroup of the auxiliary data file, returning a proper data instance. If the format of the data file is invalid, raise 'txt.Error' exception using the given error prefix. The 'output' HDF group (passed as the argument) is opened for reading. This group must contain a scalar integer dataset named 'iterCount' containing the total number of iterations (including the initial appoximation, i.e. the zeroth one) that have been realized in the optimization process. Apart from the name of the output group and the 'iterCount' dataset, there are no restrictions imposed on the format of the data. Nevertheless, these data should contain information about any of the iterations of the optimization process (normally, that should be achieved by adding an extra dimension to the respective HDF datasets).N(R(RR.R+t errorPrefix((scode\MatlabProcess.pytreadOutputDatascCsu||t|kstt|dks4ttj|tj}||||t|+|d|d|+|S(sReturn a copy of the given Numpy array converted to 'float64' data type, padded with 'firstDataIndex' copies of its first element at the beginning and with appropriate number of zeros at the end, so that the final length of the array is 'extendedSize'.i(tlentAssertionErrortnumpytzerostfloat64(t dataArraytfirstDataIndext extendedSizetextArray((scode\MatlabProcess.pyt extendArrays c Csy||}Wn1tk rAtj|dtj|nXy|||f}Wn1tk rtj|dtj|nXtj|dtj}|dk r|t |krtj ||f}n|S(s}Return a Numpy array with 'float32' data type corresponding to the 'arrayIndex' row and 'iteration' layer (3-rd dimension) of an 'hdfGroup's 3-dimensional dataset with the given name. If 'arraySize' is not 'None', return at most 'arraySize' first elements of the dataset row only. Raise 'txt.Error' using the given error prefix on failure.sthere is no dataset named %ss%s dataset has invalid shapetdtypeN( tKeyErrorRR tquotet ValueErrorR4tarraytfloat32RR2tresize( R.t datasetNamet arrayIndexR+R0t arraySizetdatasett arrayDataR7((scode\MatlabProcess.pyt readArrays     cCsWtj|||||}|jdkrMtj|dtj|nt|S(s Same as 'readArray', but assume that the resulting array length is 1 and return a scalar floating-point value representing that single array element. Raise 'txt.Error' using the given error prefix if the array has an unexpected shape.is%s dataset has invalid shape(i(RRHtshapeRR R>tfloat(R.RCRDR+R0tdata((scode\MatlabProcess.pyt readScalars   cCs~yGtj|jd}z |jd}|j|Wd|jXWn0tk rytjdtj |jnXdS(s.Prepare input file for the Matlab application.twtinputNs*Failed to write the Matlab input file (%s)( th5pytFileR t create_groupR/tclosetIOErrorRR t quotePath(RthdfFilet inputGroup((scode\MatlabProcess.pyRs  c Csg}ytj|jd}Wn0tk rQtjdtj|jnXzdtj|j}y|d}Wn1tk rtj|dtjdnXy|d}Wn1tk rtj|dtjdnXt j |}|j d kr0tj|d tjdnt |}x0t |D]"}|j|j|||qIWWd |jX|S( s&Construct a list of the output data instances representing snapshots of the optimization process at different iterations, based on the Matlab application output file. Final retrieval results will normally be represented by the last element of the returned list.trs*Failed to read the Matlab output file (%s)s,Failed to read the Matlab output file (%s): toutputsthere is no group named %st iterCountsthere is no dataset named %sis%s dataset has invalid shapeN(i(RORPR RSRR RTR=R>R4R@RItinttrangetappendR1RR( RRRUtinvalidFormatPrefixt outputGroupt iterDatasett iterArrayRYR+((scode\MatlabProcess.pytreadMatlabOutput+s:          cCs|jjdS(N(tretrievalFinishedtemit(R((scode\MatlabProcess.pyRcscCsx|jjrt|jj}|jdr<qn|jj|tjd|}|dk r|j jt |j dqqWdS(NsMATLAB:I18n:InconsistentLocales#\s+(\d+)\s+\d+\s+\d\.\d+e[+-]\d+\s+i( R t canReadLinetQStringtreadLinet startsWithtoutputAvailableRctretmatchRtiterationCompletedRZtgroup(Rt outputLinetmatchObj((scode\MatlabProcess.pyRgs   cCsU|tjkr+dtj|j|_ndtj|j|_|jjdS(Ns+Failed to start the retrieval algorithm: %ss)Failed to run the retrieval algorithm: %s(R t FailedToStartRRTR RRbRc(Rt processError((scode\MatlabProcess.pyRzs cCs\|jdk rdSy|j|_Wn"tjk rJ}|j|_nX|jjdS(N( RRRaRRR R!RbRc(RtexitCodet exitStatusR%((scode\MatlabProcess.pyRsN(t__name__t __module__t__doc__t pyqtSignalRbReRhRZRkRRR&R)R*R,R-R R/R1t staticmethodR;RHRLRRaRRRR(((scode\MatlabProcess.pyRs.!     $      8   ( ROR4tos.pathRRit PyQt4.QtCoret common.utilsRt__all__RR(((scode\MatlabProcess.pyts