ppc_radar_options.h File Reference

Keeps one radar options setup This object does support #RAVE_OBJECT_CLONE. More...

#include "polarvolume.h"
#include "rave_data2d.h"

Go to the source code of this file.

Macros
#define	PpcRadarOptions_TH_CORR   (1)
	Used by PpcRadarOptions_setRequestedFields Add Corrected TH to result.
#define	PpcRadarOptions_ATT_TH_CORR   (1 << 1)
	Used by PpcRadarOptions_setRequestedFields Add Corrected and attenuated TH to result.
#define	PpcRadarOptions_DBZH_CORR   (1 << 2)
	Used by PpcRadarOptions_setRequestedFields Add Corrected DBZH to result.
#define	PpcRadarOptions_ATT_DBZH_CORR   (1 << 3)
	Used by PpcRadarOptions_setRequestedFields Add Corrected and attenuated DBZH to result.
#define	PpcRadarOptions_KDP_CORR   (1 << 4)
	Used by PpcRadarOptions_setRequestedFields Add Corrected KDP to result.
#define	PpcRadarOptions_RHOHV_CORR   (1 << 5)
	Used by PpcRadarOptions_setRequestedFields Add Corrected RHOHV to result.
#define	PpcRadarOptions_PHIDP_CORR   (1 << 6)
	Used by PpcRadarOptions_setRequestedFields Add Corrected PHIDP to result.
#define	PpcRadarOptions_ZDR_CORR   (1 << 7)
	Used by PpcRadarOptions_setRequestedFields Add Corrected ZDR to result.
#define	PpcRadarOptions_ZPHI_CORR   (1 << 8)
	Used by PpcRadarOptions_setRequestedFields Add Corrected ZPHI to result.
#define	PpcRadarOptions_QUALITY_RESIDUAL_CLUTTER_MASK   (1 << 9)
	Used by PpcRadarOptions_setRequestedFields Add quality flag for residual clutter flag.
#define	PpcRadarOptions_QUALITY_ATTENUATION_MASK   (1 << 10)
	Used by PpcRadarOptions_setRequestedFields Add quality flag for attenuation mask.
#define	PpcRadarOptions_QUALITY_ATTENUATION   (1 << 11)
	Used by PpcRadarOptions_setRequestedFields Add quality flag for actual attenuation.
#define	PpcRadarOptions_ATT_ZDR_CORR   (1 << 12)
	Used by PpcRadarOptions_setRequestedFields Add quality flag for actual attenuation.

Typedefs
typedef struct _PpcRadarOptions_t	PpcRadarOptions_t
	Defines a transformer.

Functions
int	PpcRadarOptions_setName (PpcRadarOptions_t *self, const char *name)
	Set the name of the owner of these options.
const char *	PpcRadarOptions_getName (PpcRadarOptions_t *self)
int	PpcRadarOptions_setDefaultName (PpcRadarOptions_t *self, const char *name)
	Sets the name of the default setting if there is one.
const char *	PpcRadarOptions_getDefaultName (PpcRadarOptions_t *self)
void	PpcRadarOptions_setRequestedFields (PpcRadarOptions_t *self, int fieldmask)
	Sets the field mask which should be bitwised ored from the PdpProcessor field defines For example: PpcRadarOptions_CORR_TH | PpcRadarOptions_CORR_KDP.
int	PpcRadarOptions_getRequestedFields (PpcRadarOptions_t *self)
int	PpcRadarOptions_setBand (PpcRadarOptions_t *self, char band)
	Helper function that sets kdpUp, kdpDown and kdpStdThreshold to predfined values.
void	PpcRadarOptions_setKdpUp (PpcRadarOptions_t *self, double v)
	Sets the upper threshold for the generated kdp field.
double	PpcRadarOptions_getKdpUp (PpcRadarOptions_t *self)
void	PpcRadarOptions_setKdpDown (PpcRadarOptions_t *self, double v)
	Sets the lower threshold for the generated kdp field.
double	PpcRadarOptions_getKdpDown (PpcRadarOptions_t *self)
void	PpcRadarOptions_setKdpStdThreshold (PpcRadarOptions_t *self, double v)
	Sets the kdp standard deviation threshold for the generated kdp field.
double	PpcRadarOptions_getKdpStdThreshold (PpcRadarOptions_t *self)
void	PpcRadarOptions_setBB (PpcRadarOptions_t *self, double v)
	Sets the BB value used in the zphi part of the pdp processing.
double	PpcRadarOptions_getBB (PpcRadarOptions_t *self)
void	PpcRadarOptions_setThresholdPhidp (PpcRadarOptions_t *self, double v)
	Sets the threshold for PHIDP in the pdp processing.
double	PpcRadarOptions_getThresholdPhidp (PpcRadarOptions_t *self)
void	PpcRadarOptions_setMinWindow (PpcRadarOptions_t *self, long window)
	Sets the min window size during pdp processing.
long	PpcRadarOptions_getMinWindow (PpcRadarOptions_t *self)
void	PpcRadarOptions_setPdpRWin1 (PpcRadarOptions_t *self, double v)
	Sets the pdp ray window 1 used in the pdp processing.
double	PpcRadarOptions_getPdpRWin1 (PpcRadarOptions_t *self)
void	PpcRadarOptions_setPdpRWin2 (PpcRadarOptions_t *self, double v)
	Sets the pdp ray window 2 used in the pdp processing.
double	PpcRadarOptions_getPdpRWin2 (PpcRadarOptions_t *self)
void	PpcRadarOptions_setPdpNrIterations (PpcRadarOptions_t *self, long v)
	Sets the number of iterations in pdp processing.
