mirror of
https://github.com/slsdetectorgroup/slsDetectorPackage.git
synced 2025-04-24 15:20:02 +02:00
a271d7a9e9
git-svn-id: file:///afs/psi.ch/project/sls_det_software/svn/slsDetectorSoftware@31 951219d9-93cf-4727-9268-0efd64621fa3
340 lines
10 KiB
C++
340 lines
10 KiB
C++
|
|
|
|
|
|
#ifndef MYTHEN_DETECTOR_H
|
|
#define MYTHEN_DETECTOR_H
|
|
|
|
//#include <ostream>
|
|
#include "slsDetector.h"
|
|
#include "usersFunctions.h"
|
|
|
|
#define defaultTDead {170,90,750}
|
|
|
|
//using namespace std;
|
|
/**
|
|
\mainpage C++ class with MYTHEN specific functions
|
|
*
|
|
|
|
|
|
@author Anna Bergamaschi
|
|
|
|
*/
|
|
|
|
|
|
|
|
class mythenDetector : public slsDetector{
|
|
|
|
|
|
|
|
public:
|
|
/**
|
|
(default) constructor
|
|
*/
|
|
mythenDetector(int id=0, detectorType t=MYTHEN) : slsDetector(t, id){};
|
|
//slsDetector(string const fname);
|
|
// ~slsDetector(){while(dataQueue.size()>0){}};
|
|
/** destructor */
|
|
virtual ~mythenDetector(){};
|
|
|
|
/**
|
|
executes a set of string arguments according to a given format. It is used to read/write configuration file, dump and retrieve detector settings and for the command line interface command parsing
|
|
\param narg number of arguments
|
|
\param args array of string arguments
|
|
\param action can be PUT_ACTION or GET_ACTION (from text client even READOUT_ACTION for acquisition)
|
|
\returns answer string
|
|
*/
|
|
string executeLine(int narg, char *args[], int action=GET_ACTION);
|
|
|
|
/**
|
|
returns the help for the executeLine command
|
|
\param os output stream to return the help to
|
|
\param action can be PUT_ACTION or GET_ACTION (from text client even READOUT_ACTION for acquisition)
|
|
*/
|
|
static string helpLine(int action=GET_ACTION);
|
|
|
|
|
|
/**
|
|
type of action performed
|
|
*/
|
|
enum {GET_ACTION, PUT_ACTION, READOUT_ACTION};
|
|
|
|
|
|
/**
|
|
reads configuration file fname calling executeLine
|
|
\param fname file to be read
|
|
*/
|
|
int readConfigurationFile(string const fname);
|
|
/**
|
|
writes configuration file calling executeLine
|
|
\param fname file to write to
|
|
*/
|
|
int writeConfigurationFile(string const fname);
|
|
/**
|
|
dumps all the possible detector parameters calling executeLine
|
|
\param fname file to write to
|
|
\param level 0 dumps only main parameters and filenames for flat field correction etc.; 2 dumps really the complete configuration including flat field files, badchannels files, trimbits, angular conversion etc.
|
|
*/
|
|
int dumpDetectorSetup(string const fname, int level=0);
|
|
/**
|
|
retrieves all possible detector parameters from file calling executeLine
|
|
\param fname file to be read
|
|
*/
|
|
int retrieveDetectorSetup(string const fname, int level=0);
|
|
|
|
|
|
|
|
/**
|
|
reads a trim file
|
|
\param fname name of the file to be read
|
|
\param myMod pointer to the module structure which has to be set. <BR> If it is NULL a new module structure will be created
|
|
\returns the pointer to myMod or NULL if reading the file failed
|
|
*/
|
|
|
|
sls_detector_module* readTrimFile(string fname, sls_detector_module* myMod=NULL);
|
|
|
|
/**
|
|
writes a trim file
|
|
\param fname name of the file to be written
|
|
\param mod module structure which has to be written to file
|
|
\returns OK or FAIL if the file could not be written
|
|
|
|
\sa ::sls_detector_module
|
|
*/
|
|
int writeTrimFile(string fname, sls_detector_module mod);
|
|
|
|
/**
|
|
writes a trim file for module number imod - the values will be read from the current detector structure
|
|
\param fname name of the file to be written
|
|
\param imod module number
|
|
\returns OK or FAIL if the file could not be written
|
|
\sa ::sls_detector_module sharedSlsDetector
|
|
*/
|
|
int writeTrimFile(string fname, int imod);
|
|
|
|
/**
|
|
writes a data file
|
|
\param name of the file to be written
|
|
\param data array of data values
|
|
\param err array of arrors on the data. If NULL no errors will be written
|
|
|
|
\param ang array of angular values. If NULL data will be in the form chan-val(-err) otherwise ang-val(-err)
|
|
\param dataformat format of the data: can be 'i' integer or 'f' float (default)
|
|
\param nch number of channels to be written to file. if -1 defaults to the number of installed channels of the detector
|
|
\returns OK or FAIL if it could not write the file or data=NULL
|
|
|
|
|
|
*/
|
|
int writeDataFile(string fname, float *data, float *err=NULL, float *ang=NULL, char dataformat='f', int nch=-1);
|
|
|
|
/**
|
|
writes a data file
|
|
\param name of the file to be written
|
|
\param data array of data values
|
|
\returns OK or FAIL if it could not write the file or data=NULL
|
|
*/
|
|
int writeDataFile(string fname, int *data);
|
|
|
|
/**
|
|
reads a data file
|
|
\param name of the file to be read
|
|
\param data array of data values to be filled
|
|
\param err array of arrors on the data. If NULL no errors are expected on the file
|
|
|
|
\param ang array of angular values. If NULL data are expected in the form chan-val(-err) otherwise ang-val(-err)
|
|
\param dataformat format of the data: can be 'i' integer or 'f' float (default)
|
|
\param nch number of channels to be written to file. if <=0 defaults to the number of installed channels of the detector
|
|
\returns OK or FAIL if it could not read the file or data=NULL
|
|
|
|
|
|
*/
|
|
int readDataFile(string fname, float *data, float *err=NULL, float *ang=NULL, char dataformat='f', int nch=0);
|
|
|
|
/**
|
|
reads a data file
|
|
\param name of the file to be read
|
|
\param data array of data values
|
|
\returns OK or FAIL if it could not read the file or data=NULL
|
|
*/
|
|
int readDataFile(string fname, int *data);
|
|
|
|
|
|
/**
|
|
reads a calibration file
|
|
\param fname file to be read
|
|
\param gain reference to the gain variable
|
|
\offset reference to the offset variable
|
|
\sa sharedSlsDetector
|
|
*/
|
|
int readCalibrationFile(string fname, float &gain, float &offset);
|
|
/**
|
|
writes a clibration file
|
|
\param fname file to be written
|
|
\param gain
|
|
\param offset
|
|
\sa sharedSlsDetector
|
|
*/
|
|
int writeCalibrationFile(string fname, float gain, float offset);
|
|
|
|
|
|
/**
|
|
reads an angular conversion file
|
|
\param fname file to be read
|
|
\sa angleConversionConstant
|
|
*/
|
|
int readAngularConversion(string fname="");
|
|
/**
|
|
writes an angular conversion file
|
|
\param fname file to be written
|
|
\sa angleConversionConstant
|
|
*/
|
|
int writeAngularConversion(string fname="");
|
|
|
|
|
|
|
|
|
|
//Corrections
|
|
|
|
|
|
/**
|
|
set angular conversion
|
|
\param fname file with angular conversion constants ("" disable)
|
|
\returns 0 if angular conversion disabled, >0 otherwise
|
|
*/
|
|
int setAngularConversion(string fname="");
|
|
|
|
/**
|
|
get angular conversion
|
|
\param reference to diffractometer direction
|
|
\param angconv array that will be filled with the angular conversion constants
|
|
\returns 0 if angular conversion disabled, >0 otherwise
|
|
*/
|
|
int getAngularConversion(int &direction, angleConversionConstant *angconv=NULL);
|
|
|
|
|
|
/** returns the angular conversion file */
|
|
string getAngularConversion() {if (thisDetector->correctionMask&(1<< ANGULAR_CONVERSION)) return string(thisDetector->angConvFile); else return string("none");};
|
|
|
|
/**
|
|
set detector global offset
|
|
*/
|
|
float setGlobalOffset(float f){thisDetector->globalOffset=f; return thisDetector->globalOffset;};
|
|
|
|
/**
|
|
set detector fine offset
|
|
*/
|
|
float setFineOffset(float f){thisDetector->fineOffset=f; return thisDetector->fineOffset;};
|
|
/**
|
|
get detector fine offset
|
|
*/
|
|
float getFineOffset(){return thisDetector->fineOffset;};
|
|
|
|
/**
|
|
get detector global offset
|
|
*/
|
|
float getGlobalOffset(){return thisDetector->globalOffset;};
|
|
|
|
/**
|
|
set positions for the acquisition
|
|
\param nPos number of positions
|
|
\param pos array with the encoder positions
|
|
\returns number of positions
|
|
*/
|
|
int setPositions(int nPos, float *pos);
|
|
/**
|
|
get positions for the acquisition
|
|
\param pos array which will contain the encoder positions
|
|
\returns number of positions
|
|
*/
|
|
int getPositions(float *pos=NULL);
|
|
|
|
|
|
/** set detector bin size used for merging (approx angular resolution)*/
|
|
float setBinSize(float bs) {thisDetector->binSize=bs; return thisDetector->binSize;}
|
|
/** return detector bin size used for merging (approx angular resolution)*/
|
|
float getBinSize() {return thisDetector->binSize;}
|
|
|
|
|
|
|
|
|
|
/** sets the arrays of the merged data to 0. NB The array should be created with size >= 360./getBinSize();
|
|
\param mp already merged postions
|
|
\param mv already merged data
|
|
\param me already merged errors (squared sum)
|
|
\param mm multiplicity of merged arrays
|
|
\returns OK or FAIL
|
|
*/
|
|
int resetMerging(float *mp, float *mv,float *me, int *mm);
|
|
/** merge dataset
|
|
\param p1 angular positions of dataset
|
|
\param v1 data
|
|
\param e1 errors
|
|
\param mp already merged postions
|
|
\param mv already merged data
|
|
\param me already merged errors (squared sum)
|
|
\param mm multiplicity of merged arrays
|
|
*/
|
|
int addToMerging(float *p1, float *v1, float *e1, float *mp, float *mv,float *me, int *mm);
|
|
|
|
/**
|
|
calculates the "final" positions, data value and errors for the emrged data
|
|
\param mp already merged postions
|
|
\param mv already merged data
|
|
\param me already merged errors (squared sum)
|
|
\param mm multiplicity of merged arrays
|
|
\returns FAIL or the
|
|
*/
|
|
int finalizeMerging(float *mp, float *mv,float *me, int *mm);
|
|
|
|
|
|
/**
|
|
function for processing data
|
|
\param delflag if 1 the data are deleted, else left there for further processing (or plotting?)
|
|
*/
|
|
void* processData(int delflag=1); // thread function
|
|
|
|
/** performs the complete acquisition and data processing
|
|
moves the detector to next position <br>
|
|
starts and reads the detector <br>
|
|
reads the IC (if required) <br>
|
|
reads the encoder (iof required for angualr conversion) <br>
|
|
processes the data (flat field, rate, angular conversion and merging ::processData())
|
|
\param delflag if 1 the data are deleted, else left there for further processing (or plotting?)
|
|
*/
|
|
|
|
void acquire(int delflag=1);
|
|
|
|
/**
|
|
get current timer value on the stop socket
|
|
\param index timer index
|
|
\returns elapsed time value in ns or number of...(e.g. frames, gates, probes)
|
|
*/
|
|
|
|
int64_t getTimeLeft(timerIndex index);
|
|
|
|
/**
|
|
get run status on the stop socket
|
|
\returns status mask
|
|
*/
|
|
runStatus getRunStatus();
|
|
|
|
private:
|
|
/**
|
|
start data processing thread
|
|
*/
|
|
void startThread(int delflag=1); //
|
|
/** the data processing thread */
|
|
|
|
pthread_t dataProcessingThread;
|
|
|
|
/** sets when the acquisition is finished */
|
|
int jointhread;
|
|
|
|
/** data queue size */
|
|
int queuesize;
|
|
};
|
|
|
|
static void* startProcessData(void *n);
|
|
static void* startProcessDataNoDelete(void *n);
|
|
|
|
#endif
|