comparison: docs/administration/adding_products.rst
docs/administration/adding_products.rst
- changeset 58
- a11cb3748526
- parent 56
- 42ab98661928
equal
deleted
inserted
replaced
| 57:2c95a0843b64 | 58:a11cb3748526 |
|---|---|
| 1 Products | 1 Products |
| 2 ======== | 2 ======== |
| 3 | |
| 4 There are two ways that a product can be related to a system: *directly* or *indirectly*. | |
| 5 | |
| 6 A **directly** connected product (or **primary** product) is linked to a | |
| 7 system. When a measurement is processed, a file will be created containing the | |
| 8 retrieved quantities of this product. | |
| 9 | |
| 10 A **indirectly** connected product (or **secondary** product) is used in the | |
| 11 definition of a composite, more complex, product. For example, an "extinction" product | |
| 12 can be used to define a "lidar ratio and extinction" product. In this case the | |
| 13 "lidar ratio and extinction" product is the *primary* product (directly linked | |
| 14 to a system), and the "extinction" product is the *secondary* product (only liked to | |
| 15 the "lidar ratio and extinction" product). The output of a secondary product is not stored in a | |
| 16 file. | |
| 17 | |
| 18 .. warning:: | |
| 19 You should avoid linking a product both *directly* and *indirectly* to the | |
| 20 same system. If you link a *secondary* product directly to a system, | |
| 21 the output of the SCC could be wrong, as two products could attempt to write | |
| 22 their output on the same file. | |
| 23 | |
| 24 In the product list view, these information are summarized in two columns, labeled | |
| 25 "Directly connected" and "Parent products". | |
| 26 | |
| 27 Directly connected | |
| 28 Will be green for **primary** products, i.e. if the product is directly | |
| 29 linked to a system. | |
| 30 | |
| 31 Parent products | |
| 32 If the product is a **secondary** product (i.e. it is part of a composite product) | |
| 33 this column will have a links to the related *primary* products. | |
| 34 | |
| 35 .. note:: | |
| 36 **For administrators**: These two columns can be used to quickly spot "orphan" | |
| 37 products, i.e. products that are neither linked to a system nor to a composite | |
| 38 product. These products will not be available to any user to use, and should | |
| 39 be either connected to a system, or deleted. Orphan products will have *red* | |
| 40 in the *Directly connected* column and "-" in the *Parent products* column. | |
| 41 | |
| 42 Adding a product | |
| 43 ---------------- | |
| 3 | 44 |
| 4 Depending on the product you need to produce, some of the following tables need to be filled. | 45 Depending on the product you need to produce, some of the following tables need to be filled. |
| 5 | 46 |
| 6 | 47 |
| 7 .. note:: | 48 .. note:: |
| 8 | 49 |
| 9 This section is not up-to-date to the latest interface version. | 50 This section is not up-to-date to the latest interface version. |
| 10 | 51 |
| 11 .. note:: | 52 .. note:: |
| 12 | 53 |
| 13 Each product should be connected to a system before being saved. | 54 Each product should be connected to a system, either directly or indirectly, |
| 55 before being saved. | |
| 14 | 56 |
| 15 | 57 |
| 16 Backscatter products | 58 Backscatter products |
| 17 -------------------- | 59 ~~~~~~~~~~~~~~~~~~~~ |
| 18 The following tables need to be filed for the various backscatter products. | 60 The following tables need to be filed for the various backscatter products. |
| 19 | 61 |
| 20 Backscatter calibrations | 62 Backscatter calibrations |
| 21 ------------------------ | 63 ~~~~~~~~~~~~~~~~~~~~~~~~ |
| 22 For backscatter (product types: Raman backscatter, Combined Raman backscatter and extinction, Elastic backscatter retrieval | 64 For backscatter (product types: Raman backscatter, Combined Raman backscatter and extinction, Elastic backscatter retrieval |
| 23 | 65 |
| 24 LowestHeight | 66 LowestHeight |
| 25 in meters, lowest height for reference height search | 67 in meters, lowest height for reference height search |
| 26 | 68 |
| 38 | 80 |
| 39 | 81 |
| 40 If done, you have to remember the ID for your backscatter calibration options an go the the specific tables below, | 82 If done, you have to remember the ID for your backscatter calibration options an go the the specific tables below, |
| 41 | 83 |
| 42 for product type 0 and 2: Raman_backscatter_options | 84 for product type 0 and 2: Raman_backscatter_options |
| 43 --------------------------------------------------- | 85 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 44 | 86 |
| 45 Raman calculation method | 87 Raman calculation method |
| 46 at the moment, only 1 | 88 at the moment, only 1 |
| 47 | 89 |
| 48 bsc cal options | 90 bsc cal options |
| 50 | 92 |
| 51 error method ID: | 93 error method ID: |
| 52 at the moment, only 1 | 94 at the moment, only 1 |
| 53 | 95 |
| 54 for product type 3: elast_backscatter_options | 96 for product type 3: elast_backscatter_options |
| 55 ----------------------------------------------- | 97 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 56 | 98 |
| 57 elast bsc method ID | 99 elast bsc method ID |
| 58 at the moment, only 1 (iterative approach) | 100 at the moment, only 1 (iterative approach) |
| 59 | 101 |
| 60 bsc cal options | 102 bsc cal options |
| 71 | 113 |
| 72 iter_bsc_options | 114 iter_bsc_options |
| 73 if, iterative approach is used, go to table iter_bsc_options and remember ID and insert here | 115 if, iterative approach is used, go to table iter_bsc_options and remember ID and insert here |
| 74 | 116 |
| 75 iter_bsc_options | 117 iter_bsc_options |
| 76 ---------------- | 118 ~~~~~~~~~~~~~~~~ |
| 77 | 119 |
| 78 iter conv crit | 120 iter conv crit |
| 79 ...e.g. 0.1 (=10%) The iteration is stopped when the RELATIVE difference between the actual and the previous column integrated backscatter coefficients is below this value | 121 ...e.g. 0.1 (=10%) The iteration is stopped when the RELATIVE difference between the actual and the previous column integrated backscatter coefficients is below this value |
| 80 | 122 |
| 81 ram bsc method id | 123 ram bsc method id |
| 83 | 125 |
| 84 max iteration count: | 126 max iteration count: |
| 85 maximum number of iteration steps | 127 maximum number of iteration steps |
| 86 | 128 |
| 87 for product type 1: Extinction options | 129 for product type 1: Extinction options |
| 88 -------------------------------------- | 130 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 89 | 131 |
| 90 Extinction method: | 132 Extinction method: |
| 91 Standard: 1, (0 weighted linear fit, 1 non-weighted linear fit, 2 difference quotient, 3 polynomial sec order fit, 4 quadratic function, 5 Savitzky-Golay filter, 6 Russo) | 133 Standard: 1, (0 weighted linear fit, 1 non-weighted linear fit, 2 difference quotient, 3 polynomial sec order fit, 4 quadratic function, 5 Savitzky-Golay filter, 6 Russo) |
| 92 | 134 |
| 93 error method ID: | 135 error method ID: |
| 98 | 140 |
| 99 angstroem: | 141 angstroem: |
| 100 used angström value for the extinction calculation, e.g. 0,1, or 1.5 | 142 used angström value for the extinction calculation, e.g. 0,1, or 1.5 |
| 101 | 143 |
| 102 for product type 2: Ext bsc options | 144 for product type 2: Ext bsc options |
| 103 ----------------------------------- | 145 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 104 | 146 |
| 105 product ID | 147 product ID |
| 106 ID of product type 2 | 148 ID of product type 2 |
| 107 | 149 |
| 108 extinction option product ID | 150 extinction option product ID |
