Interactive

The rail.interactive module provides a set of functions that act as replacements for the class-based system of running RAIL, which is now primarily used for Pipeline Mode.

These functions are generated at runtime from the RailStage classes and therefore do not have viewable source code.

The docstrings given below are created from the RailStage classes and their primary method (called the entrypoint function), and can be seen by users by inspecting the function objects.

They are updated along with pz-rail-base, but the content of them is generated from the algorithm packages, using the versions that were available when this documentation was generated. Therefore, if your installed version of pz-rail-base differs from the current version, this documentation may not match the docstrings available on your machine.

• rail.interactive.creation namespace
  • rail.interactive.creation.degraders namespace
    • rail.interactive.creation.degraders.addRandom module
      • add_column_of_random()
    • rail.interactive.creation.degraders.desi_selector_phy module
      • spec_selection_desi_phy()
    • rail.interactive.creation.degraders.grid_selection module
      • grid_selection()
    • rail.interactive.creation.degraders.observing_condition_degrader module
      • obs_condition()
    • rail.interactive.creation.degraders.photometric_errors module
      • euclid_deep_error_model()
      • euclid_error_model()
      • euclid_wide_error_model()
      • lsst_error_model()
      • photo_error_model()
      • roman_deep_error_model()
      • roman_error_model()
      • roman_medium_error_model()
      • roman_ultra_deep_error_model()
      • roman_wide_error_model()
    • rail.interactive.creation.degraders.quantityCut module
      • quantity_cut()
    • rail.interactive.creation.degraders.spectroscopic_degraders module
      • inv_redshift_incompleteness()
      • line_confusion()
    • rail.interactive.creation.degraders.spectroscopic_selections module
      • spec_selection()
      • spec_selection_BOSS()
      • spec_selection_DEEP2()
      • spec_selection_DEEP2_LSST()
      • spec_selection_DESI_BGS()
      • spec_selection_DESI_LRG()
      • spec_selection_ELG_LOP()
      • spec_selection_GAMA()
      • spec_selection_HSC()
      • spec_selection_VVDSf02()
      • spec_selection_zCOSMOS()
    • rail.interactive.creation.degraders.specz_som module
      • som_spec_selector()
    • rail.interactive.creation.degraders.unrec_bl_model module
      • unrec_bl_model()
  • rail.interactive.creation.engines namespace
    • rail.interactive.creation.engines.dsps_photometry_creator module
      • dsps_photometry_creator()
    • rail.interactive.creation.engines.dsps_sed_modeler module
      • dsps_population_sed_modeler()
      • dsps_single_sed_modeler()
    • rail.interactive.creation.engines.flowEngine module
      • flow_creator()
      • flow_modeler()
      • flow_posterior()
    • rail.interactive.creation.engines.fsps_photometry_creator module
      • fsps_photometry_creator()
    • rail.interactive.creation.engines.fsps_sed_modeler module
      • fsps_sed_modeler()
• rail.interactive.estimation namespace
  • rail.interactive.estimation.algos namespace
    • rail.interactive.estimation.algos.bpz_lite module
      • bpz_lite_estimator()
      • bpz_lite_informer()
    • rail.interactive.estimation.algos.cc_yaw module
      • yaw_auto_correlate()
      • yaw_cache_create()
      • yaw_cross_correlate()
      • yaw_summarize()
    • rail.interactive.estimation.algos.cmnn module
      • cmnn_estimator()
      • cmnn_informer()
    • rail.interactive.estimation.algos.dnf module
      • dnf_estimator()
      • dnf_informer()
    • rail.interactive.estimation.algos.equal_count module
      • equal_count_classifier()
    • rail.interactive.estimation.algos.flexzboost module
      • flex_z_boost_estimator()
      • flex_z_boost_informer()
    • rail.interactive.estimation.algos.gpz module
      • gpz_estimator()
      • gpz_informer()
    • rail.interactive.estimation.algos.k_nearneigh module
      • k_near_neigh_estimator()
      • k_near_neigh_informer()
    • rail.interactive.estimation.algos.lephare module
      • lephare_estimator()
      • lephare_informer()
    • rail.interactive.estimation.algos.minisom_som module
      • mini_som_informer()
      • mini_som_summarizer()
    • rail.interactive.estimation.algos.naive_stack module
      • naive_stack_informer()
      • naive_stack_masked_summarizer()
      • naive_stack_summarizer()
    • rail.interactive.estimation.algos.nz_dir module
      • nz_dir_informer()
      • nz_dir_summarizer()
    • rail.interactive.estimation.algos.point_est_hist module
      • point_est_hist_informer()
      • point_est_hist_masked_summarizer()
      • point_est_hist_summarizer()
    • rail.interactive.estimation.algos.pzflow_nf module
      • pz_flow_estimator()
      • pz_flow_informer()
    • rail.interactive.estimation.algos.random_forest module
      • random_forest_classifier()
      • random_forest_informer()
    • rail.interactive.estimation.algos.random_gauss module
      • random_gauss_estimator()
      • random_gauss_informer()
    • rail.interactive.estimation.algos.sklearn_neurnet module
      • skl_neur_net_estimator()
      • skl_neur_net_informer()
    • rail.interactive.estimation.algos.somoclu_som module
      • somoclu_informer()
      • somoclu_summarizer()
    • rail.interactive.estimation.algos.train_z module
      • train_z_estimator()
      • train_z_informer()
    • rail.interactive.estimation.algos.true_nz module
      • true_nz_histogrammer()
    • rail.interactive.estimation.algos.uniform_binning module
      • uniform_binning_classifier()
    • rail.interactive.estimation.algos.var_inf module
      • var_inf_stack_informer()
      • var_inf_stack_summarizer()
• rail.interactive.evaluation namespace
  • rail.interactive.evaluation.dist_to_dist_evaluator module
    • dist_to_dist_evaluator()
  • rail.interactive.evaluation.dist_to_point_evaluator module
    • dist_to_point_evaluator()
  • rail.interactive.evaluation.evaluator module
    • old_evaluator()
  • rail.interactive.evaluation.point_to_point_evaluator module
    • point_to_point_binned_evaluator()
    • point_to_point_evaluator()
  • rail.interactive.evaluation.single_evaluator module
    • single_evaluator()
• rail.interactive.tools namespace
  • rail.interactive.tools.photometry_tools module
    • dereddener()
    • dust_map_base()
    • hyperbolic_magnitudes()
    • hyperbolic_smoothing()
    • lsst_flux_to_mag_converter()
    • reddener()
  • rail.interactive.tools.table_tools module
    • column_mapper()
    • row_selector()
    • table_converter()