Please, help us to better serve our user community by answering the following short survey: https://www.hdfgroup.org/website-survey/
HDF5  1.15.0.f39b228
API Reference
Fortran Filter (H5Z) Interface

Detailed Description

See also
Filters (H5Z), C-API
The HDF5 Filters, User Guide

Functions/Subroutines

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

Variables

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

Function/Subroutine Documentation

◆ h5zfilter_avail_f()

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

Queries if filter is available.

Parameters
filterFilter; 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
statusFlag; .TRUE. if filter is available, .FALSE. otherwise.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Zfilter_avail()

◆ h5zget_filter_info_f()

subroutine h5z::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
filterFilter; 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_flagsFlag, indicates if filter has its encoder and/or decoder available, possible values:
  • H5Z_FILTER_ENCODE_ENABLED_F
  • H5Z_FILTER_DECODE_ENABLED_F
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Zget_filter_info()

◆ h5zunregister_f()

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

Unregisters specified filters.

Parameters
filterFilter; 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
hdferrReturns 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.