.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
.TH MAKEPROFILES "1" "February 2024" "GNU Astronomy Utilities 0.22" "User Commands"
.SH NAME
MakeProfiles \- make standard 2D profiles on an image
.SH SYNOPSIS
.B astmkprof
[\fI\,OPTION\/\fR...] [\fI\,Options\/\fR] [\fI\,Catalog\/\fR]
.SH DESCRIPTION
MakeProfiles is part of GNU Astronomy Utilities 0.22.
MakeProfiles will create a FITS image containing any number of mock
astronomical profiles based on an input catalog. All the profiles will be built
from the center outwards. First by Monte Carlo integration, then using the
central pixel position. The tolerance level specifies when the switch will
occur.
.PP
For more information, please run any of the following commands. In particular
the second contains a very comprehensive explanation of MakeProfiles's
invocation: expected input(s), output(s), and a full description of all the
options.
.TP
All options and their values:
$ astmkprof \fB\-P\fR
.TP
Inputs/Outputs and options:
$ info astmkprof
.TP
Full section in manual/book:
$ info MakeProfiles
.TP
Full Gnuastro manual/book:
$ info gnuastro
.PP
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:
.IP
\f(CW$ info help-gnuastro\fR
.PP
MakeProfiles options:
.IP
Input:
.TP
\fB\-B\fR, \fB\-\-backhdu\fR=\fI\,INT\/\fR/STR
HDU of background image.
.TP
\fB\-\-customimg\fR=\fI\,FITS\/\fR
Image file for 'custom\-img' profile.
.HP
\fB\-\-customimghdu\fR=\fI\,INT\/\fR/STR HDU of image given to '\-\-customimg'.
.HP
\fB\-\-customtable\fR=\fI\,FITS\/\fR/TXT File for 'custom\-prof' profile.
.TP
\fB\-\-customtablehdu\fR=\fI\,INT\/\fR/STR
HDU of table given to '\-\-customtable'.
.TP
\fB\-C\fR, \fB\-\-clearcanvas\fR
All pixels in background image read as zero.
.TP
\fB\-E\fR, \fB\-\-kernel\fR=\fI\,STR\/\fR
Parameters to only build one kernel.
.TP
\fB\-h\fR, \fB\-\-hdu\fR=\fI\,STR\/\fR/INT
Input catalog HDU name or number (if FITS).
.TP
\fB\-I\fR, \fB\-\-ignorecase\fR
Ignore case in matching/searching columns.
.TP
\fB\-k\fR, \fB\-\-background\fR=\fI\,FITS\/\fR
A background image to make the profiles on.
.TP
\fB\-\-searchin\fR=\fI\,STR\/\fR
Select column(s): 'name', 'unit', 'comment'.
.TP
\fB\-\-stdintimeout\fR=\fI\,INT\/\fR
Micro\-seconds to wait for standard input.
.IP
Output:
.TP
\fB\-D\fR, \fB\-\-dontdelete\fR
Don't delete output if it exists.
.TP
\fB\-i\fR, \fB\-\-individual\fR
Build all profiles separately.
.TP
\fB\-K\fR, \fB\-\-keepinputdir\fR
Keep input directory for automatic output.
.TP
\fB\-m\fR, \fB\-\-nomerged\fR
Do not create a merged image of all profiles.
.TP
\fB\-\-outfitsnocommit\fR
No Git commit in 0\-th HDU of output FITS.
.TP
\fB\-\-outfitsnoconfig\fR
No metadata in 0\-th HDU of output FITS.
.TP
\fB\-\-outfitsnodate\fR
No 'DATE' in 0\-th HDU of output FITS.
.TP
\fB\-\-outfitsnoversions\fR
No versions in 0\-th HDU of output FITS.
.TP
\fB\-o\fR, \fB\-\-output\fR=\fI\,STR\/\fR
Output file name.
.TP
\fB\-\-psfinimg\fR
PSF profiles made with all in output image.
.TP
\fB\-s\fR, \fB\-\-oversample\fR=\fI\,INT\/\fR
Scale of oversampling (>0 and odd).
.TP
\fB\-T\fR, \fB\-\-type\fR=\fI\,STR\/\fR
Type of output: e.g., int16, float32, etc...
.TP
\fB\-\-wcslinearmatrix\fR=\fI\,STR\/\fR
WCS linear matrix of output ('pc' or 'cd').
.TP
\fB\-x\fR, \fB\-\-mergedsize\fR=\fI\,INT[\/\fR,INT,...]
Merged image size along each dimension.
.IP
Profiles:
.TP
\fB\-c\fR, \fB\-\-prepforconv\fR
Shift and expand based on first catalog PSF.
.TP
\fB\-e\fR, \fB\-\-envseed\fR
Use GSL_RNG_SEED environment variable for seed.
.TP
\fB\-f\fR, \fB\-\-mforflatpix\fR
mcol is flat pixel value (when fcol is 5 or 6)
.TP
\fB\-\-magatpeak\fR
Magnitude is for peak pixel, not full profile.
.TP
\fB\-\-mcolissum\fR
mcol is total sum, not magnitude.
.TP
\fB\-\-mcolnocustimg\fR
Ignore value of mcol in 'custom\-img'.
.TP
\fB\-\-mcolnocustprof\fR
Ignore value of mcol in 'custom\-prof'.
.TP
\fB\-\-mode\fR=\fI\,STR\/\fR
Mode of '\-\-ccol': 'img' or 'wcs'.
.TP
\fB\-p\fR, \fB\-\-tunitinp\fR
Truncation is in units of pixels, not radius.
.TP
\fB\-r\fR, \fB\-\-numrandom\fR=\fI\,INT\/\fR
No. of random points in Monte Carlo integ.
.TP
\fB\-R\fR, \fB\-\-replace\fR
Replace overlapping profile pixels, don't add.
.TP
\fB\-t\fR, \fB\-\-tolerance\fR=\fI\,FLT\/\fR
Tolerance to switch to less accurate method.
.TP
\fB\-w\fR, \fB\-\-circumwidth\fR=\fI\,FLT\/\fR
Width of circumference (inward) profiles
.TP
\fB\-X\fR, \fB\-\-shift\fR=\fI\,INT[\/\fR, ...]
Shift profile centers in output image.
.TP
\fB\-z\fR, \fB\-\-zeropoint\fR=\fI\,FLT\/\fR
Magnitude zero point.
.IP
Columns, by info (see '\-\-searchin'), or number (starting from 1):
.TP
\fB\-\-ccol\fR=\fI\,STR\/\fR/INT
Coordinate columns (one call for each dim.).
.TP
\fB\-\-fcol\fR=\fI\,STR\/\fR/INT
sersic (1), moffat (2), gaussian (3), point (4),
flat (5), circumference (6), distance (7),
custom\-prof (8), azimuth (9), custom\-img (10).
.TP
\fB\-\-mcol\fR=\fI\,STR\/\fR/INT
Magnitude.
.TP
\fB\-\-ncol\fR=\fI\,STR\/\fR/INT
Sersic index or Moffat beta.
.TP
\fB\-\-p2col\fR=\fI\,STR\/\fR/INT
Second Euler angle (X\-Z\-X order).
.TP
\fB\-\-p3col\fR=\fI\,STR\/\fR/INT
Third Euler angle (X\-Z\-X order).
.TP
\fB\-\-pcol\fR=\fI\,STR\/\fR/INT
Position angle (3D: first X\-Z\-X Euler angle).
.TP
\fB\-\-q2col\fR=\fI\,STR\/\fR/INT
Axis ratio (major/dim3 in 3D).
.TP
\fB\-\-qcol\fR=\fI\,STR\/\fR/INT
Axis ratio (major/dim2 in 3D).
.TP
\fB\-\-rcol\fR=\fI\,STR\/\fR/INT
Effective radius or FWHM in pixels.
.TP
\fB\-\-tcol\fR=\fI\,STR\/\fR/INT
Truncation in units of \fB\-\-rcol\fR.
.IP
WCS parameters:
.TP
\fB\-\-cdelt\fR=\fI\,FLT[\/\fR, ...]
Resolution in each dimension.
.TP
\fB\-\-crpix\fR=\fI\,FLT[\/\fR, ...]
Pixel coordinates of reference point.
.TP
\fB\-\-crval\fR=\fI\,FLT[\/\fR, ...]
WCS coordinates of reference point.
.TP
\fB\-\-ctype\fR=\fI\,STR[\/\fR, ... ]
One of FITS standard WCS types.
.TP
\fB\-\-cunit\fR=\fI\,STR[\/\fR, ... ]
Units of the WCS coordinates (e.g., 'deg').
.TP
\fB\-\-pc\fR=\fI\,FLT[\/\fR, ...]
WCS rotation matrix (all elements).
.IP
Operating modes:
.TP
\-?, \fB\-\-help\fR
give this help list
.TP
\fB\-\-checkconfig\fR
List all config files and variables read.
.TP
\fB\-\-cite\fR
BibTeX citation for this program.
.TP
\fB\-\-config\fR=\fI\,STR\/\fR
Read configuration file STR immediately.
.TP
\fB\-\-config\-prefix\fR=\fI\,STR\/\fR
Custom prefix of option names config files.
.TP
\fB\-\-lastconfig\fR
Do not parse any more configuration files.
.TP
\fB\-\-log\fR
Information about output(s) in a log file.
.TP
\fB\-\-minmapsize\fR=\fI\,INT\/\fR
Min. bytes to avoid RAM automatically.
.TP
\fB\-N\fR, \fB\-\-numthreads\fR=\fI\,INT\/\fR
Number of CPU threads to use.
.TP
\fB\-\-onlyversion\fR=\fI\,STR\/\fR
Only run if the program version is STR.
.TP
\fB\-P\fR, \fB\-\-printparams\fR
Print parameter values to be used and abort.
.TP
\fB\-\-quietmmap\fR
Don't print mmap'd file's name and size.
.TP
\fB\-q\fR, \fB\-\-quiet\fR
Only report errors, remain quiet about steps.
.TP
\fB\-S\fR, \fB\-\-setdirconf\fR
Set default values for this directory and abort.
.TP
\fB\-\-usage\fR
give a short usage message
.TP
\fB\-U\fR, \fB\-\-setusrconf\fR
Set default values for this user and abort.
.TP
\fB\-V\fR, \fB\-\-version\fR
print program version
.PP
Mandatory or optional arguments to long options are also mandatory or optional
for any corresponding short options.
.PP
GNU Astronomy Utilities home page: http://www.gnu.org/software/gnuastro/
.SH "REPORTING BUGS"
Report bugs to bug\-gnuastro@gnu.org.
.SH COPYRIGHT
Copyright \(co 2015\-2024 Free Software Foundation, Inc.
License GPLv3+: GNU General public license version 3 or later.
.br
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.
.PP
Written/developed by Mohammad Akhlaghi
.SH "SEE ALSO"
The full documentation for
.B MakeProfiles
is maintained as a Texinfo manual.  If the
.B info
and
.B MakeProfiles
programs are properly installed at your site, the command
.IP
.B info MakeProfiles
.PP
should give you access to the complete manual.