wip, doc

python/slsdet/detector.py

@@ -272,6 +272,7 @@ class Detector(CppDetectorApi):
 
     @property
     def triggers(self):
+        """Number of triggers per aquire. Set timing mode to use triggers."""
         return element_if_equal(self.getNumberOfTriggers())
 
     @triggers.setter
@@ -965,6 +966,17 @@ class Detector(CppDetectorApi):
 
     @property
     def trimbits(self):
+        """
+        [Eiger][Mythen3] Loads custom trimbit file to detector. 
+        Note
+        -----
+        If no extension specified, serial number of each module is attached.
+        :getter: Not implemented
+        Example
+        -------
+        >>> d.trimbits = '/path_to_file/noise'
+        - 14:53:27.931 INFO: Settings file loaded: /path_to_file/noise.sn000
+        """
         return NotImplementedError("trimbits are set only")
 
     @trimbits.setter
@@ -1240,6 +1252,16 @@ class Detector(CppDetectorApi):
 
     @property
     def trimen(self):
+        """
+        [Eiger] List of trim energies, where corresponding default trim files exist in corresponding trim folders.
+        Example
+        ------
+        >>> d.trimen
+        []
+        >>> d.trimen = [4500, 5400, 6400]
+        >>> d.trimen
+        [4500, 5400, 6400]
+        """
         return element_if_equal(self.getTrimEnergies())
 
     @trimen.setter
@@ -1256,6 +1278,12 @@ class Detector(CppDetectorApi):
 
     @property
     def type(self):
+        """ Returns detector type. Enum: detectorType
+        Note
+        ----
+        :setter: Not implemented
+        Values: EIGER, JUNGFRAU, GOTTHARD, MOENCH, MYTHEN3, GOTTHARD2, CHIPTESTBOARD
+        """
         return element_if_equal(self.getDetectorType())
 
     @property

slsDetectorSoftware/include/Detector.h

@@ -80,6 +80,8 @@ class Detector {
 
     Result<int64_t> getReceiverVersion(Positions pos = {}) const;
 
+    /** Options: EIGER, JUNGFRAU, GOTTHARD, MOENCH, MYTHEN3, GOTTHARD2,
+     * CHIPTESTBOARD */
     Result<defs::detectorType> getDetectorType(Positions pos = {}) const;
 
     /** Gets the total number of detectors */
@@ -118,7 +120,8 @@ class Detector {
      */
     void setSettings(defs::detectorSettings value, Positions pos = {});
 
-    /** [Eiger][Mythen3] */
+    /** [Eiger][Mythen3] If no extension specified, serial number of each module
+     * is attached. */
     void loadTrimbits(const std::string &fname, Positions pos = {});
 
     /** [Eiger][Mythen3] -1 if they are all different */
@@ -903,7 +906,8 @@ class Detector {
     /**[Eiger] Returns energies in eV where the module is trimmed */
     Result<std::vector<int>> getTrimEnergies(Positions pos = {}) const;
 
-    /** [Eiger] Set the energies where the detector is trimmed */
+    /** [Eiger] List of trim energies, where corresponding default trim files
+     * exist in corresponding trim folders */
     void setTrimEnergies(std::vector<int> energies, Positions pos = {});
 
     /** [Eiger] deadtime in ns, 0 = disabled */

slsDetectorSoftware/src/CmdProxy.h

@@ -1125,7 +1125,8 @@ class CmdProxy {
                     "\n\tReceiver version in format [0xYYMMDD].");
 
     GET_COMMAND(type, getDetectorType,
-                "\n\tSerial number or MAC of detector (hex).");
+                "\n\tReturns detector type. Can be Eiger, Jungfrau, Gotthard, "
+                "Moench, Mythen3, Gotthard2, ChipTestBoard");
 
     GET_COMMAND_NOID(nmod, size, "\n\tNumber of modules in shared memory.");
 
@@ -1170,8 +1171,8 @@ class CmdProxy {
 
     INTEGER_COMMAND_NOID(triggers, getNumberOfTriggers, setNumberOfTriggers,
                          StringTo<int64_t>,
-                         "[n_triggers]\n\tNumber of triggers per aquire. Use "
-                         "timing command to set timing mode.");
+                         "[n_triggers]\n\tNumber of triggers per aquire. Set "
+                         "timing mode to use triggers.");
 
     TIME_COMMAND(
         period, getPeriod, setPeriod,