source: trunk/MagicSoft/Simulation/Detector/Camera/creadparam.h@ 2337

Last change on this file since 2337 was 2337, checked in by blanch, 21 years ago
Hedaer file for creadparam.cxx 1.21
File size: 10.8 KB
Line 
1//=//////////////////////////////////////////////////////////////////////
2//=
3//= creadparam
4//=
5//= @file creadparam.h
6//= @desc Header file
7//= @author J C Gonzalez
8//= @email gonzalez@mppmu.mpg.de
9//= @date Thu May 7 16:24:22 1998
10//=
11//=----------------------------------------------------------------------
12//=
13//= Created: Thu May 7 16:24:22 1998
14//= Author: Jose Carlos Gonzalez
15//= Purpose: Program for reflector simulation
16//= Notes: See files README for details
17//=
18//=----------------------------------------------------------------------
19//=
20//= $RCSfile: creadparam.h,v $
21//= $Revision: 1.18 $
22//= $Author: blanch $
23//= $Date: 2003-09-15 10:23:31 $
24//=
25//=//////////////////////////////////////////////////////////////////////
26
27// @T \newpage
28
29//!@section Source code of |creadparam.h|.
30
31/*!@"
32
33 In this section you can find the source code for the file
34 |creadparam.h|. This file is mainly needed by
35 |creadparam.cxx|. Here is located the definition of the commands you
36 can use in the parameters file. In this file, the first line must be
37 |camera 'version'|, where |'version'| is the appropiate version of
38 the output format (NOT the version of the camera program) which can
39 read the commands written in that parameters file. You cannot mix
40 parameters files and executables with different versions. The
41 current version is |camera 0.2|.
42
43 The commands now available for the parameters file are:
44
45 @itemize
46
47 @- |input_file| filename :
48 Sets the name of the input file (|.rfl|).
49 @- |starfield_file| filename :
50 Sets the name of the starfield input file (|.rfl|).
51 @- |ct_file| filename :
52 Sets the name of the CT definition file (|.def|).
53 @- |data_file| filename :
54 Sets the name of the output data file (|.dat|).
55 @- |elec_noise_off| :
56 De-activates ElecNoise for FADC and Trigger channels. By default it is on.
57 @- |fadc_noise_off| :
58 Sets the ElecNoise for FADC.
59 @- |trig_noise_off| :
60 Sets the ElecNoise for trigger system.
61 @- |nsb_on| :
62 Activates the NSB simulation. This is the default.
63 @- |nsb_off| :
64 De-activates the NSB simulation.
65 @- |nsb_mean| number :
66 Sets the mean value for the NSB.
67 Default value: 6 for CT1, 6 for MAGIC.
68 This implies always |nsb_on|.
69 @- |threshold| number :
70 Sets the Threshold value q0. Default value: 10.
71 @- |tail_cut| number :
72 Sets the Tail-Cut value.
73 Default value: 7.
74 @- |islands_cut| number :
75 Sets the Islands-Cut value i0.
76 Default value: 10.
77 @- |end_file|
78 Last command in the parameters file.
79
80 @enditemize
81
82 @ignoreHTML
83 A parameters file (a small one) looks like this:
84
85 |camera 0.2|
86
87 |input_file gm100-500.rfl|
88
89 |output_file gm100-500.phe|
90
91 |output_file gm100-500.dat|
92
93 |ct_file magic.def|
94
95 |threshold 10.0|
96
97 |tail_cut 7.0|
98
99 |nsb_mean 5.0|
100
101 |end_file|
102 @endignoreHTML
103
104@"*/
105
106//!@{
107
108#ifndef _creadparam_
109#define _creadparam_
110
111#ifndef _this_
112#define _this_ creadparam
113#endif
114
115//!@}
116
117//!@subsection Include files.
118
119//!@{
120
121#include <iostream.h>
122#include <fstream.h>
123#include <stdlib.h>
124#include <stdio.h>
125#include <string.h>
126#include <math.h>
127#include <float.h>
128
129#include "jcmacros.h"
130#include "jcdebug.h"
131
132#include "camera-v.h"
133
134#include "MTriggerDefine.h"
135#include "MFadcDefine.h"
136#include "Mdefine.h"
137
138//!@}
139
140//!@subsection Macro-definitions, and constants.
141
142//!@{
143
144// now we define the list PM_ITEM_LIST of possible items in
145// the parameters file. note that they are functions of
146// T(x). we will change T(x) to be the real item or the
147// string of this item when needed
148
149#define PM_ITEM_LIST /* LIST OF ITEMS IN THE PARAMETERS FILE */ \
150T(input_file), /* input file */ \
151T(starfield_file), /* starfield file */ \
152T(starfield_center),/* center of thestarfield FOV */ \
153T(data_file), /* data file */ \
154T(root_file), /* ROOT file */ \
155T(ct_file), /* file with the characteristics of the CT */ \
156T(ct_num), /* number of CT, which is number of reflector files */ \
157T(ct_geom), /* class with the geometry of the CT camera */ \
158T(qe_file), /* file with the characteristics of the CT */ \
159T(ana_pixels), /* size of the camera for parameters calculation */ \
160T(elec_noise_off), /* de-activates ElecNoise for FADC and Trigger channels */\
161T(fadc_pedestal), /* Pedestal value for FADC */\
162T(fadc_noise), /* ElecNoise for FADC */\
163T(trig_noise), /* ElecNoise for trigger */\
164T(sfr_on), /* starfield rotation */ \
165T(nsb_on), /* activates NSB simulation */ \
166T(nsb_off), /* de-activates NSB simulation */ \
167T(nsb_mean), /* mean value of NSB contribution per pixel */ \
168T(nsb_directory), /* database for the NSB */ \
169T(nsb_dir_outer), /* database for the NSB */ \
170T(pixel_thres), /* value of q0 for trigger for a given pixel */ \
171T(secure_disc), /* Ac value to rise discrimnator threshold */ \
172T(seeds), /* seeds for random number generation */ \
173T(data_from_stdin), /* to read data from STDIN */ \
174T(skip), /* skip pathological showers */ \
175T(write_all_events),/* write to file .phe ALL images (even w.o. trigger)*/ \
176T(nowrite_McEvt), /* nowrite to file .root McEvt infos */ \
177T(write_McTrig), /* write to file .root McTrig infos */ \
178T(write_McFadc), /* write to file .root McFadc infos */ \
179T(nowrite_RawEvt), /* write to file .root RawData infos */ \
180T(write_all_data), /* write to file .dat ALL image data */ \
181T(select_energy), /* energy range to read: only for .phe files */ \
182T(trigger_scan), /* show signal in the diskriminator */ \
183T(fadc_scan), /* show fadc signal */ \
184T(trigger_loop), /* make loop over trigger conditions */ \
185T(trigger_prop), /* values of trigger properties */ \
186T(fadc_prop), /* values of fadc properties */ \
187T(fadc_outer), /* values of fadc properties for outer pixels */ \
188T(trigger_single), /* trigger conditions */ \
189T(Trigger_Loop_Output_Only_Specialists), /* special steercard */ \
190T(source_offset), /* Displacement of the source from the center */ \
191T(end_file) /* end of the parameters file */
192
193#define T(x) x // define T() as the name as it is
194
195enum ITEM_TYPE {
196 PM_ITEM_LIST
197};
198
199#undef T
200
201#define T(x) #x // define T() as the string of x
202
203const char *const ITEM_NAMES[] = {
204 PM_ITEM_LIST
205};
206
207#undef T
208
209#define LINE_MAX_LENGTH 400
210#define ITEM_MAX_LENGTH 40
211#define PATH_MAX_LENGTH 120
212
213//!@}
214
215//!@subsection Prototypes of functions.
216
217//!@{
218
219//++
220// prototypes
221//--
222
223void readparam(char * filename);
224char *get_input_filename(int i);
225char *get_starfield_filename(void);
226void get_starfield_center(int *rh,int *rm,int *rs,int *dd,int *dm,int *ds);
227int get_starfield_rotate(void);
228char *get_data_filename(void);
229char *get_root_filename(void);
230char *get_loop_filename(void);
231char *get_ct_filename(void);
232int get_ct_number(void);
233int get_ct_geometry(void);
234char *get_qe_filename(int ict=0);
235char *get_nsb_directory(void);
236char *get_nsb_directory_outer(void);
237int add_elec_noise(float *fadc, float *trig);
238int get_nsb(float *n, int *m);
239long int get_seeds(int n);
240int get_ana_pixels(void);
241void get_skip_showers( int *s );
242int get_nskip_showers( void );
243int get_data_from_stdin(void);
244int get_write_all_events(void);
245int get_write_McEvt(void);
246int get_write_McTrig(void);
247int get_write_McFadc(void);
248int get_write_RawEvt(void);
249int get_write_all_data(void);
250int get_select_energy(float *le, float *ue);
251int get_FADC_Scan(void);
252int get_Trigger_Scan(void);
253void get_Trigger_properties(float *gl, float *ot, float *ra, float *rf);
254void get_FADC_properties(float *ra, float *rf, float *rao, float *rfo);
255float get_FADC_pedestal(void);
256int get_Trigger_Loop(float *lt, float *ut, float *st, int *lm, int *um, int *lg, int *ug);
257void get_Trigger_Single(float **t, int *m, int *g);
258void get_threshold(float *t);
259void get_secure_threhold(float *ac, float *disc);
260int get_indi_thres_pixel(void);
261void get_source_off(float *th, float *p);
262//!@}
263
264//!@{
265
266#endif // ! _creadparam_
267
268//!@}
269
270//=------------------------------------------------------------
271//!@subsection Log of this file.
272
273//!@{
274
275/*
276 * $Log: not supported by cvs2svn $
277 * Revision 1.17 2003/07/17 18:05:13 blanch
278 * Header file for creadparam.cxx 1.20
279 *
280 * Revision 1.16 2003/01/14 13:37:32 blanch
281 * Option to set a dc value to rise the discriminator threshold has been added.
282 *
283 * Revision 1.15 2002/07/16 16:20:59 blanch
284 * Modifications done for the camera.cxx version, where a first implementation
285 * of the Star Field Rotation has been introduced.
286 *
287 * Revision 1.14 2002/03/15 15:17:57 blanch
288 * Header file for creadparam.cxx v 1.16
289 *
290 * Revision 1.13 2002/03/04 17:20:50 blanch
291 * Header file for creadparam.cxx 1.15
292 *
293 * Revision 1.12 2002/02/28 15:08:01 blanch
294 * Header file for creadparam.cxx 1.14.
295 *
296 * Revision 1.11 2002/01/18 17:45:37 blanch
297 * Header file for creadparam.cxx 1.13.
298 *
299 * Revision 1.10 2001/11/13 17:06:01 blanch
300 * Header file for creadparam.cxx version 1.12
301 *
302 * Revision 1.9 2001/07/19 09:29:02 blanch
303 * Header file for creadparam.cxx vrsion 1.10
304 *
305 * Revision 1.8 2001/03/05 10:44:44 blanch
306 * Header file of creadparam.cxx version 1.9
307 *
308 * Revision 1.7 2001/02/23 10:56:10 magicsol
309 * Header file for creadparam.cxx version 1.8
310 *
311 * Revision 1.6 2001/01/15 12:38:00 magicsol
312 * *** empty log message ***
313 *
314 * Revision 1.5 2000/07/04 14:13:34 MagicSol
315 * *** empty log message ***
316 *
317 * Revision 1.4 2000/05/11 14:23:28 blanch
318 * Thi version owns to the version 1.4 of creadparam.cxx.
319 *
320 * Revision 1.3 2000/03/24 18:15:46 blanch
321 * *** empty log message ***
322 *
323 * Revision 1.2 2000/02/18 17:50:07 petry
324 * This version belongs to camera.cxx 1.5.
325 * It version has been put in the repository in order to be
326 * able to share the further development with others.
327 *
328 * If you need something working, wait or take an earlier one.
329 * See file README
330 *
331 * Revision 1.1.1.1 1999/11/05 11:59:34 harald
332 * This the starting point for CVS controlled further developments of the
333 * camera program. The program was originally written by Jose Carlos.
334 * But here you can find a "rootified" version to the program. This means
335 * that there is no hbook stuff in it now. Also the output of the
336 * program changed to the MagicRawDataFormat.
337 *
338 * The "rootification" was done by Dirk Petry and Harald Kornmayer.
339 *
340 * Revision 1.2 1999/10/22 15:01:29 petry
341 * version sent to H.K. and N.M. on Fri Oct 22 1999
342 *
343 * Revision 1.1.1.1 1999/10/21 16:35:11 petry
344 * first synthesised version
345 *
346 * Revision 1.7 1999/03/15 14:59:09 gonzalez
347 * camera-1_1
348 *
349 * Revision 1.6 1999/03/02 09:56:13 gonzalez
350 * *** empty log message ***
351 *
352 * Revision 1.5 1999/01/14 17:32:43 gonzalez
353 * Added to camera the STDIN input option (data_from_input)
354 *
355 */
356
357//!@}
358//=EOF
Note: See TracBrowser for help on using the repository browser.