CLI Reference#
The command-line interface (CLI) uses the dpp command that is available after pip-installing vampires_dpp (Installation).
dpp#
dpp [OPTIONS] COMMAND [ARGS]...
Options
- -v, --version#
Show the version and exit.
calib#
Create calibration files from background files (darks or sky frames) and flats.
dpp calib [OPTIONS] COMMAND [ARGS]...
Options
- -o, --outdir <outdir>#
Output directory.
- -j, --num-proc <num_proc>#
Number of processes to use.
- Default:
1
- -q, --quiet#
Silence progress bars and extraneous logging.
back#
Create background files from darks/skies. Each input file will be collapsed. Groups of files with the same exposure time, EM gain, and frame size will be median-combined together to create a super-background file.
dpp calib back [OPTIONS] [FILENAMES]...
Options
- -c, --collapse <collapse>#
Frame collapse method
- Default:
'median'- Options:
median | mean | varmean | biweight
- -f, --force#
Force processing of files
Arguments
- FILENAMES#
Optional argument(s)
flat#
Create flat-field files. Each input file will be collapsed with background-subtraction if files are provided. Groups of files with the same exposure time, EM gain, frame size, and filter will be median-combined together to create a super-flat file.
dpp calib flat [OPTIONS] [FILENAMES]...
Options
- -c, --collapse <collapse>#
Frame collapse method
- Default:
'median'- Options:
median | mean | varmean | biweight
- -n, --norm, -u, --no-norm#
Normalize flat fields by field median
- -f, --force#
Force processing of files
Arguments
- FILENAMES#
Optional argument(s)
centroid#
Get image centroid estimates
dpp centroid [OPTIONS] CONFIG [FILENAMES]...
Options
- -m, --manual#
Enter centroids manually
- -p, --plot, -np, --no-plot#
Show centroiding plots (requires a display)
- -o, --outdir <outdir>#
Output file directory
- -j, --num-proc <num_proc>#
Number of processes to use.
- Default:
1
Arguments
- CONFIG#
Required argument
- FILENAMES#
Optional argument(s)
new#
Generate configuration files
dpp new [OPTIONS] CONFIG
Options
- -e, --edit#
Launch configuration file in editor after creation.
Arguments
- CONFIG#
Required argument
norm#
Normalize VAMPIRES data files
dpp norm [OPTIONS] [FILENAMES]...
Options
- -o, --outdir <outdir>#
Output directory
- -d, --deint#
Deinterleave files into FLC states (WARNING: only apply this to old VAMPIRES data downloaded directly from sonne)
- -nf, --no-filter-empty#
Don’t filter empty frames from data (post deinterleaving, if applicable)
- -j, --num-proc <num_proc>#
Number of processes to use.
- Default:
1
- -q, --quiet#
Silence progress bars and extraneous logging.
Arguments
- FILENAMES#
Optional argument(s)
nrm#
NRM mask alignment, analysis
dpp nrm [OPTIONS] COMMAND [ARGS]...
Options
- -j, --num-proc <num_proc>#
Number of processes to use.
- Default:
1
align#
Check uv scale/theta alignment from mean combined data in aux directory. Plots are saved to nrm/figures. Adjust nrm.uv and nrm.theta in the TOML file to test different values.
dpp nrm align [OPTIONS] CONFIG [FILENAMES]...
Options
- -o, --outdir <outdir>#
Output file directory
Arguments
- CONFIG#
Required argument
- FILENAMES#
Optional argument(s)
pdi#
Run the PDI pipeline only
dpp pdi [OPTIONS] CONFIG [FILENAMES]...
Options
- -o, --outdir <outdir>#
Output file directory
- -j, --num-proc <num_proc>#
Number of processes to use.
- Default:
1
- -v, --verbose#
Print debug statements.
Arguments
- CONFIG#
Required argument
- FILENAMES#
Optional argument(s)
run#
Run the data processing pipeline (including PDI)
dpp run [OPTIONS] CONFIG [FILENAMES]...
Options
- -o, --outdir <outdir>#
Output file directory
- -j, --num-proc <num_proc>#
Number of processes to use.
- Default:
1
- -v, --verbose#
Print debug statements.
Arguments
- CONFIG#
Required argument
- FILENAMES#
Optional argument(s)
select#
View files in DS9 and sort out bad files
dpp select [OPTIONS] [FILENAMES]...
Arguments
- FILENAMES#
Optional argument(s)
sort#
Sorts raw data based on the data type. This will either use the DATA-TYP header value or the U_OGFNAM header, depending on when your data was taken.
dpp sort [OPTIONS] [FILENAMES]...
Options
- -o, --outdir <outdir>#
Output directory.
- -j, --num-proc <num_proc>#
Number of processes to use.
- Default:
1
- -e, --ext <ext>#
HDU extension
- -c, --copy, -nc, --no-copy#
copy files instead of moving them
- -d, --decompress#
Would you like to decompress .fits.gz files while copying?
- -q, --quiet#
Silence progress bars and extraneous logging.
Arguments
- FILENAMES#
Optional argument(s)
table#
Go through each file and combine the header information into a single CSV.
dpp table [OPTIONS] [FILENAMES]...
Options
- -e, --ext <ext>#
FITS header extension to use for table
- -o, --output <output>#
Output path without file extension.
- -j, --num-proc <num_proc>#
Number of processes to use.
- -q, --quiet#
Silence progress bars and extraneous logging.
Arguments
- FILENAMES#
Optional argument(s)
target#
Query SIMBAD+Vizier to update target info
dpp target [OPTIONS] CONFIG
Options
- -e, --edit#
Launch configuration file in editor after updating.
Arguments
- CONFIG#
Required argument
upgrade#
Tries to automatically upgrade a configuration file to the current version (0.14.3), prompting where necessary.
dpp upgrade [OPTIONS] CONFIG
Options
- -o, --output <output>#
Output path.
- -e, --edit#
Launch configuration file in editor after creation.
Arguments
- CONFIG#
Required argument