Site 2D rule for beeing able to generate images from single scans & volumes. More...

Inheritance diagram for eu.baltrad.beast.rules.site2d.Site2DRule:

Public Member Functions
IBltMessage	handle (IBltMessage message)

void	setRuleId (int ruleid)

int	getRuleId ()

String	getType ()

boolean	isValid ()

void	afterPropertiesSet ()

int	getInterval ()

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

List< String >	getSources ()

void	setSources (List< String > sources)

String	getArea ()

void	setArea (String area)

boolean	isScanBased ()

void	setScanBased (boolean scanBased)

List< String >	getDetectors ()

void	setDetectors (List< String > detectors)
	param detectors the detectors to be used during the site 2d generation

String	getMethod ()

void	setMethod (String method)

String	getProdpar ()

void	setProdpar (String prodpar)

boolean	isApplyGRA ()

void	setApplyGRA (boolean applyGRA)

boolean	isIgnoreMalfunc ()

void	setIgnoreMalfunc (boolean ignoreMalfunc)

boolean	isCtFilter ()

void	setCtFilter (boolean ctFilter)

double	getZR_A ()

void	setZR_A (double zR_A)

double	getZR_b ()

void	setZR_b (double zR_b)

String	getPcsid ()

void	setPcsid (String pcsid)

double	getXscale ()

void	setXscale (double xscale)

double	getYscale ()

void	setYscale (double yscale)

String	getOptions ()

void	setOptions (String options)

IFilter	getFilter ()

void	setFilter (IFilter filter)

MetadataMatcher	getMatcher ()

void	setMatcher (MetadataMatcher matcher)

int	getQualityControlMode ()

String	getQualityControlModeAsString ()

void	setQualityControlMode (int qualityControlMode)

void	setQualityControlMode (String qualityControlMode)

Static Public Attributes
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 String	TYPE = "blt_site2d"
	The name of this static composite type.

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

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

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

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

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

Protected Member Functions
void	setCatalog (Catalog catalog)

Catalog	getCatalog ()

void	setRuleUtilities (IRuleUtilities ruleUtil)

IRuleUtilities	getRuleUtilities ()

BltGenerateMessage	createMessage (String filename, Date date, Time time)

CatalogEntry	createCatalogEntry (FileEntry fe)
	Wraps a FileEntry in a CatalogEntry.

Detailed Description

Site 2D rule for beeing able to generate images from single scans & volumes.

Author: Anders Henja

Member Function Documentation

◆ afterPropertiesSet()

void eu.baltrad.beast.rules.site2d.Site2DRule.afterPropertiesSet ( )

inline

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

◆ createCatalogEntry()

CatalogEntry eu.baltrad.beast.rules.site2d.Site2DRule.createCatalogEntry ( FileEntry fe )

inlineprotected

Wraps a FileEntry in a CatalogEntry.

Parameters

fe	the file entry

Returns: the catalog entry

◆ getArea()

String eu.baltrad.beast.rules.site2d.Site2DRule.getArea ( )

inline

Returns: the area (can be null)

◆ getCatalog()

Catalog eu.baltrad.beast.rules.site2d.Site2DRule.getCatalog ( )

inlineprotected

Returns: the catalog

◆ getDetectors()

List< String > eu.baltrad.beast.rules.site2d.Site2DRule.getDetectors ( )

inline

Returns: the detectors to be used during the site 2d generation

◆ getInterval()

int eu.baltrad.beast.rules.site2d.Site2DRule.getInterval ( )

inline

Returns: the interval

◆ getMethod()

String eu.baltrad.beast.rules.site2d.Site2DRule.getMethod ( )

inline

Returns: the method to use for the generation

◆ getOptions()

String eu.baltrad.beast.rules.site2d.Site2DRule.getOptions ( )

inline

Returns: the options

◆ getPcsid()

String eu.baltrad.beast.rules.site2d.Site2DRule.getPcsid ( )

inline

Returns: The pcs to use if the best-fit area approach should be used

◆ getProdpar()

String eu.baltrad.beast.rules.site2d.Site2DRule.getProdpar ( )

inline

Returns: the product parameters to use in the method

◆ getRuleId()

int eu.baltrad.beast.rules.site2d.Site2DRule.getRuleId ( )

inline

Returns: the ruleid

◆ getRuleUtilities()

