(Commit a65ccc9... : jennings : 2016-03-15 14:00:18 -0500)

#include "qxrddebug.h"
#include "qxrdscriptengine.h"
#include "qxrdapplication.h"
#include "qxrdwindow.h"
#include "qxrdexperiment.h"
#include "qxrdacquisition.h"
#include "qxrdcenterfinder.h"
#include "qxrddataprocessor.h"
#include "qxrdcalibrantlibrary.h"
#include "qxrdcalibrant.h"
#include "qxrdintegrator.h"
#include "qcepmutexlocker.h"
#include "qxrdgeneratetestimage.h"
#include "qxrdsynchronizedacquisition.h"
#include "qxrdnidaqplugininterface.h"
#include "qxrdacquisitionextrainputs.h"
#include "qcepallocator.h"
#include "qxrdserver.h"
#include "qxrdsimpleserver.h"
#include "qcepdocumentationdictionary.h"
#include "qcepdatagroup.h"
#include "qcepdatagroup-ptr.h"
#include "qcepdataarray.h"
#include "qcepdataarray-ptr.h"
#include "qcepdatacolumn.h"
#include "qcepdatacolumn-ptr.h"
#include "qcepdatacolumnscan.h"
#include "qcepdatacolumnscan-ptr.h"
#include "qcepdatasetmodel.h"
#include "qxrddetectorprocessor.h"
#include "qxrdroicalculator.h"
#include "qxrdroicoordinates.h"
#include "qxrdroicoordinateslistmodel.h"
#include <QThread>
#include <QDir>
#include <QScriptValueIterator>
#include <QMetaObject>
#include <QMetaProperty>
#include <QRegExp>

Include dependency graph for qxrdscriptengine.cpp:

Go to the source code of this file.

