CAPPI and Pseudo-CAPPI: the constant altitude planar position indicator product. More...

#include <CappiOp.h>

Inheritance diagram for CappiOp:

[legend]

Collaboration diagram for CappiOp:

[legend]

Public Member Functions
	CappiOp (double altitude=1000.0, bool aboveSeaLevel=true, double beamWidth=1.0, double weightMin=-0.1, std::string accumulationMethod="WAVG:1:8:-40")
	Pseudo-CAPPI: the constant altitude planar position indicator.

	CappiOp (const CappiOp &op)
	Copy constructor.

void	processData (const Data< PolarSrc > &data, RadarAccumulator< Accumulator, PolarODIM > &accumulator) const override

virtual const std::string &	getOutputQuantity (const std::string &inputQuantity="") const override
	Returns the primary output quantity (ODIM `what:quantity` , like DBZH)

Public Member Functions inherited from CumulativeProductOp
virtual void	computeSingleProduct (const DataSetMap< PolarSrc > &srcSweeps, DataSet< PolarDst > &dstProduct) const

Public Member Functions inherited from PolarProductOp
	PolarProductOp (const std::string &name=__FUNCTION__, const std::string &description="")

	PolarProductOp (const PolarProductOp &op)

Public Member Functions inherited from VolumeOp< PolarODIM >
	VolumeOp (const std::string &name, const std::string &description="")

virtual Hi5Tree &	processVolume (const Hi5Tree &srcRoot, Hi5Tree &dstRoot) const final
	Traverse through given volume and create new, processed data (volume or polar product).

Public Member Functions inherited from RadarProductOp< MS, MD >
	RadarProductOp (const std::string &name, const std::string &description)
	Default constructor.

	RadarProductOp (const RadarProductOp &product)

virtual void	processH5 (const Hi5Tree &src, Hi5Tree &dst) const

virtual void	computeSingleProduct (const DataSetMap< src_t > &srcSweeps, DataSet< dst_t > &dstProduct) const
	Traverse the data applicable for this product and create new, processed data (volume or polar product).

virtual void	processDataSet (const DataSet< src_t > &srcSweep, DataSet< DstType< MD > > &dstProduct) const
	Process the data of a single sweep and and write the result to given product.

virtual void	processData (const Data< src_t > &srcData, Data< dst_t > &dstData) const

Public Member Functions inherited from ProductBase
const std::string &	getLastArguments () const

virtual	~ProductBase ()
	Destructor.

void	setDataSelector (const DataSelector &selector)
	Copies the conditions of another selector.

const DataSelector &	getDataSelector () const
	Returns the data selector of this operator.

DataSelector &	getDataSelector ()
	Returns the data selector of this operator.

void	help (std::ostream &ostr=std::cout, bool showDescription=true) const
	Dumps the help of this operator.

const drain::ReferenceMap &	getAllowedEncoding () const
	Returns a map of encoding parameters that can be changed by the user.

virtual void	setEncodingRequest (const std::string &p)
	Set encoding parameters for the result: type,gain,offset,undetect,nodata.

void	setAllowedEncoding (const std::string &keys)

Public Member Functions inherited from ProductConf
	ProductConf ()
	Default constructor.

	ProductConf (const ProductConf &conf)
	Copy constructor.

Public Member Functions inherited from BeanLike
	BeanLike (const BeanLike &b)

	BeanLike (const std::string &name, const std::string &description="")

virtual const std::string &	getName () const
	Return the name of an instance.

virtual const std::string &	getDescription () const
	Return a brief description.

bool	hasParameters () const

template<class F >
F	getParameter (const std::string &p) const
	Gets a single parameter.

const map_t &	getParameters () const

map_t &	getParameters ()

template<class F >
void	setParametersFromEntries (const F &args)

void	setParameters (std::initializer_list< Variable::init_pair_t > args)
	Grants access to (if above hidden)

virtual void	setParameters (const std::string &p, char assignmentSymbol='=', char separatorSymbol=0)
	Sets comma-separated parameters in a predetermined order "a,b,c" or by specifing them "b=2".

template<class T >
void	setParameters (const std::map< std::string, T > &args)
	Set parameters.

template<class T >
void	setParameters (const SmartMap< T > &args)
	Set parameters.

void	setParameter (const std::string &p, const Castable &value)
	Sets a single parameter.

template<class T >
void	setParameter (const std::string &p, const VariableT< T > &value)

template<class F >
void	setParameter (const std::string &p, const F &value)
	Sets a single parameter.

template<class F >
void	setParameter (const std::string &p, std::initializer_list< F > value)
	Sets a single parameter.

BeanLike &	operator= (const BeanLike &b)

virtual std::ostream &	toStream (std::ostream &ostr, bool compact=true) const

Public Attributes
double	altitude = 1000.0
	Nominal height of horizontal intersection.

Beam	beam = 1.0

double	weightMin = -0.1

bool	COMPUTE_HGHT = false

Public Attributes inherited from RadarProductOp< MS, MD >
MD	odim
	The default data parameters for encoding output (the product).

Public Attributes inherited from ProductConf
DataSelector	dataSelector

std::string	targetEncoding
	How the (main) output is encoded.

ODIMPathElem	appendResults
	If set, appends outputs in an hdf5 structure instead of overwriting.

OutputFlagger	outputDataVerbosity = DEFAULT

