CmdSelectQuantity Class Reference

Tool for selecting data for next command(s), based on paths, quantities and elevations. More...

Inheritance diagram for CmdSelectQuantity:

Collaboration diagram for CmdSelectQuantity:

Public Member Functions
void	exec () const override
	Run the command with current parameter values.
Public Member Functions inherited from SimpleCommand< std::string >
	SimpleCommand (const std::string &name, const std::string &description, const std::string &key="value", const std::string &initValue=std::string(), const std::string &unit="")
	Constructor.
	SimpleCommand (const std::string &name, const std::string &description, const std::string &key, std::initializer_list< S > l, const std::string &unit="")
	Constuctor designer for SimpleCommand<Unituple<> > .
	SimpleCommand (const SimpleCommand &cmd)
	Copy constructor.
Public Member Functions inherited from BasicCommand
	BasicCommand (const std::string &name, const std::string &description)
	Constructor.
	BasicCommand (const BasicCommand &cmd)
	Copy constructor.
Public Member Functions inherited from BeanCommand< BeanLike >
	BeanCommand (const std::string &name, const std::string &description)
	Constructor.
	BeanCommand (const BeanCommand &cmd)
	Copy constructor.
	BeanCommand (BeanLike &b)
	Constructor wrapping an existing bean.
virtual const bean_t &	getBean () const
	Returns the wrapped bean.
virtual bean_t &	getBean ()
	Returns the wrapped bean.
const std::string &	getName () const final
	Returns the command name.
const std::string &	getDescription () const final
	Returns the command description.
virtual const drain::ReferenceMap &	getParameters () const
	Returns the command parameters.
Public Member Functions inherited from Command
	Command (const Command &cmd)
	Copy constructor.
virtual void	setParameters (const std::string &args) final
template<class T >
void	setParameters (const T &args)
	Sets parameters from argument.
template<class T >
void	setParameter (const std::string &key, const T &value)
	Set a value to a single parameter.
bool	hasParameters () const
	Returns true if this command has parameters.
virtual void	run (const std::string &params="") final
	Description of result, comparable to a return type of a function. ?
virtual void	update ()
	Optional method for preparing command to execution.
Command &	addSection (int i)
	Marks this command as belonging to section i.
const std::string &	getLastParameters () const
	Returns the parameters from the last execution.
virtual void	getRelatedCommands (std::ostream &ostr=std::cout) const
	Writes related command names to stream.
void	linkRelated (const std::string &cmdKey) const
	Add related command(s), to appear in help after "See-also:" phrase.
virtual void	parametersToStream (std::ostream &ostr, const std::string &indent=" ") const
	By default, the "true", technical parameters.
virtual void	parameterKeysToStream (std::ostream &ostr) const
	Writes parameter keys to stream.
void	parameterKeysToStream (std::ostream &ostr, const std::list< std::string > &list, char sep=',') const
	Writes parameter keys to stream.
Public Member Functions inherited from Contextual
	Contextual ()
	Sets internal contextPtr to NULL.
	Contextual (const Contextual &src)
	Copies base context (even null) of the source. Notice that the actual instance may be of derived class.
	Contextual (Context &ctx)
	Copies internal contextPtr.
template<class C >
void	setContext ()
	Sets internal contextPtr to the static source.
void	setExternalContext (Context &ctx)
	Sets internal contextPtr to outside target.
bool	contextIsSet () const
	True, if contextPtr has been set.
template<class T = Context>
T &	getContext () const
	If context has been set, returns it through a cast to base class Context.

Additional Inherited Members
Public Types inherited from BeanCommand< BeanLike >
typedef BeanLike	bean_t
	The bean type.
Public Types inherited from Command
typedef int	cmd_section_type
Static Public Member Functions inherited from Contextual
template<class T >
static Cloner< Context, T > &	getCloner ()
	Returns the object cloner.
Public Attributes inherited from SimpleCommand< std::string >
std::string	value
Public Attributes inherited from BeanCommand< BeanLike >
BeanLike	bean
	The wrapped bean instance.
Public Attributes inherited from Command
cmd_section_type	section = 1
	Section bitmask; zero means hidden from help.
Static Public Attributes inherited from Command
static const SprinterLayout	cmdArgLayout = {",", "?", "=", ""}
	Layout flag for command argument handling.
Protected Member Functions inherited from BeanCommand< BeanLike >
virtual drain::ReferenceMap &	getParameters () final
Protected Attributes inherited from Command
std::set< std::string >	relatedCommands
	Set of related command keys shown in help.
std::string	lastParameters
	String record of the last argument(s) passed.
Protected Attributes inherited from Contextual
Context *	contextPtr
	Pointer to the current context; nullptr if not set.

Detailed Description

Tool for selecting data for next command(s), based on paths, quantities and elevations.

