mirror of
https://github.com/slsdetectorgroup/slsDetectorPackage.git
synced 2025-05-06 12:50:02 +02:00
Dhanya Thattil
d1e5b0bc42
* udpated help on multi module and multi command help * fixed issues with empty lines and other syntax with docuemntation * fixed some warningsin documentation * some changes to documentation about command line usage * minor
18 lines
614 B
ReStructuredText
18 lines
614 B
ReStructuredText
Detector
|
|
==============================================
|
|
|
|
The sls::Detector is the public API to control
|
|
detectors from C++. This API is also used internally
|
|
for the Python bindings and the command line interface.
|
|
If a receiver has been configured, this is also controlled
|
|
through this class.
|
|
|
|
Most, if not all, functions are called in parallel
|
|
and the return value is a thin std::vector wrapper
|
|
containing results from all modules. (:ref:`Result class<Result Class>`)
|
|
|
|
Here are some :ref:`examples <Cplusplus Api Examples>` on how to use the API.
|
|
|
|
.. doxygenclass:: sls::Detector
|
|
:members:
|
|
:undoc-members: |