Given an input fluxmap, emccd_detect will return a simulated EMCCD detector image. Website: (https://github.com/roman-corgi/emccd_detect/tree/master/emccd_detect)
The latest version of emccd_detect is 2.6.2. Main differences from previous version, 2.5.0:
Main differences from previous version:
--cosmic rays are more accurate, more like what the Roman CGI expects to see at L2 (including secondary cosmic ray events due to the shielding surrounding CGI). Almost nothing is hard coded about the cosmic rays. The tail length can be tuned as well.
--Fixed-pattern noise (FPN) is now implemented: 'roman' for Roman FPN found in TVAC, custom input file, or stripe pattern in rows and/or columns. File for Roman FPN included in util folder.
--CIC in gain register ("partial CIC") implemented (defaults to no partial CIC). One can specify particular "hot" gain stages with respect to CIC as well.
--EM gain simulation now conforms to exact binomial branching process instead of the approximate Gamma distribution. fast_gain_mode allows (fine for gain >~ 200) is available and uses the Gamma distribution.
--"Hot" gain stages with respect to EM gain multiplication also implemented. Defaults to None.
--Hot pixel map input available.
This package requires Python version 3.6 or higher. If the user wants the ability to apply charge transfer inefficiency (CTI) to detector frames using the optional tool (older version of arcticpy which is pure Python) provided in emccd_detect, then the Python version should be >=3.6 and <=3.9. If the newer version of arcticpy (wrapper around C++ code) is installed, there is no upper limit restriction for Python version. For installation instructions and documentation for the newer arcticpy, see https://github.com/jkeger/arctic. emccd_detect works apart from arcticpy and does not require it.
emccd_detect is available on PyPI.org, so the following command will install the module (without CTI capabilities):
pip install emccd-detect
To install emccd_detect instead from this package download, after downloading, navigate to the emccd_detect directory where setup.py is located and use
pip install .
This will install emccd_detect and its dependencies, which are as follows:
- astropy
- matplotlib
- numpy
- scipy
- pynufft==2020.0.0
- pyyaml
To optionally implement CTI capabilities with the pure-Python arcticpy, navigate to the arcticpy directory (https://github.com/roman-corgi/emccd_detect/tree/master/arcticpy_folder), and there will be a file called setup.py in that directory. Use
pip install .
This will install arcticpy version 1.0. See (https://github.com/jkeger/arcticpy/tree/row_wise/arcticpy) for documentation. If you have Python>3.9, the CTI functionality will not work if you are using the arcticpy installation that was included with this emccd_detect package, but everything else will work fine.
For an example of how to use emccd_detect, see example_script.py.
- Bijan Nemati (bijan.nemati@tellus1.com)
- Sam Miller (sam.miller@uah.edu)
- Kevin Ludwick (kevin.ludwick@uah.edu)
- Joshua Ludwick