1helcor(1) C-Munipack 1.2 helcor(1)
2
6 helcor - utility for computing heliocentric correction
7
9 helcor [ options ] input-files ...
10 helcor [ options ] -j julian-date
11
13 The helcor command computes value of heliocentric correction for given
14 julian date and object´s coordinates. It may also append the values to
15 a set of measurements stored in a text file.
16 When the -j option is present on the command line, the value of helio‐
18 centric correction is printed to the standard output stream.
19 If one or more filenames are present on the command line, each source
21 file given is processed line by line, the program expects the JD value
22 in the first column, which must be divided at least one of common used
23 dividers (semicolon, comma, space, tab char, ...). The JD value can be
24 in full (2453xxx.x) or short (53xxx.x) form. Decimal places must be
25 separated by point, not comma. The julian date is replaced by a cor‐
26 rected date and the value of correction may be optionally appended to
27 the end of the line. If the line starts with the text JD, it is consid‐
28 ered to be a table header and it is changed to JDHEL or JDGEO. The text
29 HELCOR is optionally appended to the end of the line. All other lines
30 which do not fit to any of previous rules are copied to the output file
31 without modification.
32
34 Names of input files can be specified directly on a command-line as
35 command arguments; it is allowed to use the usual wildcard notation. In
36 case the input files are placed outside the working directory, you have
37 to specify the proper path relative to the current working directory.
38 Alternatively, you can also prepare a list of input file names in a
40 text file, each input file on a separate line. It is not allowed to use
41 the wildcard notation here. Use the -i option to instruct the program
42 to read the file.
43
45 By default, output files are stored to the current working directory.
46 Their names are derived from the command name followed by a sequential
47 number starting by 1. Command options allows a caller to modify the
48 default naming of output files:
49 The -o option sets the format string; it may contain a path where the
51 files shall be stored to. Special meaning has a sequence of question
52 marks, it is replaced by the ordinal number of a file indented by
53 leading zeros to the same number of decimal places as the number of the
54 question marks.
55 By means of the -i option, you can modify the initial value of a
57 counter.
58 On request, the program can write a list of output files to a text
60 file, use the -g option to specify a file name.
61
63 Options are used to provide extra information to customize the execu‐
64 tion of a command. They are specified as command arguments.
65 Each option has a full form starting with two dashes and an optional
67 short form starting with one dash only. Options are case-sensitive. It
68 is allowed to merge two or more successive short options together. Some
69 options require a value; in this case a value is taken from a subse‐
70 quent argument. When a full form is used, an option and its value can
71 also be separated by an equal sign. When a short form is used, its
72 value can immediately follow the option.
73 Whenever there is a conflict between a configuration file parameter and
75 an option of the same meaning, the option always take precedence.
76 -j, --julian-date jd
78 compute and print air-mass coeficient for given julian date. Do
79 not combine this option with input file names.
80 -a, --right-ascension hhmmss
82 right ascension of object in hours, minutes and seconds
83 -d, --declination -ddmmss
85 declination of object in degrees, minutes and seconds
86 -s, --set name=value
88 set value of configuration parameter
89 -i, --read-dirfile filepath
91 read list of input files from specified file; see the Files sec‐
92 tion for details.
93 -g, --make-dirfile filepath
95 save list of output files to specified file, existing content of
96 the file will be overwritten; see the Files section for details.
97 -o, --output-mask mask
99 set output file mask (default=hcor????.dat), see the Files sec‐
100 tion for details.
101 -c, --counter value
103 set initial counter value (default=1), see the Files section for
104 details.
105 -p, --configuration-file filepath
107 read parameters from given configuration file. See the Configu‐
108 ration file section for details.
109 -h, --help
111 print list of command-line parameters
112 -q, --quiet
114 quiet mode; suppress all messages
115 --version
117 print software version string
118 --licence
120 print software licence
121 --verbose
123 verbose mode; print debug messages
124
126 Configuration files are used to set the input parameters to the process
127 that is going to be executed by a command. Use the -p option to
128 instruct the program to read the file before other command-line options
129 are processed.
130 The configuration file consists of a set of parameters stored in a text
132 file. Each parameter is stored on a separate line in the following
133 form: name = value, all other lines are silently ignored. Parameter
134 names are case-sensitive.
135 right-ascension = hhmmss
137 right ascension of object in hours, minutes and seconds
138 declination = -ddmmss
140 declination of object in degrees, minutes and seconds
141
143 helcor -a182932 -d223424 -j2452763.5670
144 The command computes and prints value of heliocentric correction
145 to the standard output. The object´s coordinates are R.A. = 18h
146 29m 32s, DEC. = +22d 34m 24s. Julian date of observation is
147 2452763.5670.
148 helcor -a182932 -d223424 -ohcor.dat table.dat
150 The command performs the heliocentric correction to the table
151 stored in table.dat file and the resulting table stores in
152 hcor.dat file. The object´s coordinates are the same as in pre‐
153 vious example.
154
156 The command returns a zero exit status if it succeeds to process all
157 specified files. Otherwise, it will stop immediately when an error
158 occurs and a nonzero error code is returned.
159
161 http://c-munipack.sourceforge.net/
162
164 David Motl, dmotl@volny.cz
165
167 This program is free software; you can redistribute it and/or modify it
168 under the terms of the GNU General Public License version 2 as pub‐
169 lished by the Free Software Foundation.
170 This program is distributed in the hope that it will be useful, but
172 WITHOUT ANY WARRANTY; without even the implied warranty of MER‐
173 CHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
174 Public License for more details.
175
177 cmunipack(3), muniwin(1), meanbias(1), meandark(1), autoflat(1), bias‐
178 bat(1), darkbat(1), flatbat(1), timebat(1), airmass(1), kombine(1),
179 konve(1), muniphot(1), munimatch(1), munilist(1)
180version 1.2.10 May 16, 2010 helcor(1)