B d3@sdZddlZddlZddlmZddlmZddl m Z ddl m Z ddZ d d Zd d Zd dZddZddZddZddZdS)zFunctions to compute the area corresponding to different CBC on the m1 & m2 plane when given a central mchirp value and uncertainty. It also includes a function that calculates the source frame when given the detector frame mass and redshift. N)mass2_from_mchirp_mass1)quad) _redshift) FlatLambdaCDMcCs|d}|jdtdddddgdd |jd td d d |jdtdddd|jdtdddd|jdtddddd|jdddd|jddd ddS)!NzuArguments for estimating the source probabilities of a candidate event using the snr, mchirp, and effective distance.z--src-class-mass-limits)ZMIN_M2ZMAX_NSZMAX_M1g?g@gF@zMinimum and maximum values for the mass of the binary components and maximum mass of a neutron star, used as limits when computing the area correspondingto different CBC sources.)typenargsmetavardefaulthelpz--src-class-mass-gap-maxZMAX_GAPzUpper limit of the mass gap, corresponding to the minimum mass of a black hole. Used as limit of integration of the different CBC regions when considering the MassGap category.)rr r z--src-class-mchirp-to-deltam0TzZCoefficient to estimate the value of the mchirp uncertainty by mchirp_delta = m0 * mchirp.)rr requiredr z--src-class-eff-to-lum-distancea0zvCoefficient to estimate the value of the luminosity distance from the minimum eff distance by D_lum = a0 * min(D_eff).z!--src-class-lum-distance-to-delta)b0b1zCoefficients to estimate the value of the uncertainty on the luminosity distance from the estimated luminosity distance and the coinc snr by delta_lum = D_lum * exp(b0) * coinc_snr ** b1.)rrr r r z--src-class-mass-gap-separate store_truezQGives separate probabilities for each kind of mass gap CBC sources: GNS, GG, BHG.)actionr z--src-class-lal-cosmologyz^Uses the Planck15 cosmology defined in lalsuite instead of the astropy Planck15 default model.)add_argument_group add_argumentfloat)parserZ mchirp_groupr^/work/yifan.wang/ringdown/master-ringdown-env/lib/python3.7/site-packages/pycbc/mchirp_area.py insert_argss.  rcCst|j}|jrr|j|dkr(|d|d|dd|d|jd|j|jd|jd|jdd|j|jd S|d|dd|d|dd|j|jd|jd|jdd |j|jd S) Nz/MAX_GAP value cannot be lower than MAX_NS limitrr)max_m1min_m2)ns_maxgap_max)rrrr T) mass_limits mass_bdaryestimation_coeffmass_gapmass_gap_separate lal_cosmologyF) sortedZsrc_class_mass_limitsZsrc_class_mass_gap_maxerrorZsrc_class_eff_to_lum_distanceZsrc_class_lum_distance_to_deltaZsrc_class_mchirp_to_deltaZsrc_class_mass_gap_separateZsrc_class_lal_cosmology)argsrZmass_limits_sortedrrrfrom_cliCs4      r)c Cs\|rtddd}nd}t||d}t|||d}t|||d}d||}||d}|S)aTakes values of distance and its uncertainty and returns a dictionary with estimates of the redshift and its uncertainty. If the argument 'lal_cosmology' is True, it uses Planck15 cosmology model as defined in lalsuite instead of the astropy default. Constants for lal_cosmology taken from Planck15_lal_cosmology() in https://git.ligo.org/lscsoft/pesummary/-/blob/master/pesummary/gw/ cosmology.py. gP@gV-?)ZH0ZOm0N) cosmologyg?)centraldelta)rr) ZdistanceZ distance_stdr%r*Z z_estimationZ z_est_maxZ z_est_minZz_std_estimationzrrrredshift_estimationfs    r.cCs8|d|}|||d|d|dd}||fS)zTakes values of redshift, redshift uncertainty, detector mass and its uncertainty and computes the source mass and its uncertainty. g?g@g?r)r-Zdel_zZmdetZdel_mdetZmsrcZdel_msrcrrrsrc_mass_from_z_det_mass}s  r/cCstdd|||d}|dS)zfReturns the integral of m2 over m1 between x_min and x_max, assuming that mchirp is fixed. cSs t||S)N)m2mcm1)xmcrrrzintmc..)r(r)r)r2Zx_minZx_maxZintegralrrrintmcsr5cs|d|d}|d|d}d|}d|}dkrJ|} |} dd} n t|} t|} fdd} t|} t|} fdd}t| ||}t| ||}t| ||}t| ||}t|||}t|||}t| ||d}t|||d}||||}|S) aReturns the area under the chirp mass contour in a region of the m1-m2 plane (m1 > m2). Parameters ---------- trig_mc : sequence of two values first represents central estimate of mchirp in source frame, second its uncertainty lim_h1, lim_h2 : floats or the string 'diagonal' upper and lower horizontal limits of the region (limits on m2) lim_v1, lim_v2 : floats right and left vertical limits of the region (limits on m1) Returns ------- area : float rrgu溆a?diagonalcSs|S)Nr)r1rrrr3r4zget_area..csS)Nr)r1)lim_h1rrr3r4csS)Nr)r1)lim_h2rrr3r4)r0npZclipr5r)trig_mcr7r8Zlim_v1Zlim_v2mc_maxmc_minZmi_maxZmi_minZmax_h1Zmin_h1Zfun_supZmax_h2Zmin_h2Zfun_infZlim_max1Zlim_max2Zlim_min1Zlim_min2Zint_maxZint_minZ intline_supZ intline_infZarear)r7r8rget_areas0         r=cCst|d|d|d|d}|d}|d}|d} |d} t|d| | |} t|| | | |} t|| || |} t|d| | | }t|| || | }t|d||| }|r|r||| || | dS|| | ||| d S|| | d S) zComputes the area inside the lines of the second component mass as a function of the first component mass for the two extreme values of mchirp: mchirp +/- mchirp_uncertainty, for each region of the source classifying diagram. r+r,rrrrr6)BNSGNSNSBHGGBHGBBH)r>r@rCzMass Gap)r>r@rC)r/r=) trig_mc_detr r!r-r#r$r:Zm2_minZm1_maxrrZabbhZabhgZansbhZaggZagnsZabnsrrr calc_areass8  rEcsl|d}|d}|d}|||dd}|d|}|t|d||d} t|| |d } |d } |d } |d d } |dd }|d| d| dkr| r| rddddddd}qddddd}n dddd}n|d|d| dkr6| r(| rddddddd}nddddd}n dddd}n2t|||| | | tfddD}|S)aComputes the different probabilities that a candidate event belongs to each CBC source category taking as arguments the chirp mass, the coincident SNR and the effective distance, and estimating the chirp mass uncertainty, the luminosity distance (and its uncertainty) and the redshift (and its uncertainty). Probability is estimated to be directly proportional to the area of the corresponding CBC region. r r!r"r )r+r,rrrr%r#r$rgu溆a?rr+rgg?)r>r?r@rArBrC)r>r@rCzMass Gap)r>r@rCcsi|]}||qSrr).0key)areas total_arearr )sz&calc_probabilities..)mathexpr.rEsumvalues)ZmchirpZsnrZ eff_distanceZsrc_argsr r!ZcoeffrDZdist_estimationZdist_std_estimationr-r#r$r;r<Z probabilitiesr)rHrIrcalc_probabilitiessD        rO)__doc__rKnumpyr9Zpycbc.conversionsrr0Zscipy.integraterZpycbc.cosmologyrZastropy.cosmologyrrr)r.r/r5r=rErOrrrr s    0# 32