Skip to main content
Ctrl+K

GWIAS-HM API 0.1.0 documentation

  • Getting Started
  • Installation and Environment
  • Tutorial Notebooks
  • Scientific Background and References
  • API Documentation
  • Getting Started
  • Installation and Environment
  • Tutorial Notebooks
  • Scientific Background and References
  • API Documentation

Section Navigation

  • API Tree
    • ML_modules
      • ML_modules.NeuralPosteriorEstimator
        • ML_modules.NeuralPosteriorEstimator.forward
        • ML_modules.NeuralPosteriorEstimator.loss
        • ML_modules.NeuralPosteriorEstimator.training_step
        • ML_modules.NeuralPosteriorEstimator.validation_step
        • ML_modules.NeuralPosteriorEstimator.configure_optimizers
        • ML_modules.NeuralPosteriorEstimator.generate_samples
        • ML_modules.NeuralPosteriorEstimator.load_from_path
      • ML_modules.Template_Prior_NF
        • ML_modules.Template_Prior_NF.loss
        • ML_modules.Template_Prior_NF.training_step
        • ML_modules.Template_Prior_NF.validation_step
        • ML_modules.Template_Prior_NF.configure_optimizers
        • ML_modules.Template_Prior_NF.log_prior
        • ML_modules.Template_Prior_NF.load_from_path
      • ML_modules.build_mlp
      • ML_modules.get_flow
    • coherent_score_hm_search
      • coherent_score_hm_search.SearchCoherentScoreHMAS
        • coherent_score_hm_search.SearchCoherentScoreHMAS.get_marginalization_info
        • coherent_score_hm_search.SearchCoherentScoreHMAS.lnlike_marginalized
      • coherent_score_hm_search.compute_coherent_scores
      • coherent_score_hm_search.compute_coherent_scores_new
      • coherent_score_hm_search.create_mode_ratios_qm_subbank
      • coherent_score_hm_search.create_mode_ratios_qm_subbank_new
      • coherent_score_hm_search.initialize_cs_instance
    • coherent_score_mz_fast
      • coherent_score_mz_fast.CoherentScoreMZ
        • coherent_score_mz_fast.CoherentScoreMZ.from_new_samples
        • coherent_score_mz_fast.CoherentScoreMZ.save_samples
        • coherent_score_mz_fast.CoherentScoreMZ.gen_t3_norm
        • coherent_score_mz_fast.CoherentScoreMZ.dt_dict
        • coherent_score_mz_fast.CoherentScoreMZ.get_all_prior_terms
        • coherent_score_mz_fast.CoherentScoreMZ.trigger2comblist
        • coherent_score_mz_fast.CoherentScoreMZ.comblist2cs
        • coherent_score_mz_fast.CoherentScoreMZ.get_params
      • coherent_score_mz_fast.coherent_score_montecarlo_sky
      • coherent_score_mz_fast.create_samples
      • coherent_score_mz_fast.create_time_dict
      • coherent_score_mz_fast.delays
      • coherent_score_mz_fast.dt2key
      • coherent_score_mz_fast.gen_sample_amps_from_fplus_fcross
      • coherent_score_mz_fast.lg_approx
      • coherent_score_mz_fast.lg_fast
      • coherent_score_mz_fast.lgg
      • coherent_score_mz_fast.marg_lk
      • coherent_score_mz_fast.phase_lags
      • coherent_score_mz_fast.rand_choice_nb
    • coincidence_HM
      • coincidence_HM.collect_all_candidate_files_npy
      • coincidence_HM.collect_all_candidate_files_npz
      • coincidence_HM.collect_background_candidates
      • coincidence_HM.collect_files
      • coincidence_HM.collect_files_npz
      • coincidence_HM.combine_files
      • coincidence_HM.combine_files_npz
      • coincidence_HM.create_candidate_output_dir_name
      • coincidence_HM.create_shifted_observations
      • coincidence_HM.find_friends_in_cloud
      • coincidence_HM.find_interesting_dir
      • coincidence_HM.find_interesting_dir_cluster
      • coincidence_HM.fish_in_weaker_detector
      • coincidence_HM.fit_step_veto
      • coincidence_HM.flag_duplicates_per_group_pair
      • coincidence_HM.get_best_candidate_segments
      • coincidence_HM.get_files_with_glitches
      • coincidence_HM.get_friends_arr
      • coincidence_HM.get_histogram_stats
      • coincidence_HM.group_by_id
      • coincidence_HM.inds_into_before
      • coincidence_HM.load_trigger_file
      • coincidence_HM.main
      • coincidence_HM.mypad
      • coincidence_HM.pick_lists
      • coincidence_HM.read_channel_dict
      • coincidence_HM.remove_bad_times
      • coincidence_HM.restart_run_from_json
      • coincidence_HM.secondary_peak_reject
      • coincidence_HM.select_optimal_trigger_pairs
      • coincidence_HM.stringent_veto
      • coincidence_HM.track_job
      • coincidence_HM.veto_and_optimize_coincidence_list
      • coincidence_HM.veto_and_optimize_group
      • coincidence_HM.veto_and_optimize_single_detector
      • coincidence_HM.veto_orthogonal_step
    • data_operations
      • data_operations.asd_func
      • data_operations.band_eraser
      • data_operations.calculate_excess_power
      • data_operations.calculate_sine_gaussian_overlaps
      • data_operations.chunkedfft
      • data_operations.data_to_asdfunc
      • data_operations.define_crude_line_mask
      • data_operations.define_crude_line_mask_v2
      • data_operations.fill_hole_consecutive
      • data_operations.fill_holes_bruteforce
      • data_operations.fill_holes_file
      • data_operations.fill_holes_segment
      • data_operations.find_excess_power_transients
      • data_operations.find_sine_gaussian_transients
      • data_operations.find_whitened_outliers
      • data_operations.gen_whitened_notched_strain
      • data_operations.loaddata
      • data_operations.makeasdplots
      • data_operations.median_bias
      • data_operations.norm_matched_filter_overlap
      • data_operations.overlap_save
      • data_operations.process_data
      • data_operations.robust_power_filter
      • data_operations.scipy_12_welch
      • data_operations.specgram_quality
      • data_operations.update_masks
    • download_data
      • download_data.download_all_files
      • download_data.gen_url_list
      • download_data.get_url_list
      • download_data.get_url_list_new
    • gw_detect_file
      • gw_detect_file.main
    • params
    • python_utils
      • python_utils.abbar
      • python_utils.abs2
      • python_utils.abs2sum
      • python_utils.archive_paths
      • python_utils.argmax_lastax
      • python_utils.argmaxnd
      • python_utils.check_equal
      • python_utils.flat_in_log
      • python_utils.fmt
      • python_utils.import_matplotlib
      • python_utils.invert_dict
      • python_utils.is_numpy_float
      • python_utils.is_numpy_int
      • python_utils.load_module
      • python_utils.load_symmetrix_matrix
      • python_utils.merge_dicts_safely
      • python_utils.next_power
      • python_utils.nfft_of_rfft
      • python_utils.nfft_of_rfftlen
      • python_utils.npy_append_cols
      • python_utils.npy_append_rows
      • python_utils.printarr
      • python_utils.rand_azim
      • python_utils.rand_cos
      • python_utils.rand_polar
      • python_utils.rfftlen_of_nfft
      • python_utils.store_symmetrix_matrix
      • python_utils.tukwin_back
      • python_utils.tukwin_bandpass
      • python_utils.tukwin_front
      • python_utils.tukwin_npts
      • python_utils.zeropad_end
      • python_utils.zip_to_array
    • ranking_HM
      • ranking_HM.Rank
        • ranking_HM.Rank.from_pickle
        • ranking_HM.Rank.to_pickle
        • ranking_HM.Rank.to_hdf5
        • ranking_HM.Rank.from_hdf5
        • ranking_HM.Rank.from_hdf5_static
        • ranking_HM.Rank.create_coh_score_instance
        • ranking_HM.Rank.reform_scores_lists
        • ranking_HM.Rank.compute_function_on_subbank_data
        • ranking_HM.Rank.score_bg_fg_lists
        • ranking_HM.Rank.rank_scores_calc
        • ranking_HM.Rank.compute_fars_rank_score
        • ranking_HM.Rank.compute_fars_coherent_score
        • ranking_HM.Rank.avg_sensitive_volume
        • ranking_HM.Rank.rank_scores_calc_MZ
      • ranking_HM.add_or_vstack_to_dic
      • ranking_HM.add_to_bg_and_fg_dicts
      • ranking_HM.apply_vetos
      • ranking_HM.apply_vetos_det
      • ranking_HM.check_and_fix_bg_fg_lists
      • ranking_HM.collect_all_subbanks
      • ranking_HM.combine_subbank_dict
      • ranking_HM.compute_coherent_scores
      • ranking_HM.correct_snr2sumcut_safe
      • ranking_HM.generate_downsampling_correction_fits
      • ranking_HM.get_params
      • ranking_HM.maximization_info_from_pclists
      • ranking_HM.maximize_over_banks
      • ranking_HM.maximize_over_groups
      • ranking_HM.maximize_using_saved_options
      • ranking_HM.offset_background
      • ranking_HM.parabolic_func
      • ranking_HM.pick_mask
      • ranking_HM.print_top_cand_list
      • ranking_HM.reform_coherent_scores
      • ranking_HM.split_into_subbank_dicts
      • ranking_HM.veto_rank_entry
      • ranking_HM.veto_rank_entry_wrapper
      • ranking_HM.veto_subthreshold_top_cands
    • readligo
      • readligo.FileList
        • readligo.FileList.searchdir
        • readligo.FileList.writecache
        • readligo.FileList.readcache
        • readligo.FileList.findfile
      • readligo.SegmentList
      • readligo.dq2segs
      • readligo.dq_channel_to_seglist
      • readligo.getsegs
      • readligo.getstrain
      • readligo.loaddata
      • readligo.read_frame
      • readligo.read_hdf5
    • template_bank_generator_HM
      • template_bank_generator_HM.MultiBank
        • template_bank_generator_HM.MultiBank.from_json
        • template_bank_generator_HM.MultiBank.ntemplates
      • template_bank_generator_HM.TemplateBank
        • template_bank_generator_HM.TemplateBank.from_json
        • template_bank_generator_HM.TemplateBank.gen_amps_from_calpha
        • template_bank_generator_HM.TemplateBank.gen_phases_from_calpha
        • template_bank_generator_HM.TemplateBank.get_linear_free_shift_from_wf_fd
        • template_bank_generator_HM.TemplateBank.get_linear_free_shift_from_pars
        • template_bank_generator_HM.TemplateBank.get_linear_free_shift_from_calpha
        • template_bank_generator_HM.TemplateBank.gen_wf_td_from_pars
        • template_bank_generator_HM.TemplateBank.gen_wf_fd_from_pars
        • template_bank_generator_HM.TemplateBank.gen_wfs_td_from_fd
        • template_bank_generator_HM.TemplateBank.gen_wfs_fd_from_calpha
        • template_bank_generator_HM.TemplateBank.gen_wfs_td_from_calpha
        • template_bank_generator_HM.TemplateBank.orthogonalize_wfs
        • template_bank_generator_HM.TemplateBank.get_waveform_conditioning
        • template_bank_generator_HM.TemplateBank.set_waveform_conditioning
        • template_bank_generator_HM.TemplateBank.gen_whitened_wfs_td
        • template_bank_generator_HM.TemplateBank.gen_boundary_whitened_wfs_td
        • template_bank_generator_HM.TemplateBank.split_whitened_wf_td
        • template_bank_generator_HM.TemplateBank.wt_waveform_generator
        • template_bank_generator_HM.TemplateBank.grid_range
        • template_bank_generator_HM.TemplateBank.make_grid_axes
        • template_bank_generator_HM.TemplateBank.define_important_grid
        • template_bank_generator_HM.TemplateBank.ntemplates
        • template_bank_generator_HM.TemplateBank.get_grid_index
        • template_bank_generator_HM.TemplateBank.remove_nonphysical_templates_JR
        • template_bank_generator_HM.TemplateBank.remove_nonphysical_templates
        • template_bank_generator_HM.TemplateBank.get_coeff_grid
        • template_bank_generator_HM.TemplateBank.gen_physical_grid
        • template_bank_generator_HM.TemplateBank.is_physical
        • template_bank_generator_HM.TemplateBank.optimize_calpha
        • template_bank_generator_HM.TemplateBank.closest_coeff
        • template_bank_generator_HM.TemplateBank.test_effectualness
        • template_bank_generator_HM.TemplateBank.def_relative_bins
        • template_bank_generator_HM.TemplateBank.marginalized_HM_scores_incl_temp_prior
        • template_bank_generator_HM.TemplateBank.marginalized_HM_scores
        • template_bank_generator_HM.TemplateBank.get_approximate_params
        • template_bank_generator_HM.TemplateBank.transform_pars
        • template_bank_generator_HM.TemplateBank.gen_random_wfs_td
        • template_bank_generator_HM.TemplateBank.gen_snr_degrade_dt
        • template_bank_generator_HM.TemplateBank.gen_phase_mismatch
      • template_bank_generator_HM.compute_hplus_hcross
      • template_bank_generator_HM.compute_overlap
      • template_bank_generator_HM.compute_snr_efficiency
      • template_bank_generator_HM.gen_random_pars
      • template_bank_generator_HM.gen_waveform
      • template_bank_generator_HM.get_df
      • template_bank_generator_HM.get_efficient_frequencies
      • template_bank_generator_HM.get_prior_interp_func
      • template_bank_generator_HM.remove_linear_component
      • template_bank_generator_HM.summarize_prior
      • template_bank_generator_HM.summarize_prior_single_subbank
      • template_bank_generator_HM.transform_basis
      • template_bank_generator_HM.transform_pars
      • template_bank_generator_HM.upsample_lwfs
    • template_bank_params_O3a_HM
    • triggering_on_cluster
      • triggering_on_cluster.check_file
      • triggering_on_cluster.check_files_server
      • triggering_on_cluster.clean_file
      • triggering_on_cluster.create_trig_dir_name
      • triggering_on_cluster.filelist
      • triggering_on_cluster.finish_checks
      • triggering_on_cluster.get_problematic
      • triggering_on_cluster.get_strain_filelist
      • triggering_on_cluster.inspect_completion
      • triggering_on_cluster.submit_files_helios
      • triggering_on_cluster.submit_files_hyperion
      • triggering_on_cluster.submit_files_typhon
      • triggering_on_cluster.submit_files_wexac
      • triggering_on_cluster.submit_multibanks
    • triggers_single_detector_HM
      • triggers_single_detector_HM.TriggerList
        • triggers_single_detector_HM.TriggerList.empty_init
        • triggers_single_detector_HM.TriggerList.from_json
        • triggers_single_detector_HM.TriggerList.from_gwosc
        • triggers_single_detector_HM.TriggerList.load_data_from_preprocessing
        • triggers_single_detector_HM.TriggerList.to_json
        • triggers_single_detector_HM.TriggerList.save_preprocessing
        • triggers_single_detector_HM.TriggerList.save_candidatelist
        • triggers_single_detector_HM.TriggerList.safe_set_waveform_conditioning
        • triggers_single_detector_HM.TriggerList.pack_trigs
        • triggers_single_detector_HM.TriggerList.unpack_trigs
        • triggers_single_detector_HM.TriggerList.inject_wf_into_data
        • triggers_single_detector_HM.TriggerList.get_glitch_thresholds
        • triggers_single_detector_HM.TriggerList.hole_snr_correction
        • triggers_single_detector_HM.TriggerList.gen_psd_drift_correction
        • triggers_single_detector_HM.TriggerList.prepare_for_triggers
        • triggers_single_detector_HM.TriggerList.prepare_subset_for_triggers
        • triggers_single_detector_HM.TriggerList.scores_wf
        • triggers_single_detector_HM.TriggerList.gen_scores
        • triggers_single_detector_HM.TriggerList.gen_overlaps
        • triggers_single_detector_HM.TriggerList.process_clist
        • triggers_single_detector_HM.TriggerList.filter_with_wf
        • triggers_single_detector_HM.TriggerList.gen_triggers
        • triggers_single_detector_HM.TriggerList.get_bad_times
        • triggers_single_detector_HM.TriggerList.get_time_index
        • triggers_single_detector_HM.TriggerList.prepare_subset_for_vetoes
        • triggers_single_detector_HM.TriggerList.get_bestfit_wf
        • triggers_single_detector_HM.TriggerList.finer_psd_drift
        • triggers_single_detector_HM.TriggerList.veto_trigger_power
        • triggers_single_detector_HM.TriggerList.veto_trigger_phase
        • triggers_single_detector_HM.TriggerList.veto_trigger_all
        • triggers_single_detector_HM.TriggerList.prepare_subset_for_optimization
        • triggers_single_detector_HM.TriggerList.define_finer_grid_func
        • triggers_single_detector_HM.TriggerList.prepare_summary_stats
        • triggers_single_detector_HM.TriggerList.gen_triggers_local
        • triggers_single_detector_HM.TriggerList.gen_triggers_local_pars
        • triggers_single_detector_HM.TriggerList.filter_triggers
        • triggers_single_detector_HM.TriggerList.clip_outliers
        • triggers_single_detector_HM.TriggerList.clear_filter
        • triggers_single_detector_HM.TriggerList.filter_processed_clist
        • triggers_single_detector_HM.TriggerList.remove_loud_times
        • triggers_single_detector_HM.TriggerList.specgram
        • triggers_single_detector_HM.TriggerList.plot_teststat_hist
        • triggers_single_detector_HM.TriggerList.plot_time_hist
        • triggers_single_detector_HM.TriggerList.plot_triggers_corner
        • triggers_single_detector_HM.TriggerList.plot_running_hist
        • triggers_single_detector_HM.TriggerList.plot_bestfit_waveform
      • triggers_single_detector_HM.ensure_abspath
    • utils
      • utils.CustomDefaultdict
      • utils.CustomHDF5File
      • utils.CustomHDF5Group
        • utils.CustomHDF5Group.create_custom_group
      • utils.EditableHDF5Dataset
        • utils.EditableHDF5Dataset.return_scalar
      • utils.HDF5DatasetSubset
      • utils.NumpyEncoder
        • utils.NumpyEncoder.np_out_hook
        • utils.NumpyEncoder.np_in_hook
        • utils.NumpyEncoder.default
      • utils.TupleEncoder
        • utils.TupleEncoder.tuple_out_hook
        • utils.TupleEncoder.tuple_in_hook
        • utils.TupleEncoder.encode
      • utils.A_lm_halfinclin
      • utils.A_lm_inclin
      • utils.amend_indices
      • utils.asdf_fromfile
      • utils.band_filter
      • utils.before_write_save_old
      • utils.bincent
      • utils.bool2int
      • utils.change_filter_times_fd
      • utils.change_filter_times_td
      • utils.change_wf_fd_grid
      • utils.checkempty
      • utils.close_hdf5
      • utils.coherent_score
      • utils.colorbar
      • utils.condition_filter
      • utils.condition_filter_td
      • utils.create_chirp_mass_directory_dict
      • utils.define_coarser_mask
      • utils.delete_hdf5_datasets
      • utils.env_init_lines
      • utils.extract_filename
      • utils.extract_parts
      • utils.find_closest_coarse_calphas
      • utils.gen_step_fd
      • utils.get_coincident_json_filelist
      • utils.get_detector_fnames
      • utils.get_dirs
      • utils.get_dtype
      • utils.get_evname_from_tgps
      • utils.get_gwf_channel_names
      • utils.get_hdf5_file
      • utils.get_HL_filenames
      • utils.get_injection_details
      • utils.get_json_fname
      • utils.get_left_right_fnames
      • utils.get_lsc_event_times
      • utils.get_O3_lsc_pe_samples
      • utils.get_root_dirs
      • utils.get_run
      • utils.get_spectrum
      • utils.get_strain_fnames
      • utils.get_tgps_from_evname
      • utils.handle_missing_run
      • utils.hilbert_transform
      • utils.hole_edges
      • utils.hole_edges_to_mask
      • utils.incoherent_score
      • utils.index_after_removal
      • utils.index_limits
      • utils.interpolate_asd
      • utils.interpolate_wf_fd
      • utils.is_close_to
      • utils.is_in_run
      • utils.is_LIGO_valid
      • utils.is_LIGO_valid_between
      • utils.is_within
      • utils.load_dict_from_hdf5_attrs
      • utils.load_pesummary_io
      • utils.m1_m2_mt
      • utils.m1_m2_s1_s2_to_chieff_chia
      • utils.make_LIGO_mask
      • utils.make_template_ids
      • utils.make_trigger_ids
      • utils.mass_conversion
      • utils.match
      • utils.mmap_h5
      • utils.multiprocessing
      • utils.notch_filter
      • utils.notch_filter_sos
      • utils.offset_background
      • utils.orthogonalize_split
      • utils.pars_from_pars
      • utils.plot_veto_details
      • utils.populate_magic_methods
      • utils.preprocess_wildcards
      • utils.q_and_eta
      • utils.read_hdf5_node
      • utils.remove_bad_times
      • utils.remove_old_versions
      • utils.rm_suffix
      • utils.s1z_s2z_chieff_chia_from_pars
      • utils.safe_concatenate
      • utils.safelen
      • utils.save_dict_to_hdf5_attrs
      • utils.scalar
      • utils.sigma_from_median
      • utils.sinc_interp_by_factor_of_2
      • utils.sinc_interp_x2D
      • utils.sine_gaussian
      • utils.splitarray
      • utils.standardize_run_name
      • utils.submask
      • utils.threshold_rv
      • utils.track_job
      • utils.unbias_split
      • utils.write_hdf5_node
      • utils.Y_lm
      • utils.Y_lm_halfinclin
  • Full API Directory
  • API Documentation
  • API Tree
  • ML_modules
  • ML_modules.Template_Prior_NF

ML_modules.Template_Prior_NF#

Back to Module page

Summary#

param:

Methods#

Method

Summary

loss

No docstring summary available.

training_step

No docstring summary available.

validation_step

No docstring summary available.

configure_optimizers

No docstring summary available.

log_prior

Compute the prior of the calpha templates.

load_from_path

No docstring summary available.

Class docstring#

param:

previous

ML_modules.NeuralPosteriorEstimator.load_from_path

next

ML_modules.Template_Prior_NF.loss

On this page
  • Summary
  • Class docstring

This Page

  • Show Source

© Copyright 2026, GWIAS-HM contributors.

Created using Sphinx 9.0.4.

Built with the PyData Sphinx Theme 0.16.1.