long	PpcRadarOptions_getPdpNrIterations (PpcRadarOptions_t *self)
void	PpcRadarOptions_getParametersUZ (PpcRadarOptions_t *self, double *weight, double *X2, double *X3, double *delta1, double *delta2)
	Gets the parameters used for the UZ parameter when performing the clutter ID.
void	PpcRadarOptions_setParametersUZ (PpcRadarOptions_t *self, double weight, double X2, double X3, double delta1, double delta2)
	Sets the parameters used for the UZ parameter when performing the clutter ID.
void	PpcRadarOptions_getParametersVEL (PpcRadarOptions_t *self, double *weight, double *X2, double *X3, double *delta1, double *delta2)
	Gets the parameters used for the VEL parameter when performing the clutter ID.
void	PpcRadarOptions_setParametersVEL (PpcRadarOptions_t *self, double weight, double X2, double X3, double delta1, double delta2)
	Sets the parameters used for the VEL parameter when performing the clutter ID.
void	PpcRadarOptions_getParametersTEXT_PHIDP (PpcRadarOptions_t *self, double *weight, double *X2, double *X3, double *delta1, double *delta2)
	Gets the parameters used for the TEXT_PHIDP parameter when performing the clutter ID.
void	PpcRadarOptions_setParametersTEXT_PHIDP (PpcRadarOptions_t *self, double weight, double X2, double X3, double delta1, double delta2)
	Sets the parameters used for the TEXT_PHIDP parameter when performing the clutter ID.
void	PpcRadarOptions_getParametersRHV (PpcRadarOptions_t *self, double *weight, double *X2, double *X3, double *delta1, double *delta2)
	Gets the parameters used for the RHV parameter when performing the clutter ID.
void	PpcRadarOptions_setParametersRHV (PpcRadarOptions_t *self, double weight, double X2, double X3, double delta1, double delta2)
	Sets the parameters used for the RHV parameter when performing the clutter ID.
void	PpcRadarOptions_getParametersTEXT_UZ (PpcRadarOptions_t *self, double *weight, double *X2, double *X3, double *delta1, double *delta2)
	Gets the parameters used for the TEXT_UZ parameter when performing the clutter ID.
void	PpcRadarOptions_setParametersTEXT_UZ (PpcRadarOptions_t *self, double weight, double X2, double X3, double delta1, double delta2)
	Sets the parameters used for the TEXT_UZ parameter when performing the clutter ID.
void	PpcRadarOptions_getParametersCLUTTER_MAP (PpcRadarOptions_t *self, double *weight, double *X2, double *X3, double *delta1, double *delta2)
	Gets the parameters used for the CLUTTER_MAP parameter when performing the clutter ID.
void	PpcRadarOptions_setParametersCLUTTER_MAP (PpcRadarOptions_t *self, double weight, double X2, double X3, double delta1, double delta2)
	Sets the parameters used for the CLUTTER_MAP parameter when performing the clutter ID.
void	PpcRadarOptions_setMeltingLayerBottomHeight (PpcRadarOptions_t *self, double height)
	Sets the melting layer bottom height.
double	PpcRadarOptions_getMeltingLayerBottomHeight (PpcRadarOptions_t *self)
void	PpcRadarOptions_setMeltingLayerHourThreshold (PpcRadarOptions_t *self, long hours)
	Sets the number of hours before default height should be used.
long	PpcRadarOptions_getMeltingLayerHourThreshold (PpcRadarOptions_t *self)
void	PpcRadarOptions_setNodata (PpcRadarOptions_t *self, double nodata)
	Sets the nodata value to be used in most sub-products.
double	PpcRadarOptions_getNodata (PpcRadarOptions_t *self)
void	PpcRadarOptions_setMinDBZ (PpcRadarOptions_t *self, double minv)
	Sets the min DBZ threshold to be used in the clutter correction.
double	PpcRadarOptions_getMinDBZ (PpcRadarOptions_t *self)
void	PpcRadarOptions_setQualityThreshold (PpcRadarOptions_t *self, double minv)
	The quality threshold that should be used in the clutter correction.
double	PpcRadarOptions_getQualityThreshold (PpcRadarOptions_t *self)
void	PpcRadarOptions_setPreprocessZThreshold (PpcRadarOptions_t *self, double minv)
	A preprocessing min threshold before the actual processing begins.
double	PpcRadarOptions_getPreprocessZThreshold (PpcRadarOptions_t *self)
void	PpcRadarOptions_setResidualMinZClutterThreshold (PpcRadarOptions_t *self, double minv)
	The residual min z clutter threshold that should be used in the residual clutter filter process.
double	PpcRadarOptions_getResidualMinZClutterThreshold (PpcRadarOptions_t *self)
void	PpcRadarOptions_setResidualThresholdZ (PpcRadarOptions_t *self, double minv)
	The residual min Z threshold in the residual clutter filtering.
double	PpcRadarOptions_getResidualThresholdZ (PpcRadarOptions_t *self)
void	PpcRadarOptions_setResidualThresholdTexture (PpcRadarOptions_t *self, double minv)
	The texture threshold in the residual clutter filtering.
double	PpcRadarOptions_getResidualThresholdTexture (PpcRadarOptions_t *self)
void	PpcRadarOptions_setResidualClutterNodata (PpcRadarOptions_t *self, double v)
	The nodata value to be used when creating the residual clutter image used for creating the mask.
double	PpcRadarOptions_getResidualClutterNodata (PpcRadarOptions_t *self)
void	PpcRadarOptions_setResidualClutterMaskNodata (PpcRadarOptions_t *self, double v)
	The nodata value for the residual clutter mask.
