B
d0 @ s6 d Z ddlZddlZddlZddlmZ ddlmZ ddlmZm Z
ddl m Z ddl
mZmZ ddlmZmZmZ dd lmZ dd
lmZ dd lmZ ddl m Z d Z e Z!ee! Z"ee" Z#e$d
dgZ%dd Z&d$ddZ'd%ddZ(d&ddZ)dd Z*dd Z+d'd d Z,d d Z-d d! Z.e*ej/G d"d# d#e
Z dS )(z(Tools for dealing with LIGOLW XML files. N) lsctables)ligolw)ParamLIGOLWContentHandler) TableByName)Column TableStream)
FormatFunc
FromPyTypeToPyType)process)r )Array)default_null_valuereturn_empty_snglreturn_search_summarylegacy_row_id_converterget_table_columnsr z ilwd:charz ilwd:char_uc C s8 |dkr dS |dkrdS |dkr$dS t d| |dS ) zR
Associate a sensible "null" default value to a given LIGOLW column type.
)Zreal_4Zreal_8g )Zint_4sZint_8sr Zlstring z2Do not know how to initialize column {} of type {}N)NotImplementedErrorformat)col_nameZcol_type r \/work/yifan.wang/ringdown/master-ringdown-env/lib/python3.7/site-packages/pycbc/io/ligolw.pyr 1 s r Fc C sN t }t jj}x8|D ]0}t|}| r,dn t||| }t||| qW |S )a
Function to create a SnglInspiral object where all columns are populated
but all are set to values that test False (ie. strings to '', floats/ints
to 0, ...). This avoids errors when you try to create a table containing
columns you don't care about, but which still need populating. NOTE: This
will also produce a process_id and event_id with 0 values. For most
applications these should be set to their correct values.
Parameters
----------
nones : bool (False)
If True, just set all columns to None.
Returns
--------
lsctables.SnglInspiral
The "empty" SnglInspiral object.
N)r Z SnglInspiralZSnglInspiralTable validcolumnsr
ColumnNamer setattr)ZnonesZsnglcolsentryr valuer r r r ? s
r c C s |dkr g }t }t jj}x0|D ](}t|}t||| }t||| q"W |rX||_|rb||_ | r|rt
| |_ t
| d d |_ t
||_
t
|d d |_t
| |_t
| d d |_t
||_t
|d d |_|S )aM
Function to create a SearchSummary object where all columns are populated
but all are set to values that test False (ie. strings to '', floats/ints
to 0, ...). This avoids errors when you try to create a table containing
columns you don't care about, but which still need populating. NOTE: This
will also produce a process_id with 0 values. For most applications these
should be set to their correct values.
It then populates columns if given them as options.
Returns
--------
lsctables.SeachSummary
The "empty" SearchSummary object.
N g eA)r Z
SearchSummaryZSearchSummaryTabler r r r r instrumentsneventsintZ
in_start_timeZin_start_time_nsZ in_end_timeZin_end_time_nsZout_start_timeZout_start_time_nsZ out_end_timeZout_end_time_ns)
start_timeend_timer! ZifosZsearch_summaryr r r r r r r r [ s,
r c
C s |dkrt jtjd }|dkr&i }tjp.d}| }g }x2| D ]&\}} t | t
t krF|
| qFW t|dkrx|D ]}|| qW tj| ||tjdtj |||d}
|
S )zfCreate a LIGOLW process table with sane defaults, add it to a LIGOLW
document, and return it.
Nr zpycbc/)versionZcvs_repositorycvs_entry_timer comment)ospathbasenamesysargv
pycbc_versiondatecopyitemstypetupler
keysappendlenpopligolw_processZregister_to_xmldocr% Z
git_branch) documentZ program_nameZ detectorsr' optionsr& optsZkey_delkeyr r r r r create_process_table s&
r< c sL | j fdd}i | jf fdd }| jf fdd }|| _ || _|| _| S )a^ Convert from old-style to new-style row IDs on the fly.
This is loosely adapted from :func:`ligo.lw.utils.ilwd.strip_ilwdchar`.
Notes
-----
When building a ContentHandler, this must be the _outermost_ decorator,
outside of :func:`ligo.lw.lsctables.use_in`, :func:`ligo.lw.param.use_in`,
or :func:`ligo.lw.table.use_in`.
c S sj t | jtrZ| jjtkrZt| jj }t|| jj}t| dd }t
| j_t || j_|| || dS )z8Convert values of elements from ilwdchar to int.:N)
isinstancecurrentr TypeIDTypesr strpcdata ROWID_PYTYPEsplit
ROWID_TYPEROWID_FORMATFUNC)selfZ
uri_localnameZqnameZ__orig_endElementNSold_typeold_val new_valuer r r endElementNS s z-legacy_row_id_converter..endElementNSc s || ||}|j tkrDt|j fdd}|t||jf< t|_ |jtkrt|j j}|j|krdd |D }|j|kr|d||j |S )zConvert types in elements from ilwdchar to int.
Notes
-----
This method is adapted from
:func:`ligo.lw.utils.ilwd.strip_ilwdchar`.
c s t t | dd S )Nr= r> )rE rC rF ) old_value)rJ r r converter s z?legacy_row_id_converter..startColumn..converterc S s i | ]}|t |qS r )r r ).0namer r r
s z@legacy_row_id_converter..startColumn..Name) rA rB r idrS rG r r Z setAttribute)rI parentattrsZ__orig_startColumnresultrO r Z stripped_column_to_valid_column)remapped)rJ r startColumn s
z,legacy_row_id_converter..startColumnc sd || |}t |tr`tj jdk r8 tjM |j fddtjjD |S )zConvert values in table elements from ilwdchar to int.
Notes
-----
This method is adapted from
:meth:`ligo.lw.table.TableStream.config`.
Nc s0 g | ](\}}| kr( t|f|nd qS )N)r6 rT )rP ZpytypeZcolname) loadcolumnsrU rX r r
s z@legacy_row_id_converter..startStream..) r? r set columnnamesrZ Z
_tokenizerZ set_typeszipZ
columnpytypes)rI rU rV Z__orig_startStreamrW )rX )rZ rU r startStream s
z,legacy_row_id_converter..startStream)rM rY r_ )ZContentHandlerrM rY r_ r )rX r r s
#r c C s( t jjj}t |dt| jji}|d k r<||t _
|t j | j
d |tjd| jdd t| |}t| jjrttt| jj| | jjj| jjjf}n$ttt| jj| | jjf}tj| j ||d} t| j | _ | t j j!d }
||
_ | j|
_"||
_#|| |S )NrS epochf0zs^-1)unit) dim_namesr )$r sax xmlreaderAttributesImplLIGO_LWrC __class____name__ appendChildCommentrD TimeZfrom_gpsr` LIGOLWParam from_pyvaluera getattrnumpyZ iscomplexobjdataZ row_stackZaranger5 realimag LIGOLWArraybuildrQ sampleUnitsZUnitZgetElementsByTagNameZDimZtagNameZStartZScale) Zseriesrc r' Z
delta_nameZ
delta_unit
Attributeselemdeltarq aZdim0r r r
_build_series s0
r{ c C s |dkrt n|jd }d}t jjj}|t |d|i}x@| D ]4\}}t |dddd}||}|t
d| qJW |S ) znAdd a set of PSDs to a LIGOLW XML document. If the document is not
given, a new one is created first.
Nr psdrS )zFrequency,RealZ FrequencyZdeltaFzs^-1
instrument) r ZDocument
childNodesrd re rf rj rg r0 r{ rm rn ) ZpsddictZxmldocZ root_namerw Zlwr} r| Z xmlseriesfsr r r make_psd_xmldoc s
r c C sN | }d|_d|_t|dddd}|jd |}td|}|| dS ) z\Save an SNR time series into an XML document, in a format compatible
with BAYESTAR.
Zsnrr )rl zTime,Real,ImaginaryNZdeltaTsr> Zevent_id)ZlalrQ rv r{ r~ rj rm rn )Z
snr_seriesr8 Zsngl_inspiral_idZsnr_lalZsnr_xmlZsnr_nodeZ eid_paramr r r snr_series_to_xml4 s r c C s: g }x0| j D ]&}|dd }|| jkr || q W |S )ah Return a list of columns that are present in the given table, in a
format that can be passed to `lsctables.New()`.
The split on ":" is needed for columns like `process:process_id`, which
must be listed as `process:process_id` in `lsctables.New()`, but are
listed as just `process_id` in the `columnnames` attribute of the given
table.
r= r> )r rF r] r4 )tablecolumnscolZattr r r r F s
r c @ s e Zd ZdZdS )r z+Dummy class needed for loading LIGOLW filesN)ri
__module__ __qualname____doc__r r r r r W s r )F)r r r N)NNNN)N)0r r( r+ rp Zligo.lwr r Zligo.lw.ligolwr r ZOrigLIGOLWContentHandlerZligo.lw.lsctablesr Z
ligo.lw.tabler r Z
ligo.lw.typesr r
r Z
ligo.lw.utilsr r7 Z
ligo.lw.paramrm Z
ligo.lw.arrayr
rt Z
pycbc.versionr% r- __all__r" rE rG rH r\ rB r r r r< r r{ r r r Zuse_inr r r r s>
,
Z