diff --git a/doc/html/_page_projections.html b/doc/html/_page_projections.html index a61ea07..9021cd6 100644 --- a/doc/html/_page_projections.html +++ b/doc/html/_page_projections.html @@ -1,9 +1,9 @@ - +
- +the functions of the anglescan package support the following map projections.
-for a description of the different projections, see, for example, https://en.wikipedia.org/wiki/Map_projection
-Selector | Projection | Function | Properties |
---|---|---|---|
kProjDist = 0 | azimuthal equidistant | r = c * theta | radius is proportional to polar angle. |
kProjStereo = 1 | stereographic | r = c * tan theta/2 | circles on sphere map to circles. |
kProjArea = 2 | azimuthal equal-area | r = c * sin theta/2 | preserves area measure. |
kProjGnom = 3 | gnomonic | r = c * tan theta | great circles map to straight lines. |
kProjOrtho = 4 | orthographic | r = c * sin theta | k-space mapping in ARPES and LEED. |
Selector | Projection | Function | Properties |
---|---|---|---|
kProjDist = 0 | azimuthal equidistant | r = c * theta | radius is proportional to polar angle. |
kProjStereo = 1 | stereographic | r = c * tan theta/2 | circles on sphere map to circles. |
kProjArea = 2 | azimuthal equal-area | r = c * sin theta/2 | preserves area measure. |
kProjGnom = 3 | gnomonic | r = c * tan theta | great circles map to straight lines. |
kProjOrtho = 4 | orthographic | r = c * sin theta | k-space mapping in ARPES and LEED. |
the projections in this package are defined for 0 <= theta < 90.
|
|
|
+||
DoniachSunjicStruct | errorCode | |||
DoniachSunjicStruct | +errorCode | +|||
Variables | |
static const variable | mcp_radius_pix = 555 |
MCP radius seen by the camera in pixels. More... | |
MCP radius seen by the camera in pixels. More... | |
static const variable | mcp_radius_mm = 20 |
physical size (radius) of the MCP in mm More... | |
physical size (radius) of the MCP in mm More... | |
static const variable | hemi_radius_mm = 200 |
physical size (radius) of the hemisphere in mm More... | |
physical size (radius) of the hemisphere in mm More... | |
static const variable | mcp_radius_epass = 0.04 |
energy range imaged on MCP relative to the pass energy More... | |
energy range imaged on MCP relative to the pass energy More... | |
Definition in file fermi-edge-analysis.ipf.
@@ -165,47 +164,7 @@ Licensed under the Apache License, Version 2.0 (the "License");Definition at line 27 of file fermi-edge-analysis.ipf.
- -variable analyser_energy_resolution | -( | -variable | -epass, | -
- | - | variable | -slit | -
- | ) | -- |
calculate the energy resolution of the analyser
-epass | pass energy in eV |
slit | analyser entrance slit in mm |
Definition at line 306 of file fermi-edge-analysis.ipf.
+Definition at line 28 of file fermi-edge-analysis.ipf.
Definition at line 216 of file fermi-edge-analysis.ipf.
+Definition at line 217 of file fermi-edge-analysis.ipf.
Definition at line 116 of file fermi-edge-analysis.ipf.
+Definition at line 117 of file fermi-edge-analysis.ipf.
Definition at line 98 of file fermi-edge-analysis.ipf.
+Definition at line 99 of file fermi-edge-analysis.ipf.
Definition at line 284 of file fermi-edge-analysis.ipf.
+Definition at line 285 of file fermi-edge-analysis.ipf.
Definition at line 173 of file fermi-edge-analysis.ipf.
+Definition at line 174 of file fermi-edge-analysis.ipf.
Definition at line 267 of file fermi-edge-analysis.ipf.
+Definition at line 268 of file fermi-edge-analysis.ipf.
physical size (radius) of the hemisphere in mm
-Definition at line 263 of file fermi-edge-analysis.ipf.
+Definition at line 264 of file fermi-edge-analysis.ipf.
@@ -430,7 +389,7 @@ Licensed under the Apache License, Version 2.0 (the "License");energy range imaged on MCP relative to the pass energy
-Definition at line 265 of file fermi-edge-analysis.ipf.
+Definition at line 266 of file fermi-edge-analysis.ipf.
@@ -456,7 +415,7 @@ Licensed under the Apache License, Version 2.0 (the "License");physical size (radius) of the MCP in mm
-Definition at line 261 of file fermi-edge-analysis.ipf.
+Definition at line 262 of file fermi-edge-analysis.ipf.
@@ -482,7 +441,7 @@ Licensed under the Apache License, Version 2.0 (the "License");MCP radius seen by the camera in pixels.
-Definition at line 259 of file fermi-edge-analysis.ipf.
+Definition at line 260 of file fermi-edge-analysis.ipf.
@@ -492,9 +451,9 @@ Licensed under the Apache License, Version 2.0 (the "License");data acquisition and analysis package for ARPES at PEARL.
The purpose of a package is to load a bunch of dependent procedure files. The ARPES package loads the following files which are helpful when working with ARPES data (any data from the Scienta analyser, that is) from PEARL.
Most of these files require the HDF5.XOP. The following files are loaded if the EPICS.XOP is present:
PEARL Procedures is a suite of Igor Pro procedures developed for data acquisition and data processing at the PEARL beamline at the Swiss Light Source.
PEARL Procedures are tested on Igor Pro 8.04, 64-bit. Compatibility with earlier versions of Igor has been dropped. Please make sure to use the latest release version of Igor Pro.
PEARL Procedures should be installed according to the regular Igor Pro guidelines. Please read the Igor help About Igor Pro User Files
for details.
pearl-procs
directory in your private or shared User Procedures
folder, and copy the PEARL Procedures distribution there.pearl-arpes.ipf
and pearl-menu.ipf
files, and move them to the Igor Procedures
folder next to your User Procedures
folder.HDF5.XOP
extension in the Igor Pro Folder
under More Extensions/File Loaders
, create a shortcut, and move the shortcut to the Igor Extensions
folder next to your User Procedures
folder.pearl-arpes.ipf
and pearl-menu.ipf
files, and move them to the Igor Procedures
folder next to your User Procedures
folder.Igor Pro 9 imports the HDF5 library by default. For earlier versions:
+HDF5.XOP
(HDF5-64.xop
for 64-bit) extension in the Igor Pro Folder
under More Extensions/File Loaders
(More Extensions (64-bit)/File Loaders
), create a shortcut, and move the shortcut to the Igor Extensions
folder next to your User Procedures
folder.HDF5 Help.ihf
next to HDF5.XOP
, create a shortcut, and move the shortcut to the Igor Help Files
folder next to your User Procedures
folder.An open distribution of PEARL Procedures is available under the Apache License, Version 2.0 at https://git.psi.ch/pearl-public/igor-procs. Users of PEARL Procedures are requested to coordinate and share the development of the code with the original author. Please read and respect the respective license agreements.
-interactive processing of angle scanned XPD data. -More...
+More...interactive processing of angle scanned XPD data.
-PearlAnglescanPanel is declared in pearl-anglescan-panel.ipf.
+PearlAnglescanPanel is declared in pearl-anglescan-panel.ipf.
processing and holographic mapping of angle scanned XPD data. -More...
+More...processing and holographic mapping of angle scanned XPD data.
-PearlAnglescanProcess is declared in pearl-anglescan-process.ipf.
+PearlAnglescanProcess is declared in pearl-anglescan-process.ipf.
instant visualization of angle scan and manipulator position. -More...
+More...instant visualization of angle scan and manipulator position.
3D graphics in a Gizmo window
data dictionary of global variables in view_xxxx folder:
data dictionary of global variables in view_xxxx folder:
scienta HDF5 import, display, and slicer how-to -
/// ad_display_brick(root:x03da_scienta_20130821_01560:data) +scienta HDF5 import, display, and slicer how-to
/// ad_display_brick(root:x03da_scienta_20130821_01560:data) /// ad_scale_scienta(root:x03da_scienta_20130821_01560:data) /// ad_scale_extra(root:x03da_scienta_20130821_01560:data,root:x03da_scienta_20130821_01560:MonoEnergy,root:x03da_scienta_20130821_01560:data) /// ad_display_brick(root:x03da_scienta_20130821_01560:data) @@ -114,16 +117,17 @@ Miscellaneous Licensed under the Apache License, Version 2.0 (the "License"); @n you may not use this file except in compliance with the License. @n You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0PearlAreaDisplay is declared in pearl-area-display.ipf.
+ http://www.apache.org/licenses/LICENSE-2.0 +
PearlAreaDisplay is declared in pearl-area-display.ipf.
HDF5 file import from EPICS area detectors. -More...
+More...HDF5 file import from EPICS area detectors.
-PearlAreaImport is declared in pearl-area-import.ipf.
+PearlAreaImport is declared in pearl-area-import.ipf.
profile extraction for multi-dimensional datasets acquired from area detectors. -More...
+More...profile extraction for multi-dimensional datasets acquired from area detectors.
PearlAnglescanTracker is declared in pearl-area-profiles.ipf.
@@ -97,9 +99,9 @@ $(document).ready(function(){initNavTree('namespace_pearl_area_profiles.html','' diff --git a/doc/html/namespace_pearl_arpes.html b/doc/html/namespace_pearl_arpes.html index 85553b6..4c2d4a3 100644 --- a/doc/html/namespace_pearl_arpes.html +++ b/doc/html/namespace_pearl_arpes.html @@ -1,9 +1,9 @@ - + - +data acquisition and analysis package for ARPES at PEARL. -More...
+More...data acquisition and analysis package for ARPES at PEARL.
-PearlArpes is declared in pearl-arpes.ipf.
+PearlArpes is declared in pearl-arpes.ipf.
compatibility procedures for igor 8 -More...
+More...compatibility procedures for igor 8
-PearlCompat is declared in pearl-compat.ipf.
+PearlCompat is declared in pearl-compat.ipf.
- PEARL Procedures
- rev-distro-2.1.1-1-gf419e92-dirty
-
- Igor procedures for the analysis of PEARL data
- |
-
preview and import panel for PEARL data -More...
-preview and import panel for PEARL data
-PearlDataExplorer is declared in pearl-data-explorer.ipf.
-interface for writing ELOG entries with Igor graphs as attachment. -More...
+More...interface for writing ELOG entries with Igor graphs as attachment.
-PearlElog is declared in pearl-elog.ipf.
+PearlElog is declared in pearl-elog.ipf.
various fit functions for photoelectron spectroscopy. -More...
+More...various fit functions for photoelectron spectroscopy.
-PearlFitFuncs is declared in pearl-fitfuncs.ipf.
+PearlFitFuncs is declared in pearl-fitfuncs.ipf.
data file import for omicron matrix (STM) files -More...
+More...data file import for omicron matrix (STM) files
-PearlMatrixImport is declared in pearl-matrix-import.ipf.
+PearlMatrixImport is declared in pearl-matrix-import.ipf.
import data from PShell -More...
+More...import data from PShell
-PearlPShellImport is declared in pearl-pshell-import.ipf.
+PearlPShellImport is declared in pearl-pshell-import.ipf.
data import/export procedures for multiple scattering calculations. -More...
+More...data import/export procedures for multiple scattering calculations.
-PearlPmscoImport is declared in pearl-pmsco-import.ipf.
+PearlPmscoImport is declared in pearl-pmsco-import.ipf.
- PEARL Procedures
- rev-distro-2.1.1-1-gf419e92-dirty
-
- Igor procedures for the analysis of PEARL data
- |
-
count rate functions for Scienta detector images. -More...
-count rate functions for Scienta detector images.
-PearlScientaCountrate is declared in pearl-scienta-countrate.ipf.
-preprocessing functions for Scienta detector images. -More...
+More...preprocessing functions for Scienta detector images.
-PearlScientaPreprocess is declared in pearl-scienta-preprocess.ipf.
+PearlScientaPreprocess is declared in pearl-scienta-preprocess.ipf.
basic vector geometry operations. -More...
+More...basic vector geometry operations.
-PearlVectorOperations is declared in pearl-vector-operations.ipf.
+PearlVectorOperations is declared in pearl-vector-operations.ipf.
The processing steps depend on the complexity of the measured spectrum. The user may have to adopt one of the predefined or a custom procedure accordingly. Here, we describe two procedures that may cover many generic cases or that can serve as a starting point for a refined, customized procedure. However, any procedure that produces the datasets mentioned above is, of course, a valid approach. For instance, you could load the complete three-dimensional ScientaImage dataset, and generate the two-dimensional dataset using your own procedures.
The central import functions are psh5_load_reduced and psh5_load_dataset_reduced. The first form is sufficient if the file contains just one scan and region. Further regions/scans need to be loaded using the second form. The first form is also exposed in the PEARL data explorer window.
+The central import functions are psh5_load_reduced and psh5_load_dataset_reduced. The first form is sufficient if the file contains just one scan and region. Further regions/scans need to be loaded using the second form. The first form is also exposed in the PEARL data explorer window.
The functions require a data reduction function and processing parameters as arguments. Some particular reduction functions are described further below. More can be found in the source code (or obtained from other users). A list of functions that look like reduction functions can be got from adh5_list_reduction_funcs.
The basic call sequence looks as follows. Substitute the arguments in angle brackets as necessary. You may have to analyse a reference spectrum or the complete ScientaImage to figure out the processing parameters beforehand.
First form:
-Second form:
-Second form:
+The int_linbg_reduction function converts a two-dimensional Scienta image I(angle, energy) into a one-dimensional angle distribution I(angle). For each angle slice, it calculates a linear background. Then, it integrates the difference between the original data and the background over a specified interval.
The function requires the following, fixed parameters:
-Parameter | Description | Typical value | |
---|---|---|---|
Lcrop | size of the low-energy cropping region | 0.11 (fixed mode) | |
Lsize | size of the low-energy background region | 0.2 | |
Hcrop | size of the high-energy cropping region | 0.11 | |
Hsize | size of the high-energy background region | 0.2 | |
Cpos | position of the peak center | 0.5 | |
Csize | size of the center region | 0.3 |
Parameter | Description | Typical value |
---|---|---|
Lcrop | size of the low-energy cropping region | 0.11 (fixed mode) |
Lsize | size of the low-energy background region | 0.2 |
Hcrop | size of the high-energy cropping region | 0.11 |
Hsize | size of the high-energy background region | 0.2 |
Cpos | position of the peak center | 0.5 |
Csize | size of the center region | 0.3 |
All parameters are relative to the size of the image (length of the energy interval) and must be in the range from 0 to 1.
The cropping region is cut away from the image for the rest of the processing. This is necessary to remove the dark corners in fixed mode but can be neglected in swept mode (cropping size = 0).
@@ -157,33 +182,33 @@ Peak fittingThe gauss4_reduction function converts a two-dimensional Scienta image I(angle, energy) into a one-dimensional angle distribution I(angle). For each angle slice, it performs a Gaussian curve fit with up to four components on a linear background.
To improve the stability of the fit, the peak positions and widths are kept fixed while the amplitudes of the peaks and the background parameters are variable but constrained to reasonable values (positive amplitude). Furthermore, the function can optionally do a box averaging over three slices.
The function requires the following, fixed parameters:
-Parameter | Description | ||
---|---|---|---|
rngl | lower limit of the fit interval | ||
rngh | upper limit of the fit interval | ||
npeaks | number of components | ||
pos1 | center energy of peak 1 | ||
wid1 | width of peak 1 | ||
pos2 | center energy of peak 2 | ||
wid2 | width of peak 2 | ||
pos3 | center energy of peak 3 | ||
wid3 | width of peak 3 | ||
pos4 | center energy of peak 3 | ||
wid4 | width of peak 3 | ||
ybox | box size of slice averaging (1 or 3) |
Parameter | Description |
---|---|
rngl | lower limit of the fit interval |
rngh | upper limit of the fit interval |
npeaks | number of components |
pos1 | center energy of peak 1 |
wid1 | width of peak 1 |
pos2 | center energy of peak 2 |
wid2 | width of peak 2 |
pos3 | center energy of peak 3 |
wid3 | width of peak 3 |
pos4 | center energy of peak 3 |
wid4 | width of peak 3 |
ybox | box size of slice averaging (1 or 3) |
The peak parameters should be determined beforehand from fitting a reference spectrum, or the angle-scan integrated over all angles. Peak positions and widths have to be specified only up to the given number of peaks.
The data reduction procedure returns the peak integrals (amplitude times width times square root of 2) in waves named ReducedDataN where N is a numeric index from 1 to npeaks. The waves starting with an index of npeaks+1 contain the corresponding error estimate of the peak integral.
@@ -197,60 +222,83 @@ NormalizationThere is a GUI for the processing steps in pearl-anglescan-panel.ipf (asp_show_panel function or the PEARL/process menu).
Start by creating a new copy of the data and inspecting it:
To update the display after changes to NormData1:
Start by creating a new copy of the data and inspecting it:
To update the display after changes to NormData1:
Crop the detector angle axis to a useful range (usually about -25 to +25 degrees):
Crop the detector angle axis to a useful range (usually about -25 to +25 degrees):
Remove inhomogeneity of the detector in the detector angle axis. This component may also include a contribution from the sample. If your raw data shows a flat distribution, this step is not necessary.
-Note that the argument check=2
causes the function to generate two check waves but not to modify the original data. To inspect the check waves:
Vary the smooth_factor
(between 0.1 and 1.0) until it follows the instrumental curve but does not affect diffraction features. Then set check=1
to apply the normalization to NormData1
.
Note that the argument check=2
causes the function to generate two check waves but not to modify the original data. To inspect the check waves:
Vary the smooth_factor
(between 0.1 and 1.0) until it follows the instrumental curve but does not affect diffraction features. Then set check=1
to apply the normalization to NormData1
.
Reduce the effect of azimuthal wobble (misaligned surface) on intensity. A misaligned surface may cause a sinusoidal variation of the intensity as a function of azimuthal angle with a 360° period. A strong azimuthal variation may affect the polar normalization in the next step. The azimuthal normalization can be based on a restricted range of polar angles (theta range). You have to find out which value works best for your sample.
-Note, however, that his function does not correct for angle shifts induced by the misalignment!
+Note, however, that his function does not correct for angle shifts induced by the misalignment!
Remove the polar angle dependence (matrix element and excitation/detection geometry).
-Use the check waves and the check
argument as described above.
Use the check waves and the check
argument as described above.
You can bin and plot the data in one step:
-or two steps:
-The benefit of the latter is that you have more control over the graph through optional arguments. In particular, you can select the projection or hide the ticks and grids. See display_hemi_scan for details.
+or two steps:
+The benefit of the latter is that you have more control over the graph through optional arguments. In particular, you can select the projection or hide the ticks and grids. See display_hemi_scan for details.
The pizza_service function requires the waves with manipulator positions in a specific place, namely :attr:ManipulatorTheta
(for the polar angle), and the normal emission values as function arguments. If you have moved the waves, or if you have subtracted the offsets yourself, use the alternative pizza_service_2 function.
Additional parameters of the pizza_service function allow for rotational averaging, larger angle steps (default 1 degree), or the creation of metadata including a notebook for xpdPlot.
Note there is currently a bug in the nick name argument of some of the following functions. If the lines shown below do not work, try to switch to the data folder that contains the generated polar plot data, and call the function with an empty nickname ""
.
To remove high polar angles above θ = 80 from the plot (and data):
-Modify the pseudocolor scale by changing the polarY0
trace:
To set the contrast to clip specified percentiles of the data points, use the
Modify the pseudocolor scale by changing the polarY0
trace:
To set the contrast to clip specified percentiles of the data points, use the
Polar plots can also be interpolated to a rectangular matrix, which may in some cases produce nicer images:
-The matrix =
line optionally removes artefacts at high polar angles. Replace the cut-off angle with your own.
The matrix =
line optionally removes artefacts at high polar angles. Replace the cut-off angle with your own.
To calculate the modulation function and substitute it in the graph:
-The display_hemi_scan and interpolate_hemi_scan functions take an optional argument projection
which selects one of the following projections. By default, stereographic projection is selected.
Selector | Projection | Function | Properties |
---|---|---|---|
kProjDist = 0 | azimuthal equidistant | r = c * theta | radius is proportional to polar angle |
kProjStereo = 1 | stereographic | r = c * tan theta/2 | circles on sphere map to circles |
kProjArea = 2 | azimuthal equal-area | r = c * sin theta/2 | preserves area measure |
kProjGnom = 3 | gnomonic | r = c * tan theta | great circles map to straight lines |
kProjOrtho = 4 | orthographic | r = c * sin theta | momentum mapping in ARPES and LEED |
Selector | Projection | Function | Properties |
---|---|---|---|
kProjDist = 0 | azimuthal equidistant | r = c * theta | radius is proportional to polar angle |
kProjStereo = 1 | stereographic | r = c * tan theta/2 | circles on sphere map to circles |
kProjArea = 2 | azimuthal equal-area | r = c * sin theta/2 | preserves area measure |
kProjGnom = 3 | gnomonic | r = c * tan theta | great circles map to straight lines |
kProjOrtho = 4 | orthographic | r = c * sin theta | momentum mapping in ARPES and LEED |
For a description of the different projections, see Wikipedia, for example. The projections in this package are defined for 0 <= theta < 90.
The following line is an example of how to export a graph window. Click on the desired graph window, then issue the following command, substituting the file path and file name as appropriate.
-The following line saves the dataset to an Igor text file. The file contains all data necessary to recreate a polar plot without further processing.
-For structural optimization using the PMSCO software, it is necessary to generate an ETPI file. There is currently no special function for this. Instead, you have to create and set an energy wave,
-and write the four waves en, pol, az, values
to a general text file. Be careful about the ordering of the waves! You will also have to rename the file to the .etpi
extension because Igor always saves with .txt
extension. If you have a wave with statistical errors, add a fifth column and use the .etpis
extension.
For structural optimization using the PMSCO software, it is necessary to generate an ETPI file. There is currently no special function for this. Instead, you have to create and set an energy wave,
+and write the four waves en, pol, az, values
to a general text file. Be careful about the ordering of the waves! You will also have to rename the file to the .etpi
extension because Igor always saves with .txt
extension. If you have a wave with statistical errors, add a fifth column and use the .etpis
extension.
Projections | Functions of the anglescan package support the following map projections |
Projections | |
Angle-scan processing | |
Todo List |
#include "pearl-anglescan-process"
#include "pearl-pmsco-import"
#include "pearl-scienta-preprocess"
#include "pearl-area-display"
Go to the source code of this file.
Functions | |
static variable | AfterCompiledHook () |
initialize package data once when the procedure is first loaded More... | |
initialize package data once when the procedure is first loaded More... | |
static variable | init_package () |
static variable | save_prefs () |
save persistent package data to the preferences file. More... | |
save persistent package data to the preferences file. More... | |
static variable | load_prefs () |
load persistent package data from the preferences file. More... | |
load persistent package data from the preferences file. More... | |
variable | asp_import_raw (wave raw_data) |
import raw data More... | |
import raw data More... | |
variable | asp_display_previews () |
display a graph window of the processed data. More... | |
display a graph window of the processed data. More... | |
variable | asp_display_dist_check (variable xdist, variable ydist) |
display a graph window of the distribution checks. More... | |
display a graph window of the distribution checks. More... | |
static variable | do_init_process (variable check) |
initialize the process data with a copy of the raw data. More... | |
initialize the process data with a copy of the raw data. More... | |
static variable | do_crop (variable check, variable force=defaultValue) |
crop the process data. More... | |
crop the process data. More... | |
static variable | delete_rows (string rows, wave data, wave theta, wave tilt, wave phi) |
delete individual rows from the data strip More... | |
delete individual rows from the data strip More... | |
static variable | do_norm_alpha (variable check, variable force=defaultValue) |
alpha-normalize the process data. More... | |
alpha-normalize the process data. More... | |
static variable | do_norm_phi (variable check, variable force=defaultValue) |
phi-normalize the process data. More... | |
phi-normalize the process data. More... | |
static variable | do_norm_theta (variable check, variable force=defaultValue) |
theta-normalize the process data. More... | |
theta-normalize the process data. More... | |
static variable | do_norm_thetaphi (variable check, variable force=defaultValue) |
theta,phi-normalize the process data. More... | |
theta,phi-normalize the process data. More... | |
variable | asp_calculate_output () |
calculate the output using all enabled processing filters. More... | |
calculate the output using all enabled processing filters. More... | |
string | asp_display_output (dfref data_df=defaultValue, string data_name=defaultValue) |
display the output diffractogram More... | |
display the output diffractogram More... | |
variable | asp_update_graph () |
update graphs with new color table or contrast More... | |
update graphs with new color table or contrast More... | |
variable | asp_close_graphs () |
close all graphs created by the angle scan panel More... | |
close all graphs created by the angle scan panel More... | |
string | asp_duplicate_output (string dest_name, variable do_graph=defaultValue) |
copy the output data to a new folder More... | |
copy the output data to a new folder More... | |
variable | asp_save_output_itx () |
save the output diffractogram to an igor text file More... | |
save the output diffractogram to an igor text file More... | |
variable | asp_save_output_etpi (variable ekin) |
save the output diffractogram to a PMSCO ETPI file More... | |
save the output diffractogram to a PMSCO ETPI file More... | |
static variable | check_norm_alpha () |
static variable | preview_norm_thetaphi () |
variable | asp_show_panel () |
create the angle scan processing panel More... | |
create the angle scan processing panel More... | |
static variable | arrange_controls () |
static variable | update_menus () |
update the popup menus to reflect the values of the global variables More... | |
update the popup menus to reflect the values of the global variables More... | |
static variable | bp_load_prefs (WMButtonAction *ba) |
Variables | |
static const string | package_name = "pearl_anglescan_panel" |
package name is used as data folder name More... | |
package name is used as data folder name More... | |
static const string | package_path = "root:packages:pearl_anglescan_panel:" |
data folder path More... | |
data folder path More... | |
interactive processing of angle scanned XPD data.
steps to process a hemispherical scan into a diffractogram:
Definition in file pearl-anglescan-panel.ipf.
@@ -299,7 +303,7 @@ Licensed under the Apache License, Version 2.0 (the "License");initialize package data once when the procedure is first loaded
-Definition at line 50 of file pearl-anglescan-panel.ipf.
+Definition at line 53 of file pearl-anglescan-panel.ipf.
Definition at line 1052 of file pearl-anglescan-panel.ipf.
+Definition at line 1055 of file pearl-anglescan-panel.ipf.
calculate the output using all enabled processing filters.
the diffractogram is calculated, to display the graph, call asp_display_output.
-Definition at line 620 of file pearl-anglescan-panel.ipf.
+Definition at line 623 of file pearl-anglescan-panel.ipf.
@@ -369,7 +373,7 @@ Licensed under the Apache License, Version 2.0 (the "License");close all graphs created by the angle scan panel
-Definition at line 728 of file pearl-anglescan-panel.ipf.
+Definition at line 731 of file pearl-anglescan-panel.ipf.
@@ -409,7 +413,7 @@ Licensed under the Apache License, Version 2.0 (the "License");Definition at line 273 of file pearl-anglescan-panel.ipf.
+Definition at line 276 of file pearl-anglescan-panel.ipf.
@@ -449,7 +453,7 @@ Licensed under the Apache License, Version 2.0 (the "License");Definition at line 666 of file pearl-anglescan-panel.ipf.
+Definition at line 669 of file pearl-anglescan-panel.ipf.
@@ -471,7 +475,7 @@ Licensed under the Apache License, Version 2.0 (the "License");display a graph window of the processed data.
if the window exists, it is updated and brought to the front of the window stack.
-Definition at line 249 of file pearl-anglescan-panel.ipf.
+Definition at line 252 of file pearl-anglescan-panel.ipf.
@@ -511,7 +515,7 @@ Licensed under the Apache License, Version 2.0 (the "License");Definition at line 768 of file pearl-anglescan-panel.ipf.
+Definition at line 771 of file pearl-anglescan-panel.ipf.
@@ -540,7 +544,7 @@ Licensed under the Apache License, Version 2.0 (the "License");Definition at line 204 of file pearl-anglescan-panel.ipf.
+Definition at line 207 of file pearl-anglescan-panel.ipf.
@@ -568,7 +572,7 @@ Licensed under the Apache License, Version 2.0 (the "License");Definition at line 816 of file pearl-anglescan-panel.ipf.
+Definition at line 819 of file pearl-anglescan-panel.ipf.
@@ -589,7 +593,7 @@ Licensed under the Apache License, Version 2.0 (the "License");save the output diffractogram to an igor text file
-Definition at line 801 of file pearl-anglescan-panel.ipf.
+Definition at line 804 of file pearl-anglescan-panel.ipf.
@@ -610,7 +614,7 @@ Licensed under the Apache License, Version 2.0 (the "License");create the angle scan processing panel
-Definition at line 900 of file pearl-anglescan-panel.ipf.
+Definition at line 903 of file pearl-anglescan-panel.ipf.
@@ -632,7 +636,7 @@ Licensed under the Apache License, Version 2.0 (the "License");update graphs with new color table or contrast
applies to the preview graph and the diffractogram.
-Definition at line 710 of file pearl-anglescan-panel.ipf.
+Definition at line 713 of file pearl-anglescan-panel.ipf.
@@ -660,7 +664,7 @@ Licensed under the Apache License, Version 2.0 (the "License");Definition at line 1370 of file pearl-anglescan-panel.ipf.
+Definition at line 1373 of file pearl-anglescan-panel.ipf.
Definition at line 1526 of file pearl-anglescan-panel.ipf.
+Definition at line 1529 of file pearl-anglescan-panel.ipf.
Definition at line 1512 of file pearl-anglescan-panel.ipf.
+Definition at line 1515 of file pearl-anglescan-panel.ipf.
Definition at line 1239 of file pearl-anglescan-panel.ipf.
+Definition at line 1242 of file pearl-anglescan-panel.ipf.
Definition at line 1314 of file pearl-anglescan-panel.ipf.
+Definition at line 1317 of file pearl-anglescan-panel.ipf.
Definition at line 1384 of file pearl-anglescan-panel.ipf.
+Definition at line 1387 of file pearl-anglescan-panel.ipf.
Definition at line 1342 of file pearl-anglescan-panel.ipf.
+Definition at line 1345 of file pearl-anglescan-panel.ipf.
Definition at line 1398 of file pearl-anglescan-panel.ipf.
+Definition at line 1401 of file pearl-anglescan-panel.ipf.
Definition at line 1328 of file pearl-anglescan-panel.ipf.
+Definition at line 1331 of file pearl-anglescan-panel.ipf.
Definition at line 1412 of file pearl-anglescan-panel.ipf.
+Definition at line 1415 of file pearl-anglescan-panel.ipf.
Definition at line 1356 of file pearl-anglescan-panel.ipf.
+Definition at line 1359 of file pearl-anglescan-panel.ipf.
Definition at line 1426 of file pearl-anglescan-panel.ipf.
+Definition at line 1429 of file pearl-anglescan-panel.ipf.
Definition at line 1440 of file pearl-anglescan-panel.ipf.
+Definition at line 1443 of file pearl-anglescan-panel.ipf.
Definition at line 1455 of file pearl-anglescan-panel.ipf.
+Definition at line 1458 of file pearl-anglescan-panel.ipf.
Definition at line 1476 of file pearl-anglescan-panel.ipf.
+Definition at line 1479 of file pearl-anglescan-panel.ipf.
Definition at line 1498 of file pearl-anglescan-panel.ipf.
+Definition at line 1501 of file pearl-anglescan-panel.ipf.
Definition at line 1253 of file pearl-anglescan-panel.ipf.
+Definition at line 1256 of file pearl-anglescan-panel.ipf.
Definition at line 1267 of file pearl-anglescan-panel.ipf.
+Definition at line 1270 of file pearl-anglescan-panel.ipf.
Definition at line 1293 of file pearl-anglescan-panel.ipf.
+Definition at line 1296 of file pearl-anglescan-panel.ipf.
Definition at line 836 of file pearl-anglescan-panel.ipf.
+Definition at line 839 of file pearl-anglescan-panel.ipf.
Definition at line 843 of file pearl-anglescan-panel.ipf.
+Definition at line 846 of file pearl-anglescan-panel.ipf.
Definition at line 850 of file pearl-anglescan-panel.ipf.
+Definition at line 853 of file pearl-anglescan-panel.ipf.
Definition at line 857 of file pearl-anglescan-panel.ipf.
+Definition at line 860 of file pearl-anglescan-panel.ipf.
Definition at line 406 of file pearl-anglescan-panel.ipf.
+Definition at line 409 of file pearl-anglescan-panel.ipf.
@@ -1396,7 +1400,7 @@ Licensed under the Apache License, Version 2.0 (the "License");Definition at line 358 of file pearl-anglescan-panel.ipf.
+Definition at line 361 of file pearl-anglescan-panel.ipf.
@@ -1438,7 +1442,7 @@ Licensed under the Apache License, Version 2.0 (the "License");Definition at line 318 of file pearl-anglescan-panel.ipf.
+Definition at line 321 of file pearl-anglescan-panel.ipf.
@@ -1494,7 +1498,7 @@ Licensed under the Apache License, Version 2.0 (the "License");Definition at line 453 of file pearl-anglescan-panel.ipf.
+Definition at line 456 of file pearl-anglescan-panel.ipf.
@@ -1550,7 +1554,7 @@ Licensed under the Apache License, Version 2.0 (the "License");Definition at line 494 of file pearl-anglescan-panel.ipf.
+Definition at line 497 of file pearl-anglescan-panel.ipf.
@@ -1606,7 +1610,7 @@ Licensed under the Apache License, Version 2.0 (the "License");Definition at line 537 of file pearl-anglescan-panel.ipf.
+Definition at line 540 of file pearl-anglescan-panel.ipf.
@@ -1662,7 +1666,7 @@ Licensed under the Apache License, Version 2.0 (the "License");Definition at line 584 of file pearl-anglescan-panel.ipf.
+Definition at line 587 of file pearl-anglescan-panel.ipf.
@@ -1689,7 +1693,7 @@ Licensed under the Apache License, Version 2.0 (the "License");Definition at line 75 of file pearl-anglescan-panel.ipf.
+Definition at line 78 of file pearl-anglescan-panel.ipf.
the preferences file is an Igor packed experiment file in a special preferences folder.
this function is called automatically when the procedure is first compiled, or whenever the user clicks the corresponding button.
-Definition at line 168 of file pearl-anglescan-panel.ipf.
+Definition at line 171 of file pearl-anglescan-panel.ipf.
@@ -1748,7 +1752,7 @@ Licensed under the Apache License, Version 2.0 (the "License");Definition at line 1641 of file pearl-anglescan-panel.ipf.
+Definition at line 1644 of file pearl-anglescan-panel.ipf.
Definition at line 1609 of file pearl-anglescan-panel.ipf.
+Definition at line 1612 of file pearl-anglescan-panel.ipf.
Definition at line 1625 of file pearl-anglescan-panel.ipf.
+Definition at line 1628 of file pearl-anglescan-panel.ipf.
Definition at line 1545 of file pearl-anglescan-panel.ipf.
+Definition at line 1548 of file pearl-anglescan-panel.ipf.
Definition at line 1561 of file pearl-anglescan-panel.ipf.
+Definition at line 1564 of file pearl-anglescan-panel.ipf.
Definition at line 1577 of file pearl-anglescan-panel.ipf.
+Definition at line 1580 of file pearl-anglescan-panel.ipf.
Definition at line 1593 of file pearl-anglescan-panel.ipf.
+Definition at line 1596 of file pearl-anglescan-panel.ipf.
Definition at line 864 of file pearl-anglescan-panel.ipf.
+Definition at line 867 of file pearl-anglescan-panel.ipf.
Definition at line 870 of file pearl-anglescan-panel.ipf.
+Definition at line 873 of file pearl-anglescan-panel.ipf.
Definition at line 877 of file pearl-anglescan-panel.ipf.
+Definition at line 880 of file pearl-anglescan-panel.ipf.
Definition at line 884 of file pearl-anglescan-panel.ipf.
+Definition at line 887 of file pearl-anglescan-panel.ipf.
Definition at line 891 of file pearl-anglescan-panel.ipf.
+Definition at line 894 of file pearl-anglescan-panel.ipf.
save persistent package data to the preferences file.
this function is called when the user clicks the corresponding button.
-Definition at line 142 of file pearl-anglescan-panel.ipf.
+Definition at line 145 of file pearl-anglescan-panel.ipf.
@@ -2110,7 +2114,7 @@ Licensed under the Apache License, Version 2.0 (the "License");update the popup menus to reflect the values of the global variables
-Definition at line 1210 of file pearl-anglescan-panel.ipf.
+Definition at line 1213 of file pearl-anglescan-panel.ipf.
@@ -2137,7 +2141,7 @@ Licensed under the Apache License, Version 2.0 (the "License");package name is used as data folder name
-Definition at line 45 of file pearl-anglescan-panel.ipf.
+Definition at line 48 of file pearl-anglescan-panel.ipf.
@@ -2163,7 +2167,7 @@ Licensed under the Apache License, Version 2.0 (the "License");data folder path
-Definition at line 47 of file pearl-anglescan-panel.ipf.
+Definition at line 50 of file pearl-anglescan-panel.ipf.
@@ -2173,9 +2177,9 @@ Licensed under the Apache License, Version 2.0 (the "License");Functions | |
string | strip_append (wave strip1, wave strip2) |
append an angle scan strip to another one More... | |
variable | strip_delete_frames (wave strip, variable qlo, variable qhi, wave theta, wave tilt, wave phi) |
delete a contiguous range of frames from a strip. More... | |
delete a contiguous range of frames from a strip. More... | |
variable | normalize_strip_x (wave strip, variable smooth_method=defaultValue, variable smooth_factor=defaultValue, variable check=defaultValue) |
divide the strip by the average X distribution. More... | |
divide the strip by the average X distribution. More... | |
variable | normalize_strip_phi (wave strip, wave theta, wave phi, variable theta_offset=defaultValue, variable theta_range=defaultValue, variable check=defaultValue) |
divide the strip by a sine function in phi (wobble correction). More... | |
divide the strip by a sine function in phi (wobble correction). More... | |
variable | normalize_strip_theta (wave strip, wave theta, variable theta_offset=defaultValue, variable smooth_method=defaultValue, variable smooth_factor=defaultValue, variable check=defaultValue) |
divide the strip by the average polar distribution. More... | |
divide the strip by the average polar distribution. More... | |
variable | normalize_strip_thetaphi (wave strip, wave theta, wave phi, variable theta_offset=defaultValue, variable smooth_method=defaultValue, variable smooth_factor=defaultValue, variable check=defaultValue) |
divide the strip by a smooth polar-azimuthal distribution. More... | |
divide the strip by a smooth polar-azimuthal distribution. More... | |
variable | normalize_strip_theta_scans (wave strip, wave theta, variable theta_offset=defaultValue, variable smooth_method=defaultValue, variable smooth_factor=defaultValue, variable check=defaultValue) |
divide the strip piecewise by a smooth polar distribution. More... | |
divide the strip piecewise by a smooth polar distribution. More... | |
variable | normalize_strip_2d (wave strip, wave theta, variable theta_offset=defaultValue, variable smooth_method=defaultValue, variable smooth_factor=defaultValue, variable check=defaultValue) |
divide the strip by a two-dimensional normalization function. More... | |
divide the strip by a two-dimensional normalization function. More... | |
variable | crop_strip (wave strip, variable xlo, variable xhi) |
crop a strip at the sides. More... | |
crop a strip at the sides. More... | |
variable | crop_strip_theta (wave strip, variable theta_lo, variable theta_hi, wave theta, wave tilt, wave phi) |
crop a strip in theta. More... | |
crop a strip in theta. More... | |
variable | pizza_service (wave data, string nickname, variable theta_offset, variable tilt_offset, variable phi_offset, variable npolar=defaultValue, variable nograph=defaultValue, variable folding=defaultValue, variable xpdplot=defaultValue) |
create a pizza plot from a measured (energy-integrated) data strip More... | |
create a pizza plot from a measured (energy-integrated) data strip More... | |
variable | pizza_service_2 (wave data, string nickname, wave m_theta, wave m_tilt, wave m_phi, variable npolar=defaultValue, variable nograph=defaultValue, variable folding=defaultValue, variable xpdplot=defaultValue) |
create a pizza plot from a measured (energy-integrated) data strip More... | |
create a pizza plot from a measured (energy-integrated) data strip More... | |
variable | show_analyser_line (variable theta, variable tilt, variable phi, variable theta_offset, variable tilt_offset, variable phi_offset, variable npolar=defaultValue, variable nograph=defaultValue, variable xpdplot=defaultValue) |
calculate and display the line seen by the analyser for a specific emission angle More... | |
calculate and display the line seen by the analyser for a specific emission angle More... | |
variable | convert_angles_ttpd2polar (wave theta, wave tilt, wave phi, wave data, wave polar, wave azi) |
convert angles from TTPA (theta-tilt-phi-analyser) scheme to polar coordinates. More... | |
convert angles from TTPA (theta-tilt-phi-analyser) scheme to polar coordinates. More... | |
variable | convert_angles_ttpa2polar (wave theta, wave tilt, wave phi, wave analyser, wave polar, wave azi) |
convert angles from TTPA (theta-tilt-phi-analyser) scheme to polar coordinates. More... | |
convert angles from TTPA (theta-tilt-phi-analyser) scheme to polar coordinates. More... | |
static variable | line_average (wave source, wave dest) |
static variable | calc_nth (variable Theta_st, variable Theta_in, variable th, variable Phi_ran, variable Phi_ref, string Holomode) |
calculate the number of phis for a given theta More... | |
calculate the number of phis for a given theta More... | |
static variable | calc_phi_step (variable Theta_in, variable th, variable Theta_st, variable Phi_ran, variable Phi_ref, string Holomode) |
calculate delta-phi for a given theta More... | |
calculate delta-phi for a given theta More... | |
static variable | Calc_The_step (variable th, variable Theta_st, string Holomode) |
calculate delta-theta for a given theta More... | |
calculate delta-theta for a given theta More... | |
static variable | CalcN_Theta (string HoloMode, variable Theta_in, variable Theta_ran, variable Theta_st) |
calculate the number of thetas for a pattern More... | |
calculate the number of thetas for a pattern More... | |
variable | make_hemi_grid (variable npol, string nickname, variable xpdplot=defaultValue) |
create a hemispherical, constant solid angle grid More... | |
create a hemispherical, constant solid angle grid More... | |
string | get_hemi_nickname (wave w) |
finds the nick name given any hemi wave More... | |
finds the nick name given any hemi wave More... | |
string | get_hemi_prefix (wave w) |
finds the prefix given any hemi wave More... | |
finds the prefix given any hemi wave More... | |
dfr | find_hemi_data (string nickname, string *prefix, string *intwave) |
finds the folder, prefix and name of holo waves given their nick name More... | |
finds the folder, prefix and name of holo waves given their nick name More... | |
variable | clear_hemi_grid (string nickname) |
clear a hemispherical scan grid More... | |
clear a hemispherical scan grid More... | |
variable | duplicate_hemi_scan (string source_nickname, dfref dest_folder, string dest_nickname, variable xpdplot=defaultValue) |
duplicate a hemispherical scan dataset. More... | |
duplicate a hemispherical scan dataset. More... | |
variable | rotate_hemi_scan (string nickname, variable angle) |
azimuthally rotate a hemispherical scan dataset. More... | |
azimuthally rotate a hemispherical scan dataset. More... | |
string | prepare_hemi_scan_display (string nickname, variable projection=defaultValue) |
create waves for plotting a hemispherical angle scan. More... | |
create waves for plotting a hemispherical angle scan. More... | |
string | display_hemi_scan (string nickname, variable projection=defaultValue, variable graphtype=defaultValue, variable do_ticks=defaultValue, variable do_grids=defaultValue, string graphname=defaultValue) |
display a plot of a hemispherical angle scan. More... | |
display a plot of a hemispherical angle scan. More... | |
static string | display_polar_graph (string graphname, variable angle_offset=defaultValue, variable do_ticks=defaultValue) |
displays an empty polar graph More... | |
displays an empty polar graph More... | |
static string | draw_hemi_axes (string graphname, variable do_grids=defaultValue) |
draw polar and azimuthal grids in an existing polar graph. More... | |
draw polar and azimuthal grids in an existing polar graph. More... | |
variable | draw_diffraction_cone (string graphname, string groupname, variable theta_axis, variable theta_inner, variable phi) |
draw the circle of a diffraction cone in a stereographic polar graph. More... | |
draw the circle of a diffraction cone in a stereographic polar graph. More... | |
string | display_scanlines (string nickname, variable alpha_lo, variable alpha_hi, wave m_theta, wave m_tilt, wave m_phi, variable folding=defaultValue, variable projection=defaultValue) |
display a polar graph with lines indicating the angles covered by an angle scan. More... | |
display a polar graph with lines indicating the angles covered by an angle scan. More... | |
threadsafe variable | calc_graph_radius (variable polar, variable projection=defaultValue) |
calculate the projected polar angle More... | |
calculate the projected polar angle More... | |
threadsafe variable | calc_graph_polar (variable x, variable y, variable projection=defaultValue) |
calculate polar angle from Cartesian coordinate More... | |
calculate polar angle from Cartesian coordinate More... | |
threadsafe variable | calc_graph_azi (variable x, variable y, variable projection=defaultValue, variable zeroAngle=defaultValue) |
calculate azimuthal angle from Cartesian coordinate More... | |
calculate azimuthal angle from Cartesian coordinate More... | |
static variable | update_polar_info (string graphname) |
update the angles info based on cursors A and B of a given polar graph window More... | |
update the angles info based on cursors A and B of a given polar graph window More... | |
static variable | polar_graph_hook (WMWinHookStruct *s) |
polar graph window hook More... | |
polar graph window hook More... | |
variable | set_polar_graph_cursor (string nickname, string cursorname, variable polar_angle, variable azim_angle, string graphname=defaultValue) |
variable | hemi_add_anglescan (string nickname, wave values, wave polar, wave azi, wave weights=defaultValue) |
add an arbitrary angle scan to a hemispherical scan grid. More... | |
add arbitrary angle scan data to a hemispherical scan grid. More... | |
static threadsafe dfr | add_anglescan_worker (variable ith, wave values, wave weights, wave polar, wave azi, wave w_polar, wave w_azim, wave w_theta, wave w_index, wave w_dphi, wave w_nphis) |
thread worker for hemi_add_anglescan More... | |
static threadsafe variable | add_aziscan_core (wave values, wave weights, variable polar, wave azi, wave w_theta, wave w_azim, wave w_index, wave w_dphi, wave w_totals, wave w_weights) |
thread worker for hemi_add_anglescan and hemi_add_aziscan More... | |
variable | hemi_add_aziscan (string nickname, wave values, variable polar, wave azi, wave weights=defaultValue) |
add an azimuthal scan to a hemispherical scan grid. More... | |
add azimuthal data to a hemispherical scan grid. More... | |
variable | interpolate_hemi_scan (string nickname, variable projection=defaultValue) |
interpolate a hemispherical scan onto a rectangular grid More... | |
interpolate a hemispherical scan onto a rectangular grid More... | |
variable | quick_pizza_image (wave data, string nickname, variable theta_offset, variable tilt_offset, variable phi_offset, variable npolar=defaultValue, variable nograph=defaultValue, variable folding=defaultValue) |
map angle scan data onto a rectangular grid in stereographic projection More... | |
map angle scan data onto a rectangular grid in stereographic projection More... | |
variable | save_hemi_scan (string nickname, string pathname, string filename) |
save a hemispherical scan to an Igor text file More... | |
save a hemispherical scan to an Igor text file More... | |
variable | load_hemi_scan (string nickname, string pathname, string filename) |
load a hemispherical scan from an Igor text file More... | |
load a hemispherical scan from an Igor text file More... | |
variable | import_tpi_scan (string nickname, wave theta, wave phi, wave intensity, variable folding=defaultValue, variable npolar=defaultValue, variable nograph=defaultValue, variable xpdplot=defaultValue) |
import a hemispherical scan from theta-phi-intensity waves and display it More... | |
import a hemispherical scan from theta-phi-intensity waves and display it More... | |
variable | trim_hemi_scan (string nickname, variable theta_max) |
trim a hemispherical scan at grazing angle More... | |
trim a hemispherical scan at grazing angle More... | |
wave | hemi_polar_cut (string nickname, variable azim) |
extract a polar cut from a hemispherical scan. More... | |
extract a polar cut from a hemispherical scan. More... | |
wave | hemi_azi_cut (string nickname, variable pol) |
extract an azimuthal cut from a hemispherical scan More... | |
extract an azimuthal cut from a hemispherical scan More... | |
static variable | check_contrast (wave values, variable pcmin, variable pcmax, variable *vmin, variable *vmax) |
variable | set_contrast (variable pcmin, variable pcmax, string graphname=defaultValue, string colortable=defaultValue) |
set the pseudocolor contrast by percentile. More... | |
static variable | check_contrast (wave values, variable pcmin, variable pcmax, variable *vmin, variable *vmax, variable sym) |
variable | set_contrast (variable pcmin, variable pcmax, string graphname=defaultValue, string colortable=defaultValue, variable reversecolors=defaultValue, variable symmetric=defaultValue) |
set the pseudocolor contrast by percentile. More... | |
variable | AngleToK (wave inwave) |
k-space mapping of 2D angle-energy distribution (scienta image) More... | |
k-space mapping of 2D angle-energy distribution (scienta image) More... | |
@@ -293,14 +304,201 @@ data imported with version 1.5 and earlier, must be offset by 180 deg in phi to
* phi_sample = 270 if tilt_manipulator - tilt_offset > 0
* phi_sample = 90 if tilt_manipulator - tilt_offset < 0
*
-- Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. +
Definition in file pearl-anglescan-process.ipf. Function Documentation+ +◆ add_anglescan_worker()+ +
+
+
+
+
+
+
+thread worker for hemi_add_anglescan +this function extracts one azimuthal scan from the input data and adds it to an existing holo scan. it should be considered as a part of hemi_add_anglescan and not used elsewhere, as its interface may change in the future. +the function takes as input the entire input data, an existing hemi grid and the index of a polar angle to work on. the results are a w_totals and w_weights wave that can be added to the hemi scan. the two waves are returned in a free data folder referenced by the return value of the function. the function does not change global data. + +Definition at line 2711 of file pearl-anglescan-process.ipf. + +◆ add_aziscan_core()+ +
+
+
+
+
+thread worker for hemi_add_anglescan and hemi_add_aziscan +this function adds one azimuthal scan to an existing holo scan. it should be considered as a part of hemi_add_anglescan and hemi_add_aziscan and not used elsewhere, as its interface may change in the future. +the function takes as input an azimuthal scan and an existing hemi grid. the results are added to w_totals and w_weights waves. +
Definition at line 2761 of file pearl-anglescan-process.ipf. + +◆ AngleToK()@@ -327,7 +525,7 @@ data imported with version 1.5 and earlier, must be offset by 180 deg in phi toDefinition at line 3332 of file pearl-anglescan-process.ipf. +Definition at line 3562 of file pearl-anglescan-process.ipf. @@ -392,7 +590,7 @@ data imported with version 1.5 and earlier, must be offset by 180 deg in phi to
Definition at line 2393 of file pearl-anglescan-process.ipf. +Definition at line 2467 of file pearl-anglescan-process.ipf. @@ -429,7 +627,7 @@ data imported with version 1.5 and earlier, must be offset by 180 deg in phi tocalculate polar angle from Cartesian coordinate -this is the reverse mapping to calc_graph_radius() +this is the reverse mapping to calc_graph_radius()
-
@@ -808,7 +1012,7 @@ data imported with version 1.5 and earlier, must be offset by 180 deg in phi to
-Definition at line 3212 of file pearl-anglescan-process.ipf. +Definition at line 3407 of file pearl-anglescan-process.ipf. Definition at line 1532 of file pearl-anglescan-process.ipf. +Definition at line 1606 of file pearl-anglescan-process.ipf. @@ -877,7 +1081,7 @@ data imported with version 1.5 and earlier, must be offset by 180 deg in phi tofor the output parameters polar and azi, you need to pass in existing numeric waves. dimension size does not matter, the waves are redimensioned by the function so that they have the same dimensions as the intensity data set. X dimension = analyser scale, Y dimension = manipulator scan. -Definition at line 1088 of file pearl-anglescan-process.ipf. +Definition at line 1162 of file pearl-anglescan-process.ipf. @@ -932,9 +1136,9 @@ data imported with version 1.5 and earlier, must be offset by 180 deg in phi toconvert angles from TTPA (theta-tilt-phi-analyser) scheme to polar coordinates. -similar to convert_angles_ttpa2polar() but reads the analyser angles from the X scale of data +similar to convert_angles_ttpa2polar() but reads the analyser angles from the X scale of data -Definition at line 1049 of file pearl-anglescan-process.ipf. +Definition at line 1123 of file pearl-anglescan-process.ipf.
Definition at line 673 of file pearl-anglescan-process.ipf. +Definition at line 747 of file pearl-anglescan-process.ipf. @@ -1050,7 +1254,7 @@ data imported with version 1.5 and earlier, must be offset by 180 deg in phi to -Definition at line 705 of file pearl-anglescan-process.ipf. +Definition at line 779 of file pearl-anglescan-process.ipf. @@ -1120,7 +1324,7 @@ data imported with version 1.5 and earlier, must be offset by 180 deg in phi to | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
graphtype | type of graph
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
do_ticks | select which ticks to draw. value must be the arithmetic OR of all selected items. default: 3
Definition at line 1784 of file pearl-anglescan-process.ipf. +Definition at line 1858 of file pearl-anglescan-process.ipf. @@ -1211,7 +1415,7 @@ data imported with version 1.5 and earlier, must be offset by 180 deg in phi toDefinition at line 1929 of file pearl-anglescan-process.ipf. +Definition at line 2003 of file pearl-anglescan-process.ipf. @@ -1287,13 +1491,13 @@ data imported with version 1.5 and earlier, must be offset by 180 deg in phi tom_tilt | manipulator tilt angles, 0 = normal emission. size = dimsize(data, 1) | m_phi | manipulator phi angles, 0 = azimuthal origin. size = dimsize(data, 1) | folding | rotational averaging, default = 1 | projection | mapping function from polar to cartesian coordinates. see calc_graph_radius(). | projection | mapping function from polar to cartesian coordinates. see calc_graph_radius(). | |
Definition at line 2180 of file pearl-anglescan-process.ipf.
+Definition at line 2254 of file pearl-anglescan-process.ipf.
Definition at line 2116 of file pearl-anglescan-process.ipf.
+Definition at line 2190 of file pearl-anglescan-process.ipf.
the objects are added to the ProgFront drawing layer and will appear in front of the data trace. in interactive drawing mode, you can select the active drawing layer by clicking the tree icon while holding the Alt key.
-the graph must have been created by display_polar_graph(). the function reads the projection mode from the window user data "projection".
+the graph must have been created by display_polar_graph(). the function reads the projection mode from the window user data "projection".
graphname | name of graph window. |
add an arbitrary angle scan to a hemispherical scan grid.
-the hemi grid must have been created in the current data folder by the make_hemi_grid function. the function determines the bin size at the given polar angle, and adds all data points which fall into a bin. a point which lies exactly on the upper boundary falls into the next bin. this function does not clear previous values before adding new data. values are added to the _tot wave, weights to the _wt wave. the intensity (_i) wave is calculated as _tot / _wt.
+add arbitrary angle scan data to a hemispherical scan grid.
+the function fills the input data into bins defined by the hemi scan grid. it sums up the values and weights of the data points which fall into each bin, and adds the results to the totals and weights waves of the existing hemi grid. finally, it updates the values wave (values divided by weights).
+the hemi grid must have been created in the current data folder by the make_hemi_grid() function. the function does not clear previous values before adding new data. values are added to the _tot wave, weights to the _wt wave. the intensity (_i/values) wave is calculated as _tot divided by _wt.
+nickname | name prefix of holo waves. empty if waves are in current data folder. |
values | counts/intensity values at the positions given in the polara nd azi waves. one- or two-dimensional. NaN values are ignored. |
polar | polar angles (in degrees) of each data point. allowed range 0 <= theta <= 90. no specific ordering required. |
azi | azimuthal angles (in degrees) of each data point. allowed range -360 <= phi < +360. no specific order required. |
weights | weight or accumulation time of each point of values. weights must be positive. values with weight 0 are ignored. defaults to 1 if not specified. |
the values, weights, polar and azi waves must have the same dimensions (one- or two-dimensional). no specific order is required, the function sorts (copies of) the arrays internally.
+the actual binning is delegated to the thread-safe add_anglescan_worker() function under Igor's automatic multi-threading facility.
-Definition at line 2538 of file pearl-anglescan-process.ipf.
+Definition at line 2637 of file pearl-anglescan-process.ipf.
add an azimuthal scan to a hemispherical scan grid.
-the hemi grid must have been created in the current data folder by the make_hemi_grid function. the function determines the bin size at the given polar angle, and calculates the mean values of the data points which fall into a bin. a point which lies exactly on the upper boundary falls into the next bin.
+add azimuthal data to a hemispherical scan grid.
+the hemi grid must have been created in the current data folder by the make_hemi_grid() function. the function determines the bin size at the given polar angle, sums up the values and weights of the data points which fall into each bin, and adds the results to the totals and weights waves of the existing hemi grid. finally, it updates the values wave (values divided by weights).
+nickname | name prefix of holo waves. empty if waves are in current data folder. |
values | counts/intensity values of the azimuthal scan at the positions given in the azi parameter. |
polar | polar angle (in degrees) where to add the azi scan. |
azi | angle positions of the azimuthal scan. acceptable range: >= -360 and < +360. no specific order required, the function sorts the array internally. |
weights | weight or accumulation time of each point of values. defaults to 1 if not specified. |
the actual binning is delegated to the thread-safe add_aziscan_core() function shared with hemi_add_anglescan().
-Definition at line 2608 of file pearl-anglescan-process.ipf.
+Definition at line 2844 of file pearl-anglescan-process.ipf.
Definition at line 3159 of file pearl-anglescan-process.ipf.
+Definition at line 3354 of file pearl-anglescan-process.ipf.
@@ -1760,7 +1988,7 @@ data imported with version 1.5 and earlier, must be offset by 180 deg in phi toDefinition at line 3073 of file pearl-anglescan-process.ipf.
+Definition at line 3268 of file pearl-anglescan-process.ipf.
@@ -1854,7 +2082,7 @@ data imported with version 1.5 and earlier, must be offset by 180 deg in phi to -Definition at line 2985 of file pearl-anglescan-process.ipf.
+Definition at line 3179 of file pearl-anglescan-process.ipf.
@@ -1888,7 +2116,7 @@ data imported with version 1.5 and earlier, must be offset by 180 deg in phi tothe scan data must exist in the current data folder or in the sub-folder given by the nickname parameter.
the interpolated data is written to a new two-dimensional wave "matrix". the wave has a fixed size of 181 x 181 points optimized for 1-degree polar steps.
missing values (nan) are interpolated. this works well only if the missing values are reasonable sparse. the function also applies a gaussian filter to smooth the image. empty rings at high polar angles map are preserved.
-to display the result call display_hemi_scan() with graphtype=3.
+to display the result call display_hemi_scan() with graphtype=3.
nickname | name prefix of holo waves. may be empty. |
Definition at line 1131 of file pearl-anglescan-process.ipf.
+Definition at line 1205 of file pearl-anglescan-process.ipf.
load a hemispherical scan from an Igor text file
Definition at line 2936 of file pearl-anglescan-process.ipf.
+Definition at line 3130 of file pearl-anglescan-process.ipf.
@@ -2033,7 +2261,7 @@ data imported with version 1.5 and earlier, must be offset by 180 deg in phi toDefinition at line 1291 of file pearl-anglescan-process.ipf.
+Definition at line 1365 of file pearl-anglescan-process.ipf.
@@ -2106,7 +2334,7 @@ data imported with version 1.5 and earlier, must be offset by 180 deg in phi to -Definition at line 613 of file pearl-anglescan-process.ipf.
+Definition at line 686 of file pearl-anglescan-process.ipf.
@@ -2186,7 +2414,7 @@ data imported with version 1.5 and earlier, must be offset by 180 deg in phi to -Definition at line 283 of file pearl-anglescan-process.ipf.
+Definition at line 348 of file pearl-anglescan-process.ipf.
@@ -2275,7 +2503,7 @@ caution: binomial and boxcar smoothing are not aware of theta. this may give unp -Definition at line 366 of file pearl-anglescan-process.ipf.
+Definition at line 433 of file pearl-anglescan-process.ipf.
@@ -2332,7 +2560,7 @@ caution: binomial and boxcar smoothing are not aware of theta. this may give unpdivide the strip piecewise by a smooth polar distribution.
Definition at line 523 of file pearl-anglescan-process.ipf.
+Definition at line 594 of file pearl-anglescan-process.ipf.
@@ -2426,7 +2654,7 @@ caution: binomial and boxcar smoothing are not aware of theta. this may give unp -Definition at line 464 of file pearl-anglescan-process.ipf.
+Definition at line 533 of file pearl-anglescan-process.ipf.
@@ -2498,7 +2726,7 @@ caution: binomial and boxcar smoothing are not aware of theta. this may give unp -Definition at line 187 of file pearl-anglescan-process.ipf.
+Definition at line 252 of file pearl-anglescan-process.ipf.
@@ -2571,7 +2799,7 @@ caution: binomial and boxcar smoothing are not aware of theta. this may give unpcreate a pizza plot from a measured (energy-integrated) data strip
-accepts angle-scan data as returned by adh5_load_reduced(), maps them onto a hemispherical scan grid, and displays a polar graph.
+accepts angle-scan data as returned by adh5_load_reduced(), maps them onto a hemispherical scan grid, and displays a polar graph.
data | 2D intensity wave, see requirements above
|
Definition at line 769 of file pearl-anglescan-process.ipf.
+Definition at line 843 of file pearl-anglescan-process.ipf.
create a pizza plot from a measured (energy-integrated) data strip
-accepts angle-scan data as returned by adh5_load_reduced(), maps them onto a hemispherical scan grid, and displays a polar graph.
-the behaviour of this function is the same as pizza_service() except that the manipulator waves are specified explicitly.
+accepts angle-scan data as returned by adh5_load_reduced(), maps them onto a hemispherical scan grid, and displays a polar graph.
+the behaviour of this function is the same as pizza_service() except that the manipulator waves are specified explicitly.
data | 2D intensity wave, see requirements above
Definition at line 862 of file pearl-anglescan-process.ipf. +Definition at line 936 of file pearl-anglescan-process.ipf. @@ -2741,7 +2969,7 @@ caution: binomial and boxcar smoothing are not aware of theta. this may give unppolar graph window hook this hook converts the cursor positions to polar coordinates and displays them in a text box on the graph. the text box is visible while the cursor info box is visible. -Definition at line 2473 of file pearl-anglescan-process.ipf. +Definition at line 2547 of file pearl-anglescan-process.ipf. @@ -2788,7 +3016,7 @@ caution: binomial and boxcar smoothing are not aware of theta. this may give unp -Definition at line 1702 of file pearl-anglescan-process.ipf. +Definition at line 1776 of file pearl-anglescan-process.ipf. @@ -2865,7 +3093,7 @@ caution: binomial and boxcar smoothing are not aware of theta. this may give unpDefinition at line 2792 of file pearl-anglescan-process.ipf. +Definition at line 2986 of file pearl-anglescan-process.ipf. @@ -2896,7 +3124,7 @@ caution: binomial and boxcar smoothing are not aware of theta. this may give unpazimuthally rotate a hemispherical scan dataset. -this function works only for hemi scans created by make_hemi_grid() (or compatible functions). +this function works only for hemi scans created by make_hemi_grid() (or compatible functions). Definition at line 3247 of file pearl-anglescan-process.ipf. +Definition at line 3463 of file pearl-anglescan-process.ipf. |
Definition at line 2493 of file pearl-anglescan-process.ipf.
+Definition at line 2567 of file pearl-anglescan-process.ipf.
Definition at line 979 of file pearl-anglescan-process.ipf.
+Definition at line 1053 of file pearl-anglescan-process.ipf.
+ + + + +string strip_append | +( | +wave | +strip1, | +
+ | + | wave | +strip2 | +
+ | ) | ++ |
append an angle scan strip to another one
+concatenate two angle scan strips including matching attribute waves and replace the first strip with the resulting waves. this is useful if a scan was interrupted and continues in a second data file.
+all accompanying 1D waves which have a matching length and exist in both source and destination folders are concatenated and stored in the destination. 'accompanying waves' are those in the same folder as the 2D strip wave and those in the :attr sub-folder.
+[in,out] | strip1 | 2D data, X-axis = analyser angle, Y-axis = arbitrary manipulator scan. this is the first source wave and destination wave. |
[in] | strip2 | 2D data, X-axis = analyser angle, Y-axis = arbitrary manipulator scan. this is the second source wave. |
Definition at line 106 of file pearl-anglescan-process.ipf.
Definition at line 105 of file pearl-anglescan-process.ipf.
+Definition at line 170 of file pearl-anglescan-process.ipf.
@@ -3253,7 +3546,7 @@ caution: binomial and boxcar smoothing are not aware of theta. this may give unp -Definition at line 3034 of file pearl-anglescan-process.ipf.
+Definition at line 3229 of file pearl-anglescan-process.ipf.
@@ -3291,7 +3584,7 @@ caution: binomial and boxcar smoothing are not aware of theta. this may give unp -Definition at line 2438 of file pearl-anglescan-process.ipf.
+Definition at line 2512 of file pearl-anglescan-process.ipf.
@@ -3308,7 +3601,7 @@ caution: binomial and boxcar smoothing are not aware of theta. this may give unpDefinition at line 2270 of file pearl-anglescan-process.ipf.
+Definition at line 2344 of file pearl-anglescan-process.ipf.
Definition at line 2268 of file pearl-anglescan-process.ipf.
+Definition at line 2342 of file pearl-anglescan-process.ipf.
Definition at line 2271 of file pearl-anglescan-process.ipf.
+Definition at line 2345 of file pearl-anglescan-process.ipf.
Definition at line 2272 of file pearl-anglescan-process.ipf.
+Definition at line 2346 of file pearl-anglescan-process.ipf.
Definition at line 2276 of file pearl-anglescan-process.ipf.
+Definition at line 2350 of file pearl-anglescan-process.ipf.
Definition at line 2274 of file pearl-anglescan-process.ipf.
+Definition at line 2348 of file pearl-anglescan-process.ipf.
Definition at line 2278 of file pearl-anglescan-process.ipf.
+Definition at line 2352 of file pearl-anglescan-process.ipf.
Definition at line 2279 of file pearl-anglescan-process.ipf.
+Definition at line 2353 of file pearl-anglescan-process.ipf.
Definition at line 2275 of file pearl-anglescan-process.ipf.
+Definition at line 2349 of file pearl-anglescan-process.ipf.
Definition at line 2269 of file pearl-anglescan-process.ipf.
+Definition at line 2343 of file pearl-anglescan-process.ipf.
the manipulator angles are corrected by the preset offsets internally.
-Definition at line 453 of file pearl-anglescan-tracker.ipf.
+Definition at line 454 of file pearl-anglescan-tracker.ipf.
@@ -308,7 +310,7 @@ Variablesinitialize package data once when the procedure is first loaded
-Definition at line 73 of file pearl-anglescan-tracker.ipf.
+Definition at line 74 of file pearl-anglescan-tracker.ipf.
the manipulator angles are corrected by the preset offsets internally.
-Definition at line 285 of file pearl-anglescan-tracker.ipf.
+Definition at line 286 of file pearl-anglescan-tracker.ipf.
callback function for new analyser data from EPICS.
-Definition at line 856 of file pearl-anglescan-tracker.ipf.
+Definition at line 857 of file pearl-anglescan-tracker.ipf.
callback function for new detector state from EPICS.
-save the manipulator position at the beginning of image acquisition. it is used by ast_callback_data().
+save the manipulator position at the beginning of image acquisition. it is used by ast_callback_data().
-Definition at line 961 of file pearl-anglescan-tracker.ipf.
+Definition at line 962 of file pearl-anglescan-tracker.ipf.
callback function for new manipulator position from EPICS.
-Definition at line 990 of file pearl-anglescan-tracker.ipf.
+Definition at line 991 of file pearl-anglescan-tracker.ipf.
stop tracker, close graph, release data structures.
-Definition at line 360 of file pearl-anglescan-tracker.ipf.
+Definition at line 361 of file pearl-anglescan-tracker.ipf.
folder | destination folder path | ||
nickname | name prefix for waves | ||
xpdplot | xpdplot compatibility, see make_hemi_grid() for details
xpdplot | xpdplot compatibility, see make_hemi_grid() for details | Definition at line 307 of file pearl-anglescan-tracker.ipf. +Definition at line 308 of file pearl-anglescan-tracker.ipf. @@ -529,7 +531,7 @@ Variables |
reduction_func | name of custom reduction function, e.g. "int_linbg_reduction". any user-defined function with the same signature as adh5_default_reduction() is allowed. |
reduction_func | name of custom reduction function, e.g. "int_linbg_reduction". any user-defined function with the same signature as adh5_default_reduction() is allowed. |
reduction_params | parameter string for the reduction function. the format depends on the actual function. for int_linbg_reduction, e.g., "Lcrop=0.1;Hcrop=0.1;Lsize=0.2;Hsize=0.2;Cpos=0.5;Csize=0.4". |
Definition at line 261 of file pearl-anglescan-tracker.ipf.
+Definition at line 262 of file pearl-anglescan-tracker.ipf.
@@ -637,7 +639,7 @@ Variablesset up data structures, display graph, and try to connect to analyser.
-Definition at line 194 of file pearl-anglescan-tracker.ipf.
+Definition at line 195 of file pearl-anglescan-tracker.ipf.
@@ -691,7 +693,7 @@ Variablesthe manipulator angles are corrected by the preset offsets internally.
-Definition at line 349 of file pearl-anglescan-tracker.ipf.
+Definition at line 350 of file pearl-anglescan-tracker.ipf.
@@ -722,7 +724,7 @@ Variableswindow hook
disconnects from EPICS when the window is closed.
-Definition at line 841 of file pearl-anglescan-tracker.ipf.
+Definition at line 842 of file pearl-anglescan-tracker.ipf.
@@ -750,7 +752,7 @@ VariablesDefinition at line 1023 of file pearl-anglescan-tracker.ipf.
+Definition at line 1024 of file pearl-anglescan-tracker.ipf.
Definition at line 1244 of file pearl-anglescan-tracker.ipf.
+Definition at line 1245 of file pearl-anglescan-tracker.ipf.
Definition at line 1228 of file pearl-anglescan-tracker.ipf.
+Definition at line 1229 of file pearl-anglescan-tracker.ipf.
Definition at line 680 of file pearl-anglescan-tracker.ipf.
+Definition at line 681 of file pearl-anglescan-tracker.ipf.
Definition at line 806 of file pearl-anglescan-tracker.ipf.
+Definition at line 807 of file pearl-anglescan-tracker.ipf.
Definition at line 792 of file pearl-anglescan-tracker.ipf.
+Definition at line 793 of file pearl-anglescan-tracker.ipf.
export tracker data (with prompt)
-Definition at line 1105 of file pearl-anglescan-tracker.ipf.
+Definition at line 1106 of file pearl-anglescan-tracker.ipf.
Definition at line 402 of file pearl-anglescan-tracker.ipf.
+Definition at line 403 of file pearl-anglescan-tracker.ipf.
disconnect EPICS channels before Igor quits.
-Definition at line 188 of file pearl-anglescan-tracker.ipf.
+Definition at line 189 of file pearl-anglescan-tracker.ipf.
import tracker data (with prompt)
-Definition at line 1135 of file pearl-anglescan-tracker.ipf.
+Definition at line 1136 of file pearl-anglescan-tracker.ipf.
Definition at line 98 of file pearl-anglescan-tracker.ipf.
+Definition at line 99 of file pearl-anglescan-tracker.ipf.
the preferences file is an Igor packed experiment file in a special preferences folder.
this function is called automatically when the procedure is first compiled, or whenever the user clicks the corresponding button.
-Definition at line 163 of file pearl-anglescan-tracker.ipf.
+Definition at line 164 of file pearl-anglescan-tracker.ipf.
import tracker data from file (with prompt)
-Definition at line 1175 of file pearl-anglescan-tracker.ipf.
+Definition at line 1176 of file pearl-anglescan-tracker.ipf.
Definition at line 1071 of file pearl-anglescan-tracker.ipf.
+Definition at line 1072 of file pearl-anglescan-tracker.ipf.
Definition at line 1085 of file pearl-anglescan-tracker.ipf.
+Definition at line 1086 of file pearl-anglescan-tracker.ipf.
Definition at line 1194 of file pearl-anglescan-tracker.ipf.
+Definition at line 1195 of file pearl-anglescan-tracker.ipf.
Definition at line 1208 of file pearl-anglescan-tracker.ipf.
+Definition at line 1209 of file pearl-anglescan-tracker.ipf.
process the data buffer to generate the tracker dataset.
-Definition at line 507 of file pearl-anglescan-tracker.ipf.
+Definition at line 508 of file pearl-anglescan-tracker.ipf.
save persistent package data to the preferences file.
this function is called when the user clicks the corresponding button.
-Definition at line 139 of file pearl-anglescan-tracker.ipf.
+Definition at line 140 of file pearl-anglescan-tracker.ipf.
save tracker data to file (with prompt)
-Definition at line 1164 of file pearl-anglescan-tracker.ipf.
+Definition at line 1165 of file pearl-anglescan-tracker.ipf.
Definition at line 372 of file pearl-anglescan-tracker.ipf.
+Definition at line 373 of file pearl-anglescan-tracker.ipf.
Definition at line 434 of file pearl-anglescan-tracker.ipf.
+Definition at line 435 of file pearl-anglescan-tracker.ipf.
create the graph window.
-Definition at line 594 of file pearl-anglescan-tracker.ipf.
+Definition at line 595 of file pearl-anglescan-tracker.ipf.
Definition at line 1037 of file pearl-anglescan-tracker.ipf.
+Definition at line 1038 of file pearl-anglescan-tracker.ipf.
Definition at line 1055 of file pearl-anglescan-tracker.ipf.
+Definition at line 1056 of file pearl-anglescan-tracker.ipf.
Definition at line 645 of file pearl-anglescan-tracker.ipf.
+Definition at line 646 of file pearl-anglescan-tracker.ipf.
the manipulator angles are corrected by the preset offsets internally.
-Definition at line 559 of file pearl-anglescan-tracker.ipf.
+Definition at line 560 of file pearl-anglescan-tracker.ipf.
Definition at line 657 of file pearl-anglescan-tracker.ipf.
+Definition at line 658 of file pearl-anglescan-tracker.ipf.
data folder path
-Definition at line 68 of file pearl-anglescan-tracker.ipf.
+Definition at line 69 of file pearl-anglescan-tracker.ipf.
semicolon-separated list of persistent variable, string, and wave names
-Definition at line 70 of file pearl-anglescan-tracker.ipf.
+Definition at line 71 of file pearl-anglescan-tracker.ipf.
Definition at line 5 of file pearl-anglescan-tracker.ipf.
+Definition at line 6 of file pearl-anglescan-tracker.ipf.
visualization tools for 2D and 3D data. More...
#include "pearl-compat"
#include "pearl-area-profiles"
Go to the source code of this file.
Functions | |
static string | graphname_from_dfref (dfref df, string prefix) |
compose a valid and unique graph name from a data folder reference More... | |
compose a valid and unique graph name from a data folder reference More... | |
string | ad_display (wave image) |
open a new graph window with a 2D image. More... | |
open a new graph window with a 2D image. More... | |
string | ad_display_histogram (wave image) |
display the histogram of a 2D image. More... | |
display the histogram of a 2D image. More... | |
string | ad_display_profiles (wave image, string filter=defaultValue) |
open a new profiles graph window. More... | |
open a new profiles graph window. More... | |
wave | ad_add_overlay (wave image, string rgba=defaultValue) |
add an overlay on top of the displayed image More... | |
add an overlay on top of the displayed image More... | |
variable | ad_update_profiles (wave image) |
update a profiles graph with new data. More... | |
update a profiles graph with new data. More... | |
variable | ad_profiles_cursor_mode (wave image, variable mode) |
switch cursors on a profiles graph More... | |
switch cursors on a profiles graph More... | |
variable | ad_profiles_set_cursor (wave image, string cursorname, variable xa, variable ya, variable pscale=defaultValue) |
move a cursor to the specified position in a profiles graph. More... | |
move a cursor to the specified position in a profiles graph. More... | |
variable | ad_profiles_crosshairs (wave image, variable clear=defaultValue) |
draw permanent crosshairs in a profiles graph. More... | |
draw permanent crosshairs in a profiles graph. More... | |
static wave | get_source_image (wave view) |
find the source image wave corresponding to the given view. More... | |
find the source image wave corresponding to the given view. More... | |
static dfr | make_view_folder (wave source) |
create a view data folder. More... | |
create a view data folder. More... | |
static dfr | get_view_folder (wave source) |
find the view data folder corresponding to the given source. More... | |
find the view data folder corresponding to the given source. More... | |
static wave | get_view_image (wave source) |
find the view image wave corresponding to the given source. More... | |
find the view image wave corresponding to the given source. More... | |
static variable | bp_reset_cursors (WMButtonAction *ba) |
static variable | pmp_export (WMPopupAction *pa) |
variable | ad_profiles_hook (WMWinHookStruct *s) |
hook function for user events in the profiles window. More... | |
hook function for user events in the profiles window. More... | |
variable | ad_calc_cursor_profiles (wave image) |
calculate profiles, statistics, and histogram of a cross-hair delimited region of interest. More... | |
calculate profiles, statistics, and histogram of a cross-hair delimited region of interest. More... | |
variable | ad_calc_profiles (wave image, variable pa, variable qa, variable pb, variable qb) |
calculate profiles, statistics, and histogram of a rectangular region of interest. More... | |
calculate profiles, statistics, and histogram of a rectangular region of interest. More... | |
variable | ad_export_profile (wave view_image, variable dim, variable trace=defaultValue, variable show=defaultValue, variable overwrite=defaultValue) |
export a profile from a profiles graph to the source data folder. More... | |
export a profile from a profiles graph to the source data folder. More... | |
static variable | set_trace_colors (string graphname) |
variable | ad_calc_histogram (wave image) |
calculate the histogram. More... | |
calculate the histogram. More... | |
variable | ad_default_image_filter (wave image, string options) |
abstract filter function for image display. More... | |
abstract filter function for image display. More... | |
variable | ad_box_filter (wave image, string options) |
boxcar smoothing filter. More... | |
boxcar smoothing filter. More... | |
variable | ad_transpose_filter (wave image, string options) |
transpose image filter. More... | |
transpose image filter. More... | |
string | ad_display_brick (wave data) |
open a new "gizmo" window with three-dimensional data. More... | |
open a new "gizmo" window with three-dimensional data. More... | |
variable | ad_brick_slicer (wave data) |
open a slicer panel for 3D data. More... | |
open a slicer panel for 3D data. More... | |
string | ad_display_slice (wave data) |
display three-dimensional data by 2D slice. More... | |
display three-dimensional data by 2D slice. More... | |
static variable | update_slice_info () |
update controls with data scale limits. More... | |
update controls with data scale limits. More... | |
variable | ad_gizmo_set_plane (wave brick, variable dim, variable value) |
set the position of a slicing plane of a 3D brick in a Gizmo window. More... | |
set the position of a slicing plane of a 3D brick in a Gizmo window. More... | |
variable | ad_profiles_set_slice (wave brick, variable dim, variable value) |
set the position of the slicing plane of a 3D brick in a profiles window. More... | |
set the position of the slicing plane of a 3D brick in a profiles window. More... | |
static variable | slp_slice_position (WMSliderAction *sa) |
set slice coordinate (slider procedure). More... | |
set slice coordinate (slider procedure). More... | |
static variable | svp_slice_position (WMSetVariableAction *sva) |
set slice coordinate (button procedure). More... | |
set slice coordinate (button procedure). More... | |
static variable | bp_move_slice (WMButtonAction *ba) |
move slice (button procedure). More... | |
move slice (button procedure). More... | |
static variable | bp_extract_slice (WMButtonAction *ba) |
export a slice (button procedure). More... | |
export a slice (button procedure). More... | |
static variable | bp_move_slice_center (wave brick, variable dim, string posvariable) |
move the slice to the center of the dimension (button procedure). More... | |
move the slice to the center of the dimension (button procedure). More... | |
static variable | ad_slicer_move_bg (WMBackgroundStruct *s) |
move a slice by one step (background task). More... | |
move a slice by one step (background task). More... | |
variable | ad_slicer_init_bg () |
initialize the slice animation background task. More... | |
initialize the slice animation background task. More... | |
variable | ad_slicer_start_bg (wave brick, variable dimension, string posvariable, variable delta) |
start the animation. More... | |
start the animation. More... | |
variable | ad_slicer_stop_bg (string posvariable) |
stop the animation. More... | |
stop the animation. More... | |
Definition at line 329 of file pearl-area-display.ipf.
+Definition at line 331 of file pearl-area-display.ipf.
@@ -311,7 +314,7 @@ Functions -Definition at line 1103 of file pearl-area-display.ipf.
+Definition at line 1105 of file pearl-area-display.ipf.
@@ -340,7 +343,7 @@ Functions -Definition at line 1256 of file pearl-area-display.ipf.
+Definition at line 1258 of file pearl-area-display.ipf.
@@ -367,9 +370,9 @@ Functions -the function expects further objects as created by ad_display_profiles() in the same data folder as the image wave. the most recent profiles graph of the image must exist, and the cursors A and B must be set on the image.
+the function expects further objects as created by ad_display_profiles() in the same data folder as the image wave. the most recent profiles graph of the image must exist, and the cursors A and B must be set on the image.
-Definition at line 785 of file pearl-area-display.ipf.
+Definition at line 787 of file pearl-area-display.ipf.
@@ -392,12 +395,12 @@ Functionscalculate the histogram.
image | wave which contains the image data from the detector. the function expects further objects as created by ad_display_histogram() in the same data folder as the image wave. |
image | wave which contains the image data from the detector. the function expects further objects as created by ad_display_histogram() in the same data folder as the image wave. |
Definition at line 1066 of file pearl-area-display.ipf.
+Definition at line 1068 of file pearl-area-display.ipf.
@@ -457,10 +460,10 @@ Functions -the function expects further objects as created by ad_display_profiles() in the same data folder as the image wave.
+the function expects further objects as created by ad_display_profiles() in the same data folder as the image wave.
this function does not require that the graph exists as long as the data folder is complete.
-Definition at line 832 of file pearl-area-display.ipf.
+Definition at line 834 of file pearl-area-display.ipf.
@@ -501,7 +504,7 @@ FunctionsDefinition at line 1089 of file pearl-area-display.ipf.
+Definition at line 1091 of file pearl-area-display.ipf.
@@ -531,7 +534,7 @@ FunctionsDefinition at line 85 of file pearl-area-display.ipf.
+Definition at line 87 of file pearl-area-display.ipf.
@@ -560,7 +563,7 @@ FunctionsDefinition at line 1141 of file pearl-area-display.ipf.
+Definition at line 1143 of file pearl-area-display.ipf.
@@ -581,7 +584,7 @@ Functionsdisplay the histogram of a 2D image.
-the function will create additional objects in the same data folder as the image. this objects are displayed in the graph and are updated by calling ad_calc_profiles(). see the code.
+the function will create additional objects in the same data folder as the image. this objects are displayed in the graph and are updated by calling ad_calc_profiles(). see the code.
image | wave which contains the image data from the detector. |
image | wave which contains the image data. |
filter | name of a filter function which maps the original data to the displayed data. the function must have the same parameters as ad_default_image_filter(). default: boxcar average (ad_box_filter()) using parameters view_filter_smoothing_x and _y. |
filter | name of a filter function which maps the original data to the displayed data. the function must have the same parameters as ad_default_image_filter(). default: boxcar average (ad_box_filter()) using parameters view_filter_smoothing_x and _y. |
Definition at line 166 of file pearl-area-display.ipf.
+Definition at line 168 of file pearl-area-display.ipf.
display three-dimensional data by 2D slice.
-to select the slice data to display, call ad_profiles_set_slice(), or open a ad_brick_slicer() panel. do not modify the content of the created view_ data folder.
+to select the slice data to display, call ad_profiles_set_slice(), or open a ad_brick_slicer() panel. do not modify the content of the created view_ data folder.
data | three-dimensional wave. |
view_image | wave which contains the view image (image wave on display in profiles window). the function expects further objects as created by ad_display_profiles() in the same data folder as the view_image wave. |
view_image | wave which contains the view image (image wave on display in profiles window). the function expects further objects as created by ad_display_profiles() in the same data folder as the view_image wave. |
dim | dimension index (0 = x, 1 = y). |
trace | select profile trace:
|
image | wave which contains the image data. must be the same (by data folder and name) wave used with ad_display_profiles(). |
image | wave which contains the image data. must be the same (by data folder and name) wave used with ad_display_profiles(). |
Definition at line 375 of file pearl-area-display.ipf.
+Definition at line 377 of file pearl-area-display.ipf.
@@ -1233,7 +1236,7 @@ Functionsexport a slice (button procedure).
extract a slice and saves it in a separate wave.
-Definition at line 1671 of file pearl-area-display.ipf.
+Definition at line 1673 of file pearl-area-display.ipf.
@@ -1263,7 +1266,7 @@ Functionsmove slice (button procedure).
-Definition at line 1622 of file pearl-area-display.ipf.
+Definition at line 1624 of file pearl-area-display.ipf.
@@ -1309,7 +1312,7 @@ Functionsmove the slice to the center of the dimension (button procedure).
-Definition at line 1725 of file pearl-area-display.ipf.
+Definition at line 1727 of file pearl-area-display.ipf.
@@ -1337,7 +1340,7 @@ FunctionsDefinition at line 677 of file pearl-area-display.ipf.
+Definition at line 679 of file pearl-area-display.ipf.
find the source image wave corresponding to the given view.
Definition at line 606 of file pearl-area-display.ipf.
+Definition at line 608 of file pearl-area-display.ipf.
@@ -1400,12 +1403,12 @@ Functionsthe result data folder reference may be invalid if no view is currently open. use the built-in DataFolderRefStatus function to check for validity.
source | wave which contains the image data. must be the same (by data folder and name) wave used with ad_display_profiles(). |
source | wave which contains the image data. must be the same (by data folder and name) wave used with ad_display_profiles(). |
Definition at line 644 of file pearl-area-display.ipf.
+Definition at line 646 of file pearl-area-display.ipf.
@@ -1436,12 +1439,12 @@ Functionsfind the view image wave corresponding to the given source.
source | wave which contains the image data. must be the same (by data folder and name) wave used with ad_display_profiles(). |
source | wave which contains the image data. must be the same (by data folder and name) wave used with ad_display_profiles(). |
Definition at line 667 of file pearl-area-display.ipf.
+Definition at line 669 of file pearl-area-display.ipf.
@@ -1481,7 +1484,7 @@ Functionscompose a valid and unique graph name from a data folder reference
-Definition at line 57 of file pearl-area-display.ipf.
+Definition at line 59 of file pearl-area-display.ipf.
@@ -1511,7 +1514,7 @@ Functionscreate a view data folder.
-Definition at line 620 of file pearl-area-display.ipf.
+Definition at line 622 of file pearl-area-display.ipf.
@@ -1539,7 +1542,7 @@ FunctionsDefinition at line 721 of file pearl-area-display.ipf.
+Definition at line 723 of file pearl-area-display.ipf.
Definition at line 1045 of file pearl-area-display.ipf.
+Definition at line 1047 of file pearl-area-display.ipf.
set slice coordinate (slider procedure).
-Definition at line 1558 of file pearl-area-display.ipf.
+Definition at line 1560 of file pearl-area-display.ipf.
@@ -1627,7 +1630,7 @@ Functionsset slice coordinate (button procedure).
-Definition at line 1590 of file pearl-area-display.ipf.
+Definition at line 1592 of file pearl-area-display.ipf.
@@ -1655,7 +1658,7 @@ FunctionsDefinition at line 696 of file pearl-area-display.ipf.
+Definition at line 698 of file pearl-area-display.ipf.
update controls with data scale limits.
current folder must be slicer info
-Definition at line 1445 of file pearl-area-display.ipf.
+Definition at line 1447 of file pearl-area-display.ipf.
@@ -1695,9 +1698,9 @@ Functions diff --git a/doc/html/pearl-area-display_8ipf_source.html b/doc/html/pearl-area-display_8ipf_source.html index 692424d..92bf0d6 100644 --- a/doc/html/pearl-area-display_8ipf_source.html +++ b/doc/html/pearl-area-display_8ipf_source.html @@ -1,9 +1,9 @@ - + - +HDF5 file import from EPICS area detectors such as CCD cameras, 2D electron analysers
as of Igor 6.3, Igor can open datasets of up to rank 4. i.e. the extra dimension Y of the file plugin cannot be used. the extra dimensions N and X are supported.
-Definition in file pearl-area-import.ipf.
@@ -221,7 +223,7 @@ Licensed under the Apache License, Version 2.0 (the "License");Definition at line 167 of file pearl-area-import.ipf.
+Definition at line 171 of file pearl-area-import.ipf.
@@ -276,7 +278,7 @@ Licensed under the Apache License, Version 2.0 (the "License");Definition at line 106 of file pearl-area-import.ipf.
+Definition at line 110 of file pearl-area-import.ipf.
@@ -309,7 +311,7 @@ Licensed under the Apache License, Version 2.0 (the "License");function prototype for adh5_load_reduced_detector
this is a prototype of custom functions that convert (reduce) a two-dimensional detector image into one or more one-dimensional waves. data processing can be tuned with a set of parameters.
reduction functions have a fixed signature (function arguments) so that the file import functions can call them efficiently on a series of detector images. pearl procedures comes with a number of pre-defined reduction functions but you may as well implement your own functions. if you write your own function, you must use the same declaration and arguments as this function except for the function name. you can do many things in a reduction function, e.g. integration over a region of interest, curve fitting, etc.
-each destination wave is a one-dimensional intensity distribution. the function must redimension each of these waves to one of the image dimensions by calling the adh5_setup_profile() function. this function will also copy the scale information and dimension labels, which is important for the proper scaling of the result.
+each destination wave is a one-dimensional intensity distribution. the function must redimension each of these waves to one of the image dimensions by calling the adh5_setup_profile() function. this function will also copy the scale information and dimension labels, which is important for the proper scaling of the result.
the meaning of the data in the result waves is up to the particular function, e.g. dest1 could hold the mean value and dest2 the one-sigma error, or dest1 could hold the X-profile, and dest2 the Y-profile.
ANickName | destination folder name (top level under root) |
APathName | igor symbolic path name. can be empty if the path is specified in FileName or a dialog box should be displayed |
AFileName | if empty a dialog box shows up |
reduction_func | custom reduction function (any user-defined function which has the same parameters as adh5_default_reduction()) |
reduction_func | custom reduction function (any user-defined function which has the same parameters as adh5_default_reduction()) |
reduction_param | parameter string for the reduction function |
load_data | 1 (default): load data; 0: do not load data |
load_attr | 1 (default): load attributes; 0: do not load attributes for proper wave scaling, the attributes must be loaded |
fileID | ID of open HDF5 file from HDF5OpenFile |
detectorpath | path to detector group in the HDF5 file |
reduction_func | custom reduction function (any user-defined function which has the same parameters as adh5_default_reduction()) |
reduction_func | custom reduction function (any user-defined function which has the same parameters as adh5_default_reduction()) |
reduction_param | parameter string for the reduction function |
progress | 1 (default): show progress window; 0: do not show progress window |
nthreads | -1 (default): use as many threads as there are processor cores (in addition to main thread) 0: use main thread only (e.g. for debugging the reduction function) >= 1: use a fixed number of (additional) threads |
source | source wave. three-dimensional intensity distribution (image). the scales are carried over to the result waves. |
reduction_func | name of the reduction function to apply to the source data. |
reduction_param | string with reduction parameters as required by the specific reduction function. |
result_prefix | name prefix of result waves. a numeric index is appended to distinguish the results. the index starts at 1. existing waves are overwritten. |
result_prefix | name prefix of result waves. a numeric index is appended to distinguish the results. the index starts at 1. existing waves are overwritten. |
Definition at line 1198 of file pearl-area-import.ipf.
+Definition at line 1203 of file pearl-area-import.ipf.
@@ -1031,7 +1034,7 @@ Licensed under the Apache License, Version 2.0 (the "License");set the dimension scales of an area detector dataset.
the intrinsic dimensions 0 and 1 are scaled according to the data source (currently supported: Prosilica cameras, Scienta electron analyser). the extra dimensions are scaled according to the scan. the latter requires that the positioner names and position values are available.
-Definition at line 726 of file pearl-area-import.ipf.
+Definition at line 730 of file pearl-area-import.ipf.
@@ -1055,7 +1058,7 @@ Licensed under the Apache License, Version 2.0 (the "License");the scan positioner name and its values must be available
Definition at line 2030 of file pearl-area-import.ipf.
+Definition at line 2063 of file pearl-area-import.ipf.
@@ -1078,7 +1081,7 @@ Licensed under the Apache License, Version 2.0 (the "License");set the energy and angle scales of an area detector dataset from the Scienta analyser.
the dimension labels of the energy and angle scales must be set correctly: AD_Dim0 = energy dimension; AD_Dim1 = angle dimension. these dimensions must be the first two dimensions of a multi-dimensional dataset. normally, AD_Dim0 is the X dimension, and AD_Dim1 the Y dimension.
-Definition at line 1925 of file pearl-area-import.ipf.
+Definition at line 1958 of file pearl-area-import.ipf.
@@ -1117,7 +1120,7 @@ Licensed under the Apache License, Version 2.0 (the "License");set up a one-dimensional wave for a line profile based on a 2D original wave.
redimensions the profile wave to the given dimension. copies the scale and dimension label of the given dimension.
-Definition at line 1134 of file pearl-area-import.ipf.
+Definition at line 1138 of file pearl-area-import.ipf.
@@ -1172,7 +1175,7 @@ Licensed under the Apache License, Version 2.0 (the "License");Definition at line 1167 of file pearl-area-import.ipf.
+Definition at line 1171 of file pearl-area-import.ipf.
@@ -1236,7 +1239,7 @@ Licensed under the Apache License, Version 2.0 (the "License");callback function for drag&drop of HDF5 files into Igor.
-Definition at line 42 of file pearl-area-import.ipf.
+Definition at line 46 of file pearl-area-import.ipf.
@@ -1274,7 +1277,7 @@ Licensed under the Apache License, Version 2.0 (the "License");Definition at line 707 of file pearl-area-import.ipf.
+Definition at line 711 of file pearl-area-import.ipf.
@@ -1329,7 +1332,7 @@ Licensed under the Apache License, Version 2.0 (the "License");Definition at line 1872 of file pearl-area-import.ipf.
+Definition at line 1905 of file pearl-area-import.ipf.
@@ -1360,7 +1363,7 @@ Licensed under the Apache License, Version 2.0 (the "License");thread worker for adh5_reduce_brick
this function polls job data folders from thread group 0 and calls the reduction function on their contents. the result waves have prefix "redw_" and are saved in the job folder.
-Definition at line 1377 of file pearl-area-import.ipf.
+Definition at line 1410 of file pearl-area-import.ipf.
@@ -1410,7 +1413,7 @@ Licensed under the Apache License, Version 2.0 (the "License");Definition at line 1757 of file pearl-area-import.ipf.
+Definition at line 1790 of file pearl-area-import.ipf.
Definition at line 1718 of file pearl-area-import.ipf.
+Definition at line 1751 of file pearl-area-import.ipf.
profile extraction for multi-dimensional datasets acquired from area detectors.
-Definition in file pearl-area-profiles.ipf.
@@ -192,7 +194,7 @@ Licensed under the Apache License, Version 2.0 (the "License");collect profiles from a multi-scan.
Definition at line 621 of file pearl-area-profiles.ipf.
+Definition at line 622 of file pearl-area-profiles.ipf.
Definition at line 54 of file pearl-area-profiles.ipf.
+Definition at line 55 of file pearl-area-profiles.ipf.
@@ -361,9 +363,9 @@ Licensed under the Apache License, Version 2.0 (the "License");1D cut through 3D dataset along X dimension.
-see ad_extract_rod() for descriptions of common parameters.
+see ad_extract_rod() for descriptions of common parameters.
-Definition at line 106 of file pearl-area-profiles.ipf.
+Definition at line 107 of file pearl-area-profiles.ipf.
1D cut through 3D dataset along Y dimension.
-see ad_extract_rod() for descriptions of common parameters.
+see ad_extract_rod() for descriptions of common parameters.
-Definition at line 168 of file pearl-area-profiles.ipf.
+Definition at line 169 of file pearl-area-profiles.ipf.
1D cut through 3D dataset along Z dimension.
-see ad_extract_rod() for descriptions of common parameters.
+see ad_extract_rod() for descriptions of common parameters.
-Definition at line 231 of file pearl-area-profiles.ipf.
+Definition at line 232 of file pearl-area-profiles.ipf.
Definition at line 313 of file pearl-area-profiles.ipf.
+Definition at line 314 of file pearl-area-profiles.ipf.
@@ -644,7 +646,7 @@ Licensed under the Apache License, Version 2.0 (the "License");Definition at line 358 of file pearl-area-profiles.ipf.
+Definition at line 359 of file pearl-area-profiles.ipf.
Definition at line 398 of file pearl-area-profiles.ipf.
+Definition at line 399 of file pearl-area-profiles.ipf.
Definition at line 438 of file pearl-area-profiles.ipf.
+Definition at line 439 of file pearl-area-profiles.ipf.
1D cut through 2D dataset along X dimension, new destination wave.
-Definition at line 480 of file pearl-area-profiles.ipf.
+Definition at line 481 of file pearl-area-profiles.ipf.
@@ -840,7 +842,7 @@ Licensed under the Apache License, Version 2.0 (the "License");1D cut through 2D dataset along X dimension, existing destination wave.
-Definition at line 504 of file pearl-area-profiles.ipf.
+Definition at line 505 of file pearl-area-profiles.ipf.
@@ -890,7 +892,7 @@ Licensed under the Apache License, Version 2.0 (the "License");1D cut through 2D dataset along Y dimension, new destination wave.
-Definition at line 542 of file pearl-area-profiles.ipf.
+Definition at line 543 of file pearl-area-profiles.ipf.
@@ -940,7 +942,7 @@ Licensed under the Apache License, Version 2.0 (the "License");1D cut through 2D dataset along X dimension, existing destination wave.
-Definition at line 567 of file pearl-area-profiles.ipf.
+Definition at line 568 of file pearl-area-profiles.ipf.
@@ -960,7 +962,7 @@ Licensed under the Apache License, Version 2.0 (the "License");Definition at line 603 of file pearl-area-profiles.ipf.
+Definition at line 604 of file pearl-area-profiles.ipf.
Definition in file pearl-arpes.ipf.
@@ -160,7 +162,7 @@ Licensed under the Apache License, Version 2.0 (the "License");initializes package data once when the procedure is first loaded
-Definition at line 77 of file pearl-arpes.ipf.
+Definition at line 78 of file pearl-arpes.ipf.
@@ -179,7 +181,7 @@ Licensed under the Apache License, Version 2.0 (the "License");Definition at line 84 of file pearl-arpes.ipf.
+Definition at line 85 of file pearl-arpes.ipf.
Definition at line 47 of file pearl-compat.ipf.
+Definition at line 48 of file pearl-compat.ipf.
preview and import panel for PEARL data -More...
-#include "pearl-area-import"
#include <HierarchicalListWidget>
#include "pearl-area-import"
#include "pearl-area-profiles"
#include "pearl-area-display"
#include "pearl-compat"
Go to the source code of this file.
-Namespaces | |
PearlDataExplorer | |
preview and import panel for PEARL data | |
Functions | |
variable | pearl_data_explorer () |
show the pearl data explorer window More... | |
static variable | init_package () |
initialize the global variables of the data explorer. More... | |
static variable | save_prefs () |
save persistent package data to the preferences file. More... | |
save persistent package data to the preferences file. More... | |
static variable | load_prefs () |
static variable | pearl_file_type (string filename) |
check whether a file can be imported by this module. More... | |
check whether a file can be imported by this module. More... | |
static variable | update_filepath () |
update the file path after path change More... | |
static variable | update_filelist () |
read a list of PEARL files from the file system More... | |
read a list of PEARL files from the file system More... | |
static variable | update_datasets () |
static variable | get_file_info (string filename) |
load the internal structure of a file More... | |
static variable | attributes_notebook (string filename) |
load attributes More... | |
static variable | extract_attributes (dfref attr_df, dfref dest_df=defaultValue, wave attr_filter=defaultValue, variable include_datawaves=defaultValue, variable include_infowaves=defaultValue) |
extract summary from attribute waves More... | |
variable | test_attributes_notebook () |
static variable | create_attributes_notebook (wave attr_names, wave attr_values, string title) |
static variable | notebook_add_attributes (string notebook_name, wave attr_filter, wave attr_names, wave attr_values) |
static variable | set_elog_attributes (dfref file_df, string filename=defaultValue, string graphname=defaultValue) |
send general metadata to ELOG panel - if available More... | |
static variable | preview_file (string filename) |
static wave | preview_pshell_file (string filename) |
load the preview of a PShell HDF5 file. More... | |
load the preview of a PShell HDF5 file. More... | |
static wave | preview_hdf_file (string filename) |
load the preview of a PEARL HDF5 file. More... | |
load the preview of a PEARL HDF5 file. More... | |
static wave | preview_itx_file (string filename) |
load the preview of a general ITX file. More... | |
load the preview of a general ITX file. More... | |
static wave | preview_mtrx_file (string filename) |
load the preview of a Matrix STM file. More... | |
static variable | extract_preview_image (wave data, wave preview) |
extract a preview image from a wave of arbitrary dimension More... | |
static variable | preview_dataset (string datasetname) |
static variable | preview_datafolder () |
preview data in the current data folder More... | |
static variable | preview_setscale_x (wave data, wave preview) |
static variable | preview_attributes (dfref attr_folder, dfref dest_folder=defaultValue, wave attr_filter=defaultValue, variable include_datawaves=defaultValue, variable include_infowaves=defaultValue) |
static variable | display_dataset (string datasetname) |
variable | test_attributes_notebook () |
static variable | attributes_notebook (wave attr_names, wave attr_values, string title) |
static variable | notebook_add_attributes (string notebook_name, wave attr_filter, wave attr_names, wave attr_values) |
static variable | display_dataset (dfref file_df, string dataset) |
displays the graph of a loaded dataset in its own window More... | |
static string | show_preview_graph (wave data, wave xdata=defaultValue) |
static string | display_preview_trace (wave xtrace, wave ytrace) |
static variable | load_selected_files (string options=defaultValue) |
load the selected files More... | |
static variable | load_file (string filename, string options=defaultValue) |
static variable | load_file (string filename, string options=defaultValue, dfref dest_df=defaultValue, variable quiet=defaultValue) |
load one file More... | |
static variable | prompt_hdf_options (string *options) |
variable | prompt_default_process (string *param) |
prototype for prompting for processing function parameters. More... | |
prototype for prompting for processing function parameters. More... | |
variable | prompt_func_params (string func_name, string *func_param) |
static dfr | load_pshell_file (string filename, string options=defaultValue) |
static dfr | load_hdf_file (string filename, string options=defaultValue) |
static dfr | load_itx_file (string filename, string options=defaultValue) |
static dfr | load_mtrx_file (string filename, string options=defaultValue) |
load a matrix (STM) data file More... | |
static dfr | load_pshell_file (string filename, string options=defaultValue, dfref dest_df=defaultValue, variable quiet=defaultValue) |
load a pshell file More... | |
static dfr | load_hdf_file (string filename, string options=defaultValue, dfref dest_df=defaultValue, variable quiet=defaultValue) |
static dfr | load_itx_file (string filename, string options=defaultValue, dfref dest_df=defaultValue, variable quiet=defaultValue) |
string | itx_suggest_foldername (string filename, variable ignoredate=defaultValue, string sourcename=defaultValue, variable unique=defaultValue) |
suggest the name of a data folder based on an igor-text file name More... | |
void | PearlDataExplorer () |
static variable | update_controls () |
update controls state More... | |
static variable | bp_load_prefs (WMButtonAction *ba) |
static variable | bp_save_prefs (WMButtonAction *ba) |
static string | shorten_filepath (string long_path, variable max_len) |
shorten a file path for display More... | |
static variable | bp_browse_filepath (WMButtonAction *ba) |
static variable | bp_update_filelist (WMButtonAction *ba) |
static variable | bp_load_files (WMButtonAction *ba) |
static variable | bp_load_files_opt (WMButtonAction *ba) |
static string | pm_reduction_values () |
items for data reduction popup More... | |
static variable | pmp_reduction_func (WMPopupAction *pa) |
static variable | bp_reduction_params (WMButtonAction *ba) |
static variable | bp_load_options (WMButtonAction *ba) |
static variable | selected_file (string file, variable do_preview) |
actions after a file has been selected More... | |
static variable | bp_file_next (WMButtonAction *ba) |
static variable | bp_file_prev (WMButtonAction *ba) |
static variable | lbp_filelist (WMListboxAction *lba) |
static variable | bp_update_datasets (WMButtonAction *ba) |
static variable | bp_dataset_folder (WMButtonAction *ba) |
static variable | bp_dataset_display (WMButtonAction *ba) |
static variable | bp_dataset_next (WMButtonAction *ba) |
static variable | bp_dataset_prev (WMButtonAction *ba) |
static variable | lbp_datasets (WMListboxAction *lba) |
static variable | bp_attr_notebook (WMButtonAction *ba) |
static variable | hlp_setup () |
static variable | hl_contents_clear () |
static variable | hl_contents_update (dfref file_df) |
populate the contents list box with the internal directory of a HDF5 file More... | |
static dfr | get_pshell_info (string path_name, string file_name, dfref dest_df=defaultValue) |
static variable | hl_add_objects (string parent_path, string objects) |
populate the contents list box with the given hierarchical paths More... | |
static variable | hl_expand_scans () |
static variable | hl_default_selection () |
static variable | hlp_contents_open (string HostWindow, string ListControlName, string ContainerPath) |
static variable | hlp_contents_selection (string HostWindow, string ListControlName, string SelectedItem, variable EventCode) |
static variable | goto_dataset_folder (string filename, string datapath) |
open data folder corresponding to a file and data path More... | |
static variable | bp_goto_dataset (WMButtonAction *ba) |
"goto DF" button More... | |
static variable | bp_display_dataset (WMButtonAction *ba) |
"display dataset" button More... | |
static variable | send_to_elog () |
send file metadata to the ELOG panel More... | |
static variable | bp_elog (WMButtonAction *ba) |
Variables | |
static const string | package_name = "pearl_explorer" |
version | |
static const string | package_path = "root:packages:pearl_explorer:" |
static const string | ks_filematch_adh5 = "*.h5" |
static const string | ks_filematch_itx = "*.itx" |
static const string | ks_filematch_mtrx = "*_mtrx" |
preview and import panel for PEARL data
-preview and import panel for PEARL data:
Definition in file pearl-data-explorer.ipf.
-load attributes
+ +Definition at line 301 of file pearl-data-explorer.ipf.
+ +
+
|
+ +static | +
Definition at line 1914 of file pearl-data-explorer.ipf.
+ +
+
|
+ +static | +
Definition at line 1673 of file pearl-data-explorer.ipf.
+ +
+
|
+ +static | +
"display dataset" button
+ +Definition at line 2263 of file pearl-data-explorer.ipf.
+ +
+
|
+ +static | +
Definition at line 2351 of file pearl-data-explorer.ipf.
+ +
+
|
+ +static | +
Definition at line 1809 of file pearl-data-explorer.ipf.
+ +
+
|
+ +static | +
Definition at line 1840 of file pearl-data-explorer.ipf.
+ +
+
|
+ +static | +
"goto DF" button
+the button selects the data folder of the selected file and dataset. an error message is shown if the data folder doesn't exist.
+ +Definition at line 2231 of file pearl-data-explorer.ipf.
+ +
+
|
+ +static | +
Definition at line 1757 of file pearl-data-explorer.ipf.
+ +
+
|
+ +static | +
Definition at line 1618 of file pearl-data-explorer.ipf.
+ +
+
|
+ +static | +
Definition at line 1735 of file pearl-data-explorer.ipf.
+ +
+
|
+ +static | +
Definition at line 1633 of file pearl-data-explorer.ipf.
+ +
+
|
+ +static | +
Definition at line 1696 of file pearl-data-explorer.ipf.
+ +
+
-
-
-Definition at line 822 of file pearl-data-explorer.ipf. +Definition at line 480 of file pearl-data-explorer.ipf. ◆ bp_attr_notebook()- -
-
-
-
-
-
-
-Definition at line 1750 of file pearl-data-explorer.ipf. - -◆ bp_browse_filepath()- -
-
-
-
-
-
-
-Definition at line 1436 of file pearl-data-explorer.ipf. - -◆ bp_dataset_display()- -
-
-
-
-
-
-
-Definition at line 1641 of file pearl-data-explorer.ipf. - -◆ bp_dataset_folder()- -
-
-
-
-
-
-
-Definition at line 1615 of file pearl-data-explorer.ipf. - -◆ bp_dataset_next()- -
-
-
-
-
-
-
-Definition at line 1661 of file pearl-data-explorer.ipf. - -◆ bp_dataset_prev()- -
-
-
-
-
-
-
-Definition at line 1688 of file pearl-data-explorer.ipf. - -◆ bp_file_next()- -
-
-
-
-
-
-
-Definition at line 1502 of file pearl-data-explorer.ipf. - -◆ bp_file_prev()- -
-
-
-
-
-
-
-Definition at line 1534 of file pearl-data-explorer.ipf. - -◆ bp_load_files()- -
-
-
-
-
-
-
-Definition at line 1474 of file pearl-data-explorer.ipf. - -◆ bp_load_files_opt()- -
-
-
-
-
-
-
-Definition at line 1488 of file pearl-data-explorer.ipf. - -◆ bp_load_prefs()- -
-
-
-
-
-
-
-Definition at line 1408 of file pearl-data-explorer.ipf. - -◆ bp_save_prefs()- -
-
-
-
-
-
-
-Definition at line 1422 of file pearl-data-explorer.ipf. - -◆ bp_update_datasets()- -
-
-
-
-
-
-
-Definition at line 1601 of file pearl-data-explorer.ipf. - -◆ bp_update_filelist()- -
-
-
-
-
-
-
-Definition at line 1460 of file pearl-data-explorer.ipf. - -◆ display_dataset()+ +◆ display_dataset()
@@ -693,9 +699,19 @@ Variables | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
static variable display_dataset | ( | -string | -datasetname | ) | +dfref | +file_df, | +||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
+ | string | +dataset | +||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
+ | ) | +
Definition at line 782 of file pearl-data-explorer.ipf.
+displays the graph of a loaded dataset in its own window
+ +Definition at line 897 of file pearl-data-explorer.ipf.
Definition at line 939 of file pearl-data-explorer.ipf.
+Definition at line 978 of file pearl-data-explorer.ipf.
+ +
+
|
+ +static | +
extract summary from attribute waves
+by default, all existing attributes are copied. if a text wave attr_filter exists in the pear_explorer folder, only the attributes referenced therein are copied. to set up a filter, duplicate the attr_names wave of a template dataset, and remove unwanted items.
+attr_df | data folder which contains the original data, e.g. the attr, diags or snaps folder in pshell files. |
dest_df | destination folder. the output is written to the attr_names and attr_values waves. default = package folder. |
attr_filter | (text wave) list of attributes allowed in the output. default = use attr_filter of package folder. |
include_datawaves |
|
include_infowaves |
|
Definition at line 347 of file pearl-data-explorer.ipf.
Definition at line 495 of file pearl-data-explorer.ipf.
+extract a preview image from a wave of arbitrary dimension
+ +Definition at line 784 of file pearl-data-explorer.ipf.
+ +
+
|
+ +static | +
load the internal structure of a file
+this loads metadata for updating the panels.
+for a pshell file, metadata includes:
Definition at line 273 of file pearl-data-explorer.ipf.
+ +
+
|
+ +static | +
Definition at line 2001 of file pearl-data-explorer.ipf.
+ +
+
|
+ +static | +
open data folder corresponding to a file and data path
+the function tries to find where a given dataset has been loaded and selects the corresponding data folder. the data folder must exist (after previous import from the file), else an error code is returned and the folder selection will be the closest accessible parent folder of the target.
+filename | file name (without path). h5 and otf.itx files are supported. |
datapath | dataset or group path inside the hdf5 file. |
Definition at line 2175 of file pearl-data-explorer.ipf.
+ +
+
|
+ +static | +
populate the contents list box with the given hierarchical paths
+Definition at line 2029 of file pearl-data-explorer.ipf.
+ +
+
|
+ +static | +
Definition at line 1952 of file pearl-data-explorer.ipf.
+ +
+
|
+ +static | +
populate the contents list box with the internal directory of a HDF5 file
+Definition at line 1966 of file pearl-data-explorer.ipf.
+ +
+
|
+ +static | +
Definition at line 2118 of file pearl-data-explorer.ipf.
+ +
+
|
+ +static | +
Definition at line 2089 of file pearl-data-explorer.ipf.
+ +
+
|
+ +static | +
Definition at line 2129 of file pearl-data-explorer.ipf.
+ +
+
|
+ +static | +
Definition at line 2139 of file pearl-data-explorer.ipf.
+ +
+
|
+ +static | +
Definition at line 1942 of file pearl-data-explorer.ipf.
initialize the global variables of the data explorer.
-initializes the global variables and data folder for this procedure file must be called once before the panel is created warning: this function overwrites previous values
- -Definition at line 56 of file pearl-data-explorer.ipf.
+Definition at line 61 of file pearl-data-explorer.ipf.
Definition at line 1258 of file pearl-data-explorer.ipf.
+suggest the name of a data folder based on an igor-text file name
+if the file name follows the naming convention source-date-index.extension, the function tries to generate the nick name as source_date_index. otherwise it's just a cleaned up version of the file name.
+igor text is used by the on-the-fly scan tool.
+filename | file name, including extension. can also include a folder path (which is ignored). the extension is currently ignored, but may be used in a later version. |
ignoredate | if non-zero, the nick name will not include the date part. defaults to zero |
sourcename | nick name of the data source. the function tries to detect the source from the file name. this option can be used to override auto-detection. allowed values: sscan, otf |
unique | if non-zero, the resulting name is made a unique data folder name in the current data folder. defaults to zero |
-
|
- -static | -
Definition at line 1715 of file pearl-data-explorer.ipf.
+Definition at line 1427 of file pearl-data-explorer.ipf.
Definition at line 1566 of file pearl-data-explorer.ipf.
+Definition at line 1871 of file pearl-data-explorer.ipf.
defaultValue
defaultValue
, defaultValue
, defaultValue
Definition at line 996 of file pearl-data-explorer.ipf.
+load one file
+this can be a PShell, HDF5, or ITX file.
+options | key:value; list of load options. the recognized keys are: mode , reduction_func and reduction_params . see main text for a description of possible values. by default (options not specified), options are read from `s_hdf_options. if the option string is empty, the user is prompted for options. |
dest_df | destination data folder. default: a new folder derived from file name under root. |
quiet |
|
Definition at line 1064 of file pearl-data-explorer.ipf.
defaultValue
defaultValue
, defaultValue
, defaultValue
Definition at line 1142 of file pearl-data-explorer.ipf.
+Definition at line 1298 of file pearl-data-explorer.ipf.
defaultValue
Definition at line 1192 of file pearl-data-explorer.ipf.
- -
-
-
@@ -1090,12 +1584,12 @@ Variablesload a matrix (STM) data file - -Definition at line 1235 of file pearl-data-explorer.ipf. +Definition at line 1358 of file pearl-data-explorer.ipf. |
Definition at line 118 of file pearl-data-explorer.ipf.
+Definition at line 155 of file pearl-data-explorer.ipf.
defaultValue
defaultValue
, defaultValue
, defaultValue
Definition at line 1090 of file pearl-data-explorer.ipf.
+load a pshell file
+if options is not specified, the complete file is loaded. if options is an empty string, the package default options are used.
+data selection is extracted from the datasets list box.
+the file can be loaded in one of the following modes (mode
key of the options argument):
load_complete
load all datasets regardless of selection. load_scan
load default datasets of selected scans. load_region
load default datasets of selected regions. load_dataset
load selected datasets. load_diags
load diagnostic datasets of selected scans.3-dimensional datasets can be loaded with dimension reduction. in this case, the name of the reduction function must be given under the reduction_func
key. the reduction parameters are prompted for if a prompt function for the reduction function is found. the default reduction parameters are the most recent parameters s_reduction_params
stored in the package data folder.
reduction_func:...
name of the reduction function.if a reduction function is specified, default reduction parameters are read from s_reduction_params
in the package data folder, and the user is prompted to review/update the parameters.
options | key:value; list of load options. the recognized keys are: mode , reduction_func and reduction_params . see main text for a description of possible values. by default (options not specified), options are read from `s_hdf_options. if the option string is empty, the user is prompted for options. |
dest_df | destination data folder. default: a new folder derived from file name under root. |
quiet |
|
Definition at line 1188 of file pearl-data-explorer.ipf.
Definition at line 972 of file pearl-data-explorer.ipf.
+load the selected files
+load the files that are selected in the data explorer panel. the files are loaded using the load_file() function.
+Definition at line 1025 of file pearl-data-explorer.ipf.
Definition at line 861 of file pearl-data-explorer.ipf.
+Definition at line 519 of file pearl-data-explorer.ipf.
Definition at line 45 of file pearl-data-explorer.ipf.
+show the pearl data explorer window
+create a pearl data explorer window or bring the existing one to the front. if a new window is created, also initialize all package variables and load package preferences.
+ +Definition at line 47 of file pearl-data-explorer.ipf.
Definition at line 163 of file pearl-data-explorer.ipf.
+Definition at line 199 of file pearl-data-explorer.ipf.
@@ -1283,12 +1825,12 @@ VariablesDefinition at line 1317 of file pearl-data-explorer.ipf.
+Definition at line 1478 of file pearl-data-explorer.ipf.
static variable preview_attributes | +static string pm_reduction_values | ( | -dfref | -attr_folder, | -|
+ | ) | - | dfref | -dest_folder = defaultValue , |
- |
- | - | wave | -attr_filter = defaultValue , |
- ||
- | - | variable | -include_datawaves = defaultValue , |
- ||
- | - | variable | -include_infowaves = defaultValue |
- ||
- | ) | -
Definition at line 648 of file pearl-data-explorer.ipf.
+items for data reduction popup
+ +Definition at line 1712 of file pearl-data-explorer.ipf.
+ +
+
|
+ +static | +
Definition at line 1719 of file pearl-data-explorer.ipf.
Definition at line 577 of file pearl-data-explorer.ipf.
+preview data in the current data folder
+used by preview_itx_file
-
-
|
- -static | -
Definition at line 534 of file pearl-data-explorer.ipf.
+Definition at line 826 of file pearl-data-explorer.ipf.
Definition at line 257 of file pearl-data-explorer.ipf.
+Definition at line 629 of file pearl-data-explorer.ipf.
load the preview of a PEARL HDF5 file.
-the preview is an arbitrary detector image extracted from the file, see adh5_load_preview(). the preview is loaded to the preview_image wave in the pear_explorer data folder.
+the preview is an arbitrary detector image extracted from the file, see adh5_load_preview(). the preview is loaded to the preview_image wave in the pear_explorer data folder.
the s_file_info string is updated with information about the scan dimensions.
-
|
- -static | -
load the preview of a Matrix STM file.
-the preview is loaded to the preview_image wave in the pearl_explorer data folder.
-the s_file_info string is updated with information about the scan dimensions.
-this function requires the MatrixFileReader.xop and pearl-matrix-import.ipf to be loaded. otherwise it will return an empty wave reference.
-filename | name of a file in the directory specified by the pearl_explorer_filepath path object. |
Definition at line 452 of file pearl-data-explorer.ipf.
+Definition at line 762 of file pearl-data-explorer.ipf.
load the preview of a PShell HDF5 file.
-the preview is an arbitrary detector image extracted from the file, see adh5_load_preview(). the preview is loaded to the preview_image wave in the pear_explorer data folder.
+the preview is an arbitrary detector image extracted from the file, see adh5_load_preview(). the preview is loaded to the preview_image wave in the pear_explorer data folder.
the s_file_info string is updated with information about the scan dimensions.
Definition at line 618 of file pearl-data-explorer.ipf.
+Definition at line 866 of file pearl-data-explorer.ipf.
prompt functions must have the same name as the corresponding reduction function with the prefix "prompt_". be aware of the limited length of function names in Igor.
this function is a prototype. it does nothing but returns OK.
-Definition at line 1070 of file pearl-data-explorer.ipf.
+Definition at line 1130 of file pearl-data-explorer.ipf.
@@ -1673,7 +2151,7 @@ VariablesDefinition at line 1076 of file pearl-data-explorer.ipf.
+Definition at line 1136 of file pearl-data-explorer.ipf.
Definition at line 1031 of file pearl-data-explorer.ipf.
+Definition at line 1090 of file pearl-data-explorer.ipf.
save persistent package data to the preferences file.
this function is called when the user clicks the corresponding button. the data saved in the file are: data file path, attributes filter
-Definition at line 102 of file pearl-data-explorer.ipf.
+Definition at line 139 of file pearl-data-explorer.ipf.
+ + + + +
+
|
+ +static | +
actions after a file has been selected
+file | name of selected file |
do_preview | enable/disable loading of preview data non-zero: load preview, zero: don't load preview |
Definition at line 1791 of file pearl-data-explorer.ipf.
+ +
+
|
+ +static | +
send file metadata to the ELOG panel
+metadate is looked up in the following locations:
Definition at line 2295 of file pearl-data-explorer.ipf.
+ +
+
|
+ +static | +
send general metadata to ELOG panel - if available
+the following metatdata are sent. they must be present as strings in the specified data folder:
+ELOG parameter | global string | function argument |
---|---|---|
file | s_filepath | filename |
graph attachment | graphname | |
author | authors | |
p-group | pgroup | |
project | proposal | |
sample | sample |
file_df | data folder that contains the metadata. |
filename | override file path read from s_filepath global string variable. if neither is declared, the file name is reset to empty field. |
graphname | select this graph window for attaching. default: do not change the selection. |
Definition at line 568 of file pearl-data-explorer.ipf.
+ +
+
|
+ +static | +
shorten a file path for display
+Definition at line 1651 of file pearl-data-explorer.ipf.
Definition at line 888 of file pearl-data-explorer.ipf.
+Definition at line 925 of file pearl-data-explorer.ipf.
Definition at line 815 of file pearl-data-explorer.ipf.
+Definition at line 473 of file pearl-data-explorer.ipf.
static variable update_datasets | +static variable update_controls | ( | ) | @@ -1815,7 +2490,9 @@ Variables |
Definition at line 214 of file pearl-data-explorer.ipf.
+update controls state
+ +Definition at line 1557 of file pearl-data-explorer.ipf.
read a list of PEARL files from the file system
-wtFiles and wSelectedFiles in the package data folder are updated. only files for which pearl_file_type() returns non-zero are listed.
+wtFiles and wSelectedFiles in the package data folder are updated. only files for which pearl_file_type() returns non-zero are listed.
-Definition at line 186 of file pearl-data-explorer.ipf.
+Definition at line 231 of file pearl-data-explorer.ipf.
+ +
+
|
+ +static | +
update the file path after path change
+read the path info from pearl_explorer_filepath and update the path control
+ +Definition at line 218 of file pearl-data-explorer.ipf.
Definition at line 40 of file pearl-data-explorer.ipf.
+Definition at line 38 of file pearl-data-explorer.ipf.
Definition at line 42 of file pearl-data-explorer.ipf.
- -
-
|
- -static | -
Definition at line 43 of file pearl-data-explorer.ipf.
+Definition at line 40 of file pearl-data-explorer.ipf.
Definition at line 41 of file pearl-data-explorer.ipf.
- -
-
|
- -static | -
Definition at line 37 of file pearl-data-explorer.ipf.
+Definition at line 39 of file pearl-data-explorer.ipf.
Definition at line 38 of file pearl-data-explorer.ipf.
+Definition at line 36 of file pearl-data-explorer.ipf.
+ +version | +
Definition at line 6 of file pearl-data-explorer.ipf.
@@ -278,7 +280,7 @@ Variables |
Definition at line 1635 of file pearl-elog.ipf.
+Definition at line 1636 of file pearl-elog.ipf.
select/deselect all graph windows for attachment
-Definition at line 1614 of file pearl-elog.ipf.
+Definition at line 1615 of file pearl-elog.ipf.
@@ -464,7 +466,7 @@ Variablesselect top graph window for attachment
-Definition at line 1598 of file pearl-elog.ipf.
+Definition at line 1599 of file pearl-elog.ipf.
@@ -494,7 +496,7 @@ Variablesbutton procedure for the attachment up and down buttons
-Definition at line 1519 of file pearl-elog.ipf.
+Definition at line 1520 of file pearl-elog.ipf.
@@ -522,7 +524,7 @@ VariablesDefinition at line 1696 of file pearl-elog.ipf.
+Definition at line 1697 of file pearl-elog.ipf.
Definition at line 1712 of file pearl-elog.ipf.
+Definition at line 1713 of file pearl-elog.ipf.
Definition at line 1730 of file pearl-elog.ipf.
+Definition at line 1731 of file pearl-elog.ipf.
Definition at line 1668 of file pearl-elog.ipf.
+Definition at line 1669 of file pearl-elog.ipf.
button procedure for the Submit and Reply buttons
-Definition at line 1551 of file pearl-elog.ipf.
+Definition at line 1552 of file pearl-elog.ipf.
@@ -664,10 +666,10 @@ Variablesdelete temporary files created by the ELOG module.
-this deletes all temporary graph files that are referenced by the volatile temp_graph_files list. temp_graph_files is a semicolon-delimited string. items are added by create_graph_file().
+this deletes all temporary graph files that are referenced by the volatile temp_graph_files list. temp_graph_files is a semicolon-delimited string. items are added by create_graph_file().
this function should be called before a new experiment is loaded or igor quits.
-Definition at line 1115 of file pearl-elog.ipf.
+Definition at line 1116 of file pearl-elog.ipf.
the command script changes the working directory to the Temporary directory. it also deletes a previous elog.log file.
Definition at line 1059 of file pearl-elog.ipf.
+Definition at line 1060 of file pearl-elog.ipf.
@@ -750,7 +752,7 @@ VariablesDefinition at line 1023 of file pearl-elog.ipf.
+Definition at line 1024 of file pearl-elog.ipf.
@@ -790,7 +792,7 @@ VariablesDefinition at line 982 of file pearl-elog.ipf.
+Definition at line 983 of file pearl-elog.ipf.
@@ -837,7 +839,7 @@ VariablesDefinition at line 792 of file pearl-elog.ipf.
+Definition at line 793 of file pearl-elog.ipf.
@@ -881,7 +883,7 @@ Variablesset global module configuration parameters
-Definition at line 473 of file pearl-elog.ipf.
+Definition at line 474 of file pearl-elog.ipf.
@@ -956,7 +958,7 @@ Variables -Definition at line 685 of file pearl-elog.ipf.
+Definition at line 686 of file pearl-elog.ipf.
@@ -996,7 +998,7 @@ Variables -Definition at line 414 of file pearl-elog.ipf.
+Definition at line 415 of file pearl-elog.ipf.
@@ -1019,7 +1021,7 @@ Variablestemplate logbooks for PEARL.
Definition at line 262 of file pearl-elog.ipf.
+Definition at line 263 of file pearl-elog.ipf.
@@ -1057,7 +1059,7 @@ Variablesset username and password for login to a logbook
the username and password are stored (in plain text) in global strings under the selected logbook folder. this is necessary for sending data to the ELOG server.
-call elog_logout() to clear the password variables and to avoid unintended use of your credentials.
+call elog_logout() to clear the password variables and to avoid unintended use of your credentials.
Definition at line 1395 of file pearl-elog.ipf.
+Definition at line 1396 of file pearl-elog.ipf.
prompt to open or create a logbook
-Definition at line 1184 of file pearl-elog.ipf.
+Definition at line 1185 of file pearl-elog.ipf.
@@ -1166,7 +1168,7 @@ Variablesprompt the user for login to a logbook
-Definition at line 1214 of file pearl-elog.ipf.
+Definition at line 1215 of file pearl-elog.ipf.
@@ -1200,7 +1202,7 @@ VariablesDefinition at line 653 of file pearl-elog.ipf.
+Definition at line 654 of file pearl-elog.ipf.
@@ -1236,7 +1238,7 @@ VariablesDefinition at line 902 of file pearl-elog.ipf.
+Definition at line 903 of file pearl-elog.ipf.
@@ -1263,7 +1265,7 @@ VariablesDefinition at line 1747 of file pearl-elog.ipf.
+Definition at line 1748 of file pearl-elog.ipf.
Definition at line 170 of file pearl-elog.ipf.
+Definition at line 171 of file pearl-elog.ipf.
@@ -1344,7 +1346,7 @@ VariablesDefinition at line 1095 of file pearl-elog.ipf.
+Definition at line 1096 of file pearl-elog.ipf.
"key1=value1;key2=value2"
. Definition at line 1760 of file pearl-elog.ipf.
+Definition at line 1761 of file pearl-elog.ipf.
@@ -1418,7 +1420,7 @@ VariablesDefinition at line 1926 of file pearl-elog.ipf.
+Definition at line 1927 of file pearl-elog.ipf.
@@ -1455,7 +1457,7 @@ VariablesDefinition at line 1880 of file pearl-elog.ipf.
+Definition at line 1881 of file pearl-elog.ipf.
@@ -1483,7 +1485,7 @@ VariablesDefinition at line 958 of file pearl-elog.ipf.
+Definition at line 959 of file pearl-elog.ipf.
save preferences and recent values before Igor opens a new experiment.
-Definition at line 127 of file pearl-elog.ipf.
+Definition at line 128 of file pearl-elog.ipf.
@@ -1543,7 +1545,7 @@ Variablessave preferences and recent values before Igor quits.
-Definition at line 135 of file pearl-elog.ipf.
+Definition at line 136 of file pearl-elog.ipf.
@@ -1584,7 +1586,7 @@ Variables -Definition at line 217 of file pearl-elog.ipf.
+Definition at line 218 of file pearl-elog.ipf.
@@ -1613,9 +1615,9 @@ Variablesinitialize volatile variables.
create and initialize all volatile variables for the configured notebooks. values of existing variables are not changed.
-this function must be called after new logbooks have been configured, specifically by elog_create_logbook() and load_prefs().
+this function must be called after new logbooks have been configured, specifically by elog_create_logbook() and load_prefs().
-Definition at line 340 of file pearl-elog.ipf.
+Definition at line 341 of file pearl-elog.ipf.
@@ -1653,7 +1655,7 @@ VariablesDefinition at line 618 of file pearl-elog.ipf.
+Definition at line 619 of file pearl-elog.ipf.
@@ -1683,7 +1685,7 @@ Variablesload persistent package data from the preferences file.
the preferences file is an Igor packed experiment file in a special preferences folder
-Definition at line 584 of file pearl-elog.ipf.
+Definition at line 585 of file pearl-elog.ipf.
@@ -1729,7 +1731,7 @@ Variablesmove an attachment item in the list of attachments
-Definition at line 1495 of file pearl-elog.ipf.
+Definition at line 1496 of file pearl-elog.ipf.
@@ -1759,7 +1761,7 @@ Variablesparse the result file from an elog invokation.
Definition at line 1141 of file pearl-elog.ipf.
+Definition at line 1142 of file pearl-elog.ipf.
@@ -1783,12 +1785,12 @@ Variablesthis function takes care of all necessary initialization, configuration, and preferences. if a panel exists, it will be moved to the front.
logbook | name of the logbook if empty, the user is prompted to select or create a logbook by elog_prompt_logbook(). |
logbook | name of the logbook if empty, the user is prompted to select or create a logbook by elog_prompt_logbook(). |
Definition at line 97 of file pearl-elog.ipf.
+Definition at line 98 of file pearl-elog.ipf.
@@ -1809,7 +1811,7 @@ Variablesopen a new panel for submitting data to ELOG.
-this function creates only the panel but not the necessary data folders. call init_package() and load_prefs() once before creating panels.
+this function creates only the panel but not the necessary data folders. call init_package() and load_prefs() once before creating panels.
logbook | name of the target logbook |
Definition at line 1134 of file pearl-elog.ipf.
+Definition at line 1135 of file pearl-elog.ipf.
Definition at line 1133 of file pearl-elog.ipf.
+Definition at line 1134 of file pearl-elog.ipf.
Definition at line 1431 of file pearl-elog.ipf.
+Definition at line 1432 of file pearl-elog.ipf.
Definition at line 1429 of file pearl-elog.ipf.
+Definition at line 1430 of file pearl-elog.ipf.
Definition at line 1430 of file pearl-elog.ipf.
+Definition at line 1431 of file pearl-elog.ipf.
Definition at line 155 of file pearl-elog.ipf.
+Definition at line 156 of file pearl-elog.ipf.
Definition at line 153 of file pearl-elog.ipf.
+Definition at line 154 of file pearl-elog.ipf.
Definition at line 156 of file pearl-elog.ipf.
+Definition at line 157 of file pearl-elog.ipf.
Definition at line 154 of file pearl-elog.ipf.
+Definition at line 155 of file pearl-elog.ipf.
Definition at line 85 of file pearl-elog.ipf.
+Definition at line 86 of file pearl-elog.ipf.
Definition at line 86 of file pearl-elog.ipf.
+Definition at line 87 of file pearl-elog.ipf.
various fit functions for photoelectron spectroscopy.
this procedure contains various functions for curve fitting.
-Definition in file pearl-fitfuncs.ipf.
@@ -197,7 +205,7 @@ Licensed under the Apache License, Version 2.0 (the "License");Definition at line 598 of file pearl-fitfuncs.ipf.
+Definition at line 677 of file pearl-fitfuncs.ipf.
Definition at line 643 of file pearl-fitfuncs.ipf.
+Definition at line 722 of file pearl-fitfuncs.ipf.
Definition at line 728 of file pearl-fitfuncs.ipf.
+Definition at line 807 of file pearl-fitfuncs.ipf.
Definition at line 541 of file pearl-fitfuncs.ipf.
+Definition at line 620 of file pearl-fitfuncs.ipf.
+ +threadsafe variable DblDoubletGaussLinBG_AO | +( | +wave | +pw, | +
+ | + | wave | +yw, | +
+ | + | wave | +xw | +
+ | ) | ++ |
two doublet gaussian peaks on a linear background fit function (all at once).
+this fits four gaussian peaks. peak positions are specified by center, splitting and shift rather than individually. amplitudes are specified as absolute values for peaks 1 and 3, and relative values for peaks 2 and 4.
+can be used if a spin-orbit doublet is split by a chemical shift which affects both spin-orbit peaks equally.
+pw | shape parameters.
|
yw | y (dependent) values. |
xw | x (independent) independent values. |
Definition at line 157 of file pearl-fitfuncs.ipf.
Definition at line 174 of file pearl-fitfuncs.ipf.
+Definition at line 253 of file pearl-fitfuncs.ipf.
@@ -384,7 +454,7 @@ Licensed under the Apache License, Version 2.0 (the "License");Definition at line 480 of file pearl-fitfuncs.ipf.
+Definition at line 559 of file pearl-fitfuncs.ipf.
Definition at line 391 of file pearl-fitfuncs.ipf.
+Definition at line 470 of file pearl-fitfuncs.ipf.
Definition at line 117 of file pearl-fitfuncs.ipf.
+Definition at line 118 of file pearl-fitfuncs.ipf.
@@ -492,7 +562,7 @@ Licensed under the Apache License, Version 2.0 (the "License");Definition at line 217 of file pearl-fitfuncs.ipf.
+Definition at line 296 of file pearl-fitfuncs.ipf.
Definition at line 240 of file pearl-fitfuncs.ipf.
+Definition at line 319 of file pearl-fitfuncs.ipf.
Definition at line 268 of file pearl-fitfuncs.ipf.
+Definition at line 347 of file pearl-fitfuncs.ipf.
Definition at line 309 of file pearl-fitfuncs.ipf.
+Definition at line 388 of file pearl-fitfuncs.ipf.
Definition at line 851 of file pearl-fitfuncs.ipf.
+Definition at line 930 of file pearl-fitfuncs.ipf.
@@ -670,18 +740,18 @@ Licensed under the Apache License, Version 2.0 (the "License");Definition at line 562 of file pearl-fitfuncs.ipf.
+Definition at line 641 of file pearl-fitfuncs.ipf.
variable MultiDoniachSunjicLinBG | +threadsafe variable MultiDoniachSunjicLinBG | ( | wave | w, | @@ -717,7 +787,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
variable MultiVoigtLinBG | +threadsafe variable MultiVoigtLinBG | ( | wave | w, | @@ -866,7 +936,62 @@ Licensed under the Apache License, Version 2.0 (the "License");
threadsafe variable MultiVoigtLinBG_AO | +( | +wave | +pw, | +
+ | + | wave | +yw, | +
+ | + | wave | +xw | +
+ | ) | ++ |
multiple voigt peaks on a linear background fit function.
+this is the all-at-once version of MultiVoigtLinBG. it runs slightly faster compared to the point-by-point function.
+pw | shape parameters. the length of the wave defines the number of peaks.
|
yw | y (dependent) values. |
xw | x (independent) independent values. |
Definition at line 224 of file pearl-fitfuncs.ipf.
calculate the shirley background
-Definition at line 901 of file pearl-fitfuncs.ipf.
+Definition at line 980 of file pearl-fitfuncs.ipf.
@@ -940,7 +1065,7 @@ Licensed under the Apache License, Version 2.0 (the "License");Definition at line 697 of file pearl-fitfuncs.ipf.
+Definition at line 776 of file pearl-fitfuncs.ipf.
Definition at line 796 of file pearl-fitfuncs.ipf.
+Definition at line 875 of file pearl-fitfuncs.ipf.
Definition at line 18 of file pearl-gui-tools.ipf.
+Definition at line 19 of file pearl-gui-tools.ipf.
Definition at line 50 of file pearl-gui-tools.ipf.
+Definition at line 51 of file pearl-gui-tools.ipf.
Definition at line 32 of file pearl-gui-tools.ipf.
+Definition at line 33 of file pearl-gui-tools.ipf.
@@ -183,9 +185,9 @@ Variables |
Definition at line 145 of file pearl-matrix-import.ipf.
+Definition at line 146 of file pearl-matrix-import.ipf.
Definition at line 360 of file pearl-matrix-import.ipf.
+Definition at line 361 of file pearl-matrix-import.ipf.
@@ -559,7 +561,7 @@ Licensed under the Apache License, Version 2.0 (the "License");Definition at line 461 of file pearl-matrix-import.ipf.
+Definition at line 462 of file pearl-matrix-import.ipf.
@@ -608,7 +610,7 @@ Licensed under the Apache License, Version 2.0 (the "License");Definition at line 405 of file pearl-matrix-import.ipf.
+Definition at line 406 of file pearl-matrix-import.ipf.
@@ -629,7 +631,7 @@ Licensed under the Apache License, Version 2.0 (the "License");load all data from a Matrix data file.
-Definition at line 231 of file pearl-matrix-import.ipf.
+Definition at line 232 of file pearl-matrix-import.ipf.
@@ -677,7 +679,7 @@ Licensed under the Apache License, Version 2.0 (the "License");Definition at line 767 of file pearl-matrix-import.ipf.
+Definition at line 768 of file pearl-matrix-import.ipf.
@@ -723,7 +725,7 @@ Licensed under the Apache License, Version 2.0 (the "License");Definition at line 863 of file pearl-matrix-import.ipf.
+Definition at line 864 of file pearl-matrix-import.ipf.
@@ -778,7 +780,7 @@ Licensed under the Apache License, Version 2.0 (the "License");Definition at line 682 of file pearl-matrix-import.ipf.
+Definition at line 683 of file pearl-matrix-import.ipf.
@@ -829,7 +831,7 @@ Licensed under the Apache License, Version 2.0 (the "License");Definition at line 545 of file pearl-matrix-import.ipf.
+Definition at line 546 of file pearl-matrix-import.ipf.
@@ -896,7 +898,7 @@ Licensed under the Apache License, Version 2.0 (the "License");result data files look like: default_2015Apr20-124353_STM-STM_AtomManipulation–136_1.Aux1(V)_mtrx, default_2015Apr20-124353_STM-STM_AtomManipulation–136_1.I(V)_mtrx, default_2015Apr20-124353_STM-STM_AtomManipulation–14_1.I_mtrx, default_2015Apr20-124353_STM-STM_AtomManipulation–14_1.Z_mtrx, etc. the function returns all results as described in the parameter list.
-Definition at line 294 of file pearl-matrix-import.ipf.
+Definition at line 295 of file pearl-matrix-import.ipf.
@@ -916,7 +918,7 @@ result file names look like: default_2015Apr20-124353_STM-STM_AtomManipulation_0Definition at line 829 of file pearl-matrix-import.ipf.
+Definition at line 830 of file pearl-matrix-import.ipf.
split a matrix filename and return the first three parts
we assume that the second (third) part contains the date (time). the parts are separated by dash or underscore.
-Definition at line 332 of file pearl-matrix-import.ipf.
+Definition at line 333 of file pearl-matrix-import.ipf.
@@ -1000,7 +1002,7 @@ result file names look like: default_2015Apr20-124353_STM-STM_AtomManipulation_0Definition at line 170 of file pearl-matrix-import.ipf.
+Definition at line 171 of file pearl-matrix-import.ipf.
@@ -1022,7 +1024,7 @@ result file names look like: default_2015Apr20-124353_STM-STM_AtomManipulation_0remove linear background line-by-line
-Definition at line 886 of file pearl-matrix-import.ipf.
+Definition at line 887 of file pearl-matrix-import.ipf.
@@ -1047,7 +1049,7 @@ result file names look like: default_2015Apr20-124353_STM-STM_AtomManipulation_0Definition at line 40 of file pearl-matrix-import.ipf.
+Definition at line 41 of file pearl-matrix-import.ipf.
Definition at line 37 of file pearl-matrix-import.ipf.
+Definition at line 38 of file pearl-matrix-import.ipf.
Definition at line 38 of file pearl-matrix-import.ipf.
+Definition at line 39 of file pearl-matrix-import.ipf.
Definition at line 116 of file pearl-menu.ipf.
+Definition at line 117 of file pearl-menu.ipf.
Definition at line 133 of file pearl-menu.ipf.
+Definition at line 134 of file pearl-menu.ipf.
Definition at line 152 of file pearl-menu.ipf.
+Definition at line 153 of file pearl-menu.ipf.
Definition at line 104 of file pearl-menu.ipf.
+Definition at line 105 of file pearl-menu.ipf.
Definition at line 98 of file pearl-menu.ipf.
+Definition at line 99 of file pearl-menu.ipf.
Definition at line 110 of file pearl-menu.ipf.
+Definition at line 111 of file pearl-menu.ipf.
Definition at line 242 of file pearl-menu.ipf.
+Definition at line 243 of file pearl-menu.ipf.
@@ -317,7 +319,7 @@ Functions -Definition at line 218 of file pearl-menu.ipf.
+Definition at line 219 of file pearl-menu.ipf.
@@ -354,7 +356,7 @@ Functionsarea detector live display
-display an area detector channel in an ad_display_profiles() window.
+display an area detector channel in an ad_display_profiles() window.
epicsname | base name of the detector, e.g. X03DA-SCIENTA: image1: and cam1: are appended by the function. see ad_connect(). |
PEARL Procedures
- rev-distro-2.1.1-1-gf419e92-dirty
+ rev-distro-3.0.0-0-gfa24916-dirty
Igor procedures for the analysis of PEARL data
|
@@ -38,18 +35,21 @@
data import/export procedures for multiple scattering calculations.
-Definition in file pearl-pmsco-import.ipf.
string load_pmsco_result | +( | +string | +pathname, | +
+ | + | string | +filename, | +
+ | + | variable | +quiet = defaultValue |
+
+ | ) | ++ |
load a PMSCO result file into the current data folder.
+result files have the extension dat or tasks.dat. this will overwrite existing waves. the function loads all columns.
+pathname | name of a symbolic path |
filename | file name |
quiet | (optional)
|
Definition at line 286 of file pearl-pmsco-import.ipf.
+ +string load_pmsco_scan | +( | +string | +pathname, | +
+ | + | string | +filename, | +
+ | + | variable | +is_modulation = defaultValue , |
+
+ | + | variable | +quiet = defaultValue |
+
+ | ) | ++ |
load a PMSCO scan file into the current data folder.
+the function loads all columns from the file. the waves are named with two-letter names according to the file extension. existing waves are overwritten.
+the file extension must be etpais
or a subset of it, e.g., etpi
. the wave names will be en
(energy), th
(theta), ph
(phi), al
(alpha), in
(intensity) or mo
(modulation), and si
(sigma).
pathname | name of igor symbolic path to destination folder. prompt user if empty. |
filename | requested file name. prompt user if empty. the extension must be a string of characters indicating the data of each column. it must be "etpais" or any substring of it, and the columns must be ordered accordingly. if the name contains .modf , the intensity wave is named as mo rather than in . this behaviour can be overridden by the is_modulation flag. |
is_modulation | select whether the intensity column is named mo rather than in .
|
quiet | (optional)
|
Definition at line 207 of file pearl-pmsco-import.ipf.
+ +Definition at line 188 of file pearl-pmsco-import.ipf.
+Definition at line 320 of file pearl-pmsco-import.ipf.
@@ -269,7 +392,7 @@ Licensed under the Apache License, Version 2.0 (the "License");Definition at line 88 of file pearl-pmsco-import.ipf.
+Definition at line 89 of file pearl-pmsco-import.ipf.
@@ -327,7 +450,7 @@ Licensed under the Apache License, Version 2.0 (the "License");helper function for save_pmsco_scan()
-Definition at line 126 of file pearl-pmsco-import.ipf.
+Definition at line 127 of file pearl-pmsco-import.ipf.
@@ -337,9 +460,9 @@ Licensed under the Apache License, Version 2.0 (the "License");Definition at line 10 of file pearl-polar-coordinates.ipf.
+Definition at line 11 of file pearl-polar-coordinates.ipf.
Definition at line 36 of file pearl-polar-coordinates.ipf.
+Definition at line 37 of file pearl-polar-coordinates.ipf.
Definition at line 48 of file pearl-polar-coordinates.ipf.
+Definition at line 49 of file pearl-polar-coordinates.ipf.
Definition at line 58 of file pearl-polar-coordinates.ipf.
+Definition at line 59 of file pearl-polar-coordinates.ipf.
Definition at line 69 of file pearl-polar-coordinates.ipf.
+Definition at line 70 of file pearl-polar-coordinates.ipf.
Functions | |
variable | psh5_open_file (string ANickName, string APathName, string AFileName) |
open a HDF5 file created by the PShell data acquisition program and prepare the data folder. More... | |
variable | psh5_close_file (variable fileID) |
close a HDF5 file opened by psh5_open_file. More... | |
string | psh5_load_complete (string ANickName, string APathName, string AFileName, variable load_data=defaultValue, variable load_attr=defaultValue) |
load everything from a PShell data file. More... | |
string | psh5_load_preview (string APathName, string AFileName, variable load_data=defaultValue, variable load_attr=defaultValue, string pref_scans=defaultValue, string pref_datasets=defaultValue) |
load a preview image from a PShell data file. More... | |
string | psh5_load_scan_complete (variable fileID, string scanpath, variable load_data=defaultValue, variable load_attr=defaultValue) |
load all data of a selected scan from a PShell data file. More... | |
string | psh5_list_scans (variable fileID) |
list scan groups of a PShell data file. More... | |
string | psh5_list_scan_datasets (variable fileID, string scanpath, variable include_regions=defaultValue) |
list datasets of a PShell scan group. More... | |
string | psh5_list_scan_regions (variable fileID, string scanpath) |
list regions of a PShell scan group. More... | |
string | psh5_load_scan_data (variable fileID, string scanpath) |
load all datasets of a PShell scan group. More... | |
string | psh5_load_scan_attrs (variable fileID, string scanpath, variable attr_sets=defaultValue) |
load attributes of a PShell scan group. More... | |
string | psh5_load_scan_meta (variable fileID, string scanpath) |
load metadata of a PShell scan group. More... | |
string | psh5_load_dataset (variable fileID, string scanpath, string datasetname, variable set_scale=defaultValue) |
load a dataset from an open PShell HDF5 file. More... | |
static string | select_dataset (string file_datasets, string pref_datasets) |
select the preferred dataset from a list of available datasets. More... | |
string | psh5_load_scan_preview (variable fileID, string scanpath, variable set_scale=defaultValue, string pref_datasets=defaultValue) |
load a preview dataset from an open PShell HDF5 file. More... | |
string | psh5_load_scan_section (variable fileID, string scanpath, variable dim, variable set_scale=defaultValue, string pref_datasets=defaultValue) |
load a longitudinal section of a scan from an open PShell HDF5 file. More... | |
variable | psh5_load_dataset_meta (variable fileID, string datapath, string datasetname, wave datawave) |
load metadata of a PShell dataset. More... | |
string | psh5_load_dataset_slabs (variable fileID, string datapath, string datasetname, variable progress=defaultValue) |
load a dataset slab-wise from the open PShell HDF5 file. More... | |
string | psh5_load_dataset_slab (variable fileID, string datapath, string datasetname, variable dim2start, variable dim2count, variable dim3start, variable dim3count) |
load a single image from the open PShell data file. More... | |
variable | ps_set_dimlabels (wave data) |
set dimension labels according to the axis type More... | |
variable | ps_set_dimlabels2 (wave data, string name) |
set dimension labels according to the axis type More... | |
static dfr | find_scan_folder (dfref dataDF) |
find the scan folder More... | |
static dfr | find_attr_folder (dfref dataDF) |
find the attributes data folder More... | |
variable | ps_scale_datasets () |
set the dimension scales of loaded PShell Scienta datasets according to attributes. More... | |
variable | ps_scale_dataset (wave data) |
set the dimension scales of a loaded PShell Scienta dataset according to attributes. More... | |
static wave | find_scale_wave (string name, dfref dataDF, dfref scanDF, dfref attrDF) |
variable | ps_detect_scale (wave ax, wave lo, wave hi, wave un) |
detect the dimension scales from attributes. More... | |
variable | ps_scale_dataset_2 (wave data, wave ax, wave lo, wave hi, wave un) |
set the dimension scales of a dataset. More... | |
string | psh5_load_reduced (string ANickName, string APathName, string AFileName, funcref reduction_func, string reduction_param, variable progress=defaultValue, variable nthreads=defaultValue) |
load and reduce the ScientaImage dataset of the first scan of a PShell data file. More... | |
string | psh5_load_dataset_reduced (variable fileID, string scanpath, string datasetname, funcref reduction_func, string reduction_param, variable progress=defaultValue, variable nthreads=defaultValue) |
load a reduced dataset from the open PShell HDF5 file. More... | |
static threadsafe variable | reduce_slab_worker (funcref reduction_func) |
static threadsafe wave | reduce_slab_image (wave slabdata, wave image, funcref reduction_func, string reduction_param) |
string | psh5_load_info (string APathName, string AFileName) |
load descriptive info from a PShell data file. More... | |
string | psh5_load_scan_info (variable fileID, string scanpath) |
load descriptive info from a PShell scan. More... | |
dfr | psh5_load (string path_name, string file_name, string scans, string regions, string datasets, variable classes=defaultValue, variable max_rank=defaultValue, string reduction_func=defaultValue, string reduction_params=defaultValue, dfref dest_df=defaultValue) |
main data loading function More... | |
dfr | psh5_preview (string path_name, string file_name, dfref dest_df=defaultValue, string preview_datasets=defaultValue) |
load preview More... | |
dfr | psh5_open_file (string path_name, string file_name, dfref dest_df=defaultValue) |
open a HDF5 file created by the PShell data acquisition program and prepare the data folder. More... | |
variable | psh5_close_file (dfref file_df) |
close a HDF5 file opened by psh5_open_file. More... | |
static string | twave2list (wave wt, string sep) |
convert text wave to list. More... | |
convert text wave to list. More... | |
static string | wave2list (wave w, string format, string sep) |
convert numeric wave to list. More... | |
convert numeric wave to list. More... | |
string | psh5_list_scans (variable file_id) |
list scan groups of a PShell data file. More... | |
string | psh5_list_all_datasets (variable file_id) |
list all datasets in a file More... | |
variable[string datatypes, string ranks, string dimensions] | psh5_list_dataset_info (string variable, string file_id, variable string, sds datasets) |
list data types and dimensions of datasets More... | |
string | psh5_filter_datasets_rank (string datasets, string ranks, variable min_rank, variable max_rank) |
filter datasets by rank More... | |
static string | unique_strings (string list) |
remove duplicate items from list More... | |
string | psh5_extract_scan_paths (string datasets) |
trim dataset paths to the scan part More... | |
string | psh5_extract_region_paths (string datasets) |
trim dataset paths to the scan/region part More... | |
string | psh5_match_dataset_classes (string datasets, variable classes, string positioners=defaultValue, string detectors=defaultValue) |
filter a list of datasets by classification More... | |
dfr | psh5_create_folders (string datasetpath) |
create all data folders along a dataset path More... | |
dfr | psh5_dataset_to_folder (dfref parent_df, string datasetpath) |
map dataset path to datafolder path More... | |
string | ps_fix_folder_name (string group_name) |
convert HDF5 group name to data folder name and fix compatibility issues More... | |
string | psh5_load_datasets (dfref file_df, string datasets, variable create_folders=defaultValue, string reduction_func=defaultValue, string reduction_params=defaultValue) |
load multiple datasets from open file More... | |
string | psh5_load_dataset (dfref file_df, string datasetpath, variable create_folders=defaultValue, string reduction_func=defaultValue, string reduction_params=defaultValue) |
load a dataset from an open PShell HDF5 file. More... | |
string | psh5_load_dataset_slabs (dfref file_df, string datasetpath, variable create_folders=defaultValue, variable progress=defaultValue) |
load a dataset slab-wise from the open PShell HDF5 file. More... | |
string | psh5_load_dataset_reduced (dfref file_df, string datasetpath, funcref reduction_func, string reduction_params, variable create_folders=defaultValue, variable progress=defaultValue, variable nthreads=defaultValue) |
load a dataset with reduced dimensionality More... | |
static threadsafe variable | reduce_slab_worker (funcref reduction_func) |
static threadsafe wave | reduce_slab_image (wave slabdata, wave image, funcref reduction_func, string reduction_params) |
string | psh5_load_general_group (dfref file_df) |
load organizational metadata from the general group. More... | |
string | psh_load_general_string (dfref file_df, string name) |
load a string from the general group. More... | |
variable | psh5_load_dataset_meta (dfref file_df, string datasetpath, wave datawave) |
load metadata of a PShell dataset. More... | |
string | psh5_load_scan_meta (dfref file_df, string scanpath) |
load metadata of a PShell scan group. More... | |
variable | ps_set_dimlabels (wave data) |
set dimension labels according to the axis type More... | |
variable | ps_set_dimlabels2 (wave data, string name) |
set dimension labels according to the axis type More... | |
dfr | ps_find_scan_folder (dfref data_df) |
find the scan folder of current data More... | |
dfr | ps_find_attr_folder (dfref scan_df) |
find the attributes data folder More... | |
wave | ps_find_scale_wave (string name, dfref df1, dfref df2, dfref df3) |
find a wave in scan and attr data folders More... | |
variable | ps_detect_scale (dfref data_df, wave ax, wave lo, wave hi, wave un) |
detect the dimension scales from attributes. More... | |
variable | ps_scale_dataset_2 (wave data, wave ax, wave lo, wave hi, wave un) |
set the dimension scales of a dataset. More... | |
variable | ps_scale_datasets (dfref scan_df) |
set the dimension scales of loaded PShell Scienta datasets according to attributes. More... | |
variable | ps_scale_dataset (wave data) |
set the dimension scales of a loaded PShell Scienta dataset according to attributes. More... | |
string | kill_matching_waves (dfref dfr, string pattern, variable recurse, string killed=defaultValue) |
kill any waves matching a pattern in the experiment More... | |
Variables | |
const string | kEnergyDimLabel = "energy" |
Dimension label for the energy dispersive dimension of multi-dimensional datasets. More... | |
Dimension label for the energy dispersive dimension of multi-dimensional datasets. More... | |
const string | kAngleDimLabel = "angle" |
Dimension label for the angle dispersive dimension of multi-dimensional datasets. More... | |
Dimension label for the angle dispersive dimension of multi-dimensional datasets. More... | |
const string | kScanDimLabel = "scan" |
Dimension label for the scan dimension of multi-dimensional datasets. More... | |
Dimension label for the scan dimension of multi-dimensional datasets. More... | |
const string | kDataDimLabel = "data" |
Dimension label for the data dimension. More... | |
Dimension label for the data dimension. More... | |
const string | kPreviewDatasets = "ScientaImage;ScientaSpectrum;ImageAngleDistribution;ImageEnergyDistribution;Counts;SampleCurrent;" |
List of preferred datasets to load for preview. More... | |
const string | kPreviewDatasets = "ImageEnergyDistribution;ScientaSpectrum;ScientaImage;Counts;SampleCurrent;" |
List of preferred datasets to load for preview. More... | |
const string | kScientaScalingDatasets = "LensMode;ScientaChannelBegin;ScientaChannelEnd;ScientaSliceBegin;ScientaSliceEnd;" |
List of datasets that must be loaded to determine the axis scaling of a Scienta image. More... | |
const string | kScientaScalingDatasets = "LensMode;ScientaChannelBegin;ScientaChannelEnd;ScientaSliceBegin;ScientaSliceEnd;Eph;" |
List of datasets that must be loaded to determine the axis scaling of a Scienta image. More... | |
const string | kEssentialDiagnostics = "ManipulatorX;ManipulatorY;ManipulatorZ;ManipulatorTheta;ManipulatorTilt;ManipulatorPhi;MonoEnergy;" |
List of diagnostic datasets that are normally loaded with a scan. More... | |
const string | kTransposedDatasets = "ScientaImage;" |
List of datasets that should be transposed upon loading. More... | |
List of datasets that must be transposed upon loading. More... | |
const variable | kDetectorSensitivity = 1 |
multiply scienta detector intensity by this value to get actual counts. More... | |
const variable | kDSCPositioners = 0x0001 |
const variable | kDSCDetectors = 0x0002 |
const variable | kDSCScientaScaling = 0x0004 |
const variable | kDSCPreview = 0x0008 |
const variable | kDSCEssentialDiags = 0x0010 |
const variable | kDSCAttrs = 0x0020 |
const variable | kDSCDiags = 0x0040 |
const variable | kDSCSnaps = 0x0080 |
const variable | kDSCMeta = 0x0100 |
const variable | kDSCMonitors = 0x0200 |
const variable | kDSCRegions = 0x0400 |
const variable | kDSCOther = 0x8000 |
const variable | kDSCAll = 0xffff |
import data from PShell
-HDF5 file import from the PShell data acquisition program. the main import functions are:
+HDF5 file import from the PShell data acquisition program.
+the module provides two main entry functions:
the following helper functions are also needed:
-Definition in file pearl-pshell-import.ipf.
|
- -static | -
find the attributes data folder
-this is the :attr folder.
- -Definition at line 1476 of file pearl-pshell-import.ipf.
- -
-
|
- -static | -
Definition at line 1564 of file pearl-pshell-import.ipf.
+kill any waves matching a pattern in the experiment
+this may be used to kill big waves of original data before saving.
+example: to kill all ScientaImage waves:
Definition at line 2554 of file pearl-pshell-import.ipf.
-
|
- -static | -
find the scan folder
-the scan folder is the one that contains the :attr folder the data and scan folders may refer to the same folder.
- -Definition at line 1459 of file pearl-pshell-import.ipf.
- -detect the dimension scales from attributes.
-the function checks the data , scan and attributes folders for scan parameters. the results are written to the provided waves. the function is normally called by ps_scale_datasets() but can also be used independently.
-the current datafolder must be the data or the scan folder. the data folder contains the waves that are to be scaled. the scan folder contains the scan positions and the :attr folder.
+the function checks the data , scan and attributes folders for scan parameters. the results are written to the provided waves. the function is normally called by ps_scale_datasets() but can also be used independently.
+the data folder contains the waves that are to be scaled. the function looks for the scan positions and diagnostics as necessary. if the scaling data is not found, the scales are not changed. the kEssentialDiags flag can be used with psh5_load() to select the necessary datasets.
the provided waves are redimensioned by the function, and dimension labels are set. the scale parameters can then be extracted by keyword, e.g.,
lo[%energy]
analyser energy dimension. lo[%angle]
analyser angle dimension. lo[%scan]
scan dimension. lo[%data]
data dimension.the function tries to read the following waves, in the data, scan, and attributes folders, where the first folder in the list takes precedence. it may fall back to more or less reasonable default values if no data is not found.
the function tries to read the following waves, in the data, scan, and attributes/diagnostics folders, where the first folder in the list takes precedence. it may fall back to more or less reasonable default values if no data is not found.
LensMode
ScientaChannelBegin
ScientaChannelEnd
data_df | data folder which contains the waves to be scaled. this is usually the "scan" or "region" folder. |
ax | text wave to receive the axis labels. |
lo | wave to receive the lower limits. |
hi | wave to receive the upper limits. |
Definition at line 1621 of file pearl-pshell-import.ipf.
+Definition at line 2225 of file pearl-pshell-import.ipf.
+ +dfr ps_find_attr_folder | +( | +dfref | +scan_df | ) | ++ |
find the attributes data folder
+the attributes folder contains diagnostic beamline data at each scan point. the folder can have one of several names due to different pshell versions: "attr", "attrs", or "diags" (from 2022 on). historically, the folder was named "attr" due to the area detector software.
+assuming we are in the scan folder (where the ScanWritables, etc.) are, find the associated attributes folder.
+ +Definition at line 2134 of file pearl-pshell-import.ipf.
+ +wave ps_find_scale_wave | +( | +string | +name, | +
+ | + | dfref | +df1, | +
+ | + | dfref | +df2, | +
+ | + | dfref | +df3 | +
+ | ) | ++ |
find a wave in scan and attr data folders
+look up a wave by name in the given three data folders. return the first one found.
+df1 | first data folder to check |
df2 | second data folder to check |
df3 | third data folder to check |
Definition at line 2161 of file pearl-pshell-import.ipf.
+ +dfr ps_find_scan_folder | +( | +dfref | +data_df | ) | ++ |
find the scan folder of current data
+assuming we are in the data folder (where the scan results, ScientaSpectrum, etc.) are, find the associated scan folder. this can either be the same (usually) or the parent folder (multi-region scans).
+the scan folder is the one that contains the ScanWritables wave. the data and scan folders may refer to the same folder.
+ +Definition at line 2111 of file pearl-pshell-import.ipf.
+ +string ps_fix_folder_name | +( | +string | +group_name | ) | ++ |
convert HDF5 group name to data folder name and fix compatibility issues
+ +Definition at line 1065 of file pearl-pshell-import.ipf.
set the dimension scales of a loaded PShell Scienta dataset according to attributes.
the current datafolder must contain the :attr folder. the data wave can be in the current folder or a sub-folder.
-the dimension labels of the dataset waves must have been set correctly, e.g. by ps_set_dimlabels(). this is implicitly done by the high-level load functions.
-the function is useful if a single dataset is loaded and scaled. if multiple datasets are loaded, ps_scale_datasets() is slightly more efficient.
+the dimension labels of the dataset waves must have been set correctly, e.g. by ps_set_dimlabels(). this is implicitly done by the high-level load functions.
+the function is useful if a single dataset is loaded and scaled. if multiple datasets are loaded, ps_scale_datasets() is slightly more efficient.
data | data wave to be scaled. dimension labels (index -1) must be set correctly, cf. ps_set_dimlabels(). |
data | data wave to be scaled. dimension labels (index -1) must be set correctly, cf. ps_set_dimlabels(). |
Definition at line 1550 of file pearl-pshell-import.ipf.
+Definition at line 2528 of file pearl-pshell-import.ipf.
@@ -526,8 +616,8 @@ Licensed under the Apache License, Version 2.0 (the "License");set the dimension scales of a dataset.
-the function is normally called by ps_scale_datasets() but can also be used independently. the limits and units must be given as function arguments with proper dimension labels.
-the provided limit and unit waves must have dimension labels matching the -1 index dimension labels of the data wave, such as set by the ps_detect_scale() function. the scale parameters are extracted by keyword, e.g.,
the function is normally called by ps_scale_datasets() but can also be used independently. the limits and units must be given as function arguments with proper dimension labels.
+the provided limit and unit waves must have dimension labels matching the -1 index dimension labels of the data wave, such as set by the ps_detect_scale() function. the scale parameters are extracted by keyword, e.g.,
lo[%energy]
analyser energy dimension. lo[%angle]
analyser angle dimension. lo[%scan]
scan dimension. Definition at line 1781 of file pearl-pshell-import.ipf.
+Definition at line 2389 of file pearl-pshell-import.ipf.
set the dimension scales of loaded PShell Scienta datasets according to attributes.
datasets listed in the ScanReadables waves are scaled according to the attribute waves in the data, scan, and attributes folders, whichever is found first.
-the current datafolder must contain the ScanReadables wave and the :attr folder. the ScanReadables text wave contains names of the waves to scale. wave names can include a relative path to a sub-folder. the path separator is "/".
-the dimension labels of the dataset waves must have been set correctly, e.g. by ps_set_dimlabels(). this is implicitly done by the high-level load functions.
-the specified datafolder must contain the ScanReadables wave and the :attr folder. the ScanReadables text wave contains names of the waves to scale. wave names can include a relative path to a sub-folder. the path separator is "/".
+the dimension labels of the dataset waves must have been set correctly, e.g. by ps_set_dimlabels(). this is implicitly done by the high-level load functions.
+scan_df | scan data folder. must contain the ScanReadables wave. |
Definition at line 1504 of file pearl-pshell-import.ipf.
+Definition at line 2483 of file pearl-pshell-import.ipf.
Definition at line 1383 of file pearl-pshell-import.ipf.
+Definition at line 2031 of file pearl-pshell-import.ipf.
@@ -638,7 +734,7 @@ Licensed under the Apache License, Version 2.0 (the "License");set dimension labels according to the axis type
-same as ps_set_dimlabels() except that the dimension labels are set according to a separate name argument instead of the wave name.
+same as ps_set_dimlabels() except that the dimension labels are set according to a separate name argument instead of the wave name.
data | data wave as loaded from PShell file. | |||||||
variable psh5_close_file | ( | -variable | -fileID | ) | +dfref | +file_df | ) |
close a HDF5 file opened by psh5_open_file.
this function just closes the HDF5 file. no change is made to the loaded data.
+the function requires the specified data folder to contain a variable named file_id
that specifies the HDF5 file ID. the variable may also be in a parent folder. the variable is killed after the file has been closed. if the folder or variable can't be found, the function does nothing.
fileID | ID of open HDF5 file from psh5_open_file(). |
file_df | data folder reference of open HDF5 file from psh5_open_file(). the reference may also point to a child folder, the function will look for a file_id variable in all parent folders. |
$"foldername"
. the current folder is written as $":"
. Definition at line 140 of file pearl-pshell-import.ipf.
+Definition at line 509 of file pearl-pshell-import.ipf.
string psh5_list_scan_datasets | +dfr psh5_create_folders | ( | -variable | -fileID, | +string | +datasetpath | ) | ++ |
create all data folders along a dataset path
+if the path ends with a slash, the path is interpreted as a group path, and each part is mapped to a data folder. else, the last part of the path is the name of a dataset and will not produce a folder.
+the path will always be interpreted as starting from the root, regardless whether it starts with a slash or not.
+spaces are removed from folder names, and the names are cleaned up to produce simple names.
+a string variable named "s_hdf5_group" is added to each created folder and contains the incremental path.
+the first child folder is created in the current data folder. at the end, the lowest child folder is selected and returned as the function result.
+datasetpath | hdf5 group path to dataset, e.g. "/scan 1/region 1/ScientaImage". |
Definition at line 990 of file pearl-pshell-import.ipf.
+ +dfr psh5_dataset_to_folder | +( | +dfref | +parent_df, | |
string | -scanpath, | -|||
- | - | variable | -include_regions = defaultValue |
+ datasetpath |
@@ -718,40 +844,116 @@ Licensed under the Apache License, Version 2.0 (the "License"); |
list datasets of a PShell scan group.
-the function returns a list of all datasets of the selected scan. this does not include datasets from the attributes sub-group.
-map dataset path to datafolder path
+if the path ends with a slash, the path is interpreted as a group path, and each part maps to a data folder. if the last part of the path is the name of a dataset, it is discarded.
+spaces are removed from folder names, and the names are cleaned up to produce simple names.
+the path is interpreted as relative to the specified parent data folder. regardless whether it starts with a slash or not.
fileID | ID of open HDF5 file from psh5_open_file(). |
scanpath | path to the scan group in the HDF5 file, e.g. "/scan 1". |
datasetpath | hdf5 group path to dataset, e.g. "/scan 1/region 1/ScientaImage". |
parent_df | parent data folder |
Definition at line 440 of file pearl-pshell-import.ipf.
+Definition at line 1034 of file pearl-pshell-import.ipf.
string psh5_list_scan_regions | +string psh5_extract_region_paths | ( | -variable | -fileID, | +string | +datasets | ) | ++ |
trim dataset paths to the scan/region part
+return dataset paths stripped to the form /scan*/region*/.
+the function matches each path for scan and region tokens in the first two path elements and strips off the remainder. if there are no region-based datasets, the function returns an empty string.
+the function operates on a single path or a semicolon-separated list of paths. the items of the returned list are unique.
+datasets | semicolon separated list of dataset paths |
Definition at line 853 of file pearl-pshell-import.ipf.
+ +string psh5_extract_scan_paths | +( | +string | +datasets | ) | ++ |
trim dataset paths to the scan part
+return dataset paths stripped to the form /scan*/.
+the function matches each path for a scan token in the first path element and strips off the remaining path. if there are no scan-based datasets, the function returns an empty string.
+the function operates on a single path or a semicolon-separated list of paths. the items of the returned list are unique.
+datasets | semicolon separated list of dataset paths |
Definition at line 803 of file pearl-pshell-import.ipf.
+ +string psh5_filter_datasets_rank | +( | +string | +datasets, | |
string | -scanpath | +ranks, | +||
+ | + | variable | +min_rank, | +|
+ | + | variable | +max_rank | |
@@ -761,23 +963,123 @@ Licensed under the Apache License, Version 2.0 (the "License"); |
list regions of a PShell scan group.
-the function returns a list of all region groups of the selected scan.
+filter datasets by rank
fileID | ID of open HDF5 file from psh5_open_file(). |
scanpath | path to the scan group in the HDF5 file, e.g. "/scan 1". |
datasets | semicolon-separated list of datasets to be checked. |
ranks | semicolon-separated list of ranks of each dataset. |
Definition at line 481 of file pearl-pshell-import.ipf.
+Definition at line 728 of file pearl-pshell-import.ipf.
string psh5_list_all_datasets | +( | +variable | +file_id | ) | ++ |
list all datasets in a file
+the function returns a list of all datasets in a file. each dataset is listed by its full path like, e.g., "/scan 1/region 1/dataset 1".
+this function wraps a one-line HDF5 operation and is provided just to be more memorable.
+file_id | ID of open HDF5 file from psh5_open_file(). |
Definition at line 605 of file pearl-pshell-import.ipf.
+ +variable [string datatypes, string ranks, string dimensions] psh5_list_dataset_info | +( | +string | +variable, | +
+ | + | string | +file_id, | +
+ | + | variable | +string, | +
+ | + | sds | +datasets | +
+ | ) | ++ |
list data types and dimensions of datasets
+this function has multiple returns.
+file_id | ID of open HDF5 file from psh5_open_file(). |
filter a list of datasets by string matching
+this function can be used to extract certain dataset paths from a list of all datasets in a file. the matching is insensitive to spaces and case.
+examples match strings:
"*‍/scan1/region1/*"
match all datasets in scan 1, region 1"!*‍/diags/*"
remove diagnostics from listdatasets | semicolon separated list of dataset paths |
match | match string for igor's StringMatch function |
Definition at line 631 of file pearl-pshell-import.ipf.
+ +the function returns a list of all top-level groups whose name starts with "scan".
fileID | ID of open HDF5 file from psh5_open_file(). |
file_id | ID of open HDF5 file from psh5_open_file(). |
Definition at line 405 of file pearl-pshell-import.ipf.
+Definition at line 574 of file pearl-pshell-import.ipf.
string psh5_load_complete | +dfr psh5_load | ( | string | -ANickName, | +path_name, |
string | -APathName, | +file_name, | |||
string | -AFileName, | +scans, | +|||
+ | + | string | +regions, | +||
+ | + | string | +datasets, | ||
variable | -load_data = defaultValue , |
+ classes = defaultValue , |
|||
variable | -load_attr = defaultValue |
+ max_rank = defaultValue , |
+ |||
+ | + | string | +reduction_func = defaultValue , |
+ ||
+ | + | string | +reduction_params = defaultValue , |
+ ||
+ | + | dfref | +dest_df = defaultValue |
||
@@ -850,37 +1182,39 @@ Licensed under the Apache License, Version 2.0 (the "License"); |
load everything from a PShell data file.
+main data loading function
+load the requested elements from the given file.
+scans, regions and datasets are additive. wildcards can be used to select multiple or all datasets.
+classes are subtractive: only datasets of specified classes are loaded. by default, only positioners, detectors, scaling and essential diagnostics are loaded.
+essential diags, scaling, positioners related to requested detectors are always loaded
+data reduction (if specified) applies to 3d data, see psh5_load_dataset_reduced() for details.
ANickName | destination folder name (top level under root) |
APathName | igor symbolic path name. can be empty if the path is specified in FileName or a dialog box should be displayed |
AFileName | if empty a dialog box shows up |
load_data | select whether datasets (positioners and detectors) are loaded.
|
load_attr | select whether attributes (auxiliary device readbacks) are loaded. for proper wave scaling, the attributes must be loaded.
|
path_name | igor symbolic path name. can be empty if the path is specified in file_name or a dialog box should be displayed |
file_name | if empty a dialog box shows up |
dest_df | destination folder reference. if dest_df is specified, data is loaded into this folder. else, a new folder derived from the file name is created under root: |
scans | semicolon-separated list of scan paths to load. scan groups are at the top level, their name consists of "scan", an optional space and a number. all datasets in the group and sub-groups are considered for loading unless excluded by other arguments. if empty, no datasets are loaded based on their relation to a scan. names are matched by Igor's StringMatch function. the matching is insensitive to case and spaces. to load all scans, pass "/scan*". the leading slash before "scan" can be omitted. |
regions | semicolon-separated list of region paths to load. region groups are children of scan groups, their name consists of "region", an optional space and a number. all datasets in the group and sub-groups are considered for loading unless excluded by other arguments. if empty, no datasets are loaded based on their relation to a region. names are matched by Igor's StringMatch function. the matching is insensitive to case and spaces. to load all regions of scan 1, pass "/scan1/region*". to load regions 1 of all scans, pass "/scan*‍/region1". the leading slash before "scan" can be omitted. |
datasets | semicolon-separated list of dataset paths to load. this allows to load individual datasets. names are matched by Igor's StringMatch function against full dataset paths. to load all datasets named "SampleCurrent", pass "*‍/SampleCurrent". the matching is insensitive to case and spaces. additional datasets may be loaded for scaling. |
classes | filter datasets (that were selected by the scans, regions and datasets arguments) by class. this allows, for example, to exclude the diagnostics. note that scaling datasets are always loaded. the value is a bit-wise switch, typically the arithmetic disjunction of kDSCXxxx constants. by default, only positioners, detectors, scaling and essential diagnostics are loaded. to completely load all datasets, specify kDSCAll. |
max_rank | load only datasets with lower or equal rank. |
Definition at line 170 of file pearl-pshell-import.ipf.
+Definition at line 158 of file pearl-pshell-import.ipf.
defaultValue
defaultValue
, defaultValue
, defaultValue
load a dataset from an open PShell HDF5 file.
-if the dataset has a maximum of two dimensions, the function loads it at once. if it has more than two dimension, the function calls psh5_load_dataset_slabs() to load the data slab by slab.
+if the dataset has a maximum of two dimensions, the function loads it at once. if it has more than two dimension, the function calls psh5_load_dataset_slabs() to load the data slab by slab.
set_scale
option is selected (default). the attributes must be loaded by psh5_load_scan_meta() and psh5_load_scan_attrs() (attr_sets=2).the dataset is loaded into the current data folder unless datasetname contains a region specifier. in the latter case, the dataset is loaded into sub-folder with the name of the region. the function returns from the original data folder.
+the dataset is loaded into the current data folder or a tree based on the group path given in the datasetpath argument. the function returns from the original data folder.
+only numeric and string data types are supported, string datasets must have rank 1.
fileID | ID of open HDF5 file from psh5_open_file(). |
scanpath | path to the scan group in the HDF5 file, e.g. "/scan 1". |
datasetname | name of the dataset. the name of the loaded wave is a cleaned up version of the dataset name. the name can include the region name as a relative path, e.g. "region1/ScientaSpectrum". in this case, the dataset is loaded into a sub-folder named "region1". |
set_scale | by default, the function tries to set the wave scaling if the attributes have been loaded. if multiple datasets are loaded from a file, it is more efficient to set the scaling of all loaded datasets at the end by calling ps_scale_datasets().
|
file_df | data folder reference of open HDF5 file from psh5_open_file(). if undefined, the current datafolder is assumed. |
datasetpath | group path and name of the dataset, e.g. "/scan 1/ScientaImage". HDF5 groups map to igor data folders below the current data folder, the wave is placed into the leaf folder. the names of groups and waves are cleaned up to produce simple names, in particular, spaces and other illegal characters are removed. |
create_folders | if 1 (default), data folders according to the group path are created. if 0, the dataset is loaded into the current folder. |
reduction_func | data reduction function. three-dimensional datasets can be reduced in dimensionality by on-the-fly data reduction. by default (or if empty string), no reduction is applied. see psh5_load_dataset_reduced(). |
reduction_params | parameter string for the reduction function. |
Definition at line 706 of file pearl-pshell-import.ipf.
+Definition at line 1176 of file pearl-pshell-import.ipf.
load metadata of a PShell dataset.
-"metadata" are the HDF5 attributes attached to the scan dataset.
-data is added to the wave note.
+metadata are the HDF5 attributes attached to a dataset. they are mapped to "key=value" pairs and added to the wave note in separate lines. the following attributes are loaded. names and mappings are hard-coded.
+fileID | ID of open HDF5 file from psh5_open_file(). |
datapath | path to the containing group in the HDF5 file. path separator is the slash "/". |
datasetname | name of the dataset. may include relative path. |
file_df | data folder reference of open HDF5 file from psh5_open_file(). if undefined, the current datafolder is assumed. |
datasetpath | group path and name of the dataset. path separator is the slash "/". |
datawave | metadata is added to the wave note of this wave. |
Definition at line 1091 of file pearl-pshell-import.ipf.
+Definition at line 1887 of file pearl-pshell-import.ipf.
defaultValue
, load a reduced dataset from the open PShell HDF5 file.
-the function loads the dataset image by image using the hyperslab option and applies a custom reduction function to each image. the results from the reduction function are written to the ReducedData1
, ReducedData2
, etc. waves. the raw data are discarded.
by default, the reduction function is called in separate threads to reduce the total loading time. (see the global variable psh5_perf_secs which reports the total run time of the function.) the effect varies depending on the balance between file loading (image size) and data processing (complexity of the reduction function). for debugging the reduction function, multi-threading can be disabled.
-if the reduction function requires the image waves to be scaled properly, the attributes must have been loaded by psh5_load_scan_attrs() before. in this case, the scales of the result waves are also set by the function. otherwise, the results can also be scaled by ps_scale_dataset() later.
+load a dataset with reduced dimensionality
+the function loads the dataset image by image using the hyperslab option and applies a custom reduction function like numeric integration, curve fitting, etc. to each image. the results from the reduction function are written to the ReducedData1
, ReducedData2
, etc. waves. the raw data are discarded.
example reduction functions can be found in the PearlScientaPreprocess module. they must implement the adh5_default_reduction() interface.
+by default, the reduction function is called in separate threads to reduce the total loading time. (psh5_load() reports the total run time in the global variable psh5_perf_secs.) the effect varies depending on the balance between file loading (image size) and data processing (complexity of the reduction function).
+the function loads images (as hyperslabs) one by one and passes them to the reduction function. only a limited number of images are held in the queue at a time to limit memory use. for debugging the reduction function, multi-threading can be disabled (also remove threadsafe attributes from reduce_slab_image() and the reduction function!)
+if the reduction function requires the image waves to be scaled properly, the attributes must have been loaded by psh5_load_scan_attrs() before. in this case, the scales of the result waves are also set by the function. otherwise, the results can also be scaled by ps_scale_dataset() later.
fileID | ID of open HDF5 file from psh5_open_file(). |
file_df | data folder reference of open HDF5 file from psh5_open_file(). if undefined, the current datafolder is assumed. |
scanpath | path to scan group in the HDF5 file. |
datasetname | name of the dataset. this must currently be "ScientaImage", other data is not supported. the name of the loaded wave is a cleaned up version of the dataset name. the name can include the region name as a relative path, e.g. "region1/ScientaImage". in this case, the dataset is loaded into a sub-folder named "region1". |
reduction_func | custom data reduction function. this can be any user-defined function which has the same parameters as adh5_default_reduction. some reduction functions are predefined in the PearlScientaPreprocess module. |
reduction_param | parameter string for the reduction function. |
reduction_params | parameter string for the reduction function. |
create_folders | if 1 (default), data folders according to the group path are created. if 0, the dataset is loaded into the current folder. |
progress | progress window.
|
ReducedData1
, ReducedData2
, etc. if successful. auxiliary waves, scan positions, attributes are loaded but not listed in the string. empty string if an error occurred. error messages are printed to the history.ReducedData1
, ReducedData2
, etc. if successful. auxiliary waves, scan positions, attributes are loaded but not listed in the string. empty string if an error occurred. error messages are printed to the history. Definition at line 2040 of file pearl-pshell-import.ipf.
+Definition at line 1472 of file pearl-pshell-import.ipf.
string psh5_load_dataset_slab | -( | -variable | -fileID, | -
- | - | string | -datapath, | -
- | - | string | -datasetname, | -
- | - | variable | -dim2start, | -
- | - | variable | -dim2count, | -
- | - | variable | -dim3start, | -
- | - | variable | -dim3count | -
- | ) | -- |
load a single image from the open PShell data file.
-the function can average over a region in the extra dimensions.
-fileID | ID of open HDF5 file from psh5_open_file(). |
datapath | path to the containing group in the HDF5 file. path separator is the slash "/". |
dataset | name of the dataset. also defines the name of the loaded wave. |
dim2start | 2nd dimension coordinate of the first image set to 0 if dimension may not be present |
dim2count | number of subsequent images to average set to 1 if dimension may not be present |
dim3start | 3rd dimension coordinate of the first image set to 0 if dimension may not be present |
dim3count | number of subsequent images to average set to 1 if dimension may not be present |
Definition at line 1284 of file pearl-pshell-import.ipf.
- -defaultValue
, load a dataset slab-wise from the open PShell HDF5 file.
-the function loads the dataset image by image using the hyperslab option.
+the function loads the dataset image by image using the hyperslab option. the wave is loaded into the current data folder.
fileID | ID of open HDF5 file from psh5_open_file(). |
datapath | path to the containing group in the HDF5 file. path separator is the slash "/". |
dataset | name of the dataset. also defines the name of the loaded wave. |
file_df | data folder reference of open HDF5 file from psh5_open_file(). if undefined, the current datafolder is assumed. |
datasetpath | group path and name of the dataset. the dataset name defines the name of the loaded wave (after cleaning up). |
progress | select whether a progress window is displayed during the process.
|
create_folders | if 1 (default), data folders according to the group path are created. if 0, the dataset is loaded into the current folder. |
Definition at line 1148 of file pearl-pshell-import.ipf.
+Definition at line 1289 of file pearl-pshell-import.ipf.
string psh5_load_info | +string psh5_load_datasets | ( | -string | -APathName, | +dfref | +file_df, |
string | -AFileName | +datasets, | +||||
+ | + | variable | +create_folders = defaultValue , |
+ |||
+ | + | string | +reduction_func = defaultValue , |
+ |||
+ | + | string | +reduction_params = defaultValue |
|||
@@ -1250,393 +1527,55 @@ global string s_scanpaths in new data folder contains a list of scan groups insi |
load descriptive info from a PShell data file.
-the info string lists the following information for each scan contained in the file:
load multiple datasets from open file
APathName | igor symbolic path name. can be empty if the path is specified in AFileName or a dialog box should be displayed |
AFileName | if empty a dialog box shows up |
file_df | data folder reference of open HDF5 file from psh5_open_file(). if undefined, the current datafolder is assumed. |
create_folders | if 1 (default), data folders according to the group path are created. if 0, the dataset is loaded into the current folder. the latter option should be used with care because datasets with same names may be overwritten. |
reduction_func | data reduction function. three-dimensional datasets can be reduced in dimensionality by on-the-fly data reduction. by default (or if empty string), no reduction is applied. see psh5_load_dataset_reduced(). |
reduction_params | parameter string for the reduction function. |
Definition at line 2367 of file pearl-pshell-import.ipf.
+Definition at line 1098 of file pearl-pshell-import.ipf.
string psh5_load_preview | +string psh5_load_general_group | ( | -string | -APathName, | -||
+ | dfref | +file_df | ) | - | string | -AFileName, | -
- | - | variable | -load_data = defaultValue , |
- |||
- | - | variable | -load_attr = defaultValue , |
- |||
- | - | string | -pref_scans = defaultValue , |
- |||
- | - | string | -pref_datasets = defaultValue |
- |||
- | ) | -
load a preview image from a PShell data file.
-the data wave is loaded into the current data folder. attributes are loaded into the attr subfolder. existing waves in attr are deleted.
+load organizational metadata from the general group.
+the general group contains the following datasets: authors, pgroup, proposal, proposer, sample.
+data is loaded into the current data folder. all items are loaded into strings, authors is a comma-separated list. missing items default to empty strings.
APathName | igor symbolic path name. can be empty if the path is specified in FileName or a dialog box should be displayed |
AFileName | if empty a dialog box shows up |
load_data | 1 (default): load data; 0: do not load data |
load_attr | 1 (default): load attributes; 0: do not load attributes note: for correct scaling of the image, the attributes need to be loaded |
pref_scans | semicolon-separated list of preferred scans. the items of the list are match strings for the Igor StringMatch function. the first matching scan (i.e. top-level HDF5 group with a matching name) is loaded from the file. if no match is found, the first scan is loaded. |
pref_datasets | semicolon-separated list of preferred datasets. the items of the list are match strings for the Igor StringMatch function. the first matching dataset is loaded from the file. if no match is found, the first dataset listed in the file is loaded. |
file_df | data folder reference of open HDF5 file from psh5_open_file(). if undefined, the current datafolder is assumed. |
Definition at line 251 of file pearl-pshell-import.ipf.
+Definition at line 1803 of file pearl-pshell-import.ipf.
string psh5_load_reduced | -( | -string | -ANickName, | -
- | - | string | -APathName, | -
- | - | string | -AFileName, | -
- | - | funcref | -reduction_func, | -
- | - | string | -reduction_param, | -
- | - | variable | -progress = defaultValue , |
-
- | - | variable | -nthreads = defaultValue |
-
- | ) | -- |
load and reduce the ScientaImage dataset of the first scan of a PShell data file.
-the resulting dataset is reduced in one image dimension by a user-defined reduction function, e.g. by region-of-interest integration, curve fitting, etc. cf. adh5_default_reduction for further details.
-the function loads the dataset image by image using the hyperslab option and applies a custom reduction function to each image. the results from the reduction function are composed into one result wave. the raw data are discarded.
-if the data is from the electron analyser driver and some special attributes are included, the function will set the scales of the image dimensions.
-by default, the reduction function is called in separate threads to reduce the total loading time. (see the global variable psh5_perf_secs which reports the total run time of the function.) the effect varies depending on the balance between file loading (image size) and data processing (complexity of the reduction function). for debugging the reduction function, multi-threading can be disabled.
-ANickName | destination folder name (top level under root). |
APathName | igor symbolic path name. can be empty if the path is specified in FileName or a dialog box should be displayed. |
AFileName | if empty a dialog box shows up. |
reduction_func | custom data reduction function. this can be any user-defined function which has the same parameters as adh5_default_reduction. some reduction functions are predefined in the PearlScientaPreprocess module. |
reduction_param | parameter string for the reduction function. |
progress | progress window.
|
nthreads |
|
ReducedData1
, ReducedData2
, etc. if successful. auxiliary waves, scan positions, attributes are loaded but not listed in the string. empty string if an error occurred. error messages are printed to the history.Definition at line 1911 of file pearl-pshell-import.ipf.
- -string psh5_load_scan_attrs | -( | -variable | -fileID, | -
- | - | string | -scanpath, | -
- | - | variable | -attr_sets = defaultValue |
-
- | ) | -- |
load attributes of a PShell scan group.
-"attributes" are the auxiliary data inside the attrs group. do not confuse with HDF5 attributes! HDF5 attributes are loaded by the psh5_load_scan_meta() function.
-data is loaded into the current data folder. this should normally be the :attr
folder inside the respective scan folder.
fileID | ID of open HDF5 file from psh5_open_file(). |
scanpath | path to the scan group in the HDF5 file, e.g. "/scan 1". |
attr_sets | specify the attribute sets to be loaded. this value can be an arithmetic OR of the following constants. by default, all attributes are loaded.
|
Definition at line 554 of file pearl-pshell-import.ipf.
- -string psh5_load_scan_complete | -( | -variable | -fileID, | -
- | - | string | -scanpath, | -
- | - | variable | -load_data = defaultValue , |
-
- | - | variable | -load_attr = defaultValue |
-
- | ) | -- |
load all data of a selected scan from a PShell data file.
-data is loaded into the current data folder. attribute datasets are loaded into sub-folder attr
. region datasets are loaded into region sub-folders. existing data, if present, is overwritten.
fileID | ID of open HDF5 file from psh5_open_file(). |
scanpath | path to the scan group in the HDF5 file, e.g. "/scan 1". |
load_data | select whether datasets (positioners and detectors) are loaded.
|
load_attr | select whether attributes (auxiliary device readbacks) are loaded. for proper wave scaling, the attributes must be loaded.
|
Definition at line 361 of file pearl-pshell-import.ipf.
- -string psh5_load_scan_data | -( | -variable | -fileID, | -
- | - | string | -scanpath | -
- | ) | -- |
load all datasets of a PShell scan group.
-data is loaded into the current data folder. region datasets are loaded into the respective region sub-folders.
-this function does not scale the datasets. call ps_scale_datasets() separately.
-fileID | ID of open HDF5 file from psh5_open_file(). |
scanpath | path to the scan group in the HDF5 file, e.g. "/scan 1". |
Definition at line 514 of file pearl-pshell-import.ipf.
- -string psh5_load_scan_info | -( | -variable | -fileID, | -
- | - | string | -scanpath | -
- | ) | -- |
load descriptive info from a PShell scan.
-the info string contains up to three lines which are made up of the following information:
fileID | ID of open HDF5 file from psh5_open_file(). |
scanpath | path to scan group in the HDF5 file. |
Definition at line 2414 of file pearl-pshell-import.ipf.
- -data is loaded into the current data folder.
fileID | ID of open HDF5 file from psh5_open_file(). |
file_df | data folder reference of open HDF5 file from psh5_open_file(). if undefined, the current datafolder is assumed. |
scanpath | path to the scan group in the HDF5 file, e.g. "/scan 1". |
Definition at line 625 of file pearl-pshell-import.ipf.
+Definition at line 1954 of file pearl-pshell-import.ipf.
- -string psh5_load_scan_preview | +string psh5_match_dataset_classes | ( | -variable | -fileID, | -
- | string | -scanpath, | +datasets, | |
variable | -set_scale = defaultValue , |
+ classes, | ||
string | -pref_datasets = defaultValue |
+ positioners = defaultValue , |
+ ||
+ | + | string | +detectors = defaultValue |
|
@@ -1725,117 +1664,43 @@ global string s_scanpaths in new data folder contains a list of scan groups insi |
load a preview dataset from an open PShell HDF5 file.
-if the dataset has a maximum of two dimensions, the function loads it at once. if it has more than two dimension, the function selects and loads one two-dimensional slab.
+filter a list of datasets by classification
fileID | ID of open HDF5 file from psh5_open_file(). |
scanpath | path to the scan group in the HDF5 file, e.g. "/scan 1". |
set_scale | by default, the function tries to set the wave scaling if the attributes have been loaded. if multiple datasets are loaded from a file, it is more efficient to set the scaling of all loaded datasets at the end by calling ps_scale_datasets().
|
pref_datasets | semicolon-separated list of preferred datasets. the items of the list are match strings for the Igor StringMatch function. the first matching dataset is loaded from the file. if no match is found, the first dataset listed in the file is loaded. if empty, a hard-coded default preference list is used. |
datasets | semicolon separated list of dataset paths |
classes | dataset classes. arithmetic OR of the kDSCXxxx constants. |
Definition at line 840 of file pearl-pshell-import.ipf.
+Definition at line 899 of file pearl-pshell-import.ipf.
string psh5_load_scan_section | -( | -variable | -fileID, | -
- | - | string | -scanpath, | -
- | - | variable | -dim, | -
- | - | variable | -set_scale = defaultValue , |
-
- | - | string | -pref_datasets = defaultValue |
-
- | ) | -- |
load a longitudinal section of a scan from an open PShell HDF5 file.
-the dataset must have three dimensions.
-fileID | ID of open HDF5 file from psh5_open_file(). |
scanpath | path to the scan group in the HDF5 file, e.g. "/scan 1". |
dim | reserved, must be 0. |
set_scale | by default, the function tries to set the wave scaling if the attributes have been loaded. if multiple datasets are loaded from a file, it is more efficient to set the scaling of all loaded datasets at the end by calling ps_scale_datasets().
|
pref_datasets | semicolon-separated list of preferred datasets. the items of the list are match strings for the Igor StringMatch function. the first matching dataset is loaded from the file. if no match is found, the first dataset listed in the file is loaded. if empty, a hard-coded default preference list is used. |
Definition at line 953 of file pearl-pshell-import.ipf.
- -variable psh5_open_file | +dfr psh5_open_file | ( | string | -ANickName, | +path_name, | ||||||||||||||||||||||||||||||||||||||||||||||
string | -APathName, | +file_name, | |||||||||||||||||||||||||||||||||||||||||||||||||
- | string | -AFileName | +dfref | +dest_df = defaultValue |
|||||||||||||||||||||||||||||||||||||||||||||||
@@ -1846,28 +1711,117 @@ global string s_scanpaths in new data folder contains a list of scan groups insi |
ANickName | destination folder name (top level under root). |
APathName | igor symbolic path name. can be empty if the path is specified in FileName or a dialog box should be displayed |
AFileName | if empty a dialog box shows up |
path_name | igor symbolic path name. can be empty if the path is specified in FileName or a dialog box should be displayed |
file_name | if empty a dialog box shows up |
dest_df | destination folder reference. if dest_df is specified, data is loaded into this folder. else, by default, a new folder derived from the file name is created in root: |
Definition at line 110 of file pearl-pshell-import.ipf.
+Definition at line 450 of file pearl-pshell-import.ipf.
dfr psh5_preview | +( | +string | +path_name, | +
+ | + | string | +file_name, | +
+ | + | dfref | +dest_df = defaultValue , |
+
+ | + | string | +preview_datasets = defaultValue |
+
+ | ) | ++ |
load preview
+load information about the file structure and a preview dataset
+ +Definition at line 345 of file pearl-pshell-import.ipf.
+ +string psh_load_general_string | +( | +dfref | +file_df, | +
+ | + | string | +name | +
+ | ) | ++ |
load a string from the general group.
+the general group contains the following datasets: authors, pgroup, proposal, proposer, sample.
+data is loaded into a global string in the current data folder. arrays with multiple items are loaded into a comma-separated list. a missing item defaults to the empty string.
+file_df | data folder reference of open HDF5 file from psh5_open_file(). if undefined, the current datafolder is assumed. |
Definition at line 1838 of file pearl-pshell-import.ipf.
+ +Definition at line 2341 of file pearl-pshell-import.ipf.
+Definition at line 1776 of file pearl-pshell-import.ipf.
Definition at line 2302 of file pearl-pshell-import.ipf.
- -
-
|
- -static | -
select the preferred dataset from a list of available datasets.
-file_datasets | semicolon-separated list of datasets that are available in the file. the items may include a path separated by slashes "/". only the last component of the path is checked. |
pref_datasets | semicolon-separated list of preferred datasets. the items of the list are match strings for the Igor StringMatch function. the first matching dataset is loaded from the file. if no match is found, the first file dataset is selected. |
Definition at line 778 of file pearl-pshell-import.ipf.
+Definition at line 1737 of file pearl-pshell-import.ipf.
convert text wave to list.
-Definition at line 2473 of file pearl-pshell-import.ipf.
+Definition at line 532 of file pearl-pshell-import.ipf.
+ + + + +
+
|
+ +static | +
remove duplicate items from list
+list | semicolon-separated list of strings. strings can contain any printable character except the semicolon. |
Definition at line 764 of file pearl-pshell-import.ipf.
convert numeric wave to list.
-Definition at line 2490 of file pearl-pshell-import.ipf.
+Definition at line 549 of file pearl-pshell-import.ipf.
@@ -2093,7 +2036,7 @@ global string s_scanpaths in new data folder contains a list of scan groups insiDimension label for the angle dispersive dimension of multi-dimensional datasets.
-Definition at line 68 of file pearl-pshell-import.ipf.
+Definition at line 53 of file pearl-pshell-import.ipf.
@@ -2112,25 +2055,215 @@ global string s_scanpaths in new data folder contains a list of scan groups insiDimension label for the data dimension.
This label may be used to store the parameters for the setscale d
operation.
Definition at line 75 of file pearl-pshell-import.ipf.
+Definition at line 60 of file pearl-pshell-import.ipf.
- -const variable kDetectorSensitivity = 1 | +const variable kDSCAll = 0xffff |
multiply scienta detector intensity by this value to get actual counts.
+Definition at line 86 of file pearl-pshell-import.ipf.
-Definition at line 87 of file pearl-pshell-import.ipf.
+const variable kDSCAttrs = 0x0020 | +
Definition at line 79 of file pearl-pshell-import.ipf.
+ +const variable kDSCDetectors = 0x0002 | +
Definition at line 75 of file pearl-pshell-import.ipf.
+ +const variable kDSCDiags = 0x0040 | +
Definition at line 80 of file pearl-pshell-import.ipf.
+ +const variable kDSCEssentialDiags = 0x0010 | +
Definition at line 78 of file pearl-pshell-import.ipf.
+ +const variable kDSCMeta = 0x0100 | +
Definition at line 82 of file pearl-pshell-import.ipf.
+ +const variable kDSCMonitors = 0x0200 | +
Definition at line 83 of file pearl-pshell-import.ipf.
+ +const variable kDSCOther = 0x8000 | +
Definition at line 85 of file pearl-pshell-import.ipf.
+ +const variable kDSCPositioners = 0x0001 | +
Definition at line 74 of file pearl-pshell-import.ipf.
+ +const variable kDSCPreview = 0x0008 | +
Definition at line 77 of file pearl-pshell-import.ipf.
+ +const variable kDSCRegions = 0x0400 | +
Definition at line 84 of file pearl-pshell-import.ipf.
+ +const variable kDSCScientaScaling = 0x0004 | +
Definition at line 76 of file pearl-pshell-import.ipf.
+ +const variable kDSCSnaps = 0x0080 | +
Definition at line 81 of file pearl-pshell-import.ipf.
Dimension label for the energy dispersive dimension of multi-dimensional datasets.
-Definition at line 65 of file pearl-pshell-import.ipf.
+Definition at line 50 of file pearl-pshell-import.ipf.
+ + + + +const string kEssentialDiagnostics = "ManipulatorX;ManipulatorY;ManipulatorZ;ManipulatorTheta;ManipulatorTilt;ManipulatorPhi;MonoEnergy;" | +
List of diagnostic datasets that are normally loaded with a scan.
+ +Definition at line 69 of file pearl-pshell-import.ipf.
const string kPreviewDatasets = "ScientaImage;ScientaSpectrum;ImageAngleDistribution;ImageEnergyDistribution;Counts;SampleCurrent;" | +const string kPreviewDatasets = "ImageEnergyDistribution;ScientaSpectrum;ScientaImage;Counts;SampleCurrent;" |
List of preferred datasets to load for preview.
-Definition at line 78 of file pearl-pshell-import.ipf.
+Definition at line 63 of file pearl-pshell-import.ipf.
Dimension label for the scan dimension of multi-dimensional datasets.
-Definition at line 71 of file pearl-pshell-import.ipf.
+Definition at line 56 of file pearl-pshell-import.ipf.
@@ -2195,14 +2346,14 @@ global string s_scanpaths in new data folder contains a list of scan groups insiconst string kScientaScalingDatasets = "LensMode;ScientaChannelBegin;ScientaChannelEnd;ScientaSliceBegin;ScientaSliceEnd;" | +const string kScientaScalingDatasets = "LensMode;ScientaChannelBegin;ScientaChannelEnd;ScientaSliceBegin;ScientaSliceEnd;Eph;" |
List of datasets that must be loaded to determine the axis scaling of a Scienta image.
-Definition at line 81 of file pearl-pshell-import.ipf.
+Definition at line 66 of file pearl-pshell-import.ipf.
List of datasets that should be transposed upon loading.
+List of datasets that must be transposed upon loading.
-Definition at line 84 of file pearl-pshell-import.ipf.
+Definition at line 72 of file pearl-pshell-import.ipf.
- PEARL Procedures
- rev-distro-2.1.1-1-gf419e92-dirty
-
- Igor procedures for the analysis of PEARL data
- |
-
count rate functions for Scienta detector images. -More...
-#include "pearl-area-display"
Go to the source code of this file.
--Namespaces | |
PearlScientaCountrate | |
count rate functions for Scienta detector images. | |
-Functions | |
variable | ScientaLiveDisplay (string epicsname, string nickname, string wbRGB) |
open live display of most recent scienta measurement More... | |
variable | check_exposure_opt (wave image, wave outmask, variable dwelltime, dfref calc_df=defaultValue) |
optimized check exposure and calculate overexposure indicator mask More... | |
count rate functions for Scienta detector images.
-this procedure contains functions for working with true count rates.
- -Definition in file pearl-scienta-countrate.ipf.
-variable check_exposure_opt | -( | -wave | -image, | -
- | - | wave | -outmask, | -
- | - | variable | -dwelltime, | -
- | - | dfref | -calc_df = defaultValue |
-
- | ) | -- |
optimized check exposure and calculate overexposure indicator mask
-calculate the local count rate density and return a mask to indicate where the maximum count rate is exceeded. the raw image is filtered by FFT with a gaussian kernel.
-the raw image must have been acquired in fixed mode. slicing and dwell time are accounted for.
-this function does the same as check_exposure() but keeps intermediate waves for time-optimized processing. moreover it is compatible with igor 6.
-Definition at line 150 of file pearl-scienta-countrate.ipf.
- -variable ScientaLiveDisplay | -( | -string | -epicsname, | -
- | - | string | -nickname, | -
- | - | string | -wbRGB | -
- | ) | -- |
open live display of most recent scienta measurement
-epicsname | base name of the detector, e.g. X03DA-SCIENTA: image1: and cam1: are appended by the function. see ad_connect. |
nickname | nick name under which this detector is referred to in Igor. must be a valid data folder name. see ad_connect. |
wbRGB | window background color, e.g. "32768,49152,55296" |
Definition at line 43 of file pearl-scienta-countrate.ipf.
- -
- PEARL Procedures
- rev-distro-2.1.1-1-gf419e92-dirty
-
- Igor procedures for the analysis of PEARL data
- |
-
preprocessing functions for Scienta detector images. More...
#include "pearl-fitfuncs"
#include "pearl-area-import"
Go to the source code of this file.
Functions | |
variable | prompt_int_linbg_reduction (string *param) |
prompt the user for integrate on linear background reduction parameters. More... | |
prompt the user for integrate on linear background reduction parameters. More... | |
string | capture_int_linbg_cursors () |
capture linear background reduction parameters from cursors in a graph. More... | |
capture linear background reduction parameters from cursors in a graph. More... | |
string | csr_int_linbg_reduction (string win) |
calculate linear background reduction parameters from cursors in a graph. More... | |
calculate linear background reduction parameters from cursors in a graph. More... | |
threadsafe wave | int_linbg_reduction (wave source, string *param) |
linear-background subtracted integration reduction function. More... | |
linear-background subtracted integration reduction function. More... | |
variable | prompt_int_quadbg_reduction (string *param) |
threadsafe wave | int_quadbg_reduction (wave source, string *param) |
integrate peak area minus a quadratic background More... | |
integrate peak area minus a quadratic background More... | |
variable | prompt_redim_linbg_reduction (string *param) |
parameter dialog for the redim_linbg_reduction() function More... | |
parameter dialog for the redim_linbg_reduction() function More... | |
threadsafe wave | redim_linbg_reduction (wave source, string *param) |
linear background reduction function for incorrectly dimensioned scienta image More... | |
linear background reduction function for incorrectly dimensioned scienta image More... | |
variable | test_gauss4_reduction (wave image) |
apply the gauss4_reduction function to a single image More... | |
apply the gauss4_reduction function to a single image More... | |
variable | prompt_gauss4_reduction (string *param) |
prompt for the gauss4_reduction parameters More... | |
prompt for the gauss4_reduction parameters More... | |
threadsafe wave | gauss4_reduction (wave source, string *param) |
fit horizontal cuts of an image with up to four gaussian peaks on a linear background More... | |
fit horizontal cuts of an image with up to four gaussian peaks on a linear background More... | |
threadsafe wave | gauss6_reduction (wave source, string *param) |
preprocessing functions for Scienta detector images.
this procedure contains functions for data reduction and instrument-specific normalization.
-Definition in file pearl-scienta-preprocess.ipf.
@@ -173,7 +178,7 @@ Licensed under the Apache License, Version 2.0 (the "License");ad_profiles_cursor_mode(root:packages:pearl_explorer:preview_image, 1)
. Definition at line 93 of file pearl-scienta-preprocess.ipf.
+Definition at line 95 of file pearl-scienta-preprocess.ipf.
Definition at line 133 of file pearl-scienta-preprocess.ipf.
+Definition at line 135 of file pearl-scienta-preprocess.ipf.
@@ -267,7 +272,37 @@ Licensed under the Apache License, Version 2.0 (the "License");Definition at line 718 of file pearl-scienta-preprocess.ipf.
+Definition at line 720 of file pearl-scienta-preprocess.ipf.
+ + + + +threadsafe wave gauss6_reduction | +( | +wave | +source, | +
+ | + | string * | +param | +
+ | ) | ++ |
Definition at line 856 of file pearl-scienta-preprocess.ipf.
Definition at line 260 of file pearl-scienta-preprocess.ipf.
+Definition at line 262 of file pearl-scienta-preprocess.ipf.
@@ -369,7 +404,7 @@ Licensed under the Apache License, Version 2.0 (the "License");Definition at line 413 of file pearl-scienta-preprocess.ipf.
+Definition at line 415 of file pearl-scienta-preprocess.ipf.
@@ -391,7 +426,7 @@ Licensed under the Apache License, Version 2.0 (the "License");prompt for the gauss4_reduction parameters
-Definition at line 626 of file pearl-scienta-preprocess.ipf.
+Definition at line 628 of file pearl-scienta-preprocess.ipf.
@@ -413,7 +448,7 @@ Licensed under the Apache License, Version 2.0 (the "License");prompt the user for integrate on linear background reduction parameters.
-Definition at line 35 of file pearl-scienta-preprocess.ipf.
+Definition at line 37 of file pearl-scienta-preprocess.ipf.
@@ -433,7 +468,7 @@ Licensed under the Apache License, Version 2.0 (the "License");Definition at line 351 of file pearl-scienta-preprocess.ipf.
+Definition at line 353 of file pearl-scienta-preprocess.ipf.
parameter dialog for the redim_linbg_reduction() function
+parameter dialog for the redim_linbg_reduction() function
param | parameter string in a key1=value1;key2=value2;... list. the parameter string is passed by reference. see redim_linbg_reduction() for a description of parameters. |
param | parameter string in a key1=value1;key2=value2;... list. the parameter string is passed by reference. see redim_linbg_reduction() for a description of parameters. |
Definition at line 509 of file pearl-scienta-preprocess.ipf.
+Definition at line 511 of file pearl-scienta-preprocess.ipf.
linear background reduction function for incorrectly dimensioned scienta image
if the energy step size does not divide the energy range to an integer number, the scienta image is exported with the wrong array size. this can be fixed by redimensioning the array.
the current implementation works in the case where dimension 0 needs to be incremented. the function may be generalized to dimension 1 and/or decrementing by additional parameters. it is not known yet whether a generalization is needed or whether it can cover all cases.
-background subtraction and peak integration is the same as by the int_linbg_reduction() function.
+background subtraction and peak integration is the same as by the int_linbg_reduction() function.
source | source wave Scienta detector image, energy axis along X, angle axis along Y |
PEARL Procedures
- rev-distro-2.1.1-1-gf419e92-dirty
+ rev-distro-3.0.0-0-gfa24916-dirty
Igor procedures for the analysis of PEARL data
|
@@ -38,18 +35,21 @@
Definition at line 26 of file pearl-tools.ipf.
+Definition at line 27 of file pearl-tools.ipf.
Definition at line 65 of file pearl-tools.ipf.
+Definition at line 66 of file pearl-tools.ipf.
Definition at line 18 of file pearl-tools.ipf.
+Definition at line 19 of file pearl-tools.ipf.
Definition at line 79 of file pearl-tools.ipf.
+Definition at line 80 of file pearl-tools.ipf.
Definition at line 45 of file pearl-tools.ipf.
+Definition at line 46 of file pearl-tools.ipf.
Definition at line 34 of file pearl-tools.ipf.
+Definition at line 35 of file pearl-tools.ipf.
basic vector geometry operations.
this procedure file contains basic vector geometry functions, such as rotations.
-Definition in file pearl-vector-operations.ipf.
@@ -160,7 +162,7 @@ Licensed under the Apache License, Version 2.0 (the "License");the matrix is initialized as identity.
Definition at line 73 of file pearl-vector-operations.ipf.
+Definition at line 74 of file pearl-vector-operations.ipf.
Definition at line 45 of file pearl-vector-operations.ipf.
+Definition at line 46 of file pearl-vector-operations.ipf.
@@ -254,7 +256,7 @@ Licensed under the Apache License, Version 2.0 (the "License");Definition at line 60 of file pearl-vector-operations.ipf.
+Definition at line 61 of file pearl-vector-operations.ipf.
@@ -295,7 +297,7 @@ Licensed under the Apache License, Version 2.0 (the "License");Definition at line 175 of file pearl-vector-operations.ipf.
+Definition at line 176 of file pearl-vector-operations.ipf.
@@ -336,7 +338,7 @@ Licensed under the Apache License, Version 2.0 (the "License");Definition at line 203 of file pearl-vector-operations.ipf.
+Definition at line 205 of file pearl-vector-operations.ipf.
@@ -377,7 +379,7 @@ Licensed under the Apache License, Version 2.0 (the "License");Definition at line 231 of file pearl-vector-operations.ipf.
+Definition at line 234 of file pearl-vector-operations.ipf.
@@ -418,7 +420,7 @@ Licensed under the Apache License, Version 2.0 (the "License");Definition at line 92 of file pearl-vector-operations.ipf.
+Definition at line 93 of file pearl-vector-operations.ipf.
@@ -459,7 +461,7 @@ Licensed under the Apache License, Version 2.0 (the "License");Definition at line 120 of file pearl-vector-operations.ipf.
+Definition at line 121 of file pearl-vector-operations.ipf.
@@ -500,7 +502,7 @@ Licensed under the Apache License, Version 2.0 (the "License");Definition at line 148 of file pearl-vector-operations.ipf.
+Definition at line 149 of file pearl-vector-operations.ipf.
@@ -510,9 +512,9 @@ Licensed under the Apache License, Version 2.0 (the "License");Definition at line 370 of file pearl-fitfuncs.ipf.
+Definition at line 449 of file pearl-fitfuncs.ipf.
Definition at line 386 of file pearl-fitfuncs.ipf.
+Definition at line 465 of file pearl-fitfuncs.ipf.
Definition at line 387 of file pearl-fitfuncs.ipf.
+Definition at line 466 of file pearl-fitfuncs.ipf.
Definition at line 385 of file pearl-fitfuncs.ipf.
+Definition at line 464 of file pearl-fitfuncs.ipf.
Definition at line 380 of file pearl-fitfuncs.ipf.
+Definition at line 459 of file pearl-fitfuncs.ipf.
Definition at line 379 of file pearl-fitfuncs.ipf.
+Definition at line 458 of file pearl-fitfuncs.ipf.
Definition at line 370 of file pearl-fitfuncs.ipf.
+Definition at line 449 of file pearl-fitfuncs.ipf.
Definition at line 384 of file pearl-fitfuncs.ipf.
+Definition at line 463 of file pearl-fitfuncs.ipf.
Definition at line 376 of file pearl-fitfuncs.ipf.
+Definition at line 455 of file pearl-fitfuncs.ipf.
Definition at line 375 of file pearl-fitfuncs.ipf.
+Definition at line 454 of file pearl-fitfuncs.ipf.
from matrixfilereader help
-Definition at line 197 of file pearl-matrix-import.ipf.
+Definition at line 198 of file pearl-matrix-import.ipf.
Definition at line 200 of file pearl-matrix-import.ipf.
+Definition at line 201 of file pearl-matrix-import.ipf.
Definition at line 201 of file pearl-matrix-import.ipf.
+Definition at line 202 of file pearl-matrix-import.ipf.
Definition at line 202 of file pearl-matrix-import.ipf.
+Definition at line 203 of file pearl-matrix-import.ipf.
Definition at line 205 of file pearl-matrix-import.ipf.
+Definition at line 206 of file pearl-matrix-import.ipf.
Definition at line 207 of file pearl-matrix-import.ipf.
+Definition at line 208 of file pearl-matrix-import.ipf.
Definition at line 206 of file pearl-matrix-import.ipf.
+Definition at line 207 of file pearl-matrix-import.ipf.
Definition at line 203 of file pearl-matrix-import.ipf.
+Definition at line 204 of file pearl-matrix-import.ipf.
Definition at line 197 of file pearl-matrix-import.ipf.
+Definition at line 198 of file pearl-matrix-import.ipf.
Definition at line 199 of file pearl-matrix-import.ipf.
+Definition at line 200 of file pearl-matrix-import.ipf.
Definition at line 208 of file pearl-matrix-import.ipf.
+Definition at line 209 of file pearl-matrix-import.ipf.
Definition at line 204 of file pearl-matrix-import.ipf.
+Definition at line 205 of file pearl-matrix-import.ipf.