Functions
	QCEP_DOC_FUNCTION ("print","print([value]...)","Print values to the log file and message window","<p>The values of the arguments are catenated into a single string which is ""printed to the log file and to the message window</p>\n""<p>The following is a typical use: print out the names and values of the ""elements of an object:</p>\n""<code>""for(i in acquisition) print(i, acquisition[i])""</code>") QScriptValue QxrdScriptEngine

	QCEP_DOC_FUNCTION ("fopen","fopen(fileName)","Open a script output file","<p>The fileName given is opened as the current output file ussed by fprint</p>\n""<p>Only one script output file may be open at a time</p>\n") QScriptValue QxrdScriptEngine

	QCEP_DOC_FUNCTION ("fprint","fprint([value]...)","Print values to the script output file","<p>The values of the arguments are catenated into a single string which is ""printed to the script output file</p>\n""<p>The following is a typical use: print out the names and values of the ""elements of an object:</p>\n""<code>""for(i in acquisition) fprint(i, acquisition[i])""</code>") QScriptValue QxrdScriptEngine

	QCEP_DOC_FUNCTION ("fclose","fclose()","Closes the script output file","<p>Note that only one script output file may be open at a time</p>\n") QScriptValue QxrdScriptEngine

	QCEP_DOC_FUNCTION ("fdelete","fdelete(path)","Deletes a file","<p>If the file does not exist no error occurs</p>") QScriptValue QxrdScriptEngine

	QCEP_DOC_FUNCTION ("acquire","acquire([fileName[, exposure[, summedExposures[, postTriggerFiles[, preTriggerFiles[, nPhases]]]]]])","Start acquisition of a sequence of images","<p>The arguments are optional and may be successively omitted from the ""right. If <i>preTriggerFiles</i> is omitted, zero is used instead. ""If <i>nPhases</i> is omitted, one is used. ""Any other argument which is omitted will take its value ""instead from the values entered in the acquire dialog. Any ""argument which is given will replace the corresponding value ""in the acquire dialog.</p>\n""<p>Note that the script function merely starts the acquisition ""- you should use the separate \"status\" function to wait for ""acquisition and processing to be completed.</p>\n""<p>The following is a typical example of the use of this ""command from spec:</p>\n""<code>""def PEexp(filename,exposure,subframes,frames) '{<br/>""  remote_eval(PEHOST,""sprintf(\"acquire(\\\"%s\\\",%g,%d,%d,0)\",filename,exposure,subframes,frames));<br/>""  <br/>   PEwait()<br/> }'<br/>""</code>") QScriptValue QxrdScriptEngine

	QCEP_DOC_FUNCTION ("acquireDark","acquireDark([filename [,exposure [,darkSummedExposures]]])","Start acquisition of a dark image","<p>Arguments are optional and, if given, will replace the ""corresponding value in the acquire dialog, if not given the ""dialog values are used.</p>\n""<p>The following is a typical example of the use of this ""command from spec:</p>\n""<code>\n""def PEexpd(filename, exposure, subframes) '{<br/>\n""  remote_eval(PEHOST,""sprintf(\"acquireDark(\\\"%s\\\",%g,%d)\",filename,exposure,subframes));<br/>\n""  <br/>   PEwait()<br/> }'<br/>\n""</code>\n") QScriptValue QxrdScriptEngine

	QCEP_DOC_FUNCTION ("status","status([time])","Test if acquisition and processing have finished","<p>""If the argument is given the function will wait up to that ""many seconds - if acquisition and processing finish before ""the time elapsed then <code>status</code> will return at ""that time, otherwise at the end of the timeout period. The ""function returns a non-zero result if acquisition and ""processing are complete, or zero if they are not.""</p>\n""<p>""If no argument is given the function tests if acquisition ""and processing are complete and returns the result of the ""test immediately.""</p>\n""<p>""The following is a typical use of this command from spec:""</p>\n""<code>""def PEwait() '{<br/>""  while(remote_eval(PEHOST,\"status(1.0)\")==0) {<br/>""  }<br/> }'<br/>""</code>\n") QScriptValue QxrdScriptEngine

	QCEP_DOC_FUNCTION ("acquireStatus","acquireStatus([time])","Test if acquisition has finished","<p>""Similar to 'status' ""except that it only tests for the acquisition operation being complete.""</p>") QScriptValue QxrdScriptEngine

	QCEP_DOC_FUNCTION ("processStatus","processStatus([time])","Test if processing has finished","<p>""Similar to 'status' ""except that it only tests for the processing operation being complete.""</p>") QScriptValue QxrdScriptEngine

	QCEP_DOC_FUNCTION ("acquireCancel","acquireCancel()","Cancel the current acquisition operation","") QScriptValue QxrdScriptEngine

	QCEP_DOC_FUNCTION ("acquireScalers","vals <- acquireScalers()","Returns the scaler counts values for the latest acquisition operation","") QScriptValue QxrdScriptEngine

	QCEP_DOC_FUNCTION ("trigger","trigger()","Trigger triggered acquisition","<p>If 'preTriggerFiles' is greater than zero then acquisition operations proceed in the ""'triggered' mode. This acts much like a digital oscilloscope trigger where a certain number ""('preTriggerFiles') of acquired images are held in the computer RAM until the trigger operation occurs ""and then the most recent acquired images are written to disk, along with a number of post-trigger images</p>") QScriptValue QxrdScriptEngine

	QCEP_DOC_FUNCTION ("exposureTime","exposureTime([time])","Get or set the acquisition exposure time (also for dark exposures)","<p>If the time argument is given, set the exposure time, otherwise return the ""current exposure time</p>""<p>This function provides a convenient method to access the ""<code>acquisition.exposureTime</code> property</p>") QScriptValue QxrdScriptEngine

	QCEP_DOC_FUNCTION ("summedExposures","summedExposures([n])","Get or set the number of summed exposures for acquisition","<p>If the n argument is given, set the number of summed exposures, otherwise return the ""current value.</p>""<p>Easy access to <code>acquisition.summedExposures</code></p>") QScriptValue QxrdScriptEngine

	QCEP_DOC_FUNCTION ("skippedExposures","skippedExposures([n])","Get or set the number of skipped exposures for acquisition","<p>If the n argument is given, set the number of skipped exposures, otherwise return the ""current value.</p>""<p>Easy access to <code>acquisition.skippedExposures</code></p>") QScriptValue QxrdScriptEngine

	QCEP_DOC_FUNCTION ("darkSummedExposures","darkSummedExposures([n])","Get or set the number of summed exposures for dark acquisition","<p>If the n argument is given, set the number of summed exposures, otherwise return the ""current value.</p>""<p>Easy access to <code>acquisition.darkSummedExposures</code></p>") QScriptValue QxrdScriptEngine

	QCEP_DOC_FUNCTION ("phasesInGroup","phasesInGroup([n])","Get or set the number of phases for synchronized acquisition","<p>If the n argument is given, set the number of phases, otherwise return the ""current value.</p>""<p>Easy access to <code>acquisition.phasesInGroup</code></p>") QScriptValue QxrdScriptEngine

	QCEP_DOC_FUNCTION ("preTriggerFiles","preTriggerFiles([n])","Get or set the number of pre-trigger file groups for triggered acquisition","<p>If the n argument is given, set the number of pre-trigger file groups, otherwise return the ""current value.</p>""<p>Easy access to <code>acquisition.preTriggerFiles</code></p>") QScriptValue QxrdScriptEngine

	QCEP_DOC_FUNCTION ("postTriggerFiles","postTriggerFiles([n])","Get or set the number of post-trigger file groups for triggered acquisition","<p>If the n argument is given, set the number of post-trigger file groups, otherwise return the ""current value.</p>""<p>Easy access to <code>acquisition.postTriggerFiles</code></p>") QScriptValue QxrdScriptEngine

	QCEP_DOC_FUNCTION ("filePattern","filePattern([pattern])","Get or set the acquisition file name pattern","<p>If the pattern argument is given, set the file name pattern, otherwise return the ""current value.</p>""<p>Easy access to <code>acquisition.filePattern</code></p>") QScriptValue QxrdScriptEngine

	QCEP_DOC_FUNCTION ("outputDirectory","outputDirectory([dir])","Get or set the acquisition output directory","<p>If the dir argument is given, set the output directory, otherwise return the ""current value.</p>""<p>Easy access to <code>experiment.dataDirectory</code></p>") QScriptValue QxrdScriptEngine

	QCEP_DOC_FUNCTION ("fileIndex","fileIndex([n])","Get or set the acquisition file index","<p>If the n argument is given, set the file index, otherwise return the ""current value.</p>""<p>Easy access to <code>acquisition.fileIndex</code></p>") QScriptValue QxrdScriptEngine

	QCEP_DOC_FUNCTION ("data","data()","Get the current image","<p>Returns a reference to the most recently acquired or most recently loaded image.</p>""<p>The returned object can have its properties queried.</p>""<p>Note that the value returned by this function will change as each ""new image is acquired so be careful if calling this function during acquisition.</p>") QScriptValue QxrdScriptEngine

	QCEP_DOC_FUNCTION ("dark","dark()","Get the dark image (or null if none has been taken)","<p>Returns a reference to the current dark image.</p>""<p>The returned object can have its properties queried.</p>""<p>For example, to get the file name of the dark image:</p>""<code>print(dark().fileName)</code>""<p>Or to show a list of properties of the dark image:</p>""<code>for(i in dark()) print(i, dark()[i])</code>") QScriptValue QxrdScriptEngine

	QCEP_DOC_FUNCTION ("mask","mask()","Get the top item of the mask stack","<p>Returns a reference to the top of the mask stack, or null if the ""mask stack is empty.</p>") QScriptValue QxrdScriptEngine

	QCEP_DOC_FUNCTION ("overflow","overflow()","Get the overflow pixel map for acquired images","<p>Returns the overflow pixels map for the most recently acquired image ""(if overflow processing is enabled)</p>\n""<p>The overflow map is non-zero wherever an image pixel exceeded the overflow ""threshold during acquisition. Where more than one exposures are summed, the overflow ""map will count the number of exposures for which the pixel overflowed.</p>") QScriptValue QxrdScriptEngine

	QCEP_DOC_FUNCTION ("liveData","liveData()","Get the current live view image","<p>Returns a reference to the most recently acquired live view image.</p>""<p>The returned object can have its properties queried.</p>""<p>Note that the value returned by this function will change as each ""new live view image is acquired so be careful when calling this function.</p>") QScriptValue QxrdScriptEngine

	QCEP_DOC_FUNCTION ("help","help([name...])","Returns help text for a given name or names","<p>Returns a string containing an html representation of the help text ""for a name or names. If more than one name is given the result is the ""concatenation of the help for each name in turn</p>""<p>The names may contain wildcard characters, the result will contain help ""for all available matching the wildcard patterns.</p>""<p>If no name is given the command returns help for the help command itself.</p>""<p>If the command is executed in the QXRD script window the html result will ""be properly formatted in the message window.</p>""<p>For example:</p>""<code>help(\"help\")</code>") QScriptValue QxrdScriptEngine

	QCEP_DOC_FUNCTION ("extraChannel","extraChannel(n)","Access channels for extra inputs","<p>Returns a reference to configuration data for an extra input channel.</p>""<p>Example: to access the acquired waveform for extra channel 0</p>""<code>extraChannel(0).waveform</code>") QScriptValue QxrdScriptEngine

	QCEP_DOC_FUNCTION ("process","process(filename [, norm...])","Load and process an image file","<p>Load and process the file filename. The norm arguments are used as ""normalization values during processing</p>""<p>The function is closely related to</p>""<code>processor.processNormalizedFile(QString,QDoubleList)</code>") QScriptValue QxrdScriptEngine

	QCEP_DOC_FUNCTION ("setFileNormalization","setFileNormalization(filename [, norm...])","Set the normalization values for an image file","<p>Loads the file filename, sets its normalization values and ""rewrites the metadata file</p>""<p>The function is closely related to</p>""<code>processor.setFileNormalization(QString,QDoubleList)</code>") QScriptValue QxrdScriptEngine

	QCEP_DOC_FUNCTION ("matchFiles","matchFiles([pattern]...)","Return a list of files matching a pattern","<p>Returns a list of file names matching the provided pattern(s).</p>""<p>The patterns support 'wild card' characters sush as * and ?.</p>""<p>Example - to calculate the sum of the pixel intensity of pixel 100,100 in ""all the TIFF files in the current directory:</p>""<code>var sum=0;<br/>\n""for(f in matchFiles(\"*.tif\") {<br/>\n""  processor.loadData(f);<br/>\n""  sum += data().getImageData(100,100);<br/>\n""}<br>") QScriptValue QxrdScriptEngine

	QCEP_DOC_FUNCTION ("mapUserFunction","mapUserFunction(functionname)","Map a user function over current data","") QScriptValue QxrdScriptEngine

	QCEP_DOC_FUNCTION ("timeStamp","timeStamp()","Returns system time as seconds since unix epoch","") QScriptValue QxrdScriptEngine

	QCEP_DOC_FUNCTION ("newDataGroup","newDataGroup(name)","Creates a new named data group","") QScriptValue QxrdScriptEngine

	QCEP_DOC_FUNCTION ("newDataArray","newDataArray(name,dim1 .. dimn)","Creates a new named n-dimensional data array","") QScriptValue QxrdScriptEngine

	QCEP_DOC_FUNCTION ("newDataColumn","newDataColumn(name, npts)","Creates a new named data column","") QScriptValue QxrdScriptEngine

	QCEP_DOC_FUNCTION ("newDataColumnScan","newDataColumnScan(name, npts, col1name .. colnname)","Creates a new named data column scan","") QScriptValue QxrdScriptEngine

	QCEP_DOC_FUNCTION ("newDataImage","newDataImage(name, width, height)","Creates a new named data image","") QScriptValue QxrdScriptEngine

	QCEP_DOC_FUNCTION ("newIntegratedData","newIntegratedData(name, size)","Creates a new integrated data object","") QScriptValue QxrdScriptEngine

	QCEP_DOC_FUNCTION ("detector","detector(n)","Returns a reference to the 'n'th detector","") QScriptValue QxrdScriptEngine

	QCEP_DOC_FUNCTION ("roi","roi(n,m)","Returns a reference to the 'm'th ROI of the 'n'th detector","") QScriptValue QxrdScriptEngine

	QCEP_DOC_OBJECT ("JSON","Qt Built-in JSON Parser") QCEP_DOC_FUNCTION("JSON.parse"

JSON	parse (string)"

JSON Parse a string as a JSON< p > A built in function in the Qt script system</p >	QCEP_DOC_FUNCTION ("JSON.stringify","JSON.stringify(object)","Produce JSON string representation of an object","<p>A built-in function in the Qt script system</p>") QCEP_DOC_FUNCTION("Math"

Variables
JSON Parse a string as a JSON	object

Function Documentation

JSON parse ( string )

QCEP_DOC_FUNCTION	(	"print"	,
		"print([value]...)"	,
		"Print values to the log file and message window"	,
		"<p>The values of the arguments are catenated into a single string which is ""printed to the log file and to the message window</p>\n""<p>The following is a typical use: print out the names and values of the ""elements of an object:</p>\n""<code>""for(i in acquisition) print(i, acquisition[i])""</code>"
	)

Definition at line 286 of file qxrdscriptengine.cpp.

References QxrdScriptEngine::experiment().

                                       : print out the names and values of the "
     "elements of an object:</p>\n"
     "<code>"
     "for(i in acquisition) print(i, acquisition[i])"
     "</code>"
     )
 
 QScriptValue QxrdScriptEngine::printFunc(QScriptContext *context, QScriptEngine *engine, void * /*u*/)
 {
   QxrdScriptEngine *eng = qobject_cast<QxrdScriptEngine*>(engine);
 
   if (eng) {
     int nArgs = context->argumentCount();
     QString msg;
 
     for (int i=0; i<nArgs; i++) {
       if (i != 0) {
         msg += " ";
       }
 
       msg += context -> argument(i).toString();
     }
 
     QxrdExperimentPtr expt(eng->experiment());
 
     if (expt) {
       expt->printLine(msg);
     }
   }
 
   return QScriptValue(engine, 1);
 }

Here is the call graph for this function:

QCEP_DOC_FUNCTION	(	"fopen"	,
		"fopen(fileName)"	,
		"Open a script output file"	,
		"<p>The fileName given is opened as the current output file ussed by fprint</p>\n""<p>Only one script output file may be open at a time</p>\n"
	)

Definition at line 325 of file qxrdscriptengine.cpp.

References QxrdScriptEngine::openScriptOutput().

 {
   QxrdScriptEngine *eng = qobject_cast<QxrdScriptEngine*>(engine);
 
   if (eng) {
     int nArgs = context->argumentCount();
 
     if (nArgs >= 1) {
       eng -> openScriptOutput(context -> argument(0).toString());
     }
   }
 
   return QScriptValue(engine, 1);
 }

Here is the call graph for this function:

QCEP_DOC_FUNCTION	(	"fprint"	,
		"fprint([value]...)"	,
		"Print values to the script output file"	,
		"<p>The values of the arguments are catenated into a single string which is ""printed to the script output file</p>\n""<p>The following is a typical use: print out the names and values of the ""elements of an object:</p>\n""<code>""for(i in acquisition) fprint(i, acquisition[i])""</code>"
	)

Definition at line 348 of file qxrdscriptengine.cpp.

References QxrdScriptEngine::writeScriptOutput().

                                       : print out the names and values of the "
     "elements of an object:</p>\n"
     "<code>"
     "for(i in acquisition) fprint(i, acquisition[i])"
     "</code>"
     )
 
 QScriptValue QxrdScriptEngine::fprintFunc(QScriptContext *context, QScriptEngine *engine, void * /*u*/)
 {
   QxrdScriptEngine *eng = qobject_cast<QxrdScriptEngine*>(engine);
 
   if (eng) {
     int nArgs = context->argumentCount();
     QString msg;
 
     for (int i=0; i<nArgs; i++) {
       if (i != 0) {
         msg += " ";
       }
 
       msg += context -> argument(i).toString();
     }
 
     eng -> writeScriptOutput(msg);
   }
 
   return QScriptValue(engine, 1);
 }

