PEARL Procedures  rev-distro-3.0.0-0-gfa24916-dirty
Igor procedures for the analysis of PEARL data
pearl-anglescan-process.ipf File Reference

processing and holographic mapping of angle scanned XPD data. More...

#include "pearl-vector-operations"
#include "pearl-polar-coordinates"
#include <New Polar Graphs>

Go to the source code of this file.

Namespaces

 PearlAnglescanProcess
 processing and holographic mapping of angle scanned XPD data.
 

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...
 
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...
 
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...
 
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...
 
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...
 
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...
 
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...
 
variable crop_strip (wave strip, variable xlo, variable xhi)
 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...
 
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...
 
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...
 
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...
 
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...
 
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...
 
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...
 
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...
 
static variable Calc_The_step (variable th, variable Theta_st, string Holomode)
 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...
 
variable make_hemi_grid (variable npol, string nickname, variable xpdplot=defaultValue)
 create a hemispherical, constant solid angle grid More...
 
string get_hemi_nickname (wave w)
 finds the nick name given any hemi wave More...
 
string get_hemi_prefix (wave w)
 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...
 
variable clear_hemi_grid (string nickname)
 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...
 
variable rotate_hemi_scan (string nickname, variable angle)
 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...
 
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...
 
static string display_polar_graph (string graphname, variable angle_offset=defaultValue, variable do_ticks=defaultValue)
 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...
 
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...
 
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...
 
threadsafe variable calc_graph_radius (variable polar, variable projection=defaultValue)
 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...
 
threadsafe variable calc_graph_azi (variable x, variable y, variable projection=defaultValue, variable zeroAngle=defaultValue)
 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...
 
static variable polar_graph_hook (WMWinHookStruct *s)
 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 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 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...
 
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...
 
variable save_hemi_scan (string nickname, string pathname, string filename)
 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...
 
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...
 
variable trim_hemi_scan (string nickname, variable theta_max)
 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...
 
wave hemi_azi_cut (string nickname, variable pol)
 extract an azimuthal cut from a hemispherical scan 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...
 

Variables

const variable kProjDist = 0
 
const variable kProjStereo = 1
 
const variable kProjArea = 2
 
const variable kProjGnom = 3
 
const variable kProjOrtho = 4
 
static const variable kProjScaleDist = 2
 
static const variable kProjScaleStereo = 2
 
static const variable kProjScaleArea = 2
 
static const variable kProjScaleGnom = 0.06744519021
 
static const variable kProjScaleOrtho = 2
 

Detailed Description

processing and holographic mapping of angle scanned XPD data.

the functions in this file map angle scanned data measured at PEARL onto a hemispherical angle grid which is compatible with XPDplot. the resulting data are in a canonical polar coordinate system (normal emission <=> polar angle = 0, azimuthal axis right-handed) which is anchored in the sample surface. the orientation of polar graphs (phi = 0 at 3 o'clock) created by this procedure corresponds to a top view of the sample surface at normal emission, and the handle of the sample plate pointing to the left (phi = 180). this is the canonical orientation of a spherical coordinate system where phi = 0 corresponds to the positive part of the x axis.

Note
the orientation of the sample coordinate system has changed in version 1.6. the change was necessary for compatibility with other data analysis software and calculation programs.
data imported with version 1.5 and earlier, must be offset by 180 deg in phi to be compatible with the new version. data imported and displayed by the same code version will give the same picture but with different azimuthal axis. the new graph functions shows a warning if they are applied to code imported with earlier versions.

the measurement geometry is hard-coded but may be parametrized in the future. the theta rotation axis is perpendicular to the scattering plane. the angle dispersive axis of the analyser is parallel to the theta rotation axis. the tilt rotation axis is in the scattering plane. it rotates with theta. at normal emission it is perpendicular to the axis of the lens stack of the analyser. the phi rotation axis corresponds to the surface normal of the sample. it rotates with theta and with tilt. at normal emission it is parallel to the axis of the lens stack of the analyser.

coordinate transformations: (to be revised - v1.6)

*      theta_sample = theta_manipulator - theta_offset
*      phi_sample = phi_manipulator - phi_offset
* 

valid for theta_manipulator = normal emission only: (to be revised - v1.6)

*      theta_sample = | -(tilt_manipulator - tilt_offset) |
*      phi_sample = 270 if tilt_manipulator - tilt_offset > 0
*      phi_sample = 90 if tilt_manipulator - tilt_offset < 0
* 
Author
matthias muntwiler, matth.nosp@m.ias..nosp@m.muntw.nosp@m.iler.nosp@m.@psi..nosp@m.ch
Version
1.8 canonical orientation of spherical coordinate system.

Definition in file pearl-anglescan-process.ipf.

Function Documentation

◆ add_anglescan_worker()

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 
)
static

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()

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 
)
static

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.

Attention
the function sorts the input arrays by azimuthal angle! these waves must not refer to global objects if multi-threading is used!

Definition at line 2761 of file pearl-anglescan-process.ipf.

◆ AngleToK()

variable AngleToK ( wave  inwave)

k-space mapping of 2D angle-energy distribution (scienta image)

courtesy of F. Matsui

