diff --git a/python/slsdet/detector.py b/python/slsdet/detector.py index 441fede71..77e502780 100755 --- a/python/slsdet/detector.py +++ b/python/slsdet/detector.py @@ -253,11 +253,12 @@ class Detector(CppDetectorApi): ----- This value is used to calculate row and column positions for each module and included into udp data packet header. \n By default, it adds modules in y dimension for 2d detectors and in x dimension for 1d detectors. - :setter: Not implemented Example ------- >>> d.detsize Geometry(x=3840, y=1) + >>> d.detsize = [1024, 512] + Geometry(x=1024, y = 512) """ return to_geo(self.getDetectorSize()) @@ -2761,6 +2762,14 @@ class Detector(CppDetectorApi): @property def initialchecks(self): + """ + Enable or disable intial compatibility and other checks at detector start up. + Note + ---- + It is enabled by default. Must come before 'hostname' command to take effect. \n + Can be used to reprogram fpga when current firmware is incompatible. \n + Advanced user function! + """ return self.getInitialChecks() @initialchecks.setter diff --git a/slsDetectorSoftware/include/Detector.h b/slsDetectorSoftware/include/Detector.h index 82d208407..658469605 100644 --- a/slsDetectorSoftware/include/Detector.h +++ b/slsDetectorSoftware/include/Detector.h @@ -353,9 +353,9 @@ class Detector { Result getImageTestMode(Positions pos = {}); /** [Gotthard] If 1, adds channel intensity with precalculated values. - * Default is 0 - * [Eiger virtual] If 1, pixels are saturated. If 0, increasing intensity - * Only for virtual servers */ + * Default is 0 \n + * [Eiger][Jungfrau] Only for virtual servers, if 1, pixels are saturated. + * If 0, increasing intensity */ void setImageTestMode(const int value, Positions pos = {}); /** gets list of temperature indices for this detector */ @@ -1122,6 +1122,7 @@ class Detector { Result> getInjectChannel(Positions pos = {}); /** [Gotthard2] + * Inject channels with current source for calibration. * offsetChannel is starting channel to be injected * incrementChannel is determines succeeding channels to be injected */ void setInjectChannel(const int offsetChannel, const int incrementChannel, @@ -1577,8 +1578,10 @@ class Detector { /** Advanced user Function! */ bool getInitialChecks() const; - /** initial compaibility and other server start up checks - * default enabled Advanced user Function! */ + /** Enables/disabled initial compaibility and other server start up checks. + * \n Default is enabled. Must come before 'hostname' command to take + * effect. \n Can be used to reprogram fpga when current firmware is + * incompatible. \n Advanced user Function! */ void setInitialChecks(const bool value); /** [CTB][Moench][Jungfrau] Advanced user Function! */ diff --git a/slsDetectorSoftware/src/CmdProxy.cpp b/slsDetectorSoftware/src/CmdProxy.cpp index f3b379f1b..103bc7df3 100644 --- a/slsDetectorSoftware/src/CmdProxy.cpp +++ b/slsDetectorSoftware/src/CmdProxy.cpp @@ -2612,7 +2612,8 @@ std::string CmdProxy::InitialChecks(int action) { os << "[0, 1]\n\tEnable or disable intial compatibility and other " "checks at detector start up. It is enabled by default. Must " "come before 'hostname' command to take effect. Can be used to " - "reprogram fpga when current firmware is incompatible." + "reprogram fpga when current firmware is " + "incompatible.\n\tAdvanced User function!" << '\n'; } else if (action == defs::GET_ACTION) { if (det_id != -1) {