Here is the call graph for this function:

QCEP_DOC_FUNCTION	(	"fclose"	,
		"fclose()"	,
		"Closes the script output file"	,
		"<p>Note that only one script output file may be open at a time</p>\n"
	)

Definition at line 383 of file qxrdscriptengine.cpp.

References QxrdScriptEngine::closeScriptOutput().

 {
   QxrdScriptEngine *eng = qobject_cast<QxrdScriptEngine*>(engine);
 
   if (eng) {
     eng -> closeScriptOutput();
   }
 
   return QScriptValue(engine, 1);
 }

Here is the call graph for this function:

QCEP_DOC_FUNCTION	(	"fdelete"	,
		"fdelete(path)"	,
		"Deletes a file"	,
		"<p>If the file does not exist no error occurs</p>"
	)

Definition at line 401 of file qxrdscriptengine.cpp.

 {
   QxrdScriptEngine *eng = qobject_cast<QxrdScriptEngine*>(engine);
 
   bool res = false;
 
   if (eng) {
     QString path = context -> argument(0).toString();
 
     if (path.length() > 0) {
       res = QFile::remove(path);
     }
   }
 
   return QScriptValue(engine, res);
 }

QCEP_DOC_FUNCTION	(	"acquire"	,
		"acquire([fileName[, exposure[, summedExposures[, postTriggerFiles[, preTriggerFiles[, nPhases]]]]]])"	,
		"Start acquisition of a sequence of images"	,
		"<p>The arguments are optional and may be successively omitted from the ""right. If <i>preTriggerFiles</i> is	omitted,
		zero is used instead." "If< i >nPhases</i > is	omitted,
		one is used." "Any other argument which is omitted will take its value" "instead from the values entered in the acquire dialog.Any" "argument which is given will replace the corresponding value" "in the acquire dialog.</p >\n" "< p >Note that the script function merely starts the acquisition" "-you should use the separate\"status\" function to wait for ""acquisition and processing to be completed.</p>\n""<p>The following is a typical example of the use of this ""command from spec:</p>\n""<code>""def PEexp(filename,exposure,subframes,frames) '{<br/>""  remote_eval(PEHOST,""sprintf(\"acquire(\\\"%s\\\",%g,%d,%d,0)\",filename,exposure,subframes,frames));<br/>""  <br/>   PEwait()<br/> }'<br/>""</code>"
	)

Definition at line 425 of file qxrdscriptengine.cpp.

References QxrdScriptEngine::acquisition().

                       :</p>\n"
     "<code>"
     "def PEexp(filename,exposure,subframes,frames) '{<br/>"
     "&nbsp;&nbsp;remote_eval(PEHOST,"
     "sprintf(\"acquire(\\\"%s\\\",%g,%d,%d,0)\",filename,exposure,subframes,frames));<br/>"
     "&nbsp;&nbsp;<br/> &nbsp;&nbsp;PEwait()<br/> }'<br/>"
     "</code>"
     )
 
 QScriptValue QxrdScriptEngine::acquireFunc(QScriptContext *context, QScriptEngine *engine)
 {
   QxrdScriptEngine *eng = qobject_cast<QxrdScriptEngine*>(engine);
 
   if (eng) {
     QxrdAcquisitionPtr acq(eng->acquisition());
 
     if (!acq) return QScriptValue(engine, -1);
 
     int nArgs = context->argumentCount();
 
     if (nArgs < 6) {
       acq -> set_PhasesInGroup(1);
     }
 
     if (nArgs < 5) {
       acq -> set_PreTriggerFiles(0);
     }
 
     switch (nArgs) {
     default:
 
     case 6:
       acq -> set_PhasesInGroup(context -> argument(5).toUInt32());
 
     case 5:
       acq -> set_PreTriggerFiles(context -> argument(4).toUInt32());
 
     case 4:
       acq -> set_PostTriggerFiles(context -> argument(3).toUInt32());
 
     case 3:
       acq -> set_SummedExposures(context -> argument(2).toUInt32());
 
     case 2:
       acq -> set_ExposureTime(context -> argument(1).toNumber());
 
     case 1:
       acq -> set_FilePattern(context -> argument(0).toString());
 
     case 0:
       acq->acquire();
     }
   }
 
   return QScriptValue(engine, 1);
 }

