Package org.esa.snap.core.dataop.resamp

Interface Resampling

All Known Implementing Classes:

BilinearInterpolationResampling

public interface Resampling

An interface used to implement different resampling strategies.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Resampling.Index	An index is used to provide resampling information at a given raster position x,y.
static interface	Resampling.Raster	A raster is a rectangular grid which provides sample values at a given raster position x,y.

Field Summary

Fields

Modifier and Type	Field	Description
static Resampling	BICUBIC_INTERPOLATION	The bicubic spline interpolation resampling method.
static Resampling	BILINEAR_INTERPOLATION	The bilinear interpolation resampling method.
static Resampling	BISINC_11_POINT_INTERPOLATION
static Resampling	BISINC_21_POINT_INTERPOLATION
static Resampling	BISINC_5_POINT_INTERPOLATION	The bisinc interpolation resampling method.
static Resampling	CUBIC_CONVOLUTION	The cubic convolution resampling method.
static Resampling	NEAREST_NEIGHBOUR	The nearest neighbour resampling method.

Method Summary

Modifier and Type	Method	Description
default void	computeCornerBasedIndex(double x, double y, int width, int height, Resampling.Index index)	Computes the index's properties for the given non-pixel coordinate without pixel center intensity assumption.
void	computeIndex(double x, double y, int width, int height, Resampling.Index index)	Computes the index's properties for the given pixel coordinate.
Resampling.Index	createIndex()	Factory method which creates an appropriate index for raster access.
default int	getKernelSize()
String	getName()	Gets a unique identifier for this resampling method, e.g.
double	resample(Resampling.Raster raster, Resampling.Index index)	Performs the actual resampling operation.

Field Detail

NEAREST_NEIGHBOUR

static final Resampling NEAREST_NEIGHBOUR

The nearest neighbour resampling method.

BILINEAR_INTERPOLATION

static final Resampling BILINEAR_INTERPOLATION

The bilinear interpolation resampling method.

CUBIC_CONVOLUTION

static final Resampling CUBIC_CONVOLUTION

The cubic convolution resampling method.

BISINC_5_POINT_INTERPOLATION

static final Resampling BISINC_5_POINT_INTERPOLATION

The bisinc interpolation resampling method.

BISINC_11_POINT_INTERPOLATION

static final Resampling BISINC_11_POINT_INTERPOLATION

BISINC_21_POINT_INTERPOLATION

static final Resampling BISINC_21_POINT_INTERPOLATION

BICUBIC_INTERPOLATION

static final Resampling BICUBIC_INTERPOLATION

The bicubic spline interpolation resampling method.

Method Detail

getName

String getName()

Gets a unique identifier for this resampling method, e.g. "BILINEAR_INTERPOLATION".

Returns:

a unique name

createIndex

Resampling.Index createIndex()

Factory method which creates an appropriate index for raster access.

Returns:

an appropriate index, never null

computeIndex

void computeIndex(double x,
                  double y,
                  int width,
                  int height,
                  Resampling.Index index)

Computes the index's properties for the given pixel coordinate.

Parameters:

x - the raster's x coordinate

y - the raster's y coordinate

width - the raster's width

height - the raster's height

index - the index object to which the results are to be assigned

computeCornerBasedIndex

default void computeCornerBasedIndex(double x,
                                     double y,
                                     int width,
                                     int height,
                                     Resampling.Index index)

Computes the index's properties for the given non-pixel coordinate without pixel center intensity assumption.

The default implementation computes the resampling index for given coordinate without pixel center intensity assumption. It adds 0.5 to coordinates to counter the consideration of pixel center in base function.

Parameters:

x - the raster's x coordinate

y - the raster's y coordinate

width - the raster's width

height - the raster's height

index - the index object to which the results are to be assigned

resample

double resample(Resampling.Raster raster,
                Resampling.Index index)
         throws Exception

Performs the actual resampling operation. If a sample value could not be computed at the given index, e.g. in case of missing data, the method returns the special value Float.NaN.

Parameters:

raster - the raster

index - the index, must be computed using the computeIndex(double, double, int, int, org.esa.snap.core.dataop.resamp.Resampling.Index) method

Returns:

either the re-sampled sample value or Float.NaN.

Throws:

Exception - if a non-runtime error occurs, e.g I/O error

getKernelSize

default int getKernelSize()