rail.plotting package

The rail.plotting sub-package collects a set of tools to make plots from the data generated by using the rail.projects tools.

Submodules

• rail.plotting.cat_data_holders module
  • RailCatTruthAndMagntiduesDataHolder
    • RailCatTruthAndMagntiduesDataHolder.config_options
    • RailCatTruthAndMagntiduesDataHolder.extractor_inputs
    • RailCatTruthAndMagntiduesDataHolder.generate_dataset_dict()
    • RailCatTruthAndMagntiduesDataHolder.get_extractor_inputs()
    • RailCatTruthAndMagntiduesDataHolder.output_type
• rail.plotting.cat_plotters module
  • CatPlotterColorsVsTruth
    • CatPlotterColorsVsTruth.config_options
    • CatPlotterColorsVsTruth.input_type
  • CatPlotterMagntidues
    • CatPlotterMagntidues.config_options
    • CatPlotterMagntidues.input_type
  • CatPlotterMagntiduesVsTruth
    • CatPlotterMagntiduesVsTruth.config_options
    • CatPlotterMagntiduesVsTruth.input_type
  • CatPlotterTruth
    • CatPlotterTruth.config_options
    • CatPlotterTruth.input_type
  • RailCatMagnitudesDataset
    • RailCatMagnitudesDataset.data_types
  • RailCatTruthAndMagnitudesDataset
    • RailCatTruthAndMagnitudesDataset.data_types
  • RailCatTruthDataset
    • RailCatTruthDataset.data_types
• rail.plotting.control module
  • clear()
  • extract_datasets()
  • load_yaml()
  • print_classes()
  • print_contents()
  • run()
  • write_yaml()
• rail.plotting.data_extraction_funcs module
  • extract_mag()
  • extract_magnitudes()
  • extract_multiple_z_point()
  • extract_z_pdf()
  • extract_z_point()
  • extract_z_true()
  • get_multi_pz_point_estimate_data()
  • get_pz_point_estimate_data()
  • get_tomo_bins_nz_estimate_data()
  • get_tomo_bins_true_nz_data()
  • get_ztrue_and_magntidues()
  • make_z_true_multi_z_point_dict()
  • make_z_true_z_point_dict()
• rail.plotting.dataset module
  • RailDataset
    • RailDataset.data_types
    • RailDataset.full_class_name()
    • RailDataset.sub_classes
    • RailDataset.validate_inputs()
• rail.plotting.dataset_factory module
  • RailDatasetFactory
    • RailDatasetFactory.add_dataset()
    • RailDatasetFactory.add_dataset_list()
    • RailDatasetFactory.add_project()
    • RailDatasetFactory.client_classes
    • RailDatasetFactory.dataset_lists
    • RailDatasetFactory.datasets
    • RailDatasetFactory.get_dataset()
    • RailDatasetFactory.get_dataset_list()
    • RailDatasetFactory.get_dataset_list_names()
    • RailDatasetFactory.get_dataset_lists()
    • RailDatasetFactory.get_dataset_names()
    • RailDatasetFactory.get_datasets()
    • RailDatasetFactory.get_project()
    • RailDatasetFactory.get_project_names()
    • RailDatasetFactory.get_projects()
    • RailDatasetFactory.load_object_from_yaml_tag()
    • RailDatasetFactory.projects
    • RailDatasetFactory.yaml_tag
• rail.plotting.dataset_holder module
  • DatasetSplitMode
    • DatasetSplitMode.by_algo
    • DatasetSplitMode.by_flavor
    • DatasetSplitMode.no_split
  • RailDatasetHolder
    • RailDatasetHolder.data
    • RailDatasetHolder.extractor_inputs
    • RailDatasetHolder.generate_dataset_dict()
    • RailDatasetHolder.get_extractor_inputs()
    • RailDatasetHolder.output_type
    • RailDatasetHolder.resolve()
    • RailDatasetHolder.set_data()
    • RailDatasetHolder.sub_classes
    • RailDatasetHolder.to_yaml_dict()
    • RailDatasetHolder.yaml_tag
  • RailDatasetListHolder
    • RailDatasetListHolder.config_options
    • RailDatasetListHolder.resolve()
    • RailDatasetListHolder.yaml_tag
  • RailProjectHolder
    • RailProjectHolder.config_options
    • RailProjectHolder.resolve()
    • RailProjectHolder.yaml_tag
• rail.plotting.nz_data_holders module
  • RailNZTomoBinsDataHolder
    • RailNZTomoBinsDataHolder.config_options
    • RailNZTomoBinsDataHolder.extractor_inputs
    • RailNZTomoBinsDataHolder.generate_dataset_dict()
    • RailNZTomoBinsDataHolder.get_extractor_inputs()
    • RailNZTomoBinsDataHolder.output_type
• rail.plotting.nz_plotters module
  • NZPlotterTomoBins
    • NZPlotterTomoBins.config_options
    • NZPlotterTomoBins.input_type
  • RailNZTomoBinsDataset
    • RailNZTomoBinsDataset.data_types
• rail.plotting.plot_group module
  • RailPlotGroup
    • RailPlotGroup.config_options
    • RailPlotGroup.dataset_list
    • RailPlotGroup.find_plot()
    • RailPlotGroup.find_plot_path()
    • RailPlotGroup.find_plots()
    • RailPlotGroup.jinja_env
    • RailPlotGroup.jinja_index_template
    • RailPlotGroup.jinja_template
    • RailPlotGroup.make_html()
    • RailPlotGroup.make_html_index()
    • RailPlotGroup.make_plots()
    • RailPlotGroup.plotter_list
    • RailPlotGroup.resolve()
    • RailPlotGroup.run()
    • RailPlotGroup.yaml_tag