Parameters
inwave2D wave, x = kinetic energy (eV), y = polar angle (deg) note: the kinetic energy is with reference to the vacuum level at the sample. if the work functions of the analyser and the sample differ: Ekin,sample = Ekin,analyser + WFanalyser - WFsample where WFanalyser = Ephot - EFermi
Returns
the output wave has the name of the input wave with the suffix "_k".

Definition at line 3562 of file pearl-anglescan-process.ipf.

◆ calc_graph_azi()

threadsafe variable calc_graph_azi ( variable  x,
variable  y,
variable  projection = defaultValue,
variable  zeroAngle = defaultValue 
)

calculate azimuthal angle from Cartesian coordinate

Parameters
x,yprojected Cartesian coordinate
projectionmapping function from polar to cartesian coordinates. all supported projections are azimuthal, they have no effect on the azimuthal coordinate. see Projections for details.
  • kProjDist = 0 azimuthal equidistant
  • kProjStereo = 1 stereographic (default)
  • kProjArea = 2 azimuthal equal-area
  • kProjGnom = 3 gnomonic (0 <= polar < 90)
  • kProjOrtho = 4 orthographic
zeroAnglezeroAngleWhere parameter of polar graphs
  • 0 (default) zero is at the 3 o'clock position
  • 180 zero is at the 9 o'clock position
  • other values not tested
Returns
polar angle in degrees

Definition at line 2467 of file pearl-anglescan-process.ipf.

◆ calc_graph_polar()

threadsafe variable calc_graph_polar ( variable  x,
variable  y,
variable  projection = defaultValue 
)

calculate polar angle from Cartesian coordinate

this is the reverse mapping to calc_graph_radius()

Parameters
x,yprojected Cartesian coordinate
projectionmapping function from polar to cartesian coordinates. see Projections for details.
  • kProjDist = 0 azimuthal equidistant
  • kProjStereo = 1 stereographic (default)
  • kProjArea = 2 azimuthal equal-area
  • kProjGnom = 3 gnomonic (0 <= polar < 90)
  • kProjOrtho = 4 orthographic
Returns
polar angle in degrees

Definition at line 2414 of file pearl-anglescan-process.ipf.

◆ calc_graph_radius()

threadsafe variable calc_graph_radius ( variable  polar,
variable  projection = defaultValue 
)

calculate the projected polar angle

Parameters
polarpolar angle in degrees
projectionmapping function from polar to cartesian coordinates. see Projections for details.
  • kProjDist = 0 azimuthal equidistant
  • kProjStereo = 1 stereographic (default)
  • kProjArea = 2 azimuthal equal-area
  • kProjGnom = 3 gnomonic (0 <= polar < 90)
  • kProjOrtho = 4 orthographic
Returns
projected radius. the radius is scaled such that grazing emission maps to 2.

Definition at line 2369 of file pearl-anglescan-process.ipf.

◆ calc_nth()

static variable calc_nth ( variable  Theta_st,
variable  Theta_in,
variable  th,
variable  Phi_ran,
variable  Phi_ref,
string  Holomode 
)
static

calculate the number of phis for a given theta

adapted from XPDplot 8.03

Definition at line 1223 of file pearl-anglescan-process.ipf.

◆ calc_phi_step()

static variable calc_phi_step ( variable  Theta_in,
variable  th,
variable  Theta_st,
variable  Phi_ran,
variable  Phi_ref,
string  Holomode 
)
static

calculate delta-phi for a given theta

adapted from XPDplot 8.03

Definition at line 1252 of file pearl-anglescan-process.ipf.

◆ Calc_The_step()

static variable Calc_The_step ( variable  th,
variable  Theta_st,
string  Holomode 
)
static

calculate delta-theta for a given theta

adapted from XPDplot 8.03

Definition at line 1296 of file pearl-anglescan-process.ipf.

◆ CalcN_Theta()

static variable CalcN_Theta ( string  HoloMode,
variable  Theta_in,
variable  Theta_ran,
variable  Theta_st 
)
static

calculate the number of thetas for a pattern

adapted from XPDplot 8.03

Definition at line 1327 of file pearl-anglescan-process.ipf.

◆ check_contrast()

static variable check_contrast ( wave  values,
variable  pcmin,
variable  pcmax,
variable *  vmin,
variable *  vmax,
variable  sym 
)
static

Definition at line 3407 of file pearl-anglescan-process.ipf.

◆ clear_hemi_grid()

variable clear_hemi_grid ( string  nickname)

clear a hemispherical scan grid

values and weights waves are set to zero. the intensity wave is set to NaN.

Parameters
nicknamefolder name or name prefix of holo waves. may be empty.

Definition at line 1606 of file pearl-anglescan-process.ipf.

◆ convert_angles_ttpa2polar()

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.

the angles are in the manipulator coordinate system.

Parameters
[in]thetaoffset-corrected theta angle, normal emission = 0, grazing emission = 90. one dimensional wave.
[in]tiltoffset-corrected tilt angle, normal emission = 0 same dimension size and scale as theta
[in]phiphi angle, range -360 < phi < +360 offset correction is optional as long as the angles lie in the accepted range. same dimension size and scale as theta
[in]analyseranalyser angle scale corresponding to the slices scale of Scienta. one dimensional wave. this values are constant regardless of manipulator angle.
[out]polarwave to receive the polar coordinates.
[out]aziwave to receive the azimuthal coordinates.

