Specimreadr: Difference between revisions
Jump to navigation
Jump to search
(Created page with "===Purpose=== Reads Specim image files with dark and white removal. ===Synopsis=== : out = specimreadr : out = specimreadr('filename',options) : out = specimreadr({'filenam...") |
No edit summary |
||
| (One intermediate revision by the same user not shown) | |||
| Line 11: | Line 11: | ||
===Description=== | ===Description=== | ||
Reads Specim image files with dark and white removal. | Reads Specim image files with dark and white removal. | ||
====Inputs==== | ====Inputs==== | ||
| Line 20: | Line 20: | ||
# If input is a single file, the output is a dataset object. | # If input is a single file, the output is a dataset object. | ||
# If the input consists of multiple files, the output is a cell array with a dataset object for each input file. | # If the input consists of multiple files, the output is a cell array with a dataset object for each input file. | ||
===Options=== | |||
''options'' = a structure array with the following fields: | |||
* '''waitbar''' : [ 'off' |{'on'}] governs display of a waitbar while loading. | |||
* '''refPanel''': [ {100} ], Percent reference panel used. NOTE: You can’t have a 100% reference in reality, often you will use 80%, 70% or even 50% to maximize signal to noise ratio (100 as a standard should be fine for the 99% reference as difference will be small). | |||
===See Also=== | ===See Also=== | ||
[[asfreadr]], [[editds]], [[jcampreadr]], [[opotektiffrdr]], [[spcreadr]], [[xclreadr]] | [[asfreadr]], [[editds]], [[jcampreadr]], [[opotektiffrdr]], [[spcreadr]], [[xclreadr]] | ||
Latest revision as of 11:47, 29 June 2021
Purpose
Reads Specim image files with dark and white removal.
Synopsis
- out = specimreadr
- out = specimreadr('filename',options)
- out = specimreadr({'filename1' 'filename2'})
Description
Reads Specim image files with dark and white removal.
Inputs
- filenames = a text string with the name of an HDR file or a cell of strings of HDR filenames. If (filenames) is omitted or an empty cell or array, the user will be prompted to select a folder and then one or more files in the identified folder. If (filenames) is a blank string , the user will be prompted to select a single file.
Outputs
- out = takes one of two forms:
- If input is a single file, the output is a dataset object.
- If the input consists of multiple files, the output is a cell array with a dataset object for each input file.
Options
options = a structure array with the following fields:
- waitbar : [ 'off' |{'on'}] governs display of a waitbar while loading.
- refPanel: [ {100} ], Percent reference panel used. NOTE: You can’t have a 100% reference in reality, often you will use 80%, 70% or even 50% to maximize signal to noise ratio (100 as a standard should be fine for the 99% reference as difference will be small).
See Also
asfreadr, editds, jcampreadr, opotektiffrdr, spcreadr, xclreadr