preview and import panel for PEARL data More...

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

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

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

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

◆ attributes_notebook()

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

static

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

◆ bp_attr_notebook()

static variable bp_attr_notebook ( WMButtonAction * ba )

static

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

◆ bp_browse_filepath()

static variable bp_browse_filepath ( WMButtonAction * ba )

static

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

◆ bp_dataset_display()

static variable bp_dataset_display ( WMButtonAction * ba )

static

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

◆ bp_dataset_folder()

static variable bp_dataset_folder ( WMButtonAction * ba )

static

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

◆ bp_dataset_next()

static variable bp_dataset_next ( WMButtonAction * ba )

static

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

◆ bp_dataset_prev()

static variable bp_dataset_prev ( WMButtonAction * ba )

static

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

◆ bp_file_next()

static variable bp_file_next ( WMButtonAction * ba )

static

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

◆ bp_file_prev()

static variable bp_file_prev ( WMButtonAction * ba )

static

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

◆ bp_load_files()

static variable bp_load_files ( WMButtonAction * ba )

static

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

◆ bp_load_files_opt()

static variable bp_load_files_opt ( WMButtonAction * ba )

static

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

◆ bp_load_prefs()

static variable bp_load_prefs ( WMButtonAction * ba )

static

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

◆ bp_save_prefs()

static variable bp_save_prefs ( WMButtonAction * ba )

static

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

◆ bp_update_datasets()

static variable bp_update_datasets ( WMButtonAction * ba )

static

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

◆ bp_update_filelist()

static variable bp_update_filelist ( WMButtonAction * ba )

static

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

◆ display_dataset()

static variable display_dataset ( string datasetname )

static

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

◆ display_preview_trace()

static string display_preview_trace	(	wave	xtrace,
		wave	ytrace
	)

static

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

◆ extract_preview_image()

static variable extract_preview_image	(	wave	data,
		wave	preview
	)

static

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

◆ init_package()

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

◆ itx_suggest_foldername()

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

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

◆ lbp_datasets()

static variable lbp_datasets ( WMListboxAction * lba )

static

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

◆ lbp_filelist()

static variable lbp_filelist ( WMListboxAction * lba )

static

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

◆ load_file()

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

static

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

◆ load_hdf_file()

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

static

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

◆ load_itx_file()

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

static

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

◆ load_mtrx_file()

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

static

load a matrix (STM) data file

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

◆ load_prefs()

static variable load_prefs ( )

static

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

◆ load_pshell_file()

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

static

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

◆ load_selected_files()

static variable load_selected_files ( string options = defaultValue )

static

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

◆ notebook_add_attributes()

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

static

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

◆ pearl_data_explorer()

variable pearl_data_explorer ( )

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

◆ pearl_file_type()

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

◆ PearlDataExplorer()

void PearlDataExplorer ( )

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

◆ preview_attributes()

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

◆ preview_datafolder()

static variable preview_datafolder ( )

static

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

◆ preview_dataset()

static variable preview_dataset ( string datasetname )

static

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

◆ preview_file()

static variable preview_file ( string filename )

static

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

◆ preview_hdf_file()

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

◆ preview_itx_file()

static wave preview_itx_file ( string filename )

static

load the preview of a general ITX file.

the function is designed for PEARL OTF and EPICS scan data converted from MDA files. the function picks the first wave whose PV note matches one from the global string s_preview_pvs (see preview_datafolder and init_package).

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.

Note: : the ITX files should load their waves into the current data folder (a "free" data folder). some early versions of PEARL ITX data files created a data folder of their own. both ways are allowed, while the first one is preferred. on return, the current data folder must point to either the original free folder or the newly created one.

Parameters

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

Returns: wave reference of the preview trace. empty wave reference if the function failed.

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

◆ preview_mtrx_file()

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

◆ preview_pshell_file()

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

◆ preview_setscale_x()

static variable preview_setscale_x	(	wave	data,
		wave	preview
	)

static

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

◆ prompt_default_process()

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

◆ prompt_func_params()

variable prompt_func_params	(	string	func_name,
		string *	func_param
	)

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

◆ prompt_hdf_options()

static variable prompt_hdf_options ( string * options )

static

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

◆ save_prefs()

static variable save_prefs ( )

static

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.

◆ show_preview_graph()

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

static

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

◆ test_attributes_notebook()

variable test_attributes_notebook ( )

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

◆ update_datasets()

static variable update_datasets ( )

static

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

◆ update_filelist()

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

Variable Documentation

◆ ks_filematch_adh5

const string ks_filematch_adh5 = "*.h5"

static

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

◆ ks_filematch_itx

const string ks_filematch_itx = "*.itx"

static

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

◆ ks_filematch_mtrx

const string ks_filematch_mtrx = "*_mtrx"

static

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

◆ ks_filematch_pshell

const string ks_filematch_pshell = "psh*.h5"

static

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

◆ package_name

const string package_name = "pearl_explorer"

static

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

◆ package_path

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

static

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

Namespaces

Functions

Variables

Detailed Description

Function Documentation

◆ attributes_notebook()

◆ bp_attr_notebook()

◆ bp_browse_filepath()

◆ bp_dataset_display()

◆ bp_dataset_folder()

◆ bp_dataset_next()

◆ bp_dataset_prev()

◆ bp_file_next()

◆ bp_file_prev()

◆ bp_load_files()

◆ bp_load_files_opt()

◆ bp_load_prefs()

◆ bp_save_prefs()

◆ bp_update_datasets()

◆ bp_update_filelist()

◆ display_dataset()

◆ display_preview_trace()

◆ extract_preview_image()

◆ init_package()

◆ itx_suggest_foldername()

◆ lbp_datasets()

◆ lbp_filelist()

◆ load_file()

◆ load_hdf_file()

◆ load_itx_file()

◆ load_mtrx_file()

◆ load_prefs()

◆ load_pshell_file()

◆ load_selected_files()

◆ notebook_add_attributes()

◆ pearl_data_explorer()

◆ pearl_file_type()

◆ PearlDataExplorer()

◆ preview_attributes()

◆ preview_datafolder()

◆ preview_dataset()

◆ preview_file()

◆ preview_hdf_file()

◆ preview_itx_file()

◆ preview_mtrx_file()

◆ preview_pshell_file()

◆ preview_setscale_x()

◆ prompt_default_process()

◆ prompt_func_params()

◆ prompt_hdf_options()

◆ save_prefs()

◆ show_preview_graph()

◆ test_attributes_notebook()

◆ update_datasets()

◆ update_filelist()

Variable Documentation

◆ ks_filematch_adh5

◆ ks_filematch_itx

◆ ks_filematch_mtrx

◆ ks_filematch_pshell

◆ package_name

◆ package_path