bapsflib._hdf.utils.helpers

Helper functions that are utilized by the the HDF5 utility classes defined in module bapsflib._hdf.utils.

Functions

build_shotnum_dset_relation(shotnum, dset, ...)

Compares the shotnum numpy array to the specified dataset, dset, to determine which indices contain the desired shot number(s) [for HDFReadControls]. As a results, two numpy arrays are returned which satisfy the rule::.

build_sndr_for_simple_dset(shotnum, dset, ...)

Compares the shotnum numpy array to the specified "simple" dataset, dset, to determine which indices contain the desired shot number(s). As a results, two numpy arrays are returned which satisfy the rule::.

build_sndr_for_complex_dset(shotnum, dset, ...)

Compares the shotnum numpy array to the specified "complex" dataset, dset, to determine which indices contain the desired shot number(s). As a results, two numpy arrays are returned which satisfy the rule::.

condition_controls(hdf_file, controls)

Conditions the controls argument for HDFReadControls and HDFReadData.

condition_shotnum(shotnum, dset_dict, ...)

Conditions the shotnum argument for HDFReadControls and HDFReadData.

do_shotnum_intersection(shotnum, sni_dict, ...)

Calculates intersection of shotnum and all existing dataset shot numbers, shotnum[sni].