act.qc.QCFilter.bsrn_comparison_tests

QCFilter.bsrn_comparison_tests(test, gbl_SW_dn_name=None, glb_diffuse_SW_dn_name=None, direct_normal_SW_dn_name=None, glb_SW_up_name=None, glb_LW_dn_name=None, glb_LW_up_name=None, air_temp_name=None, test_assessment='Indeterminate', lat_name='lat', lon_name='lon', LWdn_lt_LWup_component=25.0, LWdn_gt_LWup_component=300.0, use_dask=False)

Method to apply BSRN comparison tests and add results to ancillary quality control variable. Need to provided variable name for each measurement for the test to be performed. All radiation data must be in W/m^2 units. Test will provided exception if required variable name is missing.

Parameters:
  • test (str) – Type of tests to apply. Options include: ‘Global over Sum SW Ratio’, ‘Diffuse Ratio’, ‘SW up’, ‘LW down to air temp’, ‘LW up to air temp’, ‘LW down to LW up’

  • gbl_SW_dn_name (str) – Variable name in Dataset for global shortwave downwelling radiation measured by unshaded pyranometer

  • glb_diffuse_SW_dn_name (str) – Variable name in Dataset for global diffuse shortwave downwelling radiation measured by shaded pyranometer

  • direct_normal_SW_dn_name (str) – Variable name in Dataset for direct normal shortwave downwelling radiation

  • glb_SW_up_name (str) – Variable name in Dataset for global shortwave upwelling radiation

  • glb_LW_dn_name (str) – Variable name in Dataset for global longwave downwelling radiation

  • glb_LW_up_name (str) – Variable name in Dataset for global longwave upwelling radiation

  • air_temp_name (str) – Variable name in Dataset for atmospheric air temperature. Variable used in longwave tests.

  • test_assessment (str) – Test assessment string value appended to flag_assessments attribute of QC variable.

  • lat_name (str) – Variable name in the Dataset for latitude

  • lon_name (str) – Variable name in the Dataset for longitude

  • LWdn_lt_LWup_component (int or float) – Value used in longwave down less than longwave up test.

  • LWdn_gt_LWup_component (int or float) – Value used in longwave down greater than longwave up test.

  • use_dask (boolean) – Option to use Dask for processing if data is stored in a Dask array

References

Long, Charles N., and Ellsworth G. Dutton. “BSRN Global Network recommended QC tests, V2. x.” (2010).

Examples

ds_object = act.io.armfiles.read_netcdf(act.tests.EXAMPLE_BRS, cleanup_qc=True)
ds_object.qcfilter.bsrn_comparison_tests(
    gbl_SW_dn_name='down_short_hemisp',
    glb_diffuse_SW_dn_name='down_short_diffuse_hemisp',
    direct_normal_SW_dn_name='short_direct_normal',
    glb_SW_up_name='up_short_hemisp',
    glb_LW_dn_name='down_long_hemisp_shaded',
    glb_LW_up_name='up_long_hemisp',
    use_dask=True)