PNG images added
|
@ -3,7 +3,7 @@ In the following, the most important classes that are used by the software but n
|
||||||
Spectral Quantity
|
Spectral Quantity
|
||||||
-----------------
|
-----------------
|
||||||
|
|
||||||
.. figure:: images/SpectralQty.pdf
|
.. figure:: images/SpectralQty.png
|
||||||
:alt: Class Diagram
|
:alt: Class Diagram
|
||||||
|
|
||||||
Class diagram of the Spectral Quantity.
|
Class diagram of the Spectral Quantity.
|
||||||
|
@ -20,7 +20,7 @@ Additionally, the two methods ``rebin()`` and ``integrate()`` allow to change th
|
||||||
Configuration
|
Configuration
|
||||||
-------------
|
-------------
|
||||||
|
|
||||||
.. figure:: images/Configuration.pdf
|
.. figure:: images/Configuration.png
|
||||||
:alt: Class Diagram
|
:alt: Class Diagram
|
||||||
|
|
||||||
Class diagram of the Configuration.
|
Class diagram of the Configuration.
|
||||||
|
@ -36,7 +36,7 @@ Finally, this class also computes some meta options like the array containing th
|
||||||
Entry
|
Entry
|
||||||
-----
|
-----
|
||||||
|
|
||||||
.. figure:: images/Entry.pdf
|
.. figure:: images/Entry.png
|
||||||
:alt: Class Diagram
|
:alt: Class Diagram
|
||||||
|
|
||||||
Class diagram of the Entry.
|
Class diagram of the Entry.
|
||||||
|
|
After Width: | Height: | Size: 15 KiB |
After Width: | Height: | Size: 19 KiB |
After Width: | Height: | Size: 152 KiB |
After Width: | Height: | Size: 15 KiB |
After Width: | Height: | Size: 249 KiB |
After Width: | Height: | Size: 138 KiB |
After Width: | Height: | Size: 11 KiB |
After Width: | Height: | Size: 281 KiB |
After Width: | Height: | Size: 9.5 KiB |
After Width: | Height: | Size: 84 KiB |
After Width: | Height: | Size: 70 KiB |
After Width: | Height: | Size: 54 KiB |
After Width: | Height: | Size: 1.1 MiB |
After Width: | Height: | Size: 90 KiB |
|
@ -2,7 +2,7 @@ Each push to the `ESBO-ETC Repository <https://egit.irs.uni-stuttgart.de/esbo_ds
|
||||||
This pipeline first executes all unittests to ensure the prober functioning of the code. Afterwards this documentation is being built and deployed to the webroot of ESBO-DS' webserver.
|
This pipeline first executes all unittests to ensure the prober functioning of the code. Afterwards this documentation is being built and deployed to the webroot of ESBO-DS' webserver.
|
||||||
All these build steps are defined within a Jenkins-file in the root of the repository. The complete CI/CD set up is shown in the following figure.
|
All these build steps are defined within a Jenkins-file in the root of the repository. The complete CI/CD set up is shown in the following figure.
|
||||||
|
|
||||||
.. figure:: images/ci_cd_pipeline.pdf
|
.. figure:: images/ci_cd_pipeline.png
|
||||||
:alt: CI/CD configuration
|
:alt: CI/CD configuration
|
||||||
|
|
||||||
CI/CD configuration.
|
CI/CD configuration.
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
For modelling the radiation transportation, the `decorator pattern <https://en.wikipedia.org/wiki/Decorator_pattern>`_ was used as shown in the figure below.
|
For modelling the radiation transportation, the `decorator pattern <https://en.wikipedia.org/wiki/Decorator_pattern>`_ was used as shown in the figure below.
|
||||||
|
|
||||||
.. figure:: images/decorator_pattern.pdf
|
.. figure:: images/decorator_pattern.png
|
||||||
:alt: Decorator Pattern
|
:alt: Decorator Pattern
|
||||||
:width: 100%
|
:width: 100%
|
||||||
|
|
||||||
|
@ -11,7 +11,7 @@ This target may be encapsulated by multiple optical components which manipulate
|
||||||
The outermost part of the radiation transportation pipeline is formed by some kind of sensor component, detecting the radiation.
|
The outermost part of the radiation transportation pipeline is formed by some kind of sensor component, detecting the radiation.
|
||||||
The quality of the detected signal can then be determined by calculating the signal to noise ration (SNR).
|
The quality of the detected signal can then be determined by calculating the signal to noise ration (SNR).
|
||||||
|
|
||||||
.. figure:: images/class_diagram.pdf
|
.. figure:: images/class_diagram.png
|
||||||
:alt: Class Diagram
|
:alt: Class Diagram
|
||||||
|
|
||||||
Class diagram of the software architecture.
|
Class diagram of the software architecture.
|
||||||
|
@ -19,7 +19,7 @@ The quality of the detected signal can then be determined by calculating the sig
|
||||||
Radiant Interface
|
Radiant Interface
|
||||||
-----------------
|
-----------------
|
||||||
|
|
||||||
.. figure:: images/IRadiant.pdf
|
.. figure:: images/IRadiant.png
|
||||||
:alt: Interface IRadiant
|
:alt: Interface IRadiant
|
||||||
|
|
||||||
Class diagram of the interface IRadiant.
|
Class diagram of the interface IRadiant.
|
||||||
|
@ -34,7 +34,7 @@ classes to focus on the initialization and calculation of their own properties,
|
||||||
Target
|
Target
|
||||||
^^^^^^
|
^^^^^^
|
||||||
|
|
||||||
.. figure:: images/Target.pdf
|
.. figure:: images/Target.png
|
||||||
:alt: Target Classes
|
:alt: Target Classes
|
||||||
|
|
||||||
Class diagram of the target classes.
|
Class diagram of the target classes.
|
||||||
|
@ -47,7 +47,7 @@ All subclasses therefore only set up a ``SpectralQty``-object containing the emi
|
||||||
Optical Component
|
Optical Component
|
||||||
^^^^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
.. figure:: images/OpticalComponent.pdf
|
.. figure:: images/OpticalComponent.png
|
||||||
:alt: Optical component classes
|
:alt: Optical component classes
|
||||||
|
|
||||||
Class diagram of the optical components.
|
Class diagram of the optical components.
|
||||||
|
@ -64,7 +64,7 @@ According to the restrictions above, subclasses of ``AOpticalComponent`` can be
|
||||||
Hot Optical Component
|
Hot Optical Component
|
||||||
"""""""""""""""""""""
|
"""""""""""""""""""""
|
||||||
|
|
||||||
.. figure:: images/HotOpticalComponent.pdf
|
.. figure:: images/HotOpticalComponent.png
|
||||||
:alt: Hot optical component classes
|
:alt: Hot optical component classes
|
||||||
|
|
||||||
Class diagram of the hot optical components.
|
Class diagram of the hot optical components.
|
||||||
|
@ -76,7 +76,7 @@ Like ``AOpticalComponent``, the class ``AHotOpticalComponent`` provides the abst
|
||||||
Sensor
|
Sensor
|
||||||
------
|
------
|
||||||
|
|
||||||
.. figure:: images/Sensor.pdf
|
.. figure:: images/Sensor.png
|
||||||
:alt: Sensor classes
|
:alt: Sensor classes
|
||||||
|
|
||||||
Class diagram of the sensor components.
|
Class diagram of the sensor components.
|
||||||
|
@ -90,7 +90,7 @@ Additionally, ``ASensor`` defines the abstract method ``checkConfig()`` to allow
|
||||||
PSF
|
PSF
|
||||||
---
|
---
|
||||||
|
|
||||||
.. figure:: images/PSF.pdf
|
.. figure:: images/PSF.png
|
||||||
:alt: PSF classes
|
:alt: PSF classes
|
||||||
|
|
||||||
Class diagram of the PSF classes.
|
Class diagram of the PSF classes.
|
||||||
|
@ -108,7 +108,7 @@ The following two factory methods are responsible for transforming the parsed co
|
||||||
Radiant Factory
|
Radiant Factory
|
||||||
^^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
.. figure:: images/RadiantFactory.pdf
|
.. figure:: images/RadiantFactory.png
|
||||||
:alt: RadiantFactory class
|
:alt: RadiantFactory class
|
||||||
|
|
||||||
Class diagram of the radiant factory.
|
Class diagram of the radiant factory.
|
||||||
|
@ -120,7 +120,7 @@ The method ``fromConfigBatch`` allows to set up a batch of objects starting with
|
||||||
Sensor Factory
|
Sensor Factory
|
||||||
^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^
|
||||||
|
|
||||||
.. figure:: images/SensorFactory.pdf
|
.. figure:: images/SensorFactory.png
|
||||||
:alt: SensorFactory class
|
:alt: SensorFactory class
|
||||||
|
|
||||||
Class diagram of the sensor factory.
|
Class diagram of the sensor factory.
|
||||||
|
|