SNAP Temporal Percentile Operator test case failed

kygoh · May 27, 2019, 11:10pm

Unit test org.esa.snap.statistics.percentile.interpolated.MeanOpImageTest. testThatOperatorExceptionOccursWhenNoFloatingPointImagesAreProvided failed with the following stacktrace:

Expected: an instance of org.esa.snap.core.gpf.OperatorException
     but: <java.lang.NullPointerException> is a java.lang.NullPointerException
Stacktrace was: java.lang.NullPointerException
	at javax.media.jai.PlanarImage.copyData(PlanarImage.java:2344)
	at javax.media.jai.PlanarImage.getAsBufferedImage(PlanarImage.java:2525)
	at javax.media.jai.PlanarImage.getAsBufferedImage(PlanarImage.java:2546)
	at org.esa.snap.statistics.percentile.interpolated.MeanOpImageTest.testThatOperatorExceptionOccursWhenNoFloatingPointImagesAreProvided(MeanOpImageTest.java:131)
...

It appears that OperatorException was thrown because in surefire report <system-err> shows:

org.geotools.util.logging.LoggingImagingListener: Problem occurs when computing a tile by the owner.
org.esa.snap.core.gpf.OperatorException: Unable to compute raster for non floating number data type
	at org.esa.snap.statistics.percentile.interpolated.MeanOpImage.computeRect(MeanOpImage.java:37)
	at javax.media.jai.PointOpImage.computeTile(PointOpImage.java:914)
	at com.sun.media.jai.util.SunTileScheduler.scheduleTile(SunTileScheduler.java:904)
	at javax.media.jai.OpImage.getTile(OpImage.java:1129)
	at javax.media.jai.PlanarImage.copyData(PlanarImage.java:2343)
	at javax.media.jai.PlanarImage.getAsBufferedImage(PlanarImage.java:2525)
	at javax.media.jai.PlanarImage.getAsBufferedImage(PlanarImage.java:2546)
	at org.esa.snap.statistics.percentile.interpolated.MeanOpImageTest.testThatOperatorExceptionOccursWhenNoFloatingPointImagesAreProvided(MeanOpImageTest.java:131)
...

Any ideas NullPointerException was caught instead of OperatorException for exception.expect(OperatorException.class)?

marpet · May 28, 2019, 9:34am

The OperatorException is thrown here:

github.com

senbox-org/snap-engine/blob/1228118c1842d6b43bdeeeeeae39999d86545d96/snap-temporal-percentile/src/main/java/org/esa/snap/statistics/percentile/interpolated/MeanOpImage.java#L37


    }
    RasterAccessor d = new RasterAccessor(dest, destRect, formatTags[sources.length], getColorModel());
    switch (d.getDataType()) {
    case DataBuffer.TYPE_FLOAT:
        computeRectFloat(sourceRasterAccessors, d);
        break;
    case DataBuffer.TYPE_DOUBLE:
        computeRectDouble(sourceRasterAccessors, d);
        break;
    default:
        throw new OperatorException("Unable to compute raster for non floating number data type");
    }
    d.copyDataToRaster();
}


