API Documentation

Information on specific functions, classes, and methods.

• rail.core package
  • find_version()
  • Submodules
    • rail.core.algo_utils module
      • one_algo()
    • rail.core.common_params module
      • copy_param()
      • set_param_default()
      • set_param_defaults()
    • rail.core.data module
      • DATA_STORE()
      • DataHandle
        • DataHandle.close()
        • DataHandle.finalize_write()
        • DataHandle.has_data
        • DataHandle.has_path
        • DataHandle.initialize_write()
        • DataHandle.is_written
        • DataHandle.iterator()
        • DataHandle.make_name()
        • DataHandle.open()
        • DataHandle.read()
        • DataHandle.set_data()
        • DataHandle.size()
        • DataHandle.suffix
        • DataHandle.write()
        • DataHandle.write_chunk()
      • DataStore
        • DataStore.add_data()
        • DataStore.allow_overwrite
        • DataStore.open()
        • DataStore.read()
        • DataStore.read_file()
        • DataStore.write()
        • DataStore.write_all()
      • FitsHandle
        • FitsHandle.suffix
      • FlowDict
        • FlowDict.read()
      • FlowHandle
        • FlowHandle.flow_factory
        • FlowHandle.suffix
      • Hdf5Handle
        • Hdf5Handle.suffix
      • ModelDict
        • ModelDict.open()
        • ModelDict.read()
        • ModelDict.write()
      • ModelHandle
        • ModelHandle.model_factory
        • ModelHandle.suffix
      • PqHandle
        • PqHandle.suffix
      • QPHandle
        • QPHandle.suffix
      • TableHandle
        • TableHandle.suffix
      • default_model_read()
      • default_model_write()
    • rail.core.introspection module
      • RailEnv
        • RailEnv.BASE_STAGES
        • RailEnv.MODULE_DICT
        • RailEnv.MODULE_PATH_DICT
        • RailEnv.NAMESPACE_MODULE_DICT
        • RailEnv.NAMESPACE_PATH_DICT
        • RailEnv.PACKAGES
        • RailEnv.STAGE_DICT
        • RailEnv.TREE
        • RailEnv.attach_stages()
        • RailEnv.build_rail_namespace_tree()
        • RailEnv.do_api_rst()
        • RailEnv.do_namespace_api_rst()
        • RailEnv.do_pkg_api_rst()
        • RailEnv.import_all_packages()
        • RailEnv.list_rail_modules()
        • RailEnv.list_rail_namespaces()
        • RailEnv.list_rail_packages()
        • RailEnv.pretty_print_tree()
        • RailEnv.print_rail_modules()
        • RailEnv.print_rail_namespace_tree()
        • RailEnv.print_rail_namespaces()
        • RailEnv.print_rail_packages()
        • RailEnv.print_rail_stage_dict()
    • rail.core.stage module
      • RailPipeline
      • RailStage
        • RailStage.add_data()
        • RailStage.add_handle()
        • RailStage.build()
        • RailStage.config_options
        • RailStage.connect_input()
        • RailStage.get_data()
        • RailStage.get_handle()
        • RailStage.input_iterator()
        • RailStage.make_and_connect()
        • RailStage.name
        • RailStage.set_data()
      • RailStageBuild
        • RailStageBuild.build()
      • StageIO
    • rail.core.utilPhotometry module
      • HyperbolicMagnitudes
        • HyperbolicMagnitudes.compute()
        • HyperbolicMagnitudes.config_options
        • HyperbolicMagnitudes.inputs
        • HyperbolicMagnitudes.name
        • HyperbolicMagnitudes.outputs
        • HyperbolicMagnitudes.run()
      • HyperbolicSmoothing
        • HyperbolicSmoothing.compute()
        • HyperbolicSmoothing.config_options
        • HyperbolicSmoothing.inputs
        • HyperbolicSmoothing.name
        • HyperbolicSmoothing.outputs
        • HyperbolicSmoothing.run()
      • PhotormetryManipulator
        • PhotormetryManipulator.compute()
        • PhotormetryManipulator.config_options
        • PhotormetryManipulator.get_as_fluxes()
        • PhotormetryManipulator.inputs
        • PhotormetryManipulator.name
        • PhotormetryManipulator.outputs
        • PhotormetryManipulator.run()
    • rail.core.utilStages module
      • ColumnMapper
        • ColumnMapper.config_options
        • ColumnMapper.inputs
        • ColumnMapper.name
        • ColumnMapper.outputs
        • ColumnMapper.run()
      • Dereddener
        • Dereddener.config_options
        • Dereddener.fetch_map()
        • Dereddener.inputs
        • Dereddener.name
        • Dereddener.outputs
        • Dereddener.run()
      • LSSTFluxToMagConverter
        • LSSTFluxToMagConverter.config_options
        • LSSTFluxToMagConverter.inputs
        • LSSTFluxToMagConverter.mag_conv
        • LSSTFluxToMagConverter.name
        • LSSTFluxToMagConverter.outputs
        • LSSTFluxToMagConverter.run()
      • RowSelector
        • RowSelector.config_options
        • RowSelector.inputs
        • RowSelector.name
        • RowSelector.outputs
        • RowSelector.run()
      • TableConverter
        • TableConverter.config_options
        • TableConverter.inputs
        • TableConverter.name
        • TableConverter.outputs
        • TableConverter.run()
    • rail.core.utils module
