.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.3.
.TH IMAGESTATISTICS "1" "October 2016" "GNU Astronomy Utilities 0.2.33-8a3b" "User Commands"
.SH NAME
ImageStatistics \- get image statistics
.SH SYNOPSIS
.B astimgstat
[\fI\,OPTION\/\fR...] \fI\,ASTRdata\/\fR
.SH DESCRIPTION
ImageStatistics is part of GNU Astronomy Utilities 0.2.33\-8a3b.
ImageStatistics will print the basic statistics of the input image pixel flux
distribution. All blank pixels or pixels specified by a mask image will be
ignored.
.PP
For more information, please run any of the following commands. They will
respectively show you the `Invoking ImageStatistics' subsection, the complete
`ImageStatistics' section, or the full GNU Astronomy Utilities manual. In
particular the first contains a very complete explanation of each option.
.IP
info astimgstat
.IP
info ImageStatistics
.IP
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
info help\-gnuastro
.PP
ImageStatistics options:
.IP
Input:
.TP
\fB\-d\fR, \fB\-\-mirrordist\fR=\fI\,FLT\/\fR
Distance beyond mirror point. Multiple of std.
.TP
\fB\-h\fR, \fB\-\-hdu\fR=\fI\,STR\/\fR
Extension name or number of input data.
.TP
\fB\-H\fR, \fB\-\-mhdu\fR=\fI\,STR\/\fR
Mask image header name.
.TP
\fB\-M\fR, \fB\-\-mask\fR=\fI\,STR\/\fR
Mask image file name.
.TP
\fB\-r\fR, \fB\-\-ignoremin\fR
Ignore data with values equal to minimum.
.IP
Output:
.TP
\fB\-A\fR, \fB\-\-noasciihist\fR
Do not show an ASCII histogram of the data.
.TP
\fB\-B\fR, \fB\-\-onebinvalue\fR=\fI\,FLT\/\fR
Shift bins so one bin starts on this value.
.TP
\fB\-\-checkmode\fR
Mode mirror plot. `_modehist.txt', `_modecfp.txt'
.TP
\fB\-D\fR, \fB\-\-dontdelete\fR
Don't delete output if it exists.
.TP
\fB\-\-histrangeformirror\fR
Use input histogram range for mirror plots.
.TP
\fB\-K\fR, \fB\-\-keepinputdir\fR
Do not remove input's dir info for output.
.TP
\fB\-l\fR, \fB\-\-lowerbin\fR
Interval lower limit for column 1.
.TP
\fB\-\-mirrorplotdist\fR=\fI\,FLT\/\fR
Distance beyond mode to display.
.TP
\fB\-\-mirrorquant\fR=\fI\,FLT\/\fR
Mirror quantile. `_mirhist.txt', `_mircfp.txt'.
.TP
\fB\-o\fR, \fB\-\-output\fR=\fI\,STR\/\fR
Output file or directory name.
.IP
Histogram (suffix: `_hist.txt'):
.TP
\fB\-i\fR, \fB\-\-histmin\fR=\fI\,FLT\/\fR
The minimum value for the histogram.
.TP
\fB\-\-maxhistone\fR
Scale such that the maximum bin has value of one.
.TP
\fB\-\-nohist\fR
Do not calculate histogram.
.TP
\fB\-\-normhist\fR
Normalize the  histogram (sum of all bins 1).
.TP
\fB\-n\fR, \fB\-\-histnumbins\fR=\fI\,INT\/\fR
Number of bins in the histogram.
.TP
\fB\-Q\fR, \fB\-\-histquant\fR=\fI\,FLT\/\fR
Quantile (Q) range. Histogram from Q to 1\-Q.
.TP
\fB\-x\fR, \fB\-\-histmax\fR=\fI\,FLT\/\fR
The maximum value for the histogram.
.IP
Cumulative Frequency Plot (suffix: `_cfp.txt'):
.TP
\fB\-a\fR, \fB\-\-cfpmin\fR=\fI\,FLT\/\fR
Minimum value to use in the CFP.
.TP
\fB\-b\fR, \fB\-\-cfpmax\fR=\fI\,FLT\/\fR
Maximum value to use in the CFP.
.TP
\fB\-\-cfpsimhist\fR
Set CFP range and bins similar to histogram.
.TP
\fB\-\-maxcfpeqmaxhist\fR
Set maximum of CFP to maximum of histogram.
.TP
\fB\-\-nocfp\fR
No Cumulative Frequency Plot.
.TP
\fB\-\-normcfp\fR
Normalize the CFP (sum of all bins 1).
.TP
\fB\-p\fR, \fB\-\-cfpnum\fR=\fI\,INT\/\fR
Number of data points to find CFP.
.TP
\fB\-U\fR, \fB\-\-cfpquant\fR=\fI\,FLT\/\fR
Quantile of range: from U to 1\-U.
.IP
Sigma clipping:
.TP
\fB\-g\fR, \fB\-\-sigclipnum\fR=\fI\,INT\/\fR
Number of times to do sigma clipping.
.TP
\fB\-\-nosigclip\fR
Do not preform sigma clipping.
.HP
\fB\-t\fR, \fB\-\-sigcliptolerance\fR=\fI\,FLT\/\fR Difference in STD tolerance to halt iteration.
.TP
\fB\-u\fR, \fB\-\-sigclipmultip\fR=\fI\,FLT\/\fR
Multiple of standard deviation in sigma\-clipping.
.IP
Operating modes:
.TP
\-?, \fB\-\-help\fR
give this help list
.TP
\fB\-\-cite\fR
BibTeX citation for ImageStatistics.
.TP
\fB\-\-nolog\fR
No log file for programs which make one.
.TP
\fB\-N\fR, \fB\-\-numthreads\fR=\fI\,INT\/\fR
Number of CPU threads to use.
.TP
\fB\-\-onlydirconf\fR
Only read current directory configuration file.
.TP
\fB\-\-onlyversion\fR=\fI\,STR\/\fR
Only run if the program version is this.
.TP
\fB\-P\fR, \fB\-\-printparams\fR
Print parameter values to be used and abort.
.TP
\fB\-q\fR, \fB\-\-quiet\fR
Only report errors, remain quiet about steps.
.TP
\fB\-\-setusrconf\fR
Set default values for this user and abort.
.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\-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 AUTHOR
Written by Mohammad Akhlaghi
.SH "REPORTING BUGS"
Report bugs to bug\-gnuastro@gnu.org.
.SH COPYRIGHT
Copyright \(co 2015\-2016, 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.
.SH "SEE ALSO"
The full documentation for
.B ImageStatistics
is maintained as a Texinfo manual.  If the
.B info
and
.B ImageStatistics
programs are properly installed at your site, the command
.IP
.B info ImageStatistics
.PP
should give you access to the complete manual.