PEARL Procedures rev-distro-1.6.0-0-gcf1399e-dirty Igor procedures for the analysis of PEARL data

- Main Page
- Related Pages
- Packages
- Namespaces
- Files

- File List
- Globals

Namespaces | Functions | Variables
pearl-data-explorer.ipf File Reference
ARPES package

preview and import panel for PEARL data More...

`#include "pearl-area-import"`
`#include "pearl-area-profiles"`
`#include "pearl-area-display"`
`#include "pearl-pshell-import"`

Go to the source code of this file.

## Namespaces
| PearlDataExplorer
| preview and import panel for PEARL data

## Functions
variable | pearl_data_explorer ()
static variable | init_package ()
| initialize the global variables of the data explorer. More...
static variable | save_prefs ()
static variable | load_prefs ()
static variable | pearl_file_type (string filename)
| check whether a file can be imported by this module. More...
static variable | update_filelist ()
| read a list of PEARL files from the file system More...
static variable | update_datasets ()
static variable | preview_file (string filename)
static wave | preview_pshell_file (string filename)
| 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...
static wave | preview_itx_file (string filename)
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)
static variable | preview_dataset (string datasetname)
static variable | preview_datafolder ()
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 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)
static variable | load_file (string filename, string options=defaultValue)
static variable | prompt_hdf_options (string *options)
variable | prompt_default_process (string *param)
| 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...
string | itx_suggest_foldername (string filename, variable ignoredate=defaultValue, string sourcename=defaultValue, variable unique=defaultValue)
void | PearlDataExplorer ()
static variable | bp_load_prefs (WMButtonAction *ba)
static variable | bp_save_prefs (WMButtonAction *ba)
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 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)

## Variables
static const string | package_name = "pearl_explorer"
static const string | package_path = "root:packages:pearl_explorer:"
static const string | ks_filematch_adh5 = "*.h5"
static const string | ks_filematch_pshell = "psh*.h5"
static const string | ks_filematch_itx = "*.itx"
static const string | ks_filematch_mtrx = "*_mtrx"

## Detailed Description

preview and import panel for PEARL data

preview and import panel for PEARL data:

- area detector (HDF5) files from scienta analyser and prosilica cameras (if HDF5.xop is installed).
- igor text files from s-scans and otf-scans.
- pshell (HDF5) data files (if HDF5.xop is installed).
- matrix STM files (if MatrixFileReader.xop is installed).

Definition in file pearl-data-explorer.ipf.

## Function Documentation

static variable attributes_notebook | ( | wave | attr_names,
|  | wave | attr_values,
|  | string | title
| ) |  |
| static

Definition at line 805 of file pearl-data-explorer.ipf.

static variable bp_attr_notebook | ( | WMButtonAction * | ba | ) |
| static

Definition at line 1733 of file pearl-data-explorer.ipf.

static variable bp_browse_filepath | ( | WMButtonAction * | ba | ) |
| static

Definition at line 1419 of file pearl-data-explorer.ipf.

static variable bp_dataset_display | ( | WMButtonAction * | ba | ) |
| static

Definition at line 1624 of file pearl-data-explorer.ipf.

static variable bp_dataset_folder | ( | WMButtonAction * | ba | ) |
| static

Definition at line 1598 of file pearl-data-explorer.ipf.

static variable bp_dataset_next | ( | WMButtonAction * | ba | ) |
| static

Definition at line 1644 of file pearl-data-explorer.ipf.

static variable bp_dataset_prev | ( | WMButtonAction * | ba | ) |
| static

Definition at line 1671 of file pearl-data-explorer.ipf.

static variable bp_file_next | ( | WMButtonAction * | ba | ) |
| static

Definition at line 1485 of file pearl-data-explorer.ipf.

static variable bp_file_prev | ( | WMButtonAction * | ba | ) |
| static

Definition at line 1517 of file pearl-data-explorer.ipf.

static variable bp_load_files | ( | WMButtonAction * | ba | ) |
| static

