NAME¶

SYNOPSIS¶

DESCRIPTION¶

For more information, please run any of the following commands. In particular the second contains a very comprehensive explanation of Segment's invocation: expected input(s), output(s), and a full description of all the options.

All options and their values:

$ astsegment -P

Inputs/Outputs and options:

$ info astsegment

Full section in manual/book:

$ info Segment

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

Segment options:

Input:

--chdu=STR

HDU/extension of convolved image in file.

--convolved=STR

Convolved image file to avoid convolution.

-d, --detection=STR

Filename of detection image (to segment).

--dhdu=STR

HDU containing detection image.

-h, --hdu=STR/INT

Extension name or number of input data.

-k, --kernel=STR

Filename of kernel to convolve with input.

--khdu=STR

HDU containing kernel image.

--sky=STR/FLT

Filename of Sky values image to subtract.

--skyhdu=STR

HDU containing Sky value to subtract.

--std=STR/FLT

Filename of Sky standard deviation.

--stdhdu=STR

HDU containing Sky standard deviation.

--variance

STD input is actually variance.

Tessellation (tile grid):

--checktiles

Tile IDs in an image, the size of input.

-F, --remainderfrac=FLT

Fraction of remainder to split last tile.

--interpnumngb=INT

No. of neighbors to use for interpolation.

--interponlyblank

Only interpolate over the blank tiles.

-L, --largetilesize=INT[,INT]

Sim. to --tilesize, but for larger tiles.

-M, --numchannels=INT[,..] No. of channels in dim.s (FITS order).

--oneelempertile

Display 1 element/tile, not full input res.

--workoverch

Work (not tile) over channel edges.

-Z, --tilesize=INT[,INT]

Regular tile size on dim.s (FITS order).

Output:

-D, --dontdelete

Don't delete output if it exists.

-K, --keepinputdir

Keep input directory for automatic output.

--onlyclumps

Finish after finding true clumps.

-o, --output=STR

Output file name.

--rawoutput

Output only object and clump labels.

--tableformat=STR

`txt', `fits-ascii', `fits-binary'.

Segmentation:

-B, --minskyfrac=FLT

Min. fraction of undetected area in tile.

--checksegmentation

Store segmentation steps in a file.

--checksn

Save clump S/N values into a file.

-c, --snquant=FLT

S/N Quantile of true sky clumps.

--grownclumps

Save grown clumps instead of original.

-G, --gthresh=FLT

Multiple of STD to stop growing clumps.

--minima

Built internal clumps from minima.

-m, --snminarea=INT

Minimum area of clumps for S/N estimation.

--minnumfalse=INT

Minimum number for S/N estimation.

-O, --objbordersn=FLT

Min. S/N for grown clumps as one object.

-s, --clumpsnthresh=FLT

S/N threshold of true clumps.

-v, --keepmaxnearriver

Keep clumps with peak touching a river.

-y, --minriverlength=INT

Minimum len of useful grown clump rivers.

Operating modes:

-?, --help

give this help list

--cite

BibTeX citation for this program.

--config=STR

Read configuration file STR immediately.

-C, --continueaftercheck

Continue processing after checks.

--lastconfig

Do not parse any more configuration files.

--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¶

COPYRIGHT¶

Written/developed by Mohammad Akhlaghi

SEE ALSO¶

info Segment

should give you access to the complete manual.