double	PpcRadarOptions_getResidualClutterMaskNodata (PpcRadarOptions_t *self)
void	PpcRadarOptions_setResidualClutterTextureFilteringMaxZ (PpcRadarOptions_t *self, double v)
	The max Z value when creating the residual clutter mask, anything higher will be set to min value.
double	PpcRadarOptions_getResidualClutterTextureFilteringMaxZ (PpcRadarOptions_t *self)
void	PpcRadarOptions_setResidualFilterBinSize (PpcRadarOptions_t *self, long v)
	The number of bins used in the window when creating the residual mask.
long	PpcRadarOptions_getResidualFilterBinSize (PpcRadarOptions_t *self)
void	PpcRadarOptions_setResidualFilterRaySize (PpcRadarOptions_t *self, long v)
	The number of rays used in the window when creating the residual mask.
long	PpcRadarOptions_getResidualFilterRaySize (PpcRadarOptions_t *self)
void	PpcRadarOptions_setMinZMedfilterThreshold (PpcRadarOptions_t *self, double v)
	The min z threshold used in the median filter that is used by the residual clutter filter.
double	PpcRadarOptions_getMinZMedfilterThreshold (PpcRadarOptions_t *self)
void	PpcRadarOptions_setProcessingTextureThreshold (PpcRadarOptions_t *self, double v)
	The threshold for the texture created in the pdp processing.
double	PpcRadarOptions_getProcessingTextureThreshold (PpcRadarOptions_t *self)
void	PpcRadarOptions_setMinAttenuationMaskRHOHV (PpcRadarOptions_t *self, double v)
	The min RHOHV value for marking value as 1 in the attenuation mask.
double	PpcRadarOptions_getMinAttenuationMaskRHOHV (PpcRadarOptions_t *self)
void	PpcRadarOptions_setMinAttenuationMaskKDP (PpcRadarOptions_t *self, double v)
	The min KDP value for marking value as 1 in the attenuation mask.
double	PpcRadarOptions_getMinAttenuationMaskKDP (PpcRadarOptions_t *self)
void	PpcRadarOptions_setMinAttenuationMaskTH (PpcRadarOptions_t *self, double v)
	The min TH value for marking value as 1 in the attenuation mask.
double	PpcRadarOptions_getMinAttenuationMaskTH (PpcRadarOptions_t *self)
void	PpcRadarOptions_setAttenuationGammaH (PpcRadarOptions_t *self, double v)
	The gamma h value used in the attenuation.
double	PpcRadarOptions_getAttenuationGammaH (PpcRadarOptions_t *self)
void	PpcRadarOptions_setAttenuationAlpha (PpcRadarOptions_t *self, double v)
	The alpha value used in the attenuation.
double	PpcRadarOptions_getAttenuationAlpha (PpcRadarOptions_t *self)
void	PpcRadarOptions_setAttenuationPIAminZ (PpcRadarOptions_t *self, double v)
	The min PIA Z value in attenuation process.
double	PpcRadarOptions_getAttenuationPIAminZ (PpcRadarOptions_t *self)
void	PpcRadarOptions_setInvertPHIDP (PpcRadarOptions_t *self, int v)
	Sets if the PHIDP should be inverted (multiplied with -1) or not.
int	PpcRadarOptions_getInvertPHIDP (PpcRadarOptions_t *self)
	Returns if the PHIDP should be inverted (multiplied with -1) or not.

Variables
RaveCoreObjectType	PpcRadarOptions_TYPE
	Type definition to use when creating a rave object.

Detailed Description

Keeps one radar options setup This object does support #RAVE_OBJECT_CLONE.

Author

Anders Henja (Swedish Meteorological and Hydrological Institute, SMHI)

Date

2019-05-13

Macro Definition Documentation

PpcRadarOptions_ATT_DBZH_CORR

#define PpcRadarOptions_ATT_DBZH_CORR   (1 << 3)

Used by PpcRadarOptions_setRequestedFields Add Corrected and attenuated DBZH to result.

PpcRadarOptions_ATT_TH_CORR

#define PpcRadarOptions_ATT_TH_CORR   (1 << 1)

Used by PpcRadarOptions_setRequestedFields Add Corrected and attenuated TH to result.

PpcRadarOptions_ATT_ZDR_CORR

#define PpcRadarOptions_ATT_ZDR_CORR   (1 << 12)

Used by PpcRadarOptions_setRequestedFields Add quality flag for actual attenuation.

PpcRadarOptions_DBZH_CORR

#define PpcRadarOptions_DBZH_CORR   (1 << 2)

Used by PpcRadarOptions_setRequestedFields Add Corrected DBZH to result.

PpcRadarOptions_KDP_CORR

#define PpcRadarOptions_KDP_CORR   (1 << 4)

Used by PpcRadarOptions_setRequestedFields Add Corrected KDP to result.

PpcRadarOptions_PHIDP_CORR

#define PpcRadarOptions_PHIDP_CORR   (1 << 6)

Used by PpcRadarOptions_setRequestedFields Add Corrected PHIDP to result.

PpcRadarOptions_QUALITY_ATTENUATION

#define PpcRadarOptions_QUALITY_ATTENUATION   (1 << 11)

Used by PpcRadarOptions_setRequestedFields Add quality flag for actual attenuation.

PpcRadarOptions_QUALITY_ATTENUATION_MASK

#define PpcRadarOptions_QUALITY_ATTENUATION_MASK   (1 << 10)

