diff --git a/docs/images_src/detector_data_format.drawio b/docs/images_src/detector_data_format.drawio index 1287bec75..6f11489de 100644 --- a/docs/images_src/detector_data_format.drawio +++ b/docs/images_src/detector_data_format.drawio @@ -1,1307 +1,1368 @@ - + - + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - - - - + + - - + + - - + + - - + + - - + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - - - + + + + - - + + - - - - + + + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/images_src/system_communication_architecture.drawio b/docs/images_src/system_communication_architecture.drawio index 0e22ece27..3143dd72e 100644 --- a/docs/images_src/system_communication_architecture.drawio +++ b/docs/images_src/system_communication_architecture.drawio @@ -1,785 +1,830 @@ - + - + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - - - - - - - - - - - - - - - - - - + + + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - + - + - + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - + - + - + - + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - - - - - - - - - - - - - - - - - - - - - - - - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/src/configcommands.rst b/docs/src/configcommands.rst index dbc0eabd6..b05360012 100644 --- a/docs/src/configcommands.rst +++ b/docs/src/configcommands.rst @@ -18,8 +18,8 @@ This package typically deals with two types of network interfaces: Client to Module ----------------- -.. figure:: images/Client_module_commands.png - :target: _images/Client_module_commands.png +.. figure:: images/Client_module_commands.svg + :target: _images/Client_module_commands.svg :width: 700px :align: center :alt: Client Module Commands @@ -60,8 +60,8 @@ Each physical module has its own unique IP address. As the IPs are already diffe Client to Receiver -------------------- -.. figure:: images/Client_receiver_commands.png - :target: _images/Client_receiver_commands.png +.. figure:: images/Client_receiver_commands.svg + :target: _images/Client_receiver_commands.svg :align: center :alt: Client Receiver Commands @@ -112,8 +112,8 @@ For example, using default TCP ports (1954, 1955): Module to Receiver ------------------- -.. figure:: images/Module_receiver_commands.png - :target: _images/Module_receiver_commands.png +.. figure:: images/Module_receiver_commands.svg + :target: _images/Module_receiver_commands.svg :align: center :alt: Module Receiver Commands @@ -173,13 +173,13 @@ As it is a one-way communication (module to receiver with no reply or acknowledg **UDP source port** - This is hardcoded in every module to the same value in the detector server and cannot be changed. -Note: If there is a second UDP port on the module, use 'udp_dstport2' or 'udp_dstip2'etc. See `here `_ for more detector specific info. +Note: If there is a second UDP port on the module, use 'udp_dstport2' or 'udp_dstip2' etc. See `here `_ for more detector specific info. Receiver to GUI ----------------- -.. figure:: images/Receiver_gui_commands.png - :target: _images/Receiver_gui_commands.png +.. figure:: images/Receiver_gui_commands.svg + :target: _images/Receiver_gui_commands.svg :align: center :alt: Receiver GUI Commands @@ -216,8 +216,8 @@ Enabling the GUI automatically streams images from the receiver via ZMQ sockets. Receiver to External Processing -------------------------------- -.. figure:: images/Receiver_external_process_commands.png - :target: _images/Receiver_external_process_commands.png +.. figure:: images/Receiver_external_process_commands.svg + :target: _images/Receiver_external_process_commands.svg :align: center :alt: Click to zoom diff --git a/docs/src/dataformat.rst b/docs/src/dataformat.rst index a8c2f0991..72d57f9b5 100644 --- a/docs/src/dataformat.rst +++ b/docs/src/dataformat.rst @@ -11,8 +11,8 @@ Jungfrau Single Port Configuration ^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. image:: images/Jungfrau_module.png - :target: _images/Jungfrau_module.png +.. image:: images/Jungfrau_module.svg + :target: _images/Jungfrau_module.svg :width: 650px :align: center :alt: Jungfrau Module Single Port Configuration @@ -29,8 +29,8 @@ Total image size = 524,288 bytes Double Port Configuration ^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. image:: images/Jungfrau_two_port.png - :target: _images/Jungfrau_two_port.png +.. image:: images/Jungfrau_two_port.svg + :target: _images/Jungfrau_two_port.svg :width: 500px :align: center :alt: Jungfrau Module Two Port Configuration @@ -51,8 +51,8 @@ Image size per UDP port or File = 262,144 bytes Read Partial Rows ^^^^^^^^^^^^^^^^^^ -.. image:: images/Jungfrau_read_rows.png - :target: _images/Jungfrau_read_rows.png +.. image:: images/Jungfrau_read_rows.svg + :target: _images/Jungfrau_read_rows.svg :width: 550px :align: center :alt: Jungfrau Module Read Partial Rows Configuration @@ -74,8 +74,8 @@ Moench Single Port Configuration ^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. image:: images/Moench_module.png - :target: _images/Moench_module.png +.. image:: images/Moench_module.svg + :target: _images/Moench_module.svg :width: 550px :align: center :alt: Moench Module Single Port Configuration @@ -91,8 +91,8 @@ Total image size = 320,000 bytes Double Port Configuration ^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. image:: images/Moench_two_port.png - :target: _images/Moench_two_port.png +.. image:: images/Moench_two_port.svg + :target: _images/Moench_two_port.svg :width: 400px :align: center :alt: Moench Module Two Port Configuration @@ -113,8 +113,8 @@ Image size per UDP port or File = 160,000 bytes Read Partial Rows ^^^^^^^^^^^^^^^^^^ -.. image:: images/Moench_read_rows.png - :target: _images/Moench_read_rows.png +.. image:: images/Moench_read_rows.svg + :target: _images/Moench_read_rows.svg :width: 400px :align: center :alt: Moench Module Read Partial Rows Configuration @@ -135,8 +135,8 @@ Eiger Default Configuration ^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. image:: images/Eiger_module.png - :target: _images/Eiger_module.png +.. image:: images/Eiger_module.svg + :target: _images/Eiger_module.svg :width: 350px :align: center :alt: Eiger Module Default Configuration @@ -157,8 +157,8 @@ The myth, the legend, the bottom ports: Demystifying them ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. figure:: images/Eiger_bottom_1.png - :target: _images/Eiger_bottom_1.png +.. figure:: images/Eiger_bottom_1.svg + :target: _images/Eiger_bottom_1.svg :width: 350px :align: center :alt: Eiger Bottom as Firmware gets it @@ -166,8 +166,8 @@ The myth, the legend, the bottom ports: Demystifying them How the firmware gets the images -.. figure:: images/Eiger_bottom_2.png - :target: _images/Eiger_bottom_2.png +.. figure:: images/Eiger_bottom_2.svg + :target: _images/Eiger_bottom_2.svg :width: 350px :align: center :alt: Eiger Bottom after the firmware flips it horizontally @@ -175,8 +175,8 @@ The myth, the legend, the bottom ports: Demystifying them After the firmware flips it horizontally -.. figure:: images/Eiger_bottom_3.png - :target: _images/Eiger_bottom_3.png +.. figure:: images/Eiger_bottom_3.svg + :target: _images/Eiger_bottom_3.svg :width: 350px :align: center :alt: After the software swaps the udp ports @@ -184,8 +184,8 @@ The myth, the legend, the bottom ports: Demystifying them After the software swaps the udp ports -.. figure:: images/Eiger_bottom_4.png - :target: _images/Eiger_bottom_4.png +.. figure:: images/Eiger_bottom_4.svg + :target: _images/Eiger_bottom_4.svg :width: 400px :align: center :alt: After the gui has flipped the bottom vertically @@ -223,8 +223,8 @@ Note: Only the activated ports will write data as it does not make sense to writ **Read Partial Rows**: The number of image rows per port can be adjusted using the `readnrows `_ command. By default, 256 rows are read, but a smaller value centers the readout vertically (e.g., 8 rows reads 4 above and 4 below the center). Increasing the value symmetrically expands the region toward the top and bottom. Permissible values depend on dynamic range and 10GbE enable. -.. image:: images/Eiger_read_rows.png - :target: _images/Eiger_read_rows.png +.. image:: images/Eiger_read_rows.svg + :target: _images/Eiger_read_rows.svg :width: 400px :align: center :alt: Eiger Module Read Partial Rows Configuration @@ -247,8 +247,8 @@ As with any standard half-module, it includes one control TCP port (with a hostn In this configuration, the fliprows command cannot be used to flip the entire half-module. Instead, the receiver automatically includes row-flipping information only for the second UDP port in the JSON header, so the GUI can apply the correct orientation during display -.. image:: images/Eiger_quad.png - :target: _images/Eiger_quad.png +.. image:: images/Eiger_quad.svg + :target: _images/Eiger_quad.svg :width: 300px :align: center :alt: Eiger Quad Configuration @@ -263,8 +263,8 @@ Mythen3 Default Configuration ^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. image:: images/Mythen3_module.png - :target: _images/Mythen3_module.png +.. image:: images/Mythen3_module.svg + :target: _images/Mythen3_module.svg :align: center :alt: Mythen3 Module Default Configuration @@ -306,8 +306,8 @@ Gotthard2 Default Configuration ^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. image:: images/Gotthard2_module.png - :target: _images/Gotthard2_module.png +.. image:: images/Gotthard2_module.svg + :target: _images/Gotthard2_module.svg :align: center :alt: Gotthard2 Module Default Configuration diff --git a/docs/src/images/Client_architecture.png b/docs/src/images/Client_architecture.png deleted file mode 100644 index 17c7f2797..000000000 Binary files a/docs/src/images/Client_architecture.png and /dev/null differ diff --git a/docs/src/images/Client_architecture.svg b/docs/src/images/Client_architecture.svg new file mode 100644 index 000000000..0332f9175 --- /dev/null +++ b/docs/src/images/Client_architecture.svg @@ -0,0 +1,3 @@ + + +
<<class>> Module
<<class>> Module
<<class>> Module
<<class>> Module (s)
C++ API
Python API%3CmxGraphModel%3E%3Croot%3E%3CmxCell%20id%3D%220%22%2F%3E%3CmxCell%20id%3D%221%22%20parent%3D%220%22%2F%3E%3CmxCell%20id%3D%222%22%20value%3D%22%26lt%3Bfont%20face%3D%26quot%3BCourier%20New%26quot%3B%26gt%3BC%2B%2B%20API%26lt%3B%2Ffont%26gt%3B%22%20style%3D%22rounded%3D1%3BwhiteSpace%3Dwrap%3Bhtml%3D1%3BfillColor%3D%2377AADD%3BstrokeColor%3D%2377AADD%3BlabelPosition%3Dcenter%3BverticalLabelPosition%3Dmiddle%3Balign%3Dcenter%3BverticalAlign%3Dmiddle%3BfontSize%3D17%3BgradientColor%3Dnone%3BfontColor%3D%23FFFFFF%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%22-180%22%20y%3D%224998%22%20width%3D%22146%22%20height%3D%2284%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3C%2Froot%3E%3C%2FmxGraphModel%3E
CLI
Qt GUI
<<class>> Detector
slsDetectorPackage
Client (C++17)
CLIENT
Shared Memory(s)
Module 3
Module 2
Module 1
Module (s)
Module 3
Module 2
Module 1
Receiver (s)
 \ No newline at end of file diff --git a/docs/src/images/Client_module_commands.png b/docs/src/images/Client_module_commands.png deleted file mode 100644 index e9b71c99a..000000000 Binary files a/docs/src/images/Client_module_commands.png and /dev/null differ diff --git a/docs/src/images/Client_module_commands.svg b/docs/src/images/Client_module_commands.svg new file mode 100644 index 000000000..8d761aae5 --- /dev/null +++ b/docs/src/images/Client_module_commands.svg @@ -0,0 +1,3 @@ + + +
TCP
Client
TCP
Control
Module
1952 / 1953
bchip101
port     = 1952
stopport = 1953
hostname = bchip101
Module
1952 / 1953
bchip100
port     = 1952
stopport = 1953
hostname = bchip100
 \ No newline at end of file diff --git a/docs/src/images/Client_receiver_commands.png b/docs/src/images/Client_receiver_commands.png deleted file mode 100644 index b3221e1c5..000000000 Binary files a/docs/src/images/Client_receiver_commands.png and /dev/null differ diff --git a/docs/src/images/Client_receiver_commands.svg b/docs/src/images/Client_receiver_commands.svg new file mode 100644 index 000000000..a1f521ee0 --- /dev/null +++ b/docs/src/images/Client_receiver_commands.svg @@ -0,0 +1,3 @@ + + +
Client
TCP
Control
Receiver
1955
pc1234
rx_tcpport = 1955
rx_hostname = pc1234
Receiver
1954
pc1234
rx_tcpport = 1954
rx_hostname = pc1234
TCP
 \ No newline at end of file diff --git a/docs/src/images/Eiger_bottom_1.png b/docs/src/images/Eiger_bottom_1.png deleted file mode 100644 index c1b8b4617..000000000 Binary files a/docs/src/images/Eiger_bottom_1.png and /dev/null differ diff --git a/docs/src/images/Eiger_bottom_1.svg b/docs/src/images/Eiger_bottom_1.svg new file mode 100644 index 000000000..697765dc2 --- /dev/null +++ b/docs/src/images/Eiger_bottom_1.svg @@ -0,0 +1,3 @@ + + +
UDP Port 1
UDP Port 2
1
3
2
4
 \ No newline at end of file diff --git a/docs/src/images/Eiger_bottom_2.png b/docs/src/images/Eiger_bottom_2.png deleted file mode 100644 index a96f12f4d..000000000 Binary files a/docs/src/images/Eiger_bottom_2.png and /dev/null differ diff --git a/docs/src/images/Eiger_bottom_2.svg b/docs/src/images/Eiger_bottom_2.svg new file mode 100644 index 000000000..984406558 --- /dev/null +++ b/docs/src/images/Eiger_bottom_2.svg @@ -0,0 +1,3 @@ + + +
UDP Port 1
UDP Port 2
 \ No newline at end of file diff --git a/docs/src/images/Eiger_bottom_3.png b/docs/src/images/Eiger_bottom_3.png deleted file mode 100644 index d60ddb4f2..000000000 Binary files a/docs/src/images/Eiger_bottom_3.png and /dev/null differ diff --git a/docs/src/images/Eiger_bottom_3.svg b/docs/src/images/Eiger_bottom_3.svg new file mode 100644 index 000000000..7cead35bc --- /dev/null +++ b/docs/src/images/Eiger_bottom_3.svg @@ -0,0 +1,3 @@ + + +
UDP Port 1
UDP Port 2
 \ No newline at end of file diff --git a/docs/src/images/Eiger_bottom_4.png b/docs/src/images/Eiger_bottom_4.png deleted file mode 100644 index 1d3fc6e6c..000000000 Binary files a/docs/src/images/Eiger_bottom_4.png and /dev/null differ diff --git a/docs/src/images/Eiger_bottom_4.svg b/docs/src/images/Eiger_bottom_4.svg new file mode 100644 index 000000000..3bebad3ac --- /dev/null +++ b/docs/src/images/Eiger_bottom_4.svg @@ -0,0 +1,3 @@ + + +
UDP Port 1
UDP Port 2
1
2
3
4
 \ No newline at end of file diff --git a/docs/src/images/Eiger_module.png b/docs/src/images/Eiger_module.png deleted file mode 100644 index 44a36d072..000000000 Binary files a/docs/src/images/Eiger_module.png and /dev/null differ diff --git a/docs/src/images/Eiger_module.svg b/docs/src/images/Eiger_module.svg new file mode 100644 index 000000000..8d0c37b78 --- /dev/null +++ b/docs/src/images/Eiger_module.svg @@ -0,0 +1,3 @@ + + +
Top Half Module
1
2
UDP Port 1
256 pixels
3
4
UDP Port 2
Control Port
256 pixels
Bottom Half Module
UDP Port 1
256 pixels
UDP Port 2
1
3
2
4
256 pixels
Control Port
Single Module
 \ No newline at end of file diff --git a/docs/src/images/Eiger_quad.png b/docs/src/images/Eiger_quad.png deleted file mode 100644 index 462ade28a..000000000 Binary files a/docs/src/images/Eiger_quad.png and /dev/null differ diff --git a/docs/src/images/Eiger_quad.svg b/docs/src/images/Eiger_quad.svg new file mode 100644 index 000000000..35d268b39 --- /dev/null +++ b/docs/src/images/Eiger_quad.svg @@ -0,0 +1,3 @@ + + +
1
2
256 pixels
4
3
256 pixels
UDP Port 1
Control Port
Quad
(Top Half Module)
UDP Port 2
 \ No newline at end of file diff --git a/docs/src/images/Eiger_read_rows.png b/docs/src/images/Eiger_read_rows.png deleted file mode 100644 index 5f2175de0..000000000 Binary files a/docs/src/images/Eiger_read_rows.png and /dev/null differ diff --git a/docs/src/images/Eiger_read_rows.svg b/docs/src/images/Eiger_read_rows.svg new file mode 100644 index 000000000..e4e74025e --- /dev/null +++ b/docs/src/images/Eiger_read_rows.svg @@ -0,0 +1,3 @@ + + +
1
2
UDP Port 1
3
4
UDP Port 2
UDP Port 1
UDP Port 2
3
2
4
1
 \ No newline at end of file diff --git a/docs/src/images/Gotthard2_module.png b/docs/src/images/Gotthard2_module.png deleted file mode 100644 index dffbd45dd..000000000 Binary files a/docs/src/images/Gotthard2_module.png and /dev/null differ diff --git a/docs/src/images/Gotthard2_module.svg b/docs/src/images/Gotthard2_module.svg new file mode 100644 index 000000000..ae1f29c7c --- /dev/null +++ b/docs/src/images/Gotthard2_module.svg @@ -0,0 +1,3 @@ + + +
Single Module
2
3
4
5
6
7
8
9
10
10 Chips
1
128 channels
Control Port
Veto Data Port
Data Port
 \ No newline at end of file diff --git a/docs/src/images/Jungfrau_module.png b/docs/src/images/Jungfrau_module.png deleted file mode 100644 index 5de6fccbe..000000000 Binary files a/docs/src/images/Jungfrau_module.png and /dev/null differ diff --git a/docs/src/images/Jungfrau_module.svg b/docs/src/images/Jungfrau_module.svg new file mode 100644 index 000000000..a4f744a7a --- /dev/null +++ b/docs/src/images/Jungfrau_module.svg @@ -0,0 +1,3 @@ + + +
Single Module
3
1
2
4
7
5
6
8
256 pixels
256 pixels
8 Chips
Outer Data Port
Inner Data Port
Control Port
 \ No newline at end of file diff --git a/docs/src/images/Jungfrau_read_rows.png b/docs/src/images/Jungfrau_read_rows.png deleted file mode 100644 index 701cfa913..000000000 Binary files a/docs/src/images/Jungfrau_read_rows.png and /dev/null differ diff --git a/docs/src/images/Jungfrau_read_rows.svg b/docs/src/images/Jungfrau_read_rows.svg new file mode 100644 index 000000000..e1d9c163b --- /dev/null +++ b/docs/src/images/Jungfrau_read_rows.svg @@ -0,0 +1,3 @@ + + +
3
1
2
4
7
5
6
8
Outer Data Port
Inner Data Port
 \ No newline at end of file diff --git a/docs/src/images/Jungfrau_two_port.png b/docs/src/images/Jungfrau_two_port.png deleted file mode 100644 index cd7703111..000000000 Binary files a/docs/src/images/Jungfrau_two_port.png and /dev/null differ diff --git a/docs/src/images/Jungfrau_two_port.svg b/docs/src/images/Jungfrau_two_port.svg new file mode 100644 index 000000000..3c52f9fe1 --- /dev/null +++ b/docs/src/images/Jungfrau_two_port.svg @@ -0,0 +1,3 @@ + + +
3
1
2
4
7
5
6
8
Inner Data Port
Outer Data Port
 \ No newline at end of file diff --git a/docs/src/images/Module_architecture.png b/docs/src/images/Module_architecture.png deleted file mode 100644 index 5f5c62650..000000000 Binary files a/docs/src/images/Module_architecture.png and /dev/null differ diff --git a/docs/src/images/Module_architecture.svg b/docs/src/images/Module_architecture.svg new file mode 100644 index 000000000..d9697aeb3 --- /dev/null +++ b/docs/src/images/Module_architecture.svg @@ -0,0 +1,3 @@ + + +
Client
Control Server
(C98)
Stop Server
(C98)
Client 
On-board CPU
Registers
FPGA (VHDL)
UDP Generator
Readout and Processing Logic
Stop
Control
Sensor & Chip
Control
Data
MODULE
Spawns
UDP Port
UDP Port 2
TCP Port
Control
TCP Port
Stop
Receiver
Receiver
Data
 \ No newline at end of file diff --git a/docs/src/images/Module_receiver_commands.png b/docs/src/images/Module_receiver_commands.png deleted file mode 100644 index b9831a7f6..000000000 Binary files a/docs/src/images/Module_receiver_commands.png and /dev/null differ diff --git a/docs/src/images/Module_receiver_commands.svg b/docs/src/images/Module_receiver_commands.svg new file mode 100644 index 000000000..2dbe45c03 --- /dev/null +++ b/docs/src/images/Module_receiver_commands.svg @@ -0,0 +1,3 @@ + + +
UDP
Receiver
pc1234
10.0.1.100
Raw Data 
Packets
udp src port: hardcoded (32410)
udp_srcip   : 10.0.1.15
Module
bchip100
udp_dstport: 50001
udp_dstip  : 10.0.1.100
udp_dstmac : (specify for
              custom receivers)
UDP
Receiver
pc1234
10.0.2.100
Raw Data 
Packets
Module
bchip101
udp src port: hardcoded (32410)
udp_srcip   : 10.0.2.15
udp_dstport: 50002
udp_dstip  : 10.0.2.100
udp_dstmac : (specify for
              custom receivers)
 \ No newline at end of file diff --git a/docs/src/images/Moench_module.png b/docs/src/images/Moench_module.png deleted file mode 100644 index 975ffb325..000000000 Binary files a/docs/src/images/Moench_module.png and /dev/null differ diff --git a/docs/src/images/Moench_module.svg b/docs/src/images/Moench_module.svg new file mode 100644 index 000000000..e98e1568d --- /dev/null +++ b/docs/src/images/Moench_module.svg @@ -0,0 +1,3 @@ + + +
Single Module
400 pixels
400 pixels
Control Port
Outer Data Port
Inner Data Port
 \ No newline at end of file diff --git a/docs/src/images/Moench_read_rows.png b/docs/src/images/Moench_read_rows.png deleted file mode 100644 index 696df2120..000000000 Binary files a/docs/src/images/Moench_read_rows.png and /dev/null differ diff --git a/docs/src/images/Moench_read_rows.svg b/docs/src/images/Moench_read_rows.svg new file mode 100644 index 000000000..6e097e351 --- /dev/null +++ b/docs/src/images/Moench_read_rows.svg @@ -0,0 +1,3 @@ + + +
Outer Data Port
Inner Data Port
 \ No newline at end of file diff --git a/docs/src/images/Moench_two_port.png b/docs/src/images/Moench_two_port.png deleted file mode 100644 index b3c4f22d7..000000000 Binary files a/docs/src/images/Moench_two_port.png and /dev/null differ diff --git a/docs/src/images/Moench_two_port.svg b/docs/src/images/Moench_two_port.svg new file mode 100644 index 000000000..1eca321ed --- /dev/null +++ b/docs/src/images/Moench_two_port.svg @@ -0,0 +1,3 @@ + + +
Inner Data Port
Outer Data Port
 \ No newline at end of file diff --git a/docs/src/images/Mythen3_module.png b/docs/src/images/Mythen3_module.png deleted file mode 100644 index 73eccfe1f..000000000 Binary files a/docs/src/images/Mythen3_module.png and /dev/null differ diff --git a/docs/src/images/Mythen3_module.svg b/docs/src/images/Mythen3_module.svg new file mode 100644 index 000000000..0c255f3ac --- /dev/null +++ b/docs/src/images/Mythen3_module.svg @@ -0,0 +1,3 @@ + + +
Single Module
2
3
4
5
6
7
8
9
10
10 Chips
128 channels
x
3 counters
Control Port
Data Port
 \ No newline at end of file diff --git a/docs/src/images/Receiver_architecture.png b/docs/src/images/Receiver_architecture.png deleted file mode 100644 index 8aaf00af4..000000000 Binary files a/docs/src/images/Receiver_architecture.png and /dev/null differ diff --git a/docs/src/images/Receiver_architecture.svg b/docs/src/images/Receiver_architecture.svg new file mode 100644 index 000000000..f704007a5 --- /dev/null +++ b/docs/src/images/Receiver_architecture.svg @@ -0,0 +1,3 @@ + + +
Data Streamer
Data Processor
Listener
Listener
Data Processor
Data Streamer
TCP Server
Client 
TCP Port
Control
Module
UDP Port
Assembles 
into images in memory
Optional callbacks 
for online processing
Optional File
Optional Data Streaming
Module
UDP Port 2
RECEIVER
Data packets
ZMQ Port
ZMQ Port 2
GUI
GUI
Frames
 \ No newline at end of file diff --git a/docs/src/images/Receiver_external_process_commands.png b/docs/src/images/Receiver_external_process_commands.png deleted file mode 100644 index b09b80d74..000000000 Binary files a/docs/src/images/Receiver_external_process_commands.png and /dev/null differ diff --git a/docs/src/images/Receiver_external_process_commands.svg b/docs/src/images/Receiver_external_process_commands.svg new file mode 100644 index 000000000..7dca372d2 --- /dev/null +++ b/docs/src/images/Receiver_external_process_commands.svg @@ -0,0 +1,3 @@ + + +
Client/GUI
External
Process
129.129.200.175
Processed Data
ZMQ
Receiver streaming out
rx_zmqport = 30001
Receiver
pc1234
129.129.100.115
Receiver
pc1234
129.129.100.115
Receiver streaming out
rx_zmqport = 30002
ZMQ

Client listening to 
zmqport : 30004
zmqip   : 129.129.200.175

External Process:
rx_zmqport (30001) != zmqport (30004)
ZMQ

Client listening to 
zmqport : 30003
zmqip   : 129.129.200.175

ZMQ
Assembled Data

External Process listening to 
Ports : 30001, 30002
Ip    : 129.129.100.115

External Process streaming out 
Ports : 30003, 30004

 \ No newline at end of file diff --git a/docs/src/images/Receiver_gui_commands.png b/docs/src/images/Receiver_gui_commands.png deleted file mode 100644 index 4cef3853f..000000000 Binary files a/docs/src/images/Receiver_gui_commands.png and /dev/null differ diff --git a/docs/src/images/Receiver_gui_commands.svg b/docs/src/images/Receiver_gui_commands.svg new file mode 100644 index 000000000..8494f3ddf --- /dev/null +++ b/docs/src/images/Receiver_gui_commands.svg @@ -0,0 +1,3 @@ + + +
ZMQ
ZMQ
GUI:  
zmqport (30001) = rx_zmqport (30001)
Assembled Data
Receiver streaming out
rx_zmqport = 30001
Receiver
pc1234
129.129.100.115
Receiver
pc1234
129.129.100.115
Receiver streaming out
rx_zmqport = 30002
Client/GUI

Client listening to 
zmqport : 30002
zmqip   : 129.129.100.115

Client listening to 
zmqport : 30001
zmqip   : 129.129.100.115

 \ No newline at end of file diff --git a/docs/src/images/Soft_upgrade_components.png b/docs/src/images/Soft_upgrade_components.png deleted file mode 100644 index cf715a90f..000000000 Binary files a/docs/src/images/Soft_upgrade_components.png and /dev/null differ diff --git a/docs/src/images/Soft_upgrade_components.svg b/docs/src/images/Soft_upgrade_components.svg new file mode 100644 index 000000000..79fe0cb6c --- /dev/null +++ b/docs/src/images/Soft_upgrade_components.svg @@ -0,0 +1,3 @@ + + +
Blackfin 
Detector Server
FPGA firmware 
(*.bit,*.pof,*.rbf)
slsDetectorPackage
(Client & Receiver)
UPGRADE COMPONENTS
 \ No newline at end of file diff --git a/docs/src/images/System_communication_architecture.png b/docs/src/images/System_communication_architecture.png deleted file mode 100644 index 7376a0590..000000000 Binary files a/docs/src/images/System_communication_architecture.png and /dev/null differ diff --git a/docs/src/images/System_communication_architecture.svg b/docs/src/images/System_communication_architecture.svg new file mode 100644 index 000000000..6edb75f58 --- /dev/null +++ b/docs/src/images/System_communication_architecture.svg @@ -0,0 +1,3 @@ + + +
Module 3
Module 2
Module 1
Module (s)
UDP
Client / GUI
ZMQ
ZMQ
ZMQ
External 
Processing
Chain
TCP
TCP
Control 1:N
Control 1:N
Raw Data Packets 1:1
Image Data 1:N
Assembled Data 1:N
Processed Data 1:1
Module 3
Module 2
Module 1
Receiver (s)
Option 1: Directly 
Option 2: Indirectly
Detector
 \ No newline at end of file diff --git a/docs/src/pyPatternGenerator.rst b/docs/src/pypatterngenerator.rst similarity index 100% rename from docs/src/pyPatternGenerator.rst rename to docs/src/pypatterngenerator.rst