searchindex.js

Search.setIndex({"docnames": ["index", "riroriro/detectabilityfuns", "riroriro/gwexporter", "riroriro/horizondistfuns", "riroriro/index", "riroriro/inspiralfuns", "riroriro/matchingfuns", "riroriro/mergerfirstfuns", "riroriro/mergersecondfuns", "riroriro/snrcalculatorfuns", "riroriro/tests"], "filenames": ["index.rst", "riroriro/detectabilityfuns.rst", "riroriro/gwexporter.rst", "riroriro/horizondistfuns.rst", "riroriro/index.rst", "riroriro/inspiralfuns.rst", "riroriro/matchingfuns.rst", "riroriro/mergerfirstfuns.rst", "riroriro/mergersecondfuns.rst", "riroriro/snrcalculatorfuns.rst", "riroriro/tests.rst"], "titles": ["Documentation", "detectabilityfuns", "gwexporter", "horizondistfuns", "riroriro Documentation", "inspiralfuns", "matchingfuns", "mergerfirstfuns", "mergersecondfuns", "snrcalculatorfuns", "tests"], "terms": {"thi": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9], "function": [0, 1, 2, 3, 5, 6, 7, 8, 9], "riroriro": [0, 10], "tutori": 0, "usag": 0, "can": [0, 1, 3, 5, 6, 7, 9, 10], "found": [0, 3, 9], "http": [0, 3, 9], "github": 0, "com": [0, 3, 9], "wvanzeist": 0, "riroriro_tutori": 0, "refer": 0, "api": 0, "inspiralfun": [0, 2, 6, 7, 8], "get_m_and_eta": [0, 6, 7], "startx": 0, "endx": 0, "pnderiv": 0, "pn_parameter_integr": 0, "inspiral_time_convers": [0, 2, 6], "inspiral_phase_freq_integr": [0, 2, 6, 8], "radius_calcul": 0, "a1_a2_calcul": 0, "inspiral_strain_polaris": [0, 8], "inspiral_strain_amplitud": [0, 2, 8], "list_size_reduc": 0, "mergerfirstfun": [0, 2, 6, 8], "quasi_normal_mod": 0, "girs_coeffici": [0, 8], "merger_freq_calcul": [0, 6, 8], "fhat_differenti": [0, 8], "merger_time_convers": [0, 6], "matchingfun": [0, 2, 8], "mqdiff": 0, "min_switch_ind_find": [0, 8], "final_i_index_find": [0, 8], "time_offset_find": 0, "time_frequency_stitch": [0, 2], "frequency_si_unit": [0, 2], "mergersecondfun": [0, 2, 7], "merger_phase_calcul": 0, "phase_stitch": 0, "merger_strain_amplitud": 0, "amplitude_stitch": [0, 2], "merger_polaris": 0, "polarisation_stitch": 0, "gwexport": [0, 3, 9], "waveform_export": [0, 3, 9], "waveform_array": 0, "snrcalculatorfun": [0, 1, 3], "polynomial_redshift": 0, "redshift_distance_adjust": 0, "frequency_limit": 0, "findchirp_fouri": 0, "amplitude_interpol": 0, "individual_detector_snr": 0, "horizondistfun": 0, "compact_snr_calcul": 0, "horizon_distance_calcul": 0, "detectabilityfun": 0, "cdf_gener": 0, "detectability_calcul": 0, "specific_orientation_snr": 0, "test": 0, "document": [1, 2, 3, 5, 6, 7, 8, 9], "modul": [1, 2, 3, 5, 6, 7, 8, 9, 10], "which": [1, 2, 3, 5, 6, 7, 8, 9], "consist": [1, 2, 3, 5, 6, 7, 8, 9], "part": [1, 3, 5, 6, 7, 8, 9], "procedur": [1, 3, 5, 6, 7, 8, 9], "calcul": [1, 2, 3, 5, 6, 7, 8, 9], "detect": 1, "fraction": 1, "merger": [1, 2, 3, 5, 6, 7, 8], "given": [1, 3, 5, 9], "its": 1, "optim": [1, 3, 9], "align": [1, 3, 9], "snr": [1, 2, 3, 5, 6, 9], "collect": [1, 3, 5, 6, 7, 8, 9], "modular": [1, 3, 5, 6, 7, 8, 9], "n": 1, "10": [1, 5], "6": 1, "gener": [1, 7], "cumul": 1, "distribut": 1, "cdf": 1, "project": 1, "theta": 1, "us": [1, 2, 3, 5, 6, 7, 9, 10], "base": [1, 5, 7, 8, 9], "finn": 1, "1996": 1, "belczynski": 1, "et": [1, 5, 7, 8, 9], "al": [1, 5, 7, 8, 9], "2013": 1, "2014": 1, "int": [1, 5, 6, 8], "The": [1, 2, 3, 5, 6, 7, 8, 9, 10], "number": 1, "random": [1, 3], "sampl": [1, 3, 9], "you": [1, 2, 5], "want": [1, 2, 5], "take": 1, "build": 1, "default": [1, 5], "theta_cdf": 1, "min_cdf": 1, "float": [1, 2, 3, 5, 6, 7, 8, 9], "lower": [1, 5, 9], "boundari": [1, 5], "rang": [1, 6], "over": [1, 5, 6, 7, 8, 9], "defin": 1, "max_cdf": 1, "upper": [1, 5, 9], "snr_in": 1, "arbitrari": 1, "orient": 1, "would": 1, "expect": 1, "observ": [1, 3], "i": [1, 6], "e": [1, 10], "have": [1, 5, 9], "abov": 1, "8": 1, "from": [1, 2, 3, 5, 6, 7, 8, 9], "question": 1, "obtain": [1, 3, 5, 6, 7], "det": 1, "phi": 1, "iota": 1, "psi": 1, "angle_unit": 1, "rad": 1, "result": 1, "detector": [1, 3, 5, 9], "binari": [1, 3, 5, 6, 7, 8, 9], "had": 1, "specif": 1, "specifi": 1, "four": [1, 7], "angl": 1, "rel": 1, "latitud": 1, "one": [1, 3, 5], "describ": [1, 3, 6], "direct": 1, "line": 1, "sight": 1, "gravit": [1, 2, 3, 5, 6, 7, 8, 9], "wave": [1, 5, 7, 8], "sourc": [1, 7], "ax": 1, "s": [1, 3, 9], "arm": 1, "sky": 1, "locat": [1, 2], "coordin": 1, "0": 1, "\u03c0": 1, "180": 1, "deg": 1, "longitud": 1, "2\u03c0": 1, "360": 1, "inclin": 1, "polaris": [1, 5, 8], "str": [1, 2, 3], "whether": 1, "input": [1, 5, 9], "ar": [1, 3, 5, 9], "snr_out": 1, "output": [2, 3, 5, 9], "waveform": [2, 3, 5, 6, 7, 8, 9], "file": 2, "time": [2, 3, 5, 6, 7, 8, 9], "freq": [2, 5], "amp": 2, "path": 2, "export": 2, "simul": [2, 3, 5, 7, 8, 9], "list": [2, 3, 5, 6, 7, 8, 9], "each": [2, 3, 5, 8, 9], "data": [2, 3, 5, 6, 8, 9], "point": [2, 5, 6], "For": 2, "bh": [2, 5], "i_m_tim": [2, 6], "ns": [2, 5], "i_tim": [2, 6], "realtim": [2, 5], "frequenc": [2, 3, 5, 6, 7, 8, 9], "gw": [2, 5, 8], "signal": [2, 5, 9], "i_m_freq": [2, 6], "i_freq": 2, "amplitud": [2, 3, 5, 7, 8, 9], "strain": [2, 3, 5, 8, 9], "i_m_amp": [2, 8], "i_amp": [2, 5, 8], "where": [2, 6, 8], "save": 2, "an": [2, 3, 6], "contain": [2, 10], "arrai": [2, 3, 9], "wherein": 2, "first": [2, 3, 5, 6, 7, 8, 9], "column": [2, 3, 9], "second": [2, 3, 5, 6, 7, 8, 9], "third": [2, 5], "collat": 2, "import": [2, 5], "etc": 2, "singl": [2, 9], "eas": 2, "storag": [2, 5], "similar": 2, "instead": [2, 5, 7], "area": 2, "inlin": 2, "python": 2, "numpi": [2, 3, 9], "ndarrai": [2, 3, 9], "exportarrai": 2, "horizon": 3, "distanc": [3, 5, 9], "otherwis": [3, 9], "inputarrai": [3, 9], "findchirp_arrai": [3, 9], "noisearray_list": 3, "method": [3, 5, 6, 9], "d": [3, 5, 9], "run": 3, "through": 3, "all": [3, 5], "individu": 3, "mainli": 3, "includ": 3, "call": [3, 5, 6, 7, 8], "directli": [3, 5, 6], "rather": [3, 5, 6, 9], "format": [3, 9], "findchirp": [3, 9], "fourth": [3, 9], "fourier": [3, 9], "transform": [3, 9], "other": [3, 5, 7, 9], "irrelev": [3, 9], "A": [3, 6, 7, 8, 9], "grid": [3, 9], "www": [3, 9], "dropbox": [3, 9], "sh": [3, 9], "lt8109c0c2eb10c": [3, 9], "aadbnyxmgmwoeqck": [3, 9], "xwfzujla": [3, 9], "item": 3, "should": [3, 5, 6, 8, 9], "nois": [3, 9], "spectrum": [3, 9], "assum": [3, 9], "valu": [3, 5, 6, 7, 8, 9], "asd": [3, 9], "level": [3, 9], "If": 3, "quad": 3, "quadratur": 3, "across": 3, "mean": 3, "oper": 3, "onli": 3, "equival": 3, "luminos": [3, 9], "merg": [3, 9], "mpc": [3, 5, 9], "final_snr": 3, "noisearrai": [3, 9], "maximum": 3, "someth": [3, 9], "horizon_dist": 3, "inspir": [5, 6, 8], "portion": [5, 6, 7, 8], "kwarg": 5, "give": [5, 6, 8], "total": [5, 6, 7], "mass": [5, 6, 7], "m": [5, 6, 7], "symmetr": [5, 7], "ratio": [5, 7], "eta": [5, 7], "either": 5, "m1": 5, "m2": 5, "OR": 5, "logmc": 5, "q": 5, "mani": 5, "synthesi": 5, "object": 5, "solar": 5, "log10": 5, "chirp": 5, "tupl": [5, 7, 9], "follow": 5, "flow": 5, "start": 5, "integr": 5, "post": [5, 8], "newtonian": 5, "buskirk": [5, 7, 8], "2019": [5, 7, 8], "equat": [5, 7, 8], "22": 5, "cutoff": 5, "we": 5, "usual": [5, 6], "set": [5, 9], "hz": [5, 6], "merger_typ": 5, "end": 5, "23": 5, "string": 5, "x": 5, "encod": 5, "differenti": 5, "x_integr": 5, "huerta": 5, "2017": 5, "variabl": 5, "being": 5, "mdxdt": 5, "dx": 5, "dt": 5, "xtime": 5, "seri": 5, "ha": 5, "been": [5, 9], "correspond": [5, 7, 9], "timestep": [5, 7, 8], "between": [5, 6], "pair": 5, "convert": 5, "geometr": [5, 6, 7], "unit": [5, 6, 7, 10], "real": [5, 6, 7], "orbit": [5, 7, 8], "phase": [5, 8], "angular": [5, 6, 7, 8], "7": 5, "i_phas": [5, 8], "omega": 5, "radiu": 5, "deriv": [5, 7, 8], "dure": 5, "r": 5, "rdot": 5, "a1": 5, "a2": 5, "two": [5, 8], "coeffici": [5, 7, 8], "9": 5, "feed": 5, "100": 5, "here": 5, "when": 5, "aorth": 5, "adiag": 5, "orthogon": [5, 8], "plu": [5, 8], "diagon": [5, 8], "cross": [5, 8], "unitless": 5, "reduction_factor": 5, "your_list": 5, "option": 5, "reduc": 5, "size": 5, "those": [5, 9], "much": 5, "shorter": 5, "order": 5, "files": 5, "conserv": 5, "space": 5, "note": [5, 7, 9], "typic": 5, "reduct": 5, "factor": [5, 7], "our": 5, "research": 5, "code": 5, "match": [5, 6, 7, 8], "so": [5, 9], "them": [5, 6], "length": 5, "reduced_list": 5, "form": 5, "togeth": [6, 8], "ringdown": [6, 7, 8], "black": [6, 7, 8], "hole": [6, 7, 8], "i_omega": 6, "m_time": [6, 7], "m_omega": [6, 7, 8], "quantiti": 6, "subsequ": [6, 7], "determin": 6, "best": 6, "offset": 6, "switch": [6, 8], "precis": 6, "wa": 6, "revis": 6, "sever": [6, 7], "index": [6, 8], "df_diff": 6, "nan": 6, "differ": [6, 9], "gradient": 6, "find": 6, "occur": [6, 8], "process": 6, "min_switch_ind": [6, 8], "what": 6, "last": [6, 8], "befor": [6, 8], "final_i_index": [6, 8], "time_offset": 6, "stitch": [6, 8], "combin": [6, 8], "correct": [6, 8], "i_m_omega": 6, "translat": 6, "ordinari": 6, "tempor": 6, "si": 6, "plot": 6, "also": 6, "requir": 6, "entir": [6, 8], "durat": [6, 8], "pre": 7, "final": 7, "spin": 7, "quasi": 7, "normal": 7, "mode": 7, "19": 7, "20": 7, "sfin": 7, "wqnm": 7, "constant": 7, "gir": [7, 8], "implicit": 7, "rotat": 7, "relat": 7, "appendix": 7, "c": 7, "alpha": [7, 8], "b": 7, "kappa": 7, "anyth": 7, "17": 7, "18": 7, "fhat": [7, 8], "sort": [7, 8], "f": [7, 8], "fhatdot": [7, 8], "21": 8, "m_phase": 8, "i_m_phas": 8, "16": 8, "m_amp": 8, "i_aorth": 8, "m_aorth": 8, "m_adiag": 8, "i_adiag": 8, "i_m_aorth": 8, "i_m_adiag": 8, "polynomi": 9, "approxim": 9, "redshift": 9, "z": 9, "adjust": 9, "account": 9, "effect": 9, "adjustedarrai": 9, "limit": 9, "freqmax": 9, "freqmin": 9, "respect": 9, "simpler": 9, "model": 9, "allen": 9, "2012": 9, "calibr": 9, "mai": 9, "futur": 9, "replac": 9, "fft": 9, "fourieramp": 9, "scipi": 9, "interp1d": 9, "noise_freq_amp": 9, "than": 9, "compar": 9, "barrett": 9, "2018": 9, "ind_snr": 9, "directori": 10, "main": 10, "utilis": 10, "pytest": 10, "perform": 10, "tox": 10, "standard": 10, "command": 10, "instal": 10}, "objects": {}, "objtypes": {}, "objnames": {}, "titleterms": {"document": [0, 4], "content": 0, "detectabilityfun": 1, "cdf_gener": 1, "paramet": [1, 2, 3, 5, 6, 7, 8, 9], "return": [1, 2, 3, 5, 6, 7, 8, 9], "detectability_calcul": 1, "specific_orientation_snr": 1, "gwexport": 2, "waveform_export": 2, "waveform_array": 2, "horizondistfun": 3, "compact_snr_calcul": 3, "horizon_distance_calcul": 3, "riroriro": 4, "refer": 4, "api": 4, "inspiralfun": 5, "get_m_and_eta": 5, "startx": 5, "endx": 5, "pnderiv": 5, "pn_parameter_integr": 5, "inspiral_time_convers": 5, "inspiral_phase_freq_integr": 5, "radius_calcul": 5, "a1_a2_calcul": 5, "inspiral_strain_polaris": 5, "inspiral_strain_amplitud": 5, "list_size_reduc": 5, "matchingfun": 6, "mqdiff": 6, "min_switch_ind_find": 6, "final_i_index_find": 6, "time_offset_find": 6, "time_frequency_stitch": 6, "frequency_si_unit": 6, "mergerfirstfun": 7, "quasi_normal_mod": 7, "girs_coeffici": 7, "merger_freq_calcul": 7, "fhat_differenti": 7, "merger_time_convers": 7, "mergersecondfun": 8, "merger_phase_calcul": 8, "phase_stitch": 8, "merger_strain_amplitud": 8, "amplitude_stitch": 8, "merger_polaris": 8, "polarisation_stitch": 8, "snrcalculatorfun": 9, "polynomial_redshift": 9, "redshift_distance_adjust": 9, "frequency_limit": 9, "findchirp_fouri": 9, "amplitude_interpol": 9, "individual_detector_snr": 9, "test": 10}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 6, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 56}})