Here is the call graph for this function:

QCEP_DOC_FUNCTION	(	"acquireDark"	,
		"acquireDark([filename [,exposure [,darkSummedExposures]]])"	,
		"Start acquisition of a dark image"	,
		"<p>Arguments are optional	and,
		if	given,
		will replace the" "corresponding value in the acquire	dialog,
		if not given the" "dialog values are used.</p >\n" "< p >The following is a typical example of the use of this" "command from spec:</p >\n" "< code >\n" "def PEexpd(filename, exposure, subframes) '{< br/>\n" "  remote_eval(PEHOST," "sprintf(\"acquireDark(\\\"%s\\\",%g,%d)\",filename,exposure,subframes));<br/>\n""  <br/>   PEwait()<br/> }'<br/>\n""</code>\n"
	)

Definition at line 499 of file qxrdscriptengine.cpp.

References QxrdScriptEngine::acquisition().

                       :</p>\n"
     "<code>\n"
     "def PEexpd(filename, exposure, subframes) '{<br/>\n"
     "&nbsp;&nbsp;remote_eval(PEHOST,"
     "sprintf(\"acquireDark(\\\"%s\\\",%g,%d)\",filename,exposure,subframes));<br/>\n"
     "&nbsp;&nbsp;<br/> &nbsp;&nbsp;PEwait()<br/> }'<br/>\n"
     "</code>\n"
     )
 
 QScriptValue QxrdScriptEngine::acquireDarkFunc(QScriptContext *context, QScriptEngine *engine)
 {
   QxrdScriptEngine *eng = qobject_cast<QxrdScriptEngine*>(engine);
 
   if (eng) {
     QxrdAcquisitionPtr acq(eng->acquisition());
 
     if (!acq) return QScriptValue(engine, -1);
 
     int nArgs = context->argumentCount();
 
     switch (nArgs) {
     default:
     case 3:
       acq -> set_DarkSummedExposures(context -> argument(2).toUInt32());
 
     case 2:
       acq -> set_ExposureTime(context -> argument(1).toNumber());
 
     case 1:
       acq -> set_FilePattern(context -> argument(0).toString());
 
     case 0:
       acq -> acquireDark();
     }
   }
 
   return QScriptValue(engine, 1);
 }

Here is the call graph for this function:

QCEP_DOC_FUNCTION	(	"status"	,
		"status([time])"	,
		"Test if acquisition and processing have finished"	,
		"<p>""If the argument is given the function will wait up to that ""many seconds - if acquisition and processing finish before ""the time elapsed then <code>status</code> will return at ""that	time,
		otherwise at the end of the timeout period.The" "function returns a non-zero result if acquisition and" "processing are	complete,
		or zero if they are not." "</p >\n" "< p >" "If no argument is given the function tests if acquisition" "and processing are complete and returns the result of the" "test immediately." "</p >\n" "< p >" "The following is a typical use of this command from spec:" "</p >\n" "< code >" "def PEwait() '{< br/>" "  while(remote_eval(PEHOST,\"status(1.0)\")==0) {<br/>""  }<br/> }'<br/>""</code>\n"
	)

Definition at line 546 of file qxrdscriptengine.cpp.

References QxrdScriptEngine::acquisition(), and QxrdScriptEngine::dataProcessor().

                                                              :"
     "</p>\n"
     "<code>"
     "def PEwait() '{<br/>"
     "&nbsp;&nbsp;while(remote_eval(PEHOST,\"status(1.0)\")==0) {<br/>"
     "&nbsp;&nbsp;}<br/> }'<br/>"
     "</code>\n"
     )
 
 QScriptValue QxrdScriptEngine::statusFunc(QScriptContext *context, QScriptEngine *engine)
 {
   QxrdScriptEngine *eng = qobject_cast<QxrdScriptEngine*>(engine);
 
   if (eng) {
     QxrdAcquisitionPtr acq(eng->acquisition());
     QxrdDataProcessorPtr proc(eng->dataProcessor());
 
     if (!acq || !proc) return QScriptValue(engine, -1);
 
     double time=0;
     int status=0;
 
     if (context->argumentCount() > 0) {
       time = context->argument(0).toNumber();
     }
 
     status = acq -> acquisitionStatus(time);
 
     if (status == 1) {
       status = proc -> status(time);
     }
 
     return QScriptValue(engine, status);
   } else {
     return QScriptValue(engine, -1);
   }
 }

Here is the call graph for this function:

QCEP_DOC_FUNCTION	(	"acquireStatus"	,
		"acquireStatus([time])"	,
		"Test if acquisition has finished"	,
		"<p>""Similar to 'status' ""except that it only tests for the acquisition operation being complete.""</p>"
	)

Definition at line 602 of file qxrdscriptengine.cpp.

References QxrdScriptEngine::acquisition().

 {
   QxrdScriptEngine *eng = qobject_cast<QxrdScriptEngine*>(engine);
 
   if (eng) {
     QxrdAcquisitionPtr acq(eng->acquisition());
 
     if (acq) {
       if (context->argumentCount() == 0) {
         return QScriptValue(engine, acq -> acquisitionStatus(0));
       } else {
         double time = context->argument(0).toNumber();
         return QScriptValue(engine, acq -> acquisitionStatus(time));
       }
     }
   }
 
   return QScriptValue(engine, -1);
 }

Here is the call graph for this function:

QCEP_DOC_FUNCTION	(	"processStatus"	,
		"processStatus([time])"	,
		"Test if processing has finished"	,
		"<p>""Similar to 'status' ""except that it only tests for the processing operation being complete.""</p>"
	)

Definition at line 632 of file qxrdscriptengine.cpp.

References QxrdScriptEngine::dataProcessor().

 {
   QxrdScriptEngine *eng = qobject_cast<QxrdScriptEngine*>(engine);
 
   if (eng) {
     QxrdDataProcessorPtr proc(eng->dataProcessor());
 
     if (proc) {
       if (context->argumentCount() == 0) {
         return QScriptValue(engine, proc -> status(0));
       } else {
         double time = context->argument(0).toNumber();
         return QScriptValue(engine, proc -> status(time));
       }
     }
   }
 
   return QScriptValue(engine, -1);
 }

Here is the call graph for this function:

QCEP_DOC_FUNCTION	(	"acquireCancel"	,
		"acquireCancel()"	,
		"Cancel the current acquisition operation"	,
		""
	)

Definition at line 662 of file qxrdscriptengine.cpp.

References QxrdScriptEngine::acquisition().

 {
   QxrdScriptEngine *eng = qobject_cast<QxrdScriptEngine*>(engine);
 
   if (eng) {
     QxrdAcquisitionPtr acq(eng->acquisition());
 
     if (acq) {
       acq -> cancel();
 
       return QScriptValue(engine, 1);
     }
   }
 
   return QScriptValue(engine, -1);
 }

Here is the call graph for this function:

QCEP_DOC_FUNCTION ( "acquireScalers" )

Definition at line 686 of file qxrdscriptengine.cpp.

References QxrdScriptEngine::acquisition().

 {
   QxrdScriptEngine *eng = qobject_cast<QxrdScriptEngine*>(engine);
 
   if (eng) {
     QxrdAcquisitionPtr acq(eng->acquisition());
 
     if (acq) {
       int i = context->argument(0).toInteger();
 
       return QScriptValue(eng, acq->scalerValue(i));
     }
   }
 
   return QScriptValue();
 }

Here is the call graph for this function:

QCEP_DOC_FUNCTION	(	"trigger"	,
		"trigger()"	,
		"Trigger triggered acquisition"	,
		"<p>If 'preTriggerFiles' is greater than zero then acquisition operations proceed in the ""'triggered' mode. This acts much like a digital oscilloscope trigger where a certain number ""('preTriggerFiles') of acquired images are held in the computer RAM until the trigger operation occurs ""and then the most recent acquired images are written to	disk,
		along with a number of post-trigger images</p >"
	)