• evaluation namespace
  • Subpackages
    • evaluation.metrics namespace
      • Subpackages
      • Submodules
        • rail.evaluation.metrics.base module
          • MetricEvaluator
            • MetricEvaluator.evaluate()
        • rail.evaluation.metrics.brier module
          • Brier
            • Brier.evaluate()
        • rail.evaluation.metrics.cdeloss module
          • CDELoss
            • CDELoss.evaluate()
        • rail.evaluation.metrics.pit module
          • PIT
            • PIT.evaluate()
            • PIT.pit_samps
          • PITAD
            • PITAD.evaluate()
          • PITCvM
            • PITCvM.evaluate()
          • PITKS
            • PITKS.evaluate()
          • PITMeta
            • PITMeta.evaluate()
          • PITMetaMetric()
          • PITOutRate
            • PITOutRate.evaluate()
        • rail.evaluation.metrics.pointestimates module
          • PointBias
            • PointBias.evaluate()
          • PointOutlierRate
            • PointOutlierRate.evaluate()
          • PointSigmaIQR
            • PointSigmaIQR.evaluate()
          • PointSigmaMAD
            • PointSigmaMAD.evaluate()
          • PointStatsEz
            • PointStatsEz.evaluate()
  • Submodules
    • rail.evaluation.evaluator module
      • Evaluator
        • Evaluator.config_options
        • Evaluator.evaluate()
        • Evaluator.inputs
        • Evaluator.name
        • Evaluator.outputs
        • Evaluator.run()
    • rail.evaluation.utils module
      • stat_and_pval
        • stat_and_pval.p_value
        • stat_and_pval.statistic
      • stat_crit_sig
        • stat_crit_sig.critical_values
        • stat_crit_sig.significance_level
        • stat_crit_sig.statistic
• rail.hub package
  • Submodules
