File: man_setup.html

package info (click to toggle)
munipack 0.6.2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 33,104 kB
  • sloc: cpp: 29,677; sh: 4,909; f90: 2,872; makefile: 278; python: 140; xml: 72; awk: 12
file content (134 lines) | stat: -rw-r--r-- 5,166 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- meta -->
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="A general astronomical image processing software">
<meta name="author" content="Filip Hroch">
<link href="news_feed.xml" type="application/atom+xml" rel="alternate" title="Sitewide ATOM Feed" />
<link rel="stylesheet" href="munipack.css">
<link rel="shortcut icon" href="favicon.ico">
<title>Munipack ‒ Setup</title>
</head>
<body>
<header>
  <a href="munipack.html"><img src="big_logo.png" alt="Munipack's logo" class="head"></a>
  <div class="headtitles">
    <p class="head">
      <a class="headtitle" href="munipack.html">Munipack</a>
    </p>
    <p class="head">
      <a class="headsubtitle" href="munipack.html">The astronomical image processing software</a>
    </p>
  </div>
  <div class="buttons">
    <a href="guide.html" class="button">
      <div class="bicon">
	📘
      </div>
      <div class="hide">
	Guide
      </div>
    </a>
    <a href="docs.html" class="button">
      <div class="bicon">
	📁
      </div>
      <div class="hide">
	Documents
      </div>
    </a>
  </div>
</header>
<section>

  <h1>Setup</h1>

<p class="abstract">
  Munipack reads many important data needed for processing from FITS headers.
  The data are coded in the form KEYWORD=VALUE like a dictionary. Both the
  keywords and values are standardized, but there is many local conventions
  and differences and specificatiions in naming KEYWORD conventions.
  Therefore, there are a list of keywords recognized by Munipack together
  with default values.
</p>

<p>
  How to set the values for command <samp>munipack</samp> is described in
  <a href="man_env.html">Environment variables</a> document.
</p>

<p>
A file mostly comply with
<a href="http://heasarc.gsfc.nasa.gov/docs/fcg/standard_dict.html">FITS Standard</a>
will not need redefine none of the keywords (except some local conventions).
</p>

<p>
  Just for instance. Many software keeps the exposure time in FITS header
  in the keyword EXPOSURE. Munipack expects the same quantity in the keyword
  EXPTIME (see table below). Using of the command
</p>
<pre>
  export FITS_KEY_EXPTIME="EXPOSURE"
</pre>
<p>
  replaces the default value. Similar way can be used in all other cases.
</p>

<h2 id="preprocenv">Keywords Affecting Preprocessing</h2>

<div class="table">
<table>
<caption>Preprocessing variables</caption>
<tr><th>Variable</th><th>Default</th><th>Description</th></tr>
<tr><td><samp>MUNIPACK_TEMPERATURE_TOLERANCE</samp></td><td>1°C</td><td>maximal temperature difference between frames in Celsius degrees</td></tr>
<tr><td><samp>MUNIPACK_EXPTIME_TOLERANCE</samp></td><td>1 μs</td><td>maximal difference between exposure times of frames in seconds</td></tr>
</table>
</div>

<p>
  The variables are used by bias, dark and phcorr.
</p>


<h2>Keywords Affecting Photometry Calibration</h2>

<h2>General Usage Keywords</h2>


<h2>General Usage Keywords</h2>

<h2>FITS environment variables</h2>

<div class="table">
<table>
<caption>FITS environment keywords</caption>
<tr><th>Variable</th><th>Default</th><th>Identifies of</th></tr>
<tr><td><samp>FITS_KEY_FILTER</samp></td><td><samp>FILTER</samp></td><td>the photometric filter</td></tr>
<tr><td><samp>FITS_KEY_EXPTIME</samp></td><td><samp>EXPTIME</samp></td><td>the exposure time</td></tr>
<tr><td><samp>FITS_KEY_TEMPERATURE</samp></td><td><samp>TEMPERAT</samp></td><td>the temperature of camera</td></tr>
<tr><td><samp>FITS_KEY_AIRMASS</samp></td><td><samp>AIRMASS</samp></td><td>airmass</td></tr>
<tr><td><samp>FITS_KEY_DATEOBS</samp></td><td><samp>DATE-OBS</samp></td><td>the start of exposure</td></tr>
<tr><td><samp>FITS_KEY_TIMEOBS</samp></td><td><samp>TIME-OBS</samp></td><td>the start of exposure (legacy)</td></tr>
<tr><td><samp>FITS_KEY_OBJECT</samp></td><td><samp>OBJECT</samp></td><td>the object identifier</td></tr>
<tr><td><samp>FITS_KEY_IMAGETYP</samp></td><td><samp>IMAGETYP</samp></td><td>imagetyp: light, flat, dark</td></tr>
<tr><td><samp>FITS_KEY_SATURATE</samp></td><td><samp>SATURATE</samp></td><td>detector saturation (full well capacity) on ADU</td></tr>
<tr><td><samp>FITS_KEY_READNOISE</samp></td><td><samp>READNS</samp></td><td>read noise in ADU</td></tr>
<tr><td><samp>FITS_KEY_GAIN</samp></td><td><samp>GAIN</samp></td><td>amplifier gain in electrons per ADU</td></tr>
<tr><td><samp>FITS_KEY_AREA</samp></td><td><samp>AREA</samp></td><td>area of detector in square meters</td></tr>
<tr><td><samp>FITS_KEY_EPOCH</samp></td><td><samp>EPOCH</samp></td><td>reference time epoch</td></tr>
<tr><td><samp>FITS_KEY_LATITUDE</samp></td><td><samp>LATITUDE</samp></td><td>geographical latitude of station in degrees, north positive (+north)</td></tr>
<tr><td><samp>FITS_KEY_LONGITUDE</samp></td><td><samp>LONGITUD</samp></td><td>geographical longitude of station in degrees, east positive (-west)</td></tr>
</table>
</div>

</section>
<footer>
  © 1997 – 2025
  <a href="https://integral.physics.muni.cz/" title="author's homepage"
   class="foot">Filip Hroch</a>
</footer>
</body>
</html>