Documentation Center

  • Trial Software
  • Product Updates

H5Z.get_filter_info

Information about filter

Syntax

filter_config_flags = H5Z.get_filter_info(filter)

Description

filter_config_flags = H5Z.get_filter_info(filter) retrieves information about the filter specified by its identifier. At present, the information returned is the filter's configuration flags, indicating whether the filter is configured to decode data, to encode data, neither, or both. filter_config_flags should be used with the HDF5 constant values H5Z_FILTER_CONFIG_ENCODE_ENABLED and H5Z_FILTER_CONFIG_DECODE_ENABLED in a bitwise AND operation. If the resulting value is 0, then the encode or decode functionality is not available.

Examples

Determine if encoding is enabled for the deflate filter.

flags = H5Z.get_filter_info('H5Z_FILTER_DEFLATE');
functionality = H5ML.get_constant_value('H5Z_FILTER_CONFIG_ENCODE_ENABLED');
enabled = bitand(flags,functionality) > 0;

See Also

| |

Was this topic helpful?