---
name: "astimgstat"
section: "1"
platform: "linux"
package: "gnuastro"
version: "0.2.33-1"
release: "Debian 9 (Stretch)"
platforms: ["linux"]
url: "https://new.carta.tech/astimgstat"
---

# astimgstat(1)

get image statistics

## NAME

ImageStatistics - get image statistics

## SYNOPSIS

**astimgstat** \[*OPTION*...\] *ASTRdata*

## 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.

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.

-

  info astimgstat

-

  info ImageStatistics

-

  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

ImageStatistics options:

-

  Input:

- **-d**, **--mirrordist**=*FLT*

  Distance beyond mirror point. Multiple of std.

- **-h**, **--hdu**=*STR*

  Extension name or number of input data.

- **-H**, **--mhdu**=*STR*

  Mask image header name.

- **-M**, **--mask**=*STR*

  Mask image file name.

- **-r**, **--ignoremin**

  Ignore data with values equal to minimum.

-

  Output:

- **-A**, **--noasciihist**

  Do not show an ASCII histogram of the data.

- **-B**, **--onebinvalue**=*FLT*

  Shift bins so one bin starts on this value.

- **--checkmode**

  Mode mirror plot. \`\_modehist.txt', \`\_modecfp.txt'

- **-D**, **--dontdelete**

  Don't delete output if it exists.

- **--histrangeformirror**

  Use input histogram range for mirror plots.

- **-K**, **--keepinputdir**

  Do not remove input's dir info for output.

- **-l**, **--lowerbin**

  Interval lower limit for column 1.

- **--mirrorplotdist**=*FLT*

  Distance beyond mode to display.

- **--mirrorquant**=*FLT*

  Mirror quantile. \`\_mirhist.txt', \`\_mircfp.txt'.

- **-o**, **--output**=*STR*

  Output file or directory name.

-

  Histogram (suffix: \`\_hist.txt'):

- **-i**, **--histmin**=*FLT*

  The minimum value for the histogram.

- **--maxhistone**

  Scale such that the maximum bin has value of one.

- **--nohist**

  Do not calculate histogram.

- **--normhist**

  Normalize the  histogram (sum of all bins 1).

- **-n**, **--histnumbins**=*INT*

  Number of bins in the histogram.

- **-Q**, **--histquant**=*FLT*

  Quantile (Q) range. Histogram from Q to 1-Q.

- **-x**, **--histmax**=*FLT*

  The maximum value for the histogram.

-

  Cumulative Frequency Plot (suffix: \`\_cfp.txt'):

- **-a**, **--cfpmin**=*FLT*

  Minimum value to use in the CFP.

- **-b**, **--cfpmax**=*FLT*

  Maximum value to use in the CFP.

- **--cfpsimhist**

  Set CFP range and bins similar to histogram.

- **--maxcfpeqmaxhist**

  Set maximum of CFP to maximum of histogram.

- **--nocfp**

  No Cumulative Frequency Plot.

- **--normcfp**

  Normalize the CFP (sum of all bins 1).

- **-p**, **--cfpnum**=*INT*

  Number of data points to find CFP.

- **-U**, **--cfpquant**=*FLT*

  Quantile of range: from U to 1-U.

-

  Sigma clipping:

- **-g**, **--sigclipnum**=*INT*

  Number of times to do sigma clipping.

- **--nosigclip**

  Do not preform sigma clipping.

**-t**, **--sigcliptolerance**=*FLT* Difference in STD tolerance to halt iteration.

- **-u**, **--sigclipmultip**=*FLT*

  Multiple of standard deviation in sigma-clipping.

-

  Operating modes:

- \-?, **--help**

  give this help list

- **--cite**

  BibTeX citation for ImageStatistics.

- **--nolog**

  No log file for programs which make one.

- **-N**, **--numthreads**=*INT*

  Number of CPU threads to use.

- **--onlydirconf**

  Only read current directory configuration file.

- **--onlyversion**=*STR*

  Only run if the program version is this.

- **-P**, **--printparams**

  Print parameter values to be used and abort.

- **-q**, **--quiet**

  Only report errors, remain quiet about steps.

- **--setusrconf**

  Set default values for this user and abort.

- **-S**, **--setdirconf**

  Set default values for this directory and abort.

- **--usage**

  give a short usage message

- **-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/

## AUTHOR

Written by Mohammad Akhlaghi

## REPORTING BUGS

Report bugs to bug-gnuastro@gnu.org.

## COPYRIGHT

Copyright © 2015-2016, 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.

## SEE ALSO

The full documentation for **ImageStatistics** is maintained as a Texinfo manual.  If the **info** and **ImageStatistics** programs are properly installed at your site, the command

-

  **info ImageStatistics**

should give you access to the complete manual.