ucar.nc2.write.Nc4Chunking 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-2018 John Caron and University Corporation for Atmospheric Research/Unidata
 * See LICENSE for license information.
 */

package ucar.nc2.write;

import ucar.nc2.Variable;

/** Interface for strategies deciding how to chunk netcdf-4 variables. */
public interface Nc4Chunking {

  enum Strategy {
    standard, grib, none
  }

  /** Should this variable be chunked? */
  boolean isChunked(Variable v);

  /** Compute the chunk size for this Variable. */
  long[] computeChunking(Variable v);

  /** Get the deflation level. 0 corresponds to no compression and 9 to maximum compression. */
  int getDeflateLevel(Variable v);

  /**
   * Set true to turn shuffling on which may improve compression. This option is ignored unless a non-zero deflation
   * level is specified.
   */
  boolean isShuffle(Variable v);

}