for 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 1162 of file pearl-anglescan-process.ipf.

◆ convert_angles_ttpd2polar()

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.

similar to convert_angles_ttpa2polar() but reads the analyser angles from the X scale of data

Definition at line 1123 of file pearl-anglescan-process.ipf.

◆ crop_strip()

variable crop_strip ( wave  strip,
variable  xlo,
variable  xhi 
)

crop a strip at the sides.

the strip is cropped in place, data outside the region of interest is lost.

Parameters
[in,out]strip2D data, X-axis = analyser angle, Y-axis = arbitrary manipulator scan
[in]xlolowest analyser angle to keep (will be rounded to nearest existing point)
[in]xhihighest analyser angle to keep (will be rounded to nearest existing point)
Remarks
cropping should be done after smoothing and normalization operations to reduce artefacts.

Definition at line 747 of file pearl-anglescan-process.ipf.

◆ crop_strip_theta()

variable crop_strip_theta ( wave  strip,
variable  theta_lo,
variable  theta_hi,
wave  theta,
wave  tilt,
wave  phi 
)

crop a strip in theta.

the strip is cropped in place, data outside the region of interest is lost.

Parameters
[in,out]strip2D data, X-axis = analyser angle, Y-axis = arbitrary manipulator scan
[in]ylolowest polar angle to keep (will be rounded to nearest existing point)
[in]yhihighest polar angle to keep (will be rounded to nearest existing point)
[in,out]thetapolar angle along the Y dimension of strip. this wave is modified: cropped rows are deleted.
[in,out]tilttilt angle along the Y dimension of strip. this wave is modified: cropped rows are deleted.
[in,out]phiazimuthal angle along the Y dimension of strip. this wave is modified: cropped rows are deleted.

Definition at line 779 of file pearl-anglescan-process.ipf.

◆ display_hemi_scan()

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.

the scan data must exist in the current data folder. azimuth = 0 should be at 9 o'clock. then the orientation is the same as the sample at normal emission and phi = 0, the handle of the sample plate pointing to the left.

Parameters
nicknamename prefix of holo waves. may be empty.
projectionmapping function from polar to cartesian coordinates. see Projections for details.
  • kProjDist = 0 azimuthal equidistant
  • kProjStereo = 1 stereographic (default)
  • kProjArea = 2 azimuthal equal-area
  • kProjGnom = 3 gnomonic (0 <= polar < 90)
  • kProjOrtho = 4 orthographic
graphtypetype of graph
  • 1 (pol, az) trace in Igor "New Polar" (default).
  • 2 XPDplot (reserved, not implemented).
  • 3 matrix in Igor "New Polar". the matrix wave is a 2D wave with X and Y scaling corresponding to the selected projection. matrix waves can be created by interpolate_hemi_scan(). note: the pol and az waves are required as well.
do_ticksselect which ticks to draw. value must be the arithmetic OR of all selected items. default: 3
  • 0 none
  • 1 major azimuthal
  • 2 minor azimuthal S
do_gridsselect which grids to draw. value must be the arithmetic OR of all selected items. default: 3
  • 0 none
  • 1 radius at 0 and 90 degree azimuth
  • 2 circle at 30 and 60 degree polar
graphnamename of graph window. default: nickname if empty, a default name is assigned. if a window with this name is existing, the function brings it to the front, and does nothing else.
Returns
the name of the graph window

Definition at line 1858 of file pearl-anglescan-process.ipf.

◆ display_polar_graph()

static string display_polar_graph ( string  graphname,
variable  angle_offset = defaultValue,
variable  do_ticks = defaultValue 
)
static

displays an empty polar graph

the graph is drawn using Wavemetrics "New Polar Graphs.ipf".

initially the graph is empty. hemispherical scans are displayed by adding a trace that coveres the whole plot area, and setting the trace color to a function of the intensity. traces are added by calling WMPolarAppendTrace.

the following items of the graph > packages menu might be useful:

  • modify polar graph
  • color table control
  • show polar cursors
  • polar graph legend

parameters can be changed programmatically as shown in the code of this function. after programmatic parameter changes, call WMPolarAxesRedrawGraphNow(graphname).

Parameters
graphnamerequested name of new graph window. if empty, a default name is assigned. if a window with this name is existing, the function brings it to the front, and does nothing else.
angle_offsetazimuth (on screen) where angle 0 is plotted (zeroAngleWhere parameter of polar graphs). starting with version 1.6, the default is 0. for hemi grids created with earlier versions, it should be set to 180 for correct orientation.
do_ticksselect which ticks to draw. value must be the arithmetic OR of all selected items. default: 3
  • 0 none
  • 1 major azimuthal
  • 2 minor azimuthal
Returns
the name of the graph window.
Version
1.7 interface change: the trace drawing code is moved to display_hemi_scan, so that this function can be reused by other graph types, e.g. display_scanlines.

Definition at line 2003 of file pearl-anglescan-process.ipf.

◆ display_scanlines()

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.

