JWST PSF photometry in complex crowded fields.
Project description
StarBugII
PSF photometry in complex and crowded fields
• Detect deeply dust-embedded sources in NIRCam and MIRI images
• Full suite of photometry tools
• Powerful modular and simple GNU Linux standard command line interface
Installation
StarbugII requires webbpsf installed on the system to function fully.
$~ pip install starbug2
$~ starbug2 --init
[!IMPORTANT] If you make use of StarbugII in any published or presented work, please include a citation.
StarbugII uses methods and datatypes from astropy and photutils, please acknowledge them accordingly.
Documentation
See the full documentation for the complete installation and detailed guides to using the photometric routines. Basic usage information is produced by running:
StarbugII - JWST PSF photometry
usage: starbug2 [-ABDfGhMPSv] [-b bgdfile] [-d apfile] [-n ncores] [-o ouput] [-p file.param] [-s opt=val] image.fits ...
-A --apphot : run aperture photometry on a source list
-B --background : run background estimation
-b --bgdfile : load background (-bgd.fits) file
-d --apfile ap.fits : load a source detection (-ap.fits) file to skip the source detection step
-D --detect : run source detection
-f --find : attempt to find associated -ap -bgd files
-G --geom : calculate geometric stats on source list
-h --help : display uasage information
-M --match : match outputs from all input image files
-n --ncores num : number of CPU cores to split process between
-o --output dir : output directory
-p --param a.param : load parameter file
-P --psf : run psf photometry
-s --set option : set value in parameter file at runtime (-s SIGSKY=3)
-S --subbgd : subtract background from image
-v --verbose : display verbose outputs
--> Single run commands
--init : Initialise Starbug (post install)
--local-param : Make a local copy of the default parameter file
--update-param : Update an out-of-date local parameter file
--generate-psf : Generate a single PSF. Set FILTER, DET_NAME, PSF_SIZE with -s
--generate-region a.fits : Make a ds9 region file with a detection file
--generate-run *.fits : Generate a simple run script
--version : Print starbug2 version
--apply-zeropint a.fits : Apply a zeropoint (-s ZP_MAG=1.0) to a.fits
--calc-instr-zp a.fits : Calculate and apply an instrumental zero point onto a.fits
--> typical runs
$~ starbug2 -vD -p file.param image.fits //Source detect on image with a parameter file
$~ starbug2 -vDM -n4 images*.fits //Source detect and match outputs of a list of images
$~ starbug2 -vd image-ap.fits -BP image.fits //PSF photometry on an image with a source file (image-ap.fits)
See https://starbug2.readthedocs.io for more information.
StarbugII Matching
usage: starbug2-match [-BCGfhv] [-e column] [-o output] [-p file.param] [-s KEY=VAL] table.fits ...
-B --band : match in "BAND" mode (does not preserve a column for every frame)
-C --cascade : match in "CASCADE" mode (left justify columns)
-G --generic : match in "GENERIC" mode
-e --error column : photometric error column ("eflux" or "stdflux")
-f --full : export full catalogue
-h --help : show help message
-o --output file.fits : output matched catalogue
-p --param file.param : load starbug parameter file
-s --set option : set value in parameter file at runtime (-s MATCH_THRESH=1)
-v --verbose : display verbose outputs
--band-depr : match in "old" band mode
--> typical runs
$~ starbug2-match -Gfo outfile.fits tab1.fits tab2.fits
$~ starbug2-match -sMATCH_THRESH=0.2 -sBRIDGE_COL=F444W -Bo out.fits F*W.fits
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
File details
Details for the file starbug2-0.7.7.tar.gz
.
File metadata
- Download URL: starbug2-0.7.7.tar.gz
- Upload date:
- Size: 104.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.9.20
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 658cc2d187cc06ae6f413f77838c9624fc7f3dd40a881eabaae5b51b2b7e0f39 |
|
MD5 | 8040671bda944300d98022b2871a93c9 |
|
BLAKE2b-256 | ef0651f607a84ba7846c493d622aaa4958571aed47066361750cc25077bd2eb5 |
File details
Details for the file starbug2-0.7.7-py3-none-any.whl
.
File metadata
- Download URL: starbug2-0.7.7-py3-none-any.whl
- Upload date:
- Size: 94.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.9.20
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | e79b8a2a78d8106362a5e75cc3809856b403088b70e8598575dff966b17b3506 |
|
MD5 | 5db3f4f78fe6acaac823467097ebf7c4 |
|
BLAKE2b-256 | c3bafd55d1ef66d89c6ef9ba66e671d5469eb50bb2c824b8b50d28b4327e554a |