Used by PpcRadarOptions_setRequestedFields Add quality flag for attenuation mask.

PpcRadarOptions_QUALITY_RESIDUAL_CLUTTER_MASK

#define PpcRadarOptions_QUALITY_RESIDUAL_CLUTTER_MASK   (1 << 9)

Used by PpcRadarOptions_setRequestedFields Add quality flag for residual clutter flag.

PpcRadarOptions_RHOHV_CORR

#define PpcRadarOptions_RHOHV_CORR   (1 << 5)

Used by PpcRadarOptions_setRequestedFields Add Corrected RHOHV to result.

PpcRadarOptions_TH_CORR

#define PpcRadarOptions_TH_CORR   (1)

Used by PpcRadarOptions_setRequestedFields Add Corrected TH to result.

PpcRadarOptions_ZDR_CORR

#define PpcRadarOptions_ZDR_CORR   (1 << 7)

Used by PpcRadarOptions_setRequestedFields Add Corrected ZDR to result.

PpcRadarOptions_ZPHI_CORR

#define PpcRadarOptions_ZPHI_CORR   (1 << 8)

Used by PpcRadarOptions_setRequestedFields Add Corrected ZPHI to result.

Typedef Documentation

PpcRadarOptions_t

typedef struct _PpcRadarOptions_t PpcRadarOptions_t

Defines a transformer.

Function Documentation

PpcRadarOptions_getAttenuationAlpha()

double PpcRadarOptions_getAttenuationAlpha

(

PpcRadarOptions_t *

self

)

Returns

the alpha value used in the attenuation

Parameters

[in]

self

- self

PpcRadarOptions_getAttenuationGammaH()

double PpcRadarOptions_getAttenuationGammaH

(

PpcRadarOptions_t *

self

)

Returns

the gamma h value used in the attenuation

Parameters

[in]

self

- self

PpcRadarOptions_getAttenuationPIAminZ()

double PpcRadarOptions_getAttenuationPIAminZ

(

PpcRadarOptions_t *

self

)

Returns

the min PIA Z value in attenuation process

Parameters

[in]

self

- self

PpcRadarOptions_getBB()

double PpcRadarOptions_getBB

(

PpcRadarOptions_t *

self

)

Returns

the BB value used in the zphi part of the pdp processing

Parameters

[in]

self

- selfPpcRadarOptions_TH_CORR_ATT

PpcRadarOptions_getDefaultName()

const char * PpcRadarOptions_getDefaultName

(

PpcRadarOptions_t *

self

)

Returns

the name of the default setting if there is any

Parameters

[in]

self

- self

PpcRadarOptions_getInvertPHIDP()

int PpcRadarOptions_getInvertPHIDP

(

PpcRadarOptions_t *

self

)

Returns if the PHIDP should be inverted (multiplied with -1) or not.

Typically this can be needed if the RSP produces inverted values.

Parameters

[in]

self

- self returns 0 If PHIDP not should be inverted and 1 if PHIDP should be inverted. Default is 0.

PpcRadarOptions_getKdpDown()

double PpcRadarOptions_getKdpDown

(

PpcRadarOptions_t *

self

)

Returns

the kdp lower threshold

Parameters

[in]

self

- self

PpcRadarOptions_getKdpStdThreshold()

double PpcRadarOptions_getKdpStdThreshold

(

PpcRadarOptions_t *

self

)

Returns

the kdp standard deviation threshold

Parameters

[in]

self

- self

PpcRadarOptions_getKdpUp()

double PpcRadarOptions_getKdpUp

(

PpcRadarOptions_t *

self

)

Returns

the kdp upper threshold

Parameters

[in]

self

- self

PpcRadarOptions_getMeltingLayerBottomHeight()

double PpcRadarOptions_getMeltingLayerBottomHeight

(

PpcRadarOptions_t *

self

)

Returns

the bottom melting layer height for the specified scan

Parameters

[in]

self

- self

PpcRadarOptions_getMeltingLayerHourThreshold()

long PpcRadarOptions_getMeltingLayerHourThreshold

(

PpcRadarOptions_t *

self

)

Returns

the number of hours before default height should be used.

Parameters

[in]

self

- self

PpcRadarOptions_getMinAttenuationMaskKDP()

double PpcRadarOptions_getMinAttenuationMaskKDP

(

PpcRadarOptions_t *

self

)

Returns

the min KDP value for marking value as 1 in the attenuation mask

Parameters

[in]

self

- self

PpcRadarOptions_getMinAttenuationMaskRHOHV()

double PpcRadarOptions_getMinAttenuationMaskRHOHV

(

PpcRadarOptions_t *

self

)

Returns

the min RHOHV value for marking value as 1 in the attenuation mask

Parameters

[in]

self

- self

PpcRadarOptions_getMinAttenuationMaskTH()

double PpcRadarOptions_getMinAttenuationMaskTH

(

PpcRadarOptions_t *

self

)

Returns

the min TH value for marking value as 1 in the attenuation mask

Parameters

[in]

self

- self

PpcRadarOptions_getMinDBZ()

double PpcRadarOptions_getMinDBZ

(

PpcRadarOptions_t *

self

)

Returns

the min DBZ threshold that is used in the clutter correction

Parameters

[in]

self

- self

PpcRadarOptions_getMinWindow()

long PpcRadarOptions_getMinWindow

(

PpcRadarOptions_t *

self

)

Returns

the min window size for the pdp processing

Parameters

[in]

self

- self

PpcRadarOptions_getMinZMedfilterThreshold()

double PpcRadarOptions_getMinZMedfilterThreshold

