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

Merge branch 'developer' into rr_rxr

Browse Source
This commit is contained in:
maliakal_d
2021-10-22 16:12:04 +02:00
parent 578528eb59 1454cc8434
commit c3499c0b93
51 changed files with 530 additions and 482 deletions
Download Patch File Download Diff File Expand all files Collapse all files

57
slsDetectorSoftware/include/sls/Detector.h
View File

@ -30,6 +30,14 @@ class Detector {
std::unique_ptr<DetectorImpl> pimpl;
public:
/** @name Configuration */
///@{
/**************************************************
* *
* Configuration *
* *
* ************************************************/
/**
* @param shm_id detector shared memory id
* Default value is 0. Can be set to more values for
@ -38,13 +46,6 @@ class Detector {
*/
Detector(int shm_id = 0);
~Detector();
/** @name Configuration */
///@{
/**************************************************
* *
* Configuration *
* *
* ************************************************/
/** Free the shared memory of this detector and all modules
belonging to it */
@ -191,7 +192,7 @@ class Detector {
void setFlipRows(bool value, Positions pos = {});
Result<bool> isVirtualDetectorServer(Positions pos = {}) const;
///@{
///@}
/** @name Callbacks */
///@{
@ -222,7 +223,7 @@ class Detector {
void registerDataCallback(void (*func)(detectorData *, uint64_t, uint32_t,
void *),
void *pArg);
///@{
///@}
/** @name Acquisition Parameters */
///@{
@ -526,7 +527,7 @@ class Detector {
*/
void setReadNRows(const int lines, Positions pos = {});
///@{
///@}
/** @name Acquisition */
///@{
@ -613,7 +614,7 @@ class Detector {
/** Gets Scan error message if scan ended in error for non blocking
* acquisitions.*/
Result<std::string> getScanErrorMessage(Positions pos = {}) const;
///@{
///@}
/** @name Network Configuration (Detector<->Receiver) */
///@{
@ -802,7 +803,7 @@ class Detector {
* port
*/
void setTransmissionDelayRight(int value, Positions pos = {});
///@{
///@}
/** @name Receiver Configuration */
///@{
@ -893,7 +894,7 @@ class Detector {
* streamer yet or there is no second interface, it gives 0 in its place. */
Result<std::array<pid_t, NUM_RX_THREAD_IDS>>
getRxThreadIds(Positions pos = {}) const;
///@{
///@}
/** @name File */
///@{
@ -949,7 +950,7 @@ class Detector {
/** Default depends on detector type. \n 0 will set frames per file in an
* acquisition to unlimited */
void setFramesPerFile(int n, Positions pos = {});
///@{
///@}
/** @name ZMQ Streaming Parameters (Receiver<->Client) */
///@{
@ -1058,7 +1059,7 @@ class Detector {
*/
void setRxZmqHwm(const int limit);
///@{
///@}
/** @name Eiger Specific */
///@{
@ -1157,7 +1158,7 @@ class Detector {
void setDataStream(const defs::portPosition port, const bool enable,
Positions pos = {});
///@{
///@}
/** @name Jungfrau Specific */
///@{
@ -1257,13 +1258,13 @@ class Detector {
void setGainMode(const defs::gainMode mode, Positions pos = {});
/** [Jungfrau] Advanced */
Result<int> getFilterCell(Positions pos = {}) const;
Result<int> getNumberOfFilterCells(Positions pos = {}) const;
/** [Jungfrau] Advanced Options[0-12], only for chip v1.1
*/
void setFilterCell(int cell, Positions pos = {});
void setNumberOfFilterCells(int cell, Positions pos = {});
///@{
///@}
/** @name Gotthard Specific */
///@{
@ -1290,7 +1291,7 @@ class Detector {
/** [Gotthard] */
Result<ns> getExptimeLeft(Positions pos = {}) const;
///@{
///@}
/** @name Gotthard2 Specific */
///@{
@ -1407,7 +1408,7 @@ class Detector {
/** [Gotthard2] */
void setBadChannels(const std::string &fname, Positions pos = {});
///@{
///@}
/** @name Mythen3 Specific */
///@{
@ -1464,7 +1465,7 @@ class Detector {
Result<int> getGainCaps(Positions pos = {});
///@{
///@}
/** @name CTB / Moench Specific */
///@{
@ -1523,7 +1524,7 @@ class Detector {
/** [CTB][Moench] If any of a consecutive 4 bits are enabled, the "
"complete 4 bits are enabled */
void setTenGigaADCEnableMask(uint32_t mask, Positions pos = {});
///@{
///@}
/** @name CTB Specific */
///@{
@ -1605,7 +1606,7 @@ class Detector {
/** [CTB] Default is enabled. */
void setLEDEnable(bool enable, Positions pos = {});
///@{
///@}
/** @name Pattern */
///@{
@ -1692,7 +1693,7 @@ class Detector {
/** [Mythen3] */
void startPattern(Positions pos = {});
///@{
///@}
/** @name Moench specific */
///@{
@ -1726,7 +1727,7 @@ class Detector {
void setAdditionalJsonParameter(const std::string &key,
const std::string &value,
Positions pos = {});
///@{
///@}
/** @name Advanced */
///@{
@ -1823,7 +1824,7 @@ class Detector {
/** [CTB][Moench][Jungfrau] Advanced user Function! \n
[Jungfrau] Inversions on top of default mask */
void setADCInvert(uint32_t value, Positions pos = {});
///@{
///@}
/** @name Insignificant */
///@{
@ -1875,7 +1876,7 @@ class Detector {
std::string getUserDetails() const;
Result<uint64_t> getRxCurrentFrameIndex(Positions pos = {}) const;
///@{
///@}
private:
std::vector<int> getPortNumbers(int start_port);