psphot --help or -h option

[Michael Wood-Vasey]

It would be great if psphot had a -h or --help option to point the user toward options, settings, or documentation about how to control aspects of the photometry.

[Does all of ipp-users really want to get every bug report as is the current default CC setting for submitting a new bug report?]

[Paul Price]

The default CC setting is empty. It only CCs those you select from the list.

[giebink]

(ipp004:~/ipp010) giebink% psphot -help
Usage: one of the following
psphot -file fname1[,fname2,...] -mask maskfile1[,maskfile2,...]

-variance varfile1[,varfile2,...] OutFileBaseName

psphot -list FileNameList [-masklist MaskFileNameList]

-variancelist VarFileNameList OutFileBaseName

psphot -help

psphot -version

where:

FileNameList is a text file containing filenames, one per line
MaskFileNameList is a text file of mask filenames, one per line
VarFileNameList is a text file of variance filenames, one per line
OutFileBaseName is the 'root name' for output files

additional options:

-modeltest xObj yObj [-model DEFAULT|ModelName]

[-fitmode DEFAULT|PSF|CONV] [-fitset FitFileName]

Test fit for object at the given coordinates. ModelName
is one of PS_MODEL_GAUSS, PS_MODEL_PGAUSS, PS_MODEL_QGAUSS,
PS_MODEL_RGAUSS, PS_MODEL_PS1_V1, or PS_MODEL_SERSIC.
FitFileName is a file of x,y,Io triples.

-psf PsfFile1[,PsfFile2,...] or -psflist PsfFileNameList

specify PSF rather than letting psphot estimate it

-src SrcFile1[,SrcFile2,...] or -srclist SrcFileNameList

specify additional sources for PSF generation

-chip nn[,nn,...]

select detector chips to process; default is all.
Indices correspond to zero-based offset in the FPA metadata table.

-photcode PhotoCodeName

specify photocode

-region RegionString

specify analysis region. String is of form '[x0:x1,y0:y1]'
To use this option you must define a default in psphot.config

-visual

turns on interactive display mode

-dumpconfig CfgFileName

causes config info to be dumped to the named file.

-break NOTHING|BACKMDL|PEAKS|MOMENTS|PSFMODEL|ENSEMBLE|PASS1

choose a point at which to exit processing early

-nthreads n

set number of parallel threads of execution

-F OldFileRule ReplacementFileRule

change file naming rule; e.g. '-F PSPHOT.OUTPUT PSPHOT.OUT.CMF.MEF'

-D name stringval

set a string-valued config parameter

-Di name intval

set an integer-valued config parameter

-Df name fval

set a float-valued config parameter

-Db name boolval

set a boolean-valued config parameter

-v, -vv, -vvv

set increasing levels of verbosity

-logfmt FormatString

set format string used for log messages

-trace Fac Lvl

set tracing for facility Fac to integer Lvl, e.g. '-trace err 10'

-trace-levels

print current trace levels