Spcreadr: Difference between revisions
Jump to navigation
Jump to search
imported>Jeremy (Importing text file) |
imported>Jeremy (Importing text file) |
||
| Line 6: | Line 6: | ||
===Description=== | ===Description=== | ||
SPCREADR reads a Galactic SPC file. | SPCREADR reads a Galactic SPC file. | ||
====INPUTS==== | |||
* filename = a text string with the name of a SPC file or a cell of strings of SPC filenames. | * '''filename''' = a text string with the name of a SPC file or a cell of strings of SPC filenames. | ||
* If filename is omitted or blank, the user will be prompted to select a file graphically. | * '''If''' filename is omitted or blank, the user will be prompted to select a file graphically. | ||
* If filename is an empty cell {}, the user will be prompted to select a folder and then one or more SPC files in the folder the identified folder. | * '''If''' filename is an empty cell {}, the user will be prompted to select a folder and then one or more SPC files in the folder the identified folder. | ||
OPTIONAL INPUTS | ====OPTIONAL INPUTS==== | ||
* ''subs'' = [], scalar or vector indicating the sub-files to read, e.g. [3] reads sub-file 3, [3:9] reads sub-files 3 to 9, {default reads all sub-files} and | * '''''subs''''' = [], scalar or vector indicating the sub-files to read, e.g. [3] reads sub-file 3, [3:9] reads sub-files 3 to 9, {default reads all sub-files} and | ||
* ''wlrange'' = [], two element vector (inclusive endpoints) of the wavelength range to return {default returns the entire wavelength range}. | * '''''wlrange''''' = [], two element vector (inclusive endpoints) of the wavelength range to return {default returns the entire wavelength range}. | ||
OUTPUTS | ====OUTPUTS==== | ||
* x = a dataset object containing the spectrum, or | * '''x''' = a dataset object containing the spectrum, or | ||
* data = a data array with measured intensities, | * '''data''' = a data array with measured intensities, | ||
* xaxis = vector containing the wavelength axis, and | * '''xaxis''' = vector containing the wavelength axis, and | ||
* auditlog = char array with the log from the file. | * '''auditlog''' = char array with the log from the file. | ||
===Options=== | ===Options=== | ||
* ''options'' = a structure array with the following fields: | * '''''options''''' = a structure array with the following fields: | ||
* axismatching: [ 'none' | 'intersect' |{'interpolate'} ], defines action taken when the x-axes of two spectra being read do not match. The options are: | * '''axismatching''': [ 'none' | 'intersect' |{'interpolate'} ], defines action taken when the x-axes of two spectra being read do not match. The options are: | ||
* 'intersect' returns only the points where the spectral x-axis values overlap excatly. | * ''''intersect'''' returns only the points where the spectral x-axis values overlap excatly. | ||
* 'interpolate' returns the overlapping portions with linear interpolation to match spectral points exactly. As no extrapolation will be done, the returned spectra will cover the smallest common spectral range. | * ''''interpolate'''' returns the overlapping portions with linear interpolation to match spectral points exactly. As no extrapolation will be done, the returned spectra will cover the smallest common spectral range. | ||
* 'none' ignores x-axis differences as long as the number of data points is the same in all spectra. | * ''''none'''' ignores x-axis differences as long as the number of data points is the same in all spectra. | ||
* textauditlog: [ {'no'} | 'yes' ], governs output of audit log contents. When 'yes', the auditlog is returned as a raw text array. Otherwise, the auditlog is returned as a structure with field names taken from auditlog keys. | * '''textauditlog''': [ {'no'} | 'yes' ], governs output of audit log contents. When 'yes', the auditlog is returned as a raw text array. Otherwise, the auditlog is returned as a structure with field names taken from auditlog keys. | ||
===See Also=== | ===See Also=== | ||
[[areadr]], [[xclgetdata]], [[xclputdata]], [[xclreadr]] | [[areadr]], [[xclgetdata]], [[xclputdata]], [[xclreadr]] | ||
Revision as of 19:57, 2 September 2008
Purpose
Reads a Galactic SPC file.
Synopsis
- x = spcreadr(filename,subs,wlrange,options)
- [data,xaxis,auditlog] = spcreadr(filename,subs,wlrange,options)
Description
SPCREADR reads a Galactic SPC file.
INPUTS
- filename = a text string with the name of a SPC file or a cell of strings of SPC filenames.
- If filename is omitted or blank, the user will be prompted to select a file graphically.
- If filename is an empty cell {}, the user will be prompted to select a folder and then one or more SPC files in the folder the identified folder.
OPTIONAL INPUTS
- subs = [], scalar or vector indicating the sub-files to read, e.g. [3] reads sub-file 3, [3:9] reads sub-files 3 to 9, {default reads all sub-files} and
- wlrange = [], two element vector (inclusive endpoints) of the wavelength range to return {default returns the entire wavelength range}.
OUTPUTS
- x = a dataset object containing the spectrum, or
- data = a data array with measured intensities,
- xaxis = vector containing the wavelength axis, and
- auditlog = char array with the log from the file.
Options
- options = a structure array with the following fields:
- axismatching: [ 'none' | 'intersect' |{'interpolate'} ], defines action taken when the x-axes of two spectra being read do not match. The options are:
- 'intersect' returns only the points where the spectral x-axis values overlap excatly.
- 'interpolate' returns the overlapping portions with linear interpolation to match spectral points exactly. As no extrapolation will be done, the returned spectra will cover the smallest common spectral range.
- 'none' ignores x-axis differences as long as the number of data points is the same in all spectra.
- textauditlog: [ {'no'} | 'yes' ], governs output of audit log contents. When 'yes', the auditlog is returned as a raw text array. Otherwise, the auditlog is returned as a structure with field names taken from auditlog keys.