Lib.compute_pia.PIAHitschfeldBordan Class Reference

Public Member Functions
	__init__ (self, param_name="DBZH", co_zk_power=CBAND_CO_ZK_POWER, exp_zk_power=CBAND_EXP_ZK_POWER, PIAMax=PIA_MAX)
	createPIAField (self, scan)
	createPIAParameter (self, scanparam, PIA_field)
	createPIAQualityField (self, pia_parameter, dr)
	process (self, scan, reprocess_quality_flag, quality_control_mode)
	createHowTaskArgs (self, co_zk_power, exp_zk_power, PIAMax, dr)

Protected Attributes
	_param_name = param_name
	_co_zk_power = co_zk_power
	_exp_zk_power = exp_zk_power
	_piamax = PIAMax

Constructor & Destructor Documentation

__init__()

Lib.compute_pia.PIAHitschfeldBordan.__init__	(		self,
			param_name = "DBZH",
			co_zk_power = CBAND_CO_ZK_POWER,
			exp_zk_power = CBAND_EXP_ZK_POWER,
			PIAMax = PIA_MAX )

Constructor
:param_name: the quantity to process in the scan. Only allows DBZH and TH
:param co_zk_power: The coefficient of the Z-K power law. Default to C_BAND value
:param exp_zk_power: The exponent of the Z-K power law. Default to C_BAND value
:param PIAMax: Maximum PIA adjustment. Defaults to PIA_MAX.

Member Function Documentation

createHowTaskArgs()

Lib.compute_pia.PIAHitschfeldBordan.createHowTaskArgs	(		self,
			co_zk_power,
			exp_zk_power,
			PIAMax,
			dr )

 Creates the how/task_args string that should be associated with the PIA fields
:param co_zk_power: The coefficient of the Z-K power law. Default to C_BAND value
:param exp_zk_power: The exponent of the Z-K power law. Default to C_BAND value
:param PIAMax: Maximum PIA adjustment. Defaults to PIA_MAX.
:param dr: the range resolution in km
:return: the string

createPIAField()

Lib.compute_pia.PIAHitschfeldBordan.createPIAField	(		self,
			scan )

 Calculates the PIA field according to the Hitschfeld-Bordan algorithm.
The range resolution is taken from the scans rscale and converted to km. The algorithm limits the
adjustment by ensuring that the log10 call never will be called with a negative value by limiting the cumulative
values by the inverse of the adjustment factor.
:param scan: Scan to operate on
:return: a tuple of PIA field, datatype field (0 = Undetect, 1 = Nodata and 2 = Data) and the range resolution used

createPIAParameter()

Lib.compute_pia.PIAHitschfeldBordan.createPIAParameter	(		self,
			scanparam,
			PIA_field )

 Creates a PIA parameter from the PIA field and the datatypes
:param scanparam: The parameter that was used when creating the PIA field
:param PIA_field: the PIA field without gain/offset applied
:return the PIA parameter

createPIAQualityField()

Lib.compute_pia.PIAHitschfeldBordan.createPIAQualityField	(		self,
			pia_parameter,
			dr )

 Creates a PIA quality field from the PIA parameter.
:param pia_parameter: The PIA parameter created
:param dr: the range resolution in km

process()

Lib.compute_pia.PIAHitschfeldBordan.process	(		self,
			scan,
			reprocess_quality_flag,
			quality_control_mode )

 Creates the PIA derived parameter and corresponding quality field in the scan. If quality_control_mode is set
to APPLY it will also adjust the parameter referenced by param_name with the PIA field.
:param scan: scan to change
:reprocess_quality_flag: if quality flag should be reprocessed or not
:quality_control_mode: how to handle the quality control mode if only analyzing or analyze and apply
:return: N/A

---

The documentation for this class was generated from the following file:

• /github/workspace/Lib/compute_pia.py