Hjyreadr

From Eigenvector Research Documentation Wiki
Revision as of 09:47, 10 June 2014 by imported>Scott (→‎Optional Inputs)
Jump to navigation Jump to search

Purpose

Reads HORIBA Jobin Yvon files (needs LabSpec ActiveX control installed).

Synopsis

out = hjyreadr
out = hjyreadr('filename',options)
out = hjyreadr({'filename' 'filename2'},options)

Description

When the function is first run it will prompt the user to install the ActiveX component (Windows Only).

Inputs

  • filename = a text string with the name of an ASF file or a cell of strings of ASF filenames. If (filename) is omitted or empty user will be prompted for files.

NOTE: File types can come from LabSpec version 4 and 5. Version 4 uses .tsf (spectrum) and .tvf (map/image). Version 5 uses .HJY (spectrum) and .ngc (map/image).

Optional Inputs

  • showparams = [ 'on' |{'off'}] Display a list of parameters for the given file. This feature is only enabled when single file is input.
  • installedversion : [0] Version ocx controls was installed under. Will be updated if versions differ.
  • systemcheck : [1] Governs checking for compatible operating system. If 0 (zero), the operating system will not be checked for compatibility. Usually, this will lead to errors about missing activeX objects and similar.
  • ocxcheck : [1] Flag governing checking for the a correct version of the Horiba ActiveX object (OCX) is installed. If 0 (zero), the OCX version will not be checked. This may be necessary for platforms where the OCX is correctly installed but is not the expected version.
  • forceinstall : [0] Flag governing whether the OCX should be installed automatically without asking the user. Normally, if the OCX isn't located, the user is prompted for whether or not to install the OCX.

Outputs

  • out = takes one of two forms:
1) If input is a single file, the output is a dataset object.
2) If the input consists of multiple files, the output is a cell array with a dataset object for each input file (see the nonmatching option defined above).

Options

options = a structure array with the following fields:

  • showparams = [ 'on' |{'off'}] Display a list of parameters for the given file. This feature is only enabled when single file is input.

See Also

Data Importing Formats, fluoromaxreadr, jcampreadr, spcreadr, writespc, xclreadr