pycbc.bank package

Submodules

pycbc.bank.bank_conversions module

This module is supplied to make a convenience function for converting into specific values from PyCBC template banks.

pycbc.bank.bank_conversions.get_bank_property(parameter, bank, template_ids, duration_approximant='SEOBNRv4')[source]

Get a specific value from a hdf file object in standard PyCBC template bank format

Parameters

  • parameter (str) – the parameter to convert to, must be in conversion_options

  • bank (h5py File object or dictionary of arrays) – Template bank containing the parameters for use in conversions must contain mass1, mass2, spin1z, spin2z as a minimum

  • template_ids (numpy array) – Array of template IDs for reading a set of templates from the bank

  • Parameters (Optional) –

  • ------------------- –

  • duration_approximant (string) – The approximant used to calculate the duration of the template if not already given

Returns

values – Array of whatever the requested parameter is calculated for the specified templates in the bank

Return type

numpy array, same size as template_ids

Module contents

This packages contains modules for dealing with the template bank