TLcdLOSRadarPropagationFunctionCoverageMatrixWrapper (LuciadLightspeed API documentation)

java.lang.Object
- com.luciad.tea.TLcdLOSRadarPropagationFunctionCoverageMatrixWrapper

All Implemented Interfaces:

ILcdLOSPropagationFunction, ILcdLOSRadarPropagationFunction
```
public class TLcdLOSRadarPropagationFunctionCoverageMatrixWrapper
extends Object
implements ILcdLOSRadarPropagationFunction
```
Wrapper class, enabling multiple step processing of line-of-sight computation results. This class wraps the result of a line-of-sight computation with a radar propagation function as a line-of-sight propagation function. This function can be used as input for other propagation functions (as TLcdLOSRadarPropagationFunctionSkyBackground) without having to redo the original line-of-sight computations.

Field Summary
- Fields inherited from interface com.luciad.tea.ILcdLOSRadarPropagationFunction
  INVISIBLE, UNKNOWN

Constructor Summary

Constructors
Constructor and Description
`TLcdLOSRadarPropagationFunctionCoverageMatrixWrapper(ILcdLOSCoverageMatrix aLOSCoverageMatrix, ILcdLOSRadarPropagationFunction aLOSRadarPropagationFunction)` Creates a propagation function which delegates its methods to a fixed line-of-sight coverage matrix (`ILcdLOSCoverageMatrix`).

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`applyForAzimuthSFCT(double aAzimuth, ILcdLOSCoverageMatrix aLOSCoverageMatrixSFCT)` Stores the fixed matrix values for the given azimuth `aAzimuth` in the given polar matrix `aEditablePolarMatrixViewSFCT`.
`ILcdLOSCoverageMatrix`	`createLOSCoverageMatrix(ILcdLOSCoverage aLOSCoverage, ILcdGeoReference aMatrixReference)` Creates a clone of the fixed coverage matrix with which this instance was created.
`TLcdCoverageAltitudeMode`	`getAltitudeMode()` Returns the altitude mode indicating the definition of the resulting line-of-sight values.
`TLcdEarthRepresentationMode`	`getEarthRepresentationMode()` Returns the earth representation mode used by this instance.
`double`	`getKFactor()` Returns the K-factor indicating the reflection of radar waves on the atmosphere.
`double`	`getMaxRadarTiltAngle()` Returns the maximum radar tilt angle in degrees, starting from 0 at the horizontal plane to 90 at zenith.
`double`	`getMaxRadarTiltAzimuth()` Returns the azimuth in degrees where the maximum radar tilt angle occurs.
`double`	`getMaxVerticalAngle()` Returns the maximum angle of the vertical extent in degrees, starting from 0 at the ground to 180 at zenith.
`double`	`getMinVerticalAngle()` Returns the minimum angle of the vertical extent in degrees, starting from 0 at the ground to 180 at zenith.
`ALcdTerrainElevationProvider`	`getTerrainElevationProvider()` Returns the elevation provider used to retrieve the terrain elevation data.
`void`	`initialize(ILcdLOSCoverage aLOSCoverage, ILcdGeoReference aMatrixReference)` Empty implementation because the fixed coverage matrix is already initialized.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TLcdLOSRadarPropagationFunctionCoverageMatrixWrapper
```
public TLcdLOSRadarPropagationFunctionCoverageMatrixWrapper(ILcdLOSCoverageMatrix aLOSCoverageMatrix,
                                                            ILcdLOSRadarPropagationFunction aLOSRadarPropagationFunction)
```
    Creates a propagation function which delegates its methods to a fixed line-of-sight coverage matrix (ILcdLOSCoverageMatrix). Note that the coverage matrix and the propagation function cannot be set to null. If this condition is not met, a NullPointerException will be thrown.
    
    Parameters:
    
    aLOSCoverageMatrix - The fixed coverage matrix to use in this propagation function.
    
    aLOSRadarPropagationFunction - The propagation function used to create the fixed coverage matrix.
    
    Throws:
    
    NullPointerException - when the argument aLOSCoverageMatrix or the argument aLOSRadarPropagationFunction is null.
- Method Detail
  - createLOSCoverageMatrix
```
public ILcdLOSCoverageMatrix createLOSCoverageMatrix(ILcdLOSCoverage aLOSCoverage,
                                                     ILcdGeoReference aMatrixReference)
```
    Creates a clone of the fixed coverage matrix with which this instance was created.
    
    Specified by:
    
    createLOSCoverageMatrix in interface ILcdLOSPropagationFunction
    
    Parameters:
    
    aLOSCoverage - The covered area and the intermediate step sizes.
    
    aMatrixReference - The reference in which this matrix is defined.
    
    Returns:
    
    the created coverage matrix.
  - initialize
```
public void initialize(ILcdLOSCoverage aLOSCoverage,
                       ILcdGeoReference aMatrixReference)
```
    Empty implementation because the fixed coverage matrix is already initialized.
    
    Specified by:
    
    initialize in interface ILcdLOSPropagationFunction
    
    Parameters:
    
    aLOSCoverage - The covered area to use.
    
    aMatrixReference - The matrix reference in which to compute the matrix values.
  - applyForAzimuthSFCT
