Inheritance diagram for eu.baltrad.beast.rules.acrr.AcrrRule:

Public Member Functions
void	setCatalog (Catalog catalog)

Catalog	getCatalog ()

void	setRuleUtilities (IRuleUtilities ruleUtil)

IRuleUtilities	getRuleUtilities ()

void	setRuleId (int ruleid)

int	getRuleId ()

void	setArea (String area)

String	getArea ()

int	getHours ()

void	setHours (int hours)

double	getZrA ()

void	setZrA (double zrA)

double	getZrB ()

void	setZrB (double zrB)

int	getFilesPerHour ()
	The files included / hour.

void	setFilesPerHour (int filesPerHour)
	Sets the number of in-products / hour.

String	getObjectType ()
	The object type, either COMP or IMAGE.

void	setObjectType (String objectType)

int	getAcceptableLoss ()
	The acceptable loss / pixel when generating the acrr product.

void	setAcceptableLoss (int acceptableLoss)
	The acceptable loss when generating a product.

String	getDistancefield ()
	The distance field to use in the product generation.

void	setDistancefield (String distancefield)
	Sets the distance quality field.

String	getQuantity ()

void	setQuantity (String quantity)

void	afterPropertiesSet () throws Exception

String	getType ()

boolean	isValid ()

IBltMessage	handle (IBltMessage message)

boolean	isApplyGRA ()

void	setApplyGRA (boolean applyGRA)

String	getProductId ()

void	setProductId (String productId)

IFilter	getFilter ()

void	setFilter (IFilter filter)

MetadataMatcher	getMatcher ()

void	setMatcher (MetadataMatcher matcher)

Static Public Attributes
static final String	TYPE = "blt_acrr"
	The name of this static acrr type.

Protected Member Functions
	AcrrRule ()
	Constructor.

List< CatalogEntry >	findFiles (DateTime now)
	Returns a filtered list of all included files from now and hours backward.

List< CatalogEntry >	filterEntries (List< CatalogEntry > entries)
	Filters the entries so that only one date-time / slot occurs.

List< CatalogEntry >	filterEntries (List< CatalogEntry > entries, Map< DateTime, CatalogEntry > validEntries)
	Creates a new list of entries where the entry must exist in both entries and validEntries.

int	compareStoredDateTime (CatalogEntry e1, CatalogEntry e2)
	Compares the stored date time between catalog entry 1 and 2.

boolean	isLessOrEqual (DateTime d1, DateTime d2)
	Returns true if d1 is <= d2, otherwise false.

TimeSelectionFilter	createFilter (DateTime sdt, DateTime edt, int interval)
	Creates the time selection filter to be used in this generation.

int	getFilesPerHourInterval ()
	Returns the interval corresponding to the number of files / hour.

Detailed Description

Author: Anders Henja

Constructor & Destructor Documentation

◆ AcrrRule()

eu.baltrad.beast.rules.acrr.AcrrRule.AcrrRule ( )

inlineprotected

Constructor.

Member Function Documentation

◆ afterPropertiesSet()

void eu.baltrad.beast.rules.acrr.AcrrRule.afterPropertiesSet ( ) throws Exception

inline

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

◆ compareStoredDateTime()

int eu.baltrad.beast.rules.acrr.AcrrRule.compareStoredDateTime	(	CatalogEntry	e1,
		CatalogEntry	e2 )

inlineprotected

Compares the stored date time between catalog entry 1 and 2.

Parameters

e1	entry 1
e2	entry 2

Returns: a negative integer, zero, or a positive integer if the stored time for e1 is less than, equal to, or greater than e2.

◆ createFilter()

TimeSelectionFilter eu.baltrad.beast.rules.acrr.AcrrRule.createFilter	(	DateTime	sdt,
		DateTime	edt,
		int	interval )

inlineprotected

Creates the time selection filter to be used in this generation.

Parameters

sdt	The first date time in the interval
edt	the last date time in the interval
interval	the interval

Returns: the filter

◆ filterEntries() [1/2]

List< CatalogEntry > eu.baltrad.beast.rules.acrr.AcrrRule.filterEntries ( List< CatalogEntry > entries )

inlineprotected

Filters the entries so that only one date-time / slot occurs.

Parameters

entries the entries to filter

Returns: the filtered entries

◆ filterEntries() [2/2]

List< CatalogEntry > eu.baltrad.beast.rules.acrr.AcrrRule.filterEntries	(	List< CatalogEntry >	entries,
		Map< DateTime, CatalogEntry >	validEntries )

inlineprotected

Creates a new list of entries where the entry must exist in both entries and validEntries.

Parameters

entries	the list of entries that should be filtered
validEntries	the map of valid entries

Returns: a filtered list

◆ findFiles()

List< CatalogEntry > eu.baltrad.beast.rules.acrr.AcrrRule.findFiles ( DateTime now )

inlineprotected

Returns a filtered list of all included files from now and hours backward.

