Package org.tinfour.utils.loaders

Interface ICoordinateTransform

  • All Known Implementing Classes:
    SimpleGeographicTransform
    public interface ICoordinateTransform
    Defines an interface for performing coordinate transforms. These transforms operate on the horizontal (2D) coordinates of the input.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean forward​(double xSource, double ySource, CoordinatePair transformedCoordinates)
      Transforms a point in a source coordinate system to the equivalent output.
      boolean inverse​(double xTransformed, double yTransformed, CoordinatePair sourceCoordinates)
      Transforms a point in an output coordinate system to the equivalent point in the source coordinate system.

    • Method Detail

      • forward

        boolean forward​(double xSource,
                double ySource,
                CoordinatePair transformedCoordinates)
        Transforms a point in a source coordinate system to the equivalent output. The return value indicates whether the transform was successful. In some cases, a transform may be defined only over a finite region.

        All transforms are assumed to be fully invertible (bijective) over their domain. If a forward transform is defined for a set of input coordinates, then the inverse transform must be defined for the resulting output coordinates.

        Parameters:
        xSource - the x value in the source coordinate system
        ySource - the y value in the source coordinate system
        transformedCoordinates - a simple container to receive the results of the computation, the transformed coordinates for (xSource, ySource).
        Returns:
        true if the transform is successful; otherwise, false

      • inverse

        boolean inverse​(double xTransformed,
                double yTransformed,
                CoordinatePair sourceCoordinates)
        Transforms a point in an output coordinate system to the equivalent point in the source coordinate system. The return value indicates whether the transform was successful. In some cases, a transform may be defined only over a finite region.

        All transforms are assumed to be fully invertible (bijective) over their domain. If a forward transform is defined for a set of input coordinates, then the inverse transform must be defined for the resulting output coordinates.

        Parameters:
        xTransformed - x value in the transformed coordinate system
        yTransformed - y value in the transformed coordiante system
        sourceCoordinates - a simple container to receive the results of the computation, the transformed coordinates for (xSource, ySource).
        Returns:
        true if the inverse transform is successful; otherwise, false