1darkbat(1) C-Munipack 1.2 darkbat(1)
2
6 darkbat - utility for dark correction
7
9 darkbat [ options ] dark-file input-files ...
10
12 The darkbat command applies dark correction to a set of source frames.
13 The source frames and the dark frame must be in the FITS format and of
15 same dimensions. The output file is written in the FITS format too.
16
18 Names of input files can be specified directly on a command-line as
19 command arguments; it is allowed to use the usual wildcard notation. In
20 case the input files are placed outside the working directory, you have
21 to specify the proper path relative to the current working directory.
22 Alternatively, you can also prepare a list of input file names in a
24 text file, each input file on a separate line. It is not allowed to use
25 the wildcard notation here. Use the -i option to instruct the program
26 to read the file.
27
29 By default, output files are stored to the current working directory.
30 Their names are derived from the command name followed by a sequential
31 number starting by 1. Command options allows a caller to modify the
32 default naming of output files:
33 The -o option sets the format string; it may contain a path where the
35 files shall be stored to. Special meaning has a sequence of question
36 marks, it is replaced by the ordinal number of a file indented by
37 leading zeros to the same number of decimal places as the number of the
38 question marks.
39 By means of the -i option, you can modify the initial value of a
41 counter.
42 On request, the program can write a list of output files to a text
44 file, use the -g option to specify a file name.
45
47 Options are used to provide extra information to customize the execu‐
48 tion of a command. They are specified as command arguments.
49 Each option has a full form starting with two dashes and an optional
51 short form starting with one dash only. Options are case-sensitive. It
52 is allowed to merge two or more successive short options together. Some
53 options require a value; in this case a value is taken from a subse‐
54 quent argument. When a full form is used, an option and its value can
55 also be separated by an equal sign. When a short form is used, its
56 value can immediately follow the option.
57 Whenever there is a conflict between a configuration file parameter and
59 an option of the same meaning, the option always take precedence.
60 -s, --set name=value
62 set value of configuration parameter
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=dout????.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 -p, --configuration-file filepath
81 read parameters from given configuration file. See the Configu‐
82 ration file section for details.
83 -h, --help
85 print list of command-line parameters
86 -q, --quiet
88 quiet mode; suppress all messages
89 --version
91 print software version string
92 --licence
94 print software licence
95 --verbose
97 verbose mode; print debug messages
98
100 Configuration files are used to set the input parameters to the process
101 that is going to be executed by a command. Use the -p option to
102 instruct the program to read the file before other command-line options
103 are processed.
104 The configuration file consists of a set of parameters stored in a text
106 file. Each parameter is stored on a separate line in the following
107 form: name = value, all other lines are silently ignored. Parameter
108 names are case-sensitive.
109 scaling = value
111 dark-frame scaling (0=disabled, 1=enabled)
112
114 darkbat -oout.fts dark.fts in.fts
115 The command applies the dark correction to the input file in.fts
116 using the file dark.fts as a correction frame. The output is
117 written to the output file out.fts.
118
120 The command returns a zero exit status if it succeeds to process all
121 specified files. Otherwise, it will stop immediately when an error
122 occurs and a nonzero error code is returned.
123
125 http://c-munipack.sourceforge.net/
126
128 David Motl, dmotl@volny.cz
129
131 This program is free software; you can redistribute it and/or modify it
132 under the terms of the GNU General Public License version 2 as pub‐
133 lished by the Free Software Foundation.
134 This program is distributed in the hope that it will be useful, but
136 WITHOUT ANY WARRANTY; without even the implied warranty of MER‐
137 CHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
138 Public License for more details.
139
141 cmunipack(3), muniwin(1), meanbias(1), meandark(1), autoflat(1), bias‐
142 bat(1), flatbat(1), timebat(1), airmass(1), helcor(1), kombine(1),
143 konve(1), muniphot(1), munimatch(1), munilist(1)
144version 1.2.10 May 16, 2010 darkbat(1)