ged_examples
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| ged_examples [2023/10/10 15:13] – admin | ged_examples [2023/10/11 14:49] (current) – admin | ||
|---|---|---|---|
| Line 3: | Line 3: | ||
| ==== Introduction ==== | ==== Introduction ==== | ||
| - | When using ged to read ERNE data, the type of data and the associated reader function is determined based on the data file name (or the name of the first file in a file name array). Some reader functions can process the data based on keywords. The set of acknowledged keywords are typically specific to the reader function in question, so in order to find what options are available, the user should consult the documentation of the reader function associated with the desired data type. The functions for each data type can be found in the quick reference tables on the main page. | + | When using ged to read ERNE data, the type of data and the associated reader function is determined based on the data file name (or the name of the first file in a file name array). Some reader functions can process the data based on keywords. The set of acknowledged keywords are typically specific to the reader function in question, so in order to find what options are available, the user should consult the documentation of the reader function associated with the desired data type. The functions for each data type can be found in the quick reference tables on the [[ged_docs|main page]]. |
| + | |||
| + | (hr) | ||
| ==== Empty keyword list ==== | ==== Empty keyword list ==== | ||
| Line 15: | Line 17: | ||
| </ | </ | ||
| - | If FILENAMES keyword is not set, ged will call datafilename function which will open a Graphical User Interface (GUI) window to let user interactively select the desired files. The result **mydata** will be an array of file records. Level-2 pulse height data are exceptions, as the reader output record structure is slightly modified from the one used in the input disk files (see the quick reference table on the main page). | + | If FILENAMES keyword is not set, [[GEDfunction|ged]] will call [[Datafilename|datafilename]] function which will open a Graphical User Interface (GUI) window to let user interactively select the desired files. The result **mydata** will be an array of file records. Level-2 pulse height data are exceptions, as the reader output record structure is slightly modified from the one used in the input disk files (see the quick reference table on the [[ged_docs|main page]]). |
| + | (hr) | ||
| ==== Keywords for DATAFILENAME ==== | ==== Keywords for DATAFILENAME ==== | ||
| - | User can provide keywords for the **datafilename** function via **ged**. The most important keywords are: | + | User can provide keywords for the [[Datafilename|datafilename]] function via **ged**. The most important keywords are: |
| Line 28: | Line 32: | ||
| * **DLEVEL:** a string coding the data level. This defaults to ' | * **DLEVEL:** a string coding the data level. This defaults to ' | ||
| * **UNDERCOVER: | * **UNDERCOVER: | ||
| - | * **MUTE:** setting (MUTE=1 or /MUTE) will prevent datafilename from printing its informative messages on the console. | + | * **MUTE:** setting (MUTE=1 or /MUTE) will prevent |
| - | The DATA FORMAT -field will be set automatically depending on the value of the START-field, | + | The DATA FORMAT -field will be set automatically depending on the value of the START-field, |
| Line 59: | Line 63: | ||
| will silently read ten days of onboard spectra records (structure type ' | will silently read ten days of onboard spectra records (structure type ' | ||
| + | |||
| + | (hr) | ||
| ==== Keywords for GED ==== | ==== Keywords for GED ==== | ||
| - | The most important keyword for ged-function is FILENAMES The corresponding parameter is assumed to be a file name string or an array of name strings. One way to obtain valid file names is to call datafilename directly before ged call: | + | The most important keyword for ged-function is FILENAMES The corresponding parameter is assumed to be a file name string or an array of name strings. One way to obtain valid file names is to call [[Datafilename|datafilename]] directly before |
| === Example-5 === | === Example-5 === | ||
| Line 71: | Line 77: | ||
| </ | </ | ||
| - | It is of course also possible to provide the name(s) in any other means. However ged requires the names allways to obey a standard format, see ged for details. Note that in case DATAFILENAMES keyword is set, ged will not call datafilename, | + | It is of course also possible to provide the name(s) in any other means. However |
| - | The other ged keywords are more or less technical, and are intended to be used in some special situations. | + | The other **ged** keywords are more or less technical, and are intended to be used in some special situations. |
| + | |||
| + | (hr) | ||
| ==== Onboard Spectra ==== | ==== Onboard Spectra ==== | ||
| - | Level-3 spectra reader ged_l3_spectra provides a comprehensive set of keywords. The most important of them are the ones that control the time and energy integration. The energy integration is done via separate ' | + | Level-3 spectra reader ged_l3_spectra provides a comprehensive set of keywords. The most important of them are the ones that control the time and energy integration. The energy integration is done via separate ' |
| === Example-6 === | === Example-6 === | ||
| Line 87: | Line 95: | ||
| </ | </ | ||
| - | This will silently read ten days of onboard spectra records into mydata array. The data will be time integrated in to 6 hour bins. The energies will be integrated in to the ERNE Export Data channels, and the energy information about the channels will be returned in the info table. Note that the output data is in a customized structure, depending on the number of requested channels. | + | This will silently read ten days of onboard spectra records into **mydata** array. The data will be time integrated in to 6 hour bins. The energies will be integrated in to the ERNE Export Data channels, and the energy information about the channels will be returned in the **info** table. Note that the output data is in a customized structure, depending on the number of requested channels. |
| === Example-7 === | === Example-7 === | ||
| + | |||
| + | Let's assume we have prepared an energy channel selector table chsel using the guidelines for the appropriate filter function (which as discussed above, depends on the data format). | ||
| < | < | ||
| + | IDL> mydata = ged(G3SPE_DT=15*60.0, | ||
| </ | </ | ||
| - | This will call datafilename for interactive file selection and assuming we select level-3 spectra as the data type, we will get an time integrated spectra with 15 minute binning and custom energy channels. | + | This will call [[Datafilename|datafilename]] for interactive file selection and assuming we select level-3 spectra as the data type, we will get an time integrated spectra with 15 minute binning and custom energy channels. |
| + | (hr) | ||
| ==== Pulse Height Data ==== | ==== Pulse Height Data ==== | ||
| - | level-3 pulse height data reader is ged_l3_pha. The current keyword set is quite small. | + | level-3 pulse height data reader is [[ged_l3_pha]]. The current keyword set is quite small. |
| === Example-8 === | === Example-8 === | ||
| Line 109: | Line 121: | ||
| </ | </ | ||
| - | This will read ten days of LED Pulse height records of type TledPartData_a into mydata array. Information on the LED onboard amplification parameter setting will be returned in amps which is a structure of type TledAmpParams_a. | + | This will read ten days of LED Pulse height records of type [[TledPartData_a]] into [[mydata]] array. Information on the LED onboard amplification parameter setting will be returned in [[amps]] which is a structure of type [[TledAmpParams_a]]. |
| The following will do the same for HED. | The following will do the same for HED. | ||
| Line 122: | Line 134: | ||
| </ | </ | ||
| - | The record type of mydata array will be ThedPartData_a and the structure of amps will be ThedAmpParams_a. | + | The record type of **mydata** array will be [[ThedPartData_a]] and the structure of **amps** will be [[ThedAmpParams_a]]. |
| + | (hr) | ||
| ==== LED Direction Spectra ==== | ==== LED Direction Spectra ==== | ||
| - | LED Direction Spectra reader is ged_l3_leddirspectra. As with the regular onboard spectra the energy integration is done with a standard filter function, in this case with Eint_leddir. In contrast to ged_l3_spectra, | + | LED Direction Spectra reader is [[ged_l3_leddirspectra]]. As with the regular onboard spectra the energy integration is done with a standard filter function, in this case with [[Eint_leddir]]. In contrast to **ged_l3_spectra**, there are no keywords for the energy integration for **ged_l3_leddirspectra**. Instead it is intended that the user sets the filter function keywords |
| === Example-10 === | === Example-10 === | ||
| Line 135: | Line 149: | ||
| </ | </ | ||
| - | This will initiate the call to datafilename in interactive mode, with the 'Data File Type' preset. Result in mydata will be an array of LED direction records with a default structure i.e., with the low energy channels covered by only by LED-I (thin D1 detectors, D11 and D16), discarded. The info variable will be a structure containing information on the energy channels and direction of each D1-detector. Both proton and helium data will be present. | + | This will initiate the call to [[Datafilename|datafilename]] in interactive mode, with the 'Data File Type' preset. Result in **mydata** will be an array of LED direction records with a default structure i.e., with the low energy channels covered by only by LED-I (thin D1 detectors, D11 and D16), discarded. The **info** variable will be a structure containing information on the energy channels and direction of each D1-detector. Both proton and helium data will be present. |
| === Example-11 === | === Example-11 === | ||
| Line 144: | Line 158: | ||
| </ | </ | ||
| - | As with above except, result in mydata will be an array of LED direction spectra records with a custom structure for the requested proton channel combinations. There will be three integrated energy bins, first containing the original channels 6-9, second containing the channels 10-13 and the last for the rest i.e., 14 and 15 . The info variable will be a structure containing information on the resulting proton energy bins and direction of each D1-detector. There will be no entries for helium in either of the direction spectra or the info the record. | + | As with above except, result in **mydata** will be an array of LED direction spectra records with a custom structure for the requested proton channel combinations. There will be three integrated energy bins, first containing the original channels 6-9, second containing the channels 10-13 and the last for the rest i.e., 14 and 15 . The **info** variable will be a structure containing information on the resulting proton energy bins and direction of each D1-detector. There will be no entries for helium in either of the direction spectra or the info the record. |
ged_examples.1696940010.txt.gz · Last modified: 2023/10/10 15:13 by admin