changeset
Update part concerning SCC data product file format description. Added also general section on basic lidar equations.
Fri, 19 Mar 2021 13:43:18 +0100
- author
- Giuseppe D'Amico <giuseppe.damico@imaa.cnr.it>
- date
- Fri, 19 Mar 2021 13:43:18 +0100
- changeset 125
- 003aa42747f5
- parent 124
- becb9de86607
- child 126
- 2e00e23bad90
Update part concerning SCC data product file format description. Added also general section on basic lidar equations.
--- a/docs/depolarization/depolarization.rst Wed Mar 10 10:46:27 2021 +0200 +++ b/docs/depolarization/depolarization.rst Fri Mar 19 13:43:18 2021 +0100 @@ -54,6 +54,7 @@ .. math:: \alpha_s P_s + \alpha_p P_p = P + :label: eq_totsig in two different atmospheric layers with considerably different *VLDR*. So to calibrate in this way the implementation of automatic layer identification in the SCC is required. As at moment this feature is not yet available within the SCC **ONLY** the method b) is considered. @@ -99,26 +100,31 @@ .. math:: \eta^* = \frac{I_R}{I_T}(+45) + :label: eq_eta1 While in case of :math:`\Delta90` calibration method: .. math:: \eta^* = \sqrt{\frac{I_R}{I_T}(+45) \frac{I_R}{I_T}(-45)} + :label: eq_eta2 **ELDA** module calculates the “apparent” *VLDR*: .. math:: \delta^* = \frac{K}{\eta^*} \cdot \frac{I_R}{I_T} + :label: eq_delta1 the *VLDR* .. math:: \delta = \frac{\delta^*(G_T + H_T)-(G_R + H_R)}{(G_R - H_R) - \delta^*(G_T - H_T)} + :label: eq_delta2 and the *PLDR* .. math:: \delta_{\alpha} = \frac{(1 + \delta_m)\delta R - (1 + \delta)\delta_m}{(1 + \delta_m)R - (1 + \delta)} + :label: eq_pldr where: @@ -140,6 +146,7 @@ .. math:: I_{total} \propto \frac{\frac{\eta^*}{K}H_R I_T - H_T I_R}{H_R G_T - H_T G_R} + :label: eq_Itot The formulas above are general and can be adapted to all possible polarization lidar configurations selecting the right polarization cross-talk correction parameters (see Table 1.1).
--- a/docs/file_formats.rst Wed Mar 10 10:46:27 2021 +0200 +++ b/docs/file_formats.rst Fri Mar 19 13:43:18 2021 +0100 @@ -8,6 +8,7 @@ :maxdepth: 2 file_formats/netcdf_file - file_formats/low_resolution + file_formats/scc_product_filename + file_formats/scc_product_format
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/file_formats/bitmask_flag_description.rst Fri Mar 19 13:43:18 2021 +0100 @@ -0,0 +1,288 @@ +SCC Bitmask/flag description +---------------------------- + +In this section a description of all the SCC bitmask or flag fields is provided. + +Bitmask fields +############### + +**Table A1:** SCC product type bitmask description + ++-----+--------------------+ +| Bit | Description | ++=====+====================+ +| 1st | experimental | ++-----+--------------------+ +| 2nd | operational | ++-----+--------------------+ + +**Table A2:** Range type bitmask description + ++-----+--------------------+ +| Bit | Description | ++=====+====================+ +| 1st | ultra\_near\_range | ++-----+--------------------+ +| 2nd | near\_range | ++-----+--------------------+ +| 3rd | far\_range | ++-----+--------------------+ + +**Table A3:** Scatteters type bitmask description + ++-----+--------------------+ +| Bit | Description | ++=====+====================+ +| 1st | particle | ++-----+--------------------+ +| 2nd | nitrogen | ++-----+--------------------+ +| 3rd | oxygen | ++-----+--------------------+ +| 4th | water\_vapour | ++-----+--------------------+ + +**Table A4:** Detection mode bitmask description + ++-----+--------------------+ +| Bit | Description | ++=====+====================+ +| 1st | analog | ++-----+--------------------+ +| 2nd | photoncountin | ++-----+--------------------+ + +**Table A5:** Cloudmask bitmask description + ++-----+--------------------+ +| Bit | Description | ++=====+====================+ +| 1st | unknown cloud | ++-----+--------------------+ +| 2nd | cirrus | ++-----+--------------------+ +| 3rd | mixed-phase cloud | ++-----+--------------------+ + +**Table A6:** Cloudmask type bitmask description + ++-----+--------------------+ +| Bit | Description | ++=====+====================+ +| 1st | manual cloudmask | ++-----+--------------------+ +| 2nd | automatic cloudmask| ++-----+--------------------+ + + +**Table A.7:** Polarization channel geometry bitmask description + ++-----+--------------------+ +| Bit | Description | ++=====+====================+ +| 1st | transmitted signal | ++-----+--------------------+ +| 2nd | reflected signal | ++-----+--------------------+ + +**Table A.8:** Polarization channel configuration bitmask description + ++-----+--------------------+ +| Bit | Description | ++=====+====================+ +| 1st | 0 degrees | ++-----+--------------------+ +| 2nd | 90 degrees | ++-----+--------------------+ +| 3rd | +45 degree | ++-----+--------------------+ +| 4th | -45 degrees | ++-----+--------------------+ + +**Table A.9:** Polarization calibration type bitmask description + ++-----+--------------------+ +| Bit | Description | ++=====+====================+ +| 1st | automatic | ++-----+--------------------+ +| 2nd | manual | ++-----+--------------------+ + +**Table A.10:** User defind category bitmask description + ++------+-----------------------+ +| Bit | Description | ++======+=======================+ +| 1st | cirrus | ++------+-----------------------+ +| 2nd | climatol | ++------+-----------------------+ +| 3rd | dicucles | ++------+-----------------------+ +| 4th | volcanic | ++------+-----------------------+ +| 5th | forfires | ++------+-----------------------+ +| 6th | photosmog | ++------+-----------------------+ +| 7th | rurban | ++------+-----------------------+ +| 8th | sahadust | ++------+-----------------------+ +| 9th | stratos | ++------+-----------------------+ +| 10th | satallite\_overpasses | ++-----+------------------------+ + +Flag fields +########### + + +**Table B.1:** Molecular calculation source flag description + ++-------+--------------------------+ +| Value | Description | ++=======+==========================+ +| 0 | US standard atmosphere | ++-------+--------------------------+ +| 1 | Radiosounding | ++-------+--------------------------+ +| 2 | ECMWF forecast | ++-------+--------------------------+ +| 3 | ICON-IGLO-12-13 forecast | ++-------+--------------------------+ +| 4 | ICON-IGLO-24-25 forecast | ++-------+--------------------------+ +| 5 | ICON-IGLO-36-47 forecast | ++-------+--------------------------+ +| 6 | GDAS forecast | ++-------+--------------------------+ +| 7 | ERA5-1-12 | ++-------+--------------------------+ +| 8 | ERA5-7-18 | ++-------+--------------------------+ + +**Table B.2:** Cirrus contamination flag description + ++-------+--------------------------+ +| Value | Description | ++=======+==========================+ +| 0 | not available | ++-------+--------------------------+ +| 1 | no cirrus | ++-------+--------------------------+ +| 2 | cirrus detecte | ++-------+--------------------------+ + +**Table B.3:** Cirrus contamination source flag description + ++-------+--------------------------+ +| Value | Description | ++=======+==========================+ +| 0 | not available | ++-------+--------------------------+ +| 1 | user provid | ++-------+--------------------------+ +| 2 | automatic calculate | ++-------+--------------------------+ + +**Table B.4:** Error retrieval method flag description + ++-------+----------------------------+ +| Value | Description | ++=======+============================+ +| 0 | Monte Carlo | ++-------+----------------------------+ +| 1 | Standard error propagation | ++-------+----------------------------+ +| 2 | automatic calculate | ++-------+----------------------------+ + +**Table B.5:** Backscatter evaluation method flag description + ++-------+----------------------------+ +| Value | Description | ++=======+============================+ +| 0 | Raman | ++-------+----------------------------+ +| 1 | Elastic | ++-------+----------------------------+ + +**Table B.6:** Elastic backscatter algorithm flag description + ++-------+----------------------------+ +| Value | Description | ++=======+============================+ +| 0 | Klett-Fernald | ++-------+----------------------------+ +| 1 | Iterative | ++-------+----------------------------+ + +**Table B.7:** Earlinet product type flag description + ++-------+----------------------------+ +| Value | Description | ++=======+============================+ +| 1 | e0355 | ++-------+----------------------------+ +| 2 | b0355 | ++-------+----------------------------+ +| 3 | e0351 | ++-------+----------------------------+ +| 4 | b0351 | ++-------+----------------------------+ +| 5 | e0532 | ++-------+----------------------------+ +| 6 | b0532 | ++-------+----------------------------+ +| 7 | e1064 | ++-------+----------------------------+ +| 8 | b1064 | ++-------+----------------------------+ +| 9 | b0253 | ++-------+----------------------------+ +| 10 | b0313 | ++-------+----------------------------+ +| 11 | b0335 | ++-------+----------------------------+ +| 12 | b0511 | ++-------+----------------------------+ +| 13 | b0694 | ++-------+----------------------------+ +| 14 | b0817 | ++-------+----------------------------+ + + +**Table B.8:** Backscatter calibration range search algorithm flag description + ++-------+----------------------------+ +| Value | Description | ++=======+============================+ +| 0 | minimum of signal ratio | ++-------+----------------------------+ +| 1 | minimum of elastic signal | ++-------+----------------------------+ +| 2 | Rayleigh fit | ++-------+----------------------------+ + +**Table B.9:** Raman backscatter algorithm flag description + ++-------+----------------------------+ +| Value | Description | ++=======+============================+ +| 0 | Ansmann method | ++-------+----------------------------+ +| 1 | via backscatter ratio | ++-------+----------------------------+ + +**Table B.10:** Extinction evaluation algorithm flag description + ++-------+----------------------------+ +| Value | Description | ++=======+============================+ +| 0 | weighted linear fit | ++-------+----------------------------+ +| 1 | non weighted linear fi | ++-------+----------------------------+ +
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/file_formats/cloudscreen_product_format.rst Fri Mar 19 13:43:18 2021 +0100 @@ -0,0 +1,282 @@ +CloudScreen Products +-------------------- + +This section describe the structure of CloudScreen products. + + +CloudScreen Products: dimensions +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The following dimensions are defined in CloudScreen products: + +- time +- level +- nv + +The dimension *time* (mandatory) specifies the number of cloudmask vertical profiles reported in the products. + +The dimension *level* (mandatory) represents the number of rangebins characterizing +each cloudmask verical profile. + +The dimension *nv* (mandatory) is ancillary and it is always set to 2. + + + +CloudScreen Products: variables +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +latitude + :Type: *double* + :Dimensions: -- + :Variable\_Type: Mandatory + :Description: measurement site latitude + :Units: degrees_north + :Definition: *double latitude* + +longitude + :Type: *double* + :Dimensions: -- + :Variable\_Type: Mandatory + :Description: measurement site longitude + :Units: degrees_east + :Definition: *double longitude* + +station\_altitude + :Type: *double* + :Dimensions: -- + :Variable\_Type: Mandatory + :Description: station altitude above see level + :Units: m + :Definition: *double station\_altitude* + +altitude + :Type: *double* + :Dimensions: *time, level* + :Variable\_Type: Mandatory + :Description: altitude above see level + :Units: m + :Definition: *double altitude(time, level)* + +scc\_product\_type + :Type: *byte* + :Dimensions: -- + :Variable\_Type: Mandatory + :Description: Bitmask describing the SCC product type + :Units: -- + :Definition: *byte scc\_product\_type* + +time + :Type: *double* + :Dimensions: *time* + :Variable\_Type: Mandatory + :Description: seconds since 1970-01-01T00:00:00Z + :Units: -- + :Definition: *double time(time)* + +time\_bounds + :Type: *double* + :Dimensions: *time, nv* + :Variable\_Type: Mandatory + :Description: seconds since 1970-01-01T00:00:00Z + :Units: -- + :Definition: *double time\_bounds(time,nv)* + +automatic\_cloud\_mask + :Type: *byte* + :Dimensions: *time, level* + :Variable\_Type: Mandatory + :Description: Automatic cloudmask + :Units: -- + :Definition: *byte automatic\_cloud\_mask(time, level)* + +manual\_cloud\_mask + :Type: *byte* + :Dimensions: *time, level* + :Variable\_Type: Optional + :Description: Manual cloudmask + :Units: -- + :Definition: *byte manual\_cloud\_mask(time, level)* + + +CloudScreen Products: global attributes +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Conventions + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: List of the conventions the product is compliant to + + +title + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Product title + +source + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: String describing the source used to generate the product + +references + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Reference(s) for data processing +location + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Measurement site location + +station_ID + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Unique 3 digit code identifying SCC station + +PI + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: PI full name + +PI\_affiliation + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: PI complete affiliation + +PI\_affiliation_acronym + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: PI affiliation acronym + +PI\_address + :Type: *string* + :Global\_Attribute\_Type: Optional + :Description: PI address + +PI\_phone + :Type: *string* + :Global\_Attribute\_Type: Optional + :Description: PI phone number + +PI\_email + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: PI e-mail + +Data\_Originator + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Data originator full name + +Data\_Originator\_affiliation + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Data originator complete affiliation + +Data\_Originator\_affiliation\_acronym + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Data originator affiliation acronym + +Data\_Originator\_address + :Type: *string* + :Global\_Attribute\_Type: Optional + :Description: Data originator complete address + +Data\_Originator\_phone + :Type: *string* + :Global\_Attribute\_Type: Optional + :Description: Data originator phone number + +Data\_Originator\_email + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Data originator e-mail address + +institution + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Istitution the product belong to + +system + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Name of the measuring instrument (lidar) + +hoi\_system\_ID + :Type: *int* + :Global\_Attribute\_Type: Mandatory + :Description: Numeric ID identifying the measuring system in the ACTRIS/EARLINET Handbook Of Instrument (HOI) + +hoi\_configuration\_ID; + :Type: *int* + :Global\_Attribute\_Type: Mandatory + :Description: Numeric ID identifying the configuration of the measuring system in the ACTRIS/EARLINET Handbook Of Instrument (HOI) + +measurement\_ID; + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Alphanumeric identifier for the raw data measurements use to generate the product + +measurement\_start\_datetime + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Measurement start datetime YYYY-mm-ddTHH:MM:SSZ + +measurement\_stop\_datetime + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Measruement stop datetime YYYY-mm-ddTHH:MM:SSZ + +comment + :Type: *string* + :Global\_Attribute\_Type: Optional + :Description: Any product comments + +scc\_version\_description + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Extended SCC version description + +scc\_version + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: SCC version number + +processor\_name + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Name of the processor used to generate the product + +processor\_algorithm + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Name of the cloudmask algorithm + +processor\_version + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Version of the processor used to generate the product + +history + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Field describing the history of the product + +\_\_file\_format_version + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Version of the product file format + +data\_processing\_institution + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Instituion responsible for data processing + +input\_file + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Filename of the input data product used to generate the current product + +automatic\_mask\_channels + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Channels used to generate the cloumask (SCC channel names)
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/file_formats/elda_product_format.rst Fri Mar 19 13:43:18 2021 +0100 @@ -0,0 +1,512 @@ +ELDA Products +---------------- + +This section describe the structure of ELDA products. + + +ELPP Products: dimensions +~~~~~~~~~~~~~~~~~~~~~~~~~ + +Aerosol optical products have the wavelength dimension (accommodating products at different wavelength in the same variable) and time dimension (accommodating different profiles in the same time series). The altitude dimension is defined for reporting the information as a function of the altitude. The dimension nv is used following the cf convention whenever a bound is needed for some evaluation. In our case nv is used for defining variables which have per definition some bounds as time_bounds reported below. + +The following dimensions are defined in ELDA products: + +- time +- altitude +- wavelength +- nv + +The dimension *time* (mandatory) specifies the number of vertical profiles included in the product timeseries. + +The dimension *altitude* (mandatory) represents the number of rangebins characterizing each vertical profile + +The dimension *wavelength* (mandatory) indicates the number wavelengths for which the optical variables are provided + +The dimension *nv* (mandatory) is ancillary and it is always set to 2. + + + +ELDA Products: variables +~~~~~~~~~~~~~~~~~~~~~~~~ + +latitude + :Type: *float* + :Dimensions: -- + :Variable\_Type: Mandatory + :Description: measurement site latitude + :Units: degrees_north + :Definition: *float latitude* + +longitude + :Type: *float* + :Dimensions: -- + :Variable\_Type: Mandatory + :Description: measurement site longitude + :Units: degrees_east + :Definition: *float longitude* + +station\_altitude + :Type: *float* + :Dimensions: -- + :Variable\_Type: Mandatory + :Description: station altitude above see level + :Units: m + :Definition: *float station\_altitude* + +altitude + :Type: *double* + :Dimensions: *altitude* + :Variable\_Type: Mandatory + :Description: altitude above see level + :Units: m + :Definition: *double altitude(altitude)* + +time + :Type: *double* + :Dimensions: *time* + :Variable\_Type: Mandatory + :Description: seconds since 1970-01-01T00:00:00Z + :Units: -- + :Definition: *double time(time)* + +time\_bounds + :Type: *double* + :Dimensions: *time, nv* + :Variable\_Type: Mandatory + :Description: seconds since 1970-01-01T00:00:00Z + :Units: -- + :Definition: *double time\_bounds(time,nv)* + +shots + :Type: *int* + :Dimensions: *time* + :Variable\_Type: Mandatory + :Description: accumulated laser shots + :Units: -- + :Definition: *int shots(time)* + +cloud\_mask\_type + :Type: *byte* + :Dimensions: -- + :Variable\_Type: Mandatory + :Description: Bimask describing the cloudmask type + :Units: -- + :Definition: *byte cloud_mask_type* + +cloud\_mask + :Type: *byte* + :Dimensions: *time, altitude* + :Variable\_Type: Optional + :Description: Bimask describing the cloudmask + :Units: -- + :Definition: *byte cloud_mask(time, altitude)* + +vertical\_resolution + :Type: *double* + :Dimensions: *wavelength, time, altitude* + :Variable\_Type: Mandatory + :Description: Effective vertical resolution according to Pappalardo et al., appl. opt. 2004 + :Units: *m* + :Definition: *double vertical\_resolution(wavelength, time, altitude)* + + +cirrus\_contamination + :Type: *byte* + :Dimensions: -- + :Variable\_Type: Mandatory + :Description: Do the profiles contain cirrus layers? + :Units: -- + :Definition: *byte cirrus\_contamination* + +cirrus\_contamination\_source + :Type: *byte* + :Dimensions: -- + :Variable\_Type: Mandatory + :Description: How was cirrus_contamination obtained? + :Units: -- + :Definition: *byte cirrus\_contamination\_source* + + +error\_retrieval\_method + :Type: *byte* + :Dimensions: *wavelength* + :Variable\_Type: Mandatory + :Description: Method used for the retrieval of erros (uncertainties) + :Units: -- + :Definition: *byte error\_retrieval\_method(wavelength)* + + +backscatter\_evaluation\_method + :Type: *byte* + :Dimensions: *wavelength* + :Variable\_Type: Optional + :Description: Method used for the backscatter retrieval + :Units: -- + :Definition: *byte backscatter\_evaluation\_method(wavelength)* + +elastic\_backscatter\_algorithm + :Type: *byte* + :Dimensions: *wavelength* + :Variable\_Type: Optional + :Description: Algorithm used for the retrieval of the elastic backscatter profile + :Units: -- + :Definition: *byte elastic\_backscatter\_algorithm(wavelength)* + + + +assumed\_particle\_lidar\_ratio + :Type: *double* + :Dimensions: *wavelength, time, altitude* + :Variable\_Type: Optional + :Description: Assumed particle lidar ratio for the elastic-only backscatter retrieval + :Units: *sr* + :Definition: *double assumed\_particle\_lidar\_ratio(wavelength, time, altitude)* + + +backscatter + :Type: *double* + :Dimensions: *wavelength, time, altitude* + :Variable\_Type: Optional + :Description: Particle backscatter coefficient + :Units: *1/(m\*sr)* + :Definition: *double backscatter(wavelength, time, altitude)* + +error\_backscatter + :Type: *double* + :Dimensions: *wavelength, time, altitude* + :Variable\_Type: Optional + :Description: Absolute statistical error (unertanity) of particle backscatter coefficient + :Units: *1/(m\*sr)* + :Definition: *double error\_backscatter(wavelength, time, altitude)* + +extinction + :Type: *double* + :Dimensions: *wavelength, time, altitude* + :Variable\_Type: Optional + :Description: Particle extinction coefficient + :Units: *1/m* + :Definition: *double extinction(wavelength, time, altitude)* + +error\_extinction + :Type: *double* + :Dimensions: *wavelength, time, altitude* + :Variable\_Type: Optional + :Description: Absolute statistical error (unertanity) of particle extinction coefficient + :Units: *1/m* + :Definition: *double error\_extinction(wavelength, time, altitude)* + +volumedepolarization + :Type: *double* + :Dimensions: *wavelength, time, altitude* + :Variable\_Type: Optional + :Description: Volume linear depolarization ratio + :Units: -- + :Definition: *double volumedepolarization(wavelength, time, altitude)* + +error\_volumedepolarization + :Type: *double* + :Dimensions: *wavelength, time, altitude* + :Variable\_Type: Optional + :Description: Absolute statistical error (unertanity) of volume linear depolarization ratio + :Units: *1/m* + :Definition: *double error\_volumedepolarization(wavelength, time, altitude)* + +particledepolarization + :Type: *double* + :Dimensions: *wavelength, time, altitude* + :Variable\_Type: Optional + :Description: Particle linear depolarization ratio + :Units: -- + :Definition: *double particledepolarization(wavelength, time, altitude)* + +error\_particledepolarization + :Type: *double* + :Dimensions: *wavelength, time, altitude* + :Variable\_Type: Optional + :Description: Absolute statistical error (unertanity) of particle linear depolarization ratio + :Units: *1/m* + :Definition: *double error\_particledepolarization(wavelength, time, altitude)* + + +user\_defined\_category + :Type: *int* + :Dimensions: -- + :Variable\_Type: Optional + :Description: User defined category of the measurement + :Units: -- + :Definition: *int user\_defined_category* + + +molecular\_calculation\_source + :Type: *byte* + :Dimensions: -- + :Variable\_Type: Mandatory + :Description: Data source of the molecular calculations + :Units: -- + :Definition: *byte molecular\_calculation\_source* + + +backscatter\_calibration\_value + :Type: *float* + :Dimensions: *wavelength* + :Variable\_Type: Optional + :Description: Assumed backscatter-ratio value (unitless) in calibration range + :Units: -- + :Definition: *float backscatter\_calibration\_value(wavelength)* + +backscatter\_calibration\_search\_range + :Type: *float* + :Dimensions: *wavelength, nv* + :Variable\_Type: Optional + :Description: Height range wherein calibration range is searched + :Units: *m* + :Definition: *float backscatter\_calibration\_search\_range(wavelength, nv)* + +wavelength + :Type: *float* + :Dimensions: *wavelength* + :Variable\_Type: Mandatory + :Description: Wavelength of the transmitted laser pulse + :Units: *nm* + :Definition: *float wavelength(wavelength)* + +zenith\_angle + :Type: *float* + :Dimensions: -- + :Variable\_Type: Mandatory + :Description: Laser pointing angle with respect to the zenith + :Units: *degrees* + :Definition: *float zenith\_angle* + + +earlinet_product_type + :Type: *int* + :Dimensions: -- + :Variable\_Type: Mandatory + :Description: Earlinet product type + :Units: -- + :Definition: *int earlinet_product_type* + +backscatter\_calibration\_range_search\_algorithm + :Type: *byte* + :Dimensions: *wavelength* + :Variable\_Type: Optional + :Description: Algorithm used for the search of the calibration_range + :Units: -- + :Definition: *byte backscatter\_calibration\_range\_search\_algorithm(wavelength)* + + + +backscatter\_calibration\_range + :Type: *float* + :Dimensions: *wavelength, nv* + :Variable\_Type: Optional + :Description: Height range where calibration was calculated + :Units: *m* + :Definition: *float backscatter\_calibration\_range(wavelength, nv)* + +raman\_backscatter\_algorithm + :Type: *byte* + :Dimensions: *wavelength* + :Variable\_Type: Optional + :Description: Algorithm used for the retrieval of the Raman backscatter profile + :Units: -- + :Definition: *byte raman\_backscatter\_algorithm(wavelength)* + +extinction\_evaluation\_algorithm + :Type: *byte* + :Dimensions: *wavelength* + :Variable\_Type: Optional + :Description: Algorithm used for the extinction retrieval + :Units: -- + :Definition: *byte extinction\_evaluation\_algorithm(wavelength)* + +extinction\_assumed\_wavelength\_dependence + :Type: *float* + :Dimensions: *wavelength* + :Variable\_Type: Optional + :Description: Assumed wavelength dependence for particle extinction retrieval + :Definition: *float extinction\_assumed\_wavelength\_dependence(wavelength)* + +scc\_product\_type + :Type: *byte* + :Dimensions: -- + :Variable\_Type: Mandatory + :Description: Bitmask describing the SCC product type + :Units: -- + :Definition: *byte scc\_product\_type* + + + +ELDA Products: global attributes +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Conventions + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: List of the conventions the product is compliant to + + +title + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Product title + +source + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: String describing the source used to generate the product + +references + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Reference(s) for data processing +location + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Measurement site location + +station_ID + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Unique 3 digit code identifying SCC station + +PI + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: PI full name + +PI\_affiliation + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: PI complete affiliation + +PI\_affiliation_acronym + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: PI affiliation acronym + +PI\_address + :Type: *string* + :Global\_Attribute\_Type: Optional + :Description: PI address + +PI\_phone + :Type: *string* + :Global\_Attribute\_Type: Optional + :Description: PI phone number + +PI\_email + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: PI e-mail + +Data\_Originator + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Data originator full name + +Data\_Originator\_affiliation + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Data originator complete affiliation + +Data\_Originator\_affiliation\_acronym + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Data originator affiliation acronym + +Data\_Originator\_address + :Type: *string* + :Global\_Attribute\_Type: Optional + :Description: Data originator complete address + +Data\_Originator\_phone + :Type: *string* + :Global\_Attribute\_Type: Optional + :Description: Data originator phone number + +Data\_Originator\_email + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Data originator e-mail address + +institution + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Istitution the product belong to + +system + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Name of the measuring instrument (lidar) + +hoi\_system\_ID + :Type: *int* + :Global\_Attribute\_Type: Mandatory + :Description: Numeric ID identifying the measuring system in the ACTRIS/EARLINET Handbook Of Instrument (HOI) + +hoi\_configuration\_ID; + :Type: *int* + :Global\_Attribute\_Type: Mandatory + :Description: Numeric ID identifying the configuration of the measuring system in the ACTRIS/EARLINET Handbook Of Instrument (HOI) + +measurement\_ID; + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Alphanumeric identifier for the raw data measurements use to generate the product + +measurement\_start\_datetime + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Measurement start datetime YYYY-mm-ddTHH:MM:SSZ + +measurement\_stop\_datetime + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Measruement stop datetime YYYY-mm-ddTHH:MM:SSZ + +comment + :Type: *string* + :Global\_Attribute\_Type: Optional + :Description: Any product comments + +scc\_version\_description + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Extended SCC version description + +scc\_version + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: SCC version number + +processor\_name + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Name of the processor used to generate the product + +processor\_version + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Version of the processor used to generate the product + +history + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Field describing the history of the product + +\_\_file\_format_version + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Version of the product file format + +data\_processing\_institution + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Instituion responsible for data processing + +input\_file + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Filename of the input data product used to generate the current product
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/file_formats/eldec_product_format.rst Fri Mar 19 13:43:18 2021 +0100 @@ -0,0 +1,416 @@ +ELDEC Products +-------------- + +This section describe the structure of ELDEC products. + + +ELDEC Products: dimensions +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The following dimensions are defined in ELDEC products: + +- time +- altitude +- ratio +- calibration +- nv + +The dimension *time* (mandatory) specifies the number of calibration performed at different times. + +The dimension *altitude* (mandatory) represents the number of rangebins characterizing +the reflected to transmitted polarization calibration ratio. + +The dimension *ratio* (mandatory) indicates the number reflected to transmitted ratios included in the product. + +The dimension *calibration* indicates the number of calibrations provided by the product. + +The dimension *nv* (mandatory) is ancillary and it is always set to 2. + + + +ELDEC Products: variables +~~~~~~~~~~~~~~~~~~~~~~~~~ + +latitude + :Type: *double* + :Dimensions: -- + :Variable\_Type: Mandatory + :Description: measurement site latitude + :Units: degrees_north + :Definition: *double latitude* + +longitude + :Type: *double* + :Dimensions: -- + :Variable\_Type: Mandatory + :Description: measurement site longitude + :Units: degrees_east + :Definition: *double longitude* + +station\_altitude + :Type: *double* + :Dimensions: -- + :Variable\_Type: Mandatory + :Description: station altitude above see level + :Units: m + :Definition: *double station\_altitude* + +altitude + :Type: *double* + :Dimensions: *altitude* + :Variable\_Type: Mandatory + :Description: altitude above see level + :Units: m + :Definition: *double altitude(altitude)* + +range + :Type: *double* + :Dimensions: *altitude* + :Variable\_Type: Mandatory + :Description: lidar range scale + :Units: m + :Definition: *double range(altitude)* + +shots + :Type: *int* + :Dimensions: *time* + :Variable\_Type: Mandatory + :Description: accumulated laser shots + :Units: -- + :Definition: *int shots(time)* + +time + :Type: *double* + :Dimensions: *time* + :Variable\_Type: Mandatory + :Description: seconds since 1970-01-01T00:00:00Z + :Units: -- + :Definition: *double time(time)* + +time\_bounds + :Type: *double* + :Dimensions: *time, nv* + :Variable\_Type: Mandatory + :Description: seconds since 1970-01-01T00:00:00Z + :Units: -- + :Definition: *double time\_bounds(time,nv)* + +scc\_product\_type + :Type: *byte* + :Dimensions: -- + :Variable\_Type: Mandatory + :Description: Bitmask describing the SCC product type + :Units: -- + :Definition: *byte scc\_product\_type* + +polarization\_calibration\_ratio\_emission\_wavelength + :Type: *double* + :Dimensions: *ratio* + :Variable\_Type: Mandatory + :Description: Emission wavelength of the reflected to transmitted polarization calibration + :Units: *nm* + :Definition: *double polarization\_calibration\_ratio\_emission\_wavelength(ratio)* + +polarization\_calibration\_ratio\_detection\_wavelength + :Type: *double* + :Dimensions: *ratio* + :Variable\_Type: Mandatory + :Description: Detection wavelength of the reflected to transmitted polarization calibration + :Units: *nm* + :Definition: *double polarization\_calibration\_ratio\_detection\_wavelength(ratio)* + +polarization\_calibration\_ratio\_range + :Type: *byte* + :Dimensions: *ratio* + :Variable\_Type: Mandatory + :Description: Bitmask to identify the reflected to transmitted polarization calibration ratio range type + :Units: -- + :Definition: *byte polarization\_calibration\_ratio\_range(ratio)* + +polarization\_calibration\_ratio\_configuration + :Type: *byte* + :Dimensions: *ratio* + :Variable\_Type: Mandatory + :Description: Bitmask to identify the reflected to transmitted polarization calibration ratio configuration type + :Units: -- + :Definition: *byte polarization\_calibration\_ratio\_configuration(ratio)* + +polarization\_calibration\_ratio + :Type: *double* + :Dimensions: *ratio, time, altitude* + :Variable\_Type: Mandatory + :Description: Uncalibrated reflected to transmitted polarization calibration ratio + :Units: -- + :Definition: *double polarization\_calibration\_ratio(ratio, time, altitude)* + +polarization\_calibration\_ratio\_statistical\_error + :Type: *double* + :Dimensions: *ratio, time, altitude* + :Variable\_Type: Mandatory + :Description: Statistical error (uncertainty) on uncalibrated reflected to transmitted polarization calibration ratio + :Units: -- + :Definition: *double polarization\_calibration\_ratio\_statistical\_error(ratio, time, altitude)* + +polarization\_calibration\_ratio\_systematic\_error + :Type: *double* + :Dimensions: *ratio, time, altitude* + :Variable\_Type: Optional + :Description: Systematic error (uncertainty) on uncalibrated reflected to transmitted polarization calibration ratio + :Units: -- + :Definition: *double polarization\_calibration\_ratio\_statistical\_error(ratio, time, altitude)* + +polarization\_calibration\_minimum\_range + :Type: *double* + :Dimensions: *ratio* + :Variable\_Type: Mandatory + :Description: Minimum altitude to consider for polarization calibration + :Units: *m* + :Definition: *double polarization\_calibration\_minimum\_range(ratio)* + + +polarization\_calibration\_maximum\_range + :Type: *double* + :Dimensions: *ratio* + :Variable\_Type: Mandatory + :Description: Maximum altitude to consider for polarization calibration + :Units: *m* + :Definition: *double polarization\_calibration\_maximum\_range(ratio)* + +polarization\_calibration\_ratio\_average + :Type: *double* + :Dimensions: *ratio, time* + :Variable\_Type: Mandatory + :Description: Average of the polarization calibration ratio within the calibration range + :Units: -- + :Definition: *double polarization\_calibration\_ratio\_average(ratio, time)* + +polarization\_calibration\_ratio\_average\_statistical_error + :Type: *double* + :Dimensions: *ratio, time* + :Variable\_Type: Mandatory + :Description: Statistical error (uncertainty) on the average of the polarization calibration ratio within the calibration range + :Units: -- + :Definition: *double polarization\_calibration\_ratio\_average\_statistical\_error(ratio, time)* + +polarization\_calibration\_ratio\_average\_systematic_error + :Type: *double* + :Dimensions: *ratio, time* + :Variable\_Type: Optional + :Description: Systematic error (uncertainty) on the average of the polarization calibration ratio within the calibration range + :Units: -- + :Definition: *double polarization\_calibration\_ratio\_average\_systematic\_error(ratio, time)* + +polarization\_gain\_factor\_wavelength + :Type: *double* + :Dimensions: *calibration* + :Variable\_Type: Mandatory + :Description: Polarization gain factor wavelength + :Units: *nm* + :Definition: *double polarization\_gain\_factor\_wavelength(calibration)* + +polarization\_gain\_factor\_range + :Type: *byte* + :Dimensions: *calibration* + :Variable\_Type: Mandatory + :Description: Bitmask to describe the polarization gain factor range type + :Units: -- + :Definition: *byte polarization\_gain\_factor\_range(calibration)* + + +polarization\_gain\_factor + :Type: *double* + :Dimensions: *calibration, time* + :Variable\_Type: Mandatory + :Description: Polarization gain factor (eta*) + :Units: -- + :Definition: *double polarization\_gain\_factor(calibration, time)* + +polarization\_gain\_factor\_statistical\_error + :Type: *double* + :Dimensions: *calibration, time* + :Variable\_Type: Mandatory + :Description: Statistical error (uncertainty) on polarization gain factor (eta*) + :Units: -- + :Definition: *double polarization\_gain\_factor\_statistical\_error(calibration, time)* + +polarization\_gain\_factor\_systematic\_error + :Type: *double* + :Dimensions: *calibration, time* + :Variable\_Type: Optional + :Description: Systematic error (uncertainty) on polarization gain factor (eta*) + :Units: -- + :Definition: *double polarization\_gain\_factor\_systematic\_error(calibration, time)* + + +ELDEC Products: global attributes +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Conventions + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: List of the conventions the product is compliant to + + +title + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Product title + +source + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: String describing the source used to generate the product + +references + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Reference(s) for data processing +location + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Measurement site location + +station_ID + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Unique 3 digit code identifying SCC station + +PI + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: PI full name + +PI\_affiliation + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: PI complete affiliation + +PI\_affiliation_acronym + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: PI affiliation acronym + +PI\_address + :Type: *string* + :Global\_Attribute\_Type: Optional + :Description: PI address + +PI\_phone + :Type: *string* + :Global\_Attribute\_Type: Optional + :Description: PI phone number + +PI\_email + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: PI e-mail + +Data\_Originator + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Data originator full name + +Data\_Originator\_affiliation + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Data originator complete affiliation + +Data\_Originator\_affiliation\_acronym + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Data originator affiliation acronym + +Data\_Originator\_address + :Type: *string* + :Global\_Attribute\_Type: Optional + :Description: Data originator complete address + +Data\_Originator\_phone + :Type: *string* + :Global\_Attribute\_Type: Optional + :Description: Data originator phone number + +Data\_Originator\_email + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Data originator e-mail address + +institution + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Istitution the product belong to + +system + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Name of the measuring instrument (lidar) + +hoi\_system\_ID + :Type: *int* + :Global\_Attribute\_Type: Mandatory + :Description: Numeric ID identifying the measuring system in the ACTRIS/EARLINET Handbook Of Instrument (HOI) + +hoi\_configuration\_ID; + :Type: *int* + :Global\_Attribute\_Type: Mandatory + :Description: Numeric ID identifying the configuration of the measuring system in the ACTRIS/EARLINET Handbook Of Instrument (HOI) + +measurement\_ID; + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Alphanumeric identifier for the raw data measurements use to generate the product + +measurement\_start\_datetime + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Measurement start datetime YYYY-mm-ddTHH:MM:SSZ + +measurement\_stop\_datetime + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Measruement stop datetime YYYY-mm-ddTHH:MM:SSZ + +comment + :Type: *string* + :Global\_Attribute\_Type: Optional + :Description: Any product comments + +scc\_version\_description + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Extended SCC version description + +scc\_version + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: SCC version number + +processor\_name + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Name of the processor used to generate the product + +processor\_version + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Version of the processor used to generate the product + +history + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Field describing the history of the product + +\_\_file\_format_version + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Version of the product file format + +data\_processing\_institution + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Instituion responsible for data processing + +input\_file + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Filename of the input data product used to generate the current product
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/file_formats/elic_product_format.rst Fri Mar 19 13:43:18 2021 +0100 @@ -0,0 +1,879 @@ + + +ELIC Products +------------- + +This section describe the structure of ELIC products. + + +ELIC Products: dimensions +~~~~~~~~~~~~~~~~~~~~~~~~~ + +The following dimensions are defined in ELPP products: + +- time +- level +- channel +- depolarization +- angle +- nv +- nc +- ncal + +The dimension *time* (mandatory) specifies the number of RCS (for each channel) +composing all the pre-processed time-series reported in the products. + +The dimension *level* (mandatory) represents the number of rangebins characterizing +the pre-processed RCS. + +The dimension *channel* (mandatory) indicates the number channels at which the RCS +time-series included in the product refer to. + +The dimension *depolarization* (optional) indicates how many volume depolarization time-series are included in the products. + +The dimension *angle* (mandatory) takes into account how many zenith scan angles have been used to measure the RCS time-series reported into the products. + +The dimension *nv* (mandatory) is ancillary and it is always set to 2. + +The dimension *nc* (optional) is ancillary and provides the number of channels involved in the calculation of RCS or volume depolarization time-series. + +The dimension *ncal* (mandatory) is ancillary and provides the number of optical calibration used to calibrate the current product. + +ELIC Products: variables +~~~~~~~~~~~~~~~~~~~~~~~~ + +latitude + :Type: *double* + :Dimensions: -- + :Variable\_Type: Mandatory + :Description: measurement site latitude + :Units: degrees_north + :Definition: *double latitude* + +longitude + :Type: *double* + :Dimensions: -- + :Variable\_Type: Mandatory + :Description: measurement site longitude + :Units: degrees_east + :Definition: *double longitude* + +station\_altitude + :Type: *double* + :Dimensions: -- + :Variable\_Type: Mandatory + :Description: station altitude above see level + :Units: m + :Definition: *double station\_altitude* + +altitude + :Type: *double* + :Dimensions: *time, level* + :Variable\_Type: Mandatory + :Description: altitude above see level + :Units: m + :Definition: *double altitude(time, level)* + +range + :Type: *double* + :Dimensions: *level* + :Variable\_Type: Mandatory + :Description: lidar range scale + :Units: m + :Definition: *double range(level)* + +laser\_pointing\_angle + :Type: *double* + :Dimensions: *angle* + :Variable\_Type: Mandatory + :Description: laser pointing angle with respect to the zenith + :Units: degrees + :Definition: *double laser\_pointing\_angle(angle)* + +laser\_pointing\_angle\_of\_profile + :Type: *int* + :Dimensions: *angle* + :Variable\_Type: Mandatory + :Description: index of scan angle at which each single raw profile has been detected + :Units: -- + :Definition: *int laser\_pointing\_angle\_of\_profile(angle)* + +shots + :Type: *int* + :Dimensions: *time* + :Variable\_Type: Mandatory + :Description: accumulated laser shots + :Units: -- + :Definition: *int shots(time)* + +time + :Type: *double* + :Dimensions: *time* + :Variable\_Type: Mandatory + :Description: seconds since 1970-01-01T00:00:00Z + :Units: -- + :Definition: *double time(time)* + +time\_bounds + :Type: *double* + :Dimensions: *time, nv* + :Variable\_Type: Mandatory + :Description: seconds since 1970-01-01T00:00:00Z + :Units: -- + :Definition: *double time\_bounds(time,nv)* + +scc\_product\_type + :Type: *byte* + :Dimensions: -- + :Variable\_Type: Mandatory + :Description: Bitmask describing the SCC product type + :Units: -- + :Definition: *byte scc\_product\_type* + +attenuated\_backscatter\_channel\_id + :Type: *int* + :Dimensions: *channel, nc* + :Variable\_Type: Optional + :Description: SCC channel ID list involved in the calculation of the total attenuated backscatter timeseries + :Units: -- + :Definition: *int attenuated\_backscatter\_channel\_id(channel, nc)* + +attenuated\_backscatter\_channel\_name + :Type: *string* + :Dimensions: *channel* + :Variable\_Type: Mandatory + :Description: Channel name for the total attenuated backscatter timeseries + :Units: -- + :Definition: *string attenuated\_backscatter\_channel\_name(channel)* + + +attenuated\_backscatter\_emission\_wavelength + :Type: *double* + :Dimensions: *channel* + :Variable\_Type: Mandatory + :Description: Emission wavelength used to measure the total attenuated backscatter timeseries + :Units: *nm* + :Definition: *double attenuated\_backscatter\_emission\_wavelength(channel)* + + +attenuated\_backscatter\_detection\_wavelength + :Type: *double* + :Dimensions: *channel* + :Variable\_Type: Mandatory + :Description: Detection wavelength used to measure the total attenuated backscatter timeseries + :Units: *nm* + :Definition: *double attenuated\_backscatter\_detection\_wavelength(channel)* + + +attenuated\_backscatter\_range + :Type: *byte* + :Dimensions: *channel* + :Variable\_Type: Mandatory + :Description: Bitmask to identify total attenuated backscatter range type + :Units: -- + :Definition: *byte attenuated\_backscatter\_range(channel)* + +attenuated\_backscatter\_scatterers + :Type: *byte* + :Dimensions: *channel* + :Variable\_Type: Mandatory + :Description: Bitmask to identify total attenuated backscatter scatterer type + :Units: -- + :Definition: *byte attenuated\_backscatter\_scatterers(channel)* + +attenuated\_backscatter\_detection\_mode + :Type: *byte* + :Dimensions: *channel* + :Variable\_Type: Mandatory + :Description: Bitmask to identify total attenuated backscatter detection mode + :Units: -- + :Definition: *byte attenuated\_backscatter\_detection\_mode(channel)* + + +near\_range\_glueing\_region\_minimum + :Type: *double* + :Dimensions: *channel, time* + :Variable\_Type: Optional + :Description: Mininum altitude of glueing region for the near range and far range signals + :Units: *m* + :Definition: *double near\_range\_glueing\_region\_minimum(channel, time)* + +near\_range\_glueing\_region\_maximum + :Type: *double* + :Dimensions: *channel, time* + :Variable\_Type: Optional + :Description: Mininum altitude of glueing region for the near range and far range signals + :Units: *m* + :Definition: *double near_range_glueing_region_maximum(channel, time)* + +ultra\_near\_range\_glueing\_region\_minimum + :Type: *double* + :Dimensions: *channel, time* + :Variable\_Type: Optional + :Description: Mininum altitude of glueing region for the ultra near range and near range signals + :Units: *m* + :Definition: *double ultra\_near\_range\_glueing\_region\_minimum(channel, time)* + +ultra\_near\_range\_glueing\_region\_maximum + :Type: *double* + :Dimensions: *channel, time* + :Variable\_Type: Optional + :Description: Maximum altitude of glueing region for the ultra near range and near range signals + :Units: *m* + :Definition: *double ultra\_near_range_glueing_region_maximum(channel, time)* + +attenuated\_backscatter + :Type: *double* + :Dimensions: *channel, time, level* + :Variable\_Type: Mandatory + :Description: Total attenuated baskcatter timeseries + :Units: *1/(m\*sr)* + :Definition: *double attenuated\_backscatter(channel, time, level)* + +attenuated\_backscatter\_statistical\_error + :Type: *double* + :Dimensions: *channel, time, level* + :Variable\_Type: Mandatory + :Description: Statistical error (uncertainty) on total attenuated backscatter timeseries + :Units: *1/(m\*sr)* + :Definition: *double attenuated\_backscatter\_statistical\_error(channel, time, level)* + + +attenuated\_backscatter\_systematic\_error + :Type: *double* + :Dimensions: *channel, time, level* + :Variable\_Type: Optional + :Description: Systematic error (uncertainty) on total attenuated backscatter timeseries + :Units: -- + :Definition: *double attenuated\_backscatter\_systematic\_error(channel, time, level)* + + +polarization\_gain\_factor\_measurementid + :Type: *string* + :Dimensions: *depolarization* + :Variable\_Type: Optional + :Description: Measurement ID corresponding to the polarization measurements used to calibrate polarization channels + :Units: -- + :Definition: *string polarization\_gain\_factor\_measurementid(depolarization)* + +polarization\_gain\_factor + :Type: *double* + :Dimensions: *depolarization* + :Variable\_Type: Optional + :Description: Reflected to transmitted polarization channel gain factor (eta*) + :Units: -- + :Definition: *double polarization\_gain\_factor(depolarization)* + +polarization\_gain\_factor\_statistical\_error + :Type: *double* + :Dimensions: *depolarization* + :Variable\_Type: Optional + :Description: Statistical error (uncertainty) on reflected to transmitted polarization channel gain factor + :Units: -- + :Definition: *double polarization\_gain\_factor\_statistical\_error(depolarization)* + +polarization\_gain\_factor\_systematic\_error + :Type: *double* + :Dimensions: *depolarization* + :Variable\_Type: Optional + :Description: Systamatic error (uncertainty) on reflected to transmitted polarization channel gain factor + :Units: -- + :Definition: *double polarization\_gain\_factor\_systematic\_error(depolarization)* + + +polarization\_gain\_factor\_start\_datetime + :Type: *double* + :Dimensions: *depolarization* + :Variable\_Type: Optional + :Description: Polarization gain factor measurement start datetime + :Units: seconds since 1970-01-01T00:00:00Z + :Definition: *double polarization\_gain\_factor\_start\_datetime(depolarization)* + +polarization\_gain\_factor\_stop\_datetime + :Type: *double* + :Dimensions: *depolarization* + :Variable\_Type: Optional + :Description: Polarization gain factor measurement stop datetime + :Units: seconds since 1970-01-01T00:00:00Z + :Definition: *double polarization\_gain\_factor\_stop\_datetime(depolarization)* + + +polarization\_gain\_factor\_correction + :Type: *double* + :Dimensions: *depolarization* + :Variable\_Type: Optional + :Description: Reflected to transmitted polarization channel gain correction factor (K) + :Units: -- + :Definition: *double polarization\_gain\_factor\_correction(depolarization)* + +polarization\_gain\_factor\_correction\_statistical\_error + :Type: *double* + :Dimensions: *depolarization* + :Variable\_Type: Optional + :Description: Statistical error (uncertainty) on reflected to transmitted polarization channel gain correction factor + :Units: -- + :Definition: *double polarization\_gain\_factor\_correction\_statistical_error(depolarization)* + +polarization\_gain\_factor\_correction\_systematic\_error + :Type: *double* + :Dimensions: *depolarization* + :Variable\_Type: Optional + :Description: Systamatic error (uncertainty) on reflected to transmitted polarization channel gain correction factor + :Units: -- + :Definition: *double polarization\_gain\_factor\_correction\_systematic\_error(depolarization)* + + +polarization\_gain\_factor\_correction\_start\_datetime + :Type: *double* + :Dimensions: *depolarization* + :Variable\_Type: Optional + :Description: Polarization gain corrrection factor measurement start datetime + :Units: seconds since 1970-01-01T00:00:00Z + :Definition: *double polarization\_gain\_factor\_correction\_start\_datetime(depolarization)* + +polarization\_gain\_factor\_correction\_stop\_datetime + :Type: *double* + :Dimensions: *depolarization* + :Variable\_Type: Optional + :Description: Polarization gain correction factor measurement stop datetime + :Units: seconds since 1970-01-01T00:00:00Z + :Definition: *double polarization\_gain\_factor\_correction\_stop\_datetime(depolarization)* + +cloud\_mask\_type + :Type: *byte* + :Dimensions: -- + :Variable\_Type: Optional + :Description: Bimask describing the cloudmask type + :Units: -- + :Definition: *byte cloud_mask_type* + +cloud\_mask + :Type: *byte* + :Dimensions: *time, level* + :Variable\_Type: Optional + :Description: Bimask describing the cloudmask + :Units: -- + :Definition: *byte cloud_mask(time, level)* + +cloud\_fraction + :Type: *double* + :Dimensions: *time, level* + :Variable\_Type: Optional + :Description: Fraction of cloud contamination + :Units: -- + :Definition: *byte cloud_mask(time, altitude)* + +temperature + :Type: *double* + :Dimensions: *time, level* + :Variable\_Type: Optional + :Description: Atmospheric temperature + :Units: K + :Definition: *double temperature(time, level)* + +pressure + :Type: *double* + :Dimensions: *time, level* + :Variable\_Type: Optional + :Description: Atmospheric pressure + :Units: mbar + :Definition: *double pressure(time, level)* + +molecular\_calculation\_source + :Type: *byte* + :Dimensions: -- + :Variable\_Type: Optional + :Description: Source used to compute the atmospheric molecular density + :Units: -- + :Definition: *byte molecular_calculation_source* + + +polarization\_crosstalk\_parameter\_g + :Type: *double* + :Dimensions: *channel* + :Variable\_Type: Optional + :Description: Polarization crosstalk parameter (G) + :Units: -- + :Definition: *double polarization\_crosstalk\_parameter\_g(channel)* + +polarization\_crosstalk\_parameter\_g\_statistical\_error + :Type: *double* + :Dimensions: *channel* + :Variable\_Type: Optional + :Description: Statistical error on polarization crosstalk parameter (G) + :Units: -- + :Definition: *double polarization\_crosstalk\_parameter\_g\_statistical\_error(channel)* + +polarization\_crosstalk\_parameter\_g\_systematic\_error + :Type: *double* + :Dimensions: *channel* + :Variable\_Type: Optional + :Description: Systematic error on polarization crosstalk parameter (G) + :Units: -- + :Definition: *double polarization\_crosstalk\_parameter\_g\_systematic\_error(channel)* + +polarization\_crosstalk\_parameter\_h + :Type: *double* + :Dimensions: *channel* + :Variable\_Type: Optional + :Description: Polarization crosstalk parameter (H) + :Units: -- + :Definition: *double polarization\_crosstalk\_parameter\_h(channel)* + +polarization\_crosstalk\_parameter\_h\_statistical\_error + :Type: *double* + :Dimensions: *channel* + :Variable\_Type: Optional + :Description: Statistical error on polarization crosstalk parameter (H) + :Units: -- + :Definition: *double polarization\_crosstalk\_parameter\_h\_statistical\_error(channel)* + +polarization\_crosstalk\_parameter\_h\_systematic\_error + :Type: *double* + :Dimensions: *channel* + :Variable\_Type: Optional + :Description: Systematic error on polarization crosstalk parameter (H) + :Units: -- + :Definition: *double polarization\_crosstalk\_parameter\_H\_systematic\_error(channel)* + +polarization\_channel\_geometry + :Type: *byte* + :Dimensions: *channel* + :Variable\_Type: Optional + :Description: Polarization channel geometry + :Units: -- + :Definition: *byte polarization\_channel\_geometry* + +polarization\_channel\_configuration + :Type: *byte* + :Dimensions: *channel* + :Variable\_Type: Optional + :Description: Polarization channel configuration + :Units: -- + :Definition: *byte polarization\_channel\_configuration(channel)* + +overlap\_correction\_function + :Type: *double* + :Dimensions: *channel,angle, level* + :Variable\_Type: Optional + :Description: Overlap funciton used to correct the range corrected signal + :Units: -- + :Definition: *double overlap\_correction\_function(channel, angle, level)* + +assumed\_particle\_lidar\_ratio + :Type: *double* + :Dimensions: *angle, level* + :Variable\_Type: Optional + :Description: Assumed particle lidar ration for the elastic-only backscatter retrieval + :Units: *sr* + :Definition: *double assumed\_particle\_lidar\_ratio(angle, level)* + +assumed\_particle\_lidar\_ratio\_error + :Type: *double* + :Dimensions: *angle, level* + :Variable\_Type: Optional + :Description: Total error (uncertainty) on assumed particle lidar ration for the elastic-only backscatter retrieval + :Units: *sr* + :Definition: *double assumed\_particle\_lidar\_ratio(angle, level)* + + +molecular\_extinction + :Type: *double* + :Dimensions: *channel, time, level* + :Variable\_Type: Optional + :Description: Calculated molecular extinction at emission wavelength + :Units: *m^{-1}* + :Definition: *double molecular\_extinction(channel, time, level)* + +molecular\_transmissivity\_at\_emission\_wavelength + :Type: *double* + :Dimensions: *channel, time, level* + :Variable\_Type: Optional + :Description: Calculate molecular transmissivity at emission wavelentgh + :Units: -- + :Definition: *double molecular\_transmissivity\_at\_emission\_wavelength(channel, time, level)* + +molecular\_transmissivity\_at\_detection\_wavelength + :Type: *double* + :Dimensions: *channel, time, level* + :Variable\_Type: Optional + :Description: Calculate molecular transmissivity at detection wavelentgh + :Units: -- + :Definition: *double molecular\_transmissivity\_at\_detection\_wavelength(channel, time, level)* + + +molecular\_lidar\_ratio + :Type: *double* + :Dimensions: *channel* + :Variable\_Type: Optional + :Description: Calculated molecular lidar ratio at emission wavelength + :Units: *sr* + :Definition: *double molecular\_lidar\_ratio(channel)* + + +depolarization\_calibration\_index + :Type: *int* + :Dimensions: *channel* + :Variable\_Type: Optional + :Description: Depolarization index to use to calibrate the channel + :Units: -- + :Definition: *int depolarization\_calibration\_index(channel)* + +polarization\_calibration\_type + :Type: *byte* + :Dimensions: *depolarization* + :Variable\_Type: Optional + :Description: Polarization calibration type + :Units: -- + :Definition: *byte polarization\_calibration\_type(depolarization)* + +molecular\_depolarization\_ratio + :Type: *double* + :Dimensions: *depolarization, time, level* + :Variable\_Type: Optional + :Description: Calculated molecular depolarization ratio + :Units: -- + :Definition: *double molecular\_depolarization\_ratio(depolarization, time, level)* + + +atmospheric\_background + :Type: *double* + :Dimensions: *channel, time* + :Variable\_Type: Optional + :Description: Mean atmospheric background calculated from lidar signal + :Units: *1/(m^3\*sr)* + :Definition: *double atmospheric\_background(channel, time)* + +atmospheric\_background\_stdev + :Type: *double* + :Dimensions: *channel, time* + :Variable\_Type: Optional + :Description: Standard deviation of atmospheric background calculated from lidar signal + :Units: *1/(m^3\*sr)* + :Definition: *double atmospheric\_background\_stdev(channel, time)* + +atmospheric\_background\_sterr + :Type: *double* + :Dimensions: *channel, time* + :Variable\_Type: Optional + :Description: Standard error of atmospheric background calculated from lidar signal + :Units: *1/(m^3\*sr)* + :Definition: *double atmospheric\_background\_sterr(channel, time)* + +atmospheric\_background\_min + :Type: *double* + :Dimensions: *channel, time* + :Variable\_Type: Optional + :Description: Minimum atmospheric background calculated from lidar signal + :Units: *1/(m^3\*sr)* + :Definition: *double atmospheric\_background\_min(channel, time)* + +atmospheric\_background\_max + :Type: *double* + :Dimensions: *channel, time* + :Variable\_Type: Optional + :Description: Maximum atmospheric background calculated from lidar signal + :Units: *1/(m^3\*sr)* + :Definition: *double atmospheric\_background\_max(channel, time)* + + +volume\_linear\_depolarization\_ratio\_channel\_id + :Type: *int* + :Dimensions: *depolarization, nc* + :Variable\_Type: Optional + :Description: SCC channel ID list involved in the calculation of the volume linear depolarization ratio timeseries + :Units: -- + :Definition: *int volume\_linear\_depolarization\_ratio\_channel\_id(depolarization, nc)* + + +volume\_linear\_depolarization\_ratio\_channel\_name + :Type: *string* + :Dimensions: *depolarization* + :Variable\_Type: Optional + :Description: Channel name for volume linear depolarization ration timeseries + :Units: -- + :Definition: *string volume\_linear\_depolarization\_ratio\_channel\_name(depolarization)* + + +volume\_linear\_depolarization\_ratio\_wavelength + :Type: *double* + :Dimensions: *depolarization* + :Variable\_Type: Optional + :Description: Wavelength at which the volume linear depolarization ratio is calculated + :Units: *nm* + :Definition: *double volume\_linear\_depolarization\_ratio\_wavelength(depolarization)* + + +volume\_linear\_depolarization\_ratio\_range + :Type: *byte* + :Dimensions: *depolarization* + :Variable\_Type: Optional + :Description: Bitmask field indicating the volume linear depolarization range type + :Units: -- + :Definition: *byte volume\_linear\_depolarization\_ratio\_range(depolarization)* + + + +volume\_linear\_depolarization\_ratio\_scatterers + :Type: *byte* + :Dimensions: *depolarization* + :Variable\_Type: Optional + :Description: Bitmask field indicating the volume linear depolarization scatteter type + :Units: -- + :Definition: *byte volume\_linear\_depolarization\_ratio\_scatterers(depolarization)* + + +volume\_linear\_depolarization\_ratio + :Type: *double* + :Dimensions: *depolarization, time, level* + :Variable\_Type: Optional + :Description: Volume linear depolarization ratio timeseries + :Units: -- + :Definition: *double volume\_linear\_depolarization\_ratio(depolarization, time, level)* + +volume\_linear\_depolarization\_ratio\_statistical\_error + :Type: *double* + :Dimensions: *depolarization, time, level* + :Variable\_Type: Optional + :Description: Statistical error (uncertanity) on volume linear depolarization ratio timeseries + :Units: -- + :Definition: *double volume\_linear\_depolarization\_ratio\_statistical\_error(depolarization, time, level)* + +volume\_linear\_depolarization\_ratio\_systematic\_error + :Type: *double* + :Dimensions: *depolarization, time, level* + :Variable\_Type: Optional + :Description: Systematic error (uncertanity) on volume linear depolarization ratio timeseries + :Units: -- + :Definition: *double volume\_linear\_depolarization\_ratio\_systematic\_error(depolarization, time, level)* + +attenuated\_backscatter\_calibration + :Type: *double* + :Dimensions: *channel, time* + :Variable\_Type: Mandatory + :Description: Constant used to calibrate the total attenuated backscatter + :Units: -- + :Definition: *double attenuated\_backscatter\_calibration(channel, time)* + +attenuated\_backscatter\_calibration\_statistical\_error + :Type: *double* + :Dimensions: *channel, time* + :Variable\_Type: Mandatory + :Description: Statistical error (uncertainty) of the attenuated backscatter calibration + :Units: -- + :Definition: *double attenuated\_backscatter\_calibration\_statistical\_error(channel, time)* + +attenuated\_backscatter\_calibration\_systematic\_error + :Type: *double* + :Dimensions: *channel, time* + :Variable\_Type: Mandatory + :Description: Systematic error (uncertainty) of the attenuated backscatter calibration + :Units: -- + :Definition: *double attenuated\_backscatter\_calibration\_sytematic\_error(channel, time)* + +attenuated\_backscatter\_calibration\_start\_datetime + :Type: *double* + :Dimensions: *channel, ncal* + :Variable\_Type: Mandatory + :Description: Attenuated backscatter calibration measurement start datetime + :Units: *seconds since 1970-01-01T00:00:00Z* + :Definition: *double attenuated\_backscatter\_calibration\_start\_datetime(channel, ncal)* + +attenuated\_backscatter\_calibration\_stop\_datetime + :Type: *double* + :Dimensions: *channel, ncal* + :Variable\_Type: Mandatory + :Description: Attenuated backscatter calibration measurement stop datetime + :Units: *seconds since 1970-01-01T00:00:00Z* + :Definition: *double attenuated\_backscatter\_calibration\_stop\_datetime(channel, ncal)* + +attenuated\_backscatter\_calibration\_measurementid + :Type: *string* + :Dimensions: *channel, ncal* + :Variable\_Type: Mandatory + :Description: Attenuated backscatter calibration measurementID + :Units: -- + :Definition: *string attenuated\_backscatter\_calibration\_measurementid(channel, ncal)* + +attenuated\_backscatter\_calibration\_id + :Type: *int* + :Dimensions: *channel, ncal* + :Variable\_Type: Mandatory + :Description: Attenuated backscatter calibration ID + :Units: -- + :Definition: *int attenuated\_backscatter\_calibration\_id(channel, ncal)* + + + +ELIC Products: global attributes +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Conventions + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: List of the conventions the product is compliant to + + +title + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Product title + +source + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: String describing the source used to generate the product + +references + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Reference(s) for data processing +location + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Measurement site location + +station_ID + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Unique 3 digit code identifying SCC station + +PI + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: PI full name + +PI\_affiliation + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: PI complete affiliation + +PI\_affiliation_acronym + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: PI affiliation acronym + +PI\_address + :Type: *string* + :Global\_Attribute\_Type: Optional + :Description: PI address + +PI\_phone + :Type: *string* + :Global\_Attribute\_Type: Optional + :Description: PI phone number + +PI\_email + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: PI e-mail + +Data\_Originator + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Data originator full name + +Data\_Originator\_affiliation + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Data originator complete affiliation + +Data\_Originator\_affiliation\_acronym + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Data originator affiliation acronym + +Data\_Originator\_address + :Type: *string* + :Global\_Attribute\_Type: Optional + :Description: Data originator complete address + +Data\_Originator\_phone + :Type: *string* + :Global\_Attribute\_Type: Optional + :Description: Data originator phone number + +Data\_Originator\_email + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Data originator e-mail address + +institution + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Istitution the product belong to + +system + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Name of the measuring instrument (lidar) + +hoi\_system\_ID + :Type: *int* + :Global\_Attribute\_Type: Mandatory + :Description: Numeric ID identifying the measuring system in the ACTRIS/EARLINET Handbook Of Instrument (HOI) + +hoi\_configuration\_ID; + :Type: *int* + :Global\_Attribute\_Type: Mandatory + :Description: Numeric ID identifying the configuration of the measuring system in the ACTRIS/EARLINET Handbook Of Instrument (HOI) + +measurement\_ID; + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Alphanumeric identifier for the raw data measurements use to generate the product + +measurement\_start\_datetime + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Measurement start datetime YYYY-mm-ddTHH:MM:SSZ + +measurement\_stop\_datetime + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Measruement stop datetime YYYY-mm-ddTHH:MM:SSZ + +comment + :Type: *string* + :Global\_Attribute\_Type: Optional + :Description: Any product comments + +scc\_version\_description + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Extended SCC version description + +scc\_version + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: SCC version number + +processor\_name + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Name of the processor used to generate the product + +processor\_version + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Version of the processor used to generate the product + +history + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Field describing the history of the product + +\_\_file\_format_version + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Version of the product file format + +data\_processing\_institution + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Instituion responsible for data processing + +input\_file + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Filename of the input data product used to generate the current product
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/file_formats/elpp_product_format.rst Fri Mar 19 13:43:18 2021 +0100 @@ -0,0 +1,710 @@ + + +ELPP Products +---------------- + +This section describe the structure of ELPP products. + + +ELPP Products: dimensions +~~~~~~~~~~~~~~~~~~~~~~~~~ + +The following dimensions are defined in ELPP products: + +- time +- level +- channel +- depolarization +- angle +- nv +- nc + +The dimension *time* (mandatory) specifies the number of RCS (for each channel) +composing all the pre-processed time-series reported in the products. + +The dimension *level* (mandatory) represents the number of rangebins characterizing +the pre-processed RCS. + +The dimension *channel* (mandatory) indicates the number channels at which the RCS +time-series included in the product refer to. + +The dimension *depolarization* (optional) indicates how many volume depolarization time-series are included in the products. + +The dimension *angle* (mandatory) takes into account how many zenith scan angles have been used to measure the RCS time-series reported into the products. + +The dimension *nv* (mandatory) is ancillary and it is always set to 2. + +The dimension *nc* (optional) is ancillary and provides the number of channels involved in the calculation of RCS or volume depolarization time-series. + + +ELPP Products: variables +~~~~~~~~~~~~~~~~~~~~~~~~ + +latitude + :Type: *double* + :Dimensions: -- + :Variable\_Type: Mandatory + :Description: measurement site latitude + :Units: degrees_north + :Definition: *double latitude* + +longitude + :Type: *double* + :Dimensions: -- + :Variable\_Type: Mandatory + :Description: measurement site longitude + :Units: degrees_east + :Definition: *double longitude* + +station\_altitude + :Type: *double* + :Dimensions: -- + :Variable\_Type: Mandatory + :Description: station altitude above see level + :Units: m + :Definition: *double station\_altitude* + +altitude + :Type: *double* + :Dimensions: *time, level* + :Variable\_Type: Mandatory + :Description: altitude above see level + :Units: m + :Definition: *double altitude(time, level)* + +range + :Type: *double* + :Dimensions: *level* + :Variable\_Type: Mandatory + :Description: lidar range scale + :Units: m + :Definition: *double range(level)* + +laser\_pointing\_angle + :Type: *double* + :Dimensions: *angle* + :Variable\_Type: Mandatory + :Description: laser pointing angle with respect to the zenith + :Units: degrees + :Definition: *double laser\_pointing\_angle(angle)* + +laser\_pointing\_angle\_of\_profile + :Type: *int* + :Dimensions: *angle* + :Variable\_Type: Mandatory + :Description: index of scan angle at which each single raw profile has been detected + :Units: -- + :Definition: *int laser\_pointing\_angle\_of\_profile(angle)* + +shots + :Type: *int* + :Dimensions: *time* + :Variable\_Type: Mandatory + :Description: accumulated laser shots + :Units: -- + :Definition: *int shots(time)* + +time + :Type: *double* + :Dimensions: *time* + :Variable\_Type: Mandatory + :Description: seconds since 1970-01-01T00:00:00Z + :Units: -- + :Definition: *double time(time)* + +time\_bounds + :Type: *double* + :Dimensions: *time, nv* + :Variable\_Type: Mandatory + :Description: seconds since 1970-01-01T00:00:00Z + :Units: -- + :Definition: *double time\_bounds(time,nv)* + +cloud\_mask\_type + :Type: *byte* + :Dimensions: -- + :Variable\_Type: Mandatory + :Description: Bimask describing the cloudmask type + :Units: -- + :Definition: *byte cloud_mask_type* + +cloud\_mask + :Type: *byte* + :Dimensions: *time, level* + :Variable\_Type: Optional + :Description: Bimask describing the cloudmask + :Units: -- + :Definition: *byte cloud_mask(time, level)* + +cloud\_fraction + :Type: *double* + :Dimensions: *time, level* + :Variable\_Type: Optional + :Description: Fraction of cloud contamination + :Units: -- + :Definition: *byte cloud_mask(time, altitude)* + +temperature + :Type: *double* + :Dimensions: *time, level* + :Variable\_Type: Mandatory + :Description: Atmospheric temperature + :Units: K + :Definition: *double temperature(time, level)* + +pressure + :Type: *double* + :Dimensions: *time, level* + :Variable\_Type: Mandatory + :Description: Atmospheric pressure + :Units: mbar + :Definition: *double pressure(time, level)* + +molecular\_calculation\_source + :Type: *byte* + :Dimensions: -- + :Variable\_Type: Mandatory + :Description: Source used to compute the atmospheric molecular density + :Units: -- + :Definition: *byte molecular_calculation_source* + +scc\_product\_type + :Type: *byte* + :Dimensions: -- + :Variable\_Type: Mandatory + :Description: Bitmask describing the SCC product type + :Units: -- + :Definition: *byte scc\_product\_type* + +range\_corrected\_signal\_channel\_id + :Type: *int* + :Dimensions: *channel, nc* + :Variable\_Type: Optional + :Description: SCC channel ID list involved in the calculation of the range corrected signal total timeseries + :Units: -- + :Definition: *int range\_corrected\_signal\_channel\_id(channel, nc)* + + +range\_corrected\_signal\_channel\_name + :Type: *string* + :Dimensions: *channel* + :Variable\_Type: Mandatory + :Description: Channel name for the range corrected signal timeseries + :Units: -- + :Definition: *string range\_corrected\_signal\_channel\_name(channel)* + + +range\_corrected\_signal\_emission\_wavelength + :Type: *double* + :Dimensions: *channel* + :Variable\_Type: Mandatory + :Description: Emission wavelength used to measure the range corrected signal timeseries + :Units: *nm* + :Definition: *double range\_corrected\_signal\_emission\_wavelength(channel)* + + +range\_corrected\_signal\_detection\_wavelength + :Type: *double* + :Dimensions: *channel* + :Variable\_Type: Mandatory + :Description: Detection wavelength used to measure the range corrected signal timeseries + :Units: *nm* + :Definition: *double range\_corrected\_signal\_detection\_wavelength(channel)* + + +range\_corrected\_signal\_range + :Type: *byte* + :Dimensions: *channel* + :Variable\_Type: Mandatory + :Description: Bitmask to identify range corrected signal range type + :Units: -- + :Definition: *byte range\_corrected\_signal\_range(channel)* + +range\_corrected\_signal\_scatterers + :Type: *byte* + :Dimensions: *channel* + :Variable\_Type: Mandatory + :Description: Bitmask to identify range corrected signal scatterer type + :Units: -- + :Definition: *byte range\_corrected\_signal\_scatterers(channel)* + +range\_corrected\_signal\_detection\_mode + :Type: *byte* + :Dimensions: *channel* + :Variable\_Type: Mandatory + :Description: Bitmask to identify range corrected signal detection mode + :Units: -- + :Definition: *byte range\_corrected\_signal\_detection\_mode(channel)* + +polarization\_crosstalk\_parameter\_g + :Type: *double* + :Dimensions: *channel* + :Variable\_Type: Optional + :Description: Polarization crosstalk parameter (G) + :Units: -- + :Definition: *double polarization\_crosstalk\_parameter\_g(channel)* + +polarization\_crosstalk\_parameter\_g\_statistical\_error + :Type: *double* + :Dimensions: *channel* + :Variable\_Type: Optional + :Description: Statistical error on polarization crosstalk parameter (G) + :Units: -- + :Definition: *double polarization\_crosstalk\_parameter\_g\_statistical\_error(channel)* + +polarization\_crosstalk\_parameter\_g\_systematic\_error + :Type: *double* + :Dimensions: *channel* + :Variable\_Type: Optional + :Description: Systematic error on polarization crosstalk parameter (G) + :Units: -- + :Definition: *double polarization\_crosstalk\_parameter\_g\_systematic\_error(channel)* + +polarization\_crosstalk\_parameter\_h + :Type: *double* + :Dimensions: *channel* + :Variable\_Type: Optional + :Description: Polarization crosstalk parameter (H) + :Units: -- + :Definition: *double polarization\_crosstalk\_parameter\_h(channel)* + +polarization\_crosstalk\_parameter\_h\_statistical\_error + :Type: *double* + :Dimensions: *channel* + :Variable\_Type: Optional + :Description: Statistical error on polarization crosstalk parameter (H) + :Units: -- + :Definition: *double polarization\_crosstalk\_parameter\_h\_statistical\_error(channel)* + +polarization\_crosstalk\_parameter\_h\_systematic\_error + :Type: *double* + :Dimensions: *channel* + :Variable\_Type: Optional + :Description: Systematic error on polarization crosstalk parameter (H) + :Units: -- + :Definition: *double polarization\_crosstalk\_parameter\_H\_systematic\_error(channel)* + + +polarization\_channel\_geometry + :Type: *byte* + :Dimensions: *channel* + :Variable\_Type: Optional + :Description: Polarization channel geometry + :Units: -- + :Definition: *byte polarization\_channel\_geometry* + + + +polarization\_channel\_configuration + :Type: *byte* + :Dimensions: *channel* + :Variable\_Type: Optional + :Description: Polarization channel configuration + :Units: -- + :Definition: *byte polarization\_channel\_configuration(channel)* + + +overlap\_correction\_function + :Type: *double* + :Dimensions: *channel,angle, level* + :Variable\_Type: Mandatory + :Description: Overlap funciton used to correct the range corrected signal + :Units: -- + :Definition: *double overlap\_correction\_function(channel, angle, level)* + +assumed\_particle\_lidar\_ratio + :Type: *double* + :Dimensions: *angle, level* + :Variable\_Type: Optional + :Description: Assumed particle lidar ration for the elastic-only backscatter retrieval + :Units: *sr* + :Definition: *double assumed\_particle\_lidar\_ratio(angle, level)* + +assumed\_particle\_lidar\_ratio\_error + :Type: *double* + :Dimensions: *angle, level* + :Variable\_Type: Optional + :Description: Total error (uncertainty) on assumed particle lidar ration for the elastic-only backscatter retrieval + :Units: *sr* + :Definition: *double assumed\_particle\_lidar\_ratio(angle, level)* + + +molecular\_extinction + :Type: *double* + :Dimensions: *channel, time, level* + :Variable\_Type: Mandatory + :Description: Calculated molecular extinction at emission wavelength + :Units: *m^{-1}* + :Definition: *double molecular\_extinction(channel, time, level)* + +molecular\_transmissivity\_at\_emission\_wavelength + :Type: *double* + :Dimensions: *channel, time, level* + :Variable\_Type: Mandatory + :Description: Calculate molecular transmissivity at emission wavelentgh + :Units: -- + :Definition: *double molecular\_transmissivity\_at\_emission\_wavelength(channel, time, level)* + +molecular\_transmissivity\_at\_detection\_wavelength + :Type: *double* + :Dimensions: *channel, time, level* + :Variable\_Type: Mandatory + :Description: Calculate molecular transmissivity at detection wavelentgh + :Units: -- + :Definition: *double molecular\_transmissivity\_at\_detection\_wavelength(channel, time, level)* + + +molecular\_lidar\_ratio + :Type: *double* + :Dimensions: *channel* + :Variable\_Type: Mandatory + :Description: Calculated molecular lidar ratio at emission wavelength + :Units: *sr* + :Definition: *double molecular\_lidar\_ratio(channel)* + +depolarization\_calibration\_index + :Type: *int* + :Dimensions: *channel* + :Variable\_Type: Optional + :Description: Depolarization index to use to calibrate the channel + :Units: -- + :Definition: *int depolarization\_calibration\_index(channel)* + +polarization\_calibration\_type + :Type: *byte* + :Dimensions: *depolarization* + :Variable\_Type: Optional + :Description: Polarization calibration type + :Units: -- + :Definition: *byte polarization\_calibration\_type(depolarization)* + +molecular\_depolarization\_ratio + :Type: *double* + :Dimensions: *depolarization, time, level* + :Variable\_Type: Optional + :Description: Calculated molecular depolarization ratio + :Units: -- + :Definition: *double molecular\_depolarization\_ratio(depolarization, time, level)* + +near\_range\_glueing\_region\_minimum + :Type: *double* + :Dimensions: *channel, time* + :Variable\_Type: Optional + :Description: Mininum altitude of glueing region for the near range and far range signals + :Units: *m* + :Definition: *double near\_range\_glueing\_region\_minimum(channel, time)* + +near\_range\_glueing\_region\_maximum + :Type: *double* + :Dimensions: *channel, time* + :Variable\_Type: Optional + :Description: Mininum altitude of glueing region for the near range and far range signals + :Units: *m* + :Definition: *double near_range_glueing_region_maximum(channel, time)* + +ultra\_near\_range\_glueing\_region\_minimum + :Type: *double* + :Dimensions: *channel, time* + :Variable\_Type: Optional + :Description: Mininum altitude of glueing region for the ultra near range and near range signals + :Units: *m* + :Definition: *double ultra\_near\_range\_glueing\_region\_minimum(channel, time)* + +ultra\_near\_range\_glueing\_region\_maximum + :Type: *double* + :Dimensions: *channel, time* + :Variable\_Type: Optional + :Description: Maximum altitude of glueing region for the ultra near range and near range signals + :Units: *m* + :Definition: *double ultra\_near_range_glueing_region_maximum(channel, time)* + +range\_corrected\_signal + :Type: *double* + :Dimensions: *channel, time, level* + :Variable\_Type: Mandatory + :Description: Range corrected signal timeseries + :Units: -- + :Definition: *double range\_corrected\_signal(channel, time, level)* + +range\_corrected\_signal\_statistical\_error + :Type: *double* + :Dimensions: *channel, time, level* + :Variable\_Type: Mandatory + :Description: Statistical error (uncertainty) on range corrected signal timeseries + :Units: -- + :Definition: *double range\_corrected\_signal\_statistical\_error(channel, time, level)* + + +range\_corrected\_signal\_systematic\_error + :Type: *double* + :Dimensions: *channel, time, level* + :Variable\_Type: Optional + :Description: Systematic error (uncertainty) on range corrected signal timeseries + :Units: -- + :Definition: *double range\_corrected\_signal\_statistical\_error(channel, time, level)* + +polarization\_gain\_factor\_measurementid + :Type: *string* + :Dimensions: *depolarization* + :Variable\_Type: Optional + :Description: Measurement ID corresponding to the polarization measurements used to calibrate polarization channels + :Units: -- + :Definition: *string polarization\_gain\_factor\_measurementid(depolarization)* + +polarization\_gain\_factor + :Type: *double* + :Dimensions: *depolarization* + :Variable\_Type: Optional + :Description: Reflected to transmitted polarization channel gain factor (eta*) + :Units: -- + :Definition: *double polarization\_gain\_factor(depolarization)* + +polarization\_gain\_factor\_statistical\_error + :Type: *double* + :Dimensions: *depolarization* + :Variable\_Type: Optional + :Description: Statistical error (uncertainty) on reflected to transmitted polarization channel gain factor + :Units: -- + :Definition: *double polarization\_gain\_factor\_statistical\_error(depolarization)* + +polarization\_gain\_factor\_systematic\_error + :Type: *double* + :Dimensions: *depolarization* + :Variable\_Type: Optional + :Description: Systamatic error (uncertainty) on reflected to transmitted polarization channel gain factor + :Units: -- + :Definition: *double polarization\_gain\_factor\_systematic\_error(depolarization)* + + +polarization\_gain\_factor\_start\_datetime + :Type: *double* + :Dimensions: *depolarization* + :Variable\_Type: Optional + :Description: Polarization gain factor measurement start datetime + :Units: seconds since 1970-01-01T00:00:00Z + :Definition: *double polarization\_gain\_factor\_start\_datetime(depolarization)* + +polarization\_gain\_factor\_stop\_datetime + :Type: *double* + :Dimensions: *depolarization* + :Variable\_Type: Optional + :Description: Polarization gain factor measurement stop datetime + :Units: seconds since 1970-01-01T00:00:00Z + :Definition: *double polarization\_gain\_factor\_stop\_datetime(depolarization)* + + +polarization\_gain\_factor\_correction + :Type: *double* + :Dimensions: *depolarization* + :Variable\_Type: Optional + :Description: Reflected to transmitted polarization channel gain correction factor (K) + :Units: -- + :Definition: *double polarization\_gain\_factor\_correction(depolarization)* + +polarization\_gain\_factor\_correction\_statistical\_error + :Type: *double* + :Dimensions: *depolarization* + :Variable\_Type: Optional + :Description: Statistical error (uncertainty) on reflected to transmitted polarization channel gain correction factor + :Units: -- + :Definition: *double polarization\_gain\_factor\_correction\_statistical_error(depolarization)* + +polarization\_gain\_factor\_correction\_systematic\_error + :Type: *double* + :Dimensions: *depolarization* + :Variable\_Type: Optional + :Description: Systamatic error (uncertainty) on reflected to transmitted polarization channel gain correction factor + :Units: -- + :Definition: *double polarization\_gain\_factor\_correction\_systematic\_error(depolarization)* + + +polarization\_gain\_factor\_correction\_start\_datetime + :Type: *double* + :Dimensions: *depolarization* + :Variable\_Type: Optional + :Description: Polarization gain corrrection factor measurement start datetime + :Units: seconds since 1970-01-01T00:00:00Z + :Definition: *double polarization\_gain\_factor\_correction\_start\_datetime(depolarization)* + +polarization\_gain\_factor\_correction\_stop\_datetime + :Type: *double* + :Dimensions: *depolarization* + :Variable\_Type: Optional + :Description: Polarization gain correction factor measurement stop datetime + :Units: seconds since 1970-01-01T00:00:00Z + :Definition: *double polarization\_gain\_factor\_correction\_stop\_datetime(depolarization)* + + + +ELPP Products: global attributes +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Conventions + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: List of the conventions the product is compliant to + + +title + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Product title + +source + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: String describing the source used to generate the product + +references + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Reference(s) for data processing +location + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Measurement site location + +station_ID + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Unique 3 digit code identifying SCC station + +PI + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: PI full name + +PI\_affiliation + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: PI complete affiliation + +PI\_affiliation_acronym + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: PI affiliation acronym + +PI\_address + :Type: *string* + :Global\_Attribute\_Type: Optional + :Description: PI address + +PI\_phone + :Type: *string* + :Global\_Attribute\_Type: Optional + :Description: PI phone number + +PI\_email + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: PI e-mail + +Data\_Originator + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Data originator full name + +Data\_Originator\_affiliation + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Data originator complete affiliation + +Data\_Originator\_affiliation\_acronym + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Data originator affiliation acronym + +Data\_Originator\_address + :Type: *string* + :Global\_Attribute\_Type: Optional + :Description: Data originator complete address + +Data\_Originator\_phone + :Type: *string* + :Global\_Attribute\_Type: Optional + :Description: Data originator phone number + +Data\_Originator\_email + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Data originator e-mail address + +institution + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Istitution the product belong to + +system + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Name of the measuring instrument (lidar) + +hoi\_system\_ID + :Type: *int* + :Global\_Attribute\_Type: Mandatory + :Description: Numeric ID identifying the measuring system in the ACTRIS/EARLINET Handbook Of Instrument (HOI) + +hoi\_configuration\_ID; + :Type: *int* + :Global\_Attribute\_Type: Mandatory + :Description: Numeric ID identifying the configuration of the measuring system in the ACTRIS/EARLINET Handbook Of Instrument (HOI) + +measurement\_ID; + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Alphanumeric identifier for the raw data measurements use to generate the product + +measurement\_start\_datetime + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Measurement start datetime YYYY-mm-ddTHH:MM:SSZ + +measurement\_stop\_datetime + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Measruement stop datetime YYYY-mm-ddTHH:MM:SSZ + +comment + :Type: *string* + :Global\_Attribute\_Type: Optional + :Description: Any product comments + +scc\_version\_description + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Extended SCC version description + +scc\_version + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: SCC version number + +processor\_name + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Name of the processor used to generate the product + +processor\_version + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Version of the processor used to generate the product + +history + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Field describing the history of the product + +\_\_file\_format_version + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Version of the product file format + +data\_processing\_institution + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Instituion responsible for data processing + +input\_file + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Filename of the input data product used to generate the current product
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/file_formats/hirelpp_product_format.rst Fri Mar 19 13:43:18 2021 +0100 @@ -0,0 +1,635 @@ +HiRELPP Products +---------------- + +This section describe the structure of HiRELPP products. + + +HiRELPP Products: dimensions +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The following dimensions are defined in HiRELPP products: + +- time +- level +- channel +- depolarization +- angle +- nv +- nc + +The dimension *time* (mandatory) specifies the number of RCS (for each channel) +composing all the pre-processed time-series reported in the products. + +The dimension *level* (mandatory) represents the number of rangebins characterizing +the pre-processed RCS. + +The dimension *channel* (mandatory) indicates the number channels at which the RCS +time-series included in the product refer to. + +The dimension *depolarization* (optional) indicates how many volume depolarization time-series are included in the products. + +The dimension *angle* (mandatory) takes into account how many zenith scan angles have been used to measure the RCS time-series reported into the products. + +The dimension *nv* (mandatory) is ancillary and it is always set to 2. + +The dimension *nc* (optional) is ancillary and provides the number of channels involved in the calculation of RCS or volume depolarization time-series. + + +HiRELPP Products: variables +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +latitude + :Type: *double* + :Dimensions: -- + :Variable\_Type: Mandatory + :Description: measurement site latitude + :Units: degrees_north + :Definition: *double latitude* + +longitude + :Type: *double* + :Dimensions: -- + :Variable\_Type: Mandatory + :Description: measurement site longitude + :Units: degrees_east + :Definition: *double longitude* + +station\_altitude + :Type: *double* + :Dimensions: -- + :Variable\_Type: Mandatory + :Description: station altitude above see level + :Units: m + :Definition: *double station\_altitude* + +altitude + :Type: *double* + :Dimensions: *time, level* + :Variable\_Type: Mandatory + :Description: altitude above see level + :Units: m + :Definition: *double altitude(time, level)* + +range + :Type: *double* + :Dimensions: *level* + :Variable\_Type: Mandatory + :Description: lidar range scale + :Units: m + :Definition: *double range(level)* + +laser\_pointing\_angle + :Type: *double* + :Dimensions: *angle* + :Variable\_Type: Mandatory + :Description: laser pointing angle with respect to the zenith + :Units: degrees + :Definition: *double laser\_pointing\_angle(angle)* + +laser\_pointing\_angle\_of\_profile + :Type: *int* + :Dimensions: *angle* + :Variable\_Type: Mandatory + :Description: index of scan angle at which each single raw profile has been detected + :Units: -- + :Definition: *int laser\_pointing\_angle\_of\_profile(angle)* + +shots + :Type: *int* + :Dimensions: *time* + :Variable\_Type: Mandatory + :Description: accumulated laser shots + :Units: -- + :Definition: *int shots(time)* + +time + :Type: *double* + :Dimensions: *time* + :Variable\_Type: Mandatory + :Description: seconds since 1970-01-01T00:00:00Z + :Units: -- + :Definition: *double time(time)* + +time\_bounds + :Type: *double* + :Dimensions: *time, nv* + :Variable\_Type: Mandatory + :Description: seconds since 1970-01-01T00:00:00Z + :Units: -- + :Definition: *double time\_bounds(time,nv)* + +scc\_product\_type + :Type: *byte* + :Dimensions: -- + :Variable\_Type: Mandatory + :Description: Bitmask describing the SCC product type + :Units: -- + :Definition: *byte scc\_product\_type* + + + + +range\_corrected\_signal\_channel\_id + :Type: *int* + :Dimensions: *channel, nc* + :Variable\_Type: Optional + :Description: SCC channel ID list involved in the calculation of the range corrected signal total timeseries + :Units: -- + :Definition: *int range\_corrected\_signal\_channel\_id(channel, nc)* + + +range\_corrected\_signal\_channel\_name + :Type: *string* + :Dimensions: *channel* + :Variable\_Type: Mandatory + :Description: Channel name for the range corrected signal timeseries + :Units: -- + :Definition: *string range\_corrected\_signal\_channel\_name(channel)* + + +range\_corrected\_signal\_emission\_wavelength + :Type: *double* + :Dimensions: *channel* + :Variable\_Type: Mandatory + :Description: Emission wavelength used to measure the range corrected signal timeseries + :Units: *nm* + :Definition: *double range\_corrected\_signal\_emission\_wavelength(channel)* + + +range\_corrected\_signal\_detection\_wavelength + :Type: *double* + :Dimensions: *channel* + :Variable\_Type: Mandatory + :Description: Detection wavelength used to measure the range corrected signal timeseries + :Units: *nm* + :Definition: *double range\_corrected\_signal\_detection\_wavelength(channel)* + + +range\_corrected\_signal\_range + :Type: *byte* + :Dimensions: *channel* + :Variable\_Type: Mandatory + :Description: Bitmask to identify range corrected signal range type + :Units: -- + :Definition: *byte range\_corrected\_signal\_range(channel)* + + + + +range\_corrected\_signal\_scatterers + :Type: *byte* + :Dimensions: *channel* + :Variable\_Type: Mandatory + :Description: Bitmask to identify range corrected signal scatterer type + :Units: -- + :Definition: *byte range\_corrected\_signal\_scatterers(channel)* + + + + + +range\_corrected\_signal\_detection\_mode + :Type: *byte* + :Dimensions: *channel* + :Variable\_Type: Mandatory + :Description: Bitmask to identify range corrected signal detection mode + :Units: -- + :Definition: *byte range\_corrected\_signal\_detection\_mode(channel)* + + +near\_range\_glueing\_region\_minimum + :Type: *double* + :Dimensions: *channel, time* + :Variable\_Type: Optional + :Description: Mininum altitude of glueing region for the near range and far range signals + :Units: *m* + :Definition: *double near\_range\_glueing\_region\_minimum(channel, time)* + +near\_range\_glueing\_region\_maximum + :Type: *double* + :Dimensions: *channel, time* + :Variable\_Type: Optional + :Description: Mininum altitude of glueing region for the near range and far range signals + :Units: *m* + :Definition: *double near_range_glueing_region_maximum(channel, time)* + +ultra\_near\_range\_glueing\_region\_minimum + :Type: *double* + :Dimensions: *channel, time* + :Variable\_Type: Optional + :Description: Mininum altitude of glueing region for the ultra near range and near range signals + :Units: *m* + :Definition: *double ultra\_near\_range\_glueing\_region\_minimum(channel, time)* + +ultra\_near\_range\_glueing\_region\_maximum + :Type: *double* + :Dimensions: *channel, time* + :Variable\_Type: Optional + :Description: Maximum altitude of glueing region for the ultra near range and near range signals + :Units: *m* + :Definition: *double ultra\_near_range_glueing_region_maximum(channel, time)* + + +range\_corrected\_signal + :Type: *double* + :Dimensions: *channel, time, level* + :Variable\_Type: Mandatory + :Description: Range corrected signal timeseries + :Units: -- + :Definition: *double range\_corrected\_signal(channel, time, level)* + +range\_corrected\_signal\_statistical\_error + :Type: *double* + :Dimensions: *channel, time, level* + :Variable\_Type: Mandatory + :Description: Statistical error (uncertainty) on range corrected signal timeseries + :Units: -- + :Definition: *double range\_corrected\_signal\_statistical\_error(channel, time, level)* + + +range\_corrected\_signal\_systematic\_error + :Type: *double* + :Dimensions: *channel, time, level* + :Variable\_Type: Optional + :Description: Systematic error (uncertainty) on range corrected signal timeseries + :Units: -- + :Definition: *double range\_corrected\_signal\_statistical\_error(channel, time, level)* + + + +atmospheric\_background + :Type: *double* + :Dimensions: *channel, time* + :Variable\_Type: Mandatory + :Description: Mean uncalibrated atmospheric background calculated from lidar signal + :Units: -- + :Definition: *double atmospheric\_background(channel, time)* + +atmospheric\_background\_stdev + :Type: *double* + :Dimensions: *channel, time* + :Variable\_Type: Mandatory + :Description: Standard deviation of uncalibrated atmospheric background calculated from lidar signal + :Units: -- + :Definition: *double atmospheric\_background\_stdev(channel, time)* + +atmospheric\_background\_sterr + :Type: *double* + :Dimensions: *channel, time* + :Variable\_Type: Mandatory + :Description: Standard error of uncalibrated atmospheric background calculated from lidar signal + :Units: -- + :Definition: *double atmospheric\_background\_sterr(channel, time)* + +atmospheric\_background\_min + :Type: *double* + :Dimensions: *channel, time* + :Variable\_Type: Mandatory + :Description: Minimum uncalibrated atmospheric background calculated from lidar signal + :Units: -- + :Definition: *double atmospheric\_background\_min(channel, time)* + +atmospheric\_background\_max + :Type: *double* + :Dimensions: *channel, time* + :Variable\_Type: Mandatory + :Description: Maximum uncalibrated atmospheric background calculated from lidar signal + :Units: -- + :Definition: *double atmospheric\_background\_max(channel, time)* + +polarization\_gain\_factor\_measurementid + :Type: *string* + :Dimensions: *depolarization* + :Variable\_Type: Optional + :Description: Measurement ID corresponding to the polarization measurements used to calibrate polarization channels + :Units: -- + :Definition: *string polarization\_gain\_factor\_measurementid(depolarization)* + +polarization\_gain\_factor + :Type: *double* + :Dimensions: *depolarization* + :Variable\_Type: Optional + :Description: Reflected to transmitted polarization channel gain factor (eta*) + :Units: -- + :Definition: *double polarization\_gain\_factor(depolarization)* + +polarization\_gain\_factor\_statistical\_error + :Type: *double* + :Dimensions: *depolarization* + :Variable\_Type: Optional + :Description: Statistical error (uncertainty) on reflected to transmitted polarization channel gain factor + :Units: -- + :Definition: *double polarization\_gain\_factor\_statistical\_error(depolarization)* + +polarization\_gain\_factor\_systematic\_error + :Type: *double* + :Dimensions: *depolarization* + :Variable\_Type: Optional + :Description: Systamatic error (uncertainty) on reflected to transmitted polarization channel gain factor + :Units: -- + :Definition: *double polarization\_gain\_factor\_systematic\_error(depolarization)* + + +polarization\_gain\_factor\_start\_datetime + :Type: *double* + :Dimensions: *depolarization* + :Variable\_Type: Optional + :Description: Polarization gain factor measurement start datetime + :Units: seconds since 1970-01-01T00:00:00Z + :Definition: *double polarization\_gain\_factor\_start\_datetime(depolarization)* + +polarization\_gain\_factor\_stop\_datetime + :Type: *double* + :Dimensions: *depolarization* + :Variable\_Type: Optional + :Description: Polarization gain factor measurement stop datetime + :Units: seconds since 1970-01-01T00:00:00Z + :Definition: *double polarization\_gain\_factor\_stop\_datetime(depolarization)* + + +polarization\_gain\_factor\_correction + :Type: *double* + :Dimensions: *depolarization* + :Variable\_Type: Optional + :Description: Reflected to transmitted polarization channel gain correction factor (K) + :Units: -- + :Definition: *double polarization\_gain\_factor\_correction(depolarization)* + +polarization\_gain\_factor\_correction\_statistical\_error + :Type: *double* + :Dimensions: *depolarization* + :Variable\_Type: Optional + :Description: Statistical error (uncertainty) on reflected to transmitted polarization channel gain correction factor + :Units: -- + :Definition: *double polarization\_gain\_factor\_correction\_statistical_error(depolarization)* + +polarization\_gain\_factor\_correction\_systematic\_error + :Type: *double* + :Dimensions: *depolarization* + :Variable\_Type: Optional + :Description: Systamatic error (uncertainty) on reflected to transmitted polarization channel gain correction factor + :Units: -- + :Definition: *double polarization\_gain\_factor\_correction\_systematic\_error(depolarization)* + + +polarization\_gain\_factor\_correction\_start\_datetime + :Type: *double* + :Dimensions: *depolarization* + :Variable\_Type: Optional + :Description: Polarization gain corrrection factor measurement start datetime + :Units: seconds since 1970-01-01T00:00:00Z + :Definition: *double polarization\_gain\_factor\_correction\_start\_datetime(depolarization)* + +polarization\_gain\_factor\_correction\_stop\_datetime + :Type: *double* + :Dimensions: *depolarization* + :Variable\_Type: Optional + :Description: Polarization gain correction factor measurement stop datetime + :Units: seconds since 1970-01-01T00:00:00Z + :Definition: *double polarization\_gain\_factor\_correction\_stop\_datetime(depolarization)* + + +volume\_linear\_depolarization\_ratio\_channel\_id + :Type: *int* + :Dimensions: *depolarization, nc* + :Variable\_Type: Optional + :Description: SCC channel ID list involved in the calculation of the volume linear depolarization ratio timeseries + :Units: -- + :Definition: *int volume\_linear\_depolarization\_ratio\_channel\_id(depolarization, nc)* + + +volume\_linear\_depolarization\_ratio\_channel\_name + :Type: *string* + :Dimensions: *depolarization* + :Variable\_Type: Optional + :Description: Channel name for volume linear depolarization ration timeseries + :Units: -- + :Definition: *string volume\_linear\_depolarization\_ratio\_channel\_name(depolarization)* + + +volume\_linear\_depolarization\_ratio\_wavelength + :Type: *double* + :Dimensions: *depolarization* + :Variable\_Type: Optional + :Description: Wavelength at which the volume linear depolarization ratio is calculated + :Units: *nm* + :Definition: *double volume\_linear\_depolarization\_ratio\_wavelength(depolarization)* + + +volume\_linear\_depolarization\_ratio\_range + :Type: *byte* + :Dimensions: *depolarization* + :Variable\_Type: Optional + :Description: Bitmask field indicating the volume linear depolarization range type + :Units: -- + :Definition: *byte volume\_linear\_depolarization\_ratio\_range(depolarization)* + + + +volume\_linear\_depolarization\_ratio\_scatterers + :Type: *byte* + :Dimensions: *depolarization* + :Variable\_Type: Optional + :Description: Bitmask field indicating the volume linear depolarization scatteter type + :Units: -- + :Definition: *byte volume\_linear\_depolarization\_ratio\_scatterers(depolarization)* + + +volume\_linear\_depolarization\_ratio + :Type: *double* + :Dimensions: *depolarization, time, level* + :Variable\_Type: Optional + :Description: Volume linear depolarization ratio timeseries + :Units: -- + :Definition: *double volume\_linear\_depolarization\_ratio(depolarization, time, level)* + +volume\_linear\_depolarization\_ratio\_statistical\_error + :Type: *double* + :Dimensions: *depolarization, time, level* + :Variable\_Type: Optional + :Description: Statistical error (uncertanity) on volume linear depolarization ratio timeseries + :Units: -- + :Definition: *double volume\_linear\_depolarization\_ratio\_statistical\_error(depolarization, time, level)* + +volume\_linear\_depolarization\_ratio\_systematic\_error + :Type: *double* + :Dimensions: *depolarization, time, level* + :Variable\_Type: Optional + :Description: Systematic error (uncertanity) on volume linear depolarization ratio timeseries + :Units: -- + :Definition: *double volume\_linear\_depolarization\_ratio\_systematic\_error(depolarization, time, level)* + + +HiRELPP Products: global attributes +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Conventions + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: List of the conventions the product is compliant to + + +title + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Product title + +source + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: String describing the source used to generate the product + +references + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Reference(s) for data processing +location + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Measurement site location + +station_ID + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Unique 3 digit code identifying SCC station + +PI + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: PI full name + +PI\_affiliation + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: PI complete affiliation + +PI\_affiliation_acronym + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: PI affiliation acronym + +PI\_address + :Type: *string* + :Global\_Attribute\_Type: Optional + :Description: PI address + +PI\_phone + :Type: *string* + :Global\_Attribute\_Type: Optional + :Description: PI phone number + +PI\_email + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: PI e-mail + +Data\_Originator + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Data originator full name + +Data\_Originator\_affiliation + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Data originator complete affiliation + +Data\_Originator\_affiliation\_acronym + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Data originator affiliation acronym + +Data\_Originator\_address + :Type: *string* + :Global\_Attribute\_Type: Optional + :Description: Data originator complete address + +Data\_Originator\_phone + :Type: *string* + :Global\_Attribute\_Type: Optional + :Description: Data originator phone number + +Data\_Originator\_email + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Data originator e-mail address + +institution + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Istitution the product belong to + +system + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Name of the measuring instrument (lidar) + +hoi\_system\_ID + :Type: *int* + :Global\_Attribute\_Type: Mandatory + :Description: Numeric ID identifying the measuring system in the ACTRIS/EARLINET Handbook Of Instrument (HOI) + +hoi\_configuration\_ID; + :Type: *int* + :Global\_Attribute\_Type: Mandatory + :Description: Numeric ID identifying the configuration of the measuring system in the ACTRIS/EARLINET Handbook Of Instrument (HOI) + +measurement\_ID; + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Alphanumeric identifier for the raw data measurements use to generate the product + +measurement\_start\_datetime + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Measurement start datetime YYYY-mm-ddTHH:MM:SSZ + +measurement\_stop\_datetime + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Measruement stop datetime YYYY-mm-ddTHH:MM:SSZ + +comment + :Type: *string* + :Global\_Attribute\_Type: Optional + :Description: Any product comments + +scc\_version\_description + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Extended SCC version description + +scc\_version + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: SCC version number + +processor\_name + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Name of the processor used to generate the product + +processor\_version + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Version of the processor used to generate the product + +history + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Field describing the history of the product + +\_\_file\_format_version + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Version of the product file format + +data\_processing\_institution + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Instituion responsible for data processing + +input\_file + :Type: *string* + :Global\_Attribute\_Type: Mandatory + :Description: Filename of the input data product used to generate the current product +
--- a/docs/file_formats/low_resolution.rst Wed Mar 10 10:46:27 2021 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,1384 +0,0 @@ -Low Resolution SCC L1 Products -============================== - -.. warning:: - This section is still under development. - - -Introduction ------------- - -The Single Calculus Chain (SCC) is the standard EARLINET tool to perform -automatic and quality nchecked analysis of raw lidar data. It is -composed by three different modules: - -- ELPP (EARLINET Lidar Pre-Processor) -- ELDA (EARLINET Lidar Data Analizer) -- ELDEC (EARLINET Lidar DEpolarization Calibrator) - -Whenever an input file containing raw lidar data has been submitted to -the SCC ELPP is automatically ran on it. The ELPP module pre-processes -the raw data performing all the corrections and data handling needed -before the optical retrieval algorithms can be applied by ELDA module. -The ELPP output files contain pre-processed range corrected signals -corrected for instrumental effects as well as atmospheric molecular -parameters calculated from standard model or radiosounding. Typically, -the vertical and temporal resolutions of the pre-processed signals -included in these files is lower than the raw vertical and temporal -resolution as in general time/vertical integration is performed by ELPP -to increase the SNR and allow the calculation of optical products with a -reduced uncertainties. As a consequence the ELPP output files are called -Low Resolution SCC L1 Products. Another SCC module (HiRELPP – High -Resolution EARLINET Lidar Pre-Processor) currently under development -will produce High Resolution SCC L1 Products in which both time and -vertical resolution are kept as higher as possible. - -This document provides a detailed description about the structure and -the format of Low Resolution SCC L1 Product as produced by the SCC v4.0. - -Low Resolution SCC L1 Product: File format ------------------------------------------- - -The Low Resolution SCC L1 Products are files in Network Common Data Form -(NetCDF) which is a well known self-describing, machine-independent data -format that support the creation, access, and sharing of array-oriented -scientific data. For more information about NetCDF format: -http://www.unidata.ucar.edu/software/netcdf/. - -The NetCDF is a binary format that allows the definition of -multi-dimensional variables of several types (integers, double, -character, etc). For each variable it is possible to define one or more -attributes where to specify variable properties like units, long name, -description, etc. - -It is possible to define global attributes which are not related to a -specific variable but to the whole file. - -A NetCDF file is composed by four different section: - -dimensions - this section contains all the dimensions used in the definition of - all the variables included in the NetCDF file - -variables - this section contains all the variables stored in the NetCDF file. - Each variable is defined as a multi-dimensional array of a specific - type and with all the dimensions defined in the dimensions section - -global attributes - this section lists all the attributes referring to the whole file. As - the variable the attributes (global or the one attached to a specific - variable) can be of different type - -data - in this section the data contained in each variable defined in - variable section is stored. Attribute values (both global or related - to a specific variable) are not reported in data section but directly - in variable or global attribute sections. - -Each Low Resolution SCC L1 Product correspond to a single emission -wavelength. For example it is possible to find in the same file the -elastic and the Raman channel pre-processed time-series corresponding to -the same emission wavelength (but to a different detection wavelengths) -but not two elastic time-series referring to different emission -wavelengths. - -Low Resolution SCC L1 Product Format: dimensions -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The following dimensions are defined in the Low Resolution SCC L1 -Product: - -- time -- points -- channels -- scan\_angles - -The dimension *time* specifies the number of RCS (for each channel) -composing all the pre-processed time-series reported in the file. - -The dimension *points* represents the number of rangebins characterizing -the pre-processed RCS. In case RCSs corresponding to different channels -are characterized by different rangebins the dimension time is to the -the maximum value of rangebins. - -The dimension *channels* indicates the number channels at which the RCS -time-series included in the file refer to. - -The dimension *scan\_angles* takes into account how many zenith scan -angles have been used to measure the RCS time-series reported into the -file - - -Low Resolution SCC L1 Product Format: variables -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -In this section all the possible Low Resolution SCC L1 Product variables -are reported. There are some variables that are mandatory and have to be -present in all the Low Resolution SCC L1 Product files while there are -others that have to be present only in specific cases. - -Technical Variables -################### - -altitude\_resolution - :Type: *double* - :Dimensions: *scan\_angles* - :Location: Included in all the Low Resolution SCC L1 Product files - :Definition: ``double altitude_resolution(scan_angles)`` - - This variable describes the altitude resolution - corresponding to the RCS time-series reported in the file. It is needed - to compute the vertical scale of the RCS corresponding to each scan - angle which should be calculated as it follow: - - .. math:: - - H(\alpha, z)= \Delta h(\alpha)\left(z + \frac{1}{2}\right) - - where *z* is the altitude, :math:`\alpha` is the scan angle value and :math:`\Delta h` is the - value reported by *altitude\_resolution* variable. - -range\_resolution - :Type: *double* - :Dimensions: *scan\_angles* - :Location: Included in all the Low Resolution SCC L1 Product files - :Definition: ``double range_resolution(scan_angles)`` - - This variable describes the range resolution corresponding - to the RCS time-series reported in the file. It is needed to compute the - range scale of the RCS corresponding to each scan angle which should be - calculated as it follow: - - .. math:: - - R(\alpha, z)= \Delta r(\alpha)\left(r + \frac{1}{2}\right) - - where *r* is the range, :math:`\alpha` is the scan angle value and :math:`\Delta r` is the - value reported by *range\_resolution* variable. Altitude and range - resolution are the same if the scan angle is zero (zenith acquisition). - -laser\_pointing\_angle - :Type: *double* - :Dimensions: *scan\_angles* - :Location: Included in all the Low Resolution SCC L1 Product files - :Definition: ``double laser_pointing_angle(scan_angles)`` - - This variable provides the value of the zenith scan angles - used during the measurement. The value of angle are in degrees with - respect to the zenith direction. - -emission\_wavelength - :Type: *double* - :Dimensions: *channels* - :Location: Included in all the Low Resolution SCC L1 Product files - :Definition: ``double emission_wavelength(channels)`` - - This variable provides the value of the emission wavelength - (in nm) corresponding to each RCS time-series. - -detection\_wavelength - :Type: *double* - :Dimensions: *channels* - :Location: Included in all the Low Resolution SCC L1 Product files - :Definition: ``double detection_wavelength(channels)`` - - This variable provides the value of the detection - wavelength (in nm) corresponding to each RCS time-series. For elastic - channels the detection and emission wavelength are the same or slightly - different. - -laser\_pointing\_angle\_of\_profiles - :Type: *integer* - :Dimensions: *time* - :Location: Included in all the Low Resolution SCC L1 Product files - :Definition: ``int laser_pointing_angle_of_profiles(time)`` - - This variable allows to identify the zenith angle at which - each single RCS contained in the time-series refer to. In particular, - for a given time the variable - *laser\_pointing\_angle\_of\_profiles(time)* provides the scan angle - index at which all the RCS included in the file refer to at the same - time. To get the value of the scan angle the variable - *laser\_pointing\_angle* should be evaluated in correspondence of the - index returned by the variable - *laser\_pointing\_angle\_of\_profiles(time)*. - -shots - :Type: *integer* - :Dimensions: *time* - :Location: Included in all the Low Resolution SCC L1 Product files - :Definition: ``int shots(time)`` - - This variable report the number of laser shots that have - been integrated the all the RCS time-series at a given time. - -start\_time - :Type: *integer* - :Dimensions: *time* - :Location: Included in all the Low Resolution SCC L1 Product files - :Definition: ``int start_time(time)`` - - Variable reporting the value of the start time of each RCS - within all the time-series in seconds since the start of measurement. - -stop\_time - :Type: *integer* - :Dimensions: *time* - :Location: Included in all the Low Resolution SCC L1 Product files - :Definition: ``int stop_time(time)`` - - Variables reporting the value of the stop time of each RCS - within all the time-series in seconds since the start of the - measurement. - -LR\_Input - :Type: *integer* - :Dimensions: N/A - :Location: Present only if the Low Resolution SCC L1 Product corresponds - to an elastic only product - :Definition: ``int LR_Input`` - - This variable is only used by ELDA module in the elastic - only retrieval to know which value of particle lidar ratio assume in the - retrieval. A value of 1 means to use a fixed value stored in the SCC - database for each product. A value of 0 means to use a profile of lidar - ratio provided by the user as external file. - -overlap\_correction - :Type: *integer* - :Dimensions: N/A - :Location: Included in all the Low Resolution SCC L1 Product files - :Definition: ``int overlap_correction`` - - This variable provides information on the overlap - correction of all the RCS time-series included in the file. If it is set - to 1 the overlap correction has been applied if it is set to null value - the overlap correction has not been applied. - -cloud\_flag - :Type: *integer* - :Dimensions: *time, points* - :Location: Included in all the Low Resolution SCC L1 Product files - :Definition: ``int cloud_flag(time, points)`` - - variable reporting the cloud mask on the RCS time-series - included in the file. A value of 1 means no cloud any other values - different from 1 correspond to the presence of cloud. - -Atmospheric Molecular Variables -############################### - -Elastic\_Mol\_Extinction - :Type: *double* - :Dimensions: *scan\_angles, points* - :Location: Included in all the Low Resolution SCC L1 Product files - :Definition: *double Elastic\_Mol\_Extinction(scan\_angles, points)* - - This variable provides the value of molecular extinction - coefficient at elastic wavelength in m\ :sup:`-1` at a given scan angle - and altitude (points). The values are calculated from standard models or - from radiosounding (submitted to the SCC as external input files) - -LR\_Mol - :Type: *double* - :Dimensions: N/A - :Location: Included in all the Low Resolution SCC L1 Product files - :Definition: ``double LR_Mol`` - - The value of calculated molecular lidar ratio in sr. - -Emission\_Wave\_Mol\_Trasmissivity - :Type: *double* - :Dimensions: *scan\_angles, points* - :Location: Included in all the Low Resolution SCC L1 Product files - :Definition: ``double Emission_Wave_Mol_Trasmissivity(scan_angles, points)`` - - This variable provides the value of molecular trasmissitivy - at emission wavelength at a given scan angle and altitude (*points*). - -Detection\_Wave\_Mol\_Trasmissivity - :Type: *double* - :Dimensions: *scan\_angles, points* - :Location: Included in all the Low Resolution SCC L1 Product files - :Definition: ``double Detection_Wave_Mol_Trasmissivity(scan_angles, points)`` - - This variable provides the value of molecular trasmissitivy - at detection wavelength at a given scan angle and altitude (*points*). - -Aerosol Related Variables -######################### - -elT - :Type: *double* - :Dimensions: *time, points* - :Location: Present if the Low Resolution SCC L1 Product involves one - single elastic channel not split in near and far range - :Definition: ``double elT(time, points)`` - - This variable contains the time-series of the RCS - corresponding to an elastic channel. The RCS may correspond to a single - physical lidar channel or to two physical channels (one optimized for - the near range and the other for the far range) that have been glued by - ELPP module. - -elT\_err - :Type: *double* - :Dimensions: *time, points* - :Location: Present if the Low Resolution SCC L1 Product involves one - single elastic channel not split in near and far range - :Definition: ``double elT_err(time, points)`` - - This variable describes the statistical uncertainties - corresponding to the variable *elT*. - -elTnr - :Variable name: *elTnr* - :Type: *double* - :Dimensions: *time, points* - :Location: Present if the Low Resolution SCC L1 Product involves a near - range elastic channel - :Definition: ``double elTnr(time, points)`` - - This variable contains the time-series of the RCS - corresponding to a near range elastic channel. If this variable is - present also the corresponding *elTfr* variable should be present in - the file. - -elTnr\_err - :Type: *double* - :Dimensions: * time, points* - :Location: Present if the Low Resolution SCC L1 Product involves a near - range elastic channel - :Definition: ``double elTnr_err(time, points)`` - - This variable describes the statistical uncertainties - corresponding to the variable *elTnr*. - -elTfr - :Type: *double* - :Dimensions: *time, points* - :Location: Present if the Low Resolution SCC L1 Product involves a far - range elastic channel - :Definition: ``double elTfr(time, points)`` - - This variable contains the time-series of the RCS - corresponding to a far range elastic channel. If this variable is - present also the corresponding *elTnr* variable should be present in - the file. - -elTfr\_err - :Type: *double* - :Dimensions: *time, points* - :Location: Present if the Low Resolution SCC L1 Product involves a far - range elastic channel - :Definition: ``double elTfr_err(time, points)`` - - This variable describes the statistical uncertainties - corresponding to the variable *elTfr*. - -vrRN2 - :Type: * double* - :Dimensions: *time, points* - :Location: Present if the Low Resolution SCC L1 Product involves one - vibro-rotational N2 Raman channel not split in near and far range - :Definition: ``double vrRN2(time, points)`` - - This variable contains the time-series of the RCS - corresponding to a vibro-rotational N2 Raman channel. The RCS may - correspond to a single physical lidar channel or to two physical - channels (one optimized for the near range and the other for the far - range) that have been glued by ELPP module. - -vrRN2\_err - :Type: *double* - :Dimensions: *time, points* - :Location: Present if the Low Resolution SCC L1 Product involves one - vibro-rotational N2 Raman channel not split in near and far range - :Definition: ``double vrRN2_err(time, points)`` - - This variable describes the statistical uncertainties - corresponding to the variable *vrRN2*. - -vrRN2nr - :Type: *double* - :Dimensions: *time, points* - :Location: Present if the Low Resolution SCC L1 Product involves a near - range vibro-rotational N2 Raman channel - :Definition: ``double vrRN2nr(time, points)`` - - This variable contains the time-series of the RCS - corresponding to a near range vibro-rotationl N2 Raman. If this variable - is present also the corresponding *vrRN2fr* variable should be present - in the file. - -vrRN2nr\_err - :Type: *double* - :Dimensions: *time, points* - :Location: Present if the Low Resolution SCC L1 Product involves a near - range vibro-rotational N2 Raman channel - :Definition: ``double vrRN2nr_err(time, points)`` - - This variable describes the statistical uncertainties - corresponding to the variable *vrRN2nr*. - -vrRN2fr - :Type: *double* - :Dimensions: *time, points* - :Location: Present if the Low Resolution SCC L1 Product involves a far - range vibro-rotational N2 Raman channel - :Definition: ``double vrRN2fr(time, points)`` - - This variable contains the time-series of the RCS - corresponding to a far range vibro-rotationl N2 Raman. If this variable - is present also the corresponding *vrRN2nr* variable should be present - in the file. - -vrRN2fr\_err - :Type: *double* - :Dimensions: * time, points* - :Location: Present if the Low Resolution SCC L1 Product involves a far - range vibro-rotational N2 Raman channel - :Definition: ``double vrRN2fr_err(time, points)`` - - This variable describes the statistical uncertainties - corresponding to the variable *vrRN2fr*. - -Polarization related variables -############################## - -elPT - :Type: *double* - :Dimensions: *time, points* - :Location: Present if the Low Resolution SCC L1 Product involves - polarization sensitive elastic channels not split in near and far range - :Definition: ``double elPT(time, points)`` - - This variable contains the time-series of the RCS - corresponding to the elastic polarization component which is transmitted - by the polarization sensitive optical subsystem. This component may - correspond to a total, cross or parallel polarization component - depending on the particular system configuration. Moreover the RCS may - correspond to a single physical lidar channel or to two physical - channels (one optimized for the near range and the other for the far - range) that have been glued by ELPP module. - -elPT\_err - :Type: *double* - :Dimensions: *time, points* - :Location: Present if the Low Resolution SCC L1 Product involves - spolarization sensitive elastic channels not split in near and far range - :Definition: ``double elPT_err(time, points)`` - - This variable describes the statistical uncertainties - corresponding to the variable *elPT*. - -elPTnr - :Type: *double* - :Dimensions: * time, points* - :Location: Present if the Low Resolution SCC L1 Product involves near - range polarization sensitive elastic channels - :Definition: ``double elPTnr(time, points)`` - - This variable contains the time-series of the RCS - corresponding to the near range elastic polarization component which is - transmitted by the polarization sensitive optical subsystem. This - component may correspond to a total, cross or parallel polarization - component depending on the particular system configuration. If this - variable is present also the corresponding *elPTfr* variable should be - present in the file. - -elPTnr\_err - :Type: *double* - :Dimensions: * time, points* - :Location: Present if the Low Resolution SCC L1 Product involves near - range polarization sensitive elastic channels - :Definition: ``double elPTnr_err(time, points)`` - - This variable describes the statistical uncertainties - corresponding to the variable *elPTnr*. - -elPTfr - :Type: *double* - :Dimensions: *time, points* - :Location: Present if the Low Resolution SCC L1 Product involves far - range polarization sensitive elastic channels - :Definition: ``double elTfr(time, points)`` - - This variable contains the time-series of the RCS - corresponding to the far range elastic polarization component which is - transmitted by the polarization sensitive optical subsystem. This - component may correspond to a total, cross or parallel polarization - component depending on the particular system configuration. If this - variable is present also the corresponding elPTnr variable should be - present in the file. - -elPTfr\_err - :Type: *double* - :Dimensions: * time, points* - :Location: Present if the Low Resolution SCC L1 Product involves far - range polarization sensitive elastic channels - :Definition: ``double elPTfr_err(time, points)`` - - This variable describes the statistical uncertainties - corresponding to the variable *elPTfr*. - -elPR - :Type: *double* - :Dimensions: *time, points* - :Location: Present if the Low Resolution SCC L1 Product involves - polarization sensitive elastic channels not split in near and far range - :Definition: ``double elPR(time, points)`` - - This variable contains the time-series of the RCS - corresponding to the elastic polarization component which is reflected - by the polarization sensitive optical subsystem. This component may - correspond to a total, cross or parallel polarization component - depending on the particular system configuration. Moreover the RCS may - correspond to a single physical lidar channel or to two physical - channels (one optimized for the near range and the other for the far - range) that have been glued by ELPP module. - -elPR\_err - :Type: *double* - :Dimensions: * time, points* - :Location: Present if the Low Resolution SCC L1 Product involves - polarization sensitive elastic channels not split in near and far range - :Definition: ``double elPR_err(time, points)`` - - This variable describes the statistical uncertainties - corresponding to the variable *elPR*. - -elPRnr - :Type: *double* - :Dimensions: * time, points* - :Location: Present if the Low Resolution SCC L1 Product involves near - range polarization sensitive elastic channels - :Definition: ``double elPTnr(time, points)`` - - This variable contains the time-series of the RCS - corresponding to the near range elastic polarization component which is - reflected by the polarization sensitive optical subsystem. This - component may correspond to a total, cross or parallel polarization - component depending on the particular system configuration. If this - variable is present also the corresponding *elPRfr* variable should be - present in the file. - -elPRnr\_err - :Type: *double* - :Dimensions: *time, points* - :Location: Present if the Low Resolution SCC L1 Product involves near - range polarization sensitive elastic channels - :Definition: `` double elPRnr_err(time, points)`` - - This variable describes the statistical uncertainties - corresponding to the variable *elPRnr*. - -elPRfr - :Type: *double* - :Dimensions: *time, points* - :Location: Present if the Low Resolution SCC L1 Product involves far - range polarization sensitive elastic channels - :Definition: ``double elPRfr(time, points)`` - - This variable contains the time-series of the RCS - corresponding to the far range elastic polarization component which is - reflected by the polarization sensitive optical subsystem. This - component may correspond to a total, cross or parallel polarization - component depending on the particular system configuration. If this - variable is present also the corresponding *elPRnr* variable should be - present in the file. - -elPRfr\_err - :Type: *double* - :Dimensions: *time, points* - :Location: Present if the Low Resolution SCC L1 Product involves far - range polarization sensitive elastic channels - :Definition: ``double elPRfr_err(time, points)`` - - This variable describes the statistical uncertainties - corresponding to the variable *elPRfr*. - -G\_T - :Type: *double* - :Dimensions: N/A - :Location: Present if the Low Resolution SCC L1 Product involves - polarization sensitive elastic channels - :Definition: ``double G_T`` - - G polarization cross-talk factor value corresponding to the - polarization transmitted channel. - -G\_T\_Statistical\_Err - :Type: *double* - :Dimensions: N/A - :Location: Present if the Low Resolution SCC L1 Product involves - polarization sensitive elastic channels - :Definition: ``double G_T_Statistical_Err`` - - This variable describes the statistical uncertainties - corresponding to the variable *G\_T*. - -G\_T\_Systematic\_Err - :Type: *double* - :Dimensions: N/A - :Location: Present if the Low Resolution SCC L1 Product involves - polarization sensitive elastic channels - :Definition: ``double G_T_Systematic_Err`` - - This variable describes the systematic uncertainties - corresponding to the variable *G\_T*. - -H\_T - :Type: *double* - :Dimensions: N/A - :Location: Present if the Low Resolution SCC L1 Product involves - polarization sensitive elastic channels - :Definition: ``double H_T`` - - H polarization cross-talk factor value corresponding to the - polarization transmitted channel. - -H\_T\_Statistical\_Err - :Type: *double* - :Dimensions: N/A - :Location: Present if the Low Resolution SCC L1 Product involves - polarization sensitive elastic channels - :Definition: ``double H_T_Statistical_Err`` - - This variable describes the statistical uncertainties - corresponding to the variable *H\_T*. - -H\_T\_Systematic\_Err - :Type: *double* - :Dimensions: N/A - :Location: Present if the Low Resolution SCC L1 Product involves - polarization sensitive elastic channels - :Definition: ``double H_T_Systematic_Err`` - - This variable describes the systematic uncertainties - corresponding to the variable *H\_T*. - -G\_R - :Type: *double* - :Dimensions: N/A - :Location: Present if the Low Resolution SCC L1 Product involves - polarization sensitive elastic channels - :Definition: ``double G_R`` - - G polarization cross-talk factor value corresponding to the - polarization reflected channel. - -G\_R\_Statistical\_Err - :Type: *double* - :Dimensions: N/A - :Location: Present if the Low Resolution SCC L1 Product involves - polarization sensitive elastic channels - :Definition: ``double G_R_Statistical_Err`` - - This variable describes the statistical uncertainties - corresponding to the variable *G\_R*. - -G\_R\_Systematic\_Err - :Type: *double* - :Dimensions: N/A - :Location: Present if the Low Resolution SCC L1 Product involves - polarization sensitive elastic channels - :Definition: `` double G_R_Systematic_Err`` - - This variable describes the systematic uncertainties - corresponding to the variable *G\_R*. - -H\_R - :Type: *double* - :Dimensions: N/A - :Location: Present if the Low Resolution SCC L1 Product involves - polarization sensitive elastic channels - :Definition: ``double H_R`` - - H polarization cross-talk factor value corresponding to the - polarization reflected channel. - -H\_R\_Statistical\_Err - :Type: *double* - :Dimensions: N/A - :Location: Present if the Low Resolution SCC L1 Product involves - polarization sensitive elastic channels - :Definition: ``double H_R_Statistical_Err`` - - This variable describes the statistical uncertainties - corresponding to the variable *H\_R*. - -H\_R\_Systematic\_Err - :Type: *double* - :Dimensions: N/A - :Location: Present if the Low Resolution SCC L1 Product involves - polarization sensitive elastic channels - :Definition: ``double H_R_Systematic_Err`` - - This variable describes the systematic uncertainties - corresponding to the variable *H\_R*. - -Polarization\_Channel\_Gain\_Factor - :Type: *double* - :Dimensions: N/A - :Location: Present if the Low Resolution SCC L1 Product involves - polarization sensitive elastic channels - :Definition: ``double Polarization_Channel_Gain_Factor`` - - This variable reports the value of the gain ratio of the - reflected and transmitted polarization channels. - -Polarization\_Channel\_Gain\_Factor\_Statistical\_Err - :Type: *double* - :Dimensions: N/A - :Location: Present if the Low Resolution SCC L1 Product involves - polarization sensitive elastic channels - :Definition: ``double Polarization_Channel_Gain_Factor_Statistical_Err`` - - This variable describes the statistical uncertainties - corresponding to the variable *Polarization\_Channel\_Gain\_Factor*. - -Polarization\_Channel\_Gain\_Factor\_Systematic\_Err - :Type: *double* - :Dimensions: N/A - :Location: Present if the Low Resolution SCC L1 Product involves - polarization sensitive elastic channels - :Definition: ``double Polarization_Channel_Gain_Factor_Systematic_Err`` - - This variable describes the systematic uncertainties - corresponding to the variable *Polarization\_Channel\_Gain\_Factor*. - -Polarization\_Channel\_Gain\_Factor\_Correction - :Type: *double* - :Dimensions: N/A - :Location: Present if the Low Resolution SCC L1 Product involves - polarization sensitive elastic channels - :Definition: ``double Polarization_Channel_Gain_Factor_Correction`` - - This variable reports the value of the correction to the - gain ratio of the reflected and transmitted polarization channels. - -Polarization\_Channel\_Gain\_Factor\_Correction\_Statistical\_Err - :Type: *double* - :Dimensions: N/A - :Location: Present if the Low Resolution SCC L1 Product involves - polarization sensitive elastic channels - :Definition: ``double Polarization_Channel_Gain_Factor_Correction_Statistical_Err`` - - This variable describes the statistical uncertainties - corresponding to the variable - -Polarization\_Channel\_Gain\_Factor\_Correction - -Polarization\_Channel\_Gain\_Factor\_Correction\_Systematic\_Err - :Type: *double* - :Dimensions: N/A - :Location: Present if the Low Resolution SCC L1 Product involves - polarization sensitive elastic channels - :Definition: ``double Polarization_Channel_Gain_Factor_Correction_Systematic_Err`` - - This variable describes the systematic uncertainties - corresponding to the variable *Polarization\_Channel\_Gain\_Factor\_Correction*. - -G\_T\_Near\_Range - :Type: *double* - :Dimensions: N/A - :Location: Present if the Low Resolution SCC L1 Product involves near - range polarization sensitive elastic channels - :Definition: ``double G_T_Near_Range`` - - G polarization cross-talk factor value corresponding to the - near range polarization transmitted channel. - -G\_T\_Near\_Range\_Statistical\_Err - :Type: *double* - :Dimensions: N/A - :Location: Present if the Low Resolution SCC L1 Product involves near - range polarization sensitive elastic channels - :Definition: ``double G_T_Near_Range_Statistical_Err`` - - This variable describes the statistical uncertainties - corresponding to the variable *G\_T\_Near\_Range*. - -G\_T\_Near\_Range\_Systematic\_Err - :Type: *double* - :Dimensions: N/A - :Location: Present if the Low Resolution SCC L1 Product involves near - range polarization sensitive elastic channels - :Definition: ``double G_T_Near_Range_Systematic_Err`` - - This variable describes the systematic uncertainties - corresponding to the variable *G\_T\_Near\_Range*. - -H\_T\_Near\_Range - :Type: *double* - :Dimensions: N/A - :Location: Present if the Low Resolution SCC L1 Product involves near - range polarization sensitive elastic channels - :Definition: ``double H_T_Near_Range`` - - H polarization cross-talk factor value corresponding to the - near range polarization transmitted channel. - -H\_T\_Near\_Range\_Statistical\_Err - :Type: *double* - :Dimensions: N/A - :Location: Present if the Low Resolution SCC L1 Product involves near - range polarization sensitive elastic channels - :Definition: ``double H_T_Near_Range_Statistical_Err`` - - This variable describes the statistical uncertainties - corresponding to the variable *H\_T\_Near\_Range*. - -H\_T\_Near\_Range\_Systematic\_Err - :Type: *double* - :Dimensions: N/A - :Location: Present if the Low Resolution SCC L1 Product involves near - range polarization sensitive elastic channels - :Definition: ``double H_T_Near_Range_Systematic_Err`` - - This variable describes the systematic uncertainties - corresponding to the variable *H\_T\_Near\_Range*. - -G\_R\_Near\_Range - :Type: *double* - :Dimensions: N/A - :Location: Present if the Low Resolution SCC L1 Product involves near - range polarization sensitive elastic channels - :Definition: ``double G_R_Near_Range`` - - G polarization cross-talk factor value corresponding to the - near range polarization reflected channel. - -G\_R\_Near\_Range\_Statistical\_Err - :Type: *double* - :Dimensions: N/A - :Location: Present if the Low Resolution SCC L1 Product involves near - range polarization sensitive elastic channels - :Definition: ``double G_R_Near_Range_Statistical_Err`` - - This variable describes the statistical uncertainties - corresponding to the variable *G\_R\_Near\_Range*. - -G\_R\_Near\_Range\_Systematic\_Err - :Type: *double* - :Dimensions: N/A - :Location: Present if the Low Resolution SCC L1 Product involves near - range polarization sensitive elastic channels - :Definition: ``double G_R_Near_Range_Systematic_Err`` - - This variable describes the systematic uncertainties - corresponding to the variable *G\_R\_Near\_Range*. - -H\_R\_Near\_Range - :Type: *double* - :Dimensions: N/A - :Location: Present if the Low Resolution SCC L1 Product involves near - range polarization sensitive elastic channels - :Definition: ``double H_R_Near_Range`` - - H polarization cross-talk factor value corresponding to the - near range polarization reflected channel. - -H\_R\_Near\_Range\_Statistical\_Err - :Type: *double* - :Dimensions: N/A - :Location: Present if the Low Resolution SCC L1 Product involves near - range polarization sensitive elastic channels - :Definition: ``double H_R_Near_Range_Statistical_Err`` - - This variable describes the statistical uncertainties - corresponding to the variable *H\_R\_Near\_Range*. - -H\_R\_Near\_Range\_Systematic\_Err - :Type: *double* - :Dimensions: N/A - :Location: Present if the Low Resolution SCC L1 Product involves near - range polarization sensitive elastic channels - :Definition: ``double H_R_Near_Range_Systematic_Err`` - - This variable describes the systematic uncertainties - corresponding to the variable *H\_R\_Near\_Range*. - -Polarization\_Channel\_Gain\_Factor\_Near\_Range - :Type: *double* - :Dimensions: N/A - :Location: Present if the Low Resolution SCC L1 Product involves near - range polarization sensitive elastic channels - :Definition: ``double Polarization_Channel_Gain_Factor_Near_Range`` - - This variable reports the value of the gain ratio of the - near range reflected and transmitted polarization channels. - -Polarization\_Channel\_Gain\_Factor\_Near\_Range\_Statistical\_Err - :Type: *double* - :Dimensions: N/A - :Location: Present if the Low Resolution SCC L1 Product involves near - range polarization sensitive elastic channels - :Definition: ``double Polarization_Channel_Gain_Factor_Near_Range_Statistical_Err`` - - This variable describes the statistical uncertainties - corresponding to the variable *Polarization\_Channel\_Gain\_Near\_Range\_Factor*. - -Polarization\_Channel\_Gain\_Factor\_Near\_Range\_Systematic\_Err - :Type: *double* - :Dimensions: N/A - :Location: Present if the Low Resolution SCC L1 Product involves near - range polarization sensitive elastic channels - :Definition: ``double Polarization_Channel_Gain_Factor_Near_Range_Systematic_Err`` - - This variable describes the systematic uncertainties - corresponding to the variable *Polarization\_Channel\_Gain\_Factor\_Near\_Range*. - -Polarization\_Channel\_Gain\_Factor\_Correction\_Near\_Range - :Type: *double* - :Dimensions: N/A - :Location: Present if the Low Resolution SCC L1 Product involves near - range polarization sensitive elastic channels - :Definition: ``double Polarization_Channel_Gain_Factor_Correction_Near_Range`` - - This variable reports the value of the correction to the - near range gain ratio of the reflected and transmitted polarization - channels. - -Polarization\_Channel\_Gain\_Factor\_Correction\_Near\_Range\_Statistical\_Err - :Type: *double* - :Dimensions: N/A - :Location: Present if the Low Resolution SCC L1 Product involves near - range polarization sensitive elastic channels - :Definition: ``double Polarization_Channel_Gain_Factor_Correction_Near_Range_Statistical_Err`` - - This variable describes the statistical uncertainties - corresponding to the variable Polarization\_Channel\_Gain\_Factor\_Correction\_Near\_Range - -Polarization\_Channel\_Gain\_Factor\_Correction\_Near\_Range\_Systematic\_Err - :Type: *double* - :Dimensions: N/A - :Location: Present if the Low Resolution SCC L1 Product involves near - range polarization sensitive elastic channels - :Definition: ``double Polarization_Channel_Gain_Factor_Correction_Near_Range_Systematic_Err`` - - This variable describes the systematic uncertainties - corresponding to the variable *Polarization\_Channel\_Gain\_Factor\_Correction\_Near\_Range*. - -G\_T\_Far\_Range - :Type: *double* - :Dimensions: N/A - :Location: Present if the Low Resolution SCC L1 Product involves far - range polarization sensitive elastic channels - :Definition: ``double G_T_Far_Range`` - - G polarization cross-talk factor value corresponding to the - far range polarization transmitted channel. - -G\_T\_Far\_Range\_Statistical\_Err - :Type: *double* - :Dimensions: N/A - :Location: Present if the Low Resolution SCC L1 Product involves far - range polarization sensitive elastic channels - :Definition: ``double G_T_Far_Range_Statistical_Err`` - - This variable describes the statistical uncertainties - corresponding to the variable *G\_T\_Far\_Range*. - -G\_T\_Far\_Range\_Systematic\_Err - :Type: *double* - :Dimensions: N/A - :Location: Present if the Low Resolution SCC L1 Product involves far - range polarization sensitive elastic channels - :Definition: ``double G_T_Far_Range_Systematic_Err`` - - This variable describes the systematic uncertainties - corresponding to the variable *G\_T\_Far\_Range*. - -H\_T\_Far\_Range - :Type: *double* - :Dimensions: N/A - :Location: Present if the Low Resolution SCC L1 Product involves far - range polarization sensitive elastic channels - :Definition: ``double H_T_Far_Range`` - - H polarization cross-talk factor value corresponding to the - far range polarization transmitted channel. - -H\_T\_Far\_Range\_Statistical\_Err - :Type: *double* - :Dimensions: N/A - :Location: Present if the Low Resolution SCC L1 Product involves far - range polarization sensitive elastic channels - :Definition: ``double H_T_Far_Range_Statistical_Err`` - - This variable describes the statistical uncertainties - corresponding to the variable *H\_T\_Far\_Range*. - -H\_T\_Far\_Range\_Systematic\_Err - :Type: *double* - :Dimensions: N/A - :Location: Present if the Low Resolution SCC L1 Product involves far - range polarization sensitive elastic channels - :Definition: ``double H_T_Far_Range_Systematic_Err`` - - This variable describes the systematic uncertainties - corresponding to the variable *H\_T\_Far\_Range*. - -G\_R\_Far\_Range - :Type: *double* - :Dimensions: N/A - :Location: Present if the Low Resolution SCC L1 Product involves far - range polarization sensitive elastic channels - :Definition: ``double G_R_Far_Range`` - - G polarization cross-talk factor value corresponding to the - far range polarization reflected channel. - -G\_R\_Far\_Range\_Statistical\_Err - :Type: *double* - :Dimensions: N/A - :Location: Present if the Low Resolution SCC L1 Product involves far - range polarization sensitive elastic channels - :Definition: ``double G_R_Far_Range_Statistical_Err`` - - This variable describes the statistical uncertainties - corresponding to the variable *G\_R\_Far\_Range*. - -G\_R\_Far\_Range\_Systematic\_Err - :Type: *double* - :Dimensions: N/A - :Location: Present if the Low Resolution SCC L1 Product involves far - range polarization sensitive elastic channels - :Definition: ``double G_R_Far_Range_Systematic_Err`` - - This variable describes the systematic uncertainties - corresponding to the variable *G\_R\_Far\_Range*. - -H\_R\_Far\_Range - :Type: *double* - :Dimensions: N/A - :Location: Present if the Low Resolution SCC L1 Product involves far - range polarization sensitive elastic channels - :Definition: ``double H_R_Far_Range`` - - H polarization cross-talk factor value corresponding to the - far range polarization reflected channel. - -H\_R\_Far\_Range\_Statistical\_Err - :Type: *double* - :Dimensions: N/A - :Location: Present if the Low Resolution SCC L1 Product involves far - range polarization sensitive elastic channels - :Definition: ``double H_R_Far_Range_Statistical_Err`` - - This variable describes the statistical uncertainties - corresponding to the variable *H\_R\_Far\_Range*. - -H\_R\_Far\_Range\_Systematic\_Err - :Type: *double* - :Dimensions: N/A - :Location: Present if the Low Resolution SCC L1 Product involves far - range polarization sensitive elastic channels - :Definition: ``double H_R_Far_Range_Systematic_Err`` - - This variable describes the systematic uncertainties - corresponding to the variable *H\_R\_Far\_Range*. - -Polarization\_Channel\_Gain\_Factor\_Far\_Range - :Type: *double* - :Dimensions: N/A - :Location: Present if the Low Resolution SCC L1 Product involves far - range polarization sensitive elastic channels - :Definition: ``double Polarization_Channel_Gain_Factor_Far_Range`` - - This variable reports the value of the gain ratio of the - far range reflected and transmitted polarization channels. - -Polarization\_Channel\_Gain\_Factor\_Far\_Range\_Statistical\_Err - :Type: *double* - :Dimensions: N/A - :Location: Present if the Low Resolution SCC L1 Product involves far - range polarization sensitive elastic channels - :Definition: ``double Polarization_Channel_Gain_Factor_Far_Range_Statistical_Err`` - - This variable describes the statistical uncertainties - corresponding to the variable - *Polarization\_Channel\_Gain\_Far\_Range\_Factor*. - -Polarization\_Channel\_Gain\_Factor\_Far\_Range\_Systematic\_Err - :Type: *double* - :Dimensions: N/A - :Location: Present if the Low Resolution SCC L1 Product involves far - range polarization sensitive elastic channels - :Definition: ``double Polarization_Channel_Gain_Factor_Far_Range_Systematic_Err`` - - This variable describes the systematic uncertainties - corresponding to the variable *Polarization\_Channel\_Gain\_Factor\_Far\_Range*. - -Polarization\_Channel\_Gain\_Factor\_Correction\_Far\_Range - :Type: *double* - :Dimensions: N/A - :Location: Present if the Low Resolution SCC L1 Product involves far - range polarization sensitive elastic channels - :Definition: ``double Polarization_Channel_Gain_Factor_Correction_Far_Range`` - - This variable reports the value of the correction to the - far range gain ratio of the reflected and transmitted polarization - channels. - -Polarization\_Channel\_Gain\_Factor\_Correction\_Far\_Range\_Statistical\_Err - :Type: *double* - :Dimensions: N/A - :Location: Present if the Low Resolution SCC L1 Product involves far - range polarization sensitive elastic channels - :Definition: ``double Polarization_Channel_Gain_Factor_Correction_Far_Range_Statistical_Err`` - - This variable describes the statistical uncertainties - corresponding to the variable *Polarization\_Channel\_Gain\_Factor\_Correction\_Far\_Range*. - -Polarization\_Channel\_Gain\_Factor\_Correction\_Far\_Range\_Systematic\_Err - :Type: *double* - :Dimensions: N/A - :Location: Present if the Low Resolution SCC L1 Product involves far - range polarization sensitive elastic channels - :Definition: ``double Polarization_Channel_Gain_Factor_Correction_Far_Range_Systematic_Err`` - - This variable describes the systematic uncertainties - corresponding to the variable - *Polarization\_Channel\_Gain\_Factor\_Correction\_Far\_Range*. - -Depolarization\_Calibration\_Type - :Type: *integer* - :Dimensions: N/A - :Location: Present if the Low Resolution SCC L1 Product involves - polarization sensitive elastic channels - :Definition: ``int Depolarization_Calibration_Type`` - - This variable describes the type of depolarization - calibration that has been performed. A value of 1 means automatic - calibration made the the SCC, a value of 2 means manual calibration - inserted into the SCC database. - -Molecular\_Linear\_Depolarization\_Ratio - :Type: *double* - :Dimensions: *scan\_angles,points* - :Location: Present if the Low Resolution SCC L1 Product involves - polarization sensitive elastic channels - :Definition: ``double Molecular_Linear_Depolarization_Ratio(scan_angles, points)`` - - This variable report the value of molecular linear - depolarization ration for at given scan angles and at given altitude - (*points*). This profile is calculated on the base of the atmospheric - data from standard models or radiosonding submitted by the user as - separate file. - -The altitude scale at which each RCS within the time-series reported by -the variables *elT, elTnr, elTfr, vrRN2, vrRN2nr, vrRN2fr, elPT, elPTnr, -elPTfr, elPR, elPRnr, elPRfr*, refer to can be obtained as:: - - H(laser_pointing_angle_of_profiles(time),points) - -The total signal (:math:`I_{total}`) and the volume depolarization -ratio (:math:`\delta`) can be calculated out of reflected (:math:`I_{R}`) and -transmitted (:math:`I_{T}`) polarization component intensities using -the following equations: - -.. math:: - - \delta^{*} = \frac{K}{\eta^{*}}\frac{I_R}{I_T} - -.. math:: - - \delta = \frac{\delta^{*} (G_T + H_T) - (G_R + H_R)}{(G_R - H_R) - \delta_{*}(G_T - H_T)} - -.. math:: - - I_{total} \propto \frac{\eta^{*}}{K} H_R I_T - H_T I_R - -where :math:`\eta^{*}` is the gain ratio of the reflected and transmitted -polarization channels (variable *Polarization\_Channel\_Gain\_Factor*); -:math:`K` is the correction to the gain ratio of the reflected and transmitted -polarization channels (variable *Polarization\_Channel\_Gain\_Factor\_Correction*); -:math:`I_{R}` is the intensity of the reflected polarization component (variable *elPR*); -:math:`I_{T}` is the intensity of the transmitted polarization -component (variable *elPT*); and :math:`G_{T}`, :math:`H_{T}`, -:math:`G_{R}`, and :math:`H_{R}` are the polarization cross-talk -parameters (variables *G\_T*, *H\_T*, *G\_R*, and *H\_R*). - -Low Resolution SCC L1 Product Format: global attributes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -In this section all the possible Low Resolution SCC L1 Product global -attributes are reported. There are some global attributes that are -mandatory and have to be present in all the Low Resolution SCC L1 -Product files while there are others that have to be present only in -specific cases. - -Location - :Type: *string* - :Location: Included in all the Low Resolution SCC L1 Product files - - The name of site where the measurements have been performed - -System - :Type: *string* - :Location: Included in all the Low Resolution SCC L1 Product files - - The name of the lidar system used to perform the - measurements - -Latitude\_degrees\_north - :Type: *double* - :Location: Included in all the Low Resolution SCC L1 Product files - - The latitude (in degrees North) of the measurement site - -Longitude\_degrees\_east - :Type: *double* - :Location: Included in all the Low Resolution SCC L1 Product files - - The longitude (in degrees East) of the measurement site - -Altitude\_meter\_asl - :Type: *double* - :Location: Included in all the Low Resolution SCC L1 Product files - - The altitude (in m above see level) of the measurement site - -Measurement\_ID - :Type: *string* - :Location: Included in all the Low Resolution SCC L1 Product files - - Within the SCC all the measurement sessions is identified - by a string called *Measurement\_ID* uniquely. This gobal attributes - provides this string. - -Measurement\_Start\_Date - :Type: *string* - :Location: Included in all the Low Resolution SCC L1 Product files - - The start date of the measurements. The format in which - this date is written is specified in the gobal attribute - *Measurement\_Date\_Format*. - -Measurement\_Date\_Format - :Type: *string* - :Location: Included in all the Low Resolution SCC L1 Product files - - The format in which the global attribute - *Measurement\_Start\_Date* is given. - -Measurement\_Start\_Time\_UT - :Type: *string* - :Location: Included in all the Low Resolution SCC L1 Product files - - The start time (UT) of the measurements. The format in - which this time is written is specified in the global attribute - *Measurement\_Time\_Format*. - -Measurement\_Time\_Format - :Type: *string* - :Location: Included in all the Low Resolution SCC L1 Product files - - The format in which the global attribute - *Measurement\_Start\_Time\_U*\ T is given. - -Comments - :Type: *string* - :Location: Included in all the Low Resolution SCC L1 Product files - - This string can contain comments of the measurement session - -Overlap\_File\_Name - :Type: *string* - :Location: Included in all the Low Resolution SCC L1 Product files for - which an overlap file has been submitted by the data originator. - - The name of the overlap file to use for overlap correction. - -LR\_File\_Name - :Type: *string* - :Location: Included in all the Low Resolution SCC L1 Product files - corresponding to elastic only retrieval and for which an lidar ratio - profile file has been submitted by the data originator. - - The name of the lidar ratio file containing the profile of - particle lidar ratio values to use as input in the elastic only - retrieval. - -SCCPreprocessingVersion - :Type: *string* - :Location: Included in all the Low Resolution SCC L1 Product files - - The version of SCC used to produce the current Low - Resolution SCC L1 Product - -Low Resolution SCC L1 Product Filename --------------------------------------- - -The filename of the Low Resolution SCC L1 Products has the following -format:: - - measurementid_prodid.nc - -The *measurementid* is a 12 characters alphanumeric string identifying -the measurement session at which the product refers to. The -*measurementid* (which is unique for a given measurement session) allows -to fully trance the SCC analysis performed on the current product. This -can be done because each measurement session is recorded in a SCC -database using the same string. In the same database the measurement -session is linked to the lidar configuration used to analyze the data -(which is recorded and fully characterized in the SCC database providing -all the channel details) and to a set of optical products to calculate. - -The *prodid* is a numeric string identifying the optical product that -has to be calculated by SCC (in particular ELDA module) by applying the -optical retrieval algorithm on the current pre-processed L1 product. - -Different product types are defined within the SCC. The contents of a -Low Resolution SCC L1 product depends on the type of the product -specified in the its filename by prodid string. In particular only the -**Aerosol Related Variables **\ and\ ** Polarization related variables** -specified in the section 2.2 can change depending on product type. In -Tab. 3.1 are reported the product-type related variables for each -optical product type. - -To link the *prodid* string with the corresponding product type the SCC -database a proper query to the SCC database should be addressed. - -**Table 3.1:** Possible variables that can be found in the SCC L1 -Products for each optical product type - -+--------------------------------------------------------------+---------------------------------------------------+ -| Product type | Possible variables in Low Resolution L1 Product | -+--------------------------------------------------------------+---------------------------------------------------+ -| Extinction only | vrRN2, vrRN2nr, vrRN2fr | -| | | -| | vrRN2\_err, vrRN2nr\_err, vrRN2fr\_err | -+--------------------------------------------------------------+---------------------------------------------------+ -| Elastic Backscatter | elT, elTnr, elTfr | -| | | -| Elastic Backscatter + Particle Linear Depolarization Ratio | elT\_err, elTnr\_err, elTfr\_err | -| | | -| | elPR, elPRnr, elPRfr | -| | | -| | elPR\_err, elPRnr\_err, elPRfr\_err | -| | | -| | elPT, elPTnr, elPTfr | -| | | -| | elPT\_err, elPTnr\_err, elPTfr\_err | -+--------------------------------------------------------------+---------------------------------------------------+ -| Raman Backscatter | elT, elTnr, elTfr | -| | | -| Raman Backscatter + Particle Linear Depolarization Ratio | elT\_err, elTnr\_err, elTfr\_err | -| | | -| Lidar Ratio | elPR, elPRnr, elPRfr | -| | | -| | elPR\_err, elPRnr\_err, elPRfr\_err | -| | | -| | elPT, elPTnr, elPTfr | -| | | -| | elPT\_err, elPTnr\_err, elPTfr\_err | -| | | -| | vrRN2, vrRN2nr, vrRN2fr | -| | | -| | vrRN2\_err, vrRN2nr\_err, vrRN2fr\_err | -+--------------------------------------------------------------+---------------------------------------------------+
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/file_formats/scc_product_filename.rst Fri Mar 19 13:43:18 2021 +0100 @@ -0,0 +1,57 @@ +SCC products filename +============================== + + +The filename of all SCC products has the following structure:: + + + <station_code>_<product_type_ID>_<wavelength>_<productID>_<starttime>_<stoptime>_<measurementID>_<SCC_module>_<SCC\_version>.nc + +where: + ++-----------------------+------------------------------------------------------------+ +| *<station\_code>* | 3 digits code (for example pot) | ++-----------------------+------------------------------------------------------------+ +| *<product\_type\_ID>* | numeric 3 digits (for example 002) | ++-----------------------+------------------------------------------------------------+ +| *<wavelength>* | 4 digits reporting the wavelength in nm (for example 0532) | ++-----------------------+------------------------------------------------------------+ +| *<productID>* | numeric 7 digits (for example 0000213) | ++-----------------------+------------------------------------------------------------+ +| *<starttime>* | YYYYMMDDHHMM (for example 202102031832) | ++-----------------------+------------------------------------------------------------+ +| *<stoptime>* | YYYYMMDDHHMM (for example 202102031944) | ++-----------------------+------------------------------------------------------------+ +| *<measurementID>* | measurementID string (15 characters) | ++-----------------------+------------------------------------------------------------+ +| *<SCC\_module>* | SCC module (hirelpp,cloudscreen,elpp,eldec,elda,elic) | ++-----------------------+------------------------------------------------------------+ +| *<SCC\_version>* | SCC version (for example v5.2.0) | ++-----------------------+------------------------------------------------------------+ + +The field *<product\_type\_ID>* is codified as it follows: + ++------------------+------------------------------------------------------+ +|Product\_type\_ID | Description | ++==================+======================================================+ +| *0* | Raman Bacskcatter | ++------------------+------------------------------------------------------+ +| *1* | Extinction only | ++------------------+------------------------------------------------------+ +| *2* | Lidar Ration and Extinction | ++------------------+------------------------------------------------------+ +| *3* | Elastic Backscatter | ++------------------+------------------------------------------------------+ +| *6* | Linear Polarization Calibration | ++------------------+------------------------------------------------------+ +| *7* | Raman Backscatter and Linear Depolarization Ratio | ++------------------+------------------------------------------------------+ +| *8* | Elastic Backscatter and Linear Depolarization Ratio | ++------------------+------------------------------------------------------+ +| *9* | High Resolution Pre-Processed data | ++------------------+------------------------------------------------------+ + + +The field *<wavelength>* is available only for ELEC and ELDA data products (for all the other SCC data products is missing). +For CloudScreen products the fields *<product\_type\_ID>*, *<wavelength>*, *<productID>* are missing. +
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/file_formats/scc_product_format.rst Fri Mar 19 13:43:18 2021 +0100 @@ -0,0 +1,253 @@ +SCC products +============ + +.. warning:: + This section is still under development. + + +Introduction +------------ + +The Single Calculus Chain (SCC) is the standard EARLINET tool to perform +automatic and quality checked analysis of raw lidar data. It is +composed by the following modules: + +- HiRELPP (High Resolution ELPP) +- CloudScreen +- ELPP (EARLINET Lidar Pre-Processor) +- ELDA (EARLINET Lidar Data Analizer) +- ELDEC (EARLINET Lidar DEpolarization Calibrator) +- ELIC (EARLINET LIdar Calibrator) +- ELQUICK (EARLINET Lidar QUICJKlook) + + +HiRELPP +-------- + +The HiRELPP module implements the corrections to be applied to the raw lidar signals +before they can be used to derive higher level products. +All the operations implemented in HiRELPP are designed to preserve both the vertical and time resolution as high as possible. +Some instrumental effects (like for example, dead-time correction, trigger-delay correction, overlap correction, +atmospheric and electronic background subtraction, low- and high-range automatic signal glueing) +are corrected following the recommendations provided by the EARLINET quality assurance program. + +Dead-time correction +#################### + +The dead-time corresponds to a maximum count rate. The dead- time causes a non-linearity +between the actual intensity at the photo-multiplier photocathode and the counted events, +which can be described theoretically by means of photon statistics. Actual detector can be +modelled as the paralyzable and the non-paralyzable model. Once information about the model +to use for describing the counting system and the dead-time value is determined, based on +standard operating procedures defined by the ACTRIS Center for Aerosol remote Sensing), these +are provided to HiRELPP and the acquired counts are corrected for the dead-time effect. + + +Trigger-delay correction +######################## + +In general, the data acquisition unit of a lidar system gets a trigger from the laser to start +the signal recording. Due to the electronic circuits in the laser and in the data acquisition unit, +there is always a delay between the outgoing laser pulse and the time at which the acquisition system +actually starts to record the lidar profile. If this trigger delay is not properly taken into account, +a systematic error is made in associating each lidar range bin with the corresponding atmospheric range. +Once the correct measurement of the real trigger delay is done for each detection channel following the +procedure indicated CARS, such information is inserted in the SCC configuration and HiRELPP correct acquired +lidar signals for the trigger-delay. + +Atmospheric and electronic background subtraction +################################################# + +The lidar signal has a constant background made of an atmospheric component and an electric component. +This background can be determined either in the far range of the lidar signal, far enough that the expected +contribution from atmospheric backscatter is negligible, or in the pre-trigger range before the laser pulse, +where the signal must be free of electronic distortions. Each one of this option can be defined into HiRELPP. +Additionally, it is possible to subtract so-called dark signals, which are measured, for example, with a fully +obscured telescope so that no light from the atmosphere reaches the detectors and only eventual electronic +distortions are left. This allows HiRELPP to remove potential distortions affecting analog lidar signals. + +Low- and high-range automatic signal glueing +############################################ + +Lidar signals can cover a quite large dynamic range, because the intensity of the light backscattered from the +aerosol-laden boundary layer in the near range (e.g. at 0.5 km altitude) is several orders of magnitudes higher +than the intensity of the light backscattered from the rather clean troposphere (e.g. at 10 km altitude). +As it is demanding to cover this large dynamic range with one data acquisition channel with linear response, +several approaches are used to overcome this problem. +One option is to split the signal output from a single photomultiplier into two signals and to record one signal +using analog detection mode and the other with the photon-counting method. Another option is to split the lidar +signal optically using a beam splitter and to detect the split components with two detectors and subsequent +data acquisitions. A third option is to use two (or more) telescopes with separate detection electronics. +Both SCC preprocessors (HiRELPLP and ELPP) glues the signals for the first 2 options, while gluing is implemented +directly at optical property level in the third case (ELDA). Before gluing, the near-range and the far-range signals +need to be screened for low-level clouds, corrected for instrumental effects like dead time, trigger delay, etc., +and the backgrounds have to be subtracted as explained above. +HiRELPP and ELPP contains a fully automatic algorithm for the gluing of analog and photon-counting signals as well +as for the gluing of two photon-counting signals. The algorithm is implemented through three main steps: +the procedure starts with the determination of a first guess of the gluing region, after that, the algorithm optimizes +the gluing region performing statistical tests (implemented only in ELPP) and finally, the signals are glued in the +optimal gluing region. + +The typical HiRELPP products are netCDF pre-processed files containing pre-processed (un-calibrated) range corrected +time series at instrumental vertical and time resolution. If the lidar instrument has polarization capabilities +the volume linear depolarization ratio is provided as well. + + +CloudScreen +------------ + +Lidar data contaminated by clouds has to be skipped because the retrieval algorithm implemented in the SCC are optimized +for aerosol and may produce unreliable results when applied to clouds. +The aim of the CloudScreen module is to detect clouds by ingesting as input un-calibrated high resolution pre-processed +range corrected signal timeseries (HiRELPP products). The output of CloudScreen module is a netCDF file containing +a 2-dimensional grid (x axis: time y axis: altitude) with the same resolution as the corresponding HiRELPP product, +in which each pixel is flagged as cloud free or cloud contaminated. This information is then transferred to other +SCC modules for the automatic removal of the cloud contribution within the aerosol optical property products. + +ELPP +----- + +The ELPP module implements all the needed corrections and transformations to be applied to the raw data before they +can be used to derive the optical products at low temporal/spatial resolution. +As HiRELPP, ELPP implements correction of some instrumental effects (like for example, dead-time correction, +trigger-delay correction, overlap correction, atmospheric and electronic background subtraction, +low- and high-range automatic signal glueing) following the recommendations provided by the EARLINET quality assurance program. +Additionally, to HiRELPP, time integration or vertical smoothing is performed by ELPP to meet the required condition +on the products statistical error (defined in the SCC database for each data product type). +ELPP makes also advantage of the CloudScreen output products so that signals affected by low clouds are automatically removed +already at level of lidar pre-processor. +Besides these corrections, ELPP is also responsible to generate the molecular signal needed to calculate +the aerosol optical products. +In both aerosol backscatter (Klett, 1981; Fernald, 1984; Di Girolamo et al., 1999; Ansmann et al., 1992a; Ferrare et al., 1998) +and extinction (Ansmann et al., 1990, 1992b) retrievals the molecular contribution to the atmospheric extinction and +transmissivity are required as input, which are calculated by ELPP at the emission and detection wavelengths in terms +of vertical profiles at the same vertical resolution as the pre-processed lidar signals. The molecular number density profile +is calculated by ELPP from vertical profiles of temperature T(z) and pressure P(z) using the ideal gas law and assuming as 1 +the value of the air compressibility factor. Temperature and pressure profiles are either calculated from standard atmosphere +model or taken from the measurements of a close-by radiosounding that can be provided to the SCC +as a separate input file or provided by model data profiles. +Once the molecular number density is obtained, the calculation of the molecular optical parameters, i.e., the backscatter +and extinction coefficients, is done following the procedure reported in Bucholtz (1995) and Miles et al. (2001). +More details about implemented algorithms in ELPP are reported in D'Amico et al., (2016). +The typical ELPP products consist of netCDF pre-processed files containing low resolution pre-processed (un-calibrated) +range corrected time series. + +ELDA +----- + +ELDA applies the algorithms for the retrieval of aerosol optical parameters to the low resolution pre-processed signals, +produced by ELPP module. The module provides aerosol optical products in a flexible way choosing from a set of +possible pre-defined analysis procedures. + +ELDA implements: +- retrieval of aerosol extinction profile +- retrieval of Raman aerosol backscatter profile +- retrieval of elastic aerosol backscatter profile +- particle/volume depolarization ratio profile + +An automatic vertical-smoothing and time-averaging technique selects the optimal smoothing level as a function of altitude +on the base of different thresholds on product uncertainties fixed in the SCC database for each product. +Currently, ELDA delivers only optical products at a single wavelength (so for a multi-wavelength lidar, +ELDA generates several independent optical products each referring to a single wavelength). +Full description of implemented algorithms is reported in Mattis et al., (2016). +For all products and retrieval algorithms, the user can choose whether the statistical uncertainties shall be calculated +with the Monte Carlo method or by means of error propagation. The only exception are retrievals with the Klett-Fernald a +lgorithm for which the estimation of uncertainties is implemented only with Monte Carlo method. +Currently, the separated handling of statistical errors of the lidar signals, of systematic errors of the lidar signals, +and of uncertainties of the retrieval algorithms is under research within the EARLINET community. +ELDA allows for the automated vertical smoothing and temporal averaging of the derived products. The user has the +option to adjust the degree of smoothing and averaging of each individual product by setting several parameters. +In general, those parameters and constraints can be defined for two different altitude regions, below and above 2 km altitude. +Two threshold values for the maximum allowable relative statistical error of the product below and above 2 km altitude +(meaning high expected aerosol load and low aerosol load, respectively) can be defined. +Beside these user-defined constraints, there are fixed limitations concerning the maximum allowable smoothing and averaging: +it is not allowed to apply a smoothing that would result in effective vertical resolutions larger than 500m and 2km +below and above 2km altitude, respectively. +All methods of calculating profiles of particle backscatter coefficients include a certain calibration procedure. Usually a +particle-free region in the free troposphere where the aerosol backscatter is assumed as null is used for calibration. +A calibration window of user-defined width is shifted through the altitude region, where particle-free conditions typically +occur (user-defined calibration interval). For each window position, the average and standard deviation of the signal or signal +ratio is calculated. It is assumed that the window position where the signal or signal ratio has its minimum is closest to the +assumed particle-free conditions. The average value within this calibration window and its standard deviation are used to +estimate the calibration factor and its statistical uncertainty. If the user knows from ancillary data, e.g., from +sun-photometer observations or from climatological data of the stratospheric particle load, that there is no +particle-free altitude layer, it is possible to provide backscatter ratios different from 1 as calibration value. +ELDA implements the derivative calculation into the aerosol extinction algorithm as derivative of the pre-processed +signals by weighted or non-weighted linear fit method. +Finally, concerning the assumptions needed in terms of Angstrom exponent (extinction calculation) and /or lidar ratio +(elastic backscatter retrieval), it is possible to define in the SCC configuration the values to be used. +In particular it is possible to include a lidar ratio (Angstrom) profile in order to improve the overall quality of +the product. These values can be provided to the SCC together with the raw signals and are passed by ELPP to ELDA. + +ELIC +----- + +The ELIC module calibrates both high- and low-resolution pre-processed products (HiRELPP end ELPP products respectively) using the same calibration constant computed by ELDA during the retrieval of low-resolution optical aerosol properties (elastic/Raman bacskcatter calibration). As already mentioned, both HiRELPP and ELPP deliver pre-processed range corrected signal timeseries. Pre-processed range corrected signals are not considered robust lidar products because even if they are proportional to the concentration of atmospheric backscatterers, they depend on specific lidar instrumental characteristics as well. In the retrieval of aerosol optical products (like for example aerosol backscatter), the range corrected signals are used as input and special calibration techniques are used to remove the instrumental dependence. The more is the signal to noise ratio the better is the result of these calibration techniques. Usually, a way to increase the signal to noise ratio is to degrade the time and/or space resolution of the input signals. In general, it is more demanding to get a reliable calibration when working with high resolution lidar data. This is the reason why in the SCC workflow, the calibration is done by ELDA which deals with un-calibrated low-resolution range corrected signals. Anyway, if we assume that the instrumental conditions are stable in the time interval in which the measurements take place, it is possible to use the calibration constants retrieved by ELDA calibrating low resolution signals also to calibrate the high resolution timeseries measured in the same time window. This is the main goal of the ELIC module which runs right after ELDA, gets the calibration constants retrieved by ELDA for all lidar channels and calibrates the corresponding high- and low-resolution range corrected signal timeseries. The ELIC products are netCDF files containing fully calibrated quantities like total attenuated backscatter and volume depolarization ratio. + + + +ELDEC +----- + +All the participating stations operate lidar equipped with at least 2 channels detecting independent polarization states of backscattered light and, as consequence, can deliver atmospheric volume/particle depolarization ratio profiles. Anyway, to calculate the volume/particle depolarization ratio from the ratio of these polarization channels an accurate calibration is needed. ELDEC module provide this calibration parameter following the quality assurance procedures defined within ACTRIS CARS (Centre for Aerosol Remote Sensing). In particular, the depolarization calibration is made by submitting to the SCC special raw depolarization calibration datasets. + + +ELQUICK +------- + +The ELQUICK module generates standardized lidar quicklook for the whole ACTRIS/EARLINET network. Lidar quicklooks (png images) are useful representation of the high resolution timeseries of total attenuated backscatter and/or volume depolarization profiles contained in the ELIC products which can be considered as the two-dimensional pixel grid. The number of vertical pixels of this grid is the number of points of the total attenuated backscatter (or volume depolarization ratio) vertical profile while the number of horizontal pixels is to the number of total attenuated backscatter (or volume depolarization ratio) profiles included in the time series. The color corresponding to each individual pixel is, instead, connected to the value of the total attenuated backscatter (or volume depolarization ratio) at a given altitude and time. In this way, by observing such quicklook images it is easy to visualize aerosol layers and their evolution in both time and space. + + +File Format +----------- + +All the SCC products are files in Network Common Data Form +(NetCDF) which is a well known self-describing, machine-independent data +format that support the creation, access, and sharing of array-oriented +scientific data. For more information about NetCDF format: +http://www.unidata.ucar.edu/software/netcdf/. + +The NetCDF is a binary format that allows the definition of +multi-dimensional variables of several types (integers, double, +character, etc). For each variable it is possible to define one or more +attributes where to specify variable properties like units, long name, +description, etc. + +It is possible to define global attributes which are not related to a +specific variable but to the whole file. + +A NetCDF file is composed by four different section: + +dimensions + this section contains all the dimensions used in the definition of + all the variables included in the NetCDF file + +variables + this section contains all the variables stored in the NetCDF file. + Each variable is defined as a multi-dimensional array of a specific + type and with all the dimensions defined in the dimensions section + +global attributes + this section lists all the attributes referring to the whole file. As + the variable the attributes (global or the one attached to a specific + variable) can be of different type + +data + in this section the data contained in each variable defined in + variable section is stored. Attribute values (both global or related + to a specific variable) are not reported in data section but directly + in variable or global attribute sections. + +.. toctree:: + + hirelpp_product_format + cloudscreen_product_format + elpp_product_format + eldec_product_format + elda_product_format + elic_product_format + bitmask_flag_description + + + +
--- a/docs/index.rst Wed Mar 10 10:46:27 2021 +0200 +++ b/docs/index.rst Fri Mar 19 13:43:18 2021 +0100 @@ -16,6 +16,7 @@ tutorial administration data_processing + lidar_retrievals depolarization high_resolution handbook
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/lidar_retrievals.rst Fri Mar 19 13:43:18 2021 +0100 @@ -0,0 +1,7 @@ +Lidar retrievals +================ + +.. toctree:: + :maxdepth: 2 + + lidar_retrievals/lidar_retrievals
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/lidar_retrievals/lidar_retrievals.rst Fri Mar 19 13:43:18 2021 +0100 @@ -0,0 +1,93 @@ +1. Algorithm Theoretical Basis +============================== + + +The European Aerosol Research Lidar Network, EARLINET, was founded in 2000 as a research +project for establishing a quantitative, comprehensive, and statistically significant database for the +horizontal, vertical, and temporal distribution of aerosols on a continental scale. + +ACTRIS/EARLINET stations are typically able to retrieve aerosol optical properties, such as extinction and backscatter coefficients, +lidar ratio, optical depth, and the Angstrom exponent if Raman lidar signals are available. In cases when only elastic lidar signals are used, +backscatter and a backscatter-related Angstrom exponent are derived. + +The calculation of all these quantities is done after the cloud masking procedure and it is therefore attributed exclusively to aerosol particles. + + +1.1 Physical meaning of the retrieved properties +------------------------------------------------ + + +When laser radiation with power :math:`P_L` at wavelength :math:`\lambda_L` is sent into the atmosphere, part of the radiation is backscattered. +The optical power :math:`P(\lambda,\lambda_L,z)` of the backscattered radiation received from the distance :math:`z` at wavelength :math:`\lambda` depends +on atmospheric composition through two parameters: the backscattering coefficient and the extinction coefficient, and is described by the lidar equation: + +.. math:: + P(\lambda,\lambda_L,z) \sim \frac{P_L}{z^2}\beta(\lambda,\lambda_L,z) \exp \left[-\int_0^z \alpha(\lambda,\xi) d\xi \right] \exp \left[ -\int_0^z \alpha(\lambda_L,\xi) d\xi \right] + :label: eq_lidar + +The backscattering coefficient :math:`\beta` is the fraction of incident radiation backscattered for unitary solid angle and for unitary length [m-1sr-1]. +It depends on the kind of scattering process and on both emission (:math:`\lambda_L`) and detection (:math:`\lambda`) wavelength. + +It is due to contributions of both molecules (m) and particles (p) of atmosphere: + +.. math:: + \beta(\lambda,\lambda_L,z)= \beta_m(\lambda,\lambda_L,z)+\beta_p(\lambda,\lambda_L,z) + :label: eq_beta + +The extinction coefficient is defined as the energy flux reduction per unitary path [m-1]. + +It gives a measurement of the energy loss of the laser beam in the atmosphere. + +It is due to contributions of both molecules (m) and particles (p) of atmosphere deriving from both the scattering (s) and absorption (a) processes: + +.. math:: + \alpha(\lambda,z)=\alpha_{m,a}(\lambda,z)+\alpha_{m,s}(\lambda,z) + \alpha_{p,a}(\lambda,z)+\alpha_{p,s}(\lambda,z) + :label: eq_alpha + +The extinction coefficient integrated over a spatial path provides the optical depth: + +.. math:: + \tau(\lambda,z)=\int_0^z \alpha(\lambda,\xi)d\xi + :label: eq_tau + +The Raman configuration allows for the retrieval of the range-resolved particle lidar ratio. The lidar ratio is defined as the ration between the +particle extinction coefficient and the particle backscatter coefficient: + +.. math:: + S(\lambda,z)=\frac{\alpha(\lambda,z)}{\beta(\lambda,z)} + :label: eq_lr + +It is a parameter strongly related to the microphysical properties of the aerosols: shape, size distribution, chemical composition, +relative humidity. Unlike :math:`\alpha` and :math:`\beta`, :math:`S` doesn’t depend on atmospheric aerosol load, but only on aerosol type. + +The combination of the particle extinction at different wavelengths allows for the calculation of the Angstrom exponent: + +.. math:: + k_{\alpha}(\lambda_1,\lambda_2,z)=\frac{\ln \left[ \frac{\alpha(\lambda_1,z)}{\alpha(\lambda_2,z)} \right] }{\ln \left[ \frac{\lambda_2}{\lambda_1} \right]} + :label: eq_kalpha + +This quantity is size dependent assuming larger values for smaller particles and ranges between -1 for very big particles and 4 for molecules. + +Similarly to the Angstrom exponent, the backscatter related Angstrom exponent can be calculated as: + +.. math:: + k_{\beta}(\lambda_1,\lambda_2,z)=\frac{\ln \left[ \frac{\beta(\lambda_1,z)}{\beta(\lambda_2,z)} \right] }{\ln \left[ \frac{\lambda_2}{\lambda_1} \right]} + :label: eq_kbeta + +As for the Angstrom exponent this quantity is size dependent assuming larger values for smaller particles. However, it has to be noted that it is +even more sensitive than Angstrom exponent to the size of the particles, because the backscatter itself is more size-related than the extinction coefficient. + + + + +1.2 Basic concepts for the retrieval of aerosol optical properties +------------------------------------------------------------------ + + +ACTRIS/EARLINET is mainly based on Raman lidar stations, i.e. lidars equipped with elastic channel (detection channel at the same wavelength of transmitted laser beam) and an additional channel for detecting the N2 Raman-shifted signal. This additional channel allows the direct measurement of the aerosol extinction (Ansmann et al., 1990). This means having the capability of independent retrieval of extinction and backscatter coefficient in good signal-to-noise ratio conditions, using the retrieved extinction in the elastic lidar equation reported above. Whenever this is not possible an assumption about the relationship between extinction and backscatter is needed for solving the lidar equation affecting the overall uncertainty of the aerosol backscatter coefficient. Within ACTRIS/EARLINET, aerosol extinction profiles are reported only when the Raman channel capability is used and therefore only with direct assessed measurement of the extinction coefficient profile. + +Solving the N2 Raman lidar equation involves a derivative respect to the range of the logarithm of the signal. This procedure is complex from mathematical point of view and needs for specific smoothing approaches. Within EARLINET many efforts have been done for comparing the different suitable procedures (Pappalardo et al., 2004): the linear fit has been identified as the most appropriate one. Two options are available the weighted and not weighted linear fit. + +For what concerns the aerosol backscatter coefficient profiles, the SCC can provide aerosol products in a flexible way choosing from a set of possible pre-defined analysis procedures: it enables the retrieval of particle backscatter coefficients with the elastic technique by using both the Klett method (Klett, 1981; Fernald, 1984) and the iterative algorithm (Di Girolamo et al., 1995), but also the computation of particle backscatter coefficient profiles after the Raman method (Ansmann et al., 1992). + +Statistical errors are calculated starting from the statistical errors affecting the lidar detected signals: the statistical errors affecting the optical properties can be calculated using the Monte Carlo or error propagation law. The provided errors do not include the uncertainties related to the assumption made in the retrieval algorithms like: the uncertainty to the atmospheric molecular profile, the wavelength dependence of the extinction, the absence of aerosol in the backscatter calibration range and more relevant the lidar ratio values assumption in the elastic backscatter method and the calibration of the depolarization channels. The quantification of the resulting overall error is still under investigation and object of studies within ACTRIS/EARLINET. The current approach is to reduce as much as possible such errors improving the quality assurance procedures together with the calibration centre and selecting the best possible approaches (e.g. intensifying the scheduling of the depolarization calibration procedures).
