PyFstat module documentation

These pages document the full API and set of classes provided by PyFstat.

See here for installation instructions and other general information.

• pyfstat package
  • Subpackages
    • pyfstat.utils package
      • Submodules
      • pyfstat.utils.atoms module
      • pyfstat.utils.cli module
      • pyfstat.utils.converting module
      • pyfstat.utils.ephemeris module
      • pyfstat.utils.formatting module
      • pyfstat.utils.gsl module
      • pyfstat.utils.importing module
      • pyfstat.utils.io module
      • pyfstat.utils.predict module
      • pyfstat.utils.runlalsuite module
      • pyfstat.utils.sft module
      • Module contents
  • Submodules
  • pyfstat.core module
    • BaseSearchClass
      • BaseSearchClass.binary_keys
      • BaseSearchClass.default_search_keys
      • BaseSearchClass.tex_labels
      • BaseSearchClass.unit_dictionary
      • BaseSearchClass.fmt_detstat
      • BaseSearchClass.fmt_doppler
      • BaseSearchClass.tex_label0()
      • BaseSearchClass.set_ephemeris_files()
      • BaseSearchClass.pprint_init_params_dict()
      • BaseSearchClass.get_output_file_header()
      • BaseSearchClass.read_par()
      • BaseSearchClass.translate_keys_to_lal()
    • ComputeFstat
      • ComputeFstat.init_computefstatistic()
      • ComputeFstat.estimate_min_max_CoverFreq()
      • ComputeFstat.get_fullycoherent_detstat()
      • ComputeFstat.get_fullycoherent_twoF()
      • ComputeFstat.get_fullycoherent_single_IFO_twoFs()
      • ComputeFstat.get_fullycoherent_log10BSGL()
      • ComputeFstat.get_transient_detstats()
      • ComputeFstat.get_transient_maxTwoFstat()
      • ComputeFstat.get_transient_log10BSGL()
      • ComputeFstat.calculate_twoF_cumulative()
      • ComputeFstat.predict_twoF_cumulative()
      • ComputeFstat.plot_twoF_cumulative()
      • ComputeFstat.write_atoms_to_file()
    • SemiCoherentSearch
      • SemiCoherentSearch.init_semicoherent_parameters()
      • SemiCoherentSearch.get_semicoherent_det_stat()
      • SemiCoherentSearch.get_semicoherent_twoF()
      • SemiCoherentSearch.get_semicoherent_single_IFO_twoFs()
      • SemiCoherentSearch.get_semicoherent_log10BSGL()
    • SearchForSignalWithJumps
    • SemiCoherentGlitchSearch
      • SemiCoherentGlitchSearch.get_semicoherent_nglitch_twoF()
      • SemiCoherentGlitchSearch.compute_glitch_fstat_single()
    • DeprecatedClass
    • DefunctClass
      • DefunctClass.last_supported_version
      • DefunctClass.pr_welcome
  • pyfstat.grid_based_searches module
    • GridSearch
      • GridSearch.check_old_data_is_okay_to_use()
      • GridSearch.run()
      • GridSearch.save_array_to_disk()
      • GridSearch.plot_1D()
      • GridSearch.plot_2D()
      • GridSearch.get_max_det_stat()
      • GridSearch.get_max_twoF()
      • GridSearch.print_max_twoF()
      • GridSearch.generate_loudest()
      • GridSearch.set_out_file()
    • TransientGridSearch
      • TransientGridSearch.run()
      • TransientGridSearch.get_transient_fstat_map_filename()
    • SearchOverGridFile
    • SliceGridSearch
      • SliceGridSearch.last_supported_version
    • GridUniformPriorSearch
      • GridUniformPriorSearch.last_supported_version
    • GridGlitchSearch
    • SlidingWindow
      • SlidingWindow.last_supported_version
    • FrequencySlidingWindow
      • FrequencySlidingWindow.last_supported_version
    • EarthTest
      • EarthTest.last_supported_version
    • DMoff_NO_SPIN
      • DMoff_NO_SPIN.last_supported_version
  • pyfstat.gridcorner module
    • log_mean()
    • max_slice()
    • idx_array_slice()
    • gridcorner()
    • projection_2D()
    • projection_1D()
  • pyfstat.injection_parameters module
    • custom_prior()
    • uniform_sky_declination()
    • InjectionParametersGenerator
      • InjectionParametersGenerator.draw()
      • InjectionParametersGenerator.draw_many()
    • AllSkyInjectionParametersGenerator
  • pyfstat.logging module
    • set_up_logger()
  • pyfstat.make_sfts module
    • Writer
      • Writer.mfd
      • Writer.signal_parameter_labels
      • Writer.gps_time_and_string_formats_as_LAL
      • Writer.required_signal_parameters
      • Writer.tend
      • Writer.calculate_fmin_Band()
      • Writer.make_cff()
      • Writer.check_cached_data_okay_to_use()
      • Writer.make_data()
      • Writer.run_makefakedata()
      • Writer.predict_fstat()
    • BinaryModulatedWriter
    • LineWriter
      • LineWriter.mfd
      • LineWriter.required_signal_parameters
      • LineWriter.signal_parameters_labels
    • GlitchWriter
      • GlitchWriter.make_cff()
    • FrequencyModulatedArtifactWriter
      • FrequencyModulatedArtifactWriter.get_frequency()
      • FrequencyModulatedArtifactWriter.get_h0()
      • FrequencyModulatedArtifactWriter.concatenate_sft_files()
      • FrequencyModulatedArtifactWriter.pre_compute_evolution()
      • FrequencyModulatedArtifactWriter.make_ith_sft()
      • FrequencyModulatedArtifactWriter.make_data()
      • FrequencyModulatedArtifactWriter.run_makefakedata_v4()
    • FrequencyAmplitudeModulatedArtifactWriter
      • FrequencyAmplitudeModulatedArtifactWriter.get_h0()
  • pyfstat.mcmc_based_searches module
    • Defining the prior
    • MCMCSearch
      • MCMCSearch.transform_dictionary
      • MCMCSearch.setup_initialisation()
      • MCMCSearch.run()
      • MCMCSearch.plot_corner()
      • MCMCSearch.plot_chainconsumer()
      • MCMCSearch.plot_prior_posterior()
      • MCMCSearch.plot_cumulative_max()
      • MCMCSearch.get_saved_data_dictionary()
      • MCMCSearch.export_samples_to_disk()
      • MCMCSearch.get_max_twoF()
      • MCMCSearch.get_summary_stats()
      • MCMCSearch.check_if_samples_are_railing()
      • MCMCSearch.write_par()
      • MCMCSearch.generate_loudest()
      • MCMCSearch.write_prior_table()
      • MCMCSearch.print_summary()
      • MCMCSearch.get_p_value()
      • MCMCSearch.compute_evidence()
      • MCMCSearch.read_evidence_file_to_dict()
      • MCMCSearch.write_evidence_file_from_dict()
    • MCMCGlitchSearch
      • MCMCGlitchSearch.transform_dictionary
      • MCMCGlitchSearch.plot_cumulative_max()
    • MCMCSemiCoherentSearch
    • MCMCFollowUpSearch
      • MCMCFollowUpSearch.run()
      • MCMCFollowUpSearch.init_run_setup()
      • MCMCFollowUpSearch.read_setup_input_file()
    • MCMCTransientSearch
      • MCMCTransientSearch.transform_dictionary
  • pyfstat.optimal_setup_functions module
    • get_optimal_setup()
    • get_Nstar_estimate()
  • pyfstat.snr module
    • SignalToNoiseRatio
      • SignalToNoiseRatio.detector_states
      • SignalToNoiseRatio.noise_weights
      • SignalToNoiseRatio.assumeSqrtSX
      • SignalToNoiseRatio.from_sfts()
      • SignalToNoiseRatio.compute_snr2()
      • SignalToNoiseRatio.compute_h0_from_snr2()
      • SignalToNoiseRatio.compute_twoF()
      • SignalToNoiseRatio.compute_Mmunu()
    • DetectorStates
      • DetectorStates.get_multi_detector_states()
      • DetectorStates.get_multi_detector_states_from_sfts()
  • pyfstat.tcw_fstat_map_funcs module
    • pyTransientFstatMap
      • pyTransientFstatMap.F_mn
      • pyTransientFstatMap.maxF
      • pyTransientFstatMap.t0_ML
      • pyTransientFstatMap.tau_ML
      • pyTransientFstatMap.lnBtSG
      • pyTransientFstatMap.read_from_file()
      • pyTransientFstatMap.get_maxF_idx()
      • pyTransientFstatMap.get_lnBtSG()
      • pyTransientFstatMap.write_F_mn_to_file()
    • fstatmap_versions
    • init_transient_fstat_map_features()
    • call_compute_transient_fstat_map()
    • lalpulsar_compute_transient_fstat_map()
    • reshape_FstatAtomsVector()
    • pycuda_compute_transient_fstat_map()
    • pycuda_compute_transient_fstat_map_rect()
    • pycuda_compute_transient_fstat_map_exp()
  • Module contents