pearl-area-profiles.ipf File Reference
ARPES package

profile extraction for multi-dimensional datasets acquired from area detectors. More...

Go to the source code of this file.

## Namespaces

| PearlAreaProfiles
| profile extraction for multi-dimensional datasets acquired from area detectors.

## Functions

threadsafe wave | ad_extract_rod (wave dataset, variable x1, variable x2, variable y1, variable y2, variable z1, variable z2, string destname, variable noavg=defaultValue, variable sdev=defaultValue, variable pscale=defaultValue)
| 1D cut through 3D dataset, integrate in normal dimensions More...
threadsafe wave | ad_extract_rod_x (wave dataset, variable q1, variable q2, variable r1, variable r2, string destname, variable noavg=defaultValue, variable sdev=defaultValue)
| 1D cut through 3D dataset along X dimension. More...
threadsafe wave | ad_extract_rod_y (wave dataset, variable p1, variable p2, variable r1, variable r2, string destname, variable noavg=defaultValue, variable sdev=defaultValue)
| 1D cut through 3D dataset along Y dimension. More...
threadsafe wave | ad_extract_rod_z (wave dataset, variable p1, variable p2, variable q1, variable q2, string destname, variable noavg=defaultValue, variable sdev=defaultValue)
| 1D cut through 3D dataset along Z dimension. More...
threadsafe wave | ad_extract_slab (wave dataset, variable x1, variable x2, variable y1, variable y2, variable z1, variable z2, string destname, variable noavg=defaultValue, variable pscale=defaultValue)
| 2D cut through 3D dataset, integrate in normal dimension More...
threadsafe wave | ad_extract_slab_x (wave dataset, variable p1, variable p2, string destname, variable noavg=defaultValue)
threadsafe wave | ad_extract_slab_y (wave dataset, variable q1, variable q2, string destname, variable noavg=defaultValue)
threadsafe wave | ad_extract_slab_z (wave dataset, variable r1, variable r2, string destname, variable noavg=defaultValue)
threadsafe wave | ad_profile_x (wave dataset, variable q1, variable q2, string destname, variable noavg=defaultValue)
| 1D cut through 2D dataset along X dimension, new destination wave. More...
threadsafe wave | ad_profile_x_w (wave dataset, variable q1, variable q2, wave destwave, variable noavg=defaultValue)
| 1D cut through 2D dataset along X dimension, existing destination wave. More...
threadsafe wave | ad_profile_y (wave dataset, variable p1, variable p2, string destname, variable noavg=defaultValue)
| 1D cut through 2D dataset along Y dimension, new destination wave. More...
threadsafe wave | ad_profile_y_w (wave dataset, variable p1, variable p2, wave destwave, variable noavg=defaultValue)
| 1D cut through 2D dataset along X dimension, existing destination wave. More...
threadsafe variable | calc_y_profile_mins (wave image)
variable | ad_collect_multiscan_y (wave dataset, wave positions, wave destwave, variable noavg=defaultValue)
| collect profiles from a multi-scan. More...

## Detailed Description

profile extraction for multi-dimensional datasets acquired from area detectors.

Author
  matthias muntwiler, matth.nosp@m.ias..nosp@m.muntw.nosp@m.iler.nosp@m.@psi..nosp@m.ch

Copyright
  2013-15 Paul Scherrer Institut
  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

Definition in file pearl-area-profiles.ipf.

## Function Documentation

## ad_collect_multiscan_y()

variable ad_collect_multiscan_y | ( | wave | dataset,
|  | wave | positions,
|  | wave | destwave,
|  | variable | noavg = `defaultValue`
| ) |  |

collect profiles from a multi-scan.

Warning
  experimental: name and interface of this function may change.

Definition at line 621 of file pearl-area-profiles.ipf.

## ad_extract_rod()

threadsafe wave ad_extract_rod | ( | wave | dataset,
|  | variable | x1,
|  | variable | x2,
|  | variable | y1,
|  | variable | y2,
|  | variable | z1,
|  | variable | z2,
|  | string | destname,
|  | variable | noavg = `defaultValue`,
|  | variable | sdev = `defaultValue`,
|  | variable | pscale = `defaultValue`
| ) |  |

1D cut through 3D dataset, integrate in normal dimensions

Parameters

  dataset |
  x1,x2,y1,y2,z1,z2 | coordinates of integration region by default, the coordinates use wave scaling coordinates of rod dimensions (to be preserved) must be nan coordinate pairs don't have to be ordered, i.e. both x1 <= x2 and x1 >= x2 are allowed.
  destname | name of destination wave. to be created in current data folder. if empty, the function returns a free wave
  noavg | non-zero = calculate the sum, default = 0 as of version 1.05, this option should rather be called "calc_sum" or similar. it is noavg for compatibility with older code.
  sdev | non-zero = calculate the standard deviation, default = 0 by default, the function calculates the average of the integration region set either the noavg or sdev option to select the sum or the standard deviation, respectively. if both options are set, noavg (sum) takes precedence.
  pscale | scaling of the slab coordinates x1, x2, ..., z2: zero or default = wave scaling, non-zero = point scaling

Remarks
  - version 1.02: the specification of the destination coordinates has changed
  - version 1.04: the function returns an empty wave reference if an error occurred

Definition at line 54 of file pearl-area-profiles.ipf.

