ucar.nc2.ft.point.writer2.WriterCFPointCollection Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.gecko.ucar.netcdf Show documentation
Re-packaged Unidata netCDF
The newest version!
/*
 * Copyright (c) 1998-2020 John Caron and University Corporation for Atmospheric Research/Unidata
 * See LICENSE for license information.
 */

package ucar.nc2.ft.point.writer2;

import com.google.common.collect.ImmutableList;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import ucar.ma2.DataType;
import ucar.ma2.StructureData;
import ucar.ma2.StructureDataComposite;
import ucar.ma2.StructureDataFromMember;
import ucar.ma2.StructureMembers;
import ucar.nc2.Attribute;
import ucar.nc2.AttributeContainer;
import ucar.nc2.VariableSimpleBuilder;
import ucar.nc2.VariableSimpleIF;
import ucar.nc2.constants.CDM;
import ucar.nc2.constants.CF;
import ucar.nc2.dataset.conv.CF1Convention;
import ucar.nc2.ft.DsgFeatureCollection;
import ucar.nc2.ft.PointFeature;
import ucar.nc2.ft.PointFeatureCollection;
import ucar.nc2.time.CalendarDateUnit;

/**
 * Write a CF 1.6 "Discrete Sample" point file.
 *
 *  *   writeHeader()
 *   iterate { writeRecord() }
 *   finish()
 * 
 *
 * @see "http://cf-pcmdi.llnl.gov/documents/cf-conventions/1.6/cf-conventions.html#idp8294224"
 */
class WriterCFPointCollection extends WriterCFPointAbstract {

  WriterCFPointCollection(String fileOut, AttributeContainer globalAtts, List dataVars,
      CalendarDateUnit timeUnit, String altUnits, CFPointWriterConfig config) throws IOException {
    super(fileOut, globalAtts, dataVars, timeUnit, altUnits, config);
    writerb.addAttribute(new Attribute(CF.FEATURE_TYPE, CF.FeatureType.point.name()));
    writerb.addAttribute(new Attribute(CF.DSG_REPRESENTATION, "Point Data, H.1"));
  }

  void writeHeader(List featureCollections) throws IOException {
    List coords = new ArrayList<>();
    List pointCollections = new ArrayList<>();
    for (DsgFeatureCollection featureCollection : featureCollections) {
      pointCollections.add((PointFeatureCollection) featureCollection);
      coords.add(VariableSimpleBuilder
          .makeScalar(featureCollection.getTimeName(), "time of measurement", timeUnit.getUdUnit(), DataType.DOUBLE)
          .addAttribute(CF.CALENDAR, timeUnit.getCalendar().toString()).build());
      if (altUnits != null) {
        altitudeCoordinateName = featureCollection.getAltName();
        coords.add(VariableSimpleBuilder
            .makeScalar(altitudeCoordinateName, "altitude of measurement", altUnits, DataType.DOUBLE)
            .addAttribute(CF.POSITIVE, CF1Convention.getZisPositive(altName, altUnits)).build());
      }
    }

    coords.add(
        VariableSimpleBuilder.makeScalar(latName, "latitude of measurement", CDM.LAT_UNITS, DataType.DOUBLE).build());
    coords.add(
        VariableSimpleBuilder.makeScalar(lonName, "longitude of measurement", CDM.LON_UNITS, DataType.DOUBLE).build());
    super.writeHeader(coords, pointCollections, null, null);
  }


  /////////////////////////////////////////////////////////
  // writing data
  private int obsRecno;

  protected void writeRecord(PointFeature point) throws IOException {
    trackBB(point.getLocation().getLatLon(), point.getObservationTimeAsCalendarDate());

    StructureMembers.Builder smb = StructureMembers.builder().setName("Coords");
    smb.addMemberScalar(point.getFeatureCollection().getTimeName(), null, null, DataType.DOUBLE,
        point.getObservationTime());
    smb.addMemberScalar(latName, null, null, DataType.DOUBLE, point.getLocation().getLatitude());
    smb.addMemberScalar(lonName, null, null, DataType.DOUBLE, point.getLocation().getLongitude());
    if (altUnits != null)
      smb.addMemberScalar(point.getFeatureCollection().getAltName(), null, null, DataType.DOUBLE,
          point.getLocation().getAltitude());
    StructureData coords = new StructureDataFromMember(smb.build());

    // coords first so it takes precedence
    StructureDataComposite sdall = StructureDataComposite.create(ImmutableList.of(coords, point.getFeatureData()));
    obsRecno = super.writeStructureData(obsRecno, record, sdall, dataMap);
  }

  @Override
  void makeFeatureVariables(List featureData, boolean isExtended) {}

}