RAVE
Public Member Functions | List of all members
Lib.rave_quality_plugin.rave_quality_plugin Class Reference
Inheritance diagram for Lib.rave_quality_plugin.rave_quality_plugin:
Lib.odc_hac_quality_plugin.odc_hac_filter_plugin Lib.odc_hac_quality_plugin.odc_hac_increment_plugin Lib.rave_dealias_quality_plugin.dealias_plugin Lib.rave_distance_quality_plugin.rave_distance_quality_plugin Lib.rave_height_quality_plugin.rave_height_quality_plugin Lib.rave_overshooting_quality_plugin.rave_overshooting_quality_plugin Lib.rave_qitotal_quality_plugin.rave_qitotal_quality_plugin Lib.rave_quality_chain_plugin.rave_quality_chain_plugin Lib.rave_radarindex_quality_plugin.rave_radarindex_quality_plugin Lib.rave_radvol_quality_plugin.radvol_att_plugin Lib.rave_radvol_quality_plugin.radvol_broad_plugin Lib.rave_radvol_quality_plugin.radvol_nmet_plugin Lib.rave_radvol_quality_plugin.radvol_speck_plugin Lib.rave_radvol_quality_plugin.radvol_spike_plugin Lib.rave_scansun_quality_plugin.scansun_quality_plugin Lib.rave_zdiff_quality_plugin.rave_zdiff_quality_plugin

Public Member Functions

 __init__ (self)
 Default sonstructor.
 
 getQualityFields (self)
 
 process (self, obj, reprocess_quality_flag=True, quality_control_mode=QUALITY_CONTROL_MODE_ANALYZE_AND_APPLY, arguments=None)
 
 algorithm (self)
 

Constructor & Destructor Documentation

◆ __init__()

Lib.rave_quality_plugin.rave_quality_plugin.__init__ ( self)

Default sonstructor.

Reimplemented in Lib.odc_hac_quality_plugin.odc_hac_filter_plugin, Lib.odc_hac_quality_plugin.odc_hac_increment_plugin, Lib.rave_dealias_quality_plugin.dealias_plugin, Lib.rave_distance_quality_plugin.rave_distance_quality_plugin, Lib.rave_height_quality_plugin.rave_height_quality_plugin, Lib.rave_overshooting_quality_plugin.rave_overshooting_quality_plugin, Lib.rave_qitotal_quality_plugin.rave_qitotal_quality_plugin, Lib.rave_quality_chain_plugin.rave_quality_chain_plugin, Lib.rave_radarindex_quality_plugin.rave_radarindex_quality_plugin, Lib.rave_radvol_quality_plugin.radvol_att_plugin, Lib.rave_radvol_quality_plugin.radvol_broad_plugin, Lib.rave_radvol_quality_plugin.radvol_nmet_plugin, Lib.rave_radvol_quality_plugin.radvol_speck_plugin, Lib.rave_radvol_quality_plugin.radvol_spike_plugin, Lib.rave_scansun_quality_plugin.scansun_quality_plugin, and Lib.rave_zdiff_quality_plugin.rave_zdiff_quality_plugin.

Member Function Documentation

◆ algorithm()

Lib.rave_quality_plugin.rave_quality_plugin.algorithm ( self)
Returns
: The algorithm to use or None if no specifiec algorithm wanted

Reimplemented in Lib.rave_distance_quality_plugin.rave_distance_quality_plugin, Lib.rave_height_quality_plugin.rave_height_quality_plugin, Lib.rave_overshooting_quality_plugin.rave_overshooting_quality_plugin, Lib.rave_qitotal_quality_plugin.rave_qitotal_quality_plugin, and Lib.rave_radarindex_quality_plugin.rave_radarindex_quality_plugin.

◆ getQualityFields()

Lib.rave_quality_plugin.rave_quality_plugin.getQualityFields ( self)
Returns
: The quality fields that should be added to the composite. Should be a list

Reimplemented in Lib.odc_hac_quality_plugin.odc_hac_filter_plugin, Lib.odc_hac_quality_plugin.odc_hac_increment_plugin, Lib.rave_dealias_quality_plugin.dealias_plugin, Lib.rave_distance_quality_plugin.rave_distance_quality_plugin, Lib.rave_height_quality_plugin.rave_height_quality_plugin, Lib.rave_overshooting_quality_plugin.rave_overshooting_quality_plugin, Lib.rave_qitotal_quality_plugin.rave_qitotal_quality_plugin, Lib.rave_quality_chain_plugin.rave_quality_chain_plugin, Lib.rave_radarindex_quality_plugin.rave_radarindex_quality_plugin, Lib.rave_radvol_quality_plugin.radvol_att_plugin, Lib.rave_radvol_quality_plugin.radvol_broad_plugin, Lib.rave_radvol_quality_plugin.radvol_nmet_plugin, Lib.rave_radvol_quality_plugin.radvol_speck_plugin, Lib.rave_radvol_quality_plugin.radvol_spike_plugin, Lib.rave_scansun_quality_plugin.scansun_quality_plugin, and Lib.rave_zdiff_quality_plugin.rave_zdiff_quality_plugin.

◆ process()

Lib.rave_quality_plugin.rave_quality_plugin.process ( self,
obj,
reprocess_quality_flag = True,
quality_control_mode = QUALITY_CONTROL_MODE_ANALYZE_AND_APPLY,
arguments = None )
Parameters
objA rave object that should be processed.
reprocess_quality_flagSpecifies if the quality flag should be reprocessed or not. If False, then if possible the plugin should avoid generating the quality field again.
argumentsIf there are any arguments that should be passed to the processor
Returns
: The modified object if this quality plugin has performed changes to the object.

Reimplemented in Lib.odc_hac_quality_plugin.odc_hac_filter_plugin, Lib.odc_hac_quality_plugin.odc_hac_increment_plugin, Lib.rave_dealias_quality_plugin.dealias_plugin, Lib.rave_distance_quality_plugin.rave_distance_quality_plugin, Lib.rave_height_quality_plugin.rave_height_quality_plugin, Lib.rave_overshooting_quality_plugin.rave_overshooting_quality_plugin, Lib.rave_qitotal_quality_plugin.rave_qitotal_quality_plugin, Lib.rave_quality_chain_plugin.rave_quality_chain_plugin, Lib.rave_radarindex_quality_plugin.rave_radarindex_quality_plugin, Lib.rave_radvol_quality_plugin.radvol_att_plugin, Lib.rave_radvol_quality_plugin.radvol_broad_plugin, Lib.rave_radvol_quality_plugin.radvol_nmet_plugin, Lib.rave_radvol_quality_plugin.radvol_speck_plugin, Lib.rave_radvol_quality_plugin.radvol_spike_plugin, Lib.rave_scansun_quality_plugin.scansun_quality_plugin, and Lib.rave_zdiff_quality_plugin.rave_zdiff_quality_plugin.

The documentation for this class was generated from the following file:
Generated by doxygen 1.12.0