/*
* GeoTools - The Open Source Java GIS Toolkit
* http://geotools.org
*
* (C) 2007-2014, Open Source Geospatial Foundation (OSGeo)
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation;
* version 2.1 of the License.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*/
package org.geotools.coverage.io.netcdf;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.FilenameFilter;
import java.io.IOException;
import java.net.MalformedURLException;
import java.security.MessageDigest;
import java.util.List;
import java.util.logging.Logger;
import org.apache.commons.io.FileUtils;
import org.apache.commons.io.FilenameUtils;
import org.apache.commons.io.filefilter.FileFilterUtils;
import org.geotools.coverage.grid.io.AbstractGridFormat;
import org.geotools.coverage.grid.io.DimensionDescriptor;
import org.geotools.coverage.grid.io.GridFormatFinder;
import org.geotools.coverage.io.CoverageSource.AdditionalDomain;
import org.geotools.coverage.io.CoverageSource.DomainType;
import org.geotools.coverage.io.CoverageSourceDescriptor;
import org.geotools.coverage.io.catalog.CoverageSlice;
import org.geotools.coverage.io.catalog.CoverageSlicesCatalog;
import org.geotools.data.DataUtilities;
import org.geotools.data.Query;
import org.geotools.feature.NameImpl;
import org.geotools.imageio.netcdf.AncillaryFileManager;
import org.geotools.imageio.netcdf.NetCDFImageReader;
import org.geotools.imageio.netcdf.NetCDFImageReaderSpi;
import org.geotools.imageio.netcdf.Slice2DIndex;
import org.geotools.test.TestData;
import org.junit.After;
import org.junit.Assert;
import org.junit.Test;
import org.opengis.feature.Property;
import org.opengis.feature.simple.SimpleFeature;
import org.opengis.feature.type.Name;
import org.opengis.filter.Filter;
import ucar.nc2.Variable;
import ucar.nc2.dataset.NetcdfDataset;
/**
* Testing Low level reader infrastructure.
*
* @author Simone Giannecchini, GeoSolutions SAS
* @source $URL$
*/
public final class NetCDFBasicTest extends Assert {
private final static Logger LOGGER = Logger.getLogger(NetCDFBasicTest.class.toString());
@Test
public void testImageReaderPolyphemunsComplex() throws Exception {
File file = null;
try {
file = TestData.file(this, "polyphemus_20130301.nc");
} catch (IOException e) {
LOGGER.warning("Unable to find file polyphemus_20130301.nc");
return;
}
if (!file.exists()) {
LOGGER.warning("Unable to find file polyphemus_20130301.nc");
return;
}
final NetCDFImageReaderSpi unidataImageReaderSpi = new NetCDFImageReaderSpi();
assertTrue(unidataImageReaderSpi.canDecodeInput(file));
NetCDFImageReader reader = null;
try {
reader = (NetCDFImageReader) unidataImageReaderSpi.createReaderInstance();
reader.setInput(file);
int numImages = reader.getNumImages(true);
assertEquals(1008, numImages);
for (int i = 0; i < numImages; i++) {
Slice2DIndex sliceIndex = reader.getSlice2DIndex(i);
assertNotNull(sliceIndex);
spitOutSliceInformation(i, sliceIndex);
}
// check coverage names
final List<Name> names = reader.getCoveragesNames();
assertNotNull(names);
assertTrue(!names.isEmpty());
assertTrue(3 == names.size());
assertTrue(names.contains(new NameImpl("NO2")));
assertTrue(names.contains(new NameImpl("O3")));
assertTrue(names.contains(new NameImpl("V")));
// checking slice catalog
final CoverageSlicesCatalog cs = reader.getCatalog();
assertNotNull(cs);
// get typenames
final String[] typeNames = cs.getTypeNames();
for (String typeName : typeNames) {
final List<CoverageSlice> granules = cs.getGranules(new Query(typeName,
Filter.INCLUDE));
assertNotNull(granules);
assertFalse(granules.isEmpty());
for (CoverageSlice slice : granules) {
final SimpleFeature sf = slice.getOriginator();
if (TestData.isInteractiveTest()) {
LOGGER.info(DataUtilities.encodeFeature(sf));
}
// checks
for (Property p : sf.getProperties()) {
assertNotNull("Property " + p.getName() + " had a null value!",
p.getValue());
}
}
}
} finally {
if (reader != null) {
try {
reader.dispose();
} catch (Throwable t) {
// Does nothing
}
}
}
}
@Test
public void testImageReaderPolyphemusSimple() throws Exception {
final File file = TestData.file(this, "O3-NO2.nc");
final NetCDFImageReaderSpi unidataImageReaderSpi = new NetCDFImageReaderSpi();
assertTrue(unidataImageReaderSpi.canDecodeInput(file));
NetCDFImageReader reader = null;
try {
// checking low level
reader = (NetCDFImageReader) unidataImageReaderSpi.createReaderInstance();
reader.setInput(file);
int numImages = reader.getNumImages(true);
LOGGER.info("Found " + numImages + " images.");
for (int i = 0; i < numImages; i++) {
Slice2DIndex sliceIndex = reader.getSlice2DIndex(i);
assertNotNull(sliceIndex);
spitOutSliceInformation(i, sliceIndex);
}
// checking slice catalog
final CoverageSlicesCatalog cs = reader.getCatalog();
assertNotNull(cs);
// get typenames
final String[] typeNames = cs.getTypeNames();
for (String typeName : typeNames) {
final List<CoverageSlice> granules = cs.getGranules(new Query(typeName,
Filter.INCLUDE));
assertNotNull(granules);
assertFalse(granules.isEmpty());
for (CoverageSlice slice : granules) {
final SimpleFeature sf = slice.getOriginator();
if (TestData.isInteractiveTest()) {
LOGGER.info(DataUtilities.encodeFeature(sf));
}
// checks
for (Property p : sf.getProperties()) {
assertNotNull("Property " + p.getName() + " had a null value!",
p.getValue());
}
}
}
} finally {
if (reader != null) {
try {
reader.dispose();
} catch (Throwable t) {
// Does nothing
}
}
}
}
@Test
public void testNoValid2DVariable() throws Exception {
final File file = TestData.file(this, "noVars.nc");
NetcdfDataset dataset = NetcdfDataset.acquireDataset(file.getAbsolutePath(), null);
List<Variable> variables = dataset.getVariables();
boolean speedVariableIsPresent = false;
String speedVariableName = "";
for (Variable variable : variables) {
if (variable.getShortName().equals("spd")) {
speedVariableIsPresent = true;
speedVariableName = variable.getFullName();
break;
}
}
assertTrue(speedVariableIsPresent);
final NetCDFImageReaderSpi unidataImageReaderSpi = new NetCDFImageReaderSpi();
assertTrue(unidataImageReaderSpi.canDecodeInput(file));
NetCDFImageReader reader = null;
try {
// sample dataset containing a water_speed variable having
// only time, depth dimensions. No lon/lat dims are present
// resulting into variable not usable.
reader = (NetCDFImageReader) unidataImageReaderSpi.createReaderInstance();
reader.setInput(file);
final List<Name> names = reader.getCoveragesNames();
boolean isSpeedCoverageAvailable = false;
for (Name name : names) {
if (name.toString().equals(speedVariableName)) {
isSpeedCoverageAvailable = true;
break;
}
}
// Checking that only "mask" variable is found
assertFalse(isSpeedCoverageAvailable);
} finally {
if (dataset != null) {
dataset.close();
}
if (reader != null) {
try {
reader.dispose();
} catch (Throwable t) {
// Does nothing
}
}
}
}
/**
* recursively delete indexes
*
* @param file
*/
private void removeIndexes(final File file) {
if (file.isFile()) {
final String absolutePath = file.getAbsolutePath().toLowerCase();
if (absolutePath.endsWith(".idx") || absolutePath.endsWith(".db")) {
file.delete();
}
} else {
final File[] files = file.listFiles();
for (File f : files) {
removeIndexes(f);
}
}
}
private void cleanUp() throws FileNotFoundException, IOException {
final File dir = TestData.file(this, ".");
removeIndexes(dir);
}
@After
public void tearDown() throws FileNotFoundException, IOException {
if (TestData.isInteractiveTest()) {
return;
}
cleanUp();
}
@Test
public void testImageReaderIASI() throws Exception {
File file = null;
try {
file = TestData.file(this, "IASI_C_EUMP_20121120062959_31590_eps_o_l2.nc");
} catch (IOException e) {
LOGGER.warning("Unable to find file IASI_C_EUMP_20121120062959_31590_eps_o_l2.nc");
return;
}
if (!file.exists()) {
LOGGER.warning("Unable to find file IASI_C_EUMP_20121120062959_31590_eps_o_l2.nc");
return;
}
final NetCDFImageReaderSpi unidataImageReaderSpi = new NetCDFImageReaderSpi();
assertTrue(unidataImageReaderSpi.canDecodeInput(file));
NetCDFImageReader reader = null;
try {
reader = (NetCDFImageReader) unidataImageReaderSpi.createReaderInstance();
reader.setInput(file);
int numImages = reader.getNumImages(true);
for (int i = 0; i < numImages; i++) {
Slice2DIndex sliceIndex = reader.getSlice2DIndex(i);
assertNotNull(sliceIndex);
spitOutSliceInformation(i, sliceIndex);
}
// cloud_phase
CoverageSourceDescriptor cd = reader.getCoverageDescriptor(new NameImpl("cloud_phase"));
final List<AdditionalDomain> additionalDomains = cd.getAdditionalDomains();
assertTrue(!additionalDomains.isEmpty());
final AdditionalDomain ad = additionalDomains.get(0);
assertTrue(ad.getType().equals(DomainType.NUMBER));
assertEquals("cloud_phase", ad.getName());
} finally {
if (reader != null) {
try {
reader.dispose();
} catch (Throwable t) {
// Does nothing
}
}
}
}
@Test
public void testImageReaderGOME2() throws Exception {
final File file = TestData.file(this, "20130101.METOPA.GOME2.NO2.DUMMY.nc");
final NetCDFImageReaderSpi unidataImageReaderSpi = new NetCDFImageReaderSpi();
assertTrue(unidataImageReaderSpi.canDecodeInput(file));
NetCDFImageReader reader = null;
try {
// checking low level
reader = (NetCDFImageReader) unidataImageReaderSpi.createReaderInstance();
reader.setInput(file);
int numImages = reader.getNumImages(true);
assertEquals(1, numImages);
LOGGER.info("Found " + numImages + " images.");
for (int i = 0; i < numImages; i++) {
Slice2DIndex sliceIndex = reader.getSlice2DIndex(i);
assertNotNull(sliceIndex);
spitOutSliceInformation(i, sliceIndex);
}
// check coverage names
final List<Name> names = reader.getCoveragesNames();
assertNotNull(names);
assertTrue(!names.isEmpty());
assertTrue(1 == names.size());
assertEquals("NO2", names.get(0).toString());
// checking slice catalog
final CoverageSlicesCatalog cs = reader.getCatalog();
assertNotNull(cs);
// get typenames
final String[] typeNames = cs.getTypeNames();
for (String typeName : typeNames) {
final List<CoverageSlice> granules = cs.getGranules(new Query(typeName,
Filter.INCLUDE));
assertNotNull(granules);
assertFalse(granules.isEmpty());
for (CoverageSlice slice : granules) {
final SimpleFeature sf = slice.getOriginator();
if (TestData.isInteractiveTest()) {
LOGGER.info(DataUtilities.encodeFeature(sf));
}
// checks
for (Property p : sf.getProperties()) {
final String pName = p.getName().toString();
if (!pName.equalsIgnoreCase("time") && !pName.equalsIgnoreCase("elevation")) {
assertNotNull("Property " + p.getName() + " had a null value!",
p.getValue());
} else {
assertNull("Property " + p.getName() + " did not have a null value!",
p.getValue());
}
}
}
}
} finally {
if (reader != null) {
try {
reader.dispose();
} catch (Throwable t) {
// Does nothing
}
}
}
}
@Test
public void testImageReaderGOME2AncillaryFiles() throws Exception {
final File file = TestData.file(this, "20130101.METOPA.GOME2.NO2.DUMMY.nc");
final NetCDFImageReaderSpi unidataImageReaderSpi = new NetCDFImageReaderSpi();
assertTrue(unidataImageReaderSpi.canDecodeInput(file));
NetCDFImageReader reader = null;
try {
// checking low level
reader = (NetCDFImageReader) unidataImageReaderSpi.createReaderInstance();
reader.setInput(file);
int numImages = reader.getNumImages(true);
assertEquals(1, numImages);
LOGGER.info("Found " + numImages + " images.");
for (int i = 0; i < numImages; i++) {
Slice2DIndex sliceIndex = reader.getSlice2DIndex(i);
assertNotNull(sliceIndex);
spitOutSliceInformation(i, sliceIndex);
}
// check coverage names
final List<Name> names = reader.getCoveragesNames();
assertNotNull(names);
assertTrue(!names.isEmpty());
assertTrue(1 == names.size());
assertEquals("NO2", names.get(0).toString());
// checking slice catalog
final CoverageSlicesCatalog cs = reader.getCatalog();
assertNotNull(cs);
MessageDigest md = MessageDigest.getInstance("SHA-1");
md.update(file.getCanonicalPath().getBytes());
String hashCode = AncillaryFileManager.convertToHex(md.digest());
// Check if the auxiliary files directory is present
File parentDir = file.getParentFile();
String auxiliaryDirPath = parentDir + File.separator + "."
+ FilenameUtils.getBaseName(file.getName()) + "_" + hashCode;
File auxiliaryDir = new File(auxiliaryDirPath);
assertTrue(auxiliaryDir.exists());
assertTrue(auxiliaryDir.isDirectory());
// Check if the Auxiliary File Directory contains the origin.txt file
FilenameFilter nameFileFilter = FileFilterUtils.nameFileFilter("origin.txt");
File[] files = auxiliaryDir.listFiles(nameFileFilter);
assertTrue(files != null);
assertTrue(files[0].exists());
} finally {
if (reader != null) {
try {
reader.dispose();
} catch (Throwable t) {
// Does nothing
}
}
}
}
@Test
public void testImageReaderAscat() throws Exception {
File file = null;
try {
file = TestData.file(this, "ascatl1.nc");
} catch (IOException e) {
LOGGER.warning("Unable to find file ascatl1.nc");
return;
}
if (!file.exists()) {
LOGGER.warning("Unable to find file ascatl1.nc");
return;
}
final NetCDFImageReaderSpi unidataImageReaderSpi = new NetCDFImageReaderSpi();
assertTrue(unidataImageReaderSpi.canDecodeInput(file));
NetCDFImageReader reader = null;
try {
reader = (NetCDFImageReader) unidataImageReaderSpi.createReaderInstance();
reader.setInput(file);
int numImages = reader.getNumImages(true);
for (int i = 0; i < numImages; i++) {
Slice2DIndex sliceIndex = reader.getSlice2DIndex(i);
assertNotNull(sliceIndex);
spitOutSliceInformation(i, sliceIndex);
}
// check coverage names
final List<Name> names = reader.getCoveragesNames();
assertNotNull(names);
assertTrue(!names.isEmpty());
assertTrue(2 == names.size());
assertEquals("cell_index", names.get(0).toString());
assertEquals("f_land", names.get(1).toString());
// checking slice catalog
final CoverageSlicesCatalog cs = reader.getCatalog();
assertNotNull(cs);
// get typenames
final String[] typeNames = cs.getTypeNames();
for (String typeName : typeNames) {
final List<CoverageSlice> granules = cs.getGranules(new Query(typeName,
Filter.INCLUDE));
assertNotNull(granules);
assertFalse(granules.isEmpty());
for (CoverageSlice slice : granules) {
final SimpleFeature sf = slice.getOriginator();
if (TestData.isInteractiveTest()) {
LOGGER.info(DataUtilities.encodeFeature(sf));
}
// checks
for (Property p : sf.getProperties()) {
final String pName = p.getName().toString();
if (!pName.equalsIgnoreCase("time") && !pName.equalsIgnoreCase("elevation")) {
assertNotNull("Property " + p.getName() + " had a null value!",
p.getValue());
} else {
assertNull("Property " + p.getName() + " did not have a null value!",
p.getValue());
}
}
}
}
} finally {
if (reader != null) {
try {
reader.dispose();
} catch (Throwable t) {
// Does nothing
}
}
}
}
/**
* @param i
* @param sliceIndex
*/
private void spitOutSliceInformation(int i, Slice2DIndex sliceIndex) {
if (TestData.isInteractiveTest()) {
String variableName = sliceIndex.getVariableName();
StringBuilder sb = new StringBuilder();
sb.append("\n").append("\n").append("\n");
sb.append("IMAGE: ").append(i).append("\n");
sb.append(" Variable Name = ").append(variableName);
sb.append(" ( Z = ");
sb.append(sliceIndex.getZIndex());
sb.append("; T = ");
sb.append(sliceIndex.getTIndex());
sb.append(")");
LOGGER.info(sb.toString());
}
}
@Test
public void testImageReaderPolyphemunsComplex2() throws Exception {
File file = null;
try {
file = TestData.file(this, "polyphemus_20130301.nc");
} catch (IOException e) {
LOGGER.warning("Unable to find file polyphemus_20130301.nc");
return;
}
if (!file.exists()) {
LOGGER.warning("Unable to find file polyphemus_20130301.nc");
return;
}
FileUtils.copyFile(file, new File(TestData.file(this, null), "polyphemus.nc"));
file = TestData.file(this, "polyphemus.nc");
final NetCDFImageReaderSpi unidataImageReaderSpi = new NetCDFImageReaderSpi();
assertTrue(unidataImageReaderSpi.canDecodeInput(file));
NetCDFImageReader reader = null;
try {
reader = (NetCDFImageReader) unidataImageReaderSpi.createReaderInstance();
reader.setInput(file);
int numImages = reader.getNumImages(true);
assertEquals(1008, numImages);
for (int i = 0; i < numImages; i++) {
Slice2DIndex sliceIndex = reader.getSlice2DIndex(i);
assertNotNull(sliceIndex);
spitOutSliceInformation(i, sliceIndex);
}
// check dimensions
CoverageSourceDescriptor cd = reader.getCoverageDescriptor(new NameImpl("NO2"));
final List<AdditionalDomain> additionalDomains = cd.getAdditionalDomains();
assertNull(additionalDomains);
final List<DimensionDescriptor> dimensions = cd.getDimensionDescriptors();
assertNotNull(dimensions);
assertTrue(!dimensions.isEmpty());
assertEquals("wrong dimensions", 2, dimensions.size());
DimensionDescriptor dim = dimensions.get(0);
assertTrue(dim.getName().equals("TIME"));
assertTrue(dim.getStartAttribute().equals("time"));
dim = dimensions.get(1);
assertTrue(dim.getName().equals("ELEVATION"));
assertTrue(dim.getStartAttribute().equals("z"));
// check coverage names
final List<Name> names = reader.getCoveragesNames();
assertNotNull(names);
assertTrue(!names.isEmpty());
assertTrue(3 == names.size());
assertTrue(names.contains(new NameImpl("NO2")));
assertTrue(names.contains(new NameImpl("O3")));
assertTrue(names.contains(new NameImpl("V")));
// checking slice catalog
final CoverageSlicesCatalog cs = reader.getCatalog();
assertNotNull(cs);
// get typenames
final String[] typeNames = cs.getTypeNames();
for (String typeName : typeNames) {
final List<CoverageSlice> granules = cs.getGranules(new Query(typeName,
Filter.INCLUDE));
assertNotNull(granules);
assertFalse(granules.isEmpty());
for (CoverageSlice slice : granules) {
final SimpleFeature sf = slice.getOriginator();
if (TestData.isInteractiveTest()) {
LOGGER.info(DataUtilities.encodeFeature(sf));
}
// checks
for (Property p : sf.getProperties()) {
assertNotNull("Property " + p.getName() + " had a null value!",
p.getValue());
}
}
}
} finally {
// close reader
if (reader != null) {
try {
reader.dispose();
} catch (Throwable t) {
// Does nothing
}
}
// specific clean up
FileUtils.deleteDirectory(TestData.file(this, ".polyphemus"));
}
}
public void testReadRegularNetCDF() throws IOException {
NetCDFImageReaderSpi readerSpi = new NetCDFImageReaderSpi();
File file = null;
try {
file = TestData.file(this, "2DLatLonCoverageHDF5.nc");
} catch (IOException e) {
LOGGER.warning("Unable to find file 2DLatLonCoverageHDF5.nc");
return;
}
assertTrue(readerSpi.canDecodeInput(file));
}
@Test
public void testReadNcML() throws IOException {
NetCDFImageReaderSpi readerSpi = new NetCDFImageReaderSpi();
File file = null;
try {
file = TestData.file(this, "2DLatLonCoverage.ncml");
} catch (IOException e) {
LOGGER.warning("Unable to find file 2DLatLonCoverage.ncml");
return;
}
assertTrue(readerSpi.canDecodeInput(file));
}
/**
* We can NOT read a CDL file
*
* @throws IOException
*/
@Test
public void testReadCDL() throws IOException {
NetCDFImageReaderSpi readerSpi = new NetCDFImageReaderSpi();
File file = null;
try {
file = TestData.file(this, "2DLatLonCoverage.cdl");
} catch (IOException e) {
LOGGER.warning("Unable to find file 2DLatLonCoverage.cdl");
return;
}
assertFalse(readerSpi.canDecodeInput(file));
}
@Test
public void testNetCDFWithDifferentTimeDimensions() throws MalformedURLException, IOException {
// Selection of the input file
final File workDir = new File(TestData.file(this, "."), "times");
if (!workDir.mkdir()) {
FileUtils.deleteDirectory(workDir);
assertTrue("Unable to create workdir:" + workDir, workDir.mkdir());
}
FileUtils.copyFile(TestData.file(this, "times.zip"), new File(workDir, "times.zip"));
TestData.unzipFile(this, "times/times.zip");
final File inputFile = TestData.file(this, "times/times.nc");
// Get format
final AbstractGridFormat format = (AbstractGridFormat) GridFormatFinder.findFormat(
inputFile.toURI().toURL(), null);
final NetCDFReader reader = new NetCDFReader(inputFile, null);
Assert.assertNotNull(format);
Assert.assertNotNull(reader);
try {
// Selection of all the Coverage names
String[] names = reader.getGridCoverageNames();
assertNotNull(names);
assertEquals(2, names.length);
// Parsing metadata values
assertEquals("true", reader.getMetadataValue(names[0], "HAS_TIME_DOMAIN"));
List<DimensionDescriptor> descriptors = reader.getDimensionDescriptors(names[0]);
assertEquals(1, descriptors.size());
DimensionDescriptor descriptor = descriptors.get(0);
assertEquals("time", descriptor.getStartAttribute());
assertEquals("TIME", descriptor.getName());
descriptors = reader.getDimensionDescriptors(names[1]);
assertEquals(1, descriptors.size());
descriptor = descriptors.get(0);
assertEquals("time1", descriptor.getStartAttribute());
assertEquals("TIME", descriptor.getName());
assertEquals("true", reader.getMetadataValue(names[1], "HAS_TIME_DOMAIN"));
} finally {
if (reader != null) {
try {
reader.dispose();
} catch (Throwable t) {
// Does nothing
}
}
FileUtils.deleteDirectory(TestData.file(this, "times"));
}
}
}