Man pages sections > man1 > astmkcatalog

MakeCatalog - Make a catalog from labeled input images

MAKECATALOG(1) User Commands MAKECATALOG(1)

NAME

MakeCatalog - Make a catalog from labeled input images

SYNOPSIS

astmkcatalog [ OPTION...] ASTRdata

DESCRIPTION

MakeCatalog is part of GNU Astronomy Utilities 0.4. MakeCatalog will create a catalog from an input, labeled, and noise images.
For more information, please run any of the following commands. In particular the second contains a very comprehensive explanation of MakeCatalog's invocation: expected input(s), output(s), and a full description of all the options.
All options and their values:
$ astmkcatalog -P
Inputs/Outputs and options:
$ info astmkcatalog
Full section in manual/book:
$ info MakeCatalog
Full Gnuastro manual/book:
$ info gnuastro
If you couldn't find your answer in the manual, you can get direct help from experienced Gnuastro users and developers. For more information, please run:
$ info help-gnuastro
MakeCatalog options:
Input:
--clumpshdu=STR
Clump image extension name or number.
-C, --clumpsfile=STR
Image containing clump labels.
-E, --skysubtracted
Input is already sky subtracted (for S/N).
-h, --hdu=STR/INT
Extension name or number of input data.
--objectshdu=STR
Object image extension name or number.
-O, --objectsfile=STR
Image containing object/detection labels.
-R, --threshold=FLT
Use pixels more than this multiple of STD.
-s, --skyfile=STR
Image containing sky values.
--skyhdu=STR
Sky image extension name or number.
--stdhdu=STR
Sky image extension name or number.
-t, --stdfile=STR
Image containing sky STD values.
-z, --zeropoint=FLT
Zeropoint magnitude of input dataset.
Output:
-D, --dontdelete
Don't delete output if it exists.
-K, --keepinputdir
Keep input directory for automatic output.
-o, --output=STR
Output name.
--sfmagarea=FLT
Surface brightness area (in arcseconds^2).
--sfmagnsigma=FLT
Surface brightness multiple of Sky STD.
--tableformat=STR
Table format: `fits-ascii', `fits-binary'.
Upper limit magnitude:
-e, --envseed
Use GSL_RNG_SEED environment variable for seed.
--upmaskfile=STR
Mask image file name only for upper limit.
--upmaskhdu=STR
Mask image HDU only for upper limit.
--upnsigma=FLT
Multiple of sigma to define upperlimit.
--upnum=INT
Number of randomly positioned samples
--upsigmaclip=FLT,FLT
Sigma multiple and, tolerance or number.
Output catalog columns
-a, --area
Number of pixels in clump or object.
-A, --semimajor
Flux weighted semi-major axis.
-b, --brightness
Brightness (sum of pixel values).
-B, --semiminor
Flux weighted semi-minor axis.
-c, --numclumps
Number of clumps in this object.
--clumpbrightness
Brightness of clumps in an object.
--clumpsarea
Sum of all clump areas in an object.
--clumpsdec
Declination of f.wht center of all clumps.
--clumpsgeodec
Declination of geometric center of all clumps.
--clumpsgeora
Right ascension of geo. center of all clumps.
--clumpsgeox
Geometric center of all clumps in obj. (X).
--clumpsgeoy
Geometric center of all clumps in obj. (Y).
--clumpsmagnitude
Magnitude of all clumps in object.
--clumpsra
Right ascension of f.wht center of all clumps.
--clumpsx
Flux.wht center of all clumps in obj. (X).
--clumpsy
Flux.wht center of all clumps in obj. (Y).
-d, --dec
Declination of flux weighted center.
--geoaxisratio
Geometric axis ratio.
--geodec
Declination of geometric center.
--geopositionangle
Geometric position angle.
--geora
Right ascension of geometric center.
--geosemimajor
Geometric semi-major axis.
--geosemiminor
Geometric semi-minor axis.
--geox
Geometric center in first FITS axis.
--geoy
Geometric center in second FITS axis.
-G, --magnitudeerr
Magnitude error of objects or clumps.
-i, --ids
All IDs of objects and clumps.
--idinhostobj
ID of clump in host object.
-j, --hostobjid
ID of object hosting this clump.
-m, --magnitude
Total magnitude of objects or clumps.
--noriverbrightness
Sky (not river) subtracted clump brightness.
-n, --sn
Signal to noise ratio of objects or clumps.
--objid
Object label/ID.
-p, --positionangle
Flux weighted position angle.
-Q, --axisratio
Flux weighted axis ratio.
-r, --ra
Right ascension of flux weighted center.
--riverave
Average river value surrounding a clump.
--rivernum
Number of river pixels around a clump.
--sky
Average Sky value under this clump or object.
--std
Average Sky standard deviation.
--upperlimit
Upper-limit value, use other options to config.
-u, --upperlimitmag
Upper-limit mag. use other options to config.
--weightarea
Area used for flux weighted positions.
-x, --x
Flux weighted center in first FITS axis.
-y, --y
Flux weighted center in second FITS axis.
Operating modes:
-?, --help
give this help list
--cite
BibTeX citation for this program.
--config=STR
Read configuration file STR immediately.
--lastconfig
Do not parse any more configuration files.
--log
Information about output(s) in a log file.
--minmapsize=INT
Minimum bytes in array to not use ram RAM.
-N, --numthreads=INT
Number of CPU threads to use.
--onlyversion=STR
Only run if the program version is STR.
-P, --printparams
Print parameter values to be used and abort.
-q, --quiet
Only report errors, remain quiet about steps.
-S, --setdirconf
Set default values for this directory and abort.
--usage
give a short usage message
-U, --setusrconf
Set default values for this user and abort.
-V, --version
print program version
Mandatory or optional arguments to long options are also mandatory or optional for any corresponding short options.
GNU Astronomy Utilities home page: http://www.gnu.org/software/gnuastro/

REPORTING BUGS

Report bugs to bug-gnuastro@gnu.org. Copyright © 2015-2017, Free Software Foundation, Inc. License GPLv3+: GNU General public license version 3 or later.
 
This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law.
Written/developed by Mohammad Akhlaghi

SEE ALSO

The full documentation for MakeCatalog is maintained as a Texinfo manual. If the info and MakeCatalog programs are properly installed at your site, the command
info MakeCatalog
should give you access to the complete manual.
September 2017 GNU Astronomy Utilities 0.4