Definition at line 1457 of file pearl-data-explorer.ipf.

static variable bp_load_files_opt | ( | WMButtonAction * | ba | ) |
| static

Definition at line 1471 of file pearl-data-explorer.ipf.

static variable bp_load_prefs | ( | WMButtonAction * | ba | ) |
| static

Definition at line 1391 of file pearl-data-explorer.ipf.

static variable bp_save_prefs | ( | WMButtonAction * | ba | ) |
| static

Definition at line 1405 of file pearl-data-explorer.ipf.

static variable bp_update_datasets | ( | WMButtonAction * | ba | ) |
| static

Definition at line 1584 of file pearl-data-explorer.ipf.

static variable bp_update_filelist | ( | WMButtonAction * | ba | ) |
| static

Definition at line 1443 of file pearl-data-explorer.ipf.

static variable display_dataset | ( | string | datasetname | ) |
| static

Definition at line 765 of file pearl-data-explorer.ipf.

static string display_preview_trace | ( | wave | xtrace,
|  | wave | ytrace
| ) |  |
| static

Definition at line 922 of file pearl-data-explorer.ipf.

static variable extract_preview_image | ( | wave | data,
|  | wave | preview
| ) |  |
| static

Definition at line 478 of file pearl-data-explorer.ipf.

static variable init_package | ( |  | ) |
| static

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 55 of file pearl-data-explorer.ipf.

string itx_suggest_foldername | ( | string | filename,
|  | variable | ignoredate = `defaultValue`,
|  | string | sourcename = `defaultValue`,
|  | variable | unique = `defaultValue`
| ) |  |

Definition at line 1241 of file pearl-data-explorer.ipf.

static variable lbp_datasets | ( | WMListboxAction * | lba | ) |
| static

Definition at line 1698 of file pearl-data-explorer.ipf.

static variable lbp_filelist | ( | WMListboxAction * | lba | ) |
| static

Definition at line 1549 of file pearl-data-explorer.ipf.

static variable load_file | ( | string | filename,
|  | string | options = `defaultValue`
| ) |  |
| static

Definition at line 979 of file pearl-data-explorer.ipf.

static dfr load_hdf_file | ( | string | filename,
|  | string | options = `defaultValue`
| ) |  |
| static

Definition at line 1125 of file pearl-data-explorer.ipf.

static dfr load_itx_file | ( | string | filename,
|  | string | options = `defaultValue`
| ) |  |
| static

Definition at line 1175 of file pearl-data-explorer.ipf.

static dfr load_mtrx_file | ( | string | filename,
|  | string | options = `defaultValue`
| ) |  |
| static

load a matrix (STM) data file

Definition at line 1218 of file pearl-data-explorer.ipf.

static variable load_prefs | ( |  | ) |
| static

Definition at line 116 of file pearl-data-explorer.ipf.

static dfr load_pshell_file | ( | string | filename,
|  | string | options = `defaultValue`
| ) |  |
| static

Definition at line 1073 of file pearl-data-explorer.ipf.

static variable load_selected_files | ( | string | options = `defaultValue` | ) |
| static

Definition at line 955 of file pearl-data-explorer.ipf.

static variable notebook_add_attributes | ( | string | notebook_name,
|  | wave | attr_filter,
|  | wave | attr_names,
|  | wave | attr_values
| ) |  |
| static

Definition at line 844 of file pearl-data-explorer.ipf.

variable pearl_data_explorer | ( |  | ) |

Definition at line 44 of file pearl-data-explorer.ipf.

static variable pearl_file_type | ( | string | filename | ) |
| static

check whether a file can be imported by this module.

the file type is determined by the extension of the file name.

Returns
  file type
  - 0 not a recognized file type
  - 1 PShell file (HDF5, name starts with psh_)
  - 2 area detector HDF5 file
  - 3 Igor text (itx) file
  - 4 Matrix STM file (*_mtrx)

Definition at line 161 of file pearl-data-explorer.ipf.

void PearlDataExplorer | ( |  | ) |

