search

LSSTDESC / rail_tpz

RAIL-wrapped version of a "lite" version of Matias Carrasco-Kind's TPZ tree-based photo-z code
MIT License
0 stars 0 forks source link

readme

pz-rail-tpz

Template codecov PyPI

"Lite" version of Matias Carrasco-Kind's TPZ (Trees for Photo-z) regression-tree-based photo-z code. This initial version only implements the regression-tree mode, it does not implement the classification tree or SOM-based photo-z estimators. All credit on algorithm development and initial coding goes to Matias Carrasco-Kind.

If you use TPZ for any publication, in addition to RAIL, you should cite Matias' TPZ paper: Carrasco Kind, M., & Brunner, R. J., 2013 “TPZ : Photometric redshift PDFs and ancillary information by using prediction trees and random forests”, MNRAS, 432, 1483 Link

For more details on the algorith, see Matias's MLZ website: http://matias-ck.com/mlz/

For the regression tree mode, the current implementation includes generation of "random" data via Gaussian scatter on each of the attributes that contain an uncertainty, but it does not implement the out-of-bag error or varImportance sampling that are included in the full MLZ/TPZ package.

RAIL: Redshift Assessment Infrastructure Layers

This package is part of the larger ecosystem of Photometric Redshifts in RAIL.

Citing RAIL

This code, while public on GitHub, has not yet been released by DESC and is still under active development. Our release of v1.0 will be accompanied by a journal paper describing the development and validation of RAIL.

If you make use of the ideas or software in RAIL, please cite the repository https://github.com/LSSTDESC/RAIL. You are welcome to re-use the code, which is open source and available under terms consistent with the MIT license.

External contributors and DESC members wishing to use RAIL for non-DESC projects should consult with the Photometric Redshifts (PZ) Working Group conveners, ideally before the work has started, but definitely before any publication or posting of the work to the arXiv.

Citing this package

If you use this package, you should also cite the appropriate papers for each code used. A list of such codes is included in the Citing RAIL section of the main RAIL Read The Docs page.