diff --git a/docs/source/developer/classes.rst b/docs/source/developer/classes.rst index b8cf2e2..72e3fbe 100644 --- a/docs/source/developer/classes.rst +++ b/docs/source/developer/classes.rst @@ -3,7 +3,7 @@ In the following, the most important classes that are used by the software but n Spectral Quantity ----------------- -.. figure:: images/SpectralQty.pdf +.. figure:: images/SpectralQty.png :alt: Class Diagram Class diagram of the Spectral Quantity. @@ -20,7 +20,7 @@ Additionally, the two methods ``rebin()`` and ``integrate()`` allow to change th Configuration ------------- -.. figure:: images/Configuration.pdf +.. figure:: images/Configuration.png :alt: Class Diagram Class diagram of the Configuration. @@ -36,7 +36,7 @@ Finally, this class also computes some meta options like the array containing th Entry ----- -.. figure:: images/Entry.pdf +.. figure:: images/Entry.png :alt: Class Diagram Class diagram of the Entry. diff --git a/docs/source/developer/images/Configuration.png b/docs/source/developer/images/Configuration.png new file mode 100644 index 0000000..5c357ce Binary files /dev/null and b/docs/source/developer/images/Configuration.png differ diff --git a/docs/source/developer/images/Entry.png b/docs/source/developer/images/Entry.png new file mode 100644 index 0000000..957fe28 Binary files /dev/null and b/docs/source/developer/images/Entry.png differ diff --git a/docs/source/developer/images/HotOpticalCOmponent.png b/docs/source/developer/images/HotOpticalCOmponent.png new file mode 100644 index 0000000..8a05491 Binary files /dev/null and b/docs/source/developer/images/HotOpticalCOmponent.png differ diff --git a/docs/source/developer/images/IRadiant.png b/docs/source/developer/images/IRadiant.png new file mode 100644 index 0000000..e7415dc Binary files /dev/null and b/docs/source/developer/images/IRadiant.png differ diff --git a/docs/source/developer/images/OpticalComponent.png b/docs/source/developer/images/OpticalComponent.png new file mode 100644 index 0000000..89addd2 Binary files /dev/null and b/docs/source/developer/images/OpticalComponent.png differ diff --git a/docs/source/developer/images/PSF.png b/docs/source/developer/images/PSF.png new file mode 100644 index 0000000..239fc4e Binary files /dev/null and b/docs/source/developer/images/PSF.png differ diff --git a/docs/source/developer/images/RadiantFactory.png b/docs/source/developer/images/RadiantFactory.png new file mode 100644 index 0000000..17b3af3 Binary files /dev/null and b/docs/source/developer/images/RadiantFactory.png differ diff --git a/docs/source/developer/images/Sensor.png b/docs/source/developer/images/Sensor.png new file mode 100644 index 0000000..948da57 Binary files /dev/null and b/docs/source/developer/images/Sensor.png differ diff --git a/docs/source/developer/images/SensorFactory.png b/docs/source/developer/images/SensorFactory.png new file mode 100644 index 0000000..d2f4bd1 Binary files /dev/null and b/docs/source/developer/images/SensorFactory.png differ diff --git a/docs/source/developer/images/SpectralQty.png b/docs/source/developer/images/SpectralQty.png new file mode 100644 index 0000000..5b94788 Binary files /dev/null and b/docs/source/developer/images/SpectralQty.png differ diff --git a/docs/source/developer/images/Target.png b/docs/source/developer/images/Target.png new file mode 100644 index 0000000..6e8870f Binary files /dev/null and b/docs/source/developer/images/Target.png differ diff --git a/docs/source/developer/images/ci_cd_pipeline.png b/docs/source/developer/images/ci_cd_pipeline.png new file mode 100644 index 0000000..83e7837 Binary files /dev/null and b/docs/source/developer/images/ci_cd_pipeline.png differ diff --git a/docs/source/developer/images/class_diagram.png b/docs/source/developer/images/class_diagram.png new file mode 100644 index 0000000..01e3652 Binary files /dev/null and b/docs/source/developer/images/class_diagram.png differ diff --git a/docs/source/developer/images/decorator_pattern.png b/docs/source/developer/images/decorator_pattern.png new file mode 100644 index 0000000..a1124fe Binary files /dev/null and b/docs/source/developer/images/decorator_pattern.png differ diff --git a/docs/source/developer/pipeline.rst b/docs/source/developer/pipeline.rst index 14084ec..463ab8c 100644 --- a/docs/source/developer/pipeline.rst +++ b/docs/source/developer/pipeline.rst @@ -2,7 +2,7 @@ Each push to the `ESBO-ETC Repository `_ was used as shown in the figure below. -.. figure:: images/decorator_pattern.pdf +.. figure:: images/decorator_pattern.png :alt: Decorator Pattern :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 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 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 ----------------- -.. figure:: images/IRadiant.pdf +.. figure:: images/IRadiant.png :alt: 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 ^^^^^^ -.. figure:: images/Target.pdf +.. figure:: images/Target.png :alt: 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 ^^^^^^^^^^^^^^^^^ -.. figure:: images/OpticalComponent.pdf +.. figure:: images/OpticalComponent.png :alt: Optical component classes Class diagram of the optical components. @@ -64,7 +64,7 @@ According to the restrictions above, subclasses of ``AOpticalComponent`` can be Hot Optical Component """"""""""""""""""""" -.. figure:: images/HotOpticalComponent.pdf +.. figure:: images/HotOpticalComponent.png :alt: Hot optical component classes Class diagram of the hot optical components. @@ -76,7 +76,7 @@ Like ``AOpticalComponent``, the class ``AHotOpticalComponent`` provides the abst Sensor ------ -.. figure:: images/Sensor.pdf +.. figure:: images/Sensor.png :alt: Sensor classes Class diagram of the sensor components. @@ -90,7 +90,7 @@ Additionally, ``ASensor`` defines the abstract method ``checkConfig()`` to allow PSF --- -.. figure:: images/PSF.pdf +.. figure:: images/PSF.png :alt: 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 ^^^^^^^^^^^^^^^ -.. figure:: images/RadiantFactory.pdf +.. figure:: images/RadiantFactory.png :alt: RadiantFactory class 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 ^^^^^^^^^^^^^^ -.. figure:: images/SensorFactory.pdf +.. figure:: images/SensorFactory.png :alt: SensorFactory class Class diagram of the sensor factory.