Fortran Filter (H5Z) Interface

Detailed Description

See also

Filters (H5Z), C-API

The HDF5 Filters, User Guide

Modules
module	h5z
	This module contains Fortran interfaces for H5Z functions.

Functions/Subroutines
subroutine	h5zunregister_f (filter, hdferr)
	Unregisters specified filters.
subroutine	h5zfilter_avail_f (filter, status, hdferr)
	Queries if filter is available.
subroutine	h5zget_filter_info_f (filter, config_flags, hdferr)
	Queries if filter has its encoder and/or decoder available.

Variables
integer	h5z_filter_error_f
	H5Z_FILTER_ERROR.
integer	h5z_filter_none_f
	H5Z_FILTER_NONE.
integer	h5z_filter_all_f
	H5Z_FILTER_ALL.
integer	h5z_filter_deflate_f
	H5Z_FILTER_DEFLATE.
integer	h5z_filter_shuffle_f
	H5Z_FILTER_SHUFFLE.
integer	h5z_filter_fletcher32_f
	H5Z_FILTER_FLETCHER32.
integer	h5z_filter_szip_f
	H5Z_FILTER_SZIP.
integer	h5z_error_edc_f
	H5Z_ERROR_EDC.
integer	h5z_disable_edc_f
	H5Z_DISABLE_EDC.
integer	h5z_enable_edc_f
	H5Z_ENABLE_EDC.
integer	h5z_no_edc_f
	H5Z_NO_EDC.
integer	h5z_flag_optional_f
	H5Z_FLAG_OPTIONAL.
integer	h5z_filter_encode_enabled_f
	H5Z_FILTER_ENCODE_ENABLED.
integer	h5z_filter_decode_enabled_f
	H5Z_FILTER_DECODE_ENABLED.
integer	h5z_filter_nbit_f
	H5Z_FILTER_NBIT.
integer	h5z_filter_scaleoffset_f
	H5Z_FILTER_SCALEOFFSET.
integer	h5z_so_float_dscale_f
	H5Z_SO_FLOAT_DSCALE.
integer	h5z_so_float_escale_f
	H5Z_SO_FLOAT_ESCALE.
integer	h5z_so_int_f
	H5Z_SO_INT.
integer	h5z_so_int_minbits_default_f
	H5Z_SO_INT_MINBITS_DEFAULT.

Function/Subroutine Documentation

h5zfilter_avail_f()

subroutine h5zfilter_avail_f	(	integer, intent(in)	filter,
		logical, intent(out)	status,
		integer, intent(out)	hdferr
	)

Queries if filter is available.

Parameters

filter	Filter; may be one of the following: H5Z_FILTER_DEFLATE_F H5Z_FILTER_SZIP_F H5Z_FILTER_NBIT_F H5Z_FILTER_SCALEOFFSET_F H5Z_FILTER_SHUFFLE_F H5Z_FILTER_FLETCHER32_F
status	Flag; .TRUE. if filter is available, .FALSE. otherwise.
hdferr	Returns 0 if successful and -1 if it fails.

See C API: H5Zfilter_avail()

h5zget_filter_info_f()

subroutine h5zget_filter_info_f	(	integer, intent(in)	filter,
		integer, intent(out)	config_flags,
		integer, intent(out)	hdferr
	)

Queries if filter has its encoder and/or decoder available.

Parameters

filter	Filter; may be one of the following: H5Z_FILTER_DEFLATE_F H5Z_FILTER_SZIP_F H5Z_FILTER_NBIT_F H5Z_FILTER_SCALEOFFSET_F H5Z_FILTER_SHUFFLE_F H5Z_FILTER_FLETCHER32_Ffilter
config_flags	Flag, indicates if filter has its encoder and/or decoder available, possible values: H5Z_FILTER_ENCODE_ENABLED_F H5Z_FILTER_DECODE_ENABLED_F
hdferr	Returns 0 if successful and -1 if it fails.

See C API: H5Zget_filter_info()

h5zunregister_f()

subroutine h5zunregister_f	(	integer, intent(in)	filter,
		integer, intent(out)	hdferr
	)

Unregisters specified filters.

Parameters

filter	Filter; may have one of the following values: H5Z_FILTER_DEFLATE_F H5Z_FILTER_SZIP_F H5Z_FILTER_NBIT_F H5Z_FILTER_SCALEOFFSET_F H5Z_FILTER_SHUFFLE_F H5Z_FILTER_FLETCHER32_F
hdferr	Returns 0 if successful and -1 if it fails.

See C API: H5Zunregister()

Variable Documentation

h5z_disable_edc_f

integer h5z_disable_edc_f

H5Z_DISABLE_EDC.

h5z_enable_edc_f

integer h5z_enable_edc_f

H5Z_ENABLE_EDC.

h5z_error_edc_f

integer h5z_error_edc_f

H5Z_ERROR_EDC.

h5z_filter_all_f

integer h5z_filter_all_f

H5Z_FILTER_ALL.

h5z_filter_decode_enabled_f

integer h5z_filter_decode_enabled_f

H5Z_FILTER_DECODE_ENABLED.

h5z_filter_deflate_f

integer h5z_filter_deflate_f

H5Z_FILTER_DEFLATE.

h5z_filter_encode_enabled_f

integer h5z_filter_encode_enabled_f

H5Z_FILTER_ENCODE_ENABLED.

h5z_filter_error_f

integer h5z_filter_error_f

H5Z_FILTER_ERROR.

h5z_filter_fletcher32_f

integer h5z_filter_fletcher32_f

H5Z_FILTER_FLETCHER32.

h5z_filter_nbit_f

integer h5z_filter_nbit_f

H5Z_FILTER_NBIT.

h5z_filter_none_f

integer h5z_filter_none_f

H5Z_FILTER_NONE.

h5z_filter_scaleoffset_f

integer h5z_filter_scaleoffset_f

H5Z_FILTER_SCALEOFFSET.

h5z_filter_shuffle_f

integer h5z_filter_shuffle_f

H5Z_FILTER_SHUFFLE.

h5z_filter_szip_f

integer h5z_filter_szip_f

H5Z_FILTER_SZIP.

h5z_flag_optional_f

integer h5z_flag_optional_f

H5Z_FLAG_OPTIONAL.

h5z_no_edc_f

integer h5z_no_edc_f

H5Z_NO_EDC.

h5z_so_float_dscale_f

integer h5z_so_float_dscale_f

H5Z_SO_FLOAT_DSCALE.

h5z_so_float_escale_f

integer h5z_so_float_escale_f

H5Z_SO_FLOAT_ESCALE.

h5z_so_int_f

integer h5z_so_int_f

H5Z_SO_INT.

h5z_so_int_minbits_default_f

integer h5z_so_int_minbits_default_f

H5Z_SO_INT_MINBITS_DEFAULT.