• creation namespace
  • Subpackages
    • creation.degradation namespace
      • Subpackages
      • Submodules
        • rail.creation.degradation.grid_selection module
          • GridSelection
            • GridSelection.config_options
            • GridSelection.def_ratio_file
            • GridSelection.def_set_file
            • GridSelection.name
            • GridSelection.run()
        • rail.creation.degradation.lsst_error_model module
          • LSSTErrorModel
            • LSSTErrorModel.config_options
            • LSSTErrorModel.get_limiting_mags()
            • LSSTErrorModel.name
            • LSSTErrorModel.run()
        • rail.creation.degradation.observing_condition_degrader module
          • ObsCondition
            • ObsCondition.assign_pixels()
            • ObsCondition.config_options
            • ObsCondition.get_pixel_conditions()
            • ObsCondition.name
            • ObsCondition.run()
        • rail.creation.degradation.quantityCut module
          • QuantityCut
            • QuantityCut.config_options
            • QuantityCut.name
            • QuantityCut.run()
            • QuantityCut.set_cuts()
        • rail.creation.degradation.spectroscopic_degraders module
          • InvRedshiftIncompleteness
            • InvRedshiftIncompleteness.config_options
            • InvRedshiftIncompleteness.name
            • InvRedshiftIncompleteness.run()
          • LineConfusion
            • LineConfusion.config_options
            • LineConfusion.name
            • LineConfusion.run()
        • rail.creation.degradation.spectroscopic_selections module
          • SpecSelection
            • SpecSelection.config_options
            • SpecSelection.downsampling_N_tot()
            • SpecSelection.invalid_cut()
            • SpecSelection.name
            • SpecSelection.run()
            • SpecSelection.selection()
            • SpecSelection.validate_colnames()
          • SpecSelection_BOSS
            • SpecSelection_BOSS.name
            • SpecSelection_BOSS.selection()
          • SpecSelection_DEEP2
            • SpecSelection_DEEP2.name
            • SpecSelection_DEEP2.photometryCut()
            • SpecSelection_DEEP2.selection()
            • SpecSelection_DEEP2.speczSuccess()
          • SpecSelection_GAMA
            • SpecSelection_GAMA.name
            • SpecSelection_GAMA.selection()
          • SpecSelection_HSC
            • SpecSelection_HSC.name
            • SpecSelection_HSC.photometryCut()
            • SpecSelection_HSC.selection()
            • SpecSelection_HSC.speczSuccess()
          • SpecSelection_VVDSf02
            • SpecSelection_VVDSf02.name
            • SpecSelection_VVDSf02.photometryCut()
            • SpecSelection_VVDSf02.selection()
            • SpecSelection_VVDSf02.speczSuccess()
          • SpecSelection_zCOSMOS
            • SpecSelection_zCOSMOS.name
            • SpecSelection_zCOSMOS.photometryCut()
            • SpecSelection_zCOSMOS.selection()
            • SpecSelection_zCOSMOS.speczSuccess()
    • creation.engines namespace
      • Subpackages
      • Submodules
        • rail.creation.engines.dsps_photometry_creator module
        • rail.creation.engines.dsps_sed_modeler module
        • rail.creation.engines.flowEngine module
          • FlowCreator
            • FlowCreator.inputs
            • FlowCreator.name
            • FlowCreator.outputs
            • FlowCreator.run()
          • FlowModeler
            • FlowModeler.config_options
            • FlowModeler.inputs
            • FlowModeler.name
            • FlowModeler.outputs
            • FlowModeler.run()
          • FlowPosterior
            • FlowPosterior.config_options
            • FlowPosterior.inputs
            • FlowPosterior.name
            • FlowPosterior.outputs
            • FlowPosterior.run()
        • rail.creation.engines.galaxy_population_components module
          • GalaxyGenerator
            • GalaxyGenerator.config_options
            • GalaxyGenerator.inputs
            • GalaxyGenerator.name
            • GalaxyGenerator.outputs
          • GalaxyPopulationGenerator
            • GalaxyPopulationGenerator.config_options
            • GalaxyPopulationGenerator.name
            • GalaxyPopulationGenerator.run()
  • Submodules
    • creation.degradation namespace
      • Subpackages
      • Submodules
        • rail.creation.degradation.grid_selection module
          • GridSelection
            • GridSelection.config_options
            • GridSelection.def_ratio_file
            • GridSelection.def_set_file
            • GridSelection.name
            • GridSelection.run()
        • rail.creation.degradation.lsst_error_model module
          • LSSTErrorModel
            • LSSTErrorModel.config_options
            • LSSTErrorModel.get_limiting_mags()
            • LSSTErrorModel.name
            • LSSTErrorModel.run()
        • rail.creation.degradation.observing_condition_degrader module
          • ObsCondition
            • ObsCondition.assign_pixels()
            • ObsCondition.config_options
            • ObsCondition.get_pixel_conditions()
            • ObsCondition.name
            • ObsCondition.run()
        • rail.creation.degradation.quantityCut module
          • QuantityCut
            • QuantityCut.config_options
            • QuantityCut.name
            • QuantityCut.run()
            • QuantityCut.set_cuts()
        • rail.creation.degradation.spectroscopic_degraders module
          • InvRedshiftIncompleteness
            • InvRedshiftIncompleteness.config_options
            • InvRedshiftIncompleteness.name
            • InvRedshiftIncompleteness.run()
          • LineConfusion
            • LineConfusion.config_options
            • LineConfusion.name
            • LineConfusion.run()
        • rail.creation.degradation.spectroscopic_selections module
          • SpecSelection
            • SpecSelection.config_options
            • SpecSelection.downsampling_N_tot()
            • SpecSelection.invalid_cut()
            • SpecSelection.name
            • SpecSelection.run()
            • SpecSelection.selection()
            • SpecSelection.validate_colnames()
          • SpecSelection_BOSS
            • SpecSelection_BOSS.name
            • SpecSelection_BOSS.selection()
          • SpecSelection_DEEP2
            • SpecSelection_DEEP2.name
            • SpecSelection_DEEP2.photometryCut()
            • SpecSelection_DEEP2.selection()
            • SpecSelection_DEEP2.speczSuccess()
          • SpecSelection_GAMA
            • SpecSelection_GAMA.name
            • SpecSelection_GAMA.selection()
          • SpecSelection_HSC
            • SpecSelection_HSC.name
            • SpecSelection_HSC.photometryCut()
            • SpecSelection_HSC.selection()
            • SpecSelection_HSC.speczSuccess()
          • SpecSelection_VVDSf02
            • SpecSelection_VVDSf02.name
            • SpecSelection_VVDSf02.photometryCut()
            • SpecSelection_VVDSf02.selection()
            • SpecSelection_VVDSf02.speczSuccess()
          • SpecSelection_zCOSMOS
            • SpecSelection_zCOSMOS.name
            • SpecSelection_zCOSMOS.photometryCut()
            • SpecSelection_zCOSMOS.selection()
            • SpecSelection_zCOSMOS.speczSuccess()
    • rail.creation.degrader module
      • Degrader
        • Degrader.config_options
        • Degrader.inputs
        • Degrader.name
        • Degrader.outputs
    • rail.creation.engine module
      • Creator
        • Creator.config_options
        • Creator.inputs
        • Creator.name
        • Creator.open_model()
        • Creator.outputs
        • Creator.sample()
      • Modeler
        • Modeler.config_options
        • Modeler.fit_model()
        • Modeler.inputs
        • Modeler.name
        • Modeler.outputs
      • PosteriorCalculator
        • PosteriorCalculator.config_options
        • PosteriorCalculator.get_posterior()
        • PosteriorCalculator.inputs
        • PosteriorCalculator.name
        • PosteriorCalculator.open_model()
        • PosteriorCalculator.outputs