Definition at line 709 of file qxrdscriptengine.cpp.

References QxrdScriptEngine::acquisition().

 {
   QxrdScriptEngine *eng = qobject_cast<QxrdScriptEngine*>(engine);
 
   if (eng) {
     QxrdAcquisitionPtr acq(eng->acquisition());
 
     if (acq) {
       acq -> trigger();
 
       return QScriptValue(engine, 1);
     }
   }
 
   return QScriptValue(engine, -1);
 }

Here is the call graph for this function:

QCEP_DOC_FUNCTION	(	"exposureTime"	,
		"exposureTime([time])"	,
		"Get or set the acquisition exposure time (also for dark exposures)"	,
		"<p>If the time argument is	given,
		set the exposure	time,
		otherwise return the" "current exposure time</p >" "< p >This function provides a convenient method to access the" "< code >acquisition.exposureTime</code > property</p >"
	)

Definition at line 736 of file qxrdscriptengine.cpp.

References QxrdScriptEngine::acquisition().

 {
   QxrdScriptEngine *eng = qobject_cast<QxrdScriptEngine*>(engine);
 
   if (eng) {
     QxrdAcquisitionPtr acq(eng->acquisition());
 
     if (acq) {
       if (context->argumentCount() != 0) {
         acq -> set_ExposureTime(context->argument(0).toNumber());
       }
 
       return QScriptValue(engine, acq -> get_ExposureTime());
     }
   }
 
   return QScriptValue(engine, -1);
 }

Here is the call graph for this function:

QCEP_DOC_FUNCTION	(	"summedExposures"	,
		"summedExposures([n])"	,
		"Get or set the number of summed exposures for acquisition"	,
		"<p>If the n argument is	given,
		set the number of summed	exposures,
		otherwise return the" "current value.</p >" "< p >Easy access to< code >acquisition.summedExposures</code ></p >"
	)

Definition at line 765 of file qxrdscriptengine.cpp.

References QxrdScriptEngine::acquisition().

 {
   QxrdScriptEngine *eng = qobject_cast<QxrdScriptEngine*>(engine);
 
   if (eng) {
     QxrdAcquisitionPtr acq(eng->acquisition());
 
     if (acq) {
       if (context->argumentCount() != 0) {
         acq -> set_SummedExposures(context->argument(0).toUInt32());
       }
 
       return QScriptValue(engine, acq -> get_SummedExposures());
     }
   }
 
   return QScriptValue(engine, -1);
 }

Here is the call graph for this function:

QCEP_DOC_FUNCTION	(	"skippedExposures"	,
		"skippedExposures([n])"	,
		"Get or set the number of skipped exposures for acquisition"	,
		"<p>If the n argument is	given,
		set the number of skipped	exposures,
		otherwise return the" "current value.</p >" "< p >Easy access to< code >acquisition.skippedExposures</code ></p >"
	)

Definition at line 793 of file qxrdscriptengine.cpp.

References QxrdScriptEngine::acquisition().

 {
   QxrdScriptEngine *eng = qobject_cast<QxrdScriptEngine*>(engine);
 
   if (eng) {
     QxrdAcquisitionPtr acq(eng->acquisition());
 
     if (acq) {
       if (context->argumentCount() != 0) {
         acq -> set_SkippedExposures(context->argument(0).toUInt32());
       }
 
       return QScriptValue(engine, acq -> get_SkippedExposures());
     }
   }
 
   return QScriptValue(engine, -1);
 }

Here is the call graph for this function:

QCEP_DOC_FUNCTION	(	"darkSummedExposures"	,
		"darkSummedExposures([n])"	,
		"Get or set the number of summed exposures for dark acquisition"	,
		"<p>If the n argument is	given,
		set the number of summed	exposures,
		otherwise return the" "current value.</p >" "< p >Easy access to< code >acquisition.darkSummedExposures</code ></p >"
	)

Definition at line 821 of file qxrdscriptengine.cpp.

References QxrdScriptEngine::acquisition().

 {
   QxrdScriptEngine *eng = qobject_cast<QxrdScriptEngine*>(engine);
 
   if (eng) {
     QxrdAcquisitionPtr acq(eng->acquisition());
 
     if (acq) {
       if (context->argumentCount() != 0) {
         acq -> set_DarkSummedExposures(context->argument(0).toUInt32());
       }
 
       return QScriptValue(engine, acq -> get_DarkSummedExposures());
     }
   }
 
   return QScriptValue(engine, -1);
 }

Here is the call graph for this function:

QCEP_DOC_FUNCTION	(	"phasesInGroup"	,
		"phasesInGroup([n])"	,
		"Get or set the number of phases for synchronized acquisition"	,
		"<p>If the n argument is	given,
		set the number of	phases,
		otherwise return the" "current value.</p >" "< p >Easy access to< code >acquisition.phasesInGroup</code ></p >"
	)

Definition at line 849 of file qxrdscriptengine.cpp.

References QxrdScriptEngine::acquisition().

 {
   QxrdScriptEngine *eng = qobject_cast<QxrdScriptEngine*>(engine);
 
   if (eng) {
     QxrdAcquisitionPtr acq(eng->acquisition());
 
     if (acq) {
       if (context->argumentCount() != 0) {
         acq -> set_PhasesInGroup(context->argument(0).toUInt32());
       }
 
       return QScriptValue(engine, acq -> get_PhasesInGroup());
     }
   }
 
   return QScriptValue(engine, -1);
 }

Here is the call graph for this function:

QCEP_DOC_FUNCTION	(	"preTriggerFiles"	,
		"preTriggerFiles([n])"	,
		"Get or set the number of pre-trigger file groups for triggered acquisition"	,
		"<p>If the n argument is	given,
		set the number of pre-trigger file	groups,
		otherwise return the" "current value.</p >" "< p >Easy access to< code >acquisition.preTriggerFiles</code ></p >"
	)

Definition at line 877 of file qxrdscriptengine.cpp.

References QxrdScriptEngine::acquisition().

 {
   QxrdScriptEngine *eng = qobject_cast<QxrdScriptEngine*>(engine);
 
   if (eng) {
     QxrdAcquisitionPtr acq(eng->acquisition());
 
     if (acq) {
       if (context->argumentCount() != 0) {
         acq -> set_PreTriggerFiles(context->argument(0).toUInt32());
       }
 
       return QScriptValue(engine, acq -> get_PreTriggerFiles());
     }
   }
 
   return QScriptValue(engine, -1);
 }

Here is the call graph for this function:

QCEP_DOC_FUNCTION	(	"postTriggerFiles"	,
		"postTriggerFiles([n])"	,
		"Get or set the number of post-trigger file groups for triggered acquisition"	,
		"<p>If the n argument is	given,
		set the number of post-trigger file	groups,
		otherwise return the" "current value.</p >" "< p >Easy access to< code >acquisition.postTriggerFiles</code ></p >"
	)

Definition at line 905 of file qxrdscriptengine.cpp.

References QxrdScriptEngine::acquisition().

 {
   QxrdScriptEngine *eng = qobject_cast<QxrdScriptEngine*>(engine);
 
   if (eng) {
     QxrdAcquisitionPtr acq(eng->acquisition());
 
     if (acq) {
       if (context->argumentCount() != 0) {
         acq -> set_PostTriggerFiles(context->argument(0).toUInt32());
       }
 
       return QScriptValue(engine, acq -> get_PostTriggerFiles());
     }
   }
 
   return QScriptValue(engine, -1);
 }

Here is the call graph for this function:

QCEP_DOC_FUNCTION	(	"filePattern"	,
		"filePattern([pattern])"	,
		"Get or set the acquisition file name pattern"	,
		"<p>If the pattern argument is	given,
		set the file name	pattern,
		otherwise return the" "current value.</p >" "< p >Easy access to< code >acquisition.filePattern</code ></p >"
	)