Parameters
nicknamenick name for output data. this will become the name of a child folder containing the output.
alpha_lolow limit of the analyser angle.
alpha_hihigh limit of the analyser angle.
m_thetamanipulator theta angles, 0 = normal emission. size = dimsize(data, 1)
m_tiltmanipulator tilt angles, 0 = normal emission. size = dimsize(data, 1)
m_phimanipulator phi angles, 0 = azimuthal origin. size = dimsize(data, 1)
foldingrotational averaging, default = 1
projectionmapping function from polar to cartesian coordinates. see calc_graph_radius().
Remarks
this function is extremely slow.

Definition at line 2254 of file pearl-anglescan-process.ipf.

◆ draw_diffraction_cone()

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.

the diffraction cone consists of a circle marking the diffraction ring, and a dot marking the axis. the cone is drawn as a group of draw objects on the UserFront layer. the objects can be edited interactively.

Parameters
graphnamename of graph window (not implemented yet).
groupnamename of a drawing group. if the group exists (from a previous cone) it is replaced. if the group doesn't exist, a new one is created.
theta_axispolar angle of the cone axis in degrees.
theta_innerpolar angle of the innermost point of the circle in degrees.
phiazimuthal angle of the cone axis in degrees.
Warning
EXPERIMENTAL! this function is under development. the interface and behaviour of this function may change significantly in future versions.

Definition at line 2190 of file pearl-anglescan-process.ipf.

◆ draw_hemi_axes()

static string draw_hemi_axes ( string  graphname,
variable  do_grids = defaultValue 
)
static

draw polar and azimuthal grids in an existing polar graph.

the function adds the following draw objects to a polar graph:

  • concentric circles at polar angles 0, 30, and 60 degrees with labels.
  • radial axes at 0 and 90 degree azimuth.

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".

Parameters
graphnamename of graph window.
do_gridsselect which optional grids to draw. value must be the arithmetic OR of all selected items. default: 3
  • 0 none
  • 1 radius at 0 and 90 degree azimuth
  • 2 circle at 30 and 60 degree polar
Warning
EXPERIMENTAL! this function is under development. the interface and behaviour of this function may change significantly in future versions.

Definition at line 2118 of file pearl-anglescan-process.ipf.

◆ duplicate_hemi_scan()

variable duplicate_hemi_scan ( string  source_nickname,
dfref  dest_folder,
string  dest_nickname,
variable  xpdplot = defaultValue 
)

duplicate a hemispherical scan dataset.

this function works only for hemi scans created by make_hemi_grid() (or compatible functions). the angle grid is recreated rather than copied point-by-point. the new dataset is independent from the original one.

if the version of the source dataset is pre 1.6, it is converted to version 1.6.

Parameters
source_nicknamename prefix for waves. source data must be in current data folder.
dest_folderdestination folder. folder must exist.
dest_nicknamename prefix for destination waves. must be unique in the current data folder. otherwise existing waves get overwritten. may be empty.
xpdplotXPDplot compatibility
  • 0 (default) create the data structures required by this module
  • 1 create additional waves and notebook required by XPDplot

Definition at line 1653 of file pearl-anglescan-process.ipf.

◆ find_hemi_data()

dfr find_hemi_data ( string  nickname,
string *  prefix,
string *  intwave 
)

finds the folder, prefix and name of holo waves given their nick name

the function looks for holo waves in the following order:

  1. if nickname is empty, check for prefix-less waves in current folder.
  2. if nickname is the name of a child folder in the current data folder, clear the (prefix-less) waves in the child folder.
  3. nickname is prefix of waves in current folder.
  4. nickname is prefix of waves in root folder.
Parameters
[in]nicknamefolder name or name prefix of holo waves. may be empty.
[out]prefixname prefix of waves. may be empty.
[out]intwavename of intensity/values wave
Returns
reference of the data folder which contains the waves

Definition at line 1572 of file pearl-anglescan-process.ipf.

◆ get_hemi_nickname()

string get_hemi_nickname ( wave  w)

finds the nick name given any hemi wave

the nick name is either the name of a child folder in the current data folder (PEARL specification), or a prefix of the hemi wave names (XPDplot specification).

Returns
the nick name

Definition at line 1516 of file pearl-anglescan-process.ipf.

◆ get_hemi_prefix()

string get_hemi_prefix ( wave  w)

finds the prefix given any hemi wave

the prefix is the part of the wave name before the first underscore. the prefix is used by XPDplot where it is identical to the nick name. the prefix is empty in the PEARL specification.

Returns
the prefix

Definition at line 1541 of file pearl-anglescan-process.ipf.

◆ hemi_add_anglescan()

variable hemi_add_anglescan ( string  nickname,
wave  values,
wave  polar,
wave  azi,
wave  weights = defaultValue 
)

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.

Parameters
nicknamename prefix of holo waves. empty if waves are in current data folder.
valuescounts/intensity values at the positions given in the polara nd azi waves. one- or two-dimensional. NaN values are ignored.
polarpolar angles (in degrees) of each data point. allowed range 0 <= theta <= 90. no specific ordering required.
aziazimuthal angles (in degrees) of each data point. allowed range -360 <= phi < +360. no specific order required.
weightsweight 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 2637 of file pearl-anglescan-process.ipf.

◆ hemi_add_aziscan()

variable hemi_add_aziscan ( string  nickname,
wave  values,
variable  polar,
wave  azi,
wave  weights = defaultValue 
)

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).

