Compositing rule for beeing able to generate composites both from scans and volumes. More...

Inheritance diagram for eu.baltrad.beast.rules.composite.CompositingRule:

Public Member Functions
void	setRuleId (int ruleid)

int	getRuleId ()

void	setInterval (int interval)
	Sets the interval to be used.

int	getInterval ()

void	setTimeout (int timeout)

int	getTimeout ()

void	setSources (List< String > sources)

List< String >	getSources ()

void	setArea (String area)

String	getArea ()

String	getType ()

boolean	isValid ()

void	setScanBased (boolean scanBased)

boolean	isScanBased ()

synchronized IBltMessage	handle (IBltMessage message)

synchronized IBltMessage	timeout (long id, int why, Object data)

void	setRecipients (List< String > recipients)

void	afterPropertiesSet ()

void	setSelectionMethod (int selectionMethod)

void	setSelectionMethod (String selectionMethod)
	Sets the selection method from a string.

int	getSelectionMethod ()

String	getSelectionMethodAsString ()

void	setDetectors (List< String > detectors)

List< String >	getDetectors ()

void	setMethod (String method)

String	getMethod ()

void	setProdpar (String prodpar)

String	getProdpar ()

boolean	isApplyGRA ()

void	setApplyGRA (boolean applyGRA)

double	getZR_A ()

void	setZR_A (double zR_A)

double	getZR_b ()

void	setZR_b (double zR_b)

boolean	isIgnoreMalfunc ()

void	setIgnoreMalfunc (boolean ignoreMalfunc)

boolean	isCtFilter ()

void	setCtFilter (boolean ctFilter)

String	getQitotalField ()

void	setQitotalField (String qitotalField)

String	getQuantity ()

void	setQuantity (String quantity)

int	getMaxAgeLimit ()

void	setMaxAgeLimit (int maxAgeLimit)

boolean	isNominalTimeout ()

void	setNominalTimeout (boolean nominalTimeout)

int	getQualityControlMode ()

String	getQualityControlModeAsString ()

void	setQualityControlMode (String qualityControlMode)

void	setQualityControlMode (int qualityControlMode)

IFilter	getFilter ()

void	setFilter (IFilter filter)

void	setReprocessQuality (Boolean reprocessQuality)

boolean	isReprocessQuality ()

Static Public Attributes
static final String	TYPE = "blt_composite"
	The name of this static composite type.

static final int	QualityControlMode_ANALYZE_AND_APPLY = 0
	Performs the quality analysis and then applies the result to the original set.

static final int	QualityControlMode_ANALYZE = 1
	Only performs the quality analysis.

static final int	SelectionMethod_NEAREST_RADAR = 0
	If pixel should be determined by "closest to radar".

static final int	SelectionMethod_HEIGHT_ABOVE_SEALEVEL = 1
	If pixel should be determined by "nearest sea level".

static final String	PPI = "ppi"
	To set that method should be PPI compositing.

static final String	CAPPI = "cappi"
	To set that method should be CAPPPI compositing.

static final String	PCAPPI = "pcappi"
	To set that method should be PCAPPI compositing.

static final String	PMAX = "pmax"
	Use Pseudo-Max compositing.

static final String	MAX = "max"
	Use Max compositing.

Static Public Attributes inherited from eu.baltrad.beast.rules.timer.ITimeoutRule
static final int	TIMEOUT = 0
	Timeout was triggered due to timeout.

static final int	CANCELLED = 1
	Timeout was triggered due to cancellation.

Protected Member Functions
	CompositingRule ()
	Default constructor,however, use manager for creation.

void	setCatalog (Catalog catalog)

Catalog	getCatalog ()

void	setTimeoutManager (TimeoutManager mgr)

TimeoutManager	getTimeoutManager ()

void	setRuleUtilities (IRuleUtilities ruleUtil)

IRuleUtilities	getRuleUtilities ()

boolean	dateTimeExceedsMaxAgeLimit (DateTime dateTime)

IBltMessage	createComposite (IBltMessage message, CompositingRuleFilter ruleFilter)

CompositeTimerData	createTimerData (IBltMessage message)
	If possible creates a CompositingTimerData.

DateTime	getDateTimeFromFile (FileEntry file)

DateTime	getNominalTimeFromFile (FileEntry file)

IBltMessage	createMessage (DateTime nominalDT, Map< String, CatalogEntry > entriesMap)
	Creates a message if all nessecary entries are there.

CompositingRuleFilter	createFilter (DateTime nominalDT)
	Returns a filter.

Map< String, CatalogEntry >	fetchPreviousEntriesMap (CompositingRuleFilter ruleFilter)

Map< String, CatalogEntry >	fetchEntriesMap (CompositingRuleFilter ruleFilter)

Detailed Description

Compositing rule for beeing able to generate composites both from scans and volumes.

