diffbank.metric#

Functions related to the parameter space metric.

diffbank.metric.get_density(theta, amp, Psi, fs, Sn)[source]#

Computes the determinant of the metric over the intrinsic of the binary, maximized over the time and phase at coalescence.

Parameters

  • theta (ndarray) – point at which to compute metric density

  • amp (Callable[[ndarray, ndarray], ndarray]) – function returning the amplitude of the Fourier-domain waveform as a function of frequency and parameters

  • Psi (Callable[[ndarray, ndarray], ndarray]) – function returning the phase of the Fourier-domain waveform as a function of frequency and parameters

  • fs (ndarray) – uniformly-spaced grid of frequencies used to compute the noise-weighted inner product

  • Sn (Callable[[ndarray], ndarray]) – power spectral density of the detector noise

Return type

ndarray

Returns

The determinant of the metric over the intrinsic parameters of the binary.

diffbank.metric.get_g(theta, amp, Psi, fs, Sn)[source]#

Computes the metric for the intrinsic binary parameters of the binary, maximized over the time and phase at coalescence.

Parameters

  • theta (ndarray) – point at which to compute metric

  • amp (Callable[[ndarray, ndarray], ndarray]) – function returning the amplitude of the Fourier-domain waveform as a function of frequency and parameters

  • Psi (Callable[[ndarray, ndarray], ndarray]) – function returning the phase of the Fourier-domain waveform as a function of frequency and parameters

  • fs (ndarray) – uniformly-spaced grid of frequencies used to compute the noise-weighted inner product

  • Sn (Callable[[ndarray], ndarray]) – power spectral density of the detector noise

Return type

ndarray

Returns

The metric, where the values of the index correspond to the intrinsic parameters in the same order they appear in theta.

diffbank.metric.get_gam(theta, amp, Psi, fs, Sn)[source]#

Computes the metric for the time of coalescence and intrinsic parameters of the binary.

Parameters

  • theta (ndarray) – point at which to compute metric

  • amp (Callable[[ndarray, ndarray], ndarray]) – function returning the amplitude of the Fourier-domain waveform as a function of frequency and parameters

  • Psi (Callable[[ndarray, ndarray], ndarray]) – function returning the phase of the Fourier-domain waveform as a function of frequency and parameters

  • fs (ndarray) – uniformly-spaced grid of frequencies used to compute the noise-weighted inner product

  • Sn (Callable[[ndarray], ndarray]) – power spectral density of the detector noise

Return type

ndarray

Returns

The metric. The first value of the index corresponds to the time of coalescence. The other values of the index correspond to the intrinsic parameters, in the same order they appear in theta.

diffbank.metric.get_metric_ellipse(theta, amp, Psi, fs, Sn)[source]#

Gets the ellipse representation of the metric.

Warning

Only works in two dimensions.

Parameters

  • theta (ndarray) – point at which to find metric ellipse

  • amp (Callable[[ndarray, ndarray], ndarray]) – function returning the amplitude of the Fourier-domain waveform as a function of frequency and parameters

  • Psi (Callable[[ndarray, ndarray], ndarray]) – function returning the phase of the Fourier-domain waveform as a function of frequency and parameters

  • fs (ndarray) – uniformly-spaced grid of frequencies used to compute the noise-weighted inner product

  • Sn (Callable[[ndarray], ndarray]) – power spectral density of the detector noise

Return type

ndarray

Returns

Major and minor axes and orientation of the metric ellipse.