(

PpcRadarOptions_t *

self

)

Returns

the min z threshold used in the median filter that is used by the residual clutter filter

Parameters

[in]

self

- self

PpcRadarOptions_getName()

const char * PpcRadarOptions_getName

(

PpcRadarOptions_t *

self

)

Returns

the name of the owner of these options

Parameters

[in]

self

- self

PpcRadarOptions_getNodata()

double PpcRadarOptions_getNodata

(

PpcRadarOptions_t *

self

)

Returns

the nodata value used in most products

Parameters

[in]

self

- self

PpcRadarOptions_getParametersCLUTTER_MAP()

void PpcRadarOptions_getParametersCLUTTER_MAP	(	PpcRadarOptions_t *	self,
		double *	weight,
		double *	X2,
		double *	X3,
		double *	delta1,
		double *	delta2 )

Gets the parameters used for the CLUTTER_MAP parameter when performing the clutter ID.

Parameters

[in]	self	- self
[out]	weight	- the weight
[out]	X2	- the X2 value
[out]	X3	- the X3 value
[out]	delta1	- delta 1
[out]	delta2	- delta 2

PpcRadarOptions_getParametersRHV()

void PpcRadarOptions_getParametersRHV	(	PpcRadarOptions_t *	self,
		double *	weight,
		double *	X2,
		double *	X3,
		double *	delta1,
		double *	delta2 )

Gets the parameters used for the RHV parameter when performing the clutter ID.

Parameters

[in]	self	- self
[out]	weight	- the weight
[out]	X2	- the X2 value
[out]	X3	- the X3 value
[out]	delta1	- delta 1
[out]	delta2	- delta 2

PpcRadarOptions_getParametersTEXT_PHIDP()

void PpcRadarOptions_getParametersTEXT_PHIDP	(	PpcRadarOptions_t *	self,
		double *	weight,
		double *	X2,
		double *	X3,
		double *	delta1,
		double *	delta2 )

Gets the parameters used for the TEXT_PHIDP parameter when performing the clutter ID.

Parameters

[in]	self	- self
[out]	weight	- the weight
[out]	X2	- the X2 value
[out]	X3	- the X3 value
[out]	delta1	- delta 1
[out]	delta2	- delta 2

PpcRadarOptions_getParametersTEXT_UZ()

void PpcRadarOptions_getParametersTEXT_UZ	(	PpcRadarOptions_t *	self,
		double *	weight,
		double *	X2,
		double *	X3,
		double *	delta1,
		double *	delta2 )

Gets the parameters used for the TEXT_UZ parameter when performing the clutter ID.

Parameters

[in]	self	- self
[out]	weight	- the weight
[out]	X2	- the X2 value
[out]	X3	- the X3 value
[out]	delta1	- delta 1
[out]	delta2	- delta 2

PpcRadarOptions_getParametersUZ()

void PpcRadarOptions_getParametersUZ	(	PpcRadarOptions_t *	self,
		double *	weight,
		double *	X2,
		double *	X3,
		double *	delta1,
		double *	delta2 )

Gets the parameters used for the UZ parameter when performing the clutter ID.

Parameters

[in]	self	- self
[out]	weight	- the weight
[out]	X2	- the X2 value
[out]	X3	- the X3 value
[out]	delta1	- delta 1
[out]	delta2	- delta 2

PpcRadarOptions_getParametersVEL()

void PpcRadarOptions_getParametersVEL	(	PpcRadarOptions_t *	self,
		double *	weight,
		double *	X2,
		double *	X3,
		double *	delta1,
		double *	delta2 )

Gets the parameters used for the VEL parameter when performing the clutter ID.

Parameters

[in]	self	- self
[out]	weight	- the weight
[out]	X2	- the X2 value
[out]	X3	- the X3 value
[out]	delta1	- delta 1
[out]	delta2	- delta 2

PpcRadarOptions_getPdpNrIterations()

long PpcRadarOptions_getPdpNrIterations

(

PpcRadarOptions_t *

self

)

Returns

the number of iterations in pdp processing

Parameters

[in]

self

- self

PpcRadarOptions_getPdpRWin1()

double PpcRadarOptions_getPdpRWin1

(

PpcRadarOptions_t *

self

)

Returns

the pdp ray window 1 used in the pdp processing

Parameters

[in]

self

- self

PpcRadarOptions_getPdpRWin2()

double PpcRadarOptions_getPdpRWin2

(

PpcRadarOptions_t *

self

)

Returns

the pdp ray window 2 used in the pdp processing

Parameters

[in]

self

- self

PpcRadarOptions_getPreprocessZThreshold()

double PpcRadarOptions_getPreprocessZThreshold

(

PpcRadarOptions_t *

self

)

Returns

the preprocessing min threshold before the actual processing begins. Defaults at -20.0

Parameters

[in]

self

- self

PpcRadarOptions_getProcessingTextureThreshold()

double PpcRadarOptions_getProcessingTextureThreshold

(

PpcRadarOptions_t *

self

)

Returns

the threshold for the texture created in the pdp processing

Parameters

[in]

self

- self

PpcRadarOptions_getQualityThreshold()

double PpcRadarOptions_getQualityThreshold

(

PpcRadarOptions_t *

self

)

Returns

the quality threshold that is used in the clutter correction.

Parameters

[in]

self

- self

PpcRadarOptions_getRequestedFields()

int PpcRadarOptions_getRequestedFields

(

PpcRadarOptions_t *

self

)

Parameters

[in]

self

- self

Returns

the field mask

PpcRadarOptions_getResidualClutterMaskNodata()