Definition at line 933 of file qxrdscriptengine.cpp.

References QxrdScriptEngine::acquisition().

 {
   QxrdScriptEngine *eng = qobject_cast<QxrdScriptEngine*>(engine);
 
   if (eng) {
     QxrdAcquisitionPtr acq(eng->acquisition());
 
     if (acq) {
       if (context->argumentCount() != 0) {
         acq -> set_FilePattern(context->argument(0).toString());
       }
 
       return QScriptValue(engine, acq -> get_FilePattern());
     }
   }
 
   return QScriptValue(engine, -1);
 }

Here is the call graph for this function:

QCEP_DOC_FUNCTION	(	"outputDirectory"	,
		"outputDirectory([dir])"	,
		"Get or set the acquisition output directory"	,
		"<p>If the dir argument is	given,
		set the output	directory,
		otherwise return the" "current value.</p >" "< p >Easy access to< code >experiment.dataDirectory</code ></p >"
	)

Definition at line 961 of file qxrdscriptengine.cpp.

References QxrdScriptEngine::experiment().

 {
   QxrdScriptEngine *eng = qobject_cast<QxrdScriptEngine*>(engine);
 
   if (eng) {
     QxrdExperimentPtr doc(eng->experiment());
 
     if (doc) {
       if (context->argumentCount() != 0) {
         doc -> set_DataDirectory(context->argument(0).toString());
       }
 
       return QScriptValue(engine, doc -> get_DataDirectory());
     }
   }
 
   return QScriptValue(engine, -1);
 }

Here is the call graph for this function:

QCEP_DOC_FUNCTION	(	"fileIndex"	,
		"fileIndex([n])"	,
		"Get or set the acquisition file index"	,
		"<p>If the n argument is	given,
		set the file	index,
		otherwise return the" "current value.</p >" "< p >Easy access to< code >acquisition.fileIndex</code ></p >"
	)

Definition at line 989 of file qxrdscriptengine.cpp.

References QxrdScriptEngine::acquisition().

 {
   QxrdScriptEngine *eng = qobject_cast<QxrdScriptEngine*>(engine);
 
   if (eng) {
     QxrdAcquisitionPtr acq(eng->acquisition());
 
     if (acq) {
       if (context->argumentCount() != 0) {
         acq -> set_FileIndex(context->argument(0).toUInt32());
       }
 
       return QScriptValue(engine, acq -> get_FileIndex());
     }
   }
 
   return QScriptValue(engine, -1);
 }

Here is the call graph for this function:

QCEP_DOC_FUNCTION	(	"data"	,
		"data()"	,
		"Get the current image"	,
		"<p>Returns a reference to the most recently acquired or most recently loaded image.</p>""<p>The returned object can have its properties queried.</p>""<p>Note that the value returned by this function will change as each ""new image is acquired so be careful if calling this function during acquisition.</p>"
	)

Definition at line 1017 of file qxrdscriptengine.cpp.

References QxrdScriptEngine::dataProcessor().

 {
   QxrdScriptEngine *eng = qobject_cast<QxrdScriptEngine*>(engine);
 
   if (eng) {
     QxrdDataProcessorPtr proc(eng->dataProcessor());
 
     if (proc) {
       return engine -> newQObject(proc -> data().data(),QtOwnership, QScriptEngine::AutoCreateDynamicProperties);
     }
   }
 
   return QScriptValue(engine, -1);
 }

Here is the call graph for this function:

QCEP_DOC_FUNCTION	(	"dark"	,
		"dark()"	,
		"Get the dark image (or null if none has been taken)"	,
		"<p>Returns a reference to the current dark image.</p>""<p>The returned object can have its properties queried.</p>""<p>For	example,
		to get the file name of the dark image:</p >" "< code >print(dark().fileName)</code >" "< p >Or to show a list of properties of the dark image:</p >" "< code >for(i in dark()) print(i, dark()[i])</code >"
	)

Definition at line 1042 of file qxrdscriptengine.cpp.

References QxrdScriptEngine::dataProcessor().

                                                            :</p>"
     "<code>print(dark().fileName)</code>"
     "<p>Or to show a list of properties of the dark image:</p>"
     "<code>for(i in dark()) print(i, dark()[i])</code>"
     )
 
 QScriptValue QxrdScriptEngine::darkFunc(QScriptContext * /*context*/, QScriptEngine *engine)
 {
   QxrdScriptEngine *eng = qobject_cast<QxrdScriptEngine*>(engine);
 
   if (eng) {
     QxrdDataProcessorPtr proc(eng->dataProcessor());
 
     if (proc) {
       return engine -> newQObject(proc -> darkImage().data(), QtOwnership, QScriptEngine::AutoCreateDynamicProperties);
     }
   }
 
   return QScriptValue(engine, -1);
 }

Here is the call graph for this function:

QCEP_DOC_FUNCTION	(	"mask"	,
		"mask()"	,
		"Get the top item of the mask stack"	,
		"<p>Returns a reference to the top of the mask	stack,
		or null if the" "mask stack is empty.</p >"
	)

Definition at line 1069 of file qxrdscriptengine.cpp.

References QxrdScriptEngine::dataProcessor().

 {
   QxrdScriptEngine *eng = qobject_cast<QxrdScriptEngine*>(engine);
 
   if (eng) {
     QxrdDataProcessorPtr proc(eng->dataProcessor());
 
     if (proc) {
       return engine -> newQObject(proc -> mask().data(), QtOwnership, QScriptEngine::AutoCreateDynamicProperties);
     }
   }
 
   return QScriptValue(engine, -1);
 }

Here is the call graph for this function:

QCEP_DOC_FUNCTION	(	"overflow"	,
		"overflow()"	,
		"Get the overflow pixel map for acquired images"	,
		"<p>Returns the overflow pixels map for the most recently acquired image ""(if overflow processing is enabled)</p>\n""<p>The overflow map is non-zero wherever an image pixel exceeded the overflow ""threshold during acquisition. Where more than one exposures are	summed,
		the overflow" "map will count the number of exposures for which the pixel overflowed.</p >"
	)

Definition at line 1092 of file qxrdscriptengine.cpp.

References QxrdScriptEngine::dataProcessor().

 {
   QxrdScriptEngine *eng = qobject_cast<QxrdScriptEngine*>(engine);
 
   if (eng) {
     QxrdDataProcessorPtr proc(eng->dataProcessor());
 
     if (proc) {
       return engine -> newQObject(proc -> overflow().data(), QtOwnership, QScriptEngine::AutoCreateDynamicProperties);
     }
   }
 
   return QScriptValue(engine, -1);
 }

Here is the call graph for this function:

QCEP_DOC_FUNCTION	(	"liveData"	,
		"liveData()"	,
		"Get the current live view image"	,
		"<p>Returns a reference to the most recently acquired live view image.</p>""<p>The returned object can have its properties queried.</p>""<p>Note that the value returned by this function will change as each ""new live view image is acquired so be careful when calling this function.</p>"
	)

Definition at line 1118 of file qxrdscriptengine.cpp.

References QxrdScriptEngine::dataProcessor().

 {
   QxrdScriptEngine *eng = qobject_cast<QxrdScriptEngine*>(engine);
 
   if (eng) {
     QxrdDataProcessorPtr proc(eng->dataProcessor());
 
     if (proc) {
       return engine -> newQObject(proc -> liveData().data(), QtOwnership, QScriptEngine::AutoCreateDynamicProperties);
     }
   }
 
   return QScriptValue(engine, -1);
 }

Here is the call graph for this function:

