B d,@sdZddlZddlZddlmZddlmZmZyddlmZ Wne k rXdZ YnXdZ dd l m Z mZd ZejZejZd gZdd d Zdd dZdddZdddZdddZddZddZdS)aWrappings of the LALFrame input methods for reading GWF files This module provides the read_timeseries function, the primary method by which users can load TimeSeries data from a variety of sources, including: - a Gravitational-Wave Frame file (.gwf file extension) - a LAL-format cache file (.lcf or .cache file extension) - a LAL-format cache object (either XLALCache() or glue.lal.Cache [1] [1] https://www.lsc-group.phys.uwm.edu/daswg/projects/glue/doc/glue.lal.Cache-class.html N) string_types)utilslal)rFT)lalframe git_versionz(Duncan Macleod read_timeseriescCst|tr|g}nt|}t|trBtd|rBttj |}t r\t|t j r\t |}t|tr|drt||||||d}n.t|tj rt||||||d}n td|t|tr|dS|SdS)ac Read a TimeSeries of channel data from a source. Acceptable sources are: - a .gwf-format framefile (string ending in '.gwf') - a LAL-format cache file (string ending in '.lcf' or '.cache') - a lal.Cache object (either from SWIG-LAL or GLUE) @param source input source, see above for details @param channel string name of channel, e.g. 'L1:LDAS-STRAIN', or a list of channel names @param start LIGOTimeGPS start time for output TimeSeries @param duration float duration (seconds) for output TimeSeries @param datatype datatype, either an integer from the LALTYPECODE, a string matchine the corresponding type, or a numpy dtype @param verbose print verbose output, default: False @returns a TimeSeries of the imported data Example 1, reading from a frame file: \code >>> out = read_timeseries('L-R-1061499968-32.gwf', 'L1:PSL-ISS_PDB_OUT_DQ') >>> print(type(out)) >>> print(out.name, float(out.epoch), out.deltaT) ('L1:PSL-ISS_PDB_OUT_DQ', 1061499968.0, 3.0517578125e-05) \endcode Example 2, reading from a cache: \code >>> import lal >>> cache = lal.CacheGlob('/scratch/ER4/L0/L1/L-R-10614', 'L-R-1061499968*') >>> out = frread.read_timeseries(cache, 'L1:PSL-ISS_PDB_OUT_DQ') >>> print(out.name, float(out.epoch), out.deltaT) ('L1:PSL-ISS_PDB_OUT_DQ', 1061499968.0, 3.0517578125e-05) \endcode Example 3, restricting data input: \code >>> out = read_timeseries('L-R-1061499968-32.gwf', 'L1:PSL-ISS_PDB_OUT_DQ', start=1061499970, duration=10) >>> print(out.name, float(out.epoch), out.data.length) ('L1:PSL-ISS_PDB_OUT_DQ', 1061499970.0, 327680) \endcode Example 4, specifying data type: \code >>> out = read_timeseries('L-R-1061499968-32.gwf', 'L1:PSL-ODC_CHANNEL_OUT_DQ') >>> print(type(out), out.data.data[:4]) (, array([ 4259839., 4259839., 4259839., 4259839.], dtype=float32)) >>> out = read_timeseries('L-R-1061499968-32.gwf', 'L1:PSL-ODC_CHANNEL_OUT_DQ', datatype='int8') >>> print(type(out), out.data.data[:4]) (, array([4259839, 4259839, 4259839, 4259839])) \endcode z(.lcf|.cache)\Zz.gwf)startdurationdatatypeverbosezCannot interpret source '%s'.rN) isinstancerlistresearchrZ CacheImportospath expanduser _HAS_GLUEgcacheCachelalutilsZlalcache_from_gluecacheendswith_ts_from_frame_file_ts_from_cache ValueError)sourcechannelr r r r channelsoutr \/work/yifan.wang/ringdown/master-ringdown-env/lib/python3.7/site-packages/lalframe/frread.pyr4s(G         cCst|}t||||||dS)a*Read a TimeSeries of channel data from a LAL Cache object @param cache XLALCache() containing list of GWF file paths @param channels list of channel names @param start LIGOTimeGPS start time for output TimeSeries @param duration float duration (seconds) for output TimeSeries @param datatype datatype, either an integer from the LALTYPECODE, a string matchine the corresponding type, or a numpy dtype @param verbose UNDOCUMENTED @returns a TimeSeries of the imported data )r r r r )rZ FrCacheOpen_ts_from_stream)cacherr r r r streamr r r!rs  rcCs,tj|}td|}t||||||dS)aIRead a TimeSeries of channel data from a GWF-format framefile @param framefile path to GWF-format framefile to read @param channels list of channel names @param start LIGOTimeGPS start time for output TimeSeries @param duration float duration (seconds) for output TimeSeries @param datatype datatype, either an integer from the LALTYPECODE, a string matchine the corresponding type, or a numpy dtype @param verbose print verbose output, default: False @returns a TimeSeries of the imported data )r r r r )rrabspathrZ FrStreamOpenr")Z framefilerr r r r r$r r r!rs   rc Cst|rtjptj|t|j}|dkr0|}|sPt||}tt||}g}x0|D](} | t || |||dt ||qZW|S)aERead a TimeSeries of channel data from an open FrStream @param stream XLALFrStream() of data from which to read @param channels list of channel names @param start LIGOTimeGPS start time for output TimeSeries @param duration float duration (seconds) for output TimeSeries @param datatype datatype, either an integer from the LALTYPECODE, a string matchine the corresponding type, or a numpy dtype @param verbose print verbose output, default: False @returns a TimeSeries of the imported data N)r ) rZ FrSetModeZFR_STREAM_VERBOSE_MODEZFR_STREAM_DEFAULT_MODEr LIGOTimeGPSepochfloatget_stream_durationappendread_channel_from_stream FrStreamSeek) r$rr r r r r(Z startoffsetrrr r r!r"s     r"c Cst||}|dkr|}n t|}ttdt|}|||||d}||krT|S||krtddt|}||||j|j|j |j j } |j j t || j _ | SdS)z@Read the TimeSeries of a single channel from an open stream NzFrStreamRead%sTimeSeriesrcreatez %stimeseries)rZFrStreamGetTimeSeriesTyperZ get_lal_typegetattrZget_lal_type_strZ func_factoryZf0ZdeltaTZ sampleUnitsdatalengthZastypeZget_numpy_type) r$rr r r Z frdatatypereadoriginr.Zseriesr r r!r,s"  r,cCszt|jj|jj}|jj}d}xHt|D]<}x6tt |j D]"}|t |j |d7}t |q@Wq*Wt |||S)zFind the number of samples represented in a frame stream @param stream XLALFrStream() of data to measure @param channel string name of channel to measure @returns the integer length of the data for this channel r)rr'r( gpsSecondsgpsNanoSecondsr#r1rangerFrFileQueryNFramefileZFrFileQueryChanVectorLength FrStreamNextr-)r$rr(nfiler1ijr r r!get_stream_lengths     r=cCsxt|jj|jj}|jj}d}xFt|D]:}x4tt |j D] }|t |j d7}t |q@Wq*Wt |||S)zFind the duration of time stored in a frame stream @param stream XLALFrStream() of data to measure @returns the float duration (seconds) of the data for this channel r)rr'r(r4r5r#r1r6rr7r8Z FrFileQueryDtr9r-)r$r(r:r r;r<r r r!r*.s   r*)NNNF)NNNF)NNNF)NNNF)N)__doc__rrsixrrrrZgluer ImportErrorrr%rr __author__id __version__date__date____all__rrrr"r,r=r*r r r r!s2   h   &