IRuleUtilities eu.baltrad.beast.rules.site2d.Site2DRule.getRuleUtilities ( )

inlineprotected

Returns: the ruleUtil

◆ getSources()

List< String > eu.baltrad.beast.rules.site2d.Site2DRule.getSources ( )

inline

Returns: the sources this rule affects

◆ getType()

String eu.baltrad.beast.rules.site2d.Site2DRule.getType ( )

inline

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

Implements eu.baltrad.beast.rules.IRule.

◆ getXscale()

double eu.baltrad.beast.rules.site2d.Site2DRule.getXscale ( )

inline

Returns: The xscale (in meters) to use if the best-fit area approach should be used

◆ getYscale()

double eu.baltrad.beast.rules.site2d.Site2DRule.getYscale ( )

inline

Returns: The yscale (in meters) to use if the best-fit area approach should be used

◆ getZR_A()

double eu.baltrad.beast.rules.site2d.Site2DRule.getZR_A ( )

inline

Returns: the ZR-A conversion factor

◆ getZR_b()

double eu.baltrad.beast.rules.site2d.Site2DRule.getZR_b ( )

inline

Returns: the ZR-b conversion factor

◆ handle()

IBltMessage eu.baltrad.beast.rules.site2d.Site2DRule.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.site2d.Site2DRule.isApplyGRA ( )

inline

Returns: if gra adjustment should be performed or not

◆ isCtFilter()

boolean eu.baltrad.beast.rules.site2d.Site2DRule.isCtFilter ( )

inline

Returns: if ct filtering should be applied or not

◆ isIgnoreMalfunc()

boolean eu.baltrad.beast.rules.site2d.Site2DRule.isIgnoreMalfunc ( )

inline

Returns: if malfunc scans should be ignored or not.

◆ isScanBased()

boolean eu.baltrad.beast.rules.site2d.Site2DRule.isScanBased ( )

inline

Returns: if this rule affects scans or not. If false, then volumes are handled.

◆ isValid()

boolean eu.baltrad.beast.rules.site2d.Site2DRule.isValid ( )

inline

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

Implements eu.baltrad.beast.rules.IRule.

◆ setApplyGRA()

void eu.baltrad.beast.rules.site2d.Site2DRule.setApplyGRA ( boolean applyGRA )

inline

Parameters

applyGRA if gra adjustment should be performed or not

◆ setArea()

void eu.baltrad.beast.rules.site2d.Site2DRule.setArea ( String area )

inline

Parameters

area	the area to use for the generated product (may be null and in that case, best fit approach is used)

◆ setCatalog()

void eu.baltrad.beast.rules.site2d.Site2DRule.setCatalog ( Catalog catalog )

inlineprotected

Parameters

catalog the catalog to set

◆ setCtFilter()

void eu.baltrad.beast.rules.site2d.Site2DRule.setCtFilter ( boolean ctFilter )

inline

Parameters

ctFilter if ct filtering should be applied or not

◆ setDetectors()

void eu.baltrad.beast.rules.site2d.Site2DRule.setDetectors ( List< String > detectors )

inline

param detectors the detectors to be used during the site 2d generation

◆ setIgnoreMalfunc()

void eu.baltrad.beast.rules.site2d.Site2DRule.setIgnoreMalfunc ( boolean ignoreMalfunc )

inline

Parameters

ignoreMalfunc if malfunc scans should be ignored or not.

◆ setInterval()

void eu.baltrad.beast.rules.site2d.Site2DRule.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

◆ setMethod()

void eu.baltrad.beast.rules.site2d.Site2DRule.setMethod ( String method )

inline

Parameters

method the method to use for the generation

◆ setOptions()

void eu.baltrad.beast.rules.site2d.Site2DRule.setOptions ( String options )

inline

Parameters

options the options to set

◆ setPcsid()

void eu.baltrad.beast.rules.site2d.Site2DRule.setPcsid ( String pcsid )

inline

Parameters

pcsid The pcs to use if the best-fit area approach should be used

◆ setProdpar()

void eu.baltrad.beast.rules.site2d.Site2DRule.setProdpar ( String prodpar )

inline

Parameters

prodpar the product parameters to use in the method

◆ setRuleId()

void eu.baltrad.beast.rules.site2d.Site2DRule.setRuleId ( int ruleid )

inline

Parameters