QCEP_DOC_FUNCTION	(	"help"	,
		"help([name...])"	,
		"Returns help text for a given name or names"	,
		"<p>Returns a string containing an html representation of the help text ""for a name or names. If more than one name is given the result is the ""concatenation of the help for each name in turn</p>""<p>The names may contain wildcard	characters,
		the result will contain help" "for all available matching the wildcard patterns.</p >" "< p >If no name is given the command returns help for the help command itself.</p >" "< p >If the command is executed in the QXRD script window the html result will" "be properly formatted in the message window.</p >" "< p >For example:</p >" "< code >help(\"help\")</code>"
	)

Definition at line 1143 of file qxrdscriptengine.cpp.

References QcepScriptEngine::documentationText().

                    :</p>"
     "<code>help(\"help\")</code>"
     )
 
 QScriptValue QxrdScriptEngine::helpFunc(QScriptContext * context, QScriptEngine * engine)
 {
   QxrdScriptEngine *eng = qobject_cast<QxrdScriptEngine*>(engine);
 
   if (eng) {
     int n=context->argumentCount();
     QString res="";
 
     if (n==0) {
       res = eng->documentationText("help");
     } else {
       for (int i=0; i<n; i++) {
         QString name = context->argument(i).toString();
 
         QRegExp re(name, Qt::CaseInsensitive, QRegExp::Wildcard);
 
         res.append(eng->documentationText(re));
       }
     }
 
     return QScriptValue(engine, res);
   } else {
     return QScriptValue(engine, QString());
   }
 }

Here is the call graph for this function:

QCEP_DOC_FUNCTION	(	"extraChannel"	,
		"extraChannel(n)"	,
		"Access channels for extra inputs"	,
		"<p>Returns a reference to configuration data for an extra input channel.</p>""<p>Example: to access the acquired waveform for extra channel 0</p>""<code>extraChannel(0).waveform</code>"
	)

Definition at line 1185 of file qxrdscriptengine.cpp.

References QxrdScriptEngine::acquisition().

                : to access the acquired waveform for extra channel 0</p>"
     "<code>extraChannel(0).waveform</code>"
     )
 
 QScriptValue QxrdScriptEngine::extraChannelFunc(QScriptContext *context, QScriptEngine *engine)
 {
   QxrdScriptEngine *eng = qobject_cast<QxrdScriptEngine*>(engine);
 
   if (eng) {
     QxrdAcquisitionPtr acq(eng->acquisition());
 
     if (acq) {
       QxrdAcquisitionExtraInputsPtr xtra(acq->acquisitionExtraInputs());
 
       if (xtra) {
         if (context->argumentCount() != 0) {
           int channel = context->argument(0).toInteger();
 
           QxrdAcquisitionExtraInputsChannelPtr chan(xtra->channel(channel));
 
           return engine->newQObject(chan.data());
         }
       }
     }
   }
 
   return QScriptValue();
 }

Here is the call graph for this function:

QCEP_DOC_FUNCTION	(	"process"	,
		"process(filename [, norm...])"	,
		"Load and process an image file"	,
		"<p>Load and process the file filename. The norm arguments are used as ""normalization values during processing</p>""<p>The function is closely related to</p>""<code>processor.processNormalizedFile(QString,QDoubleList)</code>"
	)

Definition at line 1219 of file qxrdscriptengine.cpp.

References QxrdScriptEngine::dataProcessor().

 {
   QxrdScriptEngine *eng = qobject_cast<QxrdScriptEngine*>(engine);
 
   if (eng) {
     QxrdDataProcessorPtr proc(eng->dataProcessor());
 
     if (proc) {
       if (context->argumentCount() >= 1) {
         QString file = context->argument(0).toString();
         QList<double> normVals;
 
         for (int i=1; i<context->argumentCount(); i++) {
           normVals.append(context->argument(i).toNumber());
         }
 
         proc -> processNormalizedFile(file, normVals);
       }
 
       return QScriptValue(engine, 1);
     }
   }
 
   return QScriptValue(engine, -1);
 }

Here is the call graph for this function:

QCEP_DOC_FUNCTION	(	"setFileNormalization"	,
		"setFileNormalization(filename [, norm...])"	,
		"Set the normalization values for an image file"	,
		"<p>Loads the file	filename,
		sets its normalization values and" "rewrites the metadata file</p >" "< p >The function is closely related to</p >" "< code >processor.setFileNormalization(QString, QDoubleList)</code >"
	)

Definition at line 1255 of file qxrdscriptengine.cpp.

References QxrdScriptEngine::dataProcessor().

 {
   QxrdScriptEngine *eng = qobject_cast<QxrdScriptEngine*>(engine);
 
   if (eng) {
     QxrdDataProcessorPtr proc(eng->dataProcessor());
 
     if (proc) {
       if (context->argumentCount() >= 1) {
         QString file = context->argument(0).toString();
         QList<double> normVals;
 
         for (int i=1; i<context->argumentCount(); i++) {
           normVals.append(context->argument(i).toNumber());
         }
 
         proc -> setFileNormalization(file, normVals);
       }
 
       return QScriptValue(engine, 1);
     }
   }
 
   return QScriptValue(engine, -1);
 }

Here is the call graph for this function:

QCEP_DOC_FUNCTION	(	"matchFiles"	,
		"matchFiles([pattern]...)"	,
		"Return a list of files matching a pattern"	,
		"<p>Returns a list of file names matching the provided pattern(s).</p>""<p>The patterns support 'wild card' characters sush as * and ?.</p>""<p>Example - to calculate the sum of the pixel intensity of pixel	100
	)

Definition at line 1291 of file qxrdscriptengine.cpp.

                                                 :</p>"
     "<code>var sum=0;<br/>\n"
     "for(f in matchFiles(\"*.tif\") {<br/>\n"
     "&nbsp;&nbsp;processor.loadData(f);<br/>\n"
     "&nbsp;&nbsp;sum += data().getImageData(100,100);<br/>\n"
     "}<br>"
     )
 
 QScriptValue QxrdScriptEngine::matchFilesFunc(QScriptContext *context, QScriptEngine *engine)
 {
   QStringList result;
 
   if (context->argumentCount() >= 1) {
     QString dir = context->argument(0).toString();
 
     if (context->argumentCount() == 1) {
       QDir a(dir);
       a.setFilter(QDir::Dirs | QDir::Files);
 
       result.append(a.entryList());
     } else {
       for (int i=1; i<context->argumentCount(); i++) {
         QString patt = context->argument(i).toString();
 
         //        g_Application->printMessage(tr("Matching %1").arg(patt));
 
         QDir a(dir);
 
         a.setFilter(QDir::Dirs | QDir::Files);
         QStringList patts;
         patts<<patt;
 
         a.setNameFilters(patts);
 
         QStringList entries = a.entryList();
         //        int nEntries = entries.length();
         //        g_Application->printMessage(tr("Matched %1 entries").arg(nEntries));
 
         result.append(entries);
       }
     }
   }
 
   return engine->toScriptValue(result);
 }

QCEP_DOC_FUNCTION	(	"mapUserFunction"	,
		"mapUserFunction(functionname)"	,
		"Map a user function over current data"	,
		""
	)

Definition at line 1344 of file qxrdscriptengine.cpp.

References QxrdScriptEngine::dataProcessor().

 {
   QxrdScriptEngine *eng = qobject_cast<QxrdScriptEngine*>(engine);
 
   if (eng) {
     QxrdDataProcessorPtr proc(eng->dataProcessor());
 
     QcepDoubleImageDataPtr d = proc->data();
 
     if (d) {
       int ht = d->get_Height();
       int wd = d->get_Width();
 
       if (context->argumentCount() == 1) {
         QScriptValue func = context->argument(0);
 
         if (!func.isFunction()) {
           func = eng->globalObject().property(func.toString());
         }
 
         if (func.isFunction()) {
           for (int i=0; i<wd; i++) {
             for (int j=0; j<ht; j++) {
               d->setValue(i,j, func.call(QScriptValue(), QScriptValueList() << i << j).toNumber());
             }
           }
 
           proc->newData(d, QcepMaskDataPtr());
         }
       }
     }
   }
 
   return engine->toScriptValue(0);
 }

Here is the call graph for this function:

QCEP_DOC_FUNCTION	(	"timeStamp"	,
		"timeStamp()"	,
		"Returns system time as seconds since unix epoch"	,
		""
	)

Definition at line 1387 of file qxrdscriptengine.cpp.

References QcepImageDataBase::secondsSinceEpoch().

 {
   double val = QcepImageDataBase::secondsSinceEpoch();
 
   return engine->toScriptValue(val);
 }

