Marianne Lemoine / ctools

Browse Code »

Commit e7ebf46977dd72f95401ec5b078fa53e4adb3289

Authored by Jürgen Knödlseder 2012-12-18 00:26:49 +0100

1 parent 8f5d4c0c

Add ctmodel description.

Inline Side-by-side

Showing 1 changed file with 505 additions and 0 deletions

doc/html/doc/ctmodel.html 0 → 100644

View file @e7ebf46

	1	+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
	2	+<html lang="en"><head>
	3	+<meta content="text/html; charset=ISO-8859-1" http-equiv="content-type"><title>ctmodel</title>
	4	+
	5	+<link rel="stylesheet" type="text/css" media="screen,print" href="../ctools.css">
	6	+<meta content="Jurgen Knodlseder" name="author">
	7	+<meta content="CTA modelling tool" name="description">
	8	+</head>
	9	+<body>
	10	+<p class="Header">ctmodel</p>
	11	+<p class="Body">Calculates model counts maps.</p>
	12	+<br>
	13	+<p class="Title">Synopsis</p>
	14	+<p style="padding-top: 0pt; text-align: left;" class="Body">This
	15	+tool computes model counts maps based on an XML model.
	16	+The maps are data cubes in Right Ascension or Galactic longitude,
	17	+Declination or Galactic latitude, and log(energy).</p>
	18	+<br>
	19	+<p class="Title">Links</p>
	20	+<ul class="Body">
	21	+<li><a href="ftools_usage.html">Basic FTOOL
	22	+Parameter Usage</a></li>
	23	+</ul>
	24	+<p style="padding-top: 0pt; text-align: left;" class="Body"></p>
	25	+<br>
	26	+<p class="Title">General parameters</p>
	27	+<table id="table1" class="Body" border="0" cellpadding="0" cellspacing="0" width="600">
	28	+<tbody>
	29	+<tr>
	30	+<td width="50"> </td>
	31	+<td colspan="2"><span class="irafpar"><strong>infile
	32	+[file]</strong></span></td>
	33	+</tr>
	34	+<tr>
	35	+<td width="50"> </td>
	36	+<td width="25"> </td>
	37	+<td width="525">Input counts map or observation
	38	+definition XML file.</td>
	39	+</tr>
	40	+<tr>
	41	+<td width="50"> </td>
	42	+<td> </td>
	43	+<td width="525"> </td>
	44	+</tr>
	45	+<tr>
	46	+<td width="50"> </td>
	47	+<td colspan="2"><span class="irafpar"><strong>outfile
	48	+[file]</strong></span></td>
	49	+</tr>
	50	+<tr>
	51	+<td width="50"> </td>
	52	+<td width="25"> </td>
	53	+<td width="525">Output model counts map or
	54	+observation definition XML file.</td>
	55	+</tr>
	56	+<tr>
	57	+<td width="50"> </td>
	58	+<td> </td>
	59	+<td width="525"> </td>
	60	+</tr>
	61	+<tr>
	62	+<td width="50"> </td>
	63	+<td colspan="2"><span class="irafpar"><strong>(prefix
	64	+= "modmap_")
	65	+[string]</strong></span></td>
	66	+</tr>
	67	+<tr>
	68	+<td width="50"> </td>
	69	+<td width="25"> </td>
	70	+<td width="525">Prefix for model counts maps in
	71	+observation definition file.</td>
	72	+</tr>
	73	+<tr>
	74	+<td width="50"> </td>
	75	+<td> </td>
	76	+<td width="525"> </td>
	77	+</tr>
	78	+<tr>
	79	+<td width="50"> </td>
	80	+<td colspan="2"><span class="irafpar"><strong>caldb
	81	+[string]</strong></span></td>
	82	+</tr>
	83	+<tr>
	84	+<td width="50"> </td>
	85	+<td width="25"> </td>
	86	+<td width="525">Calibration database.</td>
	87	+</tr>
	88	+<tr>
	89	+<td width="50"> </td>
	90	+<td> </td>
	91	+<td width="525"> </td>
	92	+</tr>
	93	+<tr>
	94	+<td width="50"> </td>
	95	+<td colspan="2"><span class="irafpar"><strong>irf
	96	+[string]</strong></span></td>
	97	+</tr>
	98	+<tr>
	99	+<td width="50"> </td>
	100	+<td width="25"> </td>
	101	+<td width="525">Instrument response function.</td>
	102	+</tr>
	103	+<tr>
	104	+<td width="50"> </td>
	105	+<td> </td>
	106	+<td width="525"> </td>
	107	+</tr>
	108	+<tr>
	109	+<td width="50"> </td>
	110	+<td colspan="2"><span class="irafpar"><strong>srcmdl
	111	+[string]</strong></span></td>
	112	+</tr>
	113	+<tr>
	114	+<td width="50"> </td>
	115	+<td width="25"> </td>
	116	+<td width="525">Source model input XML file.</td>
	117	+</tr>
	118	+<tr>
	119	+<td width="50"> </td>
	120	+<td> </td>
	121	+<td width="525"> </td>
	122	+</tr>
	123	+<tr>
	124	+<td width="50"> </td>
	125	+<td colspan="2"><span class="irafpar"><strong>ra
	126	+[double]</strong></span></td>
	127	+</tr>
	128	+<tr>
	129	+<td width="50"> </td>
	130	+<td width="25"> </td>
	131	+<td width="525">Right Ascension of pointing
	132	+(J2000, in degrees).</td>
	133	+</tr>
	134	+<tr>
	135	+<td width="50"> </td>
	136	+<td> </td>
	137	+<td width="525"> </td>
	138	+</tr>
	139	+<tr>
	140	+<td width="50"> </td>
	141	+<td colspan="2"><span class="irafpar"><strong>dec
	142	+[double]</strong></span></td>
	143	+</tr>
	144	+<tr>
	145	+<td width="50"> </td>
	146	+<td width="25"> </td>
	147	+<td width="525">Declination of pointing (J2000,
	148	+in degrees).</td>
	149	+</tr>
	150	+<tr>
	151	+<td width="50"> </td>
	152	+<td> </td>
	153	+<td width="525"> </td>
	154	+</tr>
	155	+<tr>
	156	+<td width="50"> </td>
	157	+<td colspan="2"><span class="irafpar"><strong>(deadc
	158	+= 0.95)
	159	+[double]</strong></span></td>
	160	+</tr>
	161	+<tr>
	162	+<td width="50"> </td>
	163	+<td width="25"> </td>
	164	+<td width="525">Average deadtime correction factor.</td>
	165	+</tr>
	166	+<tr>
	167	+<td width="50"> </td>
	168	+<td> </td>
	169	+<td width="525"> </td>
	170	+</tr>
	171	+<tr>
	172	+<td width="50"> </td>
	173	+<td colspan="2"><span class="irafpar"><strong>tmin
	174	+[double]</strong></span></td>
	175	+</tr>
	176	+<tr>
	177	+<td width="50"> </td>
	178	+<td width="25"> </td>
	179	+<td width="525">CTA mission elapsed start time (in
	180	+seconds).</td>
	181	+</tr>
	182	+<tr>
	183	+<td width="50"> </td>
	184	+<td> </td>
	185	+<td width="525"> </td>
	186	+</tr>
	187	+<tr>
	188	+<td width="50"> </td>
	189	+<td colspan="2"><span class="irafpar"><strong>tmax
	190	+[double]</strong></span></td>
	191	+</tr>
	192	+<tr>
	193	+<td width="50"> </td>
	194	+<td width="25"> </td>
	195	+<td width="525">CTA mission elapsed stop time
	196	+(in
	197	+seconds).</td>
	198	+</tr>
	199	+<tr>
	200	+<td width="50"> </td>
	201	+<td> </td>
	202	+<td width="525"> </td>
	203	+</tr>
	204	+<tr>
	205	+<td width="50"> </td>
	206	+<td colspan="2"><span class="irafpar"><strong>(ebinalg
	207	+= LOG)
	208	+<FILE\|LIN\|LOG> [string]</strong></span></td>
	209	+</tr>
	210	+<tr>
	211	+<td width="50"> </td>
	212	+<td width="25"> </td>
	213	+<td width="525">Algorithm for defining energy bins.
	214	+Currently, only <code>LOG</code> is supported.</td>
	215	+</tr>
	216	+<tr>
	217	+<td width="50"> </td>
	218	+<td> </td>
	219	+<td width="525"> </td>
	220	+</tr>
	221	+<tr>
	222	+<td width="50"> </td>
	223	+<td colspan="2"><span class="irafpar"><strong>emin
	224	+[double]</strong></span></td>
	225	+</tr>
	226	+<tr>
	227	+<td width="50"> </td>
	228	+<td width="25"> </td>
	229	+<td width="525">Lower energy value for first energy
	230	+bin (in
	231	+TeV).</td>
	232	+</tr>
	233	+<tr>
	234	+<td width="50"> </td>
	235	+<td> </td>
	236	+<td width="525"> </td>
	237	+</tr>
	238	+<tr>
	239	+<td width="50"> </td>
	240	+<td colspan="2"><span class="irafpar"><strong>emax
	241	+[double]</strong></span></td>
	242	+</tr>
	243	+<tr>
	244	+<td width="50"> </td>
	245	+<td width="25"> </td>
	246	+<td width="525">Upper energy value for last energy
	247	+bin
	248	+(in
	249	+TeV).</td>
	250	+</tr>
	251	+<tr>
	252	+<td width="50"> </td>
	253	+<td> </td>
	254	+<td width="525"> </td>
	255	+</tr>
	256	+<tr>
	257	+<td width="50"> </td>
	258	+<td colspan="2"><span class="irafpar"><strong>enumbins
	259	+[integer]</strong></span></td>
	260	+</tr>
	261	+<tr>
	262	+<td width="50"> </td>
	263	+<td width="25"> </td>
	264	+<td width="525">Number of energy bins.</td>
	265	+</tr>
	266	+<tr>
	267	+<td width="50"> </td>
	268	+<td> </td>
	269	+<td width="525"> </td>
	270	+</tr>
	271	+<tr>
	272	+<td width="50"> </td>
	273	+<td colspan="2"><span class="irafpar"><strong>(ebinfile
	274	+= NONE)
	275	+[file]</strong></span></td>
	276	+</tr>
	277	+<tr>
	278	+<td width="50"> </td>
	279	+<td width="25"> </td>
	280	+<td width="525">Name of the file containing the
	281	+energy bin definition (<span style="font-weight: bold;">not
	282	+yet implemented</span>).</td>
	283	+</tr>
	284	+<tr>
	285	+<td width="50"> </td>
	286	+<td> </td>
	287	+<td width="525"> </td>
	288	+</tr>
	289	+<tr>
	290	+<td width="50"> </td>
	291	+<td colspan="2"><span class="irafpar"><strong>nxpix
	292	+[integer]</strong></span></td>
	293	+</tr>
	294	+<tr>
	295	+<td width="50"> </td>
	296	+<td width="25"> </td>
	297	+<td width="525">Size of the Right Ascension /
	298	+Galactic longitude axis (in pixels).</td>
	299	+</tr>
	300	+<tr>
	301	+<td width="50"> </td>
	302	+<td> </td>
	303	+<td width="525"> </td>
	304	+</tr>
	305	+<tr>
	306	+<td width="50"> </td>
	307	+<td colspan="2"><span class="irafpar"><strong>nypix
	308	+[integer]</strong></span></td>
	309	+</tr>
	310	+<tr>
	311	+<td width="50"> </td>
	312	+<td width="25"> </td>
	313	+<td width="525">Size of the Declination / Galactic
	314	+latitude axis (in pixels).</td>
	315	+</tr>
	316	+<tr>
	317	+<td width="50"> </td>
	318	+<td> </td>
	319	+<td width="525"> </td>
	320	+</tr>
	321	+<tr>
	322	+<td width="50"> </td>
	323	+<td colspan="2"><span class="irafpar"><strong>binsz
	324	+[double]</strong></span></td>
	325	+</tr>
	326	+<tr>
	327	+<td width="50"> </td>
	328	+<td width="25"> </td>
	329	+<td width="525">Pixel size (in degrees/pixel).</td>
	330	+</tr>
	331	+<tr>
	332	+<td width="50"> </td>
	333	+<td> </td>
	334	+<td width="525"> </td>
	335	+</tr>
	336	+<tr>
	337	+<td width="50"> </td>
	338	+<td colspan="2"><span class="irafpar"><strong>coordsys
	339	+= CEL <CEL\|GAL> [string]</strong></span></td>
	340	+</tr>
	341	+<tr>
	342	+<td width="50"> </td>
	343	+<td width="25"> </td>
	344	+<td width="525">Coordinate system (<code>CEL</code>
	345	+- celestial, <code>GAL</code> - galactic).</td>
	346	+</tr>
	347	+<tr>
	348	+<td width="50"> </td>
	349	+<td> </td>
	350	+<td width="525"> </td>
	351	+</tr>
	352	+<tr>
	353	+<td width="50"> </td>
	354	+<td colspan="2"><span class="irafpar"><strong>xref
	355	+[double]</strong></span></td>
	356	+</tr>
	357	+<tr>
	358	+<td width="50"> </td>
	359	+<td width="25"> </td>
	360	+<td width="525">Right Ascension / Galactic longitude
	361	+of image centre
	362	+(J2000, in degrees).</td>
	363	+</tr>
	364	+<tr>
	365	+<td width="50"> </td>
	366	+<td> </td>
	367	+<td width="525"> </td>
	368	+</tr>
	369	+<tr>
	370	+<td width="50"> </td>
	371	+<td colspan="2"><span class="irafpar"><strong>yref
	372	+[double]</strong></span></td>
	373	+</tr>
	374	+<tr>
	375	+<td width="50"> </td>
	376	+<td width="25"> </td>
	377	+<td width="525">Declination / Galactic latitude of
	378	+image centre (J2000,
	379	+in degrees).</td>
	380	+</tr>
	381	+<tr>
	382	+<td width="50"> </td>
	383	+<td> </td>
	384	+<td width="525"> </td>
	385	+</tr>
	386	+<tr>
	387	+<td width="50"> </td>
	388	+<td colspan="2"><span class="irafpar"><strong>(axisrot
	389	+= h) [double]</strong></span></td>
	390	+</tr>
	391	+<tr>
	392	+<td width="50"> </td>
	393	+<td width="25"> </td>
	394	+<td width="525">Rotation angle of image axes (in
	395	+degrees).</td>
	396	+</tr>
	397	+<tr>
	398	+<td width="50"> </td>
	399	+<td> </td>
	400	+<td width="525"> </td>
	401	+</tr>
	402	+<tr>
	403	+<td width="50"> </td>
	404	+<td colspan="2"><span class="irafpar"><strong>proj
	405	+= CAR [string]</strong></span></td>
	406	+</tr>
	407	+<tr>
	408	+<td width="50"> </td>
	409	+<td width="25"> </td>
	410	+<td width="525">Projection method (only <code>AZP,CAR,STG,TAN</code>
	411	+are supported so far).</td>
	412	+</tr>
	413	+<tr>
	414	+<td width="50"> </td>
	415	+<td> </td>
	416	+<td width="525"> </td>
	417	+</tr>
	418	+</tbody>
	419	+</table>
	420	+<p class="Title">Standard parameters</p>
	421	+<table id="table1" class="Body" border="0" cellpadding="0" cellspacing="0" width="600">
	422	+<tbody>
	423	+<tr>
	424	+<td width="50"> </td>
	425	+<td colspan="2"><span class="irafpar"><strong>(chatter
	426	+= 1) [integer]</strong></span></td>
	427	+</tr>
	428	+<tr>
	429	+<td width="50"> </td>
	430	+<td width="25"> </td>
	431	+<td width="525">Verbosity of the executable:<br>
	432	+<code>chatter = 0</code>: no information will be
	433	+logged<br>
	434	+<code>chatter = 1</code>: only errors will be logged<br>
	435	+<code>chatter = 2</code>: errors and actions will be
	436	+logged<br>
	437	+<code>chatter = 3</code>: report about the task
	438	+execution<br>
	439	+<code>chatter = 4</code>: detailed report about the
	440	+task execution</td>
	441	+</tr>
	442	+<tr>
	443	+<td width="50"> </td>
	444	+<td> </td>
	445	+<td width="525"> </td>
	446	+</tr>
	447	+<tr>
	448	+<td width="50"> </td>
	449	+<td colspan="2"><span class="irafpar"><strong>(clobber
	450	+= yes) [boolean]</strong></span></td>
	451	+</tr>
	452	+<tr>
	453	+<td width="50"> </td>
	454	+<td width="25"> </td>
	455	+<td width="525">Specifies whether an existing output
	456	+counts map should be overwritten.</td>
	457	+</tr>
	458	+<tr>
	459	+<td width="50"> </td>
	460	+<td> </td>
	461	+<td width="525"> </td>
	462	+</tr>
	463	+<tr>
	464	+<td width="50"> </td>
	465	+<td colspan="2"><span class="irafpar"><strong>(debug
	466	+= no) [boolean]</strong></span></td>
	467	+</tr>
	468	+<tr>
	469	+<td width="50"> </td>
	470	+<td width="25"> </td>
	471	+<td width="525">Enables debug mode. In debug mode
	472	+the executable will dump any log file output in the console.</td>
	473	+</tr>
	474	+<tr>
	475	+<td width="50"> </td>
	476	+<td> </td>
	477	+<td width="525"> </td>
	478	+</tr>
	479	+<tr>
	480	+<td width="50"> </td>
	481	+<td colspan="2"><span class="irafpar"><strong>(mode
	482	+= ql) [string]</strong></span></td>
	483	+</tr>
	484	+<tr>
	485	+<td width="50"> </td>
	486	+<td width="25"> </td>
	487	+<td width="525">Mode of automatic parameters.</td>
	488	+</tr>
	489	+<tr>
	490	+<td width="50"> </td>
	491	+<td> </td>
	492	+<td width="525"> </td>
	493	+</tr>
	494	+</tbody>
	495	+</table>
	496	+<br>
	497	+<p class="Title">Related FTOOLS</p>
	498	+<br>
	499	+<hr size="1">
	500	+<p class="Body">Last updated by: Jürgen
	501	+Knödlseder 18 December
	502	+2012
	503	+</p>
	504	+<br>
	505	+</body></html>
0	506	\ No newline at end of file
...	...