• rail.flexzboost package
  • Submodules
• rail.pipelines package
  • Submodules
    • rail.pipelines.utils.name_factory module
      • CatalogType
        • CatalogType.created
        • CatalogType.degraded
        • CatalogType.reference
      • DataType
        • DataType.catalog
        • DataType.config
        • DataType.metric
        • DataType.model
        • DataType.pdf
      • ModelType
        • ModelType.creator
        • ModelType.degrarder
        • ModelType.estimator
        • ModelType.evaluator
        • ModelType.summarizer
      • NameFactory
        • NameFactory.data_directory_template
        • NameFactory.full_directory_template
        • NameFactory.get_data_dir()
        • NameFactory.get_project_dir()
        • NameFactory.project_directory_template
      • PdfType
        • PdfType.nz
        • PdfType.pz
    • rail.pipelines.estimation.inform_all module
• rail.stages package
  • import_and_attach_all()
  • Submodules
• rail.gpz package
  • Submodules
• estimation namespace
  • Subpackages
    • estimation.algos namespace
      • Subpackages
      • Submodules
        • rail.estimation.algos.GPz module
          • Dxy()
          • GP
            • GP.ANN()
            • GP.GPz()
            • GP.callbackF()
            • GP.getPHI()
            • GP.init()
            • GP.predict()
            • GP.train()
          • getOmega()
        • rail.estimation.algos.NZDir module
          • Inform_NZDir
            • Inform_NZDir.bands
            • Inform_NZDir.config_options
            • Inform_NZDir.default_usecols
            • Inform_NZDir.name
            • Inform_NZDir.run()
          • NZDir
            • NZDir.bands
            • NZDir.config_options
            • NZDir.default_usecols
            • NZDir.initialize_handle()
            • NZDir.join_histograms()
            • NZDir.name
            • NZDir.open_model()
            • NZDir.outputs
            • NZDir.run()
        • rail.estimation.algos.bpz_lite module
          • BPZ_lite
            • BPZ_lite.config_options
            • BPZ_lite.name
            • BPZ_lite.open_model()
          • Inform_BPZ_lite
            • Inform_BPZ_lite.config_options
            • Inform_BPZ_lite.name
            • Inform_BPZ_lite.run()
          • nzfunc()
        • rail.estimation.algos.flexzboost module
        • rail.estimation.algos.gpz_v1 module
          • GPz_v1
            • GPz_v1.config_options
            • GPz_v1.name
          • Inform_GPz_v1
            • Inform_GPz_v1.config_options
            • Inform_GPz_v1.name
            • Inform_GPz_v1.run()
        • rail.estimation.algos.knnpz module
          • Inform_KNearNeighPDF
            • Inform_KNearNeighPDF.config_options
            • Inform_KNearNeighPDF.name
            • Inform_KNearNeighPDF.run()
          • KNearNeighPDF
            • KNearNeighPDF.config_options
            • KNearNeighPDF.name
            • KNearNeighPDF.open_model()
        • rail.estimation.algos.naiveStack module
          • NaiveStack
            • NaiveStack.config_options
            • NaiveStack.name
            • NaiveStack.outputs
            • NaiveStack.run()
        • rail.estimation.algos.pointEstimateHist module
          • PointEstimateHist
            • PointEstimateHist.config_options
            • PointEstimateHist.name
            • PointEstimateHist.outputs
            • PointEstimateHist.run()
        • rail.estimation.algos.pzflow module
          • Inform_PZFlowPDF
            • Inform_PZFlowPDF.config_options
            • Inform_PZFlowPDF.name
            • Inform_PZFlowPDF.outputs
            • Inform_PZFlowPDF.run()
          • PZFlowPDF
            • PZFlowPDF.config_options
            • PZFlowPDF.inputs
            • PZFlowPDF.name
          • computemeanstd()
        • rail.estimation.algos.randomPZ module
          • RandomPZ
            • RandomPZ.config_options
            • RandomPZ.inputs
            • RandomPZ.name
        • rail.estimation.algos.simpleSOM module
          • Inform_SimpleSOMSummarizer
            • Inform_SimpleSOMSummarizer.config_options
            • Inform_SimpleSOMSummarizer.name
            • Inform_SimpleSOMSummarizer.run()
          • SimpleSOMSummarizer
            • SimpleSOMSummarizer.config_options
            • SimpleSOMSummarizer.name
            • SimpleSOMSummarizer.outputs
            • SimpleSOMSummarizer.run()
        • rail.estimation.algos.sklearn_nn module
          • Inform_SimpleNN
            • Inform_SimpleNN.config_options
            • Inform_SimpleNN.name
            • Inform_SimpleNN.run()
          • SimpleNN
            • SimpleNN.config_options
            • SimpleNN.name
          • make_color_data()
          • regularize_data()
        • rail.estimation.algos.somocluSOM module
          • Inform_somocluSOMSummarizer
            • Inform_somocluSOMSummarizer.config_options
            • Inform_somocluSOMSummarizer.name
            • Inform_somocluSOMSummarizer.run()
          • get_bmus()
          • plot_som()
          • somocluSOMSummarizer
            • somocluSOMSummarizer.config_options
            • somocluSOMSummarizer.get_som_coordinates()
            • somocluSOMSummarizer.name
            • somocluSOMSummarizer.outputs
            • somocluSOMSummarizer.replace_non_detections()
            • somocluSOMSummarizer.run()
            • somocluSOMSummarizer.set_weight_column()
        • rail.estimation.algos.trainZ module
          • Inform_trainZ
            • Inform_trainZ.config_options
            • Inform_trainZ.name
            • Inform_trainZ.run()
          • TrainZ
            • TrainZ.config_options
            • TrainZ.name
            • TrainZ.open_model()
          • trainZmodel
        • rail.estimation.algos.varInference module
          • VarInferenceStack
            • VarInferenceStack.config_options
            • VarInferenceStack.name
            • VarInferenceStack.outputs
            • VarInferenceStack.run()
  • Submodules
    • rail.estimation.estimator module
      • CatEstimator
        • CatEstimator.config_options
        • CatEstimator.estimate()
        • CatEstimator.inputs
        • CatEstimator.name
        • CatEstimator.open_model()
        • CatEstimator.outputs
        • CatEstimator.run()
      • CatInformer
        • CatInformer.config_options
        • CatInformer.inform()
        • CatInformer.inputs
        • CatInformer.name
        • CatInformer.outputs
    • rail.estimation.summarizer module
      • CatSummarizer
        • CatSummarizer.config_options
        • CatSummarizer.inputs
        • CatSummarizer.name
        • CatSummarizer.outputs
        • CatSummarizer.summarize()
      • PZSummarizer
        • PZSummarizer.config_options
        • PZSummarizer.inputs
        • PZSummarizer.name
        • PZSummarizer.outputs
        • PZSummarizer.summarize()
      • PzInformer
        • PzInformer.config_options
        • PzInformer.inform()
        • PzInformer.inputs
        • PzInformer.name
        • PzInformer.outputs
      • SZPZSummarizer
        • SZPZSummarizer.config_options
        • SZPZSummarizer.inputs
        • SZPZSummarizer.name
        • SZPZSummarizer.open_model()
        • SZPZSummarizer.outputs
        • SZPZSummarizer.summarize()
• rail.bpz package
  • Submodules
    • rail.bpz.utils module