Here is the call graph for this function:

QCEP_DOC_FUNCTION	(	"newDataGroup"	,
		"newDataGroup(name)"	,
		"Creates a new named data group"	,
		""
	)

Definition at line 1402 of file qxrdscriptengine.cpp.

References QxrdScriptEngine::experiment().

 {
   QxrdScriptEngine *eng = qobject_cast<QxrdScriptEngine*>(engine);
 
   if (eng) {
     QxrdExperimentPtr expt = eng->experiment();
 
     if (expt) {
       QcepDatasetModelPtr dataModel = expt->dataset();
 
       if (dataModel) {
         QString name = context->argument(0).toString();
 
         return engine->newQObject(
               dataModel->newGroup(name).data());
       }
     }
   }
 
   return QScriptValue();
 }

Here is the call graph for this function:

QCEP_DOC_FUNCTION	(	"newDataArray"	,
		"newDataArray(name,dim1 .. dimn)"	,
		"Creates a new named n-dimensional data array"	,
		""
	)

Definition at line 1431 of file qxrdscriptengine.cpp.

References QxrdScriptEngine::experiment().

 {
   QxrdScriptEngine *eng = qobject_cast<QxrdScriptEngine*>(engine);
 
   if (eng) {
     QxrdExperimentPtr expt = eng->experiment();
 
     if (expt) {
       QcepDatasetModelPtr dataModel = expt->dataset();
 
       if (dataModel) {
         QString name = context->argument(0).toString();
 
         QVector<int> dims;
 
         for (int i=1; i<context->argumentCount(); i++) {
           dims.append(context->argument(i).toInteger());
         }
 
         return engine->newQObject(
               dataModel->newArray(name, dims).data());
       }
     }
   }
 
   return QScriptValue();
 }

Here is the call graph for this function:

QCEP_DOC_FUNCTION	(	"newDataColumn"	,
		"newDataColumn(name, npts)"	,
		"Creates a new named data column"	,
		""
	)

Definition at line 1466 of file qxrdscriptengine.cpp.

References QxrdScriptEngine::experiment().

 {
   QxrdScriptEngine *eng = qobject_cast<QxrdScriptEngine*>(engine);
 
   if (eng) {
     QxrdExperimentPtr expt = eng->experiment();
 
     if (expt) {
       QcepDatasetModelPtr dataModel = expt->dataset();
 
       if (dataModel) {
         QString name = context->argument(0).toString();
         int     npts = context->argument(1).toInteger();
 
         return engine->newQObject(
               dataModel->newColumn(name, npts).data());
       }
     }
   }
 
   return QScriptValue();
 }

Here is the call graph for this function:

QCEP_DOC_FUNCTION	(	"newDataColumnScan"	,
		"newDataColumnScan(name, npts, col1name .. colnname)"	,
		"Creates a new named data column scan"	,
		""
	)

Definition at line 1496 of file qxrdscriptengine.cpp.

References QxrdScriptEngine::experiment().

 {
   QxrdScriptEngine *eng = qobject_cast<QxrdScriptEngine*>(engine);
 
   if (eng) {
     QxrdExperimentPtr expt = eng->experiment();
 
     if (expt) {
       QcepDatasetModelPtr dataModel = expt->dataset();
 
       if (dataModel) {
         QString name = context->argument(0).toString();
         int     npts = context->argument(1).toInteger();
 
         QStringList cols;
 
         for (int i=2; i<context->argumentCount(); i++) {
           cols.append(context->argument(i).toString());
         }
 
         return engine->newQObject(
               dataModel->newColumnScan(name, npts, cols).data());
       }
     }
   }
 
   return QScriptValue();
 }

Here is the call graph for this function:

QCEP_DOC_FUNCTION	(	"newDataImage"	,
		"newDataImage(name, width, height)"	,
		"Creates a new named data image"	,
		""
	)

Definition at line 1532 of file qxrdscriptengine.cpp.

References QxrdScriptEngine::application(), and QxrdScriptEngine::experiment().

 {
   QxrdScriptEngine *eng = qobject_cast<QxrdScriptEngine*>(engine);
 
   if (eng) {
     QxrdExperimentPtr expt = eng->experiment();
     QxrdApplicationPtr app(eng->application());
 
     if (expt && app) {
 
       QcepDatasetModelPtr dataModel = expt->dataset();
 
       if (dataModel) {
         QString name   = context->argument(0).toString();
         int     width  = context->argument(1).toInteger();
         int     height = context->argument(2).toInteger();
 
         return engine->newQObject(
               dataModel->newImage(name, width, height).data());
       }
     }
   }
 
   return QScriptValue();
 }

Here is the call graph for this function:

QCEP_DOC_FUNCTION	(	"newIntegratedData"	,
		"newIntegratedData(name, size)"	,
		"Creates a new integrated data object"	,
		""
	)

Definition at line 1565 of file qxrdscriptengine.cpp.

References QxrdScriptEngine::application(), and QxrdScriptEngine::experiment().

 {
   QxrdScriptEngine *eng = qobject_cast<QxrdScriptEngine*>(engine);
 
   if (eng) {
     QxrdExperimentPtr expt = eng->experiment();
     QxrdApplicationPtr app(eng->application());
 
     if (expt && app) {
       QcepDatasetModelPtr dataModel = expt->dataset();
 
       if (dataModel) {
         QString name   = context->argument(0).toString();
         int     size   = context->argument(1).toInteger();
 
         return engine->newQObject(
               dataModel->newIntegratedData(name, size).data());
       }
     }
   }
 
   return QScriptValue();
 }

Here is the call graph for this function:

QCEP_DOC_FUNCTION	(	"detector"	,
		"detector(n)"	,
		"Returns a reference to the 'n'th detector"	,
		""
	)

Definition at line 1596 of file qxrdscriptengine.cpp.

References QxrdScriptEngine::acquisition().

 {
   QxrdScriptEngine *eng = qobject_cast<QxrdScriptEngine*>(engine);
 
   if (eng) {
     QxrdAcquisitionPtr acq(eng->acquisition());
 
     if (acq) {
       int n = context->argument(0).toInteger();
 
       return engine->newQObject(acq->detector(n).data());
     }
   }
 
   return QScriptValue();
 }

Here is the call graph for this function:

QCEP_DOC_FUNCTION	(	"roi"	,
		"roi(n,m)"	,
		"Returns a reference to the 'm'th ROI of the 'n'th detector"	,
		""
	)

Definition at line 1619 of file qxrdscriptengine.cpp.

References QxrdScriptEngine::acquisition().

 {
   QxrdScriptEngine *eng = qobject_cast<QxrdScriptEngine*>(engine);
 
   if (eng) {
     QxrdAcquisitionPtr acq(eng->acquisition());
 
     if (acq) {
       int n = context->argument(0).toInteger();
       int m = context->argument(1).toInteger();
 
       QxrdDetectorPtr d = acq->detector(n);
 
       if (d) {
         return engine->newQObject(d->roi(m).data());
       }
     }
   }
 
   return QScriptValue();
 }

Here is the call graph for this function:

JSON Parse a string as a JSON<p> A built in function in the Qt script system</p> QCEP_DOC_FUNCTION	(	"JSON.stringify"	,
		"JSON.stringify(object)"	,
		"Produce JSON string representation of an object"	,
		"<p>A built-in function in the Qt script system</p>"
	)

QCEP_DOC_OBJECT	(	"JSON"	,
		"Qt Built-in JSON Parser"
	)

Referenced by QcepProperty::QcepProperty(), and QxrdScriptEngine::setWindow().

Here is the caller graph for this function:

Variable Documentation

JSON Parse a string as a JSON object

Definition at line 1656 of file qxrdscriptengine.cpp.

Referenced by OnEndFrameCallback(), QxrdDataProcessorBase::saveData(), and QcepScatterPlotGraphController::updateDisplay().

(Commit a65ccc9... : jennings : 2016-03-15 14:00:18 -0500)

Functions

Variables

Function Documentation

Variable Documentation