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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
|
/* -*- Mode: C; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim:set sw=2 sts=2 et cin: */
/*
* This file is part of the MUSE Instrument Pipeline
* Copyright (C) 2007-2015 European Southern Observatory
*
* 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; either version 2 of the License, or
* (at your option) any later version.
*
* 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.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
#include <muse.h>
#include <string.h>
/*----------------------------------------------------------------------------*/
/**
* @defgroup tools_musetraceplotsamples Tool muse_trace_plot_samples
*
* <b>muse_trace_plot_samples</b>: Plot tracing sample points.
*
* Debug tracing issues using a graphical representation of the tracing sampling
* points written into the TRACE_SAMPLES table by the muse_flat recipe.
*
* <b>Command line arguments:</b>
* - <tt>-s1 first_slice</tt> (optional, default: 24)\n
* first slice number for plotting
* - <tt>-s2 last_slice</tt> (optional, default: 25)\n
* last slice number for plotting
* - <tt>-n nifu</tt> (optional, default: load first FITS extension with data)\n
* IFU/channel number to use
* - <tt><b>TRACE_SAMPLES</b></tt>\n
* the filename of the tracing samples file to use
* - <tt>TRACE_TABLE</tt> (optional)\n
* filename of a tracing table (as produced by the MUSE pipeline) to
* overplot the tracing solution
* - <tt>MASTER_FLAT</tt> (optional)\n
* filename of a master flat image (as produced by the MUSE pipeline) for
* background display
*
* @note Plotting performance is affected a lot by the number of slices plotted
* and the use of a flat-field image for background display
*
* <b>Return values:</b>
* - <tt> 0</tt>\n Success
* - <tt> 1</tt>\n no filename given
* - <tt> 2</tt>\n argument <tt>-s1</tt> without any number
* - <tt> 3</tt>\n argument <tt>-s2</tt> without any number
* - <tt> 4</tt>\n argument <tt>-n</tt> without any number
* - <tt> 5</tt>\n argument <tt>-n</tt> with invalid IFU number
* - <tt> 9</tt>\n unknown option given
* - <tt>10</tt>\n samples table could not be loaded from file
* - <tt>11</tt>\n file does not seem to contain a MUSE samples table
* - <tt>12</tt>\n temporary file for plotting could not be created
* - <tt>20</tt>\n the platform does not support pipes [popen()/pclose()]
* - <tt>21</tt>\n gnuplot could not be opened
* - <tt>50</tt>\n unknown error
*
* @note This program only works, if the gnuplot plotting program is installed.
*/
/*----------------------------------------------------------------------------*/
/**@{*/
#define PRINT_USAGE(rc) \
fprintf(stderr, "Usage: %s [ -s1 first_slice ] [ -s2 last_slice ] " \
"[ -n nifu ] TRACE_SAMPLES [ TRACE_TABLE ] [ MASTER_FLAT ]\n", \
argv[0]); \
cpl_end(); return (rc);
int main(int argc, char **argv)
{
cpl_init(CPL_INIT_DEFAULT);
muse_processing_recipeinfo(NULL);
if (argc <= 1) {
/* filename is needed at least */
PRINT_USAGE(1);
}
char *tsname = NULL, /* samples table */
*ttname = NULL, /* trace table */
*iname = NULL; /* master flat image */
short slice1 = 24,
slice2 = 25;
unsigned char nifu = 0; /* IFU number to load */
/* argument processing */
int i;
for (i = 1; i < argc; i++) {
if (strncmp(argv[i], "-s1", 4) == 0) {
/* skip to next arg to first slice number */
i++;
if (i < argc) {
slice1 = atoi(argv[i]);
} else {
PRINT_USAGE(2);
}
} else if (strncmp(argv[i], "-s2", 4) == 0) {
/* skip to next arg to last slice number */
i++;
if (i < argc) {
slice2 = atoi(argv[i]);
} else {
PRINT_USAGE(3);
}
} else if (strncmp(argv[i], "-n", 3) == 0) {
/* skip to next arg to get extension name */
i++;
if (i < argc) {
nifu = atoi(argv[i]);
if (nifu == 0 || nifu > kMuseNumIFUs) {
PRINT_USAGE(5);
}
} else {
PRINT_USAGE(4);
}
} else if (strncmp(argv[i], "-", 1) == 0) { /* unallowed options */
PRINT_USAGE(9);
} else {
if (tsname && ttname && iname) {
break; /* we have the possible names, skip the rest */
}
if (!tsname) {
tsname = argv[i]; /* set the name for the samples table */
} else if (!ttname) {
ttname = argv[i]; /* set the name for the trace table */
} else {
iname = argv[i] /* set the name for the master flat image */;
}
}
} /* for i (all arguments) */
int iext = 1;
if (nifu) {
iext = muse_utils_get_extension_for_ifu(tsname, nifu);
}
cpl_table *ts = cpl_table_load(tsname, iext, 1);
if (!ts) {
/* fail, this is mandatory */
PRINT_USAGE(10);
}
cpl_propertylist *header = cpl_propertylist_load(tsname, iext);
char *extname = NULL;
if (cpl_propertylist_has(header, "EXTNAME")) {
extname = cpl_sprintf("[%s]", muse_pfits_get_extname(header));
}
printf("MUSE TRACE_SAMPLES table \"%s%s\", contains %"CPL_SIZE_FORMAT" rows\n",
tsname, extname ? extname : "", cpl_table_get_nrow(ts));
cpl_free(extname);
extname = NULL;
cpl_propertylist_delete(header);
cpl_table *tt = NULL;
if (ttname) {
iext = 1;
if (nifu) {
iext = muse_utils_get_extension_for_ifu(ttname, nifu);
}
tt = cpl_table_load(ttname, iext, 1);
header = cpl_propertylist_load(ttname, iext);
if (cpl_propertylist_has(header, "EXTNAME")) {
extname = cpl_sprintf("[%s]", muse_pfits_get_extname(header));
}
cpl_propertylist_delete(header);
/* if loading didn't work, just warn, this should *
* not be fatal,we can still plot the sample points */
if (!tt) {
fprintf(stderr, "%s: loading the TRACE_TABLE \"%s%s\" failed: %s\n",
argv[0], ttname, extname ? extname : "", cpl_error_get_message());
} else {
printf("MUSE TRACE table \"%s%s\", contains %"CPL_SIZE_FORMAT" rows\n",
ttname, extname ? extname : "", cpl_table_get_nrow(tt));
}
cpl_free(extname);
extname = NULL;
}
muse_image *image = NULL;
if (iname) {
if (nifu) {
image = muse_image_load_from_extensions(iname, nifu);
}
if (!image) {
image = muse_image_load(iname);
}
/* if loading didn't work, just warn, this should *
* not be fatal,we can still plot the sample points */
if (image) { /* error message comes from the library if not found */
extname = cpl_sprintf("[%s]", muse_pfits_get_extname(image->header));
printf("MUSE MASTER_FLAT image \"%s%s\", has size "
"%"CPL_SIZE_FORMAT"x%"CPL_SIZE_FORMAT"\n", iname, extname,
cpl_image_get_size_x(image->data), cpl_image_get_size_y(image->data));
cpl_free(extname);
extname = NULL;
}
}
cpl_error_code rc = muse_trace_plot_samples(ts, tt, slice1, slice2, nifu,
image);
switch (rc) {
case CPL_ERROR_NONE:
rc = 0;
break;
case CPL_ERROR_ILLEGAL_INPUT:
fprintf(stderr, "%s: \"%s\" does not seem to contain a MUSE tracing "
"samples table!\n", argv[0], tsname);
rc = 11;
break;
case CPL_ERROR_FILE_NOT_CREATED:
/* use manipulated CPL error message to show the failing file name */
fprintf(stderr, "%s: %s (temporary file for plotting)\n",
argv[0], cpl_error_get_message());
rc = 12;
break;
case CPL_ERROR_UNSUPPORTED_MODE:
fprintf(stderr, "%s: your platform does not seem to support pipes "
"[popen()/pclose()]!\n", argv[0]);
rc = 20;
break;
case CPL_ERROR_ASSIGNING_STREAM:
fprintf(stderr, "%s: could not open gnuplot (this tool uses it for "
"plotting)!\n", argv[0]);
rc = 21;
break;
default:
rc = 50;
} /* switch */
cpl_table_delete(ts);
cpl_table_delete(tt);
muse_image_delete(image);
cpl_end();
return rc;
}
/**@}*/
|
