A tool to create a read noise map for CMOS detectors by modelling Random Telegraph Signal. This was originally created for use by LCOGT's BANZAI pipeline.
Project description
CMOS Noise Map
Code to model random telegraph noise in a CMOS detector. Originally designed for the Las Cumbres Observatory BANZAI pipeline. Authors: Prerana Kottapalli, Matt Daily, Curtis McCully
Read the docs: https://cmos-noise-map.readthedocs.io/en/latest/index.html
Installation
From PyPi
pip install cmos-noise-map
From Github
To install the tool, clone this repository and run:
pip install poetry
cd cmos-noise-map
poetry install
Tests
To run the unit tests, simply run:
poetry run pytest
Usage
Once you've installed the tool, it can be run simply by:
rts-maker <path> <options> <write filename>
Usage: rts-maker [OPTIONS] PATH [METHOD] [FILEPATH]
This script builds a noise map with the chosen method.
path: Path to input without the .fits at the end
filepath:OPTIONAL Path to write file
method: Default method is std. Available methods are std, rts, and param.
See docs for more information about each method.
Options:
-r, --data_ext TEXT Extension of fits file that contains the
image data
-uq, --upper_quantile FLOAT Standard deviation cutoff for pixel noise
evaluation
-t, --tolerance FLOAT The minimum difference between silhouette
scores. See docs for more information.
-m, --min_peak_separation FLOAT
Minimum difference between pixel value
cluster centers to be considered separate
clusters
-o, --out_hdu_name TEXT Name for the header in which the data will
be stored
-f, --fpack Adding this option will fpack your output
fits file
-b, --bias_check Adding this option will skip the check to
see if files used are bias files [default:
True]
--help Show this message and exit.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
cmos_noise_map-0.1.4.tar.gz
(42.0 kB
view hashes)
Built Distribution
Close
Hashes for cmos_noise_map-0.1.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 41bcd5d8c65812070c5cb2d0871326e3fff99c83b63c19a21dfcc357f905eb40 |
|
MD5 | 1bfe2617c1da7660dabb98dc0126e266 |
|
BLAKE2b-256 | 4cb5fa26b2296854b45c29c4401ae8eaf1f8ac84e2a06f8fcd584d3cb08c3a70 |