public class TLcyLOSCoverageBackEnd extends ALcyTEABackEnd
ILcdLOSCoverage
;
TLcdLOSCoverageFactory
;
ALcyTEABackEnd
Modifier and Type | Field and Description |
---|---|
static String |
ALTITUDE_KEY
The property name for a line-of-sight coverage's altitude.
|
static String |
ALTITUDE_MODE_KEY
The property name for a line-of-sight coverage's altitude mode.
|
static String |
ARC_ANGLE_KEY
The property name for a line-of-sight coverage's arc angle.
|
static String |
DOMAIN_OBJECT_CONTEXT_KEY
The property name for a line-of-sight coverage's associated domain object.
|
static String |
FIXED_HEIGHT_AMSL_KEY
Deprecated.
replaced by
FIXED_HEIGHT_KEY and FIXED_HEIGHT_MODE_KEY |
static String |
FIXED_HEIGHT_KEY
The property name for the fixed height of a fixed height propagation function.
|
static String |
FIXED_HEIGHT_MODE_KEY
The property name for the fixed height model of a fixed height propagation function.
|
static String |
K_FACTOR_KEY
The property name for a line-of-sight coverage's radar K-factor.
|
static String |
LOCATION_KEY
The property name for a line-of-sight coverage's location.
|
static String |
LOCATION_REFERENCE_KEY
The property name for a line-of-sight coverage's model reference .
|
static String |
MAX_RADIUS_KEY
The property name for a line-of-sight coverage's maximum radius.
|
static String |
MAX_VERTICAL_ANGLE_KEY
The property name for a line-of-sight coverage's maximum vertical angle.
|
static String |
MIN_VERTICAL_ANGLE_KEY
The property name for a line-of-sight coverage's minimum vertical angle.
|
static String |
PROPAGATION_FUNCTION_KEY
The property name for a line-of-sight coverage's propagation function.
|
static String |
PROPAGATION_FUNCTION_VALUE_FIXED_HEIGHT
Denotes a propagation function with fixed height.
|
static String |
PROPAGATION_FUNCTION_VALUE_NORMAL
Denotes a normal propagation function.
|
static String |
PROPAGATION_FUNCTION_VALUE_SKY_BACKGROUND
Denotes a propagation function with sky in background.
|
static String |
START_ANGLE_KEY
The property name for a line-of-sight coverage's start angle.
|
ALTITUDE_PROVIDER_KEY, DISPLAY_NAME_KEY, MODEL_DISPLAY_NAME_KEY, MODEL_REFERENCE_KEY, QUALITY_KEY, SHAPE_KEY, SHAPE_REFERENCE_KEY, SOURCE_NAME_KEY, TARGET_REFERENCE_KEY, VIEW_KEY
Constructor and Description |
---|
TLcyLOSCoverageBackEnd(ILcyLucyEnv aLucyEnv)
Default constructor for the line-of-sight coverage back-end.
|
Modifier and Type | Method and Description |
---|---|
ILcdLOSCoverage |
createCoverage(ALcyProperties aProperties)
Creates a new line-of-sight coverage, based on the given properties.
|
TLcdLOSCoverageFactory |
createLOSCoverageFactory(ALcyProperties aProperties)
Returns a line-of-sight coverage factory with which to compute coverages.
|
TLspLOSCalculator |
createLspLOSCoverageCalculator()
Returns a
TLspLOSCalculator
used to calculate ILcdLOSCoverageMatrix
instances, which make use of OpenCL functionality and are therefore faster than the default ILcdLOSCoverageMatrix
calculator. |
ILcdModelDescriptor |
createModelDescriptor(ALcyProperties aProperties)
Returns a model descriptor suitable for the add-on's used models.
|
ILcdLOSPropagationFunction |
createPropagationFunction(ALcyProperties aProperties)
Creates a new line-of-sight propagation function, based on the given properties.
|
ILcdMatrixRasterValueMapper |
createPropagationMatrixRasterValueMapper(String aPropagationFunctionKey)
Returns an
ILcdMatrixRasterValueMapper for the given propagation function ID. |
String |
retrievePropagationFunctionLabel(String aPropagationFunctionKey)
Returns a displayable label for the given propagation function ID.
|
createAltitudeDescriptor, createAltitudeMatrixViewFactory, createAltitudeProvider, getLucyEnv
public static final String DOMAIN_OBJECT_CONTEXT_KEY
TLcyDomainObjectContext
.public static final String LOCATION_KEY
ILcdPoint
.public static final String LOCATION_REFERENCE_KEY
ILcdGeoReference
.public static final String ALTITUDE_KEY
public static final String ALTITUDE_MODE_KEY
TLcdCoverageAltitudeMode
.public static final String START_ANGLE_KEY
public static final String ARC_ANGLE_KEY
public static final String MAX_RADIUS_KEY
public static final String MIN_VERTICAL_ANGLE_KEY
public static final String MAX_VERTICAL_ANGLE_KEY
public static final String K_FACTOR_KEY
public static final String PROPAGATION_FUNCTION_KEY
PROPAGATION_FUNCTION_VALUE_FIXED_HEIGHT
,
PROPAGATION_FUNCTION_VALUE_NORMAL
and PROPAGATION_FUNCTION_VALUE_SKY_BACKGROUND
.@Deprecated public static final String FIXED_HEIGHT_AMSL_KEY
FIXED_HEIGHT_KEY
and FIXED_HEIGHT_MODE_KEY
public static final String FIXED_HEIGHT_KEY
public static final String FIXED_HEIGHT_MODE_KEY
TLcdCoverageAltitudeMode
.public static final String PROPAGATION_FUNCTION_VALUE_NORMAL
public static final String PROPAGATION_FUNCTION_VALUE_SKY_BACKGROUND
public static final String PROPAGATION_FUNCTION_VALUE_FIXED_HEIGHT
public TLcyLOSCoverageBackEnd(ILcyLucyEnv aLucyEnv)
aLucyEnv
- the Lucy environment for which the back-end will be usedpublic ILcdModelDescriptor createModelDescriptor(ALcyProperties aProperties)
createModelDescriptor
in class ALcyTEABackEnd
aProperties
- a properties object with the following parameters:
ALcyTEABackEnd.SOURCE_NAME_KEY
: The source name that was used to retrieve the data
from, use null
to indicate that it was
created from scratch.
ALcyTEABackEnd.DISPLAY_NAME_KEY
: the display name that the model descriptor should
use @return a suitable model descriptor
public ILcdLOSPropagationFunction createPropagationFunction(ALcyProperties aProperties)
Creates a new line-of-sight propagation function, based on the given properties. This implementation supports three functions: normal, sky in background, and fixed height. The type of function returned depends on the PROPAGATION_FUNCTION_KEY property.
Note that in some situations this propagation function is by default replaced
by a TLspLOSCalculator
. To know the circumstances in which the
TLspLOSCalculator
is used, see createLspLOSCoverageCalculator()
.
aProperties
- The arguments of this method. For the normal and sky in background functions,
the following properties are needed:
ALcyTEABackEnd.ALTITUDE_PROVIDER_KEY
, an altitude provider of type ALcdTerrainElevationProvider
ALTITUDE_MODE_KEY
, the altitude mode
MIN_VERTICAL_ANGLE_KEY
, the minumum vertical angle
MAX_VERTICAL_ANGLE_KEY
, the maximum vertical angle
FIXED_HEIGHT_KEY
, the fixed height
FIXED_HEIGHT_MODE_KEY
, the altitude mode
createLspLOSCoverageCalculator()
public ILcdLOSCoverage createCoverage(ALcyProperties aProperties)
aProperties
- The arguments of this method. The following properties are needed:
ALcyTEABackEnd.QUALITY_KEY
, the quality on which to base the coverage's sample density
LOCATION_KEY
, coverage's location
LOCATION_REFERENCE_KEY
, the geo-reference of the location
DOMAIN_OBJECT_CONTEXT_KEY
, the coverage's associated domain object. Objects implementing
ILcdOriented
will have their orientation added to the start angle.
ALTITUDE_KEY
, the coverage's altitude
ALTITUDE_MODE_KEY
, the coverage's altitude mode
START_ANGLE_KEY
, the coverage's start angle
ARC_ANGLE_KEY
, the coverage's arc angle
MAX_RADIUS_KEY
, the coverage's maximum radius
ALcyTEABackEnd.TARGET_REFERENCE_KEY
, the geo-reference of the target object. This property
is used to compute the required step sizes.
public TLcdLOSCoverageFactory createLOSCoverageFactory(ALcyProperties aProperties)
aProperties
- This implementation does not require any arguments.public TLspLOSCalculator createLspLOSCoverageCalculator()
Returns a TLspLOSCalculator
used to calculate ILcdLOSCoverageMatrix
instances, which make use of OpenCL functionality and are therefore faster than the default ILcdLOSCoverageMatrix
calculator.
For performance reasons, we advice to reuse the line-of-sight calculator as much as possible.
Note that this calculator will be only be used when all the following statements hold true:
TLcyLOSCoverageAddOn
's config file, is set to true.ILcdLOSCoverageMatrix
is 'above ground', 'above mean sea level' or 'above geoid'TLspLOSCalculator
used to calculate ILcdLOSCoverageMatrix
instances. Can be null
,
in case the calculator could not be created while OpenCL is supported.UnsupportedOperationException
- An exception is thrown when either no Lightspeed license option is available or when OpenCL is not
supported.createPropagationFunction(ALcyProperties)
public String retrievePropagationFunctionLabel(String aPropagationFunctionKey)
aPropagationFunctionKey
- one of PROPAGATION_FUNCTION_VALUE_NORMAL
, PROPAGATION_FUNCTION_VALUE_SKY_BACKGROUND
,
or PROPAGATION_FUNCTION_VALUE_FIXED_HEIGHT
.public ILcdMatrixRasterValueMapper createPropagationMatrixRasterValueMapper(String aPropagationFunctionKey)
ILcdMatrixRasterValueMapper
for the given propagation function ID.aPropagationFunctionKey
- one of PROPAGATION_FUNCTION_VALUE_NORMAL
, PROPAGATION_FUNCTION_VALUE_SKY_BACKGROUND
,
or PROPAGATION_FUNCTION_VALUE_FIXED_HEIGHT
.