mirror of
https://github.com/slsdetectorgroup/slsDetectorPackage.git
synced 2025-04-23 23:10:02 +02:00
ab4e569b6c
git-svn-id: file:///afs/psi.ch/project/sls_det_software/svn/slsDetectorSoftware@171 951219d9-93cf-4727-9268-0efd64621fa3
529 lines
14 KiB
C++
529 lines
14 KiB
C++
|
|
|
|
#ifndef SLS_DETECTOR_UTILS_H
|
|
#define SLS_DETECTOR_UTILS_H
|
|
|
|
|
|
#ifdef __CINT__
|
|
class pthread_mutex_t;
|
|
class pthread_t;
|
|
#endif
|
|
|
|
extern "C" {
|
|
#include <pthread.h>
|
|
}
|
|
|
|
#include <sys/stat.h>
|
|
#include <sys/types.h>
|
|
#include <sys/uio.h>
|
|
#include <fcntl.h>
|
|
#include <unistd.h>
|
|
|
|
|
|
#ifdef __MAKECINT__
|
|
#pragma link off class _FTCOMSTAT-;
|
|
#pragma link off class _FTDCB-;
|
|
#endif
|
|
|
|
|
|
//#include "MySocketTCP.h"
|
|
#include <iostream>
|
|
#include <fstream>
|
|
#include <iomanip>
|
|
#include <cstring>
|
|
#include <string>
|
|
#include <sstream>
|
|
#include <queue>
|
|
#include <math.h>
|
|
|
|
using namespace std;
|
|
|
|
|
|
#include "sls_detector_defs.h"
|
|
#include "slsDetectorBase.h"
|
|
#include "energyConversion.h"
|
|
#include "postProcessing.h"
|
|
#include "slsDetectorActions.h"
|
|
|
|
#define MAX_TIMERS 10
|
|
#define MAX_ROIS 100
|
|
#define MAXPOS 50
|
|
|
|
#define DEFAULT_HOSTNAME "localhost"
|
|
#define DEFAULT_SHM_KEY 5678
|
|
|
|
/**
|
|
@short class containing all the possible detector functionalities
|
|
|
|
(used in the PSi command line interface)
|
|
*/
|
|
class slsDetectorUtils : public slsDetectorActions, public postProcessing, public slsDetectorBase {
|
|
|
|
|
|
|
|
public:
|
|
|
|
slsDetectorUtils();
|
|
|
|
virtual ~slsDetectorUtils(){};
|
|
|
|
|
|
|
|
|
|
virtual int getNumberOfDetectors(){return 1;};
|
|
|
|
|
|
|
|
int setPositions(int nPos, float *pos){return angularConversion::setPositions(nPos, pos);};
|
|
int getPositions(float *pos=NULL){return angularConversion::getPositions(pos);};
|
|
|
|
using slsDetectorBase::setFlatFieldCorrection;
|
|
|
|
string getFilePath(){return fileIO::getFilePath();};
|
|
string setFilePath(string s){return fileIO::setFilePath(s);};
|
|
|
|
string getFileName(){return fileIO::getFileName();};
|
|
string setFileName(string s){return fileIO::setFileName(s);};
|
|
|
|
int getFileIndex(){return fileIO::getFileIndex();};
|
|
int setFileIndex(int s){return fileIO::setFileIndex(s);};
|
|
|
|
|
|
int getScanPrecision(int i){return slsDetectorActions::getScanPrecision(i);};
|
|
|
|
int getActionMask() {return slsDetectorActions::getActionMask();};
|
|
float getCurrentScanVariable(int i) {return slsDetectorActions::getCurrentScanVariable(i);};
|
|
int getCurrentPositionIndex(){return angularConversion::getCurrentPositionIndex();};
|
|
int getNumberOfPositions(){return angularConversion::getNumberOfPositions();};
|
|
|
|
|
|
string getFlatFieldCorrectionDir(){return postProcessing::getFlatFieldCorrectionDir();};
|
|
string setFlatFieldCorrectionDir(string s){return postProcessing::setFlatFieldCorrectionDir(s);};
|
|
string getFlatFieldCorrectionFile(){return postProcessing::getFlatFieldCorrectionFile();};
|
|
int enableBadChannelCorrection(int i){return postProcessing::enableBadChannelCorrection(i);};
|
|
int enableAngularConversion(int i){return postProcessing::enableAngularConversion(i);};
|
|
|
|
|
|
/** returns the detector hostname
|
|
\param pos position in the multi detector structure (is -1 returns concatenated hostnames divided by a +)
|
|
\returns hostname
|
|
*/
|
|
virtual string getHostname(int pos=-1)=0;
|
|
|
|
|
|
/** sets the detector hostname
|
|
\param name hostname
|
|
\param pos position in the multi detector structure (is -1 expects concatenated hostnames divided by a +)
|
|
\returns hostname
|
|
*/
|
|
virtual string setHostname(char* name, int pos=-1)=0;
|
|
|
|
|
|
|
|
/** Gets the detector id (shared memory id) of an slsDetector
|
|
\param i position in the multiSlsDetector structure
|
|
\return id or -1 if FAIL
|
|
*/
|
|
virtual int getDetectorId(int i=-1) =0;
|
|
|
|
/** Sets the detector id (shared memory id) of an slsDetector in a multiSlsDetector structure
|
|
\param ival id to be set
|
|
\param i position in the multiSlsDetector structure
|
|
\return id or -1 if FAIL (e.g. in case of an slsDetector)
|
|
*/
|
|
virtual int setDetectorId(int ival, int i=-1){return -1;};
|
|
|
|
|
|
|
|
/**
|
|
gets the network parameters (implemented for gotthard)
|
|
\param i network parameter type can be CLIENT_IP, CLIENT_MAC, SERVER_MAC
|
|
\returns parameter
|
|
|
|
*/
|
|
virtual char *getNetworkParameter(networkParameter i)=0;
|
|
|
|
/**
|
|
sets the network parameters (implemented for gotthard)
|
|
\param i network parameter type can be CLIENT_IP, CLIENT_MAC, SERVER_MAC
|
|
\param s value to be set
|
|
\returns parameter
|
|
|
|
*/
|
|
virtual char *setNetworkParameter(networkParameter i, string s)=0;
|
|
|
|
/**
|
|
changes/gets the port number
|
|
\param t type port type can be CONTROL_PORT, DATA_PORT, STOP_PORT
|
|
\param i new port number (<1024 gets)
|
|
\returns actual port number
|
|
*/
|
|
virtual int setPort(portType t, int i=-1)=0;
|
|
|
|
/**
|
|
get detector ids/versions for module
|
|
\param mode which id/version has to be read
|
|
\param imod module number for module serial number
|
|
\returns id
|
|
*/
|
|
virtual int64_t getId(idMode mode, int imod=0)=0;
|
|
|
|
/**
|
|
Digital test of the modules
|
|
\param mode test mode
|
|
\param imod module number for chip test or module firmware test
|
|
\returns OK or error mask
|
|
*/
|
|
virtual int digitalTest(digitalTestMode mode, int imod=0)=0;
|
|
|
|
/**
|
|
execute trimming
|
|
\param mode trim mode
|
|
\param par1 if noise, beam or fixed setting trimming it is count limit, if improve maximum number of iterations
|
|
\param par2 if noise or beam nsigma, if improve par2!=means vthreshold will be optimized, if fixed settings par2<0 trimwith median, par2>=0 trim with level
|
|
\param imod module number (-1 all)
|
|
\returns OK or FAIl (FAIL also if some channel are 0 or 63
|
|
*/
|
|
virtual int executeTrimming(trimMode mode, int par1, int par2, int imod=-1)=0;
|
|
|
|
|
|
/**
|
|
returns currently the loaded trimfile/settingsfile name
|
|
*/
|
|
virtual const char *getSettingsFile()=0;
|
|
|
|
|
|
/**
|
|
get current timer value
|
|
\param index timer index
|
|
\returns elapsed time value in ns or number of...(e.g. frames, gates, probes)
|
|
*/
|
|
virtual int64_t getTimeLeft(timerIndex index)=0;
|
|
|
|
|
|
|
|
/** sets the number of trim energies and their value \sa sharedSlsDetector
|
|
\param nen number of energies
|
|
\param en array of energies
|
|
\returns number of trim energies
|
|
|
|
unused!
|
|
|
|
*/
|
|
virtual int setTrimEn(int nen, int *en=NULL)=0;
|
|
|
|
/** returns the number of trim energies and their value \sa sharedSlsDetector
|
|
\param en pointer to the array that will contain the trim energies (in ev)
|
|
\returns number of trim energies
|
|
|
|
unused!
|
|
*/
|
|
virtual int getTrimEn(int *en=NULL)=0;
|
|
|
|
|
|
|
|
/**
|
|
set/get the use of an external signal
|
|
\param pol meaning of the signal \sa externalSignalFlag
|
|
\param signalindex index of the signal
|
|
\returns current meaning of signal signalIndex
|
|
*/
|
|
virtual externalSignalFlag setExternalSignalFlags(externalSignalFlag pol=GET_EXTERNAL_SIGNAL_FLAG , int signalindex=0)=0;
|
|
|
|
|
|
|
|
|
|
/** sets/gets the value of important readout speed parameters
|
|
\param sp is the parameter to be set/get
|
|
\param value is the value to be set, if -1 get value
|
|
\returns current value for the specified parameter
|
|
\sa speedVariable
|
|
*/
|
|
virtual int setSpeed(speedVariable sp, int value=-1)=0;
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
set/get readout flags
|
|
\param flag readout flag to be set
|
|
\returns current flag
|
|
*/
|
|
virtual int setReadOutFlags(readOutFlags flag=GET_READOUT_FLAGS)=0;
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/** sets/gets position of the master in a multi detector structure
|
|
\param i position of the detector in the multidetector structure
|
|
\returns position of the master in a multi detector structure (-1 no master or always in slsDetector)
|
|
*/
|
|
virtual int setMaster(int i=-1){return -1;};
|
|
|
|
/**
|
|
Sets/gets the synchronization mode of the various detectors
|
|
\param sync syncronization mode
|
|
\returns current syncronization mode
|
|
*/
|
|
virtual synchronizationMode setSynchronization(synchronizationMode sync=GET_SYNCHRONIZATION_MODE)=0;
|
|
|
|
|
|
/**
|
|
returns the detector trimbit/settings directory
|
|
*/
|
|
virtual char* getSettingsDir()=0;
|
|
|
|
/** sets the detector trimbit/settings directory */
|
|
virtual char* setSettingsDir(string s)=0;
|
|
|
|
/**
|
|
returns the location of the calibration files
|
|
*/
|
|
virtual char* getCalDir()=0;
|
|
|
|
/**
|
|
sets the location of the calibration files
|
|
*/
|
|
virtual char* setCalDir(string s)=0;
|
|
|
|
/** Frees the shared memory - should not be used except for debugging*/
|
|
virtual int freeSharedMemory()=0;
|
|
|
|
|
|
/** adds the detector with ID id in postion pos
|
|
\param id of the detector to be added (should already exist!)
|
|
\param pos position where it should be added (normally at the end of the list (default to -1)
|
|
\returns the actual number of detectors or -1 if it failed (always for slsDetector)
|
|
*/
|
|
virtual int addSlsDetector(int id, int pos=-1){return -1;};
|
|
|
|
|
|
/** adds the detector name in position pos
|
|
\param name of the detector to be added (should already exist in shared memory or at least be online)
|
|
\param pos position where it should be added (normally at the end of the list (default to -1)
|
|
\return the actual number of detectors or -1 if it failed (always for slsDetector)
|
|
*/
|
|
virtual int addSlsDetector(char* name, int pos=-1){return -1;};
|
|
|
|
|
|
/**
|
|
removes the detector in position pos from the multidetector
|
|
\param pos position of the detector to be removed from the multidetector system (defaults to -1 i.e. last detector)
|
|
\returns the actual number of detectors or -1 if it failed (always for slsDetector)
|
|
*/
|
|
virtual int removeSlsDetector(int pos=-1){return -1;};
|
|
|
|
/**removes the detector in position pos from the multidetector
|
|
\param name is the name of the detector
|
|
\returns the actual number of detectors or -1 if it failed (always for slsDetector)
|
|
*/
|
|
virtual int removeSlsDetector(char* name){return -1;};
|
|
|
|
/**
|
|
Turns off the server - do not use except for debugging!
|
|
*/
|
|
virtual int exitServer()=0;
|
|
|
|
|
|
|
|
|
|
/**
|
|
Loads dark image or gain image to the detector
|
|
\param index can be DARK_IMAGE or GAIN_IMAGE
|
|
\fname file name to load data from
|
|
\returns OK or FAIL
|
|
*/
|
|
virtual int loadImageToDetector(imageType index,string const fname)=0;
|
|
|
|
|
|
/**
|
|
writes the counter memory block from the detector
|
|
\param startACQ is 1 to start acquisition after reading counter
|
|
\fname file fname to load data from
|
|
\returns OK or FAIL
|
|
*/
|
|
virtual int writeCounterBlockFile(string const fname,int startACQ=0)=0;
|
|
|
|
|
|
/**
|
|
Resets counter memory block in detector
|
|
\param startACQ is 1 to start acquisition after resetting counter
|
|
\returns OK or FAIL
|
|
*/
|
|
virtual int resetCounterBlock(int startACQ=0)=0;
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
asks and receives all data from the detector and puts them in a data queue
|
|
\returns pointer to the front of the queue or NULL.
|
|
*/
|
|
virtual int* readAll()=0;
|
|
|
|
|
|
|
|
|
|
/** performs a complete acquisition including scansand 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 0 leaves the data in the final data queue
|
|
\returns nothing
|
|
*/
|
|
|
|
void acquire(int delflag=1);
|
|
|
|
|
|
// float* convertAngles(){return convertAngles(currentPosition);};
|
|
// virtual float* convertAngles(float pos)=0;
|
|
|
|
virtual int setThresholdEnergy(int, int im=-1, detectorSettings isettings=GET_SETTINGS)=0;
|
|
virtual int setChannel(long long, int ich=-1, int ichip=-1, int imod=-1)=0;
|
|
|
|
virtual float getRateCorrectionTau()=0;
|
|
virtual int* startAndReadAll()=0;
|
|
|
|
virtual int getTotalNumberOfChannels()=0;
|
|
virtual int getMaxNumberOfChannels()=0;
|
|
|
|
|
|
// virtual int getParameters();
|
|
|
|
|
|
|
|
|
|
int setTotalProgress();
|
|
|
|
float getCurrentProgress();
|
|
|
|
|
|
void incrementProgress();
|
|
void incrementFileIndex() { (*fileIndex)++;};
|
|
|
|
|
|
|
|
/** temporary test fucntion */
|
|
int testFunction(int times=0);
|
|
/**
|
|
write register
|
|
\param addr address
|
|
\param val value
|
|
\returns current register value
|
|
|
|
DO NOT USE!!! ONLY EXPERT USER!!!
|
|
*/
|
|
virtual int writeRegister(int addr, int val)=0;
|
|
|
|
|
|
/**
|
|
read register
|
|
\param addr address
|
|
\returns current register value
|
|
|
|
DO NOT USE!!! ONLY EXPERT USER!!!
|
|
*/
|
|
virtual int readRegister(int addr)=0;
|
|
/**
|
|
Returns the IP of the last client connecting to the detector
|
|
*/
|
|
virtual string getLastClientIP()=0;
|
|
|
|
|
|
|
|
/**
|
|
configures mac for gotthard readout
|
|
\returns OK or FAIL
|
|
*/
|
|
|
|
virtual int configureMAC()=0;
|
|
|
|
|
|
/** loads the modules settings/trimbits reading from a file
|
|
\param fname file name . If not specified, extension is automatically generated!
|
|
\param imod module number, -1 means all modules
|
|
\returns OK or FAIL
|
|
*/
|
|
virtual int loadSettingsFile(string fname, int imod=-1)=0;
|
|
|
|
|
|
|
|
/** saves the modules settings/trimbits writing to a file
|
|
\param fname file name . Axtension is automatically generated!
|
|
\param imod module number, -1 means all modules
|
|
\returns OK or FAIL
|
|
*/
|
|
virtual int saveSettingsFile(string fname, int imod=-1)=0;
|
|
|
|
|
|
|
|
/**
|
|
set dacs value
|
|
\param val value (in V)
|
|
\param index DAC index
|
|
\param imod module number (if -1 alla modules)
|
|
\returns current DAC value
|
|
*/
|
|
virtual float setDAC(float val, dacIndex index , int imod=-1)=0;
|
|
|
|
|
|
/**
|
|
gets ADC value
|
|
\param index ADC index
|
|
\param imod module number
|
|
\returns current ADC value
|
|
*/
|
|
virtual float getADC(dacIndex index, int imod=0)=0;
|
|
|
|
/**
|
|
get the maximum size of the detector
|
|
\param d dimension
|
|
\returns maximum number of modules that can be installed in direction d
|
|
*/
|
|
virtual int getMaxNumberOfModules(dimension d=X)=0;
|
|
|
|
|
|
/**
|
|
Writes the configuration file -- will contain all the informations needed for the configuration (e.g. for a PSI detector caldir, settingsdir, angconv, badchannels etc.)
|
|
\param fname file name
|
|
\returns OK or FAIL
|
|
*/
|
|
virtual int writeConfigurationFile(string const fname)=0;
|
|
|
|
protected:
|
|
static const int64_t thisSoftwareVersion=0x20120124;
|
|
|
|
|
|
protected:
|
|
|
|
//protected:
|
|
int *stoppedFlag;
|
|
|
|
int64_t *timerValue;
|
|
detectorSettings *currentSettings;
|
|
int *currentThresholdEV;
|
|
|
|
|
|
int totalProgress;
|
|
|
|
int progressIndex;
|
|
|
|
|
|
|
|
};
|
|
|
|
|
|
|
|
#endif
|