PIO_def_var_deflate

Set deflate & shuffle filter setting for the variable. More...

Functions/Subroutines
integer function	spio_def_var::pio_def_var_deflate_file_vid (file, varid, shuffle, deflate, deflate_level)
	Set/Change the deflate filter (NetCDF4/HDF5 compression) settings for a variable. More...
integer function	spio_def_var::pio_def_var_deflate_file_vdesc (file, vdesc, shuffle, deflate, deflate_level)
	Set/Change the deflate filter (NetCDF4/HDF5 compression) settings for a variable. More...
integer function	spio_def_var::pio_def_var_deflate_fh_vid (fh, varid, shuffle, deflate, deflate_level)
	Set/Change the deflate filter (NetCDF4/HDF5 compression) settings for a variable. More...

Detailed Description

Set deflate & shuffle filter setting for the variable.

This API can be used to set/change the deflate (NetCDF4/HDF5 compression) filter setting for the variable. The deflate levels range from 1 (low compression) to 9 (highest compression). This setting is only valid for NetCDF4/HDF5 files.

Note that frequently the shuffle filter setting is also enabled (to shuffle data before compression, to improve the ratio of compression) when the deflate setting is enabled. The shuffle filter is a low cost filter that improves the compression of data.

This API is a collective call (Although the library might internally choose to make progress on a single or small subset of MPI processes) on the I/O system associated with the file

Function/Subroutine Documentation

pio_def_var_deflate_fh_vid()

integer function spio_def_var::pio_def_var_deflate_fh_vid	(	integer, intent(in)	fh,
		integer, intent(in)	varid,
		integer, intent(in)	shuffle,
		integer, intent(in)	deflate,
		integer, intent(in)	deflate_level
	)

Set/Change the deflate filter (NetCDF4/HDF5 compression) settings for a variable.

Parameters

[in]	fh	The file id/handle
[in]	varid	The id of the variable
[in]	shuffle	The shuffle filter setting (0 to disable, 1 to enable) for the variable
[in]	deflate	The deflate filter setting (0 to disable, 1 to enable) for the variable
[in]	deflate_level	The deflate filter level setting for the variable. The levels range from 1 (lowest compression) to 9 (highest level of compression)

Return values

ierr	: The error return code. Set to PIO_NOERR on success, or an error code otherwise (See PIO_seterrorhandling for more information on how to customize/set error handling)

pio_def_var_deflate_file_vdesc()

integer function spio_def_var::pio_def_var_deflate_file_vdesc	(	type(file_desc_t), intent(in)	file,
		type(var_desc_t), intent(in)	vdesc,
		integer, intent(in)	shuffle,
		integer, intent(in)	deflate,
		integer, intent(in)	deflate_level
	)

Set/Change the deflate filter (NetCDF4/HDF5 compression) settings for a variable.

Parameters

[in]	file	The file handle. File descriptor structure. This structure holds information associated with each open file
[in]	vdesc	The descriptor of the variable. Variable description structure.
[in]	shuffle	The shuffle filter setting (0 to disable, 1 to enable) for the variable
[in]	deflate	The deflate filter setting (0 to disable, 1 to enable) for the variable
[in]	deflate_level	The deflate filter level setting for the variable. The levels range from 1 (lowest compression) to 9 (highest level of compression)

Return values

ierr	: The error return code. Set to PIO_NOERR on success, or an error code otherwise (See PIO_seterrorhandling for more information on how to customize/set error handling)

pio_def_var_deflate_file_vid()

integer function spio_def_var::pio_def_var_deflate_file_vid	(	type(file_desc_t), intent(in)	file,
		integer, intent(in)	varid,
		integer, intent(in)	shuffle,
		integer, intent(in)	deflate,
		integer, intent(in)	deflate_level
	)

Set/Change the deflate filter (NetCDF4/HDF5 compression) settings for a variable.

Parameters

[in]	file	The file handle. File descriptor structure. This structure holds information associated with each open file
[in]	varid	The variable id
[in]	shuffle	The shuffle filter setting (0 to disable, 1 to enable) for the variable
[in]	deflate	The deflate filter setting (0 to disable, 1 to enable) for the variable
[in]	deflate_level	The deflate filter level setting for the variable. The levels range from 1 (lowest compression) to 9 (highest level of compression)

Return values

ierr	: The error return code. Set to PIO_NOERR on success, or an error code otherwise (See PIO_seterrorhandling for more information on how to customize/set error handling)