double PpcRadarOptions_getResidualClutterMaskNodata

(

PpcRadarOptions_t *

self

)

Returns

the nodata value for the residual clutter mask

Parameters

[in]

self

- self

PpcRadarOptions_getResidualClutterNodata()

double PpcRadarOptions_getResidualClutterNodata

(

PpcRadarOptions_t *

self

)

Returns

the nodata value to be used when creating the residual clutter image used for creating the mask

Parameters

[in]

self

- self

PpcRadarOptions_getResidualClutterTextureFilteringMaxZ()

double PpcRadarOptions_getResidualClutterTextureFilteringMaxZ

(

PpcRadarOptions_t *

self

)

Returns

the max Z value when creating the residual clutter mask, anything higher will be set to min value

Parameters

[in]

self

- self

PpcRadarOptions_getResidualFilterBinSize()

long PpcRadarOptions_getResidualFilterBinSize

(

PpcRadarOptions_t *

self

)

Returns

the number of bins used in the window when creating the residual mask

Parameters

[in]

self

- self

PpcRadarOptions_getResidualFilterRaySize()

long PpcRadarOptions_getResidualFilterRaySize

(

PpcRadarOptions_t *

self

)

Returns

the number of rays used in the window when creating the residual mask

Parameters

[in]

self

- self

PpcRadarOptions_getResidualMinZClutterThreshold()

double PpcRadarOptions_getResidualMinZClutterThreshold

(

PpcRadarOptions_t *

self

)

Returns

the residual min z clutter threshold that should be used in the residual clutter filter process.

Parameters

[in]

self

- self

PpcRadarOptions_getResidualThresholdTexture()

double PpcRadarOptions_getResidualThresholdTexture

(

PpcRadarOptions_t *

self

)

Returns

the texture threshold in the residual clutter filtering

Parameters

[in]

self

- self

PpcRadarOptions_getResidualThresholdZ()

double PpcRadarOptions_getResidualThresholdZ

(

PpcRadarOptions_t *

self

)

Returns

the min Z threshold in the residual clutter filtering

Parameters

[in]

self

- self

PpcRadarOptions_getThresholdPhidp()

double PpcRadarOptions_getThresholdPhidp

(

PpcRadarOptions_t *

self

)

Returns

the threshold for PHIDP in the pdp processing

Parameters

[in]

self

- self

PpcRadarOptions_setAttenuationAlpha()

void PpcRadarOptions_setAttenuationAlpha	(	PpcRadarOptions_t *	self,
		double	v )

The alpha value used in the attenuation.

Parameters

[in]	self	- self
[in]	v	- the value

PpcRadarOptions_setAttenuationGammaH()

void PpcRadarOptions_setAttenuationGammaH	(	PpcRadarOptions_t *	self,
		double	v )

The gamma h value used in the attenuation.

Parameters

[in]	self	- self
[in]	v	- the value

PpcRadarOptions_setAttenuationPIAminZ()

void PpcRadarOptions_setAttenuationPIAminZ	(	PpcRadarOptions_t *	self,
		double	v )

The min PIA Z value in attenuation process.

Parameters

[in]	self	- self
[in]	v	- the value

PpcRadarOptions_setBand()

int PpcRadarOptions_setBand	(	PpcRadarOptions_t *	self,
		char	band )

Helper function that sets kdpUp, kdpDown and kdpStdThreshold to predfined values.

band = 's' => kdpUp = 14, kdpDown=-2, kdpStdThreshold=5 band = 'c' => kdpUp = 20, kdpDown=-2, kdpStdThreshold=5 band = 'x' => kdpUp = 40, kdpDown=-2, kdpStdThreshold=5

Parameters

[in]	self	- self
[in]	band	- the band, see above

Returns

1 if band is either 's', 'c' or 'x' else 0 and kdp-values will not be changed.

PpcRadarOptions_setBB()

void PpcRadarOptions_setBB	(	PpcRadarOptions_t *	self,
		double	v )

Sets the BB value used in the zphi part of the pdp processing.

Parameters

[in]	self	- self
[in]	v	- the value

PpcRadarOptions_setDefaultName()

int PpcRadarOptions_setDefaultName	(	PpcRadarOptions_t *	self,
		const char *	name )

Sets the name of the default setting if there is one.

Parameters

[in]	self	- self
[in]	name	- the name of the default setting

Returns

1 on success otherwise 0

PpcRadarOptions_setInvertPHIDP()

void PpcRadarOptions_setInvertPHIDP	(	PpcRadarOptions_t *	self,
		int	v )

Sets if the PHIDP should be inverted (multiplied with -1) or not.

Typically this can be needed if the RSP produces inverted values.

Parameters

[in]	self	- self
[in]	v	- 0 If PHIDP not should be inverted and 1 if PHIDP should be inverted.

PpcRadarOptions_setKdpDown()

void PpcRadarOptions_setKdpDown	(	PpcRadarOptions_t *	self,
		double	v )

Sets the lower threshold for the generated kdp field.

Parameters

[in]	self	- self
[in]	v	- the lower threshold

PpcRadarOptions_setKdpStdThreshold()

void PpcRadarOptions_setKdpStdThreshold	(	PpcRadarOptions_t *	self,
		double	v )

Sets the kdp standard deviation threshold for the generated kdp field.

Parameters

[in]	self	- self
[in]	v	- the threshold

PpcRadarOptions_setKdpUp()

void PpcRadarOptions_setKdpUp	(	PpcRadarOptions_t *	self,
		double	v )

Sets the upper threshold for the generated kdp field.

Parameters