Definition at line 1300 of file pearl-data-explorer.ipf.

static variable preview_attributes | ( | dfref | attr_folder,
|  | dfref | dest_folder = `defaultValue`,
|  | wave | attr_filter = `defaultValue`,
|  | variable | include_datawaves = `defaultValue`,
|  | variable | include_infowaves = `defaultValue`
| ) |  |
| static

Definition at line 631 of file pearl-data-explorer.ipf.

static variable preview_datafolder | ( |  | ) |
| static

Definition at line 560 of file pearl-data-explorer.ipf.

static variable preview_dataset | ( | string | datasetname | ) |
| static

Definition at line 517 of file pearl-data-explorer.ipf.

static variable preview_file | ( | string | filename | ) |
| static

Definition at line 255 of file pearl-data-explorer.ipf.

static wave preview_hdf_file | ( | string | filename | ) |
| static

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 s_file_info string is updated with information about the scan dimensions.

Parameters

  filename | name of a file in the directory specified by the pearl_explorer_filepath path object.

Returns
  wave reference of the preview image

Definition at line 363 of file pearl-data-explorer.ipf.

static wave preview_itx_file | ( | string | filename | ) |
| static

Definition at line 395 of file pearl-data-explorer.ipf.

static wave preview_mtrx_file | ( | string | filename | ) |
| 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.

Parameters

  filename | name of a file in the directory specified by the pearl_explorer_filepath path object.

Returns
  wave reference of the preview image. empty wave reference if the function failed.

Definition at line 435 of file pearl-data-explorer.ipf.

static wave preview_pshell_file | ( | string | filename | ) |
| static

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 s_file_info string is updated with information about the scan dimensions.

Parameters

  filename | name of a file in the directory specified by the pearl_explorer_filepath path object.

Returns
  wave reference of the preview image

Definition at line 307 of file pearl-data-explorer.ipf.

static variable preview_setscale_x | ( | wave | data,
|  | wave | preview
| ) |  |
| static

Definition at line 601 of file pearl-data-explorer.ipf.

variable prompt_default_process | ( | string * | param | ) |

prototype for prompting for processing function parameters.

the function should prompt the user for function parameters, and update the param argument if the user clicked OK. returns 0 if the user clicked OK, 1 if the user cancelled.

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 1053 of file pearl-data-explorer.ipf.

variable prompt_func_params | ( | string | func_name,
|  | string * | func_param
| ) |  |

Definition at line 1059 of file pearl-data-explorer.ipf.

static variable prompt_hdf_options | ( | string * | options | ) |
| static

Definition at line 1014 of file pearl-data-explorer.ipf.

static variable save_prefs | ( |  | ) |
| static

Definition at line 96 of file pearl-data-explorer.ipf.

static string show_preview_graph | ( | wave | data,
|  | wave | xdata = `defaultValue`
| ) |  |
| static

Definition at line 871 of file pearl-data-explorer.ipf.

variable test_attributes_notebook | ( |  | ) |

Definition at line 798 of file pearl-data-explorer.ipf.

static variable update_datasets | ( |  | ) |
| static

Definition at line 212 of file pearl-data-explorer.ipf.

static variable update_filelist | ( |  | ) |
| static

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.

Definition at line 184 of file pearl-data-explorer.ipf.

## Variable Documentation

const string ks_filematch_adh5 = "*.h5"
| static

Definition at line 39 of file pearl-data-explorer.ipf.

const string ks_filematch_itx = "*.itx"
| static

Definition at line 41 of file pearl-data-explorer.ipf.

const string ks_filematch_mtrx = "*_mtrx"
| static

Definition at line 42 of file pearl-data-explorer.ipf.

const string ks_filematch_pshell = "psh*.h5"
| static

Definition at line 40 of file pearl-data-explorer.ipf.

const string package_name = "pearl_explorer"
| static

Definition at line 36 of file pearl-data-explorer.ipf.

const string package_path = "root:packages:pearl_explorer:"
| static

Definition at line 37 of file pearl-data-explorer.ipf.