.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
.TH STATISTICS "1" "February 2024" "GNU Astronomy Utilities 0.22" "User Commands"
.SH NAME
Statistics \- calculate statistics of a dataset
.SH SYNOPSIS
.B aststatistics
[\fI\,OPTION\/\fR...] \fI\,ASTRdata\/\fR
.SH DESCRIPTION
Statistics is part of GNU Astronomy Utilities 0.22.
Statistics will do statistical analysis on the input dataset (table column or
image). All blank pixels or pixels outside of the given range are ignored. You
can either directly ask for certain statistics in one line/row as shown below
with the same order as requested, or get tables of different statistical
measures like the histogram, cumulative frequency style and etc. If no
particular statistic is requested, some basic information about the dataset is
printed on the command\-line.
.PP
For more information, please run any of the following commands. In particular
the second contains a very comprehensive explanation of Statistics's
invocation: expected input(s), output(s), and a full description of all the
options.
.TP
All options and their values:
$ aststatistics \fB\-P\fR
.TP
Inputs/Outputs and options:
$ info aststatistics
.TP
Full section in manual/book:
$ info Statistics
.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
Statistics options:
.IP
Input:
.TP
\fB\-c\fR, \fB\-\-column\fR=\fI\,STR\/\fR
Column number (counting from 1) or search string.
.TP
\fB\-\-greaterequal2\fR=\fI\,FLT\/\fR
Upper range of 2nd dim in 2D histograms.
.TP
\fB\-g\fR, \fB\-\-greaterequal\fR=\fI\,FLT\/\fR
Only use values greater\-equal than this.
.TP
\fB\-h\fR, \fB\-\-hdu\fR=\fI\,STR\/\fR/INT
Extension name or number of input data.
.TP
\fB\-I\fR, \fB\-\-ignorecase\fR
Ignore case in matching/searching columns.
.TP
\fB\-\-lessthan2\fR=\fI\,FLT\/\fR
Lower range of 2nd dim in 2D histograms.
.TP
\fB\-l\fR, \fB\-\-lessthan\fR=\fI\,FLT\/\fR
Only use values less than this.
.TP
\fB\-Q\fR, \fB\-\-qrange\fR=\fI\,FLT[\/\fR,FLT]
Quantile range: one (from Q to 1\-Q) or two.
.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
Tessellation (tile grid):
.TP
\fB\-\-checktiles\fR
Tile IDs in an image, the size of input.
.TP
\fB\-F\fR, \fB\-\-remainderfrac\fR=\fI\,FLT\/\fR
Fraction of remainder to split last tile.
.TP
\fB\-\-interpmetric\fR=\fI\,STR\/\fR
Interpolation metric (radial, manhattan).
.TP
\fB\-\-interpnumngb\fR=\fI\,INT\/\fR
No. of neighbors to use for interpolation.
.TP
\fB\-\-interponlyblank\fR
Only interpolate over the blank tiles.
.TP
\fB\-i\fR, \fB\-\-interpolate\fR
Interpolate over blank tiles to fill them.
.HP
\fB\-M\fR, \fB\-\-numchannels\fR=\fI\,INT[\/\fR,..] No. of channels in dim.s (FITS order).
.TP
\fB\-\-oneelempertile\fR
Display 1 element/tile, not full input res.
.TP
\fB\-\-workoverch\fR
Work (not tile) over channel edges.
.TP
\fB\-Z\fR, \fB\-\-tilesize\fR=\fI\,INT[\/\fR,INT]
Regular tile size on dim.s (FITS order).
.IP
Output:
.TP
\fB\-D\fR, \fB\-\-dontdelete\fR
Don't delete output if it exists.
.TP
\fB\-K\fR, \fB\-\-keepinputdir\fR
Keep input directory for automatic output.
.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\-\-tableformat\fR=\fI\,STR\/\fR
Table fmt: 'fits\-ascii', 'fits\-binary', 'txt'.
.TP
\fB\-\-wcslinearmatrix\fR=\fI\,STR\/\fR
WCS linear matrix of output ('pc' or 'cd').
.IP
Single value measurements
.TP
\fB\-d\fR, \fB\-\-std\fR
Standad deviation.
.TP
\fB\-E\fR, \fB\-\-median\fR
Median.
.TP
\fB\-\-mad\fR
Median absolute deviation.
.TP
\fB\-\-madclip\-mad\fR
MAD\-clipped Median Absolute Deviation.
.TP
\fB\-\-madclip\-mean\fR
MAD\-clipped mean.
.TP
\fB\-\-madclip\-median\fR
MAD\-clipped median.
.TP
\fB\-\-madclip\-number\fR
Number of elements after MAD\-clipping.
.TP
\fB\-\-madclip\-std\fR
MAD\-clipped standard deviation.
.TP
\fB\-\-maximum\fR
Maximum.
.TP
\fB\-\-minimum\fR
Minimum.
.TP
\fB\-\-modequant\fR
Mode quantile (see \fB\-\-mode\fR)
.TP
\fB\-\-modesym\fR
Mode symmetricity (see \fB\-\-mode\fR).
.TP
\fB\-\-modesymvalue\fR
Value at mode symmetricity (see \fB\-\-mode\fR).
.TP
\fB\-m\fR, \fB\-\-mean\fR
Mean.
.TP
\fB\-\-number\fR
Number (non\-blank).
.TP
\fB\-O\fR, \fB\-\-mode\fR
Mode (Appendix C of arXiv:1505.01664).
.TP
\fB\-\-quantfunc\fR=\fI\,FLT[\/\fR,...]
Quantile function (multiple values acceptable).
.TP
\fB\-\-quantofmean\fR
Quantile of the mean.
.TP
\fB\-\-sigclip\-mad\fR
Sigma\-clipped Median Absolute Deviation.
.TP
\fB\-\-sigclip\-mean\fR
Sigma\-clipped mean.
.TP
\fB\-\-sigclip\-median\fR
Sigma\-clipped median.
.TP
\fB\-\-sigclip\-number\fR
Number of elements after sigma\-clipping.
.TP
\fB\-\-sigclip\-std\fR
Sigma\-clipped standard deviation.
.TP
\fB\-\-sum\fR
Sum.
.TP
\fB\-u\fR, \fB\-\-quantile\fR=\fI\,FLT[\/\fR,...]
Quantile (multiple values acceptable).
.IP
Particular calculation
.TP
\fB\-\-asciicfp\fR
Print an ASCII cumulative frequency plot.
.TP
\fB\-A\fR, \fB\-\-asciihist\fR
Print an ASCII histogram.
.TP
\fB\-C\fR, \fB\-\-cumulative\fR
Save the cumulative frequency plot in output.
.TP
\fB\-\-histogram2d\fR=\fI\,STR\/\fR
2D histogram (as 'table' or 'image').
.TP
\fB\-H\fR, \fB\-\-histogram\fR
Save the histogram in output.
.TP
\fB\-\-madclip\fR
Overall MAD\-clipping (see '\-\-mclipparams')
.TP
\fB\-\-mirror\fR=\fI\,FLT\/\fR
Save the histogram and CFP of the mirror dist.
.TP
\fB\-R\fR, \fB\-\-contour\fR=\fI\,STR\/\fR
Contour levels, save in PGFPlots format.
.TP
\fB\-s\fR, \fB\-\-sigmaclip\fR
Overall sigma\-clipping (see '\-\-sclipparams')
.TP
\fB\-t\fR, \fB\-\-ontile\fR
Single values on separate tiles, not full input.
.TP
\fB\-y\fR, \fB\-\-sky\fR
Find the Sky and its STD over the tessellation.
.IP
Sky and Sky STD settings
.TP
\fB\-a\fR, \fB\-\-outliernumngb\fR=\fI\,INT\/\fR
Num neighboring tiles to look for outlier.
.TP
\fB\-\-checksky\fR
Store steps in '_sky_steps.fits' file.
.TP
\fB\-\-checkskynointerp\fR
Similar to \fB\-\-checksky\fR, stops at interpolation.
.TP
\fB\-\-ignoreblankintiles\fR
Don't write input's blanks in the tiled output.
.TP
\fB\-\-khdu\fR=\fI\,STR\/\fR
HDU/extension name or number of kernel.
.TP
\fB\-k\fR, \fB\-\-kernel\fR=\fI\,FITS\/\fR
File name of kernel to convolve input.
.TP
\fB\-\-mclipparams\fR=\fI\,FLT\/\fR,FLT
MAD clip: Multiple, and tolerance/number.
.TP
\fB\-\-meanmedqdiff\fR=\fI\,FLT\/\fR
Max. mode and median quantile diff. per tile.
.TP
\fB\-\-mirrordist\fR=\fI\,FLT\/\fR
Max. distance (error multip.) to find mode.
.HP
\fB\-\-outliersclip\fR=\fI\,FLT\/\fR,FLT Sigma\-clip params for qthresh outliers.
.TP
\fB\-\-outliersigma\fR=\fI\,FLT\/\fR
Multiple of sigma to define outliers.
.TP
\fB\-\-sclipparams\fR=\fI\,FLT\/\fR,FLT
Sigma clip: Multiple, and tolerance/number.
.TP
\fB\-\-smoothwidth\fR=\fI\,INT\/\fR
Sky: flat kernel width to smooth interpolated.
.IP
Histogram and CFP settings
.TP
\fB\-\-asciiheight\fR=\fI\,INT\/\fR
Height of ASCII histogram or CFP plots.
.TP
\fB\-\-manualbinrange\fR
Set min/max of bins manually, not from data.
.TP
\fB\-\-maxbinone\fR
Scale such that the maximum bin has value of one.
.TP
\fB\-\-numasciibins\fR=\fI\,INT\/\fR
No. of bins in ASCII histogram or CFP plots.
.TP
\fB\-\-numbins\fR=\fI\,INT\/\fR
No. of bins in histogram or CFP tables.
.TP
\fB\-\-numbins2\fR=\fI\,INT\/\fR
No. of bins in second\-dim of 2D histogram.
.TP
\fB\-n\fR, \fB\-\-normalize\fR
Set sum of all bins to 1.
.TP
\fB\-\-onebinstart\fR=\fI\,FLT\/\fR
Shift bins so one bin starts on this value.
.TP
\fB\-\-onebinstart2\fR=\fI\,FLT\/\fR
Similar to \fB\-\-onebinstart\fR, for 2D histogram
.IP
Fitting (1 dimensional)
.TP
\fB\-\-fitestimate\fR=\fI\,STR\/\fR/FLT
Estimate fitted func. (number, file or 'self').
.TP
\fB\-\-fitestimatecol\fR=\fI\,STR\/\fR/INT
Column containing the \fB\-\-fitestimate\fR values.
.TP
\fB\-\-fitestimatehdu\fR=\fI\,STR\/\fR/INT
HDU containing the \fB\-\-fitestimate\fR values.
.TP
\fB\-\-fitrobust\fR=\fI\,STR\/\fR
The robust function name to use.
.TP
\fB\-\-fitweight\fR=\fI\,STR\/\fR
Input weight: 'std', 'var' or 'inv\-variance'.
.TP
\fB\-f\fR, \fB\-\-fit\fR=\fI\,STR\/\fR
Type of fitting: 'linear', 'linear\-weighted',
\&'linear\-no\-constant',
\&'linear\-no\-constant\-weighted', 'polynomial',
\&'polynomial\-weighted', 'polynomial\-robust'.
.TP
\fB\-p\fR, \fB\-\-fitmaxpower\fR=\fI\,INT\/\fR
Maximum power in polynomial to fit.
.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\-\-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 Statistics
is maintained as a Texinfo manual.  If the
.B info
and
.B Statistics
programs are properly installed at your site, the command
.IP
.B info Statistics
.PP
should give you access to the complete manual.