[in]	self	- self
[in]	v	- the upper threshold

PpcRadarOptions_setMeltingLayerBottomHeight()

void PpcRadarOptions_setMeltingLayerBottomHeight	(	PpcRadarOptions_t *	self,
		double	height )

Sets the melting layer bottom height.

Parameters

[in]	self	- self
[in]	height	- the height in km

PpcRadarOptions_setMeltingLayerHourThreshold()

void PpcRadarOptions_setMeltingLayerHourThreshold	(	PpcRadarOptions_t *	self,
		long	hours )

Sets the number of hours before default height should be used.

Parameters

[in]	self	- self
[in]	hours	- number of hours

PpcRadarOptions_setMinAttenuationMaskKDP()

void PpcRadarOptions_setMinAttenuationMaskKDP	(	PpcRadarOptions_t *	self,
		double	v )

The min KDP value for marking value as 1 in the attenuation mask.

Parameters

[in]	self	- self
[in]	v	- the value

PpcRadarOptions_setMinAttenuationMaskRHOHV()

void PpcRadarOptions_setMinAttenuationMaskRHOHV	(	PpcRadarOptions_t *	self,
		double	v )

The min RHOHV value for marking value as 1 in the attenuation mask.

Parameters

[in]	self	- self
[in]	v	- the value

PpcRadarOptions_setMinAttenuationMaskTH()

void PpcRadarOptions_setMinAttenuationMaskTH	(	PpcRadarOptions_t *	self,
		double	v )

The min TH value for marking value as 1 in the attenuation mask.

Parameters

[in]	self	- self
[in]	v	- the value

PpcRadarOptions_setMinDBZ()

void PpcRadarOptions_setMinDBZ	(	PpcRadarOptions_t *	self,
		double	minv )

Sets the min DBZ threshold to be used in the clutter correction.

Parameters

[in]	self	- self
[in]	minv	- the min dbz threshold

PpcRadarOptions_setMinWindow()

void PpcRadarOptions_setMinWindow	(	PpcRadarOptions_t *	self,
		long	window )

Sets the min window size during pdp processing.

Parameters

[in]	self	- self
[in]	window	- the window

PpcRadarOptions_setMinZMedfilterThreshold()

void PpcRadarOptions_setMinZMedfilterThreshold	(	PpcRadarOptions_t *	self,
		double	v )

The min z threshold used in the median filter that is used by the residual clutter filter.

Parameters

[in]	self	- self
[in]	v	- the value

PpcRadarOptions_setName()

int PpcRadarOptions_setName	(	PpcRadarOptions_t *	self,
		const char *	name )

Set the name of the owner of these options.

Parameters

[in]	self	- self
[in]	name	- the name of the owner

Returns

1 on success otherwise 0

PpcRadarOptions_setNodata()

void PpcRadarOptions_setNodata	(	PpcRadarOptions_t *	self,
		double	nodata )

Sets the nodata value to be used in most sub-products.

Parameters

[in]	self	- self
[in]	nodata	- the nodata value

PpcRadarOptions_setParametersCLUTTER_MAP()

void PpcRadarOptions_setParametersCLUTTER_MAP	(	PpcRadarOptions_t *	self,
		double	weight,
		double	X2,
		double	X3,
		double	delta1,
		double	delta2 )

Sets the parameters used for the CLUTTER_MAP parameter when performing the clutter ID.

Parameters

[in]	self	- self
[in]	weight	- the weight
[in]	X2	- the X2 value
[in]	X3	- the X3 value
[in]	delta1	- delta 1
[in]	delta2	- delta 2

PpcRadarOptions_setParametersRHV()

void PpcRadarOptions_setParametersRHV	(	PpcRadarOptions_t *	self,
		double	weight,
		double	X2,
		double	X3,
		double	delta1,
		double	delta2 )

Sets the parameters used for the RHV parameter when performing the clutter ID.

Parameters

[in]	self	- self
[in]	weight	- the weight
[in]	X2	- the X2 value
[in]	X3	- the X3 value
[in]	delta1	- delta 1
[in]	delta2	- delta 2

PpcRadarOptions_setParametersTEXT_PHIDP()

void PpcRadarOptions_setParametersTEXT_PHIDP	(	PpcRadarOptions_t *	self,
		double	weight,
		double	X2,
		double	X3,
		double	delta1,
		double	delta2 )

Sets the parameters used for the TEXT_PHIDP parameter when performing the clutter ID.

Parameters

[in]	self	- self
[in]	weight	- the weight
[in]	X2	- the X2 value
[in]	X3	- the X3 value
[in]	delta1	- delta 1
[in]	delta2	- delta 2

PpcRadarOptions_setParametersTEXT_UZ()

void PpcRadarOptions_setParametersTEXT_UZ	(	PpcRadarOptions_t *	self,
		double	weight,
		double	X2,
		double	X3,
		double	delta1,
		double	delta2 )

Sets the parameters used for the TEXT_UZ parameter when performing the clutter ID.

Parameters

[in]	self	- self
[in]	weight	- the weight
[in]	X2	- the X2 value
[in]	X3	- the X3 value
[in]	delta1	- delta 1
[in]	delta2	- delta 2

PpcRadarOptions_setParametersUZ()

void PpcRadarOptions_setParametersUZ	(	PpcRadarOptions_t *	self,
		double	weight,
		double	X2,
		double	X3,
		double	delta1,
		double	delta2 )

Sets the parameters used for the UZ parameter when performing the clutter ID.

Parameters

[in]	self	- self
[in]	weight	- the weight
[in]	X2	- the X2 value
[in]	X3	- the X3 value
[in]	delta1	- delta 1
[in]	delta2	- delta 2

