runConfig_template.xml

00001 <?xml version="1.0" encoding="ASCII"?>
00002 
00003 <!-- Christopher Cantalupo May 3, 2004 -->
00004 
00005 <!DOCTYPE runConfig SYSTEM "file:runConfig.dtd">
00006 
00007 <runConfig>
00008 <!--***********-->
00009 <!--PIXEL CLASS-->
00010 <!--***********--> 
00011 <!--**************************************************-->
00012 <!--A Pixel class is a subset in a partition of the   -->
00013 <!--entire set of discrete observables that are united-->
00014 <!--by some common characteristic.  One example of a  -->
00015 <!--pixel class would be a mesh of positions on the   -->
00016 <!--sky that measure the brightness temperature in    -->
00017 <!--units of Kelvin.  At least one pixelClass is      -->
00018 <!--required and multiple pixelClasses are allowed.   -->
00019 <!--One map is created or read for each pixel class.  -->
00020 <!--**************************************************-->
00021     <pixelClass>
00022 <!--Name of pixel class                               -->
00023         <className></className>
00024 <!--Number of pixels in entire class                  -->
00025         <numPixelInClass></numPixelInClass>
00026 <!--Structure describing MLE map file                 -->
00027         <mapFile>
00028             <name></name>
00029             <format></format>
00030         </mapFile>
00031 <!--Name of pixel type possiblities are               -->
00032 <!--(default, I, Q, U)                                -->
00033         <pixelType></pixelType>
00034 <!--Structure describing pixel coordinate file,       -->
00035 <!--required only for spectrum calculation.           -->
00036         <coordFile>
00037             <name></name>
00038             <format></format>
00039         </coordFile>
00040 <!--Structure describing beam and pixel multipole     -->
00041 <!--window function, required only for sepectrum      -->
00042 <!--calculation.                                      -->
00043         <windowFile>
00044             <name></name>
00045             <format></format>
00046         </windowFile>
00047 <!--List of files that contain pixel masks.  These are-->
00048 <!--optional, and only used during power spectrum     -->
00049 <!--calculation.                                      -->
00050         <maskFiles>
00051             <file>
00052                 <name></name>
00053                 <format></format>
00054            </file>
00055         </maskFiles>
00056 <!--List of files that contain pixel templates to     -->
00057 <!--marginalize over.  Required only for spectrum     -->
00058 <!--calculation.                                      -->
00059         <templateFiles>
00060             <file>
00061                 <name></name>
00062                 <format></format>
00063             </file>
00064         </templateFiles>
00065     </pixelClass>
00066 
00067 
00068     <GCPointingGroup>
00069       <name></name>
00070       <GCPointingType></GCPointingType>
00071       <auxDataFile>
00072         <name></name>
00073         <format></format>
00074       </auxDataFile>
00075       <GCPointingFiles>
00076         <file>
00077           <name></name>
00078           <format></format>
00079         </file>
00080       </GCPointingFiles>
00081     </GCPointingGroup>
00082 
00083 <!--*******************-->
00084 <!--SPARSE PIXEL MATRIX-->
00085 <!--*******************-->
00086     <sparsePixelMatrixFile>
00087       <name></name>
00088       <format></format>
00089     </sparsePixelMatrixFile>
00090 
00091 
00092 <!--********-->
00093 <!--DATA SET-->
00094 <!--********-->
00095 <!--**************************************************-->
00096 <!--Time domain data is described in data sets.  Each -->
00097 <!--data set has its own independant time indexing.   -->
00098 <!--All of the data that is related to a time stream  -->
00099 <!--is stored in the data set.  At least one data set -->
00100 <!--is required.  Multiple data sets are allowed.     -->
00101 <!--**************************************************-->
00102     <dataSet>
00103 <!--The data set has a name.                          -->
00104        <name></name>
00105        <firstTime_sec></firstTime_sec>
00106        <firstTime_nsec></firstTime_nsec>
00107        <sampleRate></sampleRate>
00108 
00109 
00110 <!--The time ordered data is modeled as a linear      -->
00111 <!--combination of components.  Some data can be well -->
00112 <!--described by one component.  Some simulated data  -->
00113 <!--may have many components.                         -->
00114         <component>
00115 <!--Independant time ordered calibrations are applied -->
00116 <!--to each component, so there are subcomponents     -->
00117 <!--which share the same time ordered calibration.    -->
00118 <!--If no time ordered calibration is to be done, or  -->
00119 <!--if all time streams will share the same time      -->
00120 <!--ordered calibration the user should put all of the-->
00121 <!--time streams in the same component each as a      -->
00122 <!--subcomponent.                                     -->
00123             <subcomponent>
00124 <!--Each subcomponent is made up of a set of time     -->
00125 <!--ordered data files.  Files within a subcomponent  -->
00126 <!--should not overlap. A time sample is considered   -->
00127 <!--covered only if it is sampled in every            -->
00128 <!--subcomponent.  Multiple files are allowed.        -->
00129                 <file>
00130                     <name></name>
00131                     <format></format>
00132 <!--File calibration factor, not required             -->
00133                     <calib></calib>
00134                 </file>
00135             </subcomponent>
00136             <subcomponentSim>
00137               <mapScanSim>
00138 <!--If the mapScan structure is empty then the        -->
00139 <!--pointing and scan maps are taken to be the        -->
00140 <!--ones defined for the analysis.  A different       -->
00141 <!--pointing can be used in simulation than analysis  -->
00142 <!--and in this case the pointing is defined here.    -->
00143 <!--This section describes one of the pixel classes   -->
00144 <!--simulated in this data set.  There can be many    -->
00145 <!--classes simulated.                                -->
00146                 <class>
00147 <!--A reference to the pixel class.                   -->
00148                     <pixelClassRef></pixelClassRef>
00149 <!--The following structure defines a subclass.  Each -->
00150 <!--subclass must be composed of files with intervals -->
00151 <!--that are non-overlapping and complete.            -->
00152                     <subclass>
00153 <!--The full subclass has files of type "pointing"    -->
00154                         <file>
00155                             <name></name>
00156                             <format></format>
00157                            <calib></calib>
00158                         </file>
00159                     </subclass>
00160                     <subclassGC>
00161 <!--The compressed subclass has files of type         -->
00162 <!--"gcpointing"                                      -->
00163                       <GCPointingGroupRef></GCPointingGroupRef>
00164                       <auxComplement></auxComplement>
00165                     </subclassGC>
00166 
00167 <!--Each pixel class can have a set of possibly       -->
00168 <!--incomplete and/or overlapping time                -->
00169 <!--ordered calibration files.  None are required.    -->
00170                     <tocFiles>
00171                         <file>
00172                             <name></name>
00173                             <format></format>
00174 <!--File calibration factor, not required             -->
00175                             <calib></calib>
00176 <!--Action is either "multiply" (default) or "divide" -->
00177                             <action></action>
00178                         </file>
00179                     </tocFiles>
00180                 </class>
00181               </mapScanSim>
00182             </subcomponentSim>
00183             <subcomponentSim>
00184               <offNoiseSim>
00185 <!--If the otfsOOF structure is empty then the noise  -->
00186 <!--description is taken to be the one used for       -->
00187 <!--analysis.                                         -->
00188 <!--This section describes the inverse time time noise-->
00189 <!--correlation files used to generate simulated noise-->
00190 <!--time stream.                                      -->
00191                 <noiseFiles>
00192 <!--Each file corresponds to a particular stationary  -->
00193 <!--interval.  Multiple files are allowed.            -->
00194                     <file>
00195                         <name></name>
00196                         <format></format>
00197 <!--File calibration factor, not required             -->
00198                         <calib></calib>
00199 <!--Maximum time correltion length to be used for this-->
00200 <!--stationary interval.                              -->
00201                         <corLength></corLength>
00202                     </file>
00203                 </noiseFiles>
00204               </oofNoiseSim>
00205             </subcomponentSim>
00206 <!--Each component can have a set of possibly         -->
00207 <!--incomplete and/or overlapping time                -->
00208 <!--ordered calibration files.  None are required.    -->
00209             <tocFiles>
00210                 <file>
00211                     <name></name>
00212                     <format></format>
00213 <!--File calibration factor, not required             -->
00214                     <calib></calib>
00215 <!--Action is either "multiply" (default) or "divide" -->
00216                     <action></action>
00217                 </file>
00218             </tocFiles>
00219         </component>
00220 <!--This section describes the pointing files.        -->
00221 <!--Pointing files are time ordered, and cover        -->
00222 <!--particular intervals.                             -->
00223         <pointingFiles>
00224 <!--This section describes one of the pixel classes   -->
00225 <!--observed in this data set.  There can be many     -->
00226 <!--classes observed.                                 -->
00227             <class>
00228 <!--A reference to the pixel class.                   -->
00229                 <pixelClassRef></pixelClassRef>
00230 <!--The following structure defines a subclass.  Each -->
00231 <!--subclass must be composed of files with intervals -->
00232 <!--that are non-overlapping and complete.            -->
00233                 <subclass>
00234 <!--The full subclass has files of type "pointing"    -->
00235                     <file>
00236                         <name></name>
00237                         <format></format>
00238                         <calib></calib>
00239                     </file>
00240                 </subclass>
00241                 <subclassGC>
00242 <!--The compressed subclass has files of type         -->
00243 <!--"gcpointing"                                      -->
00244                   <GCPointingGroupRef></GCPointingGroupRef>
00245                   <auxComplement></auxComplement>
00246                 </subclassGC>
00247 
00248 <!--Each pixel class can have a set of possibly       -->
00249 <!--incomplete and/or overlapping time                -->
00250 <!--ordered calibration files.  None are required.    -->
00251                 <tocFiles>
00252                     <file>
00253                         <name></name>
00254                         <format></format>
00255 <!--File calibration factor, not required             -->
00256                         <calib></calib>
00257 <!--Action is either "multiply" (default) or "divide" -->
00258                         <action></action>
00259                     </file>
00260                 </tocFiles>
00261             </class>
00262         </pointingFiles>
00263 <!--This section describes the inverse time time noise-->
00264 <!--correlation files.                                -->
00265         <noiseFiles>
00266 <!--Each file corresponds to a particular stationary  -->
00267 <!--interval.  Multiple files are allowed.            -->
00268             <file>
00269                 <name></name>
00270                 <format></format>
00271 <!--File calibration factor, not required             -->
00272                 <calib></calib>
00273 <!--Maximum time correltion length to be used for this-->
00274 <!--stationary interval.                              -->
00275                 <corLength></corLength>
00276 <!--If the file is an output file then an interval can-->
00277 <!--be sepecified.                                    -->
00278                 <interval>
00279                     <firstSample></firstSample>
00280                     <lastSample></lastSample>
00281                 </interval>
00282             </file>
00283         </noiseFiles>
00284 <!--Certain time intervals can be specified for the   -->
00285 <!--analysis by the setIntervals.                     -->
00286         <setIntervals>
00287 <!--More than one interval can be given.              -->
00288             <interval>
00289                 <firstSample></firstSample>
00290                 <lastSample></lastSample>
00291             </interval>
00292         </setIntervals>
00293 <!--Time domain preprocessing filters are defined     -->
00294 <!--below.  There are four possible types of filters  -->
00295 <!--and there can be multiple filter files of each    -->
00296 <!--type that cover non-overlapping time segments.    -->
00297         <filterFiles>
00298 <!--Prewhitening filters                              -->
00299             <wFilters>
00300                 <file>
00301                     <name></name>
00302                     <format></format>
00303 <!--Number of Fourier modes to be retrieved from the  -->
00304 <!--file.                                             -->
00305                     <length></length>
00306 <!--Approximate band width of the filter in real space--> 
00307                     <bandWidth></bandWidth>
00308                 </file>
00309             </wFilters>
00310 <!--Instrument electronics filters                    -->
00311             <eFilters>
00312                 <file>
00313                     <name></name>
00314                     <format></format>
00315                     <length></length>
00316                     <bandWidth></bandWidth>
00317                 </file>
00318             </eFilters>
00319 <!--Signal filters                                    -->
00320             <sFilters>
00321                 <file>
00322                     <name></name>
00323                     <format></format>
00324                     <length></length>
00325                     <bandWidth></bandWidth>
00326                 </file>
00327             </sFilters>
00328 <!--Noched filters (i.e. banded filters)              -->
00329             <bFilters>
00330                 <file>
00331                     <name></name>
00332                     <format></format>
00333                     <length></length>
00334                     <bandWidth></bandWidth>
00335                 </file>
00336             </bFilters>
00337         </filterFiles>
00338     </dataSet>
00339 <!--*************-->
00340 <!--POWER SPECTRUM-->
00341 <!--*************-->
00342 <!--**************************************************-->
00343 <!--The power spectrum structure is only required if  -->
00344 <!--spectrum are to be computed.  This structure holds-->
00345 <!--all of the information about the MLE spectrum,    -->
00346 <!--their various attributes, and the correlations    -->
00347 <!--between bins (the Fisher matrix).  Multiple       -->
00348 <!--power spectrum are not allowed.                   -->
00349 <!--**************************************************-->
00350     <powerSpectrum>
00351 <!--**************************************************-->
00352 <!--A spectrum class is one of six possible spectrum  -->
00353 <!--types and identifies the files that describe the  -->
00354 <!--class.  Multiple spectrum classes are allowed     -->
00355 <!--but not required, and only one spectrum class is  -->
00356 <!--allowed for each spectrum type.                   -->
00357 <!--**************************************************-->
00358         <spectrumClass>
00359 <!--Spectrum type is one of the following:            -->
00360 <!--TT, EE, BB, TE, TB, or EB.                        -->
00361             <spectrumType></spectrumType>
00362 <!--Structure describing the file that determines the -->
00363 <!--partition of multipoles into bins.                -->
00364             <binFile>
00365                 <name></name>
00366                 <format></format>
00367             </binFile>
00368 <!--Structure describing the file that determines the -->
00369 <!--null hypothosis spectral shape function.          -->
00370             <shapeFile>
00371                 <name></name>
00372                 <format></format>
00373             </shapeFile>
00374 <!--Structure describing the file that gives the      -->
00375 <!--contains the MLE binned power spectrum.           -->
00376             <bpsFile>
00377                 <name></name>
00378                 <format></format>
00379             </bpsFile>
00380         </spectrumClass>
00381 <!--Fisher matrix file description                    -->
00382         <fisherMatrixFile>
00383             <name></name>
00384             <format></format>
00385         </fisherMatrixFile>
00386     </powerSpectrum>
00387 </runConfig>

Generated on Mon Nov 24 10:05:12 2008 for M3 by  doxygen 1.5.3-20071008