B }dJ @sdZddlZddlZddlmZmZddlmZmZddl m Z ddl m Z d Z d Zd d Zd=ddZd>ddZd?ddZd@ddZddZddZdAddZdBd d!Zd"d#Zd$d%Zd&d'Zd(d)Zd*d+Zd,d-Zd.d/ZdCd1d2ZdDd3d4Z d5d6Z!d7d8Z"d9d:Z#d;d<Z$dS)Ez@I/O utilities for GWF files using the lalframe or frameCPP APIs N)Segment SegmentList)to_gps LIGOTimeGPS) read_cache) file_pathz(Duncan Macleod sIGWDc Os|dk r>|}|dz|dtkr.dSWd||X|dk r|drTdS|dry t|}Wntk r~dSX|djdrdSdS)zIdentify a filename or file object as GWF This function is overloaded in that it will also identify a cache file as 'gwf' if the first entry in the cache contains a GWF file extension NrTz.gwf)z.lcfz.cacheF)tellseekread GWF_SIGNATUREendswithrIOErrorpath)originfilepathfileobjargskwargsloccacherX/work/yifan.wang/ringdown/master-ringdown-env/lib/python3.7/site-packages/gwpy/io/gwf.py identify_gwf's"      rrcCsH|dkrtdddlm}t|}|dkr:|t|S|t|S)aOpen a filename for reading or writing GWF format data Parameters ---------- filename : `str` the path to read from, or write to mode : `str`, optional either ``'r'`` (read) or ``'w'`` (write) Returns ------- `LDAStools.frameCPP.IFrameFStream` the input frame stream (if `mode='r'`), or `LDAStools.frameCPP.IFrameFStream` the output frame stream (if `mode='w'`) )rwzmode must be either 'r' or 'w'r)frameCPPr) ValueError LDAStoolsrr IFrameFStreamstrZ OFrameFStream)filenamemoderrrropen_gwfEs r%GZIPc Csddlm}ddlm}m}t|ts.||}|dkr@||j}t|d}t||j r\|g}x"|D]}| |t|t|qbWdS)aWrite a list of frame objects to a file **Requires:** |LDAStools.frameCPP|_ Parameters ---------- filename : `str` path to write into frames : `list` of `LDAStools.frameCPP.FrameH` list of frames to write into file compression : `int`, `str`, optional name of compresion algorithm to use, or its endian-appropriate ID, choose from - ``'RAW'`` - ``'GZIP'`` - ``'DIFF_GZIP'`` - ``'ZERO_SUPPRESS'`` - ``'ZERO_SUPPRESS_OTHERWISE_GZIP'`` compression_level : `int`, optional compression level for given method, default is ``6`` for GZIP-based methods, otherwise ``0`` r)rr) CompressionDefaultCompressionLevelNr) r r _framecppr'r( isinstanceintnamer%FrameHZ WriteFrame) r#frames compressionZcompression_levelrr'r(streamframerrr write_frames`s      r2gwpyc Csddlm}ddlm}|}t|}||j|j}| ||dk rX| t |x&|p`gD]} | | || |qbW|||||S)aCreate a new :class:`~LDAStools.frameCPP.FrameH` **Requires:** |LDAStools.frameCPP|_ Parameters ---------- time : `float`, optional frame start time in GPS seconds duration : `float`, optional frame length in seconds name : `str`, optional name of project or other experiment description run : `int`, optional run number (number < 0 reserved for simulated data); monotonic for experimental runs ifos : `list`, optional list of interferometer prefices (e.g. ``'L1'``) associated with this frame Returns ------- frame : :class:`~LDAStools.frameCPP.FrameH` the newly created frame header r)rr)DetectorLocationN)r rr)r5r-rZGPSTimeZ gpsSecondsZgpsNanoSecondsZSetGTimeZSetDtfloatZAppendFrDetectorZ GetDetectorZSetNameZSetRun) timedurationr,runZifosrr5r1Zgpsprefixrrr create_frames     r;c Cspddlm}|jdr"|jdkr*td|t||||d|j dj }| t t |jj t ||S)u7Create a `~frameCPP.FrAdcData` from a `~gwpy.types.Series` .. note:: Currently this method is restricted to 1-dimensional arrays. Parameters ---------- series : `~gwpy.types.Series` the input data array to store frame_epoch : `float`, `int`, optional the GPS start epoch of the `Frame` that will contain this data structure Returns ------- frdata : `~frameCPP.FrAdcData` the newly created data structure Notes ----- See Table 10 (§4.3.2.4) of LIGO-T970130 for more details r)rsrz>only 1-dimensional timeseries data can be written as FrAdcData)r rxunit is_equivalentndim TypeErrorZ FrAdcData _series_namedxtovalueZ SetTimeOffsetr6rx0)series frame_epochZ channelgroupZ channelidnbitsrZfrdatarrrcreate_fradcdatas rJcCs|jdrt|jSdS)Nr=r)r>r?absxspan)rGrrr_get_series_tranges  rMcCs:|jdrt|jS|jdkr6|jdr6t|jSdS)NHzrr)r>r?rKrLr@yunitZyspan)rGrrr_get_series_franges    rPc Csvddlm} |dkrt|}|dkr,t|}| t|t|p@|jt||t ||t t |j j t |||||| S)uCreate a `~frameCPP.FrAdcData` from a `~gwpy.types.Series` .. note:: Currently this method is restricted to 1-dimensional arrays. Parameters ---------- series : `~gwpy.types.Series` the input data array to store frame_epoch : `float`, `int`, optional the GPS start epoch of the `Frame` that will contain this data structure comment : `str`, optional comment type : `int`, `str`, optional type of data object subtype : `int`, `str`, optional subtype for f-Series trange : `float`, optional duration of sampled data fshift : `float`, optional frequency in the original data that corresponds to 0 Hz in the heterodyned series phase : `float`, optional phase of the heterodyning signal at start of dataset frange : `float`, optional frequency range bandwidth : `float, optional reoslution bandwidth Returns ------- frdata : `~frameCPP.FrAdcData` the newly created data structure Notes ----- See Table 17 (§4.3.2.11) of LIGO-T970130 for more details r)rN)r rrMrPZ FrProcDatarBr"r,_get_frprocdata_type_get_frprocdata_subtyper6rrFrE) rGrHcommenttypesubtypeZtrangefshiftphaseZfrange bandwidthrrrrcreate_frprocdatas 4  rYc Csdddlm}|jds td|t|t|p4|jd|j dj t t |jj t |||S)uCreate a `~frameCPP.FrAdcData` from a `~gwpy.types.Series` .. note:: Currently this method is restricted to 1-dimensional arrays. Parameters ---------- series : `~gwpy.types.Series` the input data array to store frame_epoch : `float`, `int`, optional the GPS start epoch of the `Frame` that will contain this data structure fshift : `float`, optional frequency in the original data that corresponds to 0 Hz in the heterodyned series phase : `float`, optional phase of the heterodyning signal at start of dataset Returns ------- frdata : `~frameCPP.FrSimData` the newly created data structure Notes ----- See Table 20 (§4.3.2.14) of LIGO-T970130 for more details r)rr=z0only timeseries data can be written as FrSimDatar)r rr>r?rAZ FrSimDatarBr"r,rCrDrEr6rrF)rGrHrSrVrWrrrrcreate_frsimdataLs   rZcCsddlm}ddlm}||jd|jjt|jj d}| t |t | |j|j|t|j }tj|jdgd|dd<|S)aVCreate a `~frameCPP.FrVect` from a `~gwpy.types.Series` .. note:: Currently this method is restricted to 1-dimensional arrays. Parameters ---------- series : `~gwpy.types.Series` the input data array to store Returns ------- frvect : `~frameCPP.FrVect` the newly created data vector r)rr) FrVectTypeC) requirementsN)r rr)r[Z DimensionshaperCrEr"unitZFrVectrBr+findZdtyper@numpyrequireZ GetDataArray)rGrr[ZdimsZvectrrr create_frvect|s    rccCs tt|S)a?Find the total number of channels in this framefile **Requires:** |LDAStools.frameCPP|_ Parameters ---------- framefile : `str` path to GWF-format file on disk Returns ------- n : `int` the total number of channels found in the table of contents for this file )lenget_channel_names) framefilerrr num_channelssrgcCsBt|}x t|D]\}}||kr|SqWtd|d|dS)aFind the channel type in a given GWF file **Requires:** |LDAStools.frameCPP|_ Parameters ---------- channel : `str`, `~gwpy.detector.Channel` name of data channel to find framefile : `str` path of GWF file in which to search Returns ------- ctype : `str` the type of the channel ('adc', 'sim', or 'proc') Raises ------ ValueError if the channel is not found in the table-of-contents 'z%' not found in table-of-contents for N)r"_iter_channelsr)channelrfr,type_rrrget_channel_types rlcCs*t|}xt|D]}||krdSqWdS)aDetermine whether a channel is stored in this framefile **Requires:** |LDAStools.frameCPP|_ Parameters ---------- channel : `str` name of channel to find framefile : `str` path of GWF file to test Returns ------- inframe : `bool` whether this channel is included in the table of contents for the given framefile TF)r"iter_channel_names)rjrfr,rrrchannel_in_frames rnccs xt|D]\}}|Vq WdS)amIterate over the names of channels found in a GWF file **Requires:** |LDAStools.frameCPP|_ Parameters ---------- framefile : `str` path of GWF file to read Returns ------- channels : `generator` an iterator that will loop over the names of channels as read from the table of contents of the given GWF file N)ri)rfr,_rrrrmsrmcCs tt|S)aReturn a list of all channel names found in a GWF file This method just returns >>> list(iter_channel_names(framefile)) **Requires:** |LDAStools.frameCPP|_ Parameters ---------- framefile : `str` path of GWF file to read Returns ------- channels : `list` of `str` a `list` of channel names as read from the table of contents of the given GWF file )listrm)rfrrrre sreccsjddlm}t||js"t|d}|}x:dD]2}|}x$t|d|D]}||fVqPWq0WdS)zYields the name and type of each channel in a GWF file TOC **Requires:** |LDAStools.frameCPP|_ Parameters ---------- framefile : `str`, `LDAStools.frameCPP.IFrameFStream` path of GWF file, or open file stream, to read r)rr)ZSimZProcZADCZGetN)r rr*r!r%GetTOClowergetattr)rfrtoctypenameZtypenr,rrrri!s    riTcCs0t}x |D]}|t|||dq W|S)aReturns the segments containing data for a channel **Requires:** |LDAStools.frameCPP|_ A frame is considered to contain data if a valid FrData structure (of any type) exists for the channel in that frame. No checks are directly made against the underlying FrVect structures. Parameters ---------- paths : `list` of `str` a list of GWF file paths channel : `str` the name to check in each frame warn : `bool`, optional emit a `UserWarning` when a channel is not found in a frame Returns ------- segments : `~gwpy.segments.SegmentList` the list of segments containing data )warn)rextend_gwf_channel_segmentsZcoalesce)pathsrjrvsegmentsrrrr data_segments5s r{c #st|}|}|}|}fdddD}xtt|||D]\}\} } } xx|D]P} y| ||Wnttfk rw`YnX| g}t | | } t | | | VPq`W|rLt d|d|d|qLWdS)zIYields the segments containing data for ``channel`` in this GWF path cs"g|]}td|dqS)ZReadFrData)rstitle).0rk)r0rr ^sz)_gwf_channel_segments..)procsimZadcrhz' not found in frame z of N) r%rqZ GetGTimeSZ GetGTimeNZGetDt enumeratezip IndexErrorrrrwarningsrv)rrjrvrtZsecsZnanoZdurZreadersir=nsdtr epochr)r0rrxTs(    rxcCst|tr|S|t|S)z}Handle a type string, or just return an `int` Only to be called in relation to FrProcDataType and FrProcDataSubType )r*r+r"upper)rkenumrrr _get_typess rcCsddlm}|dk rt||S|jdkr<|jdr<|j}nr|jdkrZ|jdrZ|j}nT|jdkrl|j}nB|jdkr|jdr|j dr|j }n|jdkr|j }n|j }|S)uDetermine the appropriate `FrProcDataType` for this series Notes ----- See Table 17 (§4.3.2.11) of LIGO-T970130 for more details r)FrProcDataTypeNr=rNr) r)rrr@r>r?Z TIME_SERIESZFREQUENCY_SERIESZOTHER_1D_SERIES_DATArOZTIME_FREQUENCYZMULTI_DIMENSIONALUNKNOWN)rGrkrrrrrQ}s"       rQcCs4ddlm}|dk rt||S|jdkr.|jS|jS)uDetermine the appropriate `FrProcDataSubType` for this series Notes ----- See Table 17 (§4.3.2.11) of LIGO-T970130 for more details r)FrProcDataSubTypeNZ coherence)r)rrr_Z COHERENCEr)rGrUrrrrrRs    rRcCs|jpt|jpdpdS)aNReturns the 'name' of a `Series` that should be written to GWF This is basically `series.name or str(series.channel) or ""` Parameters ---------- series : `gwpy.types.Series` the input series that will be written Returns ------- name : `str` the name to use when storing this series N)r,r"rj)rGrrrrBsrB)r)r&N)rNr3r4N)rrrr<) rNNNNrrNr)rNrr)T)T)%__doc__rrarzrrr7rrrrutilsr __author__rrr%r2r;rJrMrPrYrZrcrgrlrnrmrerir{rxrrQrRrBrrrrsB    / 7 - H 0-