However, it is not possible to mix composites and scans yet. The composite by scan will always work on lowest elevation and composite by volume is dependant on the receiving end.

Author: Anders Henja

Constructor & Destructor Documentation

◆ CompositingRule()

eu.baltrad.beast.rules.composite.CompositingRule.CompositingRule ( )

inlineprotected

Default constructor,however, use manager for creation.

Member Function Documentation

◆ afterPropertiesSet()

void eu.baltrad.beast.rules.composite.CompositingRule.afterPropertiesSet ( )

inline

See also: org.springframework.beans.factory.InitializingBean.afterPropertiesSet()

◆ createFilter()

CompositingRuleFilter eu.baltrad.beast.rules.composite.CompositingRule.createFilter ( DateTime nominalDT )

inlineprotected

Returns a filter.

Parameters

nominalDT the nominal time

Returns: a TimeIntervalFilter for polar volumes

◆ createMessage()

IBltMessage eu.baltrad.beast.rules.composite.CompositingRule.createMessage	(	DateTime	nominalDT,
		Map< String, CatalogEntry >	entriesMap )

inlineprotected

Creates a message if all nessecary entries are there.

Parameters

nominalDT	the nominal time
entriesMap	the list of entries

Returns: a message if criterias are fullfilled, otherwise null

◆ createTimerData()

CompositeTimerData eu.baltrad.beast.rules.composite.CompositingRule.createTimerData ( IBltMessage message )

inlineprotected

If possible creates a CompositingTimerData.

Parameters

message the message (that should be a BltDataMessage)

Returns: a compositing timer data or null if not possible

◆ getArea()

String eu.baltrad.beast.rules.composite.CompositingRule.getArea ( )

inline

Returns: an area

◆ getCatalog()

Catalog eu.baltrad.beast.rules.composite.CompositingRule.getCatalog ( )

inlineprotected

Returns: the catalog

◆ getDetectors()

List< String > eu.baltrad.beast.rules.composite.CompositingRule.getDetectors ( )

inline

Returns: the detectors

◆ getInterval()

int eu.baltrad.beast.rules.composite.CompositingRule.getInterval ( )

inline

Returns: the interval

◆ getMaxAgeLimit()

int eu.baltrad.beast.rules.composite.CompositingRule.getMaxAgeLimit ( )

inline

Returns: the maximum age limit in minutes

◆ getMethod()

String eu.baltrad.beast.rules.composite.CompositingRule.getMethod ( )

inline

Returns: the method

◆ getProdpar()

String eu.baltrad.beast.rules.composite.CompositingRule.getProdpar ( )

inline

Returns: the prodpar

◆ getQitotalField()

String eu.baltrad.beast.rules.composite.CompositingRule.getQitotalField ( )

inline

Returns: the QI total field

◆ getQuantity()

String eu.baltrad.beast.rules.composite.CompositingRule.getQuantity ( )

inline

Returns: the quantity

◆ getRuleId()

int eu.baltrad.beast.rules.composite.CompositingRule.getRuleId ( )

inline

Returns: the ruleid

◆ getRuleUtilities()

IRuleUtilities eu.baltrad.beast.rules.composite.CompositingRule.getRuleUtilities ( )

inlineprotected

Returns: the ruleUtil

◆ getSelectionMethod()

int eu.baltrad.beast.rules.composite.CompositingRule.getSelectionMethod ( )

inline

Returns: the selectionMethod

◆ getSources()

List< String > eu.baltrad.beast.rules.composite.CompositingRule.getSources ( )

inline

Returns: a list of sources

◆ getTimeoutManager()

TimeoutManager eu.baltrad.beast.rules.composite.CompositingRule.getTimeoutManager ( )

inlineprotected

Returns: the timeout manager

◆ getType()

String eu.baltrad.beast.rules.composite.CompositingRule.getType ( )

inline

See also: eu.baltrad.beast.rules.IRule.getType()

Implements eu.baltrad.beast.rules.IRule.

◆ getZR_A()

double eu.baltrad.beast.rules.composite.CompositingRule.getZR_A ( )

inline

Returns: the ZR A coefficient when converting from reflectivity to MM/H

◆ getZR_b()

double eu.baltrad.beast.rules.composite.CompositingRule.getZR_b ( )

inline

Returns: the ZR b coefficient when converting from reflectivity to MM/H

◆ handle()

synchronized IBltMessage eu.baltrad.beast.rules.composite.CompositingRule.handle ( IBltMessage message )

inline

See also: eu.baltrad.beast.rules.IRule.handle(eu.baltrad.beast.message.IBltMessage)

Implements eu.baltrad.beast.rules.IRule.

◆ isApplyGRA()

boolean eu.baltrad.beast.rules.composite.CompositingRule.isApplyGRA ( )

inline

Returns: if GRA correction should be applied or not

