Lib.compute_pia Namespace Reference

Classes
class	PIAHitschfeldBordan

Functions
	ComputePIAscan (scan, param_name, keepPIA, reprocess_quality_flag, quality_control_mode)
	Computes PIA based quality control.
	ComputePIA (pobject, param_name, keepPIA, reprocess_quality_flag, quality_control_mode)
	Computes PIA based quality control.
	main (options)
	Computes PIA and performs quality control with it.

Variables
float	CBAND_CO_ZK_POWER = 7.34e5
	settings
float	CBAND_EXP_ZK_POWER = 1.344
float	XBAND_CO_ZK_POWER = 9.25e4
float	XBAND_EXP_ZK_POWER = 1.25
float	PIA_MAX = 10.0;
float	DEFAULT_RANGE_RESOLUTION = 2.0;
str	TASK = "se.smhi.qc.hitschfeld-bordan"
int	UNDETECT_TYPE = 0
int	NODATA_TYPE = 1
int	DATA_TYPE = 2
str	description = "Computes PIA and uses it to quality control radar observations"
str	usage = "usage: %prog -i <input file> -o <output file> [-p <parameter> -k <store PIA >] [h]"
	parser = OptionParser(usage=usage, description=description)
	dest
	help
	default
	action
	options
	args

Detailed Description

Copyright (C) 2025- Swedish Meteorological and Hydrological Institute (SMHI)

This file is part of RAVE.

RAVE is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

RAVE is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License
along with RAVE.  If not, see <http://www.gnu.org/licenses/>.

Created on Mon Aug 25 14:12:08 2025

@author: Remco van de beek
@author: Yngve Einarsson SMHI

Function Documentation

ComputePIA()

Lib.compute_pia.ComputePIA	(		pobject,
			param_name,
			keepPIA,
			reprocess_quality_flag,
			quality_control_mode )

Computes PIA based quality control.

A single scan object is sent to the ComputePIA function. The scans comprising a polar volume are sent to the same function individually.

Parameters

PolarVolumeCore	or PolarScanCore object
string	radar quantity name, defaults to DBZH
boolean	whether (True) or not (False) to keep the derived PIA parameter
boolean	reprocess_quality_flag
enum	quality_control_mode

ComputePIAscan()

Lib.compute_pia.ComputePIAscan	(		scan,
			param_name,
			keepPIA,
			reprocess_quality_flag,
			quality_control_mode )

Computes PIA based quality control.

A single scan object is sent to the ComputePIAscan function. The scans comprising a polar volume are sent to the same function individually.

Parameters

PolarScanCore	object
string	radar quantity name, defaults to DBZH
boolean	whether (True) or not (False) to keep the derived PIA parameter
boolean	reprocess_quality_flag
enum	quality_control_mode

main()

Lib.compute_pia.main

(

options

)

Computes PIA and performs quality control with it.

Parameters

object

containing command-line arguments

Variable Documentation

CBAND_CO_ZK_POWER

float Lib.compute_pia.CBAND_CO_ZK_POWER = 7.34e5

settings