Most commands apply implicit input data selection criteria, typically involving data paths, quantities and/or elevation angles.

Like in general in Rack, the parameters of --select are positional (ordered), meaning that they can be issued as a comma-separated string without explicit names (keywords), as long as they are given in order. The parameters are:

• path is a string of path elements, separated by slash '/' and consisting of:
  • a leading single slash '/', if rooted matching is desired ie. leading parts of the paths are tested; otherwise trailing parts
  • what , where, how - ie. the groups containing attributes
  • dataset{min}:{max} , data{min}:{max} , quality{min}:{max} - indexed groups containing subgroups for actual data and attributes
  • data - unindexed groups containing actual data arrays
  • combined selection elements created by concatenating above elements with pipe '|' representing logical OR function (requires escaping on command line)
    • example: what|where|dataset1:3
  • in index ranges, values can be omitted, using invoking default minimum (1) and maximum (0xffff = 65535) as follows:
    • data: equals data1:65535; further the colon ':' can be omitted for dataset and quality (but not for data: , to bypass naming conflict inherent in ODIM )
    • data{index} equals data{index}:{index} (ie. exact match)
    • data{index}: equals data{index}:65535
    • data:{index} equals data1:{index}
  • in each combined selection element, only one index range can be given, referring to all indexed elements, and it must be given as the last segment
    • example: what|data|quality1:5 matches what, data1:5 and quality1:5
    • example: what|where|dataset1:3/what|data1:8 – index ranges can vary on different levels, ie. in slash-separated elements
• quantity is a regular expression
  • example: ^DBZH$, accepting DBZH only
  • example: (DBZH|TH) accepts DBZH and TH , but also DBZHC and WIDTH ...
  • future option: two regular expressions separated by a slash, the latter regExp determining the desired quality quantities
• elangle defines the range of antenna elevations accepted, range limits included
  • unlike with path selectors, elangle={angle} abbreviates elangle={angle}:90 (not elangle={angle}:{angle})
  • notice that metadata may contain floating point values like 1.000004723, use count=1 to pick a single one within a range
• count is the upper limit of accepted indices of dataset ; typically used with elangle
• order defines criteria (DATA|TIME|ELANGLE) and operation (MIN|MAX) in selecting data, applied with count. Note that the lowest elevations can be measured the latest, appearing as dataset 's with highest indices.
• dualPRF determines if sweeps using dual pulse repetition frequency is required (1), accepted like single one (0), or excluded (-1).

The selection functionality is best explained with examples.

# For a Pseudo CAPPI product, change default input selection
rack volume.h5 --select 'quantity=^TH$,elangle=1.5:10,count=3' --pCappi 1500 -o pCappi-TH-1500m.h5
 
# For image output, select DBZH  
rack volume.h5 --select elangle=1.5,quantity=DBZH -o volume-DBZH.png
 
# For image output, select VRAD of the lowest dual-PRF scan 
rack volume.h5 --select quantity=VRAD:VRADH,order=ELANGLE:MIN,prf=DOUBLE -o volume-VRAD.png
 
# For image output, select ZDR of the highest single-PRF scan 
rack volume.h5 --select quantity=ZDR,count=1,order=ELANGLE:MAX,prf=SINGLE -o volume-ZDR.png
 
# For single-image output, select DBZH of the lowest scan (from 90 6.5 2.4 1.8 1.2 0.59)
rack volume.h5 --select quantity=DBZH,order=ELANGLE:MIN -o volume-DBZH2.png
 
# For single-image output, select dBZ - preferably total dBZ - of the highest scan (from 90 6.5 2.4 1.8 1.2 0.59)
rack volume.h5 --select quantity=TH:TV:T:DBZH:DBZ,order=ELANGLE:MAX -o volume-DBZH3.png
 

Note that escaping special characters like '|' is often required on command line.

Often, the first data array matching the criteria are used.

One can explicitly change the criteria with --select (-s) command . For example, in data conversions one may wish to focus on certain quantity – like DBZH or VRAD – not all the data.

The selection command can be applied the most commands processing data. In computing meteorological products (Product generation) an compositing, it affects the following product only. In case of anomaly detectors (Anomaly Detection and Removal (AnDRe)), it applies to all subsequent operators.

Note that some processing commands may not support explicit data selection. Set selection criteria strictly to one quantity . Selecting quantities only is frequently needed, so there is a dedicated command --selectQuantity (-Q ) which accepts comma-separated simple patterns (with * and ?) instead of regular expressions. For example, -Q DBZH*,QIND is equal to --select quantity='^(DBZH.*|QIND)$' .

Member Function Documentation

exec()

void exec ( ) const

inlineoverridevirtual

Run the command with current parameter values.

Reimplemented from Command.

---

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

• src/main/commands.cpp