PpcRadarOptions_setParametersVEL()

void PpcRadarOptions_setParametersVEL	(	PpcRadarOptions_t *	self,
		double	weight,
		double	X2,
		double	X3,
		double	delta1,
		double	delta2 )

Sets the parameters used for the VEL parameter when performing the clutter ID.

Parameters

[in]	self	- self
[in]	weight	- the weight
[in]	X2	- the X2 value
[in]	X3	- the X3 value
[in]	delta1	- delta 1
[in]	delta2	- delta 2

PpcRadarOptions_setPdpNrIterations()

void PpcRadarOptions_setPdpNrIterations	(	PpcRadarOptions_t *	self,
		long	v )

Sets the number of iterations in pdp processing.

Parameters

[in]	self	- self
[in]	v	- the value

PpcRadarOptions_setPdpRWin1()

void PpcRadarOptions_setPdpRWin1	(	PpcRadarOptions_t *	self,
		double	v )

Sets the pdp ray window 1 used in the pdp processing.

Parameters

[in]	self	- self
[in]	v	- the value

PpcRadarOptions_setPdpRWin2()

void PpcRadarOptions_setPdpRWin2	(	PpcRadarOptions_t *	self,
		double	v )

Sets the pdp ray window 2 used in the pdp processing.

Parameters

[in]	self	- self
[in]	v	- the value

PpcRadarOptions_setPreprocessZThreshold()

void PpcRadarOptions_setPreprocessZThreshold	(	PpcRadarOptions_t *	self,
		double	minv )

A preprocessing min threshold before the actual processing begins.

Defaults at -20.0

Parameters

[in]	self	- self
[in]	minv	- the threshold

PpcRadarOptions_setProcessingTextureThreshold()

void PpcRadarOptions_setProcessingTextureThreshold	(	PpcRadarOptions_t *	self,
		double	v )

The threshold for the texture created in the pdp processing.

Parameters

[in]	self	- self
[in]	v	- the value

PpcRadarOptions_setQualityThreshold()

void PpcRadarOptions_setQualityThreshold	(	PpcRadarOptions_t *	self,
		double	minv )

The quality threshold that should be used in the clutter correction.

Parameters

[in]	self	- self
[in]	minv	- the threshold

PpcRadarOptions_setRequestedFields()

void PpcRadarOptions_setRequestedFields	(	PpcRadarOptions_t *	self,
		int	fieldmask )

Sets the field mask which should be bitwised ored from the PdpProcessor field defines For example: PpcRadarOptions_CORR_TH | PpcRadarOptions_CORR_KDP.

Parameters

[in]	self	- self
[in]	fieldmask	- the bit mask

PpcRadarOptions_setResidualClutterMaskNodata()

void PpcRadarOptions_setResidualClutterMaskNodata	(	PpcRadarOptions_t *	self,
		double	v )

The nodata value for the residual clutter mask.

Parameters

[in]	self	- self
[in]	v	- the value

PpcRadarOptions_setResidualClutterNodata()

void PpcRadarOptions_setResidualClutterNodata	(	PpcRadarOptions_t *	self,
		double	v )

The nodata value to be used when creating the residual clutter image used for creating the mask.

Parameters

[in]	self	- self
[in]	v	- the value

PpcRadarOptions_setResidualClutterTextureFilteringMaxZ()

void PpcRadarOptions_setResidualClutterTextureFilteringMaxZ	(	PpcRadarOptions_t *	self,
		double	v )

The max Z value when creating the residual clutter mask, anything higher will be set to min value.

Parameters

[in]	self	- self
[in]	v	- the value

PpcRadarOptions_setResidualFilterBinSize()

void PpcRadarOptions_setResidualFilterBinSize	(	PpcRadarOptions_t *	self,
		long	v )

The number of bins used in the window when creating the residual mask.

Parameters

[in]	self	- self
[in]	v	- the value

PpcRadarOptions_setResidualFilterRaySize()

void PpcRadarOptions_setResidualFilterRaySize	(	PpcRadarOptions_t *	self,
		long	v )

The number of rays used in the window when creating the residual mask.

Parameters

[in]	self	- self
[in]	v	- the value

PpcRadarOptions_setResidualMinZClutterThreshold()

void PpcRadarOptions_setResidualMinZClutterThreshold	(	PpcRadarOptions_t *	self,
		double	minv )

The residual min z clutter threshold that should be used in the residual clutter filter process.

Parameters

[in]	self	- self
[in]	minv	- the threshold

PpcRadarOptions_setResidualThresholdTexture()

void PpcRadarOptions_setResidualThresholdTexture	(	PpcRadarOptions_t *	self,
		double	minv )

The texture threshold in the residual clutter filtering.

Parameters

[in]	self	- self
[in]	minv	- the threshold

PpcRadarOptions_setResidualThresholdZ()

void PpcRadarOptions_setResidualThresholdZ	(	PpcRadarOptions_t *	self,
		double	minv )

The residual min Z threshold in the residual clutter filtering.

Parameters

[in]	self	- self
[in]	minv	- the threshold

PpcRadarOptions_setThresholdPhidp()

void PpcRadarOptions_setThresholdPhidp	(	PpcRadarOptions_t *	self,
		double	v )

Sets the threshold for PHIDP in the pdp processing.

Parameters

[in]	self	- self
[in]	v	- the threshold

Variable Documentation

PpcRadarOptions_TYPE

RaveCoreObjectType PpcRadarOptions_TYPE

extern

Type definition to use when creating a rave object.