reference
API Reference › Thermal Images
labkit.thermal.readFiles
Read several radiometric image files.
Syntax
records = labkit.thermal.readFiles(paths)
records = labkit.thermal.readFiles(paths, opts)
[records, report] = labkit.thermal.readFiles(paths, opts)Description
Calls labkit.thermal.readFile for each path in input order. By default, the first unreadable file stops the operation. Set SkipInvalid to true when a batch should keep its readable records and return a failure entry for each skipped file.
Inputs
paths- Character vector, string array, or cell array of character vectors and strings. Empty strings are removed. Output record order follows the remaining input order.
opts- Optional scalar structure. See Options.
Options
AllowEmpty- Logical scalar. When true, an empty path list returns empty records and a zero-count report. When false, an empty list throws labkit:thermal:NoPaths. Default: true.
RequireExisting- Logical scalar forwarded to readFile. Default: true.
SkipInvalid- Logical scalar. When true, an unreadable file is added to report.failures and processing continues. When false, its exception is rethrown immediately. Default: false.
TemperatureCorrection- String scalar forwarded to readFile. Allowed values are "environment" and "planck-basic". Default: "environment".
progressFcn- Empty or a function handle called once before each read and again after it loads or is skipped. The callback receives a scalar structure with stage, index, count, path, and name. stage is "beforeRead", "afterRead", or "skipped". Default: [].
Outputs
records- Column structure array of successfully read thermal records. See
labkit.thermal.readFilefor the fields in each element. report- Scalar structure. requested is the number of normalized paths; loaded and skipped are counts. failures is a structure array with path, name, identifier, and message for each skipped file.
Errors
In addition to readFile errors, throws labkit:thermal:InvalidOptions when opts or a callback is invalid and labkit:thermal:NoPaths when AllowEmpty is false and no usable path remains.
Typical Call
opts = struct("SkipInvalid", true, ...
"TemperatureCorrection", "environment");
[records, report] = labkit.thermal.readFiles(files, opts);
fprintf("Loaded %d of %d files.\n", report.loaded, report.requested)Related APIs
labkit.thermal.readFile— Read radiometric image data and convert it to degrees Celsius.labkit.thermal.inspectFile— Check whether a file contains supported radiometric data.labkit.thermal.fileDialogFilter— Create a file-selection filter for thermal images.labkit.thermal.isSupportedPath— Test whether a path has a supported thermal extension.labkit.thermal.rawToTemperatureC— Convert FLIR raw sensor values to degrees Celsius.labkit.thermal.renderImage— Map a thermal matrix to an RGB image.labkit.thermal.supportedExtensions— List the supported thermal filename extensions.labkit.thermal.version— Return version information for the thermal API.
Source
This page is generated from the MATLAB help text in +labkit/+thermal/readFiles.m.