## ad_extract_rod_x()

threadsafe wave ad_extract_rod_x | ( | wave | dataset,
|  | variable | q1,
|  | variable | q2,
|  | variable | r1,
|  | variable | r2,
|  | string | destname,
|  | variable | noavg = `defaultValue`,
|  | variable | sdev = `defaultValue`
| ) |  |

1D cut through 3D dataset along X dimension.

see ad_extract_rod() for descriptions of common parameters.

Definition at line 106 of file pearl-area-profiles.ipf.

## ad_extract_rod_y()

threadsafe wave ad_extract_rod_y | ( | wave | dataset,
|  | variable | p1,
|  | variable | p2,
|  | variable | r1,
|  | variable | r2,
|  | string | destname,
|  | variable | noavg = `defaultValue`,
|  | variable | sdev = `defaultValue`
| ) |  |

1D cut through 3D dataset along Y dimension.

see ad_extract_rod() for descriptions of common parameters.

Definition at line 168 of file pearl-area-profiles.ipf.

## ad_extract_rod_z()

threadsafe wave ad_extract_rod_z | ( | wave | dataset,
|  | variable | p1,
|  | variable | p2,
|  | variable | q1,
|  | variable | q2,
|  | string | destname,
|  | variable | noavg = `defaultValue`,
|  | variable | sdev = `defaultValue`
| ) |  |

1D cut through 3D dataset along Z dimension.

see ad_extract_rod() for descriptions of common parameters.

Definition at line 231 of file pearl-area-profiles.ipf.

## ad_extract_slab()

threadsafe wave ad_extract_slab | ( | wave | dataset,
|  | variable | x1,
|  | variable | x2,
|  | variable | y1,
|  | variable | y2,
|  | variable | z1,
|  | variable | z2,
|  | string | destname,
|  | variable | noavg = `defaultValue`,
|  | variable | pscale = `defaultValue`
| ) |  |

2D cut through 3D dataset, integrate in normal dimension

Parameters

  dataset |
  x1,x2,y1,y2,z1,z2 | coordinates of integration region. by default, the coordinates use wave scaling. coordinates of slab dimensions (to be preserved) must be nan. coordinate pairs don't have to be ordered, i.e. both x1 <= x2 and x1 >= x2 are allowed. coordinates can be out of range (-inf and +inf allowed) to select the whole range.
  destname | name of destination wave. to be created in current data folder. if empty, the function returns a free wave.
  noavg | zero or default = average, non-zero = sum.
  pscale | scaling of the slab coordinates x1, x2, ..., z2: zero or default = wave scaling, non-zero = point scaling.

Remarks
  - version 1.02: the specification of the destination coordinates has changed
  - version 1.04: the function returns an empty wave reference if an error occurred

Definition at line 313 of file pearl-area-profiles.ipf.

## ad_extract_slab_x()

threadsafe wave ad_extract_slab_x | ( | wave | dataset,
|  | variable | p1,
|  | variable | p2,
|  | string | destname,
|  | variable | noavg = `defaultValue`
| ) |  |

Definition at line 358 of file pearl-area-profiles.ipf.

## ad_extract_slab_y()

threadsafe wave ad_extract_slab_y | ( | wave | dataset,
|  | variable | q1,
|  | variable | q2,
|  | string | destname,
|  | variable | noavg = `defaultValue`
| ) |  |

Definition at line 398 of file pearl-area-profiles.ipf.

## ad_extract_slab_z()

threadsafe wave ad_extract_slab_z | ( | wave | dataset,
|  | variable | r1,
|  | variable | r2,
|  | string | destname,
|  | variable | noavg = `defaultValue`
| ) |  |

Definition at line 438 of file pearl-area-profiles.ipf.

## ad_profile_x()

threadsafe wave ad_profile_x | ( | wave | dataset,
|  | variable | q1,
|  | variable | q2,
|  | string | destname,
|  | variable | noavg = `defaultValue`
| ) |  |

1D cut through 2D dataset along X dimension, new destination wave.

Definition at line 480 of file pearl-area-profiles.ipf.

## ad_profile_x_w()

threadsafe wave ad_profile_x_w | ( | wave | dataset,
|  | variable | q1,
|  | variable | q2,
|  | wave | destwave,
|  | variable | noavg = `defaultValue`
| ) |  |

1D cut through 2D dataset along X dimension, existing destination wave.

Definition at line 504 of file pearl-area-profiles.ipf.

## ad_profile_y()

threadsafe wave ad_profile_y | ( | wave | dataset,
|  | variable | p1,
|  | variable | p2,
|  | string | destname,
|  | variable | noavg = `defaultValue`
| ) |  |

1D cut through 2D dataset along Y dimension, new destination wave.

Definition at line 542 of file pearl-area-profiles.ipf.

## ad_profile_y_w()

threadsafe wave ad_profile_y_w | ( | wave | dataset,
|  | variable | p1,
|  | variable | p2,
|  | wave | destwave,
|  | variable | noavg = `defaultValue`
| ) |  |

1D cut through 2D dataset along X dimension, existing destination wave.

Definition at line 567 of file pearl-area-profiles.ipf.

## calc_y_profile_mins()

threadsafe variable calc_y_profile_mins | ( | wave | image | ) |

Definition at line 603 of file pearl-area-profiles.ipf.