ruleid the ruleid to set

◆ setRuleUtilities()

void eu.baltrad.beast.rules.site2d.Site2DRule.setRuleUtilities ( IRuleUtilities ruleUtil )

inlineprotected

Parameters

ruleUtil the ruleUtil to set

◆ setScanBased()

void eu.baltrad.beast.rules.site2d.Site2DRule.setScanBased ( boolean scanBased )

inline

Parameters

scanBased if this rule should affect scans or not. If false, the volumes are handled

◆ setSources()

void eu.baltrad.beast.rules.site2d.Site2DRule.setSources ( List< String > sources )

inline

Parameters

sources the sources this rule should affect

◆ setXscale()

void eu.baltrad.beast.rules.site2d.Site2DRule.setXscale ( double xscale )

inline

Parameters

xscale The xscale (in meters) to use if the best-fit area approach should be used

◆ setYscale()

void eu.baltrad.beast.rules.site2d.Site2DRule.setYscale ( double yscale )

inline

Parameters

yscale The yscale (in meters) to use if the best-fit area approach should be used

◆ setZR_A()

void eu.baltrad.beast.rules.site2d.Site2DRule.setZR_A ( double zR_A )

inline

Parameters

zR_A	the ZR-A conversion factor

◆ setZR_b()

void eu.baltrad.beast.rules.site2d.Site2DRule.setZR_b ( double zR_b )

inline

Parameters

zR_b	the ZR-b conversion factor

Member Data Documentation

◆ CAPPI

final String eu.baltrad.beast.rules.site2d.Site2DRule.CAPPI = "cappi"

static

To set that method should be CAPPPI generation.

◆ MAX

final String eu.baltrad.beast.rules.site2d.Site2DRule.MAX = "max"

static

Use Max generation.

◆ PCAPPI

final String eu.baltrad.beast.rules.site2d.Site2DRule.PCAPPI = "pcappi"

static

To set that method should be PCAPPI generation.

◆ PMAX

final String eu.baltrad.beast.rules.site2d.Site2DRule.PMAX = "pmax"

static

Use Pseudo-Max generation.

◆ PPI

final String eu.baltrad.beast.rules.site2d.Site2DRule.PPI = "ppi"

static

To set that method should be PPI generation.

◆ QualityControlMode_ANALYZE

final int eu.baltrad.beast.rules.site2d.Site2DRule.QualityControlMode_ANALYZE = 1

static

Only performs the quality analysis.

◆ QualityControlMode_ANALYZE_AND_APPLY

final int eu.baltrad.beast.rules.site2d.Site2DRule.QualityControlMode_ANALYZE_AND_APPLY = 0

static

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

◆ TYPE

final String eu.baltrad.beast.rules.site2d.Site2DRule.TYPE = "blt_site2d"

static

The name of this static composite type.

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

src/eu/baltrad/beast/rules/site2d/Site2DRule.java

Public Member Functions

Static Public Attributes

Protected Member Functions

Detailed Description

Member Function Documentation

◆ afterPropertiesSet()

◆ createCatalogEntry()

◆ getArea()

◆ getCatalog()

◆ getDetectors()

◆ getInterval()

◆ getMethod()

◆ getOptions()

◆ getPcsid()

◆ getProdpar()

◆ getRuleId()

◆ getRuleUtilities()

◆ getSources()

◆ getType()

◆ getXscale()

◆ getYscale()

◆ getZR_A()

◆ getZR_b()

◆ handle()

◆ isApplyGRA()

◆ isCtFilter()

◆ isIgnoreMalfunc()

◆ isScanBased()

◆ isValid()

◆ setApplyGRA()

◆ setArea()

◆ setCatalog()

◆ setCtFilter()

◆ setDetectors()

◆ setIgnoreMalfunc()

◆ setInterval()

◆ setMethod()

◆ setOptions()

◆ setPcsid()

◆ setProdpar()

◆ setRuleId()

◆ setRuleUtilities()

◆ setScanBased()

◆ setSources()

◆ setXscale()

◆ setYscale()

◆ setZR_A()

◆ setZR_b()

Member Data Documentation

◆ CAPPI

◆ MAX

◆ PCAPPI

◆ PMAX

◆ PPI

◆ QualityControlMode_ANALYZE

◆ QualityControlMode_ANALYZE_AND_APPLY

◆ TYPE