beamb_quality_plugin.beamb_quality_plugin Class Reference

The beam blockage quality plugin. More...

Inheritance diagram for beamb_quality_plugin.beamb_quality_plugin:

Public Member Functions
	__init__ (self)
	Default constructor.
	getQualityFields (self)
	process (self, obj, reprocess_quality_flag=True, quality_control_mode=QUALITY_CONTROL_MODE_ANALYZE_AND_APPLY, arguments=None)

Protected Member Functions
	_create_bb (self)
	Creates a beam blockage instance.

Static Protected Attributes
	_topodir = None
	The gtopo30 directory.
	_cachedir = None
	The cachedir.
	_dblimit = BEAMBLOCKAGE_DBLIMIT
	The default beam blockage Gaussian approximation main lobe.
	_bblimit = BEAMBLOCKAGE_BBLIMIT
	The default percent beam blockage (divided by 100).

Detailed Description

The beam blockage quality plugin.

Constructor & Destructor Documentation

__init__()

beamb_quality_plugin.beamb_quality_plugin.__init__

(

self

)

Default constructor.

Member Function Documentation

_create_bb()

beamb_quality_plugin.beamb_quality_plugin._create_bb ( self )

protected

Creates a beam blockage instance.

getQualityFields()

beamb_quality_plugin.beamb_quality_plugin.getQualityFields

(

self

)

Returns

a list containing the string se.smhi.detector.beamblockage

process()

beamb_quality_plugin.beamb_quality_plugin.process	(		self,
			obj,
			reprocess_quality_flag = True,
			quality_control_mode = QUALITY_CONTROL_MODE_ANALYZE_AND_APPLY,
			arguments = None )

Parameters

obj	A rave object that should be processed.
reprocess_quality_flag	If the quality fields should be reprocessed or not.
arguments	Not used

Returns

: The modified object if this quality plugin has performed changes to the object.

Member Data Documentation

_bblimit

beamb_quality_plugin.beamb_quality_plugin._bblimit = BEAMBLOCKAGE_BBLIMIT

staticprotected

The default percent beam blockage (divided by 100).

Defaults 1.0 if not changed in beamb_defines.py.

_cachedir

beamb_quality_plugin.beamb_quality_plugin._cachedir = None

staticprotected

The cachedir.

If not set, then default values will be used.

_dblimit

beamb_quality_plugin.beamb_quality_plugin._dblimit = BEAMBLOCKAGE_DBLIMIT

staticprotected

The default beam blockage Gaussian approximation main lobe.

Defaults to -6.0 if not changed in beamb_defines.py.

_topodir

beamb_quality_plugin.beamb_quality_plugin._topodir = None

staticprotected

The gtopo30 directory.

If not set, then default values will be used.

---

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

• /github/workspace/pybeamb/beamb_quality_plugin.py