Page tree

The license could not be verified: License Certificate has expired!

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Content Layer
id1195548671
Content Column
width50.00001%
id1195578110
classrm_pagetree_col mobile-hide
Content Block
id1195578111
 
Content Column
width50.00001%
id1195548673
classhdf-rm-main-column
Content Block
id1195548672

Include Content
render-without-blockstrue
page.rm-navbar
HTML Wrap
classhdf-print-only

Page Title

HTML Wrap
classhdf-rm-summary-block

Hdf rm anchor
AnchorNamesummary

Excerpt

Returns information about a filter in a pipeline

HTML Wrap
classhdf-rm-content-block

Hdf rm anchor
AnchorNameprocedure

Procedure:
HTML Wrap
classhdf-rm-section
HTML Wrap
classhdf_procedure

H5P_GET_FILTER2 ( plist_id, idx, flags, cd_nelmts, cd_values, namelen, name, filter_config )

Hdf rm anchor
AnchorNamesignature

Signature:
HTML Wrap
classhdf-rm-section
HTML Wrap
classhdf-togglebox hdf-c

HTML Add Class
hdf-togglebutton-visible
hdf-togglebutton-visible
selector.hdf-togglebutton.hdf-c

HTML
<pre><code class="language-c">H5Z_filter_t H5Pget_filter2(
        hid_t plist_id, 
        unsigned idx, 
        unsigned int *flags,
        size_t *cd_nelmts,
        unsigned cd_values[],
        size_t namelen, 
        char name[],
        unsigned *filter_config
    )
        </code></pre>
HTML Wrap
classhdf-togglebox hdf-fortran hdf-togglebox-hidden

HTML Add Class
hdf-togglebutton-visible
hdf-togglebutton-visible
selector.hdf-togglebutton.hdf-fortran

HTML
<pre><code class="language-fortran">Fortran90 Interface:  h5pget_filter_f
    
SUBROUTINE h5pget_filter_f(prp_id, filter_number, flags, cd_nelmts, 
                           cd_values, namelen, name, filter_id, hdferr)
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: prp_id    ! Property list identifier
  INTEGER, INTENT(IN) :: filter_number    ! Sequence number within the filter
                                          ! pipeline of the filter for which
                                          ! information is sought
  INTEGER, DIMENSION(*), INTENT(OUT) :: cd_values  
                                          ! Auxiliary data for the filter
  INTEGER, INTENT(OUT) :: flags           ! Bit vector specifying certain 
                                          ! general properties of the filter
  INTEGER(SIZE_T), INTENT(INOUT) :: cd_nelmts      
                                          ! Number of elements in cd_values
  INTEGER(SIZE_T), INTENT(IN) :: namelen  ! Anticipated number of characters 
                                          ! in name
  CHARACTER(LEN=*), INTENT(OUT) :: name   ! Name of the filter
  INTEGER, INTENT(OUT) :: filter_id       ! Filter identification number
  INTEGER, INTENT(OUT) :: hdferr          ! Error code
                                          ! 0 on success and -1 on failure
END SUBROUTINE h5pget_filter_f
	</code></pre>

Hdf rm anchor
AnchorNameparameters

Parameters:
HTML Wrap
classhdf-rm-section
hid_t plist_idIN: Dataset or group creation property list identifier
int idxIN: Sequence number within the filter pipeline of the filter for which information is sought
unsigned int * flagsOUT: Bit vector specifying certain general properties of the filter
size_t * cd_nelmtsIN/OUT: Number of elements in cd_values
unsigned int * cd_valuesOUT: Auxiliary data for the filter
size_t namelenIN: Anticipated number of characters in name
char name[]OUT: Name of the filter
unsigned int * filter_config    OUT: Bit field, as described in H5Z_GET_FILTER_INFO

Hdf rm anchor
AnchorNamedescription

Description:
HTML Wrap
classhdf-rm-section

H5P_GET_FILTER2 returns information about a filter, specified by its filter number, in a filter pipeline, specified by the property list with which it is associated.

plist_id must be a dataset or group creation property list.

idx is a value between zero and N-1, as described in H5P_GET_NFILTERS. The function will return a negative value if the filter number is out of range.

The structure of the flags argument is discussed in H5P_SET_FILTER.

On input, cd_nelmts indicates the number of entries in the cd_values array, as allocated by the caller; on return,cd_nelmts contains the number of values defined by the filter.

If name is a pointer to an array of at least namelen bytes, the filter name will be copied into that array. The name will be null terminated if namelen is large enough. The filter name returned will be the name appearing in the file, the name registered for the filter, or an empty string.

filter_config is the bit field described in H5Z_GET_FILTER_INFO.

Hdf rm anchor
AnchorNamereturns

Returns:
HTML Wrap
classhdf-rm-section

Returns the filter identifier if successful:

H5Z_FILTER_DEFLATEData compression filter, employing the gzip algorithm
H5Z_FILTER_SHUFFLEData shuffling filter
H5Z_FILTER_FLETCHER32  Error detection filter, employing the Fletcher32 checksum algorithm
H5Z_FILTER_SZIPData compression filter, employing the SZIP algorithm
H5Z_FILTER_NBITData compression filter, employing the N-bit algorithm
H5Z_FILTER_SCALEOFFSETData compression filter, employing the scale-offset algorithm

Otherwise returns a negative value.

Hdf rm anchor
AnchorNameexample

Example:

Coming Soon!

hdf-
HTML Wrap
classhdf-rm-section
Comment (Hide)
HTML Wrap
class
togglebox hdf-c

Bitbucket Server file
repoSlughdf5
branchIdrefs/heads/1.10/master
projectKeyHDFFV
filepathexamples/h5_

subset

cmprss.c
showLineNumberstrue
lineStart

32

93
progLang

cpp

plain
lineEnd

42

115
applicationLink5ac7b370-7412-3c8c-ad20-807a68261336

HTML Wrap
classhdf-togglebox hdf-fortran hdf-togglebox-hidden

Bitbucket Server file
repoSlughdf5
branchIdrefs/heads/1.10/master
projectKeyHDFFV
filepathfortran/examples/

compound

h5_cmprss.f90
showLineNumberstrue
lineStart

25

102
progLangplain
lineEnd

35

121
applicationLink5ac7b370-7412-3c8c-ad20-807a68261336

 

Hdf rm anchor
AnchorNamehistory

History:
HTML Wrap
classhdf-rm-section
Release    Change
1.8.5Function extended to work with group creation property lists.
1.8.0Function introduced in this release.