detectors/slsDetectorPackage
25
0
Fork 0
mirror of https://github.com/slsdetectorgroup/slsDetectorPackage.git synced 2025-06-23 18:17:59 +02:00
Code Issues Actions Packages Releases Activity

doc warnings fixed

Browse Source
This commit is contained in:
maliakal_d
2020-06-23 17:32:56 +02:00
parent cd677e4d97
commit ba7f54744b
17 changed files with 59 additions and 72 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
slsDetectorSoftware/include/Detector.h
View File

@ -550,7 +550,7 @@ class Detector {
* Validates and sets the receiver.
* Updates local receiver cache parameters
* Configures the detector to the receiver as UDP destination
* @param receiver receiver hostname or IP address, can include tcp port eg.
* receiver is receiver hostname or IP address, can include tcp port eg.
* hostname:port
*/
void setRxHostname(const std::string &receiver, Positions pos = {});
@ -669,7 +669,7 @@ class Detector {
Result<int> getRxZmqFrequency(Positions pos = {}) const;
/** @param freq nth frame streamed out of receiver.
/** freq is nth frame streamed out of receiver.
* If 0, streaming timer is the timeout,
* after which current frame sent out. Default is 0 at 200 ms.
* Default is 1: send every frame.
@ -863,7 +863,7 @@ class Detector {
* and temperature control is enabled,
* power to chip will be switched off and
* temperature event will be set
* @param val value in degrees
* val is value in degrees
*/
void setThresholdTemperature(int temp, Positions pos = {});
@ -924,7 +924,7 @@ class Detector {
* [Gotthard]
* Options: Only a single ROI per module
* Can set only a single ROI at a time
* @param module position index
* module_id is position index
*/
void setROI(defs::ROI value, int module_id);
@ -956,8 +956,8 @@ class Detector {
Result<std::array<int, 2>> getInjectChannel(Positions pos = {});
/** [Gotthard2]
* @param offsetChannel starting channel to be injected
* @param incrementChannel determines succeeding channels to be injected */
* offsetChannel is starting channel to be injected
* incrementChannel is determines succeeding channels to be injected */
void setInjectChannel(const int offsetChannel, const int incrementChannel,
Positions pos = {});
@ -1166,8 +1166,8 @@ class Detector {
/**
* [CTB] Set Digital IO Delay
* cannot get
* @param digital IO mask to select the pins
* @param delay delay in ps(1 bit=25ps, max of 775 ps)
* pinMask is IO mask to select the pins
* delay is delay in ps(1 bit=25ps, max of 775 ps)
*/
void setDigitalIODelay(uint64_t pinMask, int delay, Positions pos = {});
@ -1335,11 +1335,10 @@ class Detector {
* [Jungfrau][Gotthard][CTB][Moench]
* Updates the firmware, detector server and then reboots detector
* controller blackfin.
* @param sname name of detector server binary found on tftp folder of host
* sname is name of detector server binary found on tftp folder of host
* pc
* @param hostname name of pc to tftp from
* @param fname programming file name
* @param pos detector positions
* hostname is name of pc to tftp from
* fname is programming file name
*/
void updateFirmwareAndServer(const std::string &sname,
const std::string &hostname,

4
slsDetectorSoftware/include/detectorData.h
View File

@ -11,9 +11,9 @@ class detectorData {
* Constructor
* @param progress progress index
* @param fname file name prefix
* @param nx number of detector channels (1D detector) or dimension in x (2D
* @param x number of detector channels (1D detector) or dimension in x (2D
* detector)
* @param ny dimension in y (2D detector)
* @param y dimension in y (2D detector)
* @param d pointer to data in char* format
* @param dbytes number of bytes of image pointed to by cval pointer
* @param dr dynamic range or bits per pixel

10
slsDetectorSoftware/src/DetectorImpl.h
View File

@ -68,7 +68,7 @@ class DetectorImpl : public virtual slsDetectorDefs {
public:
/**
* Constructor
* @param id multi detector id
* @param multi_id multi detector id
* @param verify true to verify if shared memory version matches existing
* one
* @param update true to update last user pid, date etc
@ -213,7 +213,7 @@ class DetectorImpl : public virtual slsDetectorDefs {
/**
* Connect to Virtual Detector Servers at local host
* @param ndet number of detectors
* @param numdet number of detectors
* @param port starting port number
*/
void setVirtualDetectorServers(const int numdet, const int port);
@ -283,8 +283,7 @@ class DetectorImpl : public virtual slsDetectorDefs {
* [Jungfrau][Ctb] from pof file
* [Mythen3][Gotthard2] from rbf file
* @param fname name of pof/rbf file
* @param fpgasrc pointer in memory to read programming file to
* @returns file size
* @returns binary of the program
*/
std::vector<char> readProgrammingFile(const std::string &fname);
@ -302,7 +301,6 @@ class DetectorImpl : public virtual slsDetectorDefs {
* Creates shm and initializes shm structure OR
* Open shm and maps to structure
* @param verify true to verify if shm size matches existing one
* @param update true to update last user pid, date etc
*/
void initSharedMemory(bool verify = true);
@ -364,7 +362,7 @@ class DetectorImpl : public virtual slsDetectorDefs {
/**
* Main thread sets if the processing thread should join it
* @param v true if it should join, else false
* @param value true if it should join, else false
*/
void setJoinThreadFlag(bool value);

12
slsDetectorSoftware/src/Module.h
View File

@ -64,12 +64,12 @@ class Module : public virtual slsDetectorDefs {
* ************************************************/
/** creating new shared memory
@param verify if shared memory version matches existing one */
verify is if shared memory version matches existing one */
explicit Module(detectorType type, int det_id = 0, int module_id = 0,
bool verify = true);
/** opening existing shared memory
@param verify if shared memory version matches existing one */
verify is if shared memory version matches existing one */
explicit Module(int det_id = 0, int module_id = 0, bool verify = true);
virtual ~Module();
@ -81,7 +81,7 @@ class Module : public virtual slsDetectorDefs {
bool isFixedPatternSharedMemoryCompatible();
std::string getHostname() const;
/** @param initialChecks enable or disable initial compatibility checks and
/** initialChecks is enable or disable initial compatibility checks and
other server start up checks. Enabled by default. Disable only for advanced
users! */
void setHostname(const std::string &hostname, const bool initialChecks);
@ -600,11 +600,11 @@ class Module : public virtual slsDetectorDefs {
Ret sendToReceiver(int fnum, const Arg &args) const;
/** Get Detector Type from Shared Memory
@param verify if shm size matches existing one */
verify is if shm size matches existing one */
detectorType getDetectorTypeFromShm(int det_id, bool verify = true);
/** Initialize shared memory
@param verify if shm size matches existing one */
verify is if shm size matches existing one */
void initSharedMemory(detectorType type, int det_id, bool verify = true);
/** Initialize detector structure to defaults,
@ -639,7 +639,7 @@ class Module : public virtual slsDetectorDefs {
* @param energy energy to trim at
* @param e1 reference trim value
* @param e2 reference trim value
* @param tb 1 to include trimbits, 0 to exclude (used for eiger)
* @param trimbits 1 to include trimbits, 0 to exclude (used for eiger)
* @returns the pointer to the module structure with interpolated values or
* NULL if error
*/

4
slsDetectorSoftware/src/SharedMemory.h
View File

@ -92,7 +92,6 @@ template <typename T> class SharedMemory {
/**
* Verify if it exists
* @param name of shared memory
* @return true if exists, else false
*/
bool IsExisting() {
@ -116,7 +115,6 @@ template <typename T> class SharedMemory {
* Create Shared memory and call MapSharedMemory to map it to an address
* throws a SharedMemoryError exception on failure to create, ftruncate or
* map
* @param sz of shared memory
*/
void CreateSharedMemory() {
fd = shm_open(name.c_str(), O_CREAT | O_TRUNC | O_EXCL | O_RDWR,
@ -144,7 +142,6 @@ template <typename T> class SharedMemory {
/**
* Open existing Shared memory and call MapSharedMemory to map it to an
* address throws a SharedMemoryError exception on failure to open or map
* @param sz of shared memory
*/
void OpenSharedMemory() {
fd = shm_open(name.c_str(), O_RDWR, 0);
@ -248,7 +245,6 @@ template <typename T> class SharedMemory {
/**
* Map shared memory to an address
* throws a SharedMemoryException exception on failure
* @param sz of shared memory
*/
T *MapSharedMemory() {