```
public void applyForAzimuthSFCT(double aAzimuth,
                                ILcdLOSCoverageMatrix aLOSCoverageMatrixSFCT)
```
    Stores the fixed matrix values for the given azimuth aAzimuth in the given polar matrix aEditablePolarMatrixViewSFCT. Note that the method assumes that the matrix contains a column for that specific azimuth.
    
    Specified by:
    
    applyForAzimuthSFCT in interface ILcdLOSPropagationFunction
    
    Parameters:
    
    aAzimuth - The azimuth in degrees.
    
    aLOSCoverageMatrixSFCT - The coverage matrix to update.
    
    Throws:
    
    NullPointerException - if the aLOSCoverageMatrixSFCT is null.
  - getEarthRepresentationMode
```
public TLcdEarthRepresentationMode getEarthRepresentationMode()
```
    Description copied from interface: ILcdLOSRadarPropagationFunction
    
    Returns the earth representation mode used by this instance.
    
    Specified by:
    
    getEarthRepresentationMode in interface ILcdLOSRadarPropagationFunction
    
    Returns:
    
    the earth representation mode used by this instance.
  - getAltitudeMode
```
public TLcdCoverageAltitudeMode getAltitudeMode()
```
    Description copied from interface: ILcdLOSRadarPropagationFunction
    
    Returns the altitude mode indicating the definition of the resulting line-of-sight values.
    
    Specified by:
    
    getAltitudeMode in interface ILcdLOSRadarPropagationFunction
    
    Returns:
    
    the altitude mode indicating the definition of the resulting line-of-sight values.
  - getKFactor
```
public double getKFactor()
```
    Description copied from interface: ILcdLOSRadarPropagationFunction
    
    Returns the K-factor indicating the reflection of radar waves on the atmosphere. For radar computations, values should be greater than 1, usually 4/3. Setting the value equal to 1 will yield the same results as visual line-of-sight computations.
    
    Specified by:
    
    getKFactor in interface ILcdLOSRadarPropagationFunction
    
    Returns:
    
    the K-factor indicating the reflection of radar waves on the atmosphere.
  - getMaxVerticalAngle
```
public double getMaxVerticalAngle()
```
    Description copied from interface: ILcdLOSRadarPropagationFunction
    
    Returns the maximum angle of the vertical extent in degrees, starting from 0 at the ground to 180 at zenith. It is the maximum vertical angle when the radar tilt angle is set to zero.
    
    Specified by:
    
    getMaxVerticalAngle in interface ILcdLOSRadarPropagationFunction
    
    Returns:
    
    the maximum angle of the vertical extent in degrees.
  - getMinVerticalAngle
```
public double getMinVerticalAngle()
```
    Description copied from interface: ILcdLOSRadarPropagationFunction
    
    Returns the minimum angle of the vertical extent in degrees, starting from 0 at the ground to 180 at zenith. It is the minimum vertical angle when the radar tilt angle is set to zero.
    
    Specified by:
    
    getMinVerticalAngle in interface ILcdLOSRadarPropagationFunction
    
    Returns:
    
    the minimum angle of the vertical extent in degrees.
  - getMaxRadarTiltAngle
```
public double getMaxRadarTiltAngle()
```
    Description copied from interface: ILcdLOSRadarPropagationFunction
    
    Returns the maximum radar tilt angle in degrees, starting from 0 at the horizontal plane to 90 at zenith.
    
    Specified by:
    
    getMaxRadarTiltAngle in interface ILcdLOSRadarPropagationFunction
    
    Returns:
    
    the maximum radar tilt angle in degrees.
  - getMaxRadarTiltAzimuth
```
public double getMaxRadarTiltAzimuth()
```
    Description copied from interface: ILcdLOSRadarPropagationFunction
    
    Returns the azimuth in degrees where the maximum radar tilt angle occurs.
    
    Specified by:
    
    getMaxRadarTiltAzimuth in interface ILcdLOSRadarPropagationFunction
    
    Returns:
    
    the azimuth in degrees where the maximum radar tilt angle occurs.
  - getTerrainElevationProvider
```
public ALcdTerrainElevationProvider getTerrainElevationProvider()
```
    Description copied from interface: ILcdLOSRadarPropagationFunction
    
    Returns the elevation provider used to retrieve the terrain elevation data.
    
    Specified by:
    
    getTerrainElevationProvider in interface ILcdLOSRadarPropagationFunction
    
    Returns:
    
    the elevation provider used to retrieve the terrain elevation data.

Terrain Analysis EngineClass TLcdLOSRadarPropagationFunctionCoverageMatrixWrapper

Field Summary

Fields inherited from interface com.luciad.tea.ILcdLOSRadarPropagationFunction

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TLcdLOSRadarPropagationFunctionCoverageMatrixWrapper

Method Detail

createLOSCoverageMatrix

initialize

applyForAzimuthSFCT

getEarthRepresentationMode

getAltitudeMode

getKFactor

getMaxVerticalAngle

getMinVerticalAngle

getMaxRadarTiltAngle

getMaxRadarTiltAzimuth

getTerrainElevationProvider