com.luciad.tea

Terrain Analysis EngineInterface ILcdLOSPropagationFunction

All Known Subinterfaces:

ILcdLOSRadarPropagationFunction

All Known Implementing Classes:

TLcdLOSPropagationFunctionFixedHeight, TLcdLOSRadarPropagationFunction, TLcdLOSRadarPropagationFunctionCoverageMatrixWrapper, TLcdLOSRadarPropagationFunctionSkyBackground

public interface ILcdLOSPropagationFunction

Computes values along a given azimuth and stores the result in an ILcdLOSCoverageMatrix. Typical for a propagation function is that previous results are being reused (hence the name propagation). For example, when a point is no longer visible from a certain distance, it will not be visible from another point at a greater distance in the same direction (or azimuth).

The function is initialized with the method initialize(ILcdLOSCoverage, ILcdGeoReference). The TLcdLOSCoverage contains the area on which the propagation function will be applied. The matrix reference is the ILcdGeoReference in which the computation is done. This reference should be the reference in which the matrix argument of the method applyForAzimuthSFCT is defined. For performance reasons, it is recommended that this method initializes all pre-computational fields.

The method createLOSCoverageMatrix(ILcdLOSCoverage, ILcdGeoReference) creates an empty matrix, that can be used with this propagation function. It requires a coverage and a matrix reference, needed to initialize the matrix. The matrix reference is the ILcdGeoReference in which the matrix will be defined.

Note that the matrix argument passed in the method applyForAzimuthSFCT(double, ILcdLOSCoverageMatrix) must also be initialized with the same coverage and matrix reference as given in the initialize method. The result of the interface method createLOSCoverageMatrix will be used as input for this method.

See Also:

TLcdLOSCoverageFactory

Method Summary

Modifier and Type	Method and Description
void	applyForAzimuthSFCT(double aAzimuth, ILcdLOSCoverageMatrix aLOSCoverageMatrixSFCT) Applies the function for the given azimuth and stores the results in the line-of-sight coverage matrix.
ILcdLOSCoverageMatrix	createLOSCoverageMatrix(ILcdLOSCoverage aLOSCoverage, ILcdGeoReference aMatrixReference) Creates a coverage matrix using the line-of-sight coverage aLOSCoverage and the matrix reference aMatrixReference.
void	initialize(ILcdLOSCoverage aLOSCoverage, ILcdGeoReference aMatrixReference) Initialize the propagation function with the given coverage aLOSCoverage and the given matrix reference aMatrixReference.

Method Detail

createLOSCoverageMatrix

ILcdLOSCoverageMatrix createLOSCoverageMatrix(ILcdLOSCoverage aLOSCoverage,
                                              ILcdGeoReference aMatrixReference)

Creates a coverage matrix using the line-of-sight coverage aLOSCoverage and the matrix reference aMatrixReference. The result of this method is used as input parameter for the method applyForAzimuthSFCT, which will store the actual matrix values. The matrix should be consistent with the given coverage. This means that all matrix rows and columns represent evenly spaced radii and azimuths as defined by the radial and angular step sizes of the line-of-sight coverage.

The method initialize(com.luciad.tea.ILcdLOSCoverage, com.luciad.reference.ILcdGeoReference) is called with the same arguments as supplied with this method.

The ILcdLOSCoverageMatrix created by this method is guaranteed to be capable of determining its own associatedPointX and associatedPointY properties. These values are not calculated by this ILcdPropagationFunction . An ILcdLOSPropagationFunction does not modify the values of the associatedPointX and associatedPointY for its created ILcdLOSCoverageMatrix.

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

void initialize(ILcdLOSCoverage aLOSCoverage,
                ILcdGeoReference aMatrixReference)

Initialize the propagation function with the given coverage aLOSCoverage and the given matrix reference aMatrixReference. For performance reasons, it is recommended that this method initializes all fields that are common to all computations or which do not depend on a specific azimuth.

Parameters:

aLOSCoverage - The covered area to use.

aMatrixReference - The matrix reference in which to compute the matrix values.

Throws:

NullPointerException - if a null argument is found.

IllegalArgumentException - if the initialization fails due to an invalid argument, e.g. when the coverage center point is located underneath the terrain,...

applyForAzimuthSFCT

void applyForAzimuthSFCT(double aAzimuth,
                         ILcdLOSCoverageMatrix aLOSCoverageMatrixSFCT)

Applies the function for the given azimuth and stores the results in the line-of-sight coverage matrix. Note that the method assumes that the matrix contains a column for that specific azimuth.

Keep in mind that the given matrix must be initialized with the same coverage and same reference as those given in the initialization. The result of the method createLOSCoverageMatrix will be used as input parameter for this method.

Parameters:

aAzimuth - The azimuth in degrees.

aLOSCoverageMatrixSFCT - The coverage matrix to update.

Throws:

NullPointerException - if the aLOSCoverageMatrixSFCT is null.