◆ isCtFilter()

boolean eu.baltrad.beast.rules.composite.CompositingRule.isCtFilter ( )

inline

Returns: if ct filtering will be performed or not

◆ isIgnoreMalfunc()

boolean eu.baltrad.beast.rules.composite.CompositingRule.isIgnoreMalfunc ( )

inline

Returns: if malfunc should be ignored or not

◆ isScanBased()

boolean eu.baltrad.beast.rules.composite.CompositingRule.isScanBased ( )

inline

Returns: the scanBased

◆ isValid()

boolean eu.baltrad.beast.rules.composite.CompositingRule.isValid ( )

inline

See also: eu.baltrad.beast.rules.IRule.isValid()

Implements eu.baltrad.beast.rules.IRule.

◆ setApplyGRA()

void eu.baltrad.beast.rules.composite.CompositingRule.setApplyGRA ( boolean applyGRA )

inline

Parameters

applyGRA if GRA correction should be applied or not

◆ setArea()

void eu.baltrad.beast.rules.composite.CompositingRule.setArea ( String area )

inline

Parameters

area	the area to set

◆ setCatalog()

void eu.baltrad.beast.rules.composite.CompositingRule.setCatalog ( Catalog catalog )

inlineprotected

Parameters

catalog the catalog to set

◆ setCtFilter()

void eu.baltrad.beast.rules.composite.CompositingRule.setCtFilter ( boolean ctFilter )

inline

Parameters

ctFilter if ct filtering should be performed or not

◆ setDetectors()

void eu.baltrad.beast.rules.composite.CompositingRule.setDetectors ( List< String > detectors )

inline

Parameters

detectors the detectors to set

◆ setIgnoreMalfunc()

void eu.baltrad.beast.rules.composite.CompositingRule.setIgnoreMalfunc ( boolean ignoreMalfunc )

inline

Parameters

ignoreMalfunc if malfunc should be ignored or not

◆ setInterval()

void eu.baltrad.beast.rules.composite.CompositingRule.setInterval ( int interval )

inline

Sets the interval to be used.

Must be a valid integer that is greater than 0 and evenly dividable by 60. E.g. 1,2,3,4,...15,....30,60

Parameters

interval

Exceptions

IllegalArgumentException if interval not valid

◆ setMaxAgeLimit()

void eu.baltrad.beast.rules.composite.CompositingRule.setMaxAgeLimit ( int maxAgeLimit )

inline

Parameters

maxAgeLimit the maximum age limit in minutes

◆ setMethod()

void eu.baltrad.beast.rules.composite.CompositingRule.setMethod ( String method )

inline

Parameters

method the method to set

◆ setProdpar()

void eu.baltrad.beast.rules.composite.CompositingRule.setProdpar ( String prodpar )

inline

Parameters

prodpar the prodpar to set

◆ setQitotalField()

void eu.baltrad.beast.rules.composite.CompositingRule.setQitotalField ( String qitotalField )

inline

Parameters

qitotalField the QI total field to set

◆ setQuantity()

void eu.baltrad.beast.rules.composite.CompositingRule.setQuantity ( String quantity )

inline

Parameters

quantity the quantity to set

◆ setRecipients()

void eu.baltrad.beast.rules.composite.CompositingRule.setRecipients ( List< String > recipients )

inline

See also: eu.baltrad.beast.rules.IRuleRecipientAware.setRecipients(java.util.List)

Implements eu.baltrad.beast.rules.IRuleRecipientAware.

◆ setRuleId()

void eu.baltrad.beast.rules.composite.CompositingRule.setRuleId ( int ruleid )

inline

Parameters

ruleid the ruleid to set

◆ setRuleUtilities()

void eu.baltrad.beast.rules.composite.CompositingRule.setRuleUtilities ( IRuleUtilities ruleUtil )

inlineprotected

Parameters

ruleUtil the ruleUtil to set

◆ setScanBased()

void eu.baltrad.beast.rules.composite.CompositingRule.setScanBased ( boolean scanBased )

inline

Parameters

scanBased the scanBased to set

◆ setSelectionMethod() [1/2]

void eu.baltrad.beast.rules.composite.CompositingRule.setSelectionMethod ( int selectionMethod )

inline

Parameters

selectionMethod the selectionMethod to set

◆ setSelectionMethod() [2/2]

void eu.baltrad.beast.rules.composite.CompositingRule.setSelectionMethod ( String selectionMethod )

inline

Sets the selection method from a string.

Parameters

selectionMethod the selection method

◆ setSources()

void eu.baltrad.beast.rules.composite.CompositingRule.setSources ( List< String > sources )

inline

Parameters

sources the list of sources to set

◆ setTimeout()

void eu.baltrad.beast.rules.composite.CompositingRule.setTimeout ( int timeout )

inline