Parameters
nicknamename prefix of holo waves. empty if waves are in current data folder.
valuescounts/intensity values of the azimuthal scan at the positions given in the azi parameter.
polarpolar angle (in degrees) where to add the azi scan.
aziangle positions of the azimuthal scan. acceptable range: >= -360 and < +360. no specific order required, the function sorts the array internally.
weightsweight 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 2844 of file pearl-anglescan-process.ipf.

◆ hemi_azi_cut()

wave hemi_azi_cut ( string  nickname,
variable  pol 
)

extract an azimuthal cut from a hemispherical scan

the function extracts all azimuthal angles that are present for the given polar angle.

the hemi grid must have been created in the current data folder by the make_hemi_grid function. correct ordering is required.

Parameters
nicknamename of the scan dataset. can be empty if no prefix is used. the dataset must be in the current datafolder.
polpolar angle in degrees
Returns
reference of the created wave. the wave has the same name as the intensity wave of the dataset with the suffix "_azi" and the azimuthal angle rounded to integer. it is created in the same datafolder as the original data.

Definition at line 3354 of file pearl-anglescan-process.ipf.

◆ hemi_polar_cut()

wave hemi_polar_cut ( string  nickname,
variable  azim 
)

extract a polar cut from a hemispherical scan.

for each polar angle, the function first extracts all azimuthal angles. the intensity is then interpolated between the nearest neighbours of the given azimuth.

the hemi grid must have been created in the current data folder by the make_hemi_grid function. correct ordering is required.

Parameters
nicknamename of the scan dataset. can be empty if no prefix is used. the dataset must be in the current datafolder.
azimazimuthal angle in degrees
Returns
reference of the created wave. the wave has the same name as the intensity wave of the dataset with the suffix "_azi" and the azimuthal angle rounded to integer. it is created in the same datafolder as the original data.

Definition at line 3268 of file pearl-anglescan-process.ipf.

◆ import_tpi_scan()

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

in the tpi format, the hemi scan data is represented by a triple of flat one-dimensional waves corresponding to the polar angle (theta), azimuthal angle (phi) and intensity. no specific sort order is required.

Parameters
nicknamenick name for output data
  • in default mode, this will become the name of a child folder containing the output.
  • in XPDplot mode, this will become a prefix of the generated data in the root folder.
thetatheta angles, 0 = normal emission.
phiphi angles, 0 = azimuthal origin. size = dimsize(data, 1)
intensityintensity wave, see requirements above.
npolarnumber of polar angles, determines polar and azimuthal step size. default = 91 (1 degree steps)
foldingrotational averaging. example: 3 = average to 3-fold symmetry. default = 1.
nographdisplay a new graph window?
  • 0 (default) display a new polar graph
  • 1 don't display a new graph
xpdplotXPDplot compatibility
  • 0 (default) create waves in child folder $nickname
  • 1 create waves in root folder (compatible with XPDplot)

Definition at line 3179 of file pearl-anglescan-process.ipf.

◆ interpolate_hemi_scan()

variable interpolate_hemi_scan ( string  nickname,
variable  projection = defaultValue 
)

interpolate a hemispherical scan onto a rectangular grid

the 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.

Parameters
nicknamename prefix of holo waves. may be empty.
projectionmapping function from polar to cartesian coordinates. see Projections for details.
  • kProjDist = 0 azimuthal equidistant
  • kProjStereo = 1 stereographic (default)
  • kProjArea = 2 azimuthal equal-area
  • kProjGnom = 3 gnomonic (0 <= polar < 90)
  • kProjOrtho = 4 orthographic

Definition at line 2920 of file pearl-anglescan-process.ipf.

◆ line_average()

static variable line_average ( wave  source,
wave  dest 
)
static

Definition at line 1205 of file pearl-anglescan-process.ipf.

◆ load_hemi_scan()

variable load_hemi_scan ( string  nickname,
string  pathname,
string  filename 
)

load a hemispherical scan from an Igor text file

Todo:
function not implemented

Definition at line 3130 of file pearl-anglescan-process.ipf.

◆ make_hemi_grid()

variable make_hemi_grid ( variable  npol,
string  nickname,
variable  xpdplot = defaultValue 
)

create a hemispherical, constant solid angle grid

all necessary waves are created in the current data folder with step size 90 / (npol - 1)

adapted from XPDplot 8.03

Parameters
npolnumber of polar angles, determines polar and azimuthal step size. recommended 91 for 1-degree steps.
nicknamename prefix for waves. nick name must be unique in the current data folder. otherwise existing waves get overwritten. may be empty.
xpdplotXPDplot compatibility
  • 0 (default) create the data structures required by this module
  • 1 create additional waves and notebook required by XPDplot

Definition at line 1365 of file pearl-anglescan-process.ipf.

◆ normalize_strip_2d()

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.

Warning
experimental. this function is under development.
Parameters
checkenable output of intermediate results
  • 0 (default) don't create additional waves
  • 1 create check waves in the current folder
  • 2 calculate check waves only, do not modify strip
Returns
if check waves are enabled, the following waves are created (overwritten if existing):
  • check_dist average theta distribution
  • check_smoo smoothed distribution used to normalize the strip

Definition at line 686 of file pearl-anglescan-process.ipf.

◆ normalize_strip_phi()

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).

