reference

`labkit.thermal.readFile`

Read radiometric image data and convert it to degrees Celsius.

Syntax

record = labkit.thermal.readFile(path)
record = labkit.thermal.readFile(path, opts)

Description

Reads the embedded FLIR FFF RawThermalImage record from a radiometric JPEG or RJPEG. The ordinary visible JPEG pixels are not used as temperature values. Raw sensor counts are retained alongside the converted matrix and the calibration metadata used for conversion.

Inputs

path: Character vector or string scalar naming one .jpg, .jpeg, or .rjpg file. The file must contain FLIR radiometric data.
opts: Optional scalar structure. See Options.

Options

RequireExisting: Logical scalar. When true, report a missing file before checking its extension. Default: true.
TemperatureCorrection: String scalar selecting the temperature model. Allowed values are "environment" and "planck-basic". "environment" accounts for emissivity, object distance, reflected temperature, atmosphere, humidity, and an infrared window when the metadata is available. "planck-basic" applies only the camera's Planck constants to the raw counts. Default: "environment".

Outputs

record: Scalar structure with fields path, name, format, raw, temperatureC, units, metadata, and message. raw is the decoded sensor matrix. temperatureC is a same-size double matrix in degrees Celsius, or NaN when the raw data cannot be converted. metadata includes the parsed FLIR tags and temperatureConversion diagnostics, including any environmental values that used documented defaults.

Errors

Throws labkit:thermal:InvalidPath for a nonscalar path, labkit:thermal:FileNotFound for a missing file when RequireExisting is true, labkit:thermal:UnsupportedFile for another extension or a JPEG with no supported radiometric payload, and labkit:thermal:InvalidOptions for an invalid option value.

Typical Call

opts = struct("TemperatureCorrection", "environment");
record = labkit.thermal.readFile("capture.rjpg", opts);
imagesc(record.temperatureC)
axis image
colorbar

labkit.thermal.inspectFile — Check whether a file contains supported radiometric data.
labkit.thermal.readFiles — Read several radiometric image files.
labkit.thermal.rawToTemperatureC — Convert FLIR raw sensor values to degrees Celsius.
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.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/readFile.m.

labkit.thermal.readFile