Spereadr: Difference between revisions

From Eigenvector Research Documentation Wiki
Jump to navigation Jump to search
imported>Benjamin
(Created page with "===Purpose=== Reads a Princeton Instruments SPE file and saves it into the workspace as a Dataset Object (DSO). ===Synopsis=== :x = spereadr(filename,''options'') :x = sper...")
 
imported>Benjamin
Line 31: Line 31:
''options'' = a structure array with the following fields:
''options'' = a structure array with the following fields:


* '''waitbar''': [ 'off' | {'on'}] governs the display of a waitbar when loading multiple files. If 'auto', waitbar is displayed for larger sets of files only.
* '''waitbar''': [ 'off' | {'on'}] governs the display of a waitbar when loading multiple files.


* '''dsomode''': [{'std'} |'img' ], governs the DSO type that gets outputted by the importer. The options are:
* '''dsomode''': [{'std'} |'img' ], governs the DSO type that gets outputted by the importer. The options are:

Revision as of 12:09, 9 April 2018

Purpose

Reads a Princeton Instruments SPE file and saves it into the workspace as a Dataset Object (DSO).

Synopsis

x = spereadr(filename,options)
x = spereadr()

Description

Reads a Princeton Instruments SPE file. The reader will pre-allocate the data dimensions for the DSO using the Frame dimensions as well as the number of Frames, as specified size found in the file header and/or footer. The importer will then populate the DSO with the data recorded for every Region of Interest (ROI) found in each Frame.

Inputs

  • filename = a text string with the name of a SPE file or a cell containing a string of an SPE filename.
If (filename) is omitted or an empty cell {}, the user will be prompted to select a folder and then a SPE file in the identified folder.
If filename is a blank string, the user will be prompted to select a file.

Optional Inputs

  • options = a structure array containing settings variables (see Options section below).

Outputs

  • x = a dataset object containing the data/spectrum.

Options

options = a structure array with the following fields:

  • waitbar: [ 'off' | {'on'}] governs the display of a waitbar when loading multiple files.
  • dsomode: [{'std'} |'img' ], governs the DSO type that gets outputted by the importer. The options are:
    • 'std' spereadr will return a standard DSO.
    • 'img' spereadr will return an image type DSO. Note: if MIA_Toolbox is not installed spereadr will default to returning a standard DSO.

See Also

Data Importing Formats, MIA_Toolbox_User_Guide