Additional Inherited Members
Public Types inherited from RadarProductOp< MS, MD >
typedef SrcType< MS const >	src_t
	Type of input, that is, source.

typedef DstType< MD >	dst_t
	Type of output, that is, destination.

Public Types inherited from ProductConf
enum	OutputDataVerbosity { DEFAULT =0 , INTERMEDIATE =1 , DEBUG =2 , QUALITY =4 }
	Determines if also intermediate results (1) are saved. See –store.

typedef drain::EnumFlagger< drain::MultiFlagger< OutputDataVerbosity > >	OutputFlagger

Public Types inherited from BeanLike
typedef ReferenceMap	map_t

Static Public Member Functions inherited from ProductBase
static void	applyODIM (ODIM &productODIM, const ODIM &srcODIM, bool applyDefaults=false)
	Modifies encoding. If type is changed, resets scaling first.

static void	setRackVersion (drain::VariableMap &metadata)

Static Public Attributes inherited from PolarProductOp
static const CoordinatePolicy	polarCoordPolicy

Protected Member Functions inherited from CumulativeProductOp
	CumulativeProductOp (const std::string &name=__FUNCTION__, const std::string &description="", const std::string &accumulationMethod="LATEST")
	Default constructor.

	CumulativeProductOp (const CumulativeProductOp &op)
	Copy constructor.

virtual void	setGeometry (const PolarODIM &srcODIM, PlainData< PolarDst > &dstData) const

Protected Member Functions inherited from PolarProductOp
void	copyPolarGeometry (const PolarODIM &srcODIM, PlainData< PolarDst > &dstData) const

virtual void	deriveDstGeometry (const DataSetMap< PolarSrc > &srcSweeps, PolarODIM &dstOdim, bool MINIMISE_RSCALE=false) const
	Based on input data, find geometry that maximises range and ray count.

virtual void	determineMetadata (const DataSetMap< PolarSrc > &srcSweeps, PolarODIM &dstOdim) const
	Update timestamps etc.

Protected Member Functions inherited from RadarProductOp< MS, MD >
virtual void	setGeometry (const MS &srcODIM, PlainData< dst_t > &dstData) const =0
	Sets automagically the suitable dst parameters.

virtual void	initDst (const MS &srcODIM, PlainData< dst_t > &dstData) const
	initialises dst data by setting suitable ODIM metadata and geometry.

virtual void	setEncoding (const ODIM &srcODIM, PlainData< dst_t > &dstData) const
	Sets applicable encoding parametes (type, gain, offset, undetect, nodata) for this product.

void	setEncodingNEW (PlainData< dst_t > &dstData, const std::string quantity="", const std::string type="") const
	Sets applicable encoding parametes (type, gain, offset, undetect, nodata) for this product.

Protected Member Functions inherited from ProductBase
	ProductBase (const std::string &name, const std::string &description)
	Default constructor.

	ProductBase (const ProductBase &product)

void	storeLastArguments (const std::string &p) override
	Called after setParameters()

Protected Member Functions inherited from BeanLike
virtual void	updateBean () const
	Called after setParameters()

Static Protected Member Functions inherited from ProductBase
static void	setODIMspecials (ODIM &productODIM)
	Sets target encoding.

Protected Attributes inherited from CumulativeProductOp
std::string	accumulationMethod

Protected Attributes inherited from PolarProductOp
bool	aboveSeaLevel

Protected Attributes inherited from ProductBase
std::string	lastArguments

drain::ReferenceMap	allowedEncoding
	Defines which encoding parameters can be changed by the user from command line.

Protected Attributes inherited from BeanLike
const std::string	name

const std::string	description

map_t	parameters

Detailed Description

CAPPI and Pseudo-CAPPI: the constant altitude planar position indicator product.

Constructor & Destructor Documentation

◆ CappiOp()

CappiOp	(	double	altitude = `1000.0`,
		bool	aboveSeaLevel = `true`,
		double	beamWidth = `1.0`,
		double	weightMin = `-0.1`,
		std::string	accumulationMethod = `"WAVG:1:8:-40"`
	)

Pseudo-CAPPI: the constant altitude planar position indicator.

Parameters

altitude	- altitude of the horizontal intersection
aboveSeaLevel	- measure altitude from sea level (true) or radar site altitude (false)
beamWidth	- half-power width of Gaussian beam model
weightMin	- threshold [0...1] for normalized beam power interpreted as weight; set -1 to include "pseudo" areas
accumulationMethod	- define how dBZ and weight of each bin contributes to the product

Member Function Documentation

◆ getOutputQuantity()

virtual const std::string & getOutputQuantity ( const std::string & inputQuantity = "" ) const

inlineoverridevirtual

Returns the primary output quantity (ODIM what:quantity , like DBZH)

Reimplemented from CumulativeProductOp.

◆ processData()

void processData	(	const Data< PolarSrc > &	data,
		RadarAccumulator< Accumulator, PolarODIM > &	accumulator
	)		const

overridevirtual

Ground angle

Elevation angle of a bin.

Measurement, encoded

Beam weight

Prevent bell curve falling under a limit

Measurement weight (quality)

Direct pixel address in the accumulation arrey.

Implements CumulativeProductOp.

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

src/product/CappiOp.h
src/product/CappiOp.cpp

Public Member Functions