Parameters

timeout the timeout in seconds

◆ setTimeoutManager()

void eu.baltrad.beast.rules.composite.CompositingRule.setTimeoutManager ( TimeoutManager mgr )

inlineprotected

Parameters

mgr	the timeout manager to set

◆ setZR_A()

void eu.baltrad.beast.rules.composite.CompositingRule.setZR_A ( double zR_A )

inline

Parameters

zR_A	the ZR A coefficient

◆ setZR_b()

void eu.baltrad.beast.rules.composite.CompositingRule.setZR_b ( double zR_b )

inline

Parameters

zR_b	the ZR b coefficient

◆ timeout()

synchronized IBltMessage eu.baltrad.beast.rules.composite.CompositingRule.timeout	(	long	id,
		int	why,
		Object	data )

inline

See also: eu.baltrad.beast.rules.timer.ITimeoutRule.timeout(long, int, Object)

Implements eu.baltrad.beast.rules.timer.ITimeoutRule.

Member Data Documentation

◆ CAPPI

final String eu.baltrad.beast.rules.composite.CompositingRule.CAPPI = "cappi"

static

To set that method should be CAPPPI compositing.

◆ MAX

final String eu.baltrad.beast.rules.composite.CompositingRule.MAX = "max"

static

Use Max compositing.

◆ PCAPPI

final String eu.baltrad.beast.rules.composite.CompositingRule.PCAPPI = "pcappi"

static

To set that method should be PCAPPI compositing.

◆ PMAX

final String eu.baltrad.beast.rules.composite.CompositingRule.PMAX = "pmax"

static

Use Pseudo-Max compositing.

◆ PPI

final String eu.baltrad.beast.rules.composite.CompositingRule.PPI = "ppi"

static

To set that method should be PPI compositing.

◆ QualityControlMode_ANALYZE

final int eu.baltrad.beast.rules.composite.CompositingRule.QualityControlMode_ANALYZE = 1

static

Only performs the quality analysis.

◆ QualityControlMode_ANALYZE_AND_APPLY

final int eu.baltrad.beast.rules.composite.CompositingRule.QualityControlMode_ANALYZE_AND_APPLY = 0

static

Performs the quality analysis and then applies the result to the original set.

◆ SelectionMethod_HEIGHT_ABOVE_SEALEVEL

final int eu.baltrad.beast.rules.composite.CompositingRule.SelectionMethod_HEIGHT_ABOVE_SEALEVEL = 1

static

If pixel should be determined by "nearest sea level".

◆ SelectionMethod_NEAREST_RADAR

final int eu.baltrad.beast.rules.composite.CompositingRule.SelectionMethod_NEAREST_RADAR = 0

static

If pixel should be determined by "closest to radar".

◆ TYPE

final String eu.baltrad.beast.rules.composite.CompositingRule.TYPE = "blt_composite"

static

The name of this static composite type.

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

src/eu/baltrad/beast/rules/composite/CompositingRule.java

Public Member Functions

Static Public Attributes

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ CompositingRule()

Member Function Documentation

◆ afterPropertiesSet()

◆ createFilter()

◆ createMessage()

◆ createTimerData()

◆ getArea()

◆ getCatalog()

◆ getDetectors()

◆ getInterval()

◆ getMaxAgeLimit()

◆ getMethod()

◆ getProdpar()

◆ getQitotalField()

◆ getQuantity()

◆ getRuleId()

◆ getRuleUtilities()

◆ getSelectionMethod()

◆ getSources()

◆ getTimeoutManager()

◆ getType()

◆ getZR_A()

◆ getZR_b()

◆ handle()

◆ isApplyGRA()

◆ isCtFilter()

◆ isIgnoreMalfunc()

◆ isScanBased()

◆ isValid()

◆ setApplyGRA()

◆ setArea()

◆ setCatalog()

◆ setCtFilter()

◆ setDetectors()

◆ setIgnoreMalfunc()

◆ setInterval()

◆ setMaxAgeLimit()

◆ setMethod()

◆ setProdpar()

◆ setQitotalField()

◆ setQuantity()

◆ setRecipients()

◆ setRuleId()

◆ setRuleUtilities()

◆ setScanBased()

◆ setSelectionMethod() [1/2]

◆ setSelectionMethod() [2/2]

◆ setSources()

◆ setTimeout()

◆ setTimeoutManager()

◆ setZR_A()

◆ setZR_b()

◆ timeout()

Member Data Documentation

◆ CAPPI

◆ MAX

◆ PCAPPI

◆ PMAX

◆ PPI

◆ QualityControlMode_ANALYZE

◆ QualityControlMode_ANALYZE_AND_APPLY

◆ SelectionMethod_HEIGHT_ABOVE_SEALEVEL

◆ SelectionMethod_NEAREST_RADAR

◆ TYPE