mirror of
https://github.com/slsdetectorgroup/slsDetectorPackage.git
synced 2025-06-13 13:27:14 +02:00
WIP doc
This commit is contained in:
@ -197,6 +197,14 @@ class Detector(CppDetectorApi):
|
|||||||
|
|
||||||
@property
|
@property
|
||||||
def frames(self):
|
def frames(self):
|
||||||
|
"""Number of frames per acquisition. In trigger mode, number of frames per trigger.
|
||||||
|
|
||||||
|
Notes
|
||||||
|
-----
|
||||||
|
Cannot be set in modular level. ????
|
||||||
|
In scan mode, number of frames is set to number of steps.
|
||||||
|
[Gotthard2] Burst mode has a maximum of 2720 frames.
|
||||||
|
"""
|
||||||
return element_if_equal(self.getNumberOfFrames())
|
return element_if_equal(self.getNumberOfFrames())
|
||||||
|
|
||||||
@frames.setter
|
@frames.setter
|
||||||
@ -472,6 +480,7 @@ class Detector(CppDetectorApi):
|
|||||||
|
|
||||||
@property
|
@property
|
||||||
def fwrite(self):
|
def fwrite(self):
|
||||||
|
"""Enable or disable receiver file write. Default is enabled. """
|
||||||
return element_if_equal(self.getFileWrite())
|
return element_if_equal(self.getFileWrite())
|
||||||
|
|
||||||
@fwrite.setter
|
@fwrite.setter
|
||||||
|
@ -170,6 +170,8 @@ class Detector {
|
|||||||
|
|
||||||
Result<int64_t> getNumberOfFrames(Positions pos = {}) const;
|
Result<int64_t> getNumberOfFrames(Positions pos = {}) const;
|
||||||
|
|
||||||
|
/** In trigger mode, number of frames per trigger. In scan mode, number of
|
||||||
|
* frames is set to number of steps */
|
||||||
void setNumberOfFrames(int64_t value);
|
void setNumberOfFrames(int64_t value);
|
||||||
|
|
||||||
Result<int64_t> getNumberOfTriggers(Positions pos = {}) const;
|
Result<int64_t> getNumberOfTriggers(Positions pos = {}) const;
|
||||||
|
@ -203,7 +203,7 @@ std::string CmdProxy::Acquire(int action) {
|
|||||||
return os.str();
|
return os.str();
|
||||||
}
|
}
|
||||||
|
|
||||||
std::string CmdProxy::free(int action) {
|
std::string CmdProxy::Free(int action) {
|
||||||
// This function is purely for help, actual functionality is in the caller
|
// This function is purely for help, actual functionality is in the caller
|
||||||
return "free\n\tFree detector shared memory\n";
|
return "free\n\tFree detector shared memory\n";
|
||||||
}
|
}
|
||||||
|
@ -635,7 +635,7 @@ class CmdProxy {
|
|||||||
|
|
||||||
/* configuration */
|
/* configuration */
|
||||||
{"config", &CmdProxy::config},
|
{"config", &CmdProxy::config},
|
||||||
{"free", &CmdProxy::free},
|
{"free", &CmdProxy::Free},
|
||||||
{"parameters", &CmdProxy::parameters},
|
{"parameters", &CmdProxy::parameters},
|
||||||
{"hostname", &CmdProxy::Hostname},
|
{"hostname", &CmdProxy::Hostname},
|
||||||
{"virtual", &CmdProxy::VirtualServer},
|
{"virtual", &CmdProxy::VirtualServer},
|
||||||
@ -1011,7 +1011,7 @@ class CmdProxy {
|
|||||||
/* Commands */
|
/* Commands */
|
||||||
std::string ListCommands(int action);
|
std::string ListCommands(int action);
|
||||||
/* configuration */
|
/* configuration */
|
||||||
std::string free(int action);
|
std::string Free(int action);
|
||||||
// std::string config2(int action);
|
// std::string config2(int action);
|
||||||
std::string Hostname(int action);
|
std::string Hostname(int action);
|
||||||
std::string VirtualServer(int action);
|
std::string VirtualServer(int action);
|
||||||
@ -1161,9 +1161,10 @@ class CmdProxy {
|
|||||||
|
|
||||||
INTEGER_COMMAND_NOID(
|
INTEGER_COMMAND_NOID(
|
||||||
frames, getNumberOfFrames, setNumberOfFrames, StringTo<int64_t>,
|
frames, getNumberOfFrames, setNumberOfFrames, StringTo<int64_t>,
|
||||||
"[n_frames]\n\tNumber of frames per aquire. In trigger mode, number of "
|
"[n_frames]\n\tNumber of frames per acquisition. In "
|
||||||
"frames per trigger."
|
"trigger mode, number of frames per trigger. Cannot be set in modular "
|
||||||
"\n\t[Gotthard2] Burst mode has a maximum of 2720 frames.");
|
"level. In scan mode, number of frames is set to number of "
|
||||||
|
"steps.\n\t[Gotthard2] Burst mode has a maximum of 2720 frames.");
|
||||||
|
|
||||||
INTEGER_COMMAND_NOID(triggers, getNumberOfTriggers, setNumberOfTriggers,
|
INTEGER_COMMAND_NOID(triggers, getNumberOfTriggers, setNumberOfTriggers,
|
||||||
StringTo<int64_t>,
|
StringTo<int64_t>,
|
||||||
|
Reference in New Issue
Block a user