kinow commented on a change in pull request #165:
URL: https://github.com/apache/commons-imaging/pull/165#discussion_r704981060
##########
File path:
src/main/java/org/apache/commons/imaging/formats/tiff/TiffImageParser.java
##########
@@ -762,12 +763,12 @@ public void writeImage(final BufferedImage src, final
OutputStream os, final Map
}
/**
- * Reads the content of a TIFF file that contains floating-point data
- * samples.
+ * Reads the content of a TIFF file that contains numerical data samples
+ * rather than image-related pixels.
* <p>
- * If desired, sub-image data can be read from the file by using a Java Map
- * instance to specify the subsection of the image that is required. The
- * following code illustrates the approach:
+ * If desired, sub-image data can be read from the file by using a Java
+ * {@code Map} instance to specify the subsection of the image that
+ * isrequired. The following code illustrates the approach:
Review comment:
s/isrequired/is required?
##########
File path:
src/test/java/org/apache/commons/imaging/formats/tiff/TiffShortIntRoundTripTest.java
##########
@@ -0,0 +1,229 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.commons.imaging.formats.tiff;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+import java.awt.image.BufferedImage;
Review comment:
Not used.
##########
File path:
src/test/java/org/apache/commons/imaging/formats/tiff/TiffRasterDataIntTest.java
##########
@@ -0,0 +1,203 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.commons.imaging.formats.tiff;
+
+import static org.junit.jupiter.api.Assertions.assertArrayEquals;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.fail;
+
+import org.junit.jupiter.api.Test;
+
+/**
+ * Provides unit test for the raster-data class.
+ */
+public class TiffRasterDataIntTest {
+
+ int width = 11;
+ int height = 10;
+ int[] data;
+ TiffRasterData raster;
+ float meanValue;
+
+ public TiffRasterDataIntTest() {
+ double sum = 0;
+ data = new int[width * height];
+ int k = 0;
+ for (int i = 0; i < width; i++) {
+ for (int j = 0; j < height; j++) {
+ data[k] = (int)k;
Review comment:
Unnecessary casting.
##########
File path:
src/test/java/org/apache/commons/imaging/formats/tiff/TiffRasterDataIntTest.java
##########
@@ -0,0 +1,203 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.commons.imaging.formats.tiff;
+
+import static org.junit.jupiter.api.Assertions.assertArrayEquals;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.fail;
+
+import org.junit.jupiter.api.Test;
+
+/**
+ * Provides unit test for the raster-data class.
+ */
+public class TiffRasterDataIntTest {
+
+ int width = 11;
+ int height = 10;
+ int[] data;
+ TiffRasterData raster;
+ float meanValue;
+
+ public TiffRasterDataIntTest() {
+ double sum = 0;
+ data = new int[width * height];
+ int k = 0;
+ for (int i = 0; i < width; i++) {
+ for (int j = 0; j < height; j++) {
+ data[k] = (int)k;
+ sum += k;
+ k++;
+ }
+ }
+ raster = new TiffRasterDataInt(width, height, data);
+ meanValue = (float) (sum / k);
+ }
+
+ /**
+ * Test of setValue method, of class TiffRasterData.
+ */
+ @Test
+ public void testSetValue() {
+ final TiffRasterData instance = new TiffRasterDataInt(width, height);
+ for (int y = 0; y < height; y++) {
+ for (int x = 0; x < width; x++) {
+ final int index = y * width + height;
+ instance.setValue(x, y, index+0.4f);
+ int test = (int) instance.getValue(x, y);
+ assertEquals(index, test, "Set/get value test failed");
+ instance.setIntValue(x, y, index);
+ test = (int) instance.getIntValue(x, y);
Review comment:
Unnecessary casting.
##########
File path:
src/test/java/org/apache/commons/imaging/formats/tiff/TiffRasterDataIntTest.java
##########
@@ -0,0 +1,203 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.commons.imaging.formats.tiff;
+
+import static org.junit.jupiter.api.Assertions.assertArrayEquals;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.fail;
+
+import org.junit.jupiter.api.Test;
+
+/**
+ * Provides unit test for the raster-data class.
+ */
+public class TiffRasterDataIntTest {
+
+ int width = 11;
+ int height = 10;
+ int[] data;
+ TiffRasterData raster;
+ float meanValue;
+
+ public TiffRasterDataIntTest() {
+ double sum = 0;
+ data = new int[width * height];
+ int k = 0;
+ for (int i = 0; i < width; i++) {
+ for (int j = 0; j < height; j++) {
+ data[k] = (int)k;
+ sum += k;
+ k++;
+ }
+ }
+ raster = new TiffRasterDataInt(width, height, data);
+ meanValue = (float) (sum / k);
+ }
+
+ /**
+ * Test of setValue method, of class TiffRasterData.
+ */
+ @Test
+ public void testSetValue() {
+ final TiffRasterData instance = new TiffRasterDataInt(width, height);
+ for (int y = 0; y < height; y++) {
+ for (int x = 0; x < width; x++) {
+ final int index = y * width + height;
+ instance.setValue(x, y, index+0.4f);
+ int test = (int) instance.getValue(x, y);
+ assertEquals(index, test, "Set/get value test failed");
+ instance.setIntValue(x, y, index);
+ test = (int) instance.getIntValue(x, y);
+ assertEquals(index, test, "Set/get int value test failed");
+ }
+ }
+ }
+
+ /**
+ * Test of getValue method, of class TiffRasterData.
+ */
+ @Test
+ public void testGetValue() {
+ for (int y = 0; y < height; y++) {
+ for (int x = 0; x < width; x++) {
+ final int index = y * width + x;
+ int test = (int) raster.getValue(x, y);
+ assertEquals(index, test, "Get into source data test failed at
(" + x + "," + y + ")");
+ test = (int) raster.getIntValue(x, y);
Review comment:
Unnecessary casting.
##########
File path:
src/test/java/org/apache/commons/imaging/formats/tiff/TiffRasterDataIntTest.java
##########
@@ -0,0 +1,203 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.commons.imaging.formats.tiff;
+
+import static org.junit.jupiter.api.Assertions.assertArrayEquals;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.fail;
+
+import org.junit.jupiter.api.Test;
+
+/**
+ * Provides unit test for the raster-data class.
+ */
+public class TiffRasterDataIntTest {
+
+ int width = 11;
+ int height = 10;
+ int[] data;
+ TiffRasterData raster;
+ float meanValue;
+
+ public TiffRasterDataIntTest() {
+ double sum = 0;
+ data = new int[width * height];
+ int k = 0;
+ for (int i = 0; i < width; i++) {
+ for (int j = 0; j < height; j++) {
+ data[k] = (int)k;
+ sum += k;
+ k++;
+ }
+ }
+ raster = new TiffRasterDataInt(width, height, data);
+ meanValue = (float) (sum / k);
+ }
+
+ /**
+ * Test of setValue method, of class TiffRasterData.
+ */
+ @Test
+ public void testSetValue() {
+ final TiffRasterData instance = new TiffRasterDataInt(width, height);
+ for (int y = 0; y < height; y++) {
+ for (int x = 0; x < width; x++) {
+ final int index = y * width + height;
+ instance.setValue(x, y, index+0.4f);
+ int test = (int) instance.getValue(x, y);
+ assertEquals(index, test, "Set/get value test failed");
+ instance.setIntValue(x, y, index);
+ test = (int) instance.getIntValue(x, y);
+ assertEquals(index, test, "Set/get int value test failed");
+ }
+ }
+ }
+
+ /**
+ * Test of getValue method, of class TiffRasterData.
+ */
+ @Test
+ public void testGetValue() {
+ for (int y = 0; y < height; y++) {
+ for (int x = 0; x < width; x++) {
+ final int index = y * width + x;
+ int test = (int) raster.getValue(x, y);
+ assertEquals(index, test, "Get into source data test failed at
(" + x + "," + y + ")");
+ test = (int) raster.getIntValue(x, y);
+ assertEquals(index, test, "Get into source data test failed at
(" + x + "," + y + ")");
+ }
+ }
+ }
+
+ /**
+ * Test of getSimpleStatistics method, of class TiffRasterData.
+ */
+ @Test
+ public void testGetSimpleStatistics_0args() {
+
+ final TiffRasterStatistics result = raster.getSimpleStatistics();
+ assertEquals(0, result.getMinValue(), "Min value failure");
+ assertEquals(width * height - 1, result.getMaxValue(), "Max value
failure");
+ assertEquals(meanValue, result.getMeanValue(), "Mean value failure");
+ }
+
+ /**
+ * Test of getSimpleStatistics method, of class TiffRasterData.
+ */
+ @Test
+ public void testGetSimpleStatistics_float() {
+ // exclude the maximum value (width*height-1). This will result
+ // in a max value of width*height-2
+ final TiffRasterStatistics result = raster.getSimpleStatistics(width *
height - 1);
+ assertEquals(width * height - 2, result.getMaxValue(), "Max value
failure");
+ }
+
+ /**
+ * Test of getWidth method, of class TiffRasterData.
+ */
+ @Test
+ public void testGetWidth() {
+ assertEquals(width, raster.getWidth(), "Improper width stored");
+ }
+
+ /**
+ * Test of getHeight method, of class TiffRasterData.
+ */
+ @Test
+ public void testGetHeight() {
+ assertEquals(width, raster.getWidth(), "Improper height stored");
+ }
+
+ /**
+ * Test of getData method, of class TiffRasterData.
+ */
+ @Test
+ public void testGetData() {
+ final float[] result = raster.getData();
+ for(int i=0; i<result.length; i++){
+ assertEquals((int)result[i], data[i]);
+ }
+ final int []iResult = raster.getIntData();
+ assertArrayEquals(data, iResult);
+ }
+
+
+ /**
+ * Test of constructors with bad arguments, of class TiffRasterData.
+ */
+ @Test
+ public void testBadConstructor() {
+ try{
+ final TiffRasterData raster = new TiffRasterDataInt(-1, 10);
+ fail("Constructor did not detect bad width");
+ }catch(final IllegalArgumentException illArgEx){
+ // success!
+ }
Review comment:
@gwlucastrig I believe the tests that are using this pattern `try {
something; fail(); } catch {}` is JUnit 4. But for Junit 5 we can use:
```java
assertThrows(IllegalArgumentException.class, () -> new TiffRasterDataInt(-1,
10));
```
There are other places in this PR where this can be applied, you can look at
GitHub's UI to search for this "fail(" text if you'd like.
##########
File path:
src/test/java/org/apache/commons/imaging/formats/tiff/TiffRasterDataIntTest.java
##########
@@ -0,0 +1,203 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.commons.imaging.formats.tiff;
+
+import static org.junit.jupiter.api.Assertions.assertArrayEquals;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.fail;
+
+import org.junit.jupiter.api.Test;
+
+/**
+ * Provides unit test for the raster-data class.
+ */
+public class TiffRasterDataIntTest {
+
+ int width = 11;
+ int height = 10;
+ int[] data;
+ TiffRasterData raster;
+ float meanValue;
+
+ public TiffRasterDataIntTest() {
+ double sum = 0;
+ data = new int[width * height];
+ int k = 0;
+ for (int i = 0; i < width; i++) {
+ for (int j = 0; j < height; j++) {
+ data[k] = (int)k;
+ sum += k;
+ k++;
+ }
+ }
+ raster = new TiffRasterDataInt(width, height, data);
+ meanValue = (float) (sum / k);
+ }
+
+ /**
+ * Test of setValue method, of class TiffRasterData.
+ */
+ @Test
+ public void testSetValue() {
+ final TiffRasterData instance = new TiffRasterDataInt(width, height);
+ for (int y = 0; y < height; y++) {
+ for (int x = 0; x < width; x++) {
+ final int index = y * width + height;
+ instance.setValue(x, y, index+0.4f);
+ int test = (int) instance.getValue(x, y);
+ assertEquals(index, test, "Set/get value test failed");
+ instance.setIntValue(x, y, index);
+ test = (int) instance.getIntValue(x, y);
+ assertEquals(index, test, "Set/get int value test failed");
+ }
+ }
+ }
+
+ /**
+ * Test of getValue method, of class TiffRasterData.
+ */
+ @Test
+ public void testGetValue() {
+ for (int y = 0; y < height; y++) {
+ for (int x = 0; x < width; x++) {
+ final int index = y * width + x;
+ int test = (int) raster.getValue(x, y);
+ assertEquals(index, test, "Get into source data test failed at
(" + x + "," + y + ")");
+ test = (int) raster.getIntValue(x, y);
+ assertEquals(index, test, "Get into source data test failed at
(" + x + "," + y + ")");
+ }
+ }
+ }
+
+ /**
+ * Test of getSimpleStatistics method, of class TiffRasterData.
+ */
+ @Test
+ public void testGetSimpleStatistics_0args() {
+
+ final TiffRasterStatistics result = raster.getSimpleStatistics();
+ assertEquals(0, result.getMinValue(), "Min value failure");
+ assertEquals(width * height - 1, result.getMaxValue(), "Max value
failure");
+ assertEquals(meanValue, result.getMeanValue(), "Mean value failure");
+ }
+
+ /**
+ * Test of getSimpleStatistics method, of class TiffRasterData.
+ */
+ @Test
+ public void testGetSimpleStatistics_float() {
+ // exclude the maximum value (width*height-1). This will result
+ // in a max value of width*height-2
+ final TiffRasterStatistics result = raster.getSimpleStatistics(width *
height - 1);
+ assertEquals(width * height - 2, result.getMaxValue(), "Max value
failure");
+ }
+
+ /**
+ * Test of getWidth method, of class TiffRasterData.
+ */
+ @Test
+ public void testGetWidth() {
+ assertEquals(width, raster.getWidth(), "Improper width stored");
+ }
+
+ /**
+ * Test of getHeight method, of class TiffRasterData.
+ */
+ @Test
+ public void testGetHeight() {
+ assertEquals(width, raster.getWidth(), "Improper height stored");
+ }
+
+ /**
+ * Test of getData method, of class TiffRasterData.
+ */
+ @Test
+ public void testGetData() {
+ final float[] result = raster.getData();
+ for(int i=0; i<result.length; i++){
+ assertEquals((int)result[i], data[i]);
+ }
+ final int []iResult = raster.getIntData();
+ assertArrayEquals(data, iResult);
Review comment:
Tabs and spaces here @gwlucastrig :point_up: (better confirm other files
don't have tabs, only spotted it here due to the lines not aligned due to mix
spaces/tabs, but we could have in the other files).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
