flatbat (1) - Linux Manuals

flatbat: CCD flat-frame correction

NAME

flatbat - CCD flat-frame correction

SYNOPSIS

flatbat [options] flat=file source_file ...

DESCRIPTION

The Flatbat program applies flat-field correction to a set of source frames. It means, that it divides the source frames by the flat frame pixel-by-pixel and the result is multiplied by median value of the flat frame. The resulting image is written to output file.

The source frames and also flat frame must be in FITS format and of same dimensions. Frames of the same exposition duration and color filter should be used. The output file is in FITS format too.

OPTIONS

The list of input files is usualy entered directly on the command line. If you are going to process a large set of files, you can use the question marks (for a single chars) or the asterisk (for a strings of chars).

The alternate way, how to process a large set of files, is the batch mode. In this mode, the list of input files is read from a given file or from the standard input. The directory file, for example named dirfile, must have the text format and the names of the input files are written on the separate lines. If the files are placed not in the current working directory, you have to specify the proper path in full or shortened form.

The mask parameters allows to set the naming of output files. The mask consists of letters, numbers and other characters allowed in the file name by the operating system. The special meaning has the question mark or the sequence of it. They will be replaced by the ordinal number of the output file, the number is always indented by leading zeros to the same number of decimal places as the number of the question marks. For example, when the mask fout????.fts is given, the output files named fout0001.fts, fout0002.fts, fout0003.fts will be generated.

@dirfile

The program will read the list of source files from specified file.

@

The program will read the list of source files from stdin.

flat=file, -ffile

Name of the flat-frame file.

mask=mask, -omask

Mask of the output file(s). Default is fout????.fts.

-cx

Initial counter value. Default is 1.

--help

Prints short help.

--license

Prints the license.

--version

Prints the program name and its version.

--quiet

Quiet mode -- inhibits the screen printouts.

--debug

Debug mode -- extends the screen printouts.

EXAMPLES

The following command applies flat-frame correction to 'dout0001.fts' using 'flat.fts' as flat frame. The output is writted to 'fout0001.fts'.

flatbat flat=flat.fts fout0001.fts

EXIT STATUS

flatbat returns a zero exist status if it succeeds to convert all specified file. Otherwise, it will stop immediately when the error occurs and returns nonzero code.

DIRECTORIES

~/.cmunipack /usr/local/share/cmunipack

AUTHORS

The project manager David Motl is also the author of the most part of the source codes. Some algorithms originates from Munipack package, coded by Filip Hroch. Algorithms for aperture photometry originates from Daophot software by P. B. Stetson. Munifind algorithm originates from Varfind tool written by Rudolf Novak and Lukas Kral.

The package uses the FITSIO library (Dr. William Pence, NASA), the FreeImage library maintained by Herve Drolon and the James Clark's EXPAT library.

The english version of the documentation was written by David Motl with great help of Petr Lutcha and Jitka Kudrnacova.

BUG REPORTS

David Motl (dmotl [at] volny.cz)

COPYING

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.