B d_I@sjdZddlmZmZddlZddlmZddlm Z GdddedZ Gd d d e Z Gd d d e Z dS) z2 Classes and functions for adjusting strain data. )ABCMetaabstractmethodN)UnivariateSpline)FrequencySeriesc@s>eZdZdZdZddZeddZd dd Ze d d Z dS) Recalibratez& Base class for modifying calibration NcCs||_t|_dS)N)ifo_namedictparams)selfrr e/work/yifan.wang/ringdown/master-ringdown-env/lib/python3.7/site-packages/pycbc/strain/recalibrate.py__init__szRecalibrate.__init__cCsdS)a:Apply calibration model This method should be overwritten by subclasses Parameters ---------- strain : FrequencySeries The strain to be recalibrated. Return ------ strain_adjusted : FrequencySeries The recalibrated strain. Nr )r strainr r r apply_calibration#szRecalibrate.apply_calibrationrecalib_c s,jfddD|}|S)a[Map an input dictionary of sampling parameters to the adjust_strain function by filtering the dictionary for the calibration parameters, then calling adjust_strain. Parameters ---------- strain : FrequencySeries The strain to be recalibrated. prefix: str Prefix for calibration parameter names params : dict Dictionary of sampling parameters which includes calibration parameters. Return ------ strain_adjusted : FrequencySeries The recalibrated strain. cs4i|],}|krj|kr||tdqS)N)rlen).0key)r prefixr r r Isz-Recalibrate.map_to_adjust..)r updater)r rrr strain_adjustedr )r rr r map_to_adjust5s  zRecalibrate.map_to_adjustcsTt||fddDfddDdd<|fS)a7Read a config file to get calibration options and transfer functions which will be used to intialize the model. Parameters ---------- cp : WorkflowConfigParser An open config file. ifo : string The detector (H1, L1) for which the calibration model will be loaded. section : string The section name in the config file from which to retrieve the calibration options. Return ------ instance An instance of the class. cs2i|]*}|kr||tddqS)N)lowerr)rr) all_paramsifor r rfsz+Recalibrate.from_config..csi|]}||qSr r )rr)r r r rhsmodelr)ritemspopr)clscprsectionr )rrr r from_configQs   zRecalibrate.from_config)r) __name__ __module__ __qualname____doc__namer rrr classmethodr#r r r r rs   r) metaclassc@s$eZdZdZdZddZddZdS) CubicSplineaCubic spline recalibration see https://dcc.ligo.org/LIGO-T1400682/public This assumes the spline points follow np.logspace(np.log(minimum_frequency), np.log(maximum_frequency), n_points) Parameters ---------- minimum_frequency: float minimum frequency of spline points maximum_frequency: float maximum frequency of spline points n_points: int number of spline points Z cubic_splinecCs\tj||dt|}t|}t|}|dkr6td||_tt|t|||_ dS)N)rz2Use at least 4 spline points for calibration model) rr floatint ValueErrorn_pointsnpZlogspacelog10 spline_points)r Zminimum_frequencyZmaximum_frequencyr0rr r r r s zCubicSpline.__init__c sfddtjD}tj|}||j}fddtjD}tj|}||j}|d|dd|dd|}|S)a?Apply calibration model This applies cubic spline calibration to the strain. Parameters ---------- strain : FrequencySeries The strain to be recalibrated. Return ------ strain_adjusted : FrequencySeries The recalibrated strain. cs g|]}jdj|qS)zamplitude_{}_{})r formatr)rii)r r r sz1CubicSpline.apply_calibration..cs g|]}jdj|qS)z phase_{}_{})r r4r)rr5)r r r r6sg?g@y?)ranger0rr3sample_frequenciesnumpy) r rZamplitude_parametersZamplitude_splineZdelta_amplitudeZphase_parametersZ phase_splineZ delta_phaserr )r r rs   $zCubicSpline.apply_calibrationN)r$r%r&r'r(r rr r r r r+os r+c@sheZdZdZdZdddZdddZdd d Zdd d ZdddZ e dddZ e ddZ ddZ dS) PhysicalModela Class for adjusting time-varying calibration parameters of given strain data. Parameters ---------- strain : FrequencySeries The strain to be adjusted. freq : array The frequencies corresponding to the values of c0, d0, a0 in Hertz. fc0 : float Coupled-cavity (CC) pole at time t0, when c0=c(t0) and a0=a(t0) are measured. c0 : array Initial sensing function at t0 for the frequencies. d0 : array Digital filter for the frequencies. a_tst0 : array Initial actuation function for the test mass at t0 for the frequencies. a_pu0 : array Initial actuation function for the penultimate mass at t0 for the frequencies. fs0 : float Initial spring frequency at t0 for the signal recycling cavity. qinv0 : float Initial inverse quality factor at t0 for the signal recycling cavity. Zphysical_modelNc Cst||_||_||_||_||_t||_t||_ t||_ |jd|jdd|j|j |j |j d} |j|j|j|j|_ d|j |j|_ |jdd|j|j| |_ dS)Ny?g?r)r1realfreqc0d0a_tst0a_pu0r-fc0fs0qinv0Zg0r0c_res) r r=rBr>r?r@rArCrDZ init_detuningr r r r s    ,zPhysicalModel.__init__?cCsN|jd|jdd|j|||d}|j|dd|j||S)aM Calculate the sensing function c(f,t) given the new parameters kappa_c(t), kappa_a(t), f_c(t), fs, and qinv. Parameters ---------- fc : float Coupled-cavity (CC) pole at time t. kappa_c : float Scalar correction factor for sensing function at time t. fs : float Spring frequency for signal recycling cavity. qinv : float Inverse quality factor for signal recycling cavity. Returns ------- c : numpy.array The new sensing function c(f,t). r;y?r)r=rF)r fsqinvfckappa_cZ detuning_termr r r update_cs&zPhysicalModel.update_cc CsH|j||||d} |j|d|} |j|d|} | |j| | S)aa Calculate the open loop gain g(f,t) given the new parameters kappa_c(t), kappa_a(t), f_c(t), fs, and qinv. Parameters ---------- fc : float Coupled-cavity (CC) pole at time t. kappa_c : float Scalar correction factor for sensing function c at time t. kappa_tst_re : float Real part of scalar correction factor for actuation function a_tst0 at time t. kappa_pu_re : float Real part of scalar correction factor for actuation function a_pu0 at time t. kappa_tst_im : float Imaginary part of scalar correction factor for actuation function a_tst0 at time t. kappa_pu_im : float Imaginary part of scalar correction factor for actuation function a_pu0 at time t. fs : float Spring frequency for signal recycling cavity. qinv : float Inverse quality factor for signal recycling cavity. Returns ------- g : numpy.array The new open loop gain g(f,t). )rHrIrJrKy?)rLr@rAr?) r rHrIrJ kappa_tst_re kappa_tst_im kappa_pu_re kappa_pu_imrKcZa_tstZa_pur r r update_gs"zPhysicalModel.update_gc Cs8|j||||d} |j||||||||d} d| | S)ag Calculate the response function R(f,t) given the new parameters kappa_c(t), kappa_a(t), f_c(t), fs, and qinv. Parameters ---------- fc : float Coupled-cavity (CC) pole at time t. kappa_c : float Scalar correction factor for sensing function c at time t. kappa_tst_re : float Real part of scalar correction factor for actuation function a_tst0 at time t. kappa_pu_re : float Real part of scalar correction factor for actuation function a_pu0 at time t. kappa_tst_im : float Imaginary part of scalar correction factor for actuation function a_tst0 at time t. kappa_pu_im : float Imaginary part of scalar correction factor for actuation function a_pu0 at time t. fs : float Spring frequency for signal recycling cavity. qinv : float Inverse quality factor for signal recycling cavity. Returns ------- r : numpy.array The new response function r(f,t). )rHrIrJrK)rHrIrJrKrNrOrPrQg?)rLrS) r rHrIrJrKrNrOrPrQrRgr r r update_r(s "  zPhysicalModel.update_rc  Cs|r|j|n|j} |r"|j|n|j} |r6|j|n|j} |j| | | ||||| d} | |j}t|}tt|}d}t |j ||dd}t |j ||dd}|j }||t d||}t| ||jd}|S)aAdjust the FrequencySeries strain by changing the time-dependent calibration parameters kappa_c(t), kappa_a(t), f_c(t), fs, and qinv. Parameters ---------- strain : FrequencySeries The strain data to be adjusted. delta_fc : float Change in coupled-cavity (CC) pole at time t. kappa_c : float Scalar correction factor for sensing function c0 at time t. kappa_tst_re : float Real part of scalar correction factor for actuation function A_{tst0} at time t. kappa_tst_im : float Imaginary part of scalar correction factor for actuation function A_tst0 at time t. kappa_pu_re : float Real part of scalar correction factor for actuation function A_{pu0} at time t. kappa_pu_im : float Imaginary part of scalar correction factor for actuation function A_{pu0} at time t. fs : float Spring frequency for signal recycling cavity. qinv : float Inverse quality factor for signal recycling cavity. Returns ------- strain_adjusted : FrequencySeries The adjusted strain. )rHrIrJrKrNrOrPrQrr)ksy?)delta_f)rBrCrDrUrEr1absunwrapZanglerr=r8r9exprrX)r rdelta_fs delta_qinvdelta_fcrKrNrOrPrQrJrHrIZ r_adjustedrVZk_ampZk_phaseorderZ k_amp_offZ k_phase_offZ freq_evenZ k_even_samplerr r r adjust_strainQs*$     zPhysicalModel.adjust_strain cCsTtj||d}|dddf}|dddfd|dddf}t||gS)a,Convert the contents of a file with the columns [freq, real(h), imag(h)] to a numpy.array with columns [freq, real(h)+j*imag(h)]. Parameters ---------- path : string delimiter : {" ", string} Return ------ numpy.array ) delimiterNrry?r;)r1ZloadtxtarrayZ transpose)r pathrbdatar=hr r r tf_from_files$zPhysicalModel.tf_from_filec sPg}ddddg}x8fdd|DD]"}|||d}|||q$W|dddd f}|d ddd f} |d ddd f} |d ddd f} |ddddf} d d g} ||| r||| d}| ||ddd f7} ||d dgd}||d dgd}||d dgd}|| || | || ||dS)aDRead a config file to get calibration options and transfer functions which will be used to intialize the model. Parameters ---------- cp : WorkflowConfigParser An open config file. ifo : string The detector (H1, L1) for which the calibration model will be loaded. section : string The section name in the config file from which to retrieve the calibration options. Return ------ instance An instance of the Recalibrate class. za-tstza-purRdcsg|]}dd|gqS)-ztransfer-function)join)rr()rr r r6sz-PhysicalModel.from_config..Nrrr;riztransfer-function-a-uimrBrCrD)r=rBr>r?r@rArCrD)Z get_opt_tagappendrgrj has_option)r r!rr"ZtfsZtf_namestagZtf_pathr@rAr>r?r=Zuim_tagrBrCrDr )rr r#s(     zPhysicalModel.from_configc Ksddddddddg}d d |D}d d d d d d d d g}g}x8t||D]*\}}||krf|||qF||qFW|j||d |d|d|d|d|d|d|dd } | S)aMap an input dictionary of sampling parameters to the adjust_strain function by filtering the dictionary for the calibration parameters, then calling adjust_strain. Parameters ---------- strain : FrequencySeries The strain to be recalibrated. params : dict Dictionary of sampling parameters which includes calibration parameters. Return ------ strain_adjusted : FrequencySeries The recalibrated strain. r\r^r]rKrNrOrPrQcSsg|]}dd|gqS)Zcalib_)rj)rr(r r r r6sz/PhysicalModel.map_to_adjust..gg?rrr;rkr,)r\r^r]rKrNrOrPrQ)ziprlr`) r rr arg_namesZ arg_labelsdefault_valuesZ calib_argsargvalrr r r rs$   zPhysicalModel.map_to_adjust)NNNNNNNN)NNNrG)NNNrGrMrGrMrG)NNNrGrGrMrGrM)NNNrGrGrMrGrM)ra)r$r%r&r'r(r rLrSrUr`r)rgr#rr r r r r:s$   % ' A  1r:)r'abcrrr9r1Zscipy.interpolaterZ pycbc.typesrrr+objectr:r r r r s  TC