scri.SpEC.file_io.rotating_paired_xor_multishuffle_bzip2

Functions

load(file_name[, ignore_validation, ...])

Load a waveform in RPXMB format

save(w[, file_name, file_write_mode, ...])

Save a waveform in RPXMB format
scri.SpEC.file_io.rotating_paired_xor_multishuffle_bzip2.load(file_name, ignore_validation=False, check_md5=True, transform_to_inertial=False, **kwargs)[source]

Load a waveform in RPXMB format

This function is essentially a backwards-compatibility wrapper for the the sxs.rpxmb.load function; see that function’s docstring for full details.

However, note that this function has slightly different behavior (for backwards compatibility):

  1. The default value of ignore_validation is False, which means that a ValueError is raised whenever validation fails, rather than just a warning.

  2. The default value of transform_to_inertial is False, which means that the returned waveform will still be in the corotating frame (specified most precisely by the log_frame attribute of the returned waveform).

  3. If transform_to_inertial is False, the return value is a tuple of (w, log_frame); otherwise, it is just the waveform w. In both cases, w.log_frame will contain this data.

scri.SpEC.file_io.rotating_paired_xor_multishuffle_bzip2.save(w, file_name=None, file_write_mode='w', L2norm_fractional_tolerance=1e-10, log_frame=None, shuffle_widths=(16, 4, 2, 2, 2, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 4, 4, 4, 4))[source]

Save a waveform in RPXMB format

This function is essentially a backwards-compatibility wrapper for the the sxs.rpxmb.save function; see that function’s docstring for details.