Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| the_lvis_user_interface [2023/05/10 12:36] – [Settings] 2003:c8:4f17:8100:7dcc:cf8b:83b2:eecc | the_lvis_user_interface [2023/05/10 15:25] (current) – [Configuration bar] 2003:c8:4f17:8100:7dcc:cf8b:83b2:eecc | ||
|---|---|---|---|
| Line 197: | Line 197: | ||
| You can also add further explanation to your units. For example, you can differentiate between dried (dry mass) and untreated samples (moist mass). This can easily be indicated in the sample reference unit by using kg (DM) and kg (MM). | You can also add further explanation to your units. For example, you can differentiate between dried (dry mass) and untreated samples (moist mass). This can easily be indicated in the sample reference unit by using kg (DM) and kg (MM). | ||
| </ | </ | ||
| + | ====Pre-Defining Users, Sample Descriptions, | ||
| + | In LVis you can provide a number of descriptions per measurement. Some of these descriptions can be predefined, so that you do not have to enter them over and over again, but can simply select them from a pull-down menu. To do this, click on the “Names” button in the global [[Settings]] window to open the following dialog. | ||
| + | <WRAP todo> | ||
| + | LVis lets you pre-define, or add to pre-defined, | ||
| + | |||
| + | In addition, you can specify, for each type of entry, whether it is a mandatory, “Required” field that must be entered into the parameter set by the user prior to any measurement analysis. | ||
| + | You can also assign each name or description with an alias (Shortcut), which can be used in the parameter set for automatic file name generation using the dollar commands $U$ for user, $C$ for sample category, and $L$ for the sample location. For further information, | ||
| + | In order to add a new name or description, | ||
| + | <WRAP todo> | ||
| + | Enter the name or description with its corresponding abbreviation, | ||
| + | <WRAP important> | ||
| + | **Important**\\ | ||
| + | Newly added units, names, and descriptions become available for use once data entry on the Settings dialog is complete and the dialog is closed. Measurements and parameter sets that are open when a new description is created will only offer it in the respective pulldown menus after they are closed and opened again. | ||
| + | </ | ||
| + | |||
| + | |||
| ==== Editors ==== | ==== Editors ==== | ||
| + | Besides the spectrum itself, the calibration and the analysis settings several additional information is needed for a gamma spectroscopic analysis. | ||
| + | Mainly this is the nuclide or analysis library which is essential for spectrum analysis but there is other additional information that may eventually be needed for a thorough analysis like eg a correction library that allows to apply peak and/or nuclide specific correction factors to the analysis, a geometry correction that applies energy specific changes to the efficiency curve or a background correction which subtracts counts from identified peaks to compensate for nuclides present in the system and not the sample. | ||
| + | In LVis these additional information is saved by use of additional files that can be created and edited via special “Editors” that can be accessed and started from this menu. | ||
| + | <WRAP todo> | ||
| === Analysis Library Editor === | === Analysis Library Editor === | ||
| - | === Correction Library Editor === | + | In general, LVis uses the GammaVision nuclide library format .LIB and you can certainly make use of the external GammaVision editor program, LibEdit.exe, |
| + | <WRAP important> | ||
| + | **Important**\\ | ||
| + | It is currently not possible to use Nuclide Navigator database libraries in LVis! | ||
| + | </ | ||
| + | Besides the GammaVision editor it is possible to create and modify library information within LVis. This can either be done from “Editors” in the Menu Bar or from within a specific LVis measurement LVM file (the herein created library can be exported in the .LIB format so that it is available for use in parameter sets. This is explained in detail in the chapter [[Modifying the internal nuclide library of an LVis measurement file]] of this manual). | ||
| + | |||
| + | All library files are saved by default to the library folder in your LVis database directory. | ||
| + | <WRAP important> | ||
| + | **Important**\\ | ||
| + | Besides calibration, | ||
| + | </ | ||
| + | <WRAP tip> | ||
| + | **Tip**\\ | ||
| + | If you are not sure about the “needs” of your application, | ||
| + | </ | ||
| + | Selecting “Analysis library” under Editors in the LVis Menu Bar opens a dialogue to open an existing library file for modification. It will always come up with the default library folder in your LVis database directory. | ||
| + | <WRAP todo> | ||
| + | If a library shall be created from scratch, simply don’t select a file here and click “Cancel”. | ||
| + | The library editor itself looks like this: | ||
| + | <WRAP todo> | ||
| + | You can “Load” or “Add” the data from an existing library, you can “Save” and “Print” the library. | ||
| + | <WRAP important> | ||
| + | **Important**\\ | ||
| + | Adding data from a library will add all data for all nuclides that are not existing in the currently open one. The information about nuclides that are already existing will be maintained. | ||
| + | </ | ||
| + | To add a single nuclide to the library simply right click into the white main area of the editor and choose “Add Nuclide”. | ||
| + | <WRAP todo> | ||
| + | This will bring up the following dialogue: | ||
| + | <WRAP todo> | ||
| + | Here one can either enter a nuclide name, halflife and uncertainty manually and define then in a subsequent window all the different peak energies with their respective emission probabilities or one simply enters a name and imports the nuclide with all of its data from an existing ORTEC library or from the LARA database ([[http:// | ||
| + | <WRAP info> | ||
| + | **Info**\\ | ||
| + | The nuclide uncertainty does not refer to a single peak, but the entire nuclide. The 1-sigma uncertainty entered here is calculated in square in the total uncertainty of the nuclide activity. This is the 1-sigma uncertainty, | ||
| + | </ | ||
| + | The LARA database is published by the French “Laboratoire National Henri Becquerel” which is – at least to our knowledge – using all the reviewed nuclear data from the DDEP, the Decay Data Evaluation Project. An international collaboration that was formed in 1995 which includes members of the BNM-CEA/ | ||
| + | In order to be able to import data from the LARA database a valid internet connection is required. | ||
| + | <WRAP tip> | ||
| + | **Tip**\\ | ||
| + | In rare occasions you might experience problems when importing nuclide data from LARA so that you receive error messages like “Unreasonable answer from LARA” or similar. In these rare occasions it usually helps when you browse to the LARA page and select the respective nuclide for display, then try to import again. | ||
| + | </ | ||
| + | When importing data from either an ORTEC GammaVision library or LARA, one can limit the number of peaks that are imported by applying filters for the energy and the emission probability so that just peaks with energies being within the selected energy range and above the specified emission probability will be imported. | ||
| + | |||
| + | Every nuclide in the library will be listed in the editor. One can modify the nuclide information by right clicking on the respective entry and selecting “Edit”. From this menu it is as well possible to “Delete” the nuclide or “Add Peaks” to this nuclide. | ||
| + | <WRAP todo> | ||
| + | Using the “Photon Properties”, | ||
| + | <WRAP important> | ||
| + | **Important**\\ | ||
| + | You can define so-called “key lines.” Key lines must be found in a spectrum to identify a nuclide. The peak on level 1 will be automatically set as the key line. | ||
| + | </ | ||
| + | For more detailed instructions on using the library editor, see the GammaVision user manual. | ||
| + | |||
| + | ===Correction Library Editor === | ||
| + | Correction libraries (*.lvf files) can be used to apply corrections to either the peak emission probabilities (peak specific corrections) or the reported total nuclide activity (nuclide specific corrections). | ||
| + | The basic idea behind correction libraries is that eventually needed sample type or detector specific corrections like those for true coincidences for example that usually would be taken into account by manually modifying (correcting!!) analysis libraries are automatically applied while still being able to report the uncorrected values as well as the correction factors (for more see[[Correction Libraries]]([[LVF Files]])). | ||
| + | |||
| + | The structure of a correction library is very similar to the one of an analysis library. However instead of halflives and emission probabilities, | ||
| + | If however eg the nuclide activity of Cs-137 should be doubled simply define a nuclide correction factor of 2. | ||
| + | |||
| + | A correction library can be created manually or edited by selecting “Correction library” under Editors in the LVis [[Menu Bar]]. This opens a dialogue to select an existing correction library file (*.LVF) for modification. | ||
| + | < | ||
| + | Note that instead of solely *.LVF file formats, it is as well possible to open a standard GammaVision library *.lib or a (M)EffTran correction file (gv.txt) as a correction library. | ||
| + | Usually correction libraries are linked to a detector which is why they are best stored in a subdirectory named “Corr” in the LVis database directory of the respective detector. These folders are created automatically in each detector folder by LVis, however only when a correction library is created from within an LVM file so that the detector is known, the editor points to the respective directory, otherwise it will be the default library folder. | ||
| + | |||
| + | The correction library editor looks very much like the nuclide library editor. It is possible to load or add data from an existing correction library as well as from an existing GammaVision nuclide library file *.lib or a (M)EffTran Correction file (gv.txt). | ||
| + | <WRAP todo> | ||
| + | When loading a GammaVision library (*.lib) as a correction library one can set all nuclide and peak correction factors to 1 by clicking “Neutral”. | ||
| + | |||
| + | Right clicking on a peak energy or a nuclide name will bring up a context menu from where an entry can either be deleted, manually added or and existing entry can be modified. The respective editor for the nuclide and peak specific correction factors are shown below. | ||
| + | <WRAP todo> | ||
| + | <WRAP todo> | ||
| + | |||
| + | An additional uncertainty can be defined for the library correction. It is applied to the nuclide uncertainty from the analysis library (see [[Nuclide Uncertainty Estimate]]). | ||
| + | |||
| === Peak Background Correction Editor === | === Peak Background Correction Editor === | ||
| + | Peak background correction (PBC) is used if an isotope in the sample is also contained in the background. The correction subtracts counts in a peak resulting from the background, from the measured spectrum (for more see [[Background Correction]] ([[PBC Files]]). | ||
| + | A PBC file can be created manually or edited by selecting “Background correction” under Editors in the LVis [[Menu Bar]]. This opens a dialogue to select an existing background correction file (*.PBC) for modification. | ||
| + | |||
| + | Note that PBC files are linked to a detector which is why they are best stored in a subdirectory named “PBC” in the LVis database directory of the respective detector. These folders are created automatically in each detector folder by LVis and when creating a PBC file from the “Analysis results” tab of an LVis LVM file this will be your default PBC file location where the file will be stored. However when using the editor from the menu bar, you will be directed to the default library folder. | ||
| + | |||
| + | The Peak Background Correction editor itself looks like this: | ||
| + | <WRAP todo> | ||
| + | The PBC editor looks very much like the nuclide library editor. It is possible to load an existing PBC file or add data from one. When loading or adding background data from an existing PBC file (*.pbc) one can reset all peak background count rates to 0 by clicking “Neutral”. | ||
| + | |||
| + | Right clicking on a peak energy or a nuclide name will bring up a context menu from where a PBC entry can either be deleted, manually added or and existing entry can be modified. The respective editor for the nuclide and peak specific correction factors are shown below | ||
| + | <WRAP todo> | ||
| + | <WRAP todo> | ||
| + | For each peak background count rate an individual uncertainty can be defined, which will be applied to the uncertainty of the respective peak activity (see [[Peaked Background Correction and Uncertainty Calculations]]). | ||
| === Geometry Correction Editor === | === Geometry Correction Editor === | ||
| + | The geometry correction is used to compensate for differences between two counting geometries. As shown in the equation in chapter [[Geometry Corrections]] (GEO Files), the respective correction factors (at energy E) are multiplied with the peak activities for each identified peak from the library (at the same energy E). The factors are stored in a table as energy correction factor pairs. | ||
| + | The determination of the correction factors can be performed experimentally by counting the two samples and calculating the ratio of the peak activities. Hence the geometry correction editor consists of a 4 column table, where one can enter the peak energy, the reference and the actual value as well as their ratio (which is calculated automatically when entering the reference and the current value). The ratio itself represents the correction factor. The factor is linearly interpolated between the energies in the table and linearly extrapolated outside the energy range of the table points. In LVis this is shown in a graph. | ||
| + | <WRAP todo> | ||
| + | |||
| + | Geometry tables can be built automatically in GammaVision using analysis results (.UFO) files. The correction can be greater or less than 1.0 to allow for corrections between any two geometries. | ||
| + | In LVis GEO file can be created manually or edited by selecting “Geometry correction” under Editors in the LVis [[Menu Bar]]. This opens a dialogue to select an existing geometry correction file (*.GEO) for modification. So, one way to create a geometry correction file is to manually enter the energy, reference and actual value by double clicking into the table. | ||
| + | |||
| + | Note that GEO files are linked to a detector which is why they are best stored in a subdirectory named “GEO” in the LVis database directory of the respective detector. These folders are created automatically in each detector folder by LVis and when using GEO files in an LVM file. However when using the editor from the menu bar, you will be directed to the default library folder. | ||
| + | |||
| + | Since the geometry correction basically applies an energy dependent correction to every (identified) peak, the geometry correction can as well be used to apply correction factors determined by 3rd party programs like e.g. ANGLE, GeSpeCorr or (M)EFFTRAN for the efficiency transfer between different geometries. Some of these programs provide an ORTEC geometry correction file as a direct output for others the calculated correction factors have to be entered manually into the editor. Note that it is not necessary to provide values for the reference and the actual value. Only energy and correction factor are mandatory entries. | ||
| + | |||
| + | It is as well possible to enter an uncertainty value for the geometry correction (see [[Geometry Uncertainty Estimate]]). Note that if the uncertainty is 0 or no value is entered, or if using a .GEO file from an earlier version of GammaVision, | ||
| + | |||
| === Materials Editor === | === Materials Editor === | ||
| + | Some functions in LVis, eg the efficiency transfer calculation by [[EFFTRAN]], | ||
| + | In LVis it is possible to create new materials with the Materials Editor that can be accessed from the | ||
| + | Main menu “Editors”. | ||
| + | <WRAP todo> | ||
| + | Every material in LVis is composed of (multiple) chemical elements and/or molecules. Every material is characterized by its name and density. To create a new element, open the materials editor and click “New”, then specify a name. To modify an existing material, select one from the list and click “Edit”. | ||
| + | This will bring you to the following dialogue: | ||
| + | <WRAP todo> | ||
| + | To add a molecule or element from the library on the left side to the material composition on the right side, simply drag and drop the molecule/ | ||
| + | <WRAP todo> | ||
| + | To create a new molecule simply drag and drop the elemental constituents from the left library to the right, then define the atomic fraction and the name. | ||
| + | |||
| + | |||
| === External Database Editor === | === External Database Editor === | ||
| + | With the “External Database” feature of LVis it is possible to link a complete set of data to a measurement and show this data on a separate tab in an LVM file. The selection of the data set is achieved by listing a key value in the “Location field” of a [[parameter set]]. | ||
| + | Such a dataset is usually implemented by importing it from a LIMS or any other database by csv file import/ | ||
| + | <WRAP todo> | ||
| + | The first thing to do, is to define the name of the data set (give it a label). Note that this label will later be displayed as the name of the tab in the LVM file. In addition, it is possible to define the separator in the CSV file that will be used to import data into the database. | ||
| + | Clicking on “Add” will allow the definition of a new data field in the database. It is possible to select from six different types of data (see screenshot above). For each data field, one has to specify a name (label), a preset (default value), the position of the value in the csv file, the position of the respective field on the tab in LVis as well as the limits for the size of a value and if the entry is unique. | ||
| + | <WRAP todo> | ||
| + | |||
| + | The “Position in LVis” is referring to the location of the respective data entry on the database tab in an LVM file. | ||
| + | The following dataset of patient information (see screenshot below): | ||
| + | <WRAP todo> | ||
| + | will show the database entries on the tab like this: | ||
| + | <WRAP todo> | ||
| + | Note that the pulldown menu for the Location field of the parameter set will be different depending on which of the database fields were ticked for “Selection” in this configuration. The three entries selection shown above will bring up a selection menu like this: | ||
| + | < | ||
| + | Once the database fields are defined and configured, the “External Database Editor” will come up with the default editor that allows to add new entries to the database | ||
| + | < | ||
| + | | ||
| + | <WRAP todo> | ||
| + | Note that “Import of datasets via a csv file” (see blue marking below) as well as editing the “Database Settings” (see red marking) can be achieved by clicking on the icon in the top left corner of the database editor | ||
| + | <WRAP todo> | ||
| + | |||
| ==== Admin ==== | ==== Admin ==== | ||
| + | The Admin menu allows you to password-protect several LVis settings against unauthorized access. This includes the following functions: | ||
| + | |||
| + | Change global settings | ||
| + | • Change of LVis [[global settings]] | ||
| + | |||
| + | Change MCB settings | ||
| + | • [[Detector configuration]] (changes the hardware settings of the measuring chain) | ||
| + | |||
| + | Change QA settings | ||
| + | • [[QA settings]] (tolerances and intervals, etc. specification for QA measurements) | ||
| + | |||
| + | Delete a detector | ||
| + | • [[Delete detector]] (removes a detector from the list of available detectors) | ||
| + | |||
| + | Parameter sets: create, edit, delete, copy, import, load, save | ||
| + | • [[New parameter set]] (creates a new measurement parameters set for a detector) | ||
| + | • [[Delete parameter se]]t (removes a parameter set from the list of available parameter sets of the detector) | ||
| + | • [[Edit parameter set]] (changes predefined measurement and analysis parameters, unlocks input fields for the user) | ||
| + | • [[Copy parameter set]] (copies a complete measurement parameter set) | ||
| + | • I[[mport parameter set from existing]] .LVM file (applies settings of a .LVM measurement as new parameter set) | ||
| + | • [[Load parameter set]] (imports a parameter set, saved as a .LVP file, into a detector) | ||
| + | • [[Save parameter set]] (saves a parameter set as .LVP file) | ||
| + | |||
| + | Reference sources: create, edit load, save | ||
| + | • [[New reference source]] (manual creation of a new calibration source) | ||
| + | • [[Load reference source]] (imports a reference source, saved as .LVS file) | ||
| + | • [[Save reference source]] (saves a reference source as .LVS file) | ||
| + | • [[Edit reference source]] (edits an already existing reference source) | ||
| + | |||
| + | Change passwords | ||
| + | • [[Change password]] (changes the current administrator password) | ||
| + | • [[Set start password]] (changes the password to be entered when starting LVis) | ||
| + | |||
| + | These changes can only be made by an administrator (or by any user doing so before the administrator password is set). Adding and removing password protection from LVis functions is as simple as clicking on the “padlock” icon beside a data entry field (the red padlock indicates a field that has been locked; a green padlock means the field is unlocked). | ||
| === Login and Logoff === | === Login and Logoff === | ||
| + | There are two options to unlock the application. Either you click on “ | ||
| + | [[Admin]]“ in the [[menu bar]] and then click on “Login”, | ||
| + | In both cases, you reach the login window, where password entry will be requested. | ||
| + | <WRAP todo> | ||
| + | <WRAP todo> | ||
| + | After you enter the password and confirm it with “OK”, the application will be unlocked. After the administrator has performed the requested settings, it is expedient to lock the program again to protect it against unauthorized changes. To log off, select “[[Logoff]]” from the Admin menu or click on the red “closed padlock” icon on the [[tool bar]]. | ||
| + | <WRAP important> | ||
| + | **Important**\\ | ||
| + | As soon as you set this password, you are logged in as the administrator | ||
| + | </ | ||
| + | <WRAP todo> | ||
| === Change Password === | === Change Password === | ||
| + | To change the administrator password, click on “Admin” -> “Change password” to open the following dialog. | ||
| + | <WRAP todo> | ||
| + | Enter the current password first (if no old password exists, simply leave the field empty). Then enter the new password, confirm it by entering it a second time, and click on “OK” to apply it. Passwords are case-sensitive. | ||
| + | <WRAP todo> | ||
| + | <WRAP important> | ||
| + | **Important**\\ | ||
| + | As soon as you set this password, you are logged in as the administrator | ||
| + | </ | ||
| + | < | ||
| + | **Important**\\ | ||
| + | Once a password has been set, it can be changed but not removed completely (i.e., there is no way to revert to the factory “unpassworded” condition). If you forget the password, contact your ORTEC representative or our Global Service Center for assistance. | ||
| + | </ | ||
| === Set Start Password === | === Set Start Password === | ||
| + | LVis allows you to set a password to prevent program start by unauthorized users. If the wrong password is entered on startup, LVis automatically closes. Users who log in with this password do not have Administrator privileges, hence, cannot change any locked data fields or functions. | ||
| - | ==== LabJournal ==== | + | <WRAP important> |
| + | **Important**\\ | ||
| + | This password is separate from the administrator password (even if you use the same character string for both passwords). Administrator-level users must know this password to start the program, and the administrator password to access locked program functions. Once a start password has been set, it can be changed but not removed completely (i.e., there is no way to revert to the factory “unpassworded” condition). If you forget the password, contact your ORTEC representative or our Global Service Center for assistance. | ||
| + | </ | ||
| + | To set the start password, click on “Admin” -> “Set start password” on the menu bar. | ||
| + | |||
| + | <WRAP todo> | ||
| + | You reach the following dialog box: | ||
| + | |||
| + | <WRAP todo> | ||
| + | Enter the current password first (if no old password exists, simply leave the field empty). Then enter the new password, confirm it by entering it a second time, then click on “OK” to apply it. Passwords are case-sensitive. | ||
| + | |||
| + | The next time the LVis program is started, the start password must be entered. | ||
| + | <WRAP important> | ||
| + | **Important**\\ | ||
| + | If you forget the password, contact your ORTEC representative or our Global Service Center for assistance. | ||
| + | </ | ||
| + | |||
| + | |||
| + | |||
| + | ==== LabJournal ==== | ||
| + | The LVis LabJournal is a log (a database) of all your measurements, | ||
| + | <WRAP todo> | ||
| + | The LVis menu bar gives you two options under “LabJournal”: | ||
| + | It is important to note, that the LVis Labjournal database (LabJournal.mdb) is located in the Config folder of your LVis database directory. If this file does not exist, “Import measurements” will create the database for you and will go through all LVM files in your LVis database folder and will add their data into the LabJournal. | ||
| + | <WRAP important> | ||
| + | **Important**\\ | ||
| + | Depending on the number of LVis LVM files on your system the import of analyses into the LabJournal can take some time. LVis should not be interrupted during the import! | ||
| + | </ | ||
| ==== Help ==== | ==== Help ==== | ||
| + | The “About LVis” screen provides software version information for this copy of LVis. | ||
| + | <WRAP todo> | ||
| ===== Configuration bar ===== | ===== Configuration bar ===== | ||
| + | The configuration sidebar, on the left side of the LVis application window, is the gateway to detector setup and operation. | ||
| + | |||
| + | This bar lists all measurement chains ([[detectors]]) and the [[parameter sets]] defined for each. | ||
| + | |||
| + | The Reference Sources section of configuration bar gives you access to the [[reference source editor]], a convenient tool for managing the information on your calibration standards; and allows you to use the reference source entries to perform calibrations. | ||
| + | |||
| + | In addition, it provides the [[Buffer]] (a virtual detector window) in which GammaVision can load .CHN spectrum files and analyze them using parameter sets. | ||
| + | |||
| + | If any [[multi-detector configurations]] are defined, they are listed here. | ||
| + | |||
| + | The [[Currently open]] section lists all currently open analysis and spectrum windows. | ||
| + | |||
| + | In addition, you can right-click in the sidebar and create a [[backup copy of the entire, current LVis configuration]]. | ||
| + | |||
| + | |||
| ==== Detectors ==== | ==== Detectors ==== | ||