• rail.plotting.plot_group_factory module
  • RailPlotGroupFactory
    • RailPlotGroupFactory.add_plot_group()
    • RailPlotGroupFactory.client_classes
    • RailPlotGroupFactory.get_plot_group()
    • RailPlotGroupFactory.get_plot_group_names()
    • RailPlotGroupFactory.get_plot_groups()
    • RailPlotGroupFactory.make_plot_groups()
    • RailPlotGroupFactory.make_plot_groups_instance()
    • RailPlotGroupFactory.make_yaml_for_dataset_list()
    • RailPlotGroupFactory.make_yaml_for_dataset_list_instance()
    • RailPlotGroupFactory.make_yaml_for_project()
    • RailPlotGroupFactory.make_yaml_for_project_instance()
    • RailPlotGroupFactory.plot_groups
    • RailPlotGroupFactory.yaml_tag
• rail.plotting.plot_holder module
  • RailPlotDict
    • RailPlotDict.name
    • RailPlotDict.plots
    • RailPlotDict.savefigs()
  • RailPlotHolder
    • RailPlotHolder.dataset_holder
    • RailPlotHolder.figure
    • RailPlotHolder.name
    • RailPlotHolder.path
    • RailPlotHolder.plotter
    • RailPlotHolder.savefig()
    • RailPlotHolder.set_figure()
    • RailPlotHolder.set_path()
• rail.plotting.plotter module
  • RailPlotter
    • RailPlotter.input_type
    • RailPlotter.iterate()
    • RailPlotter.iterate_plotters()
    • RailPlotter.run()
    • RailPlotter.sub_classes
    • RailPlotter.to_yaml_dict()
    • RailPlotter.write_plots()
    • RailPlotter.yaml_tag
  • RailPlotterList
    • RailPlotterList.config_options
    • RailPlotterList.resolve()
    • RailPlotterList.yaml_tag
• rail.plotting.plotter_factory module
  • RailPlotterFactory
    • RailPlotterFactory.add_plotter()
    • RailPlotterFactory.add_plotter_list()
    • RailPlotterFactory.client_classes
    • RailPlotterFactory.get_plotter()
    • RailPlotterFactory.get_plotter_list()
    • RailPlotterFactory.get_plotter_list_names()
    • RailPlotterFactory.get_plotter_lists()
    • RailPlotterFactory.get_plotter_names()
    • RailPlotterFactory.get_plotters()
    • RailPlotterFactory.load_object_from_yaml_tag()
    • RailPlotterFactory.plotter_lists
    • RailPlotterFactory.plotters
    • RailPlotterFactory.yaml_tag
• rail.plotting.plotting_functions module
  • get_subplot_nrow_ncol()
  • plot_colors_v_colors_with_templates()
  • plot_colors_v_redshifts_with_templates()
  • plot_feature_histograms()
  • plot_feature_target_hist2d()
  • plot_true_nz()
• rail.plotting.pz_data_holders module
  • RailPZMultiPointEstimateDataHolder
    • RailPZMultiPointEstimateDataHolder.config_options
    • RailPZMultiPointEstimateDataHolder.extractor_inputs
    • RailPZMultiPointEstimateDataHolder.get_extractor_inputs()
    • RailPZMultiPointEstimateDataHolder.output_type
  • RailPZPointEstimateDataHolder
    • RailPZPointEstimateDataHolder.config_options
    • RailPZPointEstimateDataHolder.extractor_inputs
    • RailPZPointEstimateDataHolder.generate_dataset_dict()
    • RailPZPointEstimateDataHolder.get_extractor_inputs()
    • RailPZPointEstimateDataHolder.output_type
• rail.plotting.pz_plotters module
  • PZPlotterAccuraciesVsTrue
    • PZPlotterAccuraciesVsTrue.config_options
    • PZPlotterAccuraciesVsTrue.input_type
  • PZPlotterBiweightStatsVsMag
    • PZPlotterBiweightStatsVsMag.config_options
    • PZPlotterBiweightStatsVsMag.input_type
    • PZPlotterBiweightStatsVsMag.process_data()
  • PZPlotterBiweightStatsVsRedshift
    • PZPlotterBiweightStatsVsRedshift.config_options
    • PZPlotterBiweightStatsVsRedshift.input_type
    • PZPlotterBiweightStatsVsRedshift.process_data()
  • PZPlotterPointEstimateVsTrueHist2D
    • PZPlotterPointEstimateVsTrueHist2D.config_options
    • PZPlotterPointEstimateVsTrueHist2D.get_biweight_mean_sigma_outlier()
    • PZPlotterPointEstimateVsTrueHist2D.input_type
  • PZPlotterPointEstimateVsTrueProfile
    • PZPlotterPointEstimateVsTrueProfile.config_options
    • PZPlotterPointEstimateVsTrueProfile.input_type
  • RailPZMultiPointEstimateDataset
    • RailPZMultiPointEstimateDataset.data_types
  • RailPZPointEstimateDataset
    • RailPZPointEstimateDataset.data_types
• rail.plotting.utility_functions module
  • adjacent_band_colors()
  • build_template_dict()
  • extract_data_to_2d_array()
  • get_band_values()
  • make_band_names()
• rail.plotting.validation module
  • validate_inputs()