the sine function is a curve fit to the intensity integrated over detector angle with a period of 360°.

this normalization may be useful if the intensity varies with a 360° periodicity in the azimuthal angle, e.g. due to misalignment of the surface normal and the azimuthal rotation axis of the manipulator (wobble). note, however, that this function does not correct other effects of wobble such as angle shifts.

the strip is normalized in place, previous data is overwritten.

Parameters
[in,out]strip2D data, X-axis = analyser angle, Y-axis = arbitrary manipulator scan
[in]thetapolar manipulator angle.
[in]phiazimuthal manipulator angle, arbitrary offset.
[in]theta_offsettheta value corresponding to normal emission (default 0).
[in]theta_rangemaximum (offset corrected) theta to consider in the sine fit (default 10).
checkenable output of intermediate results
  • 0 (default) don't create additional waves
  • 1 create check waves in the current folder
  • 2 calculate check waves only, do not modify strip
Returns
if check waves are enabled, the following waves are created (overwritten if existing):
  • check_dist average theta distribution
  • check_smoo smoothed distribution used to normalize the strip

Definition at line 348 of file pearl-anglescan-process.ipf.

◆ normalize_strip_theta()

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.

this is a simple way to remove the polar angle dependence. the strip is normalized in place, previous data is overwritten.

Parameters
[in,out]strip2D data, X-axis = analyser angle, Y-axis = arbitrary manipulator scan
[in]thetapolar manipulator angle, 0 = normal emission, 90 = grazing emission
[in]theta_offset
[in]smooth_methodsmoothing method
  • 0 none
  • 1 binomial (requires monotonic theta), see Igor's Smooth operation
  • 2 boxcar (requires monotonic theta), see Igor's Smooth operation
  • 3 polynomial fit per slice
  • 4 (default) Loess, see Igor's Loess operation
caution: binomial and boxcar smoothing are not aware of theta. this may give unpredictable results if theta is non-monotonic.
[in]smooth_factorsmoothing parameter, depends on smooth_method
  • binomial/boxcar: see Igor's Smooth operation
  • loess: see Igor's Loess operation, 0 <= smooth_factor <= 1, default 0.5
  • polynomial fit: polynomial degree, 1 = linear (default), 2 = quadratic
checkenable output of intermediate results
  • 0 (default) don't create additional waves
  • 1 create check waves in the current folder
  • 2 calculate check waves only, do not modify strip
Returns
if check waves are enabled, the following waves are created (overwritten if existing):
  • check_dist average theta distribution
  • check_smoo smoothed distribution used to normalize the strip

Definition at line 433 of file pearl-anglescan-process.ipf.

◆ normalize_strip_theta_scans()

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.

Warning
experimental. this function is under development.

Definition at line 594 of file pearl-anglescan-process.ipf.

◆ normalize_strip_thetaphi()

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.

this is a simple way to remove the polar angle dependence. in contrast to normalize_strip_theta this function also removes a smooth variation over azimuthal angles.

the strip is normalized in place, previous data is overwritten.

Warning
experimental. this function is under development.
Parameters
[in,out]strip2D data, X-axis = analyser angle, Y-axis = arbitrary manipulator scan
[in]thetapolar manipulator angle, 0 = normal emission, 90 = grazing emission
[in]phiazimuthal manipulator angle.
[in]theta_offset
[in]smooth_methodsmoothing method
  • 0 none
  • 4 (default) Loess, see Igor's Loess operation
[in]smooth_factorsmoothing parameter, depends on smooth_method
  • loess: see Igor's Loess operation, 0 <= smooth_factor <= 1, default 0.5
checkenable output of intermediate results
  • 0 (default) don't create additional waves
  • 1 create check waves in the current folder
  • 2 calculate check waves only, do not modify strip
Returns
if check waves are enabled, the following waves are created (overwritten if existing):
  • check_dist average theta distribution
  • check_smoo smoothed distribution used to normalize the strip

Definition at line 533 of file pearl-anglescan-process.ipf.

◆ normalize_strip_x()

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.

this is a simple way to remove the effect of the angle-dependence of the analyser transmission function. the strip is normalized in place, previous data is overwritten.

the function can handle sparse NaNs.

Parameters
[in,out]strip2D data, X-axis = analyser angle, Y-axis = arbitrary manipulator scan
[in]smooth_methodsmoothing method
  • 0 none
  • 1 binomial, see Igor's Smooth operation
  • 2 boxcar, see Igor's Smooth operation
  • 3 scienta_ang_transm() function fit
  • 4 (default) LOESS smoothing, see Igor's Loess operation
[in]smooth_factornum parameter of Igor's Smooth operation. the default value depends on smooth_method. it is 0.5 for LOESS smoothing, 2 otherwise.
[in]checkenable output of intermediate results
  • 0 (default) don't create additional waves
  • 1 create check waves in the current folder
  • 2 calculate check waves only, do not modify strip
Returns
if check waves are enabled, the following waves are created (overwritten if existing):
  • check_dist average X distribution
  • check_smoo smoothed distribution used to normalize the strip

Definition at line 252 of file pearl-anglescan-process.ipf.

◆ pizza_service()

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

accepts angle-scan data as returned by adh5_load_reduced(), maps them onto a hemispherical scan grid, and displays a polar graph.

