act.qc.QCFilter.bsrn_limits_test

QCFilter.bsrn_limits_test(test='Physically Possible', gbl_SW_dn_name=None, glb_diffuse_SW_dn_name=None, direct_normal_SW_dn_name=None, direct_SW_dn_name=None, glb_SW_up_name=None, glb_LW_dn_name=None, glb_LW_up_name=None, sw_min_limit=None, lw_min_dn_limit=None, lw_min_up_limit=None, lw_max_dn_limit=None, lw_max_up_limit=None, solar_constant=1366, lat_name='lat', lon_name='lon', use_dask=False)

Method to apply BSRN limits test and add results to ancillary quality control variable. Need to provide variable name for each measurement for the test to be performed. If no limits provided will use default values. All 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 “Physically Possible” or “Extremely Rare”

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

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

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

  • direct_SW_dn_name (str) – Variable name in the Dataset for direct shortwave downwelling radiation

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

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

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

  • sw_min_limit (int or float) – Lower limit for shortwave radiation test

  • lw_min_dn_limit (int or float) – Lower limit for downwelling longwave radiation test measured by a pyrgeometer

  • lw_min_up_limit (int or float) – Lower limit for upwelling longwave radiation test measured by a pyrgeometer

  • lw_max_dn_limit (int or float) – Upper limit for downwelling longwave radiation test measured by a pyrgeometer

  • lw_max_up_limit (int or float) – Upper limit for upwelling longwave radiation test measured by a pyrgeometer

  • solar_constant (int or float) – Mean solar constant used in upper limit calculation. Earth sun distance will be calculated and applied to this value.

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

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

  • 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_limits_test(
    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')