This component provides a mechanism to apply the single scattering albedo dependent PSAP correction described in Virkkula et all 2005. This correction incorporates the updated constants from the 2010 errata. The correction involved a loading correction dependent on single scattering albedo and a constant fraction of scattering subtraction.
Usage
da.corr.virkkula2005 [switches…] [[station] variables times [archive]|[file]]
Switches
- --correct=SELECTION
-
These are the variables to that the correction is applied to. This option is mutually exclusive with instrument specification.
Default: All absorptions
- --extinction=SELECTION
-
These are the variables to the light extinction coefficients used by the correction are contained in. By default none are used. This option is mutually exclusive with instrument specification.
- --extinction-instruments=SUFFIX…
-
These are the instrument suffixes that input light extinctions are read from. For example S11 would usually specifies the reference nephelometer. This option is mutually exclusive with manual variable specification.
- --h0=INPUT
-
This is the h1 constant used to generate the absorption scaling factor. Ba = [k0 + k1×(h0 + h1×ω)×ln(Tr)]×σa0 - s×σs
Default: Wavelength dependent
- --h1=INPUT
-
This is the h1 constant used to generate the absorption scaling factor. Ba = [k0 + k1×(h0 + h1×ω)×ln(Tr)]×σa0 - s×σs
Default: Wavelength dependent
- --instruments=SUFFIX…
-
These are the instrument suffixes to correct. For example S11 would usually specifies the reference nephelometer. This option is mutually exclusive with manual variable specification.
Default: All instrument suffixes
- --k0=INPUT
-
This is the k0 constant used to generate the absorption scaling factor. Ba = [k0 + k1×(h0 + h1×ω)×ln(Tr)]×σa0 - s×σs
Default: Wavelength dependent
- --k1=INPUT
-
This is the k1 constant used to generate the absorption scaling factor. Ba = [k0 + k1×(h0 + h1×ω)×ln(Tr)]×σa0 - s×σs
Default: Wavelength dependent
- --s=INPUT
-
This is the s constant that is multiplied by the scattering and subtracted from the absorption. Ba = [k0 + k1×(h0 + h1×ω)×ln(Tr)]×σa0 - s×σs
Default: Wavelength dependent
- --scattering=SELECTION
-
These are the variables to the light scattering coefficients used by the correction are contained in. This option is mutually exclusive with instrument specification.
Default: All scatterings from S11
- --scattering-instruments=SUFFIX…
-
These are the instrument suffixes that input light scatterings are read from. For example S11 would usually specifies the reference nephelometer. This option is mutually exclusive with manual variable specification.
Default: S11
- --smoothing=SMOOTHER
-
This is the smoothing applied to the scattering and/or extinction inputs before any calculation using them.
Default: 3-minute TC low pass filter
- --transmittance-end=INPUT
-
This is the input end transmittance used in the correction. When this option is set, this transmittance is used for all absorption channels. Therefor, normally only a single absorption can be corrected while using this option.
Default: Resolved automatically by instrument suffix
- --transmittance-start=INPUT
-
This is the input start transmittance used in the correction. When this option is set, this transmittance is used for all absorption channels. Therefor, normally only a single absorption can be corrected while using this option.
Default: Resolved automatically by instrument suffix
Arguments
If no bare word input specification is supplied then data are read from standard input.
- station
-
This argument is used to specify the station used to look up variables that do not include a station as part of an archive read specification. The station is the three letter GAW station code of the location, such as
BND
. The argument accepts multiple stations specified as regular expressions and separated by:
or;
or,
. For exampleBND,MLO
and(BND|MLO)
are two ways of selecting both the BND and MLO stations.The special value
allstations
may also be specified to select all stations. - variables
-
This argument may be split into multiple actual program arguments. Each part consists of one or more variable specifications separated by
,
(commas). The station and archive used if none are explicitly given are defined in the other arguments or inferred from system defaults. For example simplyBsB_S11
selects the blue scattering from the S11 instrument and returns all cut sizes and metadata. If instead::BsB_S11:pm10
is used then only PM10 scattering is returned. That is, the selection specifies "any" station and archive (the defaults are set in the other arguments) then requires that it has the "PM10" flavor. A specification such asbnd:BsB_S11,thd:BsB_S11
allows for data selection from multiple stations.This may also be used to select a "record" type alias such as "S11a". In this mode all the variables defined in the alias are returned.
Finally the special value
everything
can be used to select all available data for the given station(s) and archive(s). - times
-
This argument may be split into multiple actual program arguments. This full list of time arguments defines a time bounds list that sets the range of data queried. The final resulting data are clipped to the given time bounds but any values that intersect them are returned.
- archive
-
This argument is used to specify the archive used to look up variables that do not include an archive as part of an archive read specification. The archive is the internal name, such as
raw
orclean_meta
. The argument accepts multiple archives specified as regular expressions and separated by:
or;
or,
. For exampleraw(_meta)?
selects both theraw
andraw_meta
archives.The special value
allarchives
may also be used to select all available archives. - file
-
This argument is used to specify the the file to read data from. If it is present and exists then data is read from the given file name instead of from standard input. Alternatively
-
(a single dash) may be used to explicitly specify standard input.
Examples
- Defaults
-
This will correct all absorptions present using the scatterings from the S11 instrument.
da.corr.virkkula2005 bnd S11a 2015-05-01 2015-05-03
Or:
da.corr.virkkula2005 input_file.c3d
Or:
da.get bnd S11a 2015-05-01 2015-05-03 | da.corr.virkkula2005
- Single instrument with manual constants
-
This will correct all absorptions from A11 using extinctions from E11. Non-standard constants with k0 = 0.534 and k1 = -0.617 are also used.
da.corr.virkkula2005 --extinction-instruments=E11 --instruments=A11 --k0=0.534 --k1=-0.617 bnd S11a 2015-05-01 2015-05-03
- Single variable
-
This will correct only the variable BaG_A11.
da.corr.virkkula2005 --correct=bnd:raw:BaG_A11 bnd S11a 2015-05-01 2015-05-03