Parameters
data2D intensity wave, see requirements above
  • X-axis analyser angle
  • Y-axis manipulator scan. no specific ordering required. manipulator angle waves (ManipulatorTheta, ManipulatorTilt, ManipulatorPhi) must be in the subfolder attr below the data wave.
nicknamenick name for output data
  • in default mode, this will become the name of a child folder containing the output.
  • in XPDplot mode, this will become a prefix of the generated data in the root folder.
theta_offsetmanipulator theta angle corresponding to normal emission. the offset is subtracted from the ManipulatorTheta wave before processing.
tilt_offsetmanipulator tilt angle corresponding to normal emission the offset is subtracted from the ManipulatorTilt wave before processing.
phi_offsetmanipulator phi angle corresponding to phi_result = 0 the offset is subtracted from the ManipulatorPhi wave before processing.
npolarnumber of polar angles, determines polar and azimuthal step size. default = 91 (1 degree steps)
foldingrotational averaging, default = 1
nographdisplay a new graph window?
  • 0 (default) display a new polar graph
  • 1 don't display a new graph
xpdplotXPDplot compatibility
  • 0 (default) create waves in child folder $nickname
  • 1 create waves in root folder (compatible with XPDplot)
Attention
if you modify the structure of the data wave, e.g. delete some angles, this function cannot be used because the manipulator settings do not correspond to the original manipulator waves! instead, create your own manipulator waves and use pizza_service_2().

Definition at line 843 of file pearl-anglescan-process.ipf.

◆ pizza_service_2()

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

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.

Parameters
data2D intensity wave, see requirements above
  • X-axis analyser angle
  • Y-axis manipulator scan. no specific ordering required. manipulator angle waves (ManipulatorTheta, ManipulatorTilt, ManipulatorPhi) must be in the subfolder attr below the data wave.
nicknamenick name for output data
  • in default mode, this will become the name of a child folder containing the output.
  • in XPDplot mode, this will become a prefix of the generated data in the root folder.
m_thetamanipulator theta angles, 0 = normal emission. size = dimsize(data, 1)
m_tiltmanipulator tilt angles, 0 = normal emission. size = dimsize(data, 1)
m_phimanipulator phi angles, 0 = azimuthal origin. size = dimsize(data, 1)
npolarnumber of polar angles, determines polar and azimuthal step size. default = 91 (1 degree steps)
foldingrotational averaging, default = 1
nographdisplay a new graph window?
  • 0 (default) display a new polar graph
  • 1 don't display a new graph
xpdplotXPDplot compatibility
  • 0 (default) create waves in child folder $nickname
  • 1 create waves in root folder (compatible with XPDplot)

Definition at line 936 of file pearl-anglescan-process.ipf.

◆ polar_graph_hook()

static variable polar_graph_hook ( WMWinHookStruct *  s)
static

polar 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 2547 of file pearl-anglescan-process.ipf.

◆ prepare_hemi_scan_display()

string prepare_hemi_scan_display ( string  nickname,
variable  projection = defaultValue 
)

create waves for plotting a hemispherical angle scan.

the scan data must exist in the current data folder.

Parameters
nicknamename prefix of holo waves. may be empty.
projectionmapping function from polar to cartesian coordinates. see Projections for details.
  • kProjDist = 0 azimuthal equidistant
  • kProjStereo = 1 stereographic (default)
  • kProjArea = 2 azimuthal equal-area
  • kProjGnom = 3 gnomonic (0 <= polar < 90)
  • kProjOrtho = 4 orthographic

Definition at line 1776 of file pearl-anglescan-process.ipf.

◆ quick_pizza_image()

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

accepts angle-scan data as returned by adh5_load_reduced, maps them onto a rectangular grid in stereographic projection

Parameters
data2D data wave, X-axis = analyser angle, Y-axis = manipulator scan (no specific ordering required)
Precondition
manipulator angles as attributes in attr folder next to the data wave
Warning
EXPERIMENTAL

Definition at line 2986 of file pearl-anglescan-process.ipf.

◆ rotate_hemi_scan()

variable rotate_hemi_scan ( string  nickname,
variable  angle 
)

azimuthally rotate a hemispherical scan dataset.

this function works only for hemi scans created by make_hemi_grid() (or compatible functions).

Parameters
nicknamename prefix for waves. source data must be in current data folder.
angleazimuthal rotation angle in degrees.

Definition at line 1728 of file pearl-anglescan-process.ipf.

◆ save_hemi_scan()

variable save_hemi_scan ( string  nickname,
string  pathname,
string  filename 
)

save a hemispherical scan to an Igor text file

Definition at line 3097 of file pearl-anglescan-process.ipf.

◆ set_contrast()

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.

set the minimum and maximum values of the pseudocolor scale such that a specified percentile of the distribution lies outside the limits.

the new contrast is applied to traces and images of the selected graph that have pseudocolor tables.

the function is not specific to angle scans. it can be used for any pseudocolor trace or image plots except contour plots.

Parameters
pcminpercentile below the minimum color (0-100).
pcmaxpercentile above the maximum color (0-100).
graphnamename of graph. default: top graph.
colortablename of new colortable. default: keep current table.
reversecolorsreverse colors of new colorable. takes effect only if colortable argument is defined.
  • 0 (default) normal colors,
  • 1 reverse color table
