B dL@sdZddlmZddlZddlmZddlmZddlmZddlm Z Gdd d e j Z Gd d d e Z Gd d d e Z GdddejZd d d dgZdS)zE This modules provides classes for evaluating angular distributions. )ErrorN) VARARGS_DELIM) boundaries)bounded)uniformcsXeZdZdZdZddejfZdfdd Ze dd Z fd d Z e d d Z ZS) UniformAngleaA uniform distribution in which the dependent variable is between `[0,2pi)`. The domain of the distribution may optionally be made cyclic using the `cyclic_domain` parameter. Bounds may be provided to limit the range for which the pdf has support. If provided, the parameter bounds are in radians. Parameters ---------- cyclic_domain : {False, bool} If True, cyclic bounds on [0, 2pi) are applied to all values when evaluating the pdf. This is done prior to any additional bounds specified for a parameter are applied. Default is False. \**params : The keyword arguments should provide the names of parameters and (optionally) their corresponding bounds, as either `boundaries.Bounds` instances or tuples. The bounds must be in [0,2PI). These are converted to radians for storage. None may also be passed; in that case, the domain bounds will be used. Notes ------ For more information, see Uniform. Z uniform_anglerFc stj|jd|jd|d|_x|D]\}}|dkr@|j}nBt|tjrn|j|j|_|j|j|_nt|d|d}|j |jj ks|j |jj krt dj |jj |jj |j |j d|||<q(Wt t|jf|dS)Nr)cyclicz*bounds must be in [{x},{y}); got [{a},{b}))xyab)rBounds _domainbounds_domainitems isinstance_min __class___maxminmax ValueErrorformatsuperr__init__)self cyclic_domainparamspZbnds)rh/work/yifan.wang/ringdown/master-ringdown-env/lib/python3.7/site-packages/pycbc/distributions/angular.pyr:s      zUniformAngle.__init__cCs|jS)z'Returns the domain of the distribution.)r)rr!r!r"domainVszUniformAngle.domainc s,tfdd|D}ttjf|S)aMaps values to be in [0, 2pi) (the domain) first, before applying any additional boundary conditions. Parameters ---------- \**kwargs : The keyword args should be the name of a parameter and value to apply its boundary conditions to. The arguments need not include all of the parameters in self. Returns ------- dict A dictionary of the parameter names and the conditioned values. cs*g|]"\}}|jkr|j|gqSr!)_boundsrapply_conditions).0r val)rr!r" lsz:UniformAngle.apply_boundary_conditions..)dictrrrapply_boundary_conditions)rkwargs)r)rr"r*[s z&UniformAngle.apply_boundary_conditionscCs(d||d|i}tj||||d|dS)aReturns a distribution based on a configuration file. The parameters for the distribution are retrieved from the section titled "[`section`-`variable_args`]" in the config file. By default, only the name of the distribution (`uniform_angle`) needs to be specified. This will results in a uniform prior on `[0, 2pi)`. To make the domain cyclic, add `cyclic_domain =`. To specify boundaries that are not `[0, 2pi)`, add `(min|max)-var` arguments, where `var` is the name of the variable. For example, this will initialize a variable called `theta` with a uniform distribution on `[0, 2pi)` without cyclic boundaries: .. code-block:: ini [{section}-theta] name = uniform_angle This will make the domain cyclic on `[0, 2pi)`: .. code-block:: ini [{section}-theta] name = uniform_angle cyclic_domain = Parameters ---------- cp : pycbc.workflow.WorkflowConfigParser A parsed configuration file that contains the distribution options. section : str Name of the section in the configuration file. variable_args : str The names of the parameters for this distribution, separated by ``VARARGS_DELIM``. These must appear in the "tag" part of the section header. Returns ------- UniformAngle A distribution instance from the pycbc.inference.prior module. rF)Zbounds_requiredadditional_opts)has_option_tagrZbounded_from_config)clscpsection variable_argsr,r!r!r" from_configqs .  zUniformAngle.from_config)F)__name__ __module__ __qualname____doc__namenumpypirrpropertyr#r* classmethodr2 __classcell__r!r!)rr"rs  rcsXeZdZdZdZejZejZ ej Z dej fZ fddZddZdd Zd d ZZS) SinAngleaA sine distribution; the pdf of each parameter `\theta` is given by: ..math:: p(\theta) = \frac{\sin \theta}{\cos\theta_0 - \cos\theta_1}, \theta_0 \leq \theta < \theta_1, and 0 otherwise. Here, :math:`\theta_0, \theta_1` are the bounds of the parameter. The domain of this distribution is `[0, pi]`. This is accomplished by putting hard boundaries at `[0, pi]`. Bounds may be provided to further limit the range for which the pdf has support. As with `UniformAngle`, these are initialized in radians. Parameters ---------- \**params : The keyword arguments should provide the names of parameters and (optionally) their corresponding bounds, as either `boundaries.Bounds` instances or tuples. The bounds must be in [0,PI]. These are converted to radians for storage. None may also be passed; in that case, the domain bounds will be used. Z sin_anglerc sfttjf|tjjdjddddd_tfddj D _ t j _ dS)Nrr closedF)Z btype_minZ btype_maxr c s2g|]*}tt|d|dqS)r r)r8logabs_func)r&Zbnd)rr!r"r(sz%SinAngle.__init__..)rr=rrrrrsumr$values_lognormr8exp_norm)rr)r)rr"rs    zSinAngle.__init__cCs\t|j|dt|j|d}dt|j|d|}t| ||}|S)zMReturn inverse of cdf for mapping unit interval to parameter bounds. rr g?)r8cosr$arccos)rargvaluescaleoffset new_valuer!r!r" _cdfinv_params zSinAngle._cdfinv_paramc s6|kr dS|j|tfdd|jDS)zReturns the pdf at the given values. The keyword arguments must contain all of parameters in self's params. Unrecognized arguments are ignored. gcsg|] }|qSr!r!)r&r )r+r!r"r(sz!SinAngle._pdf..)rF_dfuncr8array_paramsprod)rr+r!)r+r"_pdfsz SinAngle._pdfc s@|krtj S|jt|tfdd|jDS)zReturns the log of the pdf at the given values. The keyword arguments must contain all of parameters in self's params. Unrecognized arguments are ignored. csg|] }|qSr!r!)r&r )r+r!r"r(sz$SinAngle._logpdf..)r8infrDr?rOrPrQrB)rr+r!)r+r"_logpdfs zSinAngle._logpdf)r3r4r5r6r7r8rGrAsinrOrH_arcfuncr9rrrNrSrUr<r!r!)rr"r=s    r=c@sDeZdZdZdZejZejZ ej Z ej dej dfZ ddZdS)CosAngleaA cosine distribution. This is the same thing as a sine distribution, but with the domain shifted to `[-pi/2, pi/2]`. See SinAngle for more details. Parameters ---------- \**params : The keyword arguments should provide the names of parameters and (optionally) their corresponding bounds, as either `boundaries.Bounds` instances or tuples. The bounds must be in [-PI/2, PI/2]. Z cos_anglercCsh|j|d}|j|d}t|t|}dt|t|t|}t|||}|S)Nrr g?)r$r8rVarcsin)rparamrJr rrKrLrMr!r!r"rNs "zCosAngle._cdfinv_paramN)r3r4r5r6r7r8rVrArGrOrYrWr9rrNr!r!r!r"rXs rXc@s~eZdZdZdZeZeZdZ dZ dddZ e d d Z e d d Ze d dZddZddZddZddZeddZdS)UniformSolidAngleaA distribution that is uniform in the solid angle of a sphere. The names of the two angluar parameters can be specified on initalization. Parameters ---------- polar_angle : {'theta', str} The name of the polar angle. azimuthal_angle : {'phi', str} The name of the azimuthal angle. polar_bounds : {None, tuple} Limit the polar angle to the given bounds. If None provided, the polar angle will vary from 0 (the north pole) to pi (the south pole). The bounds should be specified as factors of pi. For example, to limit the distribution to the northern hemisphere, set `polar_bounds=(0,0.5)`. azimuthal_bounds : {None, tuple} Limit the azimuthal angle to the given bounds. If None provided, the azimuthal angle will vary from 0 to 2pi. The bounds should be specified as factors of pi. For example, to limit the distribution to the one hemisphere, set `azimuthal_bounds=(0,1)`. azimuthal_cyclic_domain : {False, bool} Make the domain of the azimuthal angle be cyclic; i.e., azimuthal values are constrained to be in [0, 2pi) using cyclic boundaries prior to applying any other boundary conditions and prior to evaluating the pdf. Default is False. Zuniform_solidanglethetaphiNFcCs|dkr|j}|dkr|j}|jf||i|_|jf||d|i|_||_||_|jj |_ |j |jjt |j |_dS)Nr)_default_polar_angle_default_azimuthal_angle _polardistcls _polardist_azimuthaldistcls_azimuthaldist _polar_angle_azimuthal_angleboundscopyr$updatesortedkeysrQ)r polar_angleazimuthal_angle polar_boundsazimuthal_boundsazimuthal_cyclic_domainr!r!r"r+s  zUniformSolidAngle.__init__cCs|jS)a_dict: The bounds on each angle. The keys are the names of the polar and azimuthal angles, the values are the minimum and maximum of each, in radians. For example, if the distribution was initialized with `polar_angle='theta', polar_bounds=(0,0.5)` then the bounds will have `'theta': 0, 1.5707963267948966` as an entry.)r$)rr!r!r"rf=szUniformSolidAngle.boundscCs|jS)z!str: The name of the polar angle.)rd)rr!r!r"rkFszUniformSolidAngle.polar_anglecCs|jS)z%str: The name of the azimuthal angle.)re)rr!r!r"rlKsz!UniformSolidAngle.azimuthal_anglecCs4||jkr|j||S||jkr0|j||SdS)z0 Return the cdfinv for a single given parameter N)rkrarNrlrc)rrZrJr!r!r"rNPs  zUniformSolidAngle._cdfinv_paramcKsd||j}||j}|jj|}|jj|}|j|j|}|j|j|}|j||j|iS)alMaps the given values to be within the domain of the azimuthal and polar angles, before applying any other boundary conditions. Parameters ---------- \**kwargs : The keyword args must include values for both the azimuthal and polar angle, using the names they were initilialized with. For example, if `polar_angle='theta'` and `azimuthal_angle=`phi`, then the keyword args must be `theta={val1}, phi={val2}`. Returns ------- dict A dictionary of the parameter names and the conditioned values. )rdrerarr%rcr$)rr+ZpolarvalZazvalr!r!r"r*Ws  z+UniformSolidAngle.apply_boundary_conditionscKs|jjf||jjf|S)a Returns the pdf at the given angles. Parameters ---------- \**kwargs: The keyword arguments should specify the value for each angle, using the names of the polar and azimuthal angles as the keywords. Unrecognized arguments are ignored. Returns ------- float The value of the pdf at the given values. )rarSrc)rr+r!r!r"rSss zUniformSolidAngle._pdfcKs|jjf||jjf|S)a Returns the logpdf at the given angles. Parameters ---------- \**kwargs: The keyword arguments should specify the value for each angle, using the names of the polar and azimuthal angles as the keywords. Unrecognized arguments are ignored. Returns ------- float The value of the pdf at the given values. )rarUrc)rr+r!r!r"rUs zUniformSolidAngle._logpdfc Cs|}|t}y||d|}Wntk r:|j}YnXy||d|}Wntk rh|j}YnX||krtd|d|f||krtd|dd|t||||}t||||}| |d|} |||||| dS) aEReturns a distribution based on a configuration file. The section must have the names of the polar and azimuthal angles in the tag part of the section header. For example: .. code-block:: ini [prior-theta+phi] name = uniform_solidangle If nothing else is provided, the default names and bounds of the polar and azimuthal angles will be used. To specify a different name for each angle, set the `polar-angle` and `azimuthal-angle` attributes. For example: .. code-block:: ini [prior-foo+bar] name = uniform_solidangle polar-angle = foo azimuthal-angle = bar Note that the names of the variable args in the tag part of the section name must match the names of the polar and azimuthal angles. Bounds may also be specified for each angle, as factors of pi. For example: .. code-block:: ini [prior-theta+phi] polar-angle = theta azimuthal-angle = phi min-theta = 0 max-theta = 0.5 This will return a distribution that is uniform in the upper hemisphere. By default, the domain of the azimuthal angle is `[0, 2pi)`. To make this domain cyclic, add `azimuthal_cyclic_domain =`. Parameters ---------- cp : ConfigParser instance The config file. section : str The name of the section. variable_args : str The names of the parameters for this distribution, separated by ``VARARGS_DELIM``. These must appear in the "tag" part of the section header. Returns ------- UniformSolidAngle A distribution instance from the pycbc.inference.prior module. z polar-anglezazimuthal-anglez3polar-angle %s is not one of the variable args (%s)z, z3azimuthal-angle %s is not one of the variable args z(%s)ro)rkrlrmrnro) splitrZ get_opt_tagrr^r_joinrZget_param_bounds_from_configr-) r.r/r0r1tagrkrlrmrnror!r!r"r2s8<   zUniformSolidAngle.from_config)NNNNF)r3r4r5r6r7r=r`rrbr^r_rr:rfrkrlrNr*rSrUr;r2r!r!r!r"r[ s"   r[)r6 configparserrr8ZpycbcrrZpycbc.distributionsrrZUniformrr=rXZ BoundedDistr[__all__r!r!r!r"s      Hs