Package org.esa.snap.core.dataio.geocoding

Class ComponentGeoCoding

java.lang.Object
org.esa.snap.core.datamodel.AbstractGeoCoding
org.esa.snap.core.dataio.geocoding.ComponentGeoCoding
All Implemented Interfaces:
GeoCoding
public class ComponentGeoCoding extends AbstractGeoCoding

  • Field Details

    • SYSPROP_SNAP_PIXEL_CODING_FRACTION_ACCURACY

      public static final String SYSPROP_SNAP_PIXEL_CODING_FRACTION_ACCURACY
      See Also:

  • Constructor Details

    • ComponentGeoCoding

      public ComponentGeoCoding(GeoRaster geoRaster, ForwardCoding forwardCoding, InverseCoding inverseCoding)
      Constructs a GeoCoding with given GeoRaster, ForwardCoding and InverseCoding. No geoChecks will be performed during initialize phase. Defaults to WGS84 CRS. Forward and/or Inverse coding can be null.
      Parameters:
      geoRaster - the GeoRaster
      forwardCoding - the ForwardCoding, can be null
      inverseCoding - the InverseCoding, can be null

    • ComponentGeoCoding

      public ComponentGeoCoding(GeoRaster geoRaster, ForwardCoding forwardCoding, InverseCoding inverseCoding, GeoChecks geoChecks)
      Constructs a GeoCoding with given GeoRaster, ForwardCoding, InverseCoding and GeoCheck definition to be executed during initialize phase. Defaults to WGS84 CRS. Forward and/or Inverse coding can be null.
      Parameters:
      geoRaster - the GeoRaster
      forwardCoding - the ForwardCoding, can be null
      inverseCoding - the InverseCoding, can be null
      geoChecks - definition of GeoChecks to be executed during initialization

    • ComponentGeoCoding

      public ComponentGeoCoding(GeoRaster geoRaster, ForwardCoding forwardCoding, InverseCoding inverseCoding, org.opengis.referencing.crs.CoordinateReferenceSystem geoCRS)
      Constructs a GeoCoding with given GeoRaster, ForwardCoding, InverseCoding and CRS. No GeoChecks will be performed during initialize phase. Forward and/or Inverse coding can be null.
      Parameters:
      geoRaster - the GeoRaster
      forwardCoding - the ForwardCoding, can be null
      inverseCoding - the InverseCoding, can be null
      geoCRS - the CRS

    • ComponentGeoCoding

      public ComponentGeoCoding(GeoRaster geoRaster, ForwardCoding forwardCoding, InverseCoding inverseCoding, GeoChecks geoChecks, org.opengis.referencing.crs.CoordinateReferenceSystem geoCRS)
      Constructs a GeoCoding with given GeoRaster, ForwardCoding, InverseCoding, GeoChecks to be performed during initialization and CRS. Forward and/or Inverse coding can be null.
      Parameters:
      geoRaster - the GeoRaster
      forwardCoding - the ForwardCoding, can be null
      inverseCoding - the InverseCoding, can be null
      geoChecks - definition of GeoChecks to be executed during initialization
      geoCRS - the CRS

  • Method Details

    • isCrossingMeridianAt180

      public boolean isCrossingMeridianAt180()
      Description copied from interface: GeoCoding
      Checks whether or not the longitudes of this geo-coding cross the +/- 180 degree meridian.
      Returns:
      true, if so

    • canGetPixelPos

      public boolean canGetPixelPos()
      Description copied from interface: GeoCoding
      Checks whether or not this geo-coding can determine the pixel position from a geodetic position.
      Returns:
      true, if so

    • canGetGeoPos

      public boolean canGetGeoPos()
      Description copied from interface: GeoCoding
      Checks whether or not this geo-coding can determine the geodetic position from a pixel position.
      Returns:
      true, if so

    • getPixelPos

      public PixelPos getPixelPos(GeoPos geoPos, PixelPos pixelPos)
      Description copied from interface: GeoCoding
      Returns the pixel co-ordinates as x/y for a given geographical position given as lat/lon.
      Parameters:
      geoPos - the geographical position as lat/lon in the coordinate system determined by GeoCoding.getGeoCRS()
      pixelPos - an instance of Point to be used as return value. If this parameter is null, the method creates a new instance which it then returns.
      Returns:
      the pixel co-ordinates as x/y

    • getGeoPos

      public GeoPos getGeoPos(PixelPos pixelPos, GeoPos geoPos)
      Description copied from interface: GeoCoding
      Returns the latitude and longitude value for a given pixel co-ordinate.
      Parameters:
      pixelPos - the pixel's co-ordinates given as x,y
      geoPos - an instance of GeoPos to be used as return value. If this parameter is null, the method creates a new instance which it then returns.
      Returns:
      the geographical position as lat/lon in the coordinate system determined by GeoCoding.getGeoCRS()

    • transferGeoCoding

      public boolean transferGeoCoding(Scene srcScene, Scene destScene, ProductSubsetDef subsetDef)
      Transfers the geo-coding of the srcScene to the destScene with respect to the given subsetDef.
      Specified by:
      transferGeoCoding in class AbstractGeoCoding
      Parameters:
      srcScene - the source scene
      destScene - the destination scene
      subsetDef - the definition of the subset, may be null
      Returns:
      true, if the geo-coding could be transferred.

    • dispose

      public void dispose()
      Description copied from interface: GeoCoding
      Releases all of the resources used by this object instance and all of its owned children. Its primary use is to allow the garbage collector to perform a vanilla job.

      This method should be called only if it is for sure that this object instance will never be used again. The results of referencing an instance of this class after a call to dispose() are undefined.

    • getDatum

      @Deprecated public Datum getDatum()
      Deprecated.
      use the datum of the associated map CRS.
      Gets the datum, the reference point or surface against which GeoPos measurements are made.
      Returns:
      the datum

    • clone

      public GeoCoding clone()
      Description copied from class: AbstractGeoCoding
      Creates a shallow clone of this geocoding. Geolocation raster data is shared.
      Specified by:
      clone in interface GeoCoding
      Overrides:
      clone in class AbstractGeoCoding
      Returns:
      the cloned geocoding

    • canClone

      public boolean canClone()
      Description copied from class: AbstractGeoCoding
      Check if geocoding can be cloned.
      Specified by:
      canClone in interface GeoCoding
      Overrides:
      canClone in class AbstractGeoCoding
      Returns:
      if so or not

    • initialize

      public void initialize()

    • getGeoChecks

      public GeoChecks getGeoChecks()

    • getForwardCoding

      public ForwardCoding getForwardCoding()

    • getInverseCoding

      public InverseCoding getInverseCoding()

    • getGeoRaster

      public GeoRaster getGeoRaster()