template_bank_generator_HM.transform_pars#

Back to Module page

Summary#

Transforms [m1, m2, s1z, s2z, lambda1, lambda2] to commonly used parameters [mchirp, eta, chieff, chia, tilde{lambda}, delta tilde{lambda}]

Signature#

def transform_pars(pars)
Input variables#

Name

Type

Default

Description

pars

return value of gen_and_save_temp_structure (can be vector for n_sample = 1)

Output variables#

Return annotation

Docstring type

Description

None

n_sample x 6 array with mchirp, eta, chieff, chia, tilde{lambda} and delta tilde{lambda} (can be vector for n_wf = 1)

Docstring#

Transforms [m1, m2, s1z, s2z, lambda1, lambda2] to commonly used
parameters [mchirp, eta, chieff, chia, tilde{lambda},
delta tilde{lambda}]
:param pars:
    return value of gen_and_save_temp_structure
    (can be vector for n_sample = 1)
:return: n_sample x 6 array with mchirp, eta, chieff, chia,
         tilde{lambda} and delta tilde{lambda}
         (can be vector for n_wf = 1)