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.
Reason this release was yanked:
updated docs and code
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
¯_(ツ)_/¯ Not on Pypi yet
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 FILENAME [METHOD]
This script builds a noise map with the chosen method.
path: Path to input without the .fits at the end
filename: Path to write file, including the filename ending in .fits
method: Default method is std. Available methods are std, rts, and param.
See docs for more information about each method.
Options:
-r, --data_ext INTEGER 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
--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
Built Distribution
Hashes for cmos_noise_map-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f4b202cd3b4444e079e81293c994d3a0aa1a91682593a85953e653b45650173a |
|
MD5 | 5c070239a73ca235d9ff7d7efa58f853 |
|
BLAKE2b-256 | a0806a9ea441455b28c06535be1e7e8f9d05c6a52ef91e4d89dcdf8e3f133a62 |