Installing PyCBC
Use of PyCBC in Scientific Publications
Modules
Index
User Guides
Library Examples and Interactive Tutorials
PyCBC inference documentation (
pycbc.inference
)
Applications and Workflows
Dev Guides
Extending PyCBC with external plugins
Documentation for Developers
PyCBC
Index
Index – S
sample_frequencies (pycbc.types.frequencyseries.FrequencySeries property)
sample_points (pycbc.waveform.compress.CompressedWaveform property)
sample_rate (pycbc.types.frequencyseries.FrequencySeries property)
(pycbc.types.timeseries.TimeSeries property)
sample_rate_close() (pycbc.types.timeseries.TimeSeries method)
sample_round() (pycbc.inference.sampler.games.GameSampler method)
sample_rwalk_mod() (in module pycbc.inference.sampler.dynesty)
sample_times (pycbc.types.timeseries.TimeSeries property)
sampler_group (pycbc.inference.io.base_hdf.BaseInferenceFile attribute)
samples (pycbc.inference.sampler.base.BaseSampler property)
(pycbc.inference.sampler.dummy.DummySampler property)
(pycbc.inference.sampler.dynesty.DynestySampler property)
(pycbc.inference.sampler.emcee.EmceeEnsembleSampler property)
(pycbc.inference.sampler.emcee_pt.EmceePTSampler property)
(pycbc.inference.sampler.epsie.EpsieSampler property)
(pycbc.inference.sampler.multinest.MultinestSampler property)
(pycbc.inference.sampler.nessai.NessaiSampler property)
(pycbc.inference.sampler.ptemcee.PTEmceeSampler property)
(pycbc.inference.sampler.snowline.SnowlineSampler property)
(pycbc.inference.sampler.ultranest.UltranestSampler property)
samples_from_cli() (pycbc.inference.io.base_hdf.BaseInferenceFile method)
samples_group (pycbc.inference.io.base_hdf.BaseInferenceFile attribute)
sampling_params (pycbc.inference.models.base.BaseModel property)
(pycbc.inference.sampler.base.BaseSampler property)
SamplingTransforms (class in pycbc.inference.models.base)
sanitize_newline() (pycbc.types.config.InterpolatingConfigParser method)
sanity_check_subsections() (in module pycbc.workflow.configparser_test)
(pycbc.types.config.InterpolatingConfigParser method)
save() (pycbc.io.gracedb.CandidateForGraceDB method)
(pycbc.io.hdf.DictArray method)
(pycbc.io.hdf.StatmapData method)
(pycbc.types.array.Array method)
(pycbc.types.frequencyseries.FrequencySeries method)
(pycbc.types.timeseries.TimeSeries method)
(pycbc.workflow.core.Workflow method)
(pycbc.workflow.pegasus_workflow.Workflow method)
save_bkg_falloff() (in module pycbc.population.rates_functions)
save_config() (pycbc.workflow.core.Workflow method)
save_dict_to_hdf5() (in module pycbc.io.hdf)
save_fig_with_metadata() (in module pycbc.results.metadata)
save_html_with_metadata() (in module pycbc.results.metadata)
save_pdf_with_metadata() (in module pycbc.results.metadata)
save_performance() (pycbc.events.eventmgr.EventManager method)
save_png_with_metadata() (in module pycbc.results.metadata)
save_state() (pycbc.events.coinc.LiveCoincTimeslideBackgroundEstimator method)
(pycbc.events.eventmgr.EventManager method)
save_to_wav() (pycbc.types.timeseries.TimeSeries method)
save_veto_definer() (in module pycbc.workflow.segment)
scale_factor (pycbc.inference.sampler.ptemcee.PTEmceeSampler property)
Scheme (class in pycbc.scheme)
schemed() (in module pycbc.scheme)
second_phase() (in module pycbc.fft.fftw_pruned)
second_phase_cython() (in module pycbc.fft.fftw_pruned_cython)
secondary_mass (pycbc.io.record.WaveformArray property)
secondary_mass() (in module pycbc.conversions)
secondary_spin() (in module pycbc.conversions)
secondary_xi() (in module pycbc.conversions)
section_to_cli() (pycbc.workflow.configuration.WorkflowConfigParser method)
SectionNumber (class in pycbc.results.layout)
seed (pycbc.inference.io.epsie.EpsieFile property)
(pycbc.inference.sampler.epsie.EpsieSampler property)
SegFile (class in pycbc.workflow.core)
segment (pycbc.workflow.core.File property)
segment_snrs() (in module pycbc.vetoes.bank_chisq)
segments_to_start_end() (in module pycbc.events.veto)
select() (pycbc.io.hdf.DictArray method)
(pycbc.io.hdf.HFile method)
select_files_by_ifo_combination() (in module pycbc.workflow.coincidence)
select_generic_executable() (in module pycbc.workflow.jobsetup)
select_matchedfilter_class() (in module pycbc.workflow.jobsetup)
select_rframe_generator() (pycbc.waveform.generator.BaseFDomainDetFrameGenerator method)
(pycbc.waveform.generator.FDomainDetFrameGenerator static method)
(pycbc.waveform.generator.FDomainDetFrameModesGenerator static method)
(pycbc.waveform.generator.FDomainDetFrameTwoPolGenerator static method)
(pycbc.waveform.generator.FDomainDetFrameTwoPolNoRespGenerator static method)
(pycbc.waveform.generator.FDomainDirectDetFrameGenerator static method)
select_segments_by_definer() (in module pycbc.events.veto)
select_splitfilejob_instance() (in module pycbc.workflow.splittable)
select_tmpltbank_class() (in module pycbc.workflow.jobsetup)
select_waveform_generator() (in module pycbc.waveform.generator)
select_waveform_modes_generator() (in module pycbc.waveform.generator)
semi_analytical_psd_lisa_confusion_noise() (in module pycbc.psd.analytical_space)
sensitivity_curve_lisa_confusion() (in module pycbc.psd.analytical_space)
sensitivity_curve_lisa_SciRD() (in module pycbc.psd.analytical_space)
sensitivity_curve_lisa_semi_analytical() (in module pycbc.psd.analytical_space)
sensitivity_curve_taiji_analytical() (in module pycbc.psd.analytical_space)
sensitivity_curve_taiji_confusion() (in module pycbc.psd.analytical_space)
sensitivity_curve_tianqin_analytical() (in module pycbc.psd.analytical_space)
sensitivity_curve_tianqin_confusion() (in module pycbc.psd.analytical_space)
set_backend() (in module pycbc.fft.backend_cpu)
(in module pycbc.fft.backend_cupy)
(in module pycbc.fft.backend_mkl)
(in module pycbc.fft.backend_support)
set_bandwidth() (pycbc.distributions.arbitrary.Arbitrary method)
set_burn_in() (pycbc.inference.sampler.base_mcmc.BaseMCMC method)
set_burn_in_from_config() (pycbc.inference.sampler.base_mcmc.BaseMCMC method)
set_category() (pycbc.workflow.pegasus_workflow.ProfileShortcuts method)
set_data() (pycbc.filter.matchedfilter.LiveBatchMatchedFilter method)
set_epoch() (pycbc.waveform.generator.BaseFDomainDetFrameGenerator method)
(pycbc.waveform.generator.FDomainDirectDetFrameGenerator method)
set_execution_site() (pycbc.workflow.pegasus_workflow.ProfileShortcuts method)
set_gmst_reference() (pycbc.detector.ground.Detector method)
set_grb_start_end() (in module pycbc.workflow.grb_utils)
set_initial_conditions() (pycbc.inference.sampler.dynesty.DynestySampler method)
(pycbc.inference.sampler.multinest.MultinestSampler method)
(pycbc.inference.sampler.nessai.NessaiSampler method)
set_marginal_histogram_title() (in module pycbc.results.scatter_histograms)
set_measure_level() (in module pycbc.fft.fftw)
set_memory() (pycbc.workflow.pegasus_workflow.ProfileShortcuts method)
set_num_cpus() (pycbc.workflow.pegasus_workflow.ProfileShortcuts method)
set_num_retries() (pycbc.workflow.pegasus_workflow.ProfileShortcuts method)
set_p0() (pycbc.inference.sampler.base_mcmc.BaseMCMC method)
(pycbc.inference.sampler.epsie.EpsieSampler method)
set_planning_limit() (in module pycbc.fft.fftw)
set_priority() (pycbc.workflow.pegasus_workflow.ProfileShortcuts method)
set_psd_segments() (pycbc.inference.models.gaussian_noise.BaseGaussianNoise method)
set_ref_time() (pycbc.inject.inject.IncoherentFromFileHDFInjectionSet method)
set_sim_data() (in module pycbc.inject.inject)
set_singles_buffer() (pycbc.events.coinc.LiveCoincTimeslideBackgroundEstimator method)
set_start_from_config() (pycbc.inference.sampler.base_mcmc.BaseMCMC method)
(pycbc.inference.sampler.refine.RefineSampler method)
set_state_from_file() (pycbc.inference.sampler.base_mcmc.BaseMCMC method)
(pycbc.inference.sampler.dynesty.DynestySampler method)
(pycbc.inference.sampler.emcee.EmceeEnsembleSampler method)
(pycbc.inference.sampler.emcee_pt.EmceePTSampler method)
(pycbc.inference.sampler.epsie.EpsieSampler method)
(pycbc.inference.sampler.multinest.MultinestSampler method)
(pycbc.inference.sampler.ptemcee.PTEmceeSampler method)
set_storage() (pycbc.workflow.pegasus_workflow.ProfileShortcuts method)
set_style_from_cli() (in module pycbc.results.plot)
set_subworkflow_properties() (pycbc.workflow.pegasus_workflow.SubWorkflow method)
set_target() (pycbc.inference.sampler.base_mcmc.BaseMCMC method)
set_target_from_config() (pycbc.inference.sampler.base_mcmc.BaseMCMC method)
set_template() (pycbc.io.hdf.ReadByTemplate method)
set_thin_interval_from_config() (pycbc.inference.sampler.base_mcmc.BaseMCMC method)
set_threads_backend() (in module pycbc.fft.fftw)
set_universe() (pycbc.workflow.pegasus_workflow.ProfileShortcuts method)
setup_antenna() (pycbc.inference.models.relbin.Relative method)
setup_bins() (in module pycbc.inference.models.relbin)
setup_calls() (in module pycbc.inference.sampler.base_cube)
setup_combine_statmap() (in module pycbc.workflow.coincidence)
setup_datafind_from_pregenerated_lcf_files() (in module pycbc.workflow.datafind)
setup_datafind_runtime_cache_multi_calls_perifo() (in module pycbc.workflow.datafind)
setup_datafind_runtime_cache_single_call_perifo() (in module pycbc.workflow.datafind)
setup_datafind_runtime_frames_multi_calls_perifo() (in module pycbc.workflow.datafind)
setup_datafind_runtime_frames_single_call_perifo() (in module pycbc.workflow.datafind)
setup_datafind_workflow() (in module pycbc.workflow.datafind)
setup_distance_marg_interpolant() (in module pycbc.inference.models.tools)
setup_dq_reranking() (in module pycbc.workflow.dq)
setup_exclude_zerolag() (in module pycbc.workflow.coincidence)
setup_foreground_minifollowups() (in module pycbc.workflow.minifollowups)
setup_injection_minifollowups() (in module pycbc.workflow.minifollowups)
setup_injection_workflow() (in module pycbc.workflow.injection)
setup_interval_coinc() (in module pycbc.workflow.coincidence)
setup_interval_coinc_inj() (in module pycbc.workflow.coincidence)
setup_marginalization() (pycbc.inference.models.tools.DistMarg method)
setup_matchedfltr_dax_generated() (in module pycbc.workflow.matched_filter)
setup_matchedfltr_dax_generated_multi() (in module pycbc.workflow.matched_filter)
setup_matchedfltr_workflow() (in module pycbc.workflow.matched_filter)
setup_output() (in module pycbc.inference.sampler.base)
(pycbc.inference.sampler.multinest.MultinestSampler method)
setup_peak_lock() (pycbc.inference.models.tools.DistMarg method)
setup_psd_calculate() (in module pycbc.workflow.psd)
setup_psd_pregenerated() (in module pycbc.workflow.psdfiles)
setup_psd_workflow() (in module pycbc.workflow.psdfiles)
setup_pygrb_minifollowups() (in module pycbc.workflow.grb_utils)
setup_pygrb_pp_workflow() (in module pycbc.workflow.grb_utils)
setup_pygrb_results_workflow() (in module pycbc.workflow.grb_utils)
setup_segments() (pycbc.events.stat.DQExpFitFgBgNormStatistic method)
setup_single_det_minifollowups() (in module pycbc.workflow.minifollowups)
setup_sngls() (in module pycbc.workflow.coincidence)
setup_sngls_inj() (in module pycbc.workflow.coincidence)
setup_sngls_statmap() (in module pycbc.workflow.coincidence)
setup_sngls_statmap_inj() (in module pycbc.workflow.coincidence)
setup_splittable_dax_generated() (in module pycbc.workflow.splittable)
setup_splittable_workflow() (in module pycbc.workflow.splittable)
setup_statmap() (in module pycbc.workflow.coincidence)
setup_statmap_inj() (in module pycbc.workflow.coincidence)
setup_template_render() (in module pycbc.results.render)
setup_tmpltbank_dax_generated() (in module pycbc.workflow.tmpltbank)
setup_tmpltbank_pregenerated() (in module pycbc.workflow.tmpltbank)
setup_tmpltbank_without_frames() (in module pycbc.workflow.tmpltbank)
setup_tmpltbank_workflow() (in module pycbc.workflow.tmpltbank)
setup_trigger_fitting() (in module pycbc.workflow.coincidence)
setup_upload_prep_minifollowups() (in module pycbc.workflow.minifollowups)
sfr_grb_2008() (in module pycbc.population.population_models)
sfr_madau_dickinson_2014() (in module pycbc.population.population_models)
sfr_madau_fragos_2017() (in module pycbc.population.population_models)
sgburst_approximants() (in module pycbc.waveform.waveform)
SGBurstInjectionSet (class in pycbc.inject.inject)
sgchisq (pycbc.io.hdf.SingleDetTriggers property)
sh_transformed_psd_lisa_tdi_XYZ() (in module pycbc.psd.analytical_space)
shape (pycbc.types.array.Array property)
shift_sum() (in module pycbc.vetoes.chisq)
(in module pycbc.vetoes.chisq_cpu)
(in module pycbc.vetoes.chisq_cupy)
shift_sum_points() (in module pycbc.vetoes.chisq_cupy)
shift_sum_points_pow2() (in module pycbc.vetoes.chisq_cupy)
sigma() (in module pycbc.filter.matchedfilter)
sigma_cached() (in module pycbc.waveform.bank)
sigma_multiple_cut_thresh() (in module pycbc.events.cuts)
sigmasq() (in module pycbc.filter.matchedfilter)
sigmasq_series() (in module pycbc.filter.matchedfilter)
signal_pdf_from_snr() (in module pycbc.population.live_pastro)
signal_rate_rescale() (in module pycbc.population.live_pastro)
signal_rate_trig_type() (in module pycbc.population.live_pastro)
SignalEventRate (class in pycbc.population.fgmc_functions)
SinAngle (class in pycbc.distributions.angular)
single() (pycbc.events.stat.DQExpFitFgBgNormStatistic method)
(pycbc.events.stat.ExpFitCombinedSNR method)
(pycbc.events.stat.ExpFitFgBgNormBBHStatistic method)
(pycbc.events.stat.ExpFitFgBgNormStatistic method)
(pycbc.events.stat.ExpFitStatistic method)
(pycbc.events.stat.PhaseTDExpFitStatistic method)
(pycbc.events.stat.PhaseTDStatistic method)
(pycbc.events.stat.QuadratureSumStatistic method)
(pycbc.events.stat.Stat method)
single_arm_frequency_response() (in module pycbc.detector.ground)
single_layout() (in module pycbc.results.layout)
SingleDetAutoChisq (class in pycbc.vetoes.autochisq)
SingleDetBankVeto (class in pycbc.vetoes.bank_chisq)
SingleDetPowerChisq (class in pycbc.vetoes.chisq)
SingleDetSGChisq (class in pycbc.vetoes.sgchisq)
SingleDetSkyMaxAutoChisq (class in pycbc.vetoes.autochisq)
SingleDetSkyMaxBankVeto (class in pycbc.vetoes.bank_chisq)
SingleDetSkyMaxPowerChisq (class in pycbc.vetoes.chisq)
SingleDetTriggers (class in pycbc.io.hdf)
SinglePool (class in pycbc.pool)
SingleTemplate (class in pycbc.inference.models.single_template)
SingleTemplateExecutable (class in pycbc.workflow.minifollowups)
SingleTimeFreqExecutable (class in pycbc.workflow.minifollowups)
sites (pycbc.workflow.core.Workflow property)
skew_lognormal_samples() (in module pycbc.population.rates_functions)
sky_coords (pycbc.detector.space.SpaceDetector property)
SkyGrid (class in pycbc.tmpltbank.sky_grid)
slice_and_taper() (pycbc.inject.inject.IncoherentFromFileHDFInjectionSet static method)
slide_opts_helper() (in module pycbc.results.pygrb_postprocessing_utils)
smaller() (pycbc.boundaries.ClosedBound method)
(pycbc.boundaries.OpenBound method)
sngl_ifo_job_setup() (in module pycbc.workflow.jobsetup)
SnowlineFile (class in pycbc.inference.io.snowline)
SnowlineSampler (class in pycbc.inference.sampler.snowline)
snr (pycbc.io.hdf.SingleDetTriggers property)
snr_draw() (pycbc.inference.models.tools.DistMarg method)
snr_from_loglr() (in module pycbc.conversions)
snr_predictor() (in module pycbc.inference.models.relbin_cpu)
snr_predictor_dom() (in module pycbc.inference.models.relbin_cpu)
solar_mass_to_kg() (in module pycbc.pnutils)
sort() (pycbc.io.record.FieldArray method)
sort_arr (pycbc.io.hdf.ForegroundTriggers property)
sort_stat() (in module pycbc.results.pygrb_postprocessing_utils)
sort_trigs() (in module pycbc.results.pygrb_postprocessing_utils)
source_color() (in module pycbc.results.color)
spa_amplitude_factor() (in module pycbc.waveform.spa_tmplt)
spa_compression() (in module pycbc.waveform.compress)
spa_distance() (in module pycbc.waveform.spa_tmplt)
spa_length_in_time() (in module pycbc.waveform.spa_tmplt)
spa_tmplt() (in module pycbc.waveform.spa_tmplt)
spa_tmplt_end() (in module pycbc.waveform.spa_tmplt)
spa_tmplt_engine() (in module pycbc.waveform.spa_tmplt)
(in module pycbc.waveform.spa_tmplt_cpu)
(in module pycbc.waveform.spa_tmplt_cupy)
spa_tmplt_inline_sequence() (in module pycbc.waveform.spa_tmplt_cpu)
spa_tmplt_norm() (in module pycbc.waveform.spa_tmplt)
spa_tmplt_precondition() (in module pycbc.waveform.spa_tmplt)
SpaceDetector (class in pycbc.detector.space)
spher_harms() (in module pycbc.waveform.ringdown)
spherical_to_cartesian() (in module pycbc.coordinates)
(in module pycbc.coordinates.base)
SphericalSpin1ToCartesianSpin1 (class in pycbc.transforms)
SphericalSpin2ToCartesianSpin2 (class in pycbc.transforms)
SphericalToCartesian (class in pycbc.transforms)
spin1_a (pycbc.io.record.WaveformArray property)
spin1_azimuthal (pycbc.io.record.WaveformArray property)
spin1_polar (pycbc.io.record.WaveformArray property)
spin1x (pycbc.io.hdf.SingleDetTriggers property)
spin1x_from_xi1_phi_a_phi_s() (in module pycbc.conversions)
spin1y (pycbc.io.hdf.SingleDetTriggers property)
spin1y_from_xi1_phi_a_phi_s() (in module pycbc.conversions)
spin1z (pycbc.io.hdf.SingleDetTriggers property)
spin1z_from_mass1_mass2_chi_eff_chi_a() (in module pycbc.conversions)
spin2_a (pycbc.io.record.WaveformArray property)
spin2_azimuthal (pycbc.io.record.WaveformArray property)
spin2_polar (pycbc.io.record.WaveformArray property)
spin2x (pycbc.io.hdf.SingleDetTriggers property)
spin2x_from_mass1_mass2_xi2_phi_a_phi_s() (in module pycbc.conversions)
spin2y (pycbc.io.hdf.SingleDetTriggers property)
spin2y_from_mass1_mass2_xi2_phi_a_phi_s() (in module pycbc.conversions)
spin2z (pycbc.io.hdf.SingleDetTriggers property)
spin2z_from_mass1_mass2_chi_eff_chi_a() (in module pycbc.conversions)
spin_from_pulsar_freq() (in module pycbc.conversions)
spin_px (pycbc.io.record.WaveformArray property)
spin_py (pycbc.io.record.WaveformArray property)
spin_pz (pycbc.io.record.WaveformArray property)
spin_sx (pycbc.io.record.WaveformArray property)
spin_sy (pycbc.io.record.WaveformArray property)
spin_sz (pycbc.io.record.WaveformArray property)
splay() (in module pycbc.fft.fftw_pruned)
split_multi_sections() (in module pycbc.workflow.configparser_test)
(pycbc.types.config.InterpolatingConfigParser method)
squared_norm() (in module pycbc.types.array_cpu)
(in module pycbc.types.array_cupy)
(pycbc.types.array.Array method)
src_mass_from_z_det_mass() (in module pycbc.mchirp_area)
ssb_to_geo() (in module pycbc.coordinates)
(in module pycbc.coordinates.space)
ssb_to_lisa() (in module pycbc.coordinates)
(in module pycbc.coordinates.space)
SSBToGEO (class in pycbc.transforms)
SSBToLISA (class in pycbc.transforms)
stack_xi_direction_brute() (in module pycbc.tmpltbank.brute_force_methods)
staging_site (pycbc.workflow.core.Workflow property)
staging_site_str (pycbc.workflow.core.Workflow property)
start_end_from_segments() (in module pycbc.events.veto)
start_end_to_segments() (in module pycbc.events.veto)
start_refresh_thread() (pycbc.events.coinc.LiveCoincTimeslideBackgroundEstimator method)
(pycbc.events.single.LiveSingle method)
start_time (pycbc.strain.strain.StrainBuffer property)
(pycbc.types.frequencyseries.FrequencySeries property)
(pycbc.types.timeseries.TimeSeries property)
startColumn() (pycbc.io.ligolw.LIGOLWContentHandler method)
starting_betas (pycbc.inference.io.ptemcee.PTEmceeFile property)
(pycbc.inference.sampler.ptemcee.PTEmceeSampler property)
startStream() (pycbc.io.ligolw.LIGOLWContentHandler method)
startTable() (pycbc.io.ligolw.LIGOLWContentHandler method)
Stat (class in pycbc.events.stat)
static_args (pycbc.waveform.generator.BaseFDomainDetFrameGenerator property)
(pycbc.waveform.generator.BaseGenerator property)
static_params (pycbc.inference.io.base_hdf.BaseInferenceFile property)
(pycbc.inference.models.base.BaseModel property)
(pycbc.inference.models.hierarchical.HierarchicalModel property)
(pycbc.inference.sampler.base.BaseSampler property)
static_table() (in module pycbc.results.table_utils)
StatmapData (class in pycbc.io.hdf)
statnames (pycbc.inference.models.base.ModelStats property)
StatusBuffer (class in pycbc.frame.frame)
stepping_stone_algorithm() (in module pycbc.inference.evidence)
str_to_bool() (in module pycbc.inference.models.tools)
str_to_tuple() (in module pycbc.inference.models.tools)
strain() (pycbc.catalog.Merger method)
strain_from_cli_multi_ifos() (in module pycbc.inference.models.data_utils)
StrainBuffer (class in pycbc.strain.strain)
StrainSegments (class in pycbc.strain.strain)
subname (pycbc.inference.models.hierarchical.HierarchicalParam attribute)
SubWorkflow (class in pycbc.workflow.pegasus_workflow)
sum() (in module pycbc.types.array_cpu)
(in module pycbc.types.array_cupy)
(pycbc.types.array.Array method)
sum_modes() (in module pycbc.waveform.waveform_modes)
summary_product() (pycbc.inference.models.relbin.Relative method)
SupernovaeConvexHull (class in pycbc.distributions.constraints)
supported_approximants() (pycbc.inject.inject.CBCHDFInjectionSet static method)
(pycbc.inject.inject.IncoherentFromFileHDFInjectionSet static method)
(pycbc.inject.inject.RingdownHDFInjectionSet static method)
swap_interval (pycbc.inference.io.epsie.EpsieFile property)
(pycbc.inference.sampler.epsie.EpsieSampler property)
symlink() (in module pycbc.live.supervision)