1flatbat(1) C-Munipack 1.2 flatbat(1)
2
6 flatbat - utility for flat-frame correction
7
9 flatbat [ options ] flat-file input-files ...
10
12 The flatbat command applies flat-field correction to a set of source
13 frames. It means, that it divides the source frames by the flat frame
14 pixel-by-pixel and the result is multiplied by median value of the flat
15 frame. The resulting image is written to output file.
16 The source frames and also flat frame must be in FITS format and of
18 same dimensions. The output file is in FITS format too.
19
21 Names of input files can be specified directly on a command-line as
22 command arguments; it is allowed to use the usual wildcard notation. In
23 case the input files are placed outside the working directory, you have
24 to specify the proper path relative to the current working directory.
25 Alternatively, you can also prepare a list of input file names in a
27 text file, each input file on a separate line. It is not allowed to use
28 the wildcard notation here. Use the -i option to instruct the program
29 to read the file.
30
32 By default, output files are stored to the current working directory.
33 Their names are derived from the command name followed by a sequential
34 number starting by 1. Command options allows a caller to modify the
35 default naming of output files:
36 The -o option sets the format string; it may contain a path where the
38 files shall be stored to. Special meaning has a sequence of question
39 marks, it is replaced by the ordinal number of a file indented by
40 leading zeros to the same number of decimal places as the number of the
41 question marks.
42 By means of the -i option, you can modify the initial value of a
44 counter.
45 On request, the program can write a list of output files to a text
47 file, use the -g option to specify a file name.
48
50 Options are used to provide extra information to customize the execu‐
51 tion of a command. They are specified as command arguments.
52 Each option has a full form starting with two dashes and an optional
54 short form starting with one dash only. Options are case-sensitive. It
55 is allowed to merge two or more successive short options together. Some
56 options require a value; in this case a value is taken from a subse‐
57 quent argument. When a full form is used, an option and its value can
58 also be separated by an equal sign. When a short form is used, its
59 value can immediately follow the option.
60 Whenever there is a conflict between a configuration file parameter and
62 an option of the same meaning, the option always take precedence.
63 -i, --read-dirfile filepath
65 read list of input files from specified file; see the Files sec‐
66 tion for details.
67 -g, --make-dirfile filepath
69 save list of output files to specified file, existing content of
70 the file will be overwritten; see the Files section for details.
71 -o, --output-mask mask
73 set output file mask (default=fout????.fts), see the Files sec‐
74 tion for details.
75 -c, --counter value
77 set initial counter value (default=1), see the Files section for
78 details.
79 -h, --help
81 print list of command-line parameters
82 -q, --quiet
84 quiet mode; suppress all messages
85 --version
87 print software version string
88 --licence
90 print software licence
91 --verbose
93 verbose mode; print debug messages
94
96 flatbat -oout.fts flat.fts in.fts
97 The command applies flat correction to in.fts using flat.fts as
98 a correction frame. The output is written to out.fts.
99
101 The command returns a zero exit status if it succeeds to process all
102 specified files. Otherwise, it will stop immediately when an error
103 occurs and a nonzero error code is returned.
104
106 http://c-munipack.sourceforge.net/
107
109 David Motl, dmotl@volny.cz
110
112 This program is free software; you can redistribute it and/or modify it
113 under the terms of the GNU General Public License version 2 as pub‐
114 lished by the Free Software Foundation.
115 This program is distributed in the hope that it will be useful, but
117 WITHOUT ANY WARRANTY; without even the implied warranty of MER‐
118 CHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
119 Public License for more details.
120
122 cmunipack(3), muniwin(1), meanbias(1), meandark(1), autoflat(1), bias‐
123 bat(1), darkbat(1), timebat(1), airmass(1), helcor(1), kombine(1),
124 konve(1), muniphot(1), munimatch(1), munilist(1)
125version 1.2.10 May 16, 2010 flatbat(1)