private void computeRectFloat(RasterAccessor[] sourceRasterAccessors, RasterAccessor dst) {


    final RasterAccessor src = sourceRasterAccessors[0];
    int sLineStride = src.getScanlineStride();
    int sPixelStride = src.getPixelStride();
    int[] sBandOffsets = src.getBandOffsets();

For me on Windows the test works also on our build platform (Linux) it works. Maybe Mac is again a bit different here. I’ll test it in the coming days on Mac

Actually throwing OperatorException is not correct in the MeanOpImage. Because it is not a GPF operator. It would be better to throw UnsupportedOperationException similar. I’ll check if I can change this easily.

kygoh · May 28, 2019, 10:23am

I also had to add the following dependency in snap-desktop/snap-ui/pom.xml in order to successfully complete the snap-desktop build:

<dependency>
    <groupId>org.esa.snap</groupId>
    <artifactId>snap-gpf</artifactId>
</dependency>

Without that dependency, maven gives the following error:

Project uses classes from transitive module org.esa.snap:snap-gpf:jar:7.0.0-SNAPSHOT which will not be accessible at runtime.

kygoh · May 29, 2019, 7:59am

I just tried out your new code which is throwing UnsupportedOperationException. The exception is indeed thrown as can be seen in the surefire-report:

INFO: org.geotools.util.logging.LoggingImagingListener: Problem occurs when computing a tile by the owner.
java.lang.UnsupportedOperationException: Unable to compute raster for non floating number data type
	at org.esa.snap.statistics.percentile.interpolated.MeanOpImage.computeRect(MeanOpImage.java:35)
	at javax.media.jai.PointOpImage.computeTile(PointOpImage.java:914)
	at com.sun.media.jai.util.SunTileScheduler.scheduleTile(SunTileScheduler.java:904)
	at javax.media.jai.OpImage.getTile(OpImage.java:1129)
	at javax.media.jai.PlanarImage.copyData(PlanarImage.java:2343)
	at javax.media.jai.PlanarImage.getAsBufferedImage(PlanarImage.java:2525)
	at javax.media.jai.PlanarImage.getAsBufferedImage(PlanarImage.java:2546)
	at org.esa.snap.statistics.percentile.interpolated.MeanOpImageTest.testThatOperatorExceptionOccursWhenNoFloatingPointImagesAreProvided(MeanOpImageTest.java:131)
    ...

However, what is caught in the test case is still NullPointerException as seen here:

Expected: an instance of java.lang.UnsupportedOperationException
     but: <java.lang.NullPointerException> is a java.lang.NullPointerException
Stacktrace was: java.lang.NullPointerException
	at javax.media.jai.PlanarImage.copyData(PlanarImage.java:2344)
	at javax.media.jai.PlanarImage.getAsBufferedImage(PlanarImage.java:2525)
	at javax.media.jai.PlanarImage.getAsBufferedImage(PlanarImage.java:2546)
	at org.esa.snap.statistics.percentile.interpolated.MeanOpImageTest.testThatOperatorExceptionOccursWhenNoFloatingPointImagesAreProvided(MeanOpImageTest.java:131)
    ...

kygoh · May 29, 2019, 11:52am

INFO: org.geotools.util.logging.LoggingImagingListener: Problem occurs when computing a tile by the owner.
java.lang.UnsupportedOperationException: Unable to compute raster for non floating number data type
    at org.esa.snap.statistics.percentile.interpolated.MeanOpImage.computeRect(MeanOpImage.java:35)
    at javax.media.jai.PointOpImage.computeTile(PointOpImage.java:914)
    at com.sun.media.jai.util.SunTileScheduler.scheduleTile(SunTileScheduler.java:904)
    at javax.media.jai.OpImage.getTile(OpImage.java:1129)
    at javax.media.jai.PlanarImage.copyData(PlanarImage.java:2343)
    at javax.media.jai.PlanarImage.getAsBufferedImage(PlanarImage.java:2525)

Expected: an instance of java.lang.UnsupportedOperationException
but: <java.lang.NullPointerException> is a java.lang.NullPointerException
Stacktrace was: java.lang.NullPointerException
at javax.media.jai.PlanarImage.copyData(PlanarImage.java:2344)
at javax.media.jai.PlanarImage.getAsBufferedImage(PlanarImage.java:2525)

From the above 2 stack traces, it appears that UnsupportedOperationException was indeed thrown within getTile(tx, ty) method.

github.com

mauricio/jai-core/blob/b60dff804785afcf676da797c1bba5e61ccfa12b/src/share/classes/javax/media/jai/PlanarImage.java#L2343


SampleModel[] sampleModels = { getSampleModel() };
int tagID = RasterAccessor.findCompatibleTag(sampleModels,
                                             raster.getSampleModel());


RasterFormatTag srcTag = new RasterFormatTag(getSampleModel(),tagID);
RasterFormatTag dstTag =
    new RasterFormatTag(raster.getSampleModel(),tagID);


for (int ty = startTileY; ty <= endTileY; ty++) {
    for (int tx = startTileX; tx <= endTileX; tx++) {
        Raster tile = getTile(tx, ty);
        Rectangle subRegion = region.intersection(tile.getBounds());


        RasterAccessor s = new RasterAccessor(tile, subRegion,
                                              srcTag, getColorModel());
        RasterAccessor d = new RasterAccessor(raster, subRegion,
                                              dstTag, null);
        ImageUtil.copyRaster(s, d);
    }
}
return raster;

But for some reason, the code still continued with tile still null.

kygoh · May 30, 2019, 3:33am

If I run the unit test on eclipse, it will pass with UnsupportedOperationException but fail if NullPointerException is used.

However, if I run maven clean test from command line, it will fail with UnsupportedOperationException but pass if NullPointerException is used.

kygoh · June 6, 2019, 1:26am

kygoh:

I also had to add the following dependency in snap-desktop/snap-ui/pom.xml in order to successfully complete the snap-desktop build:
<dependency>
    <groupId>org.esa.snap</groupId>
    <artifactId>snap-gpf</artifactId>
</dependency>
Without that dependency, maven gives the following error:

Project uses classes from transitive module org.esa.snap:snap-gpf:jar:7.0.0-SNAPSHOT which will not be accessible at runtime.

This has been resolved by

kygoh · June 6, 2019, 4:05am

Just found out that the above behaviour is due to the different ImagingListener used when in eclipse and maven.

When running the test case in eclipse, the ImagingListener class is

com.sun.media.jai.util.ImagingListenerImpl

but in maven command line, the ImagingListener class is

org.geotools.util.logging.LoggingImagingListener

I managed to trace the test case code flow as below:

github.com

mauricio/jai-core/blob/b60dff804785afcf676da797c1bba5e61ccfa12b/src/share/classes/javax/media/jai/PlanarImage.java#L2343


SampleModel[] sampleModels = { getSampleModel() };
int tagID = RasterAccessor.findCompatibleTag(sampleModels,
                                             raster.getSampleModel());


RasterFormatTag srcTag = new RasterFormatTag(getSampleModel(),tagID);
RasterFormatTag dstTag =
    new RasterFormatTag(raster.getSampleModel(),tagID);


for (int ty = startTileY; ty <= endTileY; ty++) {
    for (int tx = startTileX; tx <= endTileX; tx++) {
        Raster tile = getTile(tx, ty);
        Rectangle subRegion = region.intersection(tile.getBounds());


        RasterAccessor s = new RasterAccessor(tile, subRegion,
                                              srcTag, getColorModel());
        RasterAccessor d = new RasterAccessor(raster, subRegion,
                                              dstTag, null);
        ImageUtil.copyRaster(s, d);
    }
}
return raster;

Raster tile = getTile(tx, ty) at line 2343 above will call tile = scheduler.scheduleTile(this, tileX, tileY) at line 1129 below:

github.com

mauricio/jai-core/blob/b60dff804785afcf676da797c1bba5e61ccfa12b/src/share/classes/javax/media/jai/OpImage.java#L1129


Raster tile = null;	// the requested tile, to be returned


// Make sure the requested tile is inside this image's boundary.
if (tileX >= getMinTileX() && tileX <= getMaxTileX() &&
    tileY >= getMinTileY() && tileY <= getMaxTileY()) {
    // Check if tile is available in the cache.
    tile = getTileFromCache(tileX, tileY);


    if (tile == null) {         // tile not in cache
        try {
            tile = scheduler.scheduleTile(this, tileX, tileY);
        } catch (OutOfMemoryError e) {
            // Empty the cache and call System.gc()
            if(cache != null) {
                cache.flush();
                System.gc(); //slow
            }


            // Need to reissue the tile scheduling.
            tile = scheduler.scheduleTile(this, tileX, tileY);
        }

… which will reach line 904 below…

github.com

mauricio/jai-core/blob/b60dff804785afcf676da797c1bba5e61ccfa12b/src/share/classes/com/sun/media/jai/util/SunTileScheduler.java#L904


    } else {
        // Waiting: get tile cache from the Map.
        cache = (Object[])tilesInProgress.get(tileID);
    }
}


if(computeTile) {
    try {
        try {
            // Attempt to compute the tile.
            tile = owner.computeTile(tileX, tileY);
        } catch (OutOfMemoryError e) {
            // Empty the cache and call System.gc()
            TileCache tileCache = owner.getTileCache();
            if(tileCache != null) {
                tileCache.flush();
                System.gc(); //slow
            }


            // Re-attempt to compute the tile.
            tile = owner.computeTile(tileX, tileY);

… which will reach line 914 below …

github.com

mauricio/jai-core/blob/b60dff804785afcf676da797c1bba5e61ccfa12b/src/share/classes/javax/media/jai/PointOpImage.java#L914


if (sameTileGrid) {
    // All sources share the tile grid of the destination so
    // there is no need for splits.
    if (recyclingSource0Tile) {
        sources[0] = dest;
    }
    for (int i = recyclingSource0Tile ? 1 : 0; i < numSrcs; i++) {
        sources[i] = getSource(i).getTile(tileX, tileY);
    }


    computeRect(sources, dest, destRect);
} else {
    //
    // The tileWidth and tileHeight of the source image
    // may differ from this tileWidth and tileHeight.
    //
    IntegerSequence xSplits =
        new IntegerSequence(destMinX, destMaxX);
    xSplits.insert(destMinX);
    xSplits.insert(destMaxX);

… then reaching line 35 of MeanOpImage which throws UnsupportedOperationException.

github.com

senbox-org/snap-engine/blob/master/snap-temporal-percentile/src/main/java/org/esa/snap/statistics/percentile/interpolated/MeanOpImage.java#L35


    }
    RasterAccessor d = new RasterAccessor(dest, destRect, formatTags[sources.length], getColorModel());
    switch (d.getDataType()) {
    case DataBuffer.TYPE_FLOAT:
        computeRectFloat(sourceRasterAccessors, d);
        break;
    case DataBuffer.TYPE_DOUBLE:
        computeRectDouble(sourceRasterAccessors, d);
        break;
    default:
        throw new UnsupportedOperationException("Unable to compute raster for non floating number data type");
    }
    d.copyDataToRaster();
}


private void computeRectFloat(RasterAccessor[] sourceRasterAccessors, RasterAccessor dst) {


    final RasterAccessor src = sourceRasterAccessors[0];
    int sLineStride = src.getScanlineStride();
    int sPixelStride = src.getPixelStride();
    int[] sBandOffsets = src.getBandOffsets();

The UnsupportedOperationException thrown is handled between 916 and 931 below:

github.com

mauricio/jai-core/blob/b60dff804785afcf676da797c1bba5e61ccfa12b/src/share/classes/com/sun/media/jai/util/SunTileScheduler.java#L916-L931


            } catch(Throwable e) {
                // Re-throw the Error or Exception.
                if(e instanceof Error) {
                    throw (Error)e;
                } else if(e instanceof RuntimeException) {
                    sendExceptionToListener(JaiI18N.getString("SunTileScheduler6"), e);
//                    throw (RuntimeException)e;
                } else {
                    String message = JaiI18N.getString("SunTileScheduler6");
                    sendExceptionToListener(message,
                                            new ImagingException(message, e));
/*
                    throw new RuntimeException(e.getMessage()+"\n"+
                                               getStackTraceString(e));
*/
                }

Since UnsupportedOperationException is an instance of RuntimeException, line 921 above handles it through the method sendExceptionToListener below:

github.com

mauricio/jai-core/blob/b60dff804785afcf676da797c1bba5e61ccfa12b/src/share/classes/com/sun/media/jai/util/SunTileScheduler.java#L1643-L1647


void sendExceptionToListener(String message, Throwable e) {
    ImagingListener listener =
        ImageUtil.getImagingListener((RenderingHints)null);
    listener.errorOccurred(message, e, this, false);
}

As mentioned earlier, the ImagingListener gotten from ImageUtil in line 1644 is different when I ran the test from eclipse and maven.
Tracing the code further to org.geotools.util.logging.Logging, I can see that geotools will replace ImagingListener with LoggingImagingListener in line 119 if the class name contains ImagingListenerImpl. I think this happened when I ran the test case in maven command line which made the test case logged UnsupportedOperationException instead of throwing the exception for the test case to catch.

github.com

geotools/geotools/blob/2b4f2da997afc09624013bfc0e3e5c08f923b011/modules/library/metadata/src/main/java/org/geotools/util/logging/Logging.java#L115-L123


if (imagingListener == null
        || imagingListener.getClass().getName().contains("ImagingListenerImpl")) {
    // Client code has not provided an ImagingListener so we can use our own
    // Custom GeoTools ImagingListener used to ignore common warnings
    setImagingListener.invoke(jai, new LoggingImagingListener());
    if (LOGGING_TRACE) {
        System.out.println("Logging JAI messages: javax.media.jai logger redirected");
    }
} else {

Any way to set the ImageListener to com.sun.media.jai.util.ImagingListenerImpl when running the case from maven command line so that the test case can pass?

kygoh · June 6, 2019, 4:51am

Based on my above finding, I modified testThatOperatorExceptionOccursWhenNoFloatingPointImagesAreProvided method as below in order to pass the test from maven command line:

@Test
public void testThatOperatorExceptionOccursWhenNoFloatingPointImagesAreProvided() {
	// get the ImagingListener currently in use
	ImagingListener originalImagingListener = JAI.getDefaultInstance().getImagingListener();
	// set the ImagingListener to com.sun.media.jai.util.ImagingListenerImpl
	JAI.getDefaultInstance().setImagingListener(ImagingListenerImpl.getInstance());

    final Vector<RenderedImage> sources = new Vector<>();
    sources.add(ConstantDescriptor.create(2f, 2f, new Integer[]{3}, null));
    sources.add(ConstantDescriptor.create(2f, 2f, new Integer[]{2}, null));

    //execution
    final MeanOpImage meanOpImage = new MeanOpImage(sources);
    exception.expect(UnsupportedOperationException.class);
    meanOpImage.getAsBufferedImage();

	// revert the ImagingListener to the one in use
	JAI.getDefaultInstance().setImagingListener(originalImagingListener);
    fail("Should not reach this line");
}

Do you know of a better way?

kygoh · June 6, 2019, 1:56pm

Also found out that org.geotools.util.logging.LoggingImagingListener logger is set only when org.esa.snap.statistics.percentile.interpolated.UtilsTest_GroupProductsDaily test is run.

This could be the reason why the test passed in eclipse because I only ran the MeanOpImageTest whereas from maven command line I ran all tests.

marpet · June 14, 2019, 11:31am

Thanks for this.
It should be solved now.

The problem is that GeoTools changes the behavior. As soon as it is used or at least its logging the ImagingListener is changed, as you already noticed.

I’ve written a bit more in the MeanOpImageTest:

github.com

senbox-org/snap-engine/blob/29fcc2e405bce7845e9f98648bca561ba60cd190/snap-temporal-percentile/src/test/java/org/esa/snap/statistics/percentile/interpolated/MeanOpImageTest.java#L19-L26


// Triggering init of GeoTools
SystemUtils.initGeoTools();
// GeoTools adds a special listener to JAI (see static block in class org.geotools.util.logging.Logging) which
// changes the behavior. The registered ImagingListener does not
// rethrow the actually expected UnsupportedOperationException but swallows it. Due to this, a
// NullPointerException occurs as a consequence in test
// MeanOpImageTest.testThatOperatorExceptionOccursWhenNoFloatingPointImagesAreProvided.
// The special Listener is also registered when running SNAP, so we ensure here that it is registered.