Interface ILcdPolarMatrixView

All Superinterfaces:
ILcdMatrixView
All Known Subinterfaces:
ILcdEditablePolarMatrixView, ILcdLOSCoverageMatrix

public interface ILcdPolarMatrixView extends ILcdMatrixView
An ILcdPolarMatrixView is an ILcdMatrixView which represents a polar 2D data structure where the values and associated points can be accessed through an azimuth and a radius.

Each matrix column corresponds to a fixed azimuth (defined in degrees) and each row to a fixed distance (defined in meters) from the center point. Therefore a polar matrix view contains a method to convert an azimuth/radius to the column/row index corresponding to the azimuth/radius.

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    getAzimuth(int aColumnIndex)
    Returns the azimuth corresponding to the given aColumnIndex.
    int
    getColumn(double aAzimuth)
    Returns the column index corresponding to the given aAzimuth.
    double
    getRadius(int aRowIndex)
    Returns the radius corresponding to the given aRowIndex.
    int
    getRow(double aRadius)
    Returns the row index corresponding to the given aRadius.
    double
    getValue(double aAzimuth, double aRadius)
    Returns the value of the matrix pixel corresponding to the azimuth aAzimuth and the radius aRadius.
    double
    retrieveAssociatedPointX(double aAzimuth, double aRadius)
    Returns the x-coordinate of the associated point corresponding to the azimuth aAzimuth and the radius aRadius.
    double
    retrieveAssociatedPointY(double aAzimuth, double aRadius)
    Returns the y-coordinate of the associated point corresponding to the azimuth aAzimuth and the radius aRadius.
  • Method Details

    • getValue

      double getValue(double aAzimuth, double aRadius)
      Returns the value of the matrix pixel corresponding to the azimuth aAzimuth and the radius aRadius. If the given azimuth/radius does not correspond to a fixed azimuth/radius used by this instance, a surrounding fixed azimuth/radius can be used to retrieve the value of the matrix pixel.

      This method can use the methods getColumn(double) and getRow(double) to convert the double indices to integer indices. The value of the matrix pixel can then be retrieved using the method ILcdMatrixView.getValue(int, int).

      Parameters:
      aAzimuth - the azimuth, defined in degrees.
      aRadius - the radius, defined in meters.
      Returns:
      the value of the matrix pixel.
    • retrieveAssociatedPointX

      double retrieveAssociatedPointX(double aAzimuth, double aRadius)
      Returns the x-coordinate of the associated point corresponding to the azimuth aAzimuth and the radius aRadius. If the given azimuth/radius does not correspond to a fixed azimuth/radius used by this instance, a surrounding fixed azimuth/radius can be used to retrieve the x-coordinate. The definition of an associated point can be found in the class documentation of ILcdMatrixView.

      This method can use the methods getColumn(double) and getRow(double) to convert the double indices to integer indices. The x-coordinate of the matrix pixel can then be retrieved using the method ILcdMatrixView.retrieveAssociatedPointX(int, int).

      Parameters:
      aAzimuth - the azimuth, defined in degrees.
      aRadius - the radius, defined in meters.
      Returns:
      the x-coordinate of the associated point.
    • retrieveAssociatedPointY

      double retrieveAssociatedPointY(double aAzimuth, double aRadius)
      Returns the y-coordinate of the associated point corresponding to the azimuth aAzimuth and the radius aRadius. If the given azimuth/radius does not correspond to a fixed azimuth/radius used by this instance, a surrounding fixed azimuth/radius can be used to retrieve the y-coordinate. The definition of an associated point can be found in the class documentation of ILcdMatrixView.

      This method can use the methods getColumn(double) and getRow(double) to convert the double indices to integer indices. The y-coordinate of the matrix pixel can then be retrieved using the method ILcdMatrixView.retrieveAssociatedPointY(int, int).

      Parameters:
      aAzimuth - the azimuth, defined in degrees.
      aRadius - the radius, defined in meters.
      Returns:
      the y-coordinate of the associated point.
    • getColumn

      int getColumn(double aAzimuth)
      Returns the column index corresponding to the given aAzimuth. If the given azimuth does not correspond to a fixed azimuth used by this instance, a surrounding fixed azimuth can be used.
      Parameters:
      aAzimuth - the azimuth, defined in degrees.
      Returns:
      the column index.
    • getRow

      int getRow(double aRadius)
      Returns the row index corresponding to the given aRadius. If the given radius does not correspond to a fixed radius used by this instance, a surrounding fixed radius can be used.
      Parameters:
      aRadius - the radius, defined in meters.
      Returns:
      the row index.
    • getAzimuth

      double getAzimuth(int aColumnIndex)
      Returns the azimuth corresponding to the given aColumnIndex. Each matrix column corresponds to a fixed azimuth (defined in degrees)
      Parameters:
      aColumnIndex - the column index.
      Returns:
      the fixed azimuth, defined in degrees.
    • getRadius

      double getRadius(int aRowIndex)
      Returns the radius corresponding to the given aRowIndex. Each matrix row corresponds to a fixed distance (defined in meters) from the center point.
      Parameters:
      aRowIndex - the row index.
      Returns:
      the fixed radius, defined in meters.