symmetricmake scale symmetric about zero (for modulation functions, e.g.).
  • 0 (default) do not enforce symmetry.
  • 1 try symmetric scale if "reasonable".

Definition at line 3463 of file pearl-anglescan-process.ipf.

◆ set_polar_graph_cursor()

variable set_polar_graph_cursor ( string  nickname,
string  cursorname,
variable  polar_angle,
variable  azim_angle,
string  graphname = defaultValue 
)

Definition at line 2567 of file pearl-anglescan-process.ipf.

◆ show_analyser_line()

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

this can be used to compare to an hemispherical plot and check the manipulator angle.

Parameters
thetamanipulator theta angle
tiltmanipulator tilt angle
phimanipulator phi angle
theta_offsetmanipulator theta angle corresponding to normal emission
tilt_offsetmanipulator tilt angle corresponding to normal emission
phi_offsetmanipulator phi angle corresponding to phi_result = 0
npolarnumber of polar angles, determines polar and azimuthal step size. default = 91 (1 degree steps)
nographdisplay a new graph window?
  • 0 (default) display a new polar graph
  • 1 don't display a new graph
xpdplotXPDplot compatibility
  • 0 (default) create waves in child folder $nickname
  • 1 create waves in root folder (compatible with XPDplot)
Remarks
the function creates angle scan data under the nickname analyser.

Definition at line 1053 of file pearl-anglescan-process.ipf.

◆ strip_append()

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.

Attention
this function modifies all matching waves in the data and attr folders of strip1! consider a backup before calling the function, or work on a copy of the original data (cf. Igor's DuplicateDataFolder operation)!
Parameters
[in,out]strip12D data, X-axis = analyser angle, Y-axis = arbitrary manipulator scan. this is the first source wave and destination wave.
[in]strip22D data, X-axis = analyser angle, Y-axis = arbitrary manipulator scan. this is the second source wave.
Returns
(string) semicolon-separated list of modified wave names (without folder path).

Definition at line 106 of file pearl-anglescan-process.ipf.

◆ strip_delete_frames()

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.

this can be used to remove a region of bad frames due to, e.g., measurement problems. the function operates on 2D intensity data and manipulator coordinates at the same time.

Parameters
[in,out]strip2D data, X-axis = analyser angle, Y-axis = arbitrary manipulator scan. the result is written to the original wave.
[in,out]theta1D data, manipulator scan. the result is written to the original wave.
[in,out]tilt1D data, manipulator scan. the result is written to the original wave.
[in,out]phi1D data, manipulator scan. the result is written to the original wave.
[in]qlopoint index of first frame to delete.
[in]qhipoint index of last frame to delete. qhi must be greater or equal than qlo.

Definition at line 170 of file pearl-anglescan-process.ipf.

◆ trim_hemi_scan()

variable trim_hemi_scan ( string  nickname,
variable  theta_max 
)

trim a hemispherical scan at grazing angle

the function recalaculates the values wave from totals and weights but sets elements above a given polar angle to nan.

Parameters
nicknamename of the scan dataset. can be empty if no prefix is used. the dataset must be in the current datafolder.
theta_maxhighest polar angle to keep (0...90 degrees).

Definition at line 3229 of file pearl-anglescan-process.ipf.

◆ update_polar_info()

static variable update_polar_info ( string  graphname)
static

update the angles info based on cursors A and B of a given polar graph window

the function reads the projection mode from the user data of the graph window and the zeroAngleWhere variable from the associated WMPolarGraph data folder.

the calculated angles are written to the csrA_theta, csrA_phi, csrB_theta, and csrB_phi global variables in the polar graph data folder. the angles text box of the graph updates from to these variables dynamically.

Parameters
graphnamename of polar graph window

Definition at line 2512 of file pearl-anglescan-process.ipf.

Variable Documentation

◆ kProjArea

const variable kProjArea = 2

Definition at line 2344 of file pearl-anglescan-process.ipf.

◆ kProjDist

const variable kProjDist = 0

Definition at line 2342 of file pearl-anglescan-process.ipf.

◆ kProjGnom

const variable kProjGnom = 3

Definition at line 2345 of file pearl-anglescan-process.ipf.

◆ kProjOrtho

const variable kProjOrtho = 4

Definition at line 2346 of file pearl-anglescan-process.ipf.

◆ kProjScaleArea

const variable kProjScaleArea = 2
static

Definition at line 2350 of file pearl-anglescan-process.ipf.

◆ kProjScaleDist

const variable kProjScaleDist = 2
static

Definition at line 2348 of file pearl-anglescan-process.ipf.

◆ kProjScaleGnom

const variable kProjScaleGnom = 0.06744519021
static

Definition at line 2352 of file pearl-anglescan-process.ipf.

◆ kProjScaleOrtho

const variable kProjScaleOrtho = 2
static

Definition at line 2353 of file pearl-anglescan-process.ipf.

◆ kProjScaleStereo

const variable kProjScaleStereo = 2
static

Definition at line 2349 of file pearl-anglescan-process.ipf.

◆ kProjStereo

const variable kProjStereo = 1

Definition at line 2343 of file pearl-anglescan-process.ipf.