PIO_inq_var_deflate

Inquire the compression settings for a variable in a NetCDF4 file. More...

Functions/Subroutines
integer function	spio_inq_var::pio_inq_var_deflate_file_vid (file, varid, shuffle_status, deflate_status, deflate_level)
	Inquire the compression settings for a variable in a NetCDF4 file. More...
integer function	spio_inq_var::pio_inq_var_deflate_fh_vid (fh, varid, shuffle_status, deflate_status, deflate_level)
	Inquire the compression settings for a variable in a NetCDF4 file. More...
integer function	spio_inq_var::pio_inq_var_deflate_file_vdesc (file, vdesc, shuffle_status, deflate_status, deflate_level)
	Inquire the compression settings for a variable in a NetCDF4 file. More...

Detailed Description

Inquire the compression settings for a variable in a NetCDF4 file.

This API can be used to inquire the HDF5 deflate/shuffle compression settings of a variable in a NetCDF4 file. An error code is returned if the provided file is not in the NetCDF4 (HDF5) file format.

Shuffle and Deflate are filters available with HDF5 to aid in data compression. The shuffle option is frequently used/enabled with the deflate option to shuffle the data prior to compression, usually improving the compression ratio of the data. The deflate option is a set of levels, 1-9, that can be used to control the amount of compression (deflate level 1 is faster than level 9, however level 9 would compress data more than level 1).

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_inq_var_deflate_fh_vid()

integer function spio_inq_var::pio_inq_var_deflate_fh_vid	(	integer, intent(in)	fh,
		integer, intent(in)	varid,
		integer, intent(out)	shuffle_status,
		integer, intent(out)	deflate_status,
		integer, intent(out)	deflate_level
	)

Inquire the compression settings for a variable in a NetCDF4 file.

Parameters

[in]	fh	The file id/handle
[in]	varid	The id of the variable
[out]	shuffle_status	The status of the shuffle filter setting for the variable. Set to 1 if the shuffle filter is enabled, 0 otherwise
[out]	deflate_status	The status of the deflate filter setting for the variable. Set to 1 if the deflate filter is enabled, 0 otherwise
[out]	deflate_level	The level of the deflate filter setting for the variable. The deflate levels range from 1 (least compression) to 9. The deflate level is set to 0 if the deflate filter is not enabled for the variable (i.e., deflate_status == 0)

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_inq_var_deflate_file_vdesc()

integer function spio_inq_var::pio_inq_var_deflate_file_vdesc	(	type(file_desc_t), intent(in)	file,
		type(var_desc_t), intent(in)	vdesc,
		integer, intent(out)	shuffle_status,
		integer, intent(out)	deflate_status,
		integer, intent(out)	deflate_level
	)

Inquire the compression settings for a variable in a NetCDF4 file.

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.
[out]	shuffle_status	The status of the shuffle filter setting for the variable. Set to 1 if the shuffle filter is enabled, 0 otherwise
[out]	deflate_status	The status of the deflate filter setting for the variable. Set to 1 if the deflate filter is enabled, 0 otherwise
[out]	deflate_level	The level of the deflate filter setting for the variable. The deflate levels range from 1 (least compression) to 9. The deflate level is set to 0 if the deflate filter is not enabled for the variable (i.e., deflate_status == 0)

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_inq_var_deflate_file_vid()

integer function spio_inq_var::pio_inq_var_deflate_file_vid	(	type(file_desc_t), intent(in)	file,
		integer, intent(in)	varid,
		integer, intent(out)	shuffle_status,
		integer, intent(out)	deflate_status,
		integer, intent(out)	deflate_level
	)

Inquire the compression settings for a variable in a NetCDF4 file.

Parameters

[in]	file	The file handle. File descriptor structure. This structure holds information associated with each open file
[in]	varid	The id of the variable
[out]	shuffle_status	The status of the shuffle filter setting for the variable. Set to 1 if the shuffle filter is enabled, 0 otherwise
[out]	deflate_status	The status of the deflate filter setting for the variable. Set to 1 if the deflate filter is enabled, 0 otherwise
[out]	deflate_level	The level of the deflate filter setting for the variable. The deflate levels range from 1 (least compression) to 9. The deflate level is set to 0 if the deflate filter is not enabled for the variable (i.e., deflate_status == 0)

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)