The filtered list will only contain one file / what_time, what_date and the files will be based on latest stored_time.

Parameters

now	the current time

Returns: the found unique entries.

Reimplemented in eu.baltrad.beast.rules.gra.GraRule.

◆ getAcceptableLoss()

int eu.baltrad.beast.rules.acrr.AcrrRule.getAcceptableLoss ( )

inline

The acceptable loss / pixel when generating the acrr product.

Returns: acceptable loss in percent (0-100)

◆ getArea()

String eu.baltrad.beast.rules.acrr.AcrrRule.getArea ( )

inline

Returns: an area

◆ getCatalog()

Catalog eu.baltrad.beast.rules.acrr.AcrrRule.getCatalog ( )

inline

Returns: the catalog

◆ getDistancefield()

String eu.baltrad.beast.rules.acrr.AcrrRule.getDistancefield ( )

inline

The distance field to use in the product generation.

Default is eu.baltrad.composite.quality.distance.radar

Returns: the distance quality field

◆ getFilesPerHour()

int eu.baltrad.beast.rules.acrr.AcrrRule.getFilesPerHour ( )

inline

The files included / hour.

The actual number of in-products are actually one more. This means that if filesPerHour = 4, the actual number of files in the product will be 5 (e.g. 00:00,00:15,00:30,00:45,01:00). Note, that both 00:00 and 01:00 are included.

Returns: the files included / hour (-1)

◆ getFilesPerHourInterval()

int eu.baltrad.beast.rules.acrr.AcrrRule.getFilesPerHourInterval ( )

inlineprotected

Returns the interval corresponding to the number of files / hour.

E.g. 1 means 60 minute interval, 2 means 30 minute, 3 means 20 and so on

Returns: the interval to use depending on the filesPerHour setting

◆ getFilter()

IFilter eu.baltrad.beast.rules.acrr.AcrrRule.getFilter ( )

inline

Returns: the filter to use when trying out if files are matching

◆ getHours()

int eu.baltrad.beast.rules.acrr.AcrrRule.getHours ( )

inline

Returns: the number of hours in the product

Reimplemented in eu.baltrad.beast.rules.gra.GraRule.

◆ getMatcher()

MetadataMatcher eu.baltrad.beast.rules.acrr.AcrrRule.getMatcher ( )

inline

Returns: the metadata matcher

◆ getObjectType()

String eu.baltrad.beast.rules.acrr.AcrrRule.getObjectType ( )

inline

The object type, either COMP or IMAGE.

Returns: the object type

◆ getProductId()

String eu.baltrad.beast.rules.acrr.AcrrRule.getProductId ( )

inline

Returns: the product id. Default is null

◆ getQuantity()

String eu.baltrad.beast.rules.acrr.AcrrRule.getQuantity ( )

inline

Returns: the parameter (quantity) to use for the ACRR accumulation

◆ getRuleId()

int eu.baltrad.beast.rules.acrr.AcrrRule.getRuleId ( )

inline

Returns: the ruleid

◆ getRuleUtilities()

IRuleUtilities eu.baltrad.beast.rules.acrr.AcrrRule.getRuleUtilities ( )

inline

Returns: the ruleUtil

◆ getType()

String eu.baltrad.beast.rules.acrr.AcrrRule.getType ( )

inline

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

Implements eu.baltrad.beast.rules.IRule.

Reimplemented in eu.baltrad.beast.rules.gra.GraRule.

◆ getZrA()

double eu.baltrad.beast.rules.acrr.AcrrRule.getZrA ( )

inline

Returns: the ZR-A relation

◆ getZrB()

double eu.baltrad.beast.rules.acrr.AcrrRule.getZrB ( )

inline

Returns: the ZR-B relation

◆ handle()

IBltMessage eu.baltrad.beast.rules.acrr.AcrrRule.handle ( IBltMessage message )

inline

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

Implements eu.baltrad.beast.rules.IRule.

Reimplemented in eu.baltrad.beast.rules.gra.GraRule.

◆ isApplyGRA()

boolean eu.baltrad.beast.rules.acrr.AcrrRule.isApplyGRA ( )

inline

Returns: If GRA coefficients should be applied or not

◆ isLessOrEqual()

boolean eu.baltrad.beast.rules.acrr.AcrrRule.isLessOrEqual	(	DateTime	d1,
		DateTime	d2 )

inlineprotected

Returns true if d1 is <= d2, otherwise false.

Parameters

d1	date time 1
d2	date time 2

Returns: true if d1 is <= d2, otherwise false

◆ isValid()

boolean eu.baltrad.beast.rules.acrr.AcrrRule.isValid ( )

inline

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

Implements eu.baltrad.beast.rules.IRule.

◆ setAcceptableLoss()

void eu.baltrad.beast.rules.acrr.AcrrRule.setAcceptableLoss ( int acceptableLoss )

inline

The acceptable loss when generating a product.

If for example, there are 10 files to be used in the generation and acceptableLoss = 20, it means that the observations at that position can be used if not more than 2 (20%) observations with nodata exists in that set.

Parameters

acceptableLoss acceptable loss in percent (0-100)

◆ setApplyGRA()

void eu.baltrad.beast.rules.acrr.AcrrRule.setApplyGRA ( boolean applyGRA )

inline

Parameters

applyGRA If GRA coefficients should be applied or not

◆ setArea()

void eu.baltrad.beast.rules.acrr.AcrrRule.setArea ( String area )

inline

Parameters

area	the area to set

◆ setCatalog()

void eu.baltrad.beast.rules.acrr.AcrrRule.setCatalog ( Catalog catalog )

inline

Parameters

catalog the catalog to set

◆ setDistancefield()

void eu.baltrad.beast.rules.acrr.AcrrRule.setDistancefield ( String distancefield )

inline

Sets the distance quality field.

Parameters

distancefield

◆ setFilesPerHour()

void eu.baltrad.beast.rules.acrr.AcrrRule.setFilesPerHour ( int filesPerHour )

inline

Sets the number of in-products / hour.

Be aware that the actual number of used files will be number_of_files_per_hour * hours + 1. For example, if filesPerHour = 4 and hours = 1, the number of files will be 4 * 1 + 1. E.g. 00:00,00:15,00:30,00:45,01:00. The number of files / hours will affect Valid values are [1,2,3,4,6,12] (=> 2,3,4,7,13 files)

Parameters

filesPerHour the number of in-products / hour (-1).

◆ setFilter()

void eu.baltrad.beast.rules.acrr.AcrrRule.setFilter ( IFilter filter )

inline

Parameters

filter the filter to use

◆ setHours()

void eu.baltrad.beast.rules.acrr.AcrrRule.setHours ( int hours )

inline

Parameters

hours the number of hours in the product

Reimplemented in eu.baltrad.beast.rules.gra.GraRule.

◆ setMatcher()

void eu.baltrad.beast.rules.acrr.AcrrRule.setMatcher ( MetadataMatcher matcher )

inline

Parameters

matcher the metadata matcher

◆ setObjectType()

void eu.baltrad.beast.rules.acrr.AcrrRule.setObjectType ( String objectType )

inline

Parameters

objectType the object type to use, either IMAGE or COMP

◆ setProductId()

void eu.baltrad.beast.rules.acrr.AcrrRule.setProductId ( String productId )

inline

Parameters

productId the product id

◆ setQuantity()

void eu.baltrad.beast.rules.acrr.AcrrRule.setQuantity ( String quantity )

inline

Parameters

quantity the parameter (quantity) to use in the accumulation

◆ setRuleId()

void eu.baltrad.beast.rules.acrr.AcrrRule.setRuleId ( int ruleid )

inline

Parameters

ruleid the ruleid to set

◆ setRuleUtilities()

void eu.baltrad.beast.rules.acrr.AcrrRule.setRuleUtilities ( IRuleUtilities ruleUtil )

inline

Parameters

ruleUtil the ruleUtil to set

◆ setZrA()

void eu.baltrad.beast.rules.acrr.AcrrRule.setZrA ( double zrA )

inline

Parameters

zrA	the ZR-A relation

◆ setZrB()

void eu.baltrad.beast.rules.acrr.AcrrRule.setZrB ( double zrB )

inline

Parameters

zrB	the ZR-B relation

Member Data Documentation

◆ TYPE

final String eu.baltrad.beast.rules.acrr.AcrrRule.TYPE = "blt_acrr"

static

The name of this static acrr type.

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

src/eu/baltrad/beast/rules/acrr/AcrrRule.java

Public Member Functions

Static Public Attributes

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ AcrrRule()

Member Function Documentation

◆ afterPropertiesSet()

◆ compareStoredDateTime()

◆ createFilter()

◆ filterEntries() [1/2]

◆ filterEntries() [2/2]

◆ findFiles()

◆ getAcceptableLoss()

◆ getArea()

◆ getCatalog()

◆ getDistancefield()

◆ getFilesPerHour()

◆ getFilesPerHourInterval()

◆ getFilter()

◆ getHours()

◆ getMatcher()

◆ getObjectType()

◆ getProductId()

◆ getQuantity()

◆ getRuleId()

◆ getRuleUtilities()

◆ getType()

◆ getZrA()

◆ getZrB()

◆ handle()

◆ isApplyGRA()

◆ isLessOrEqual()

◆ isValid()

◆ setAcceptableLoss()

◆ setApplyGRA()

◆ setArea()

◆ setCatalog()

◆ setDistancefield()

◆ setFilesPerHour()

◆ setFilter()

◆ setHours()

◆ setMatcher()

◆ setObjectType()

◆ setProductId()

◆ setQuantity()

◆ setRuleId()

◆ setRuleUtilities()

◆ setZrA()

◆ setZrB()

Member Data Documentation

◆ TYPE