Struct libblackbody::tiff::TiffThermogram

pub struct TiffThermogram { /* fields omitted */ }

This is the struct and ThermogramTrait implementation for TIFF thermograms, through the use image-rs/tiff.

A 'TIFF thermogram' is basically any TIFF file with a channel of data, assumed to be thermographic. Currently the only supported data types are u16 and u32, which are converted to floats. U16 data is assumed to be centikelvin and converted to centigrades by subtracting 27315. U32 is assumed to actually be a f32 and transmuted to that data type.

While a file can be directly read with from_file, it is recommended to instead use the Thermogram::from_file instead. The latter detects what kind of file (TIFF, FLIR) it is dealing with, subsequently choosing the right reader for it. This way your application support different thermogram formats.

Implementations

impl TiffThermogram

pub fn from_file(file_path: &Path) -> Option<Self>

Read a FLIR file referenced by a path.

Arguments

• file_path - The path to the FLIR file to read.

Returns

In case of success, Some<FlirThermogram> is returned, otherwise None. Values are in centigrades, as specified by the ThermogramTrait contract.

Trait Implementations

impl Clone for TiffThermogram

pub fn clone(&self) -> TiffThermogram

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TiffThermogram

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl ThermogramTrait for TiffThermogram

pub fn thermal(&self) -> &Array<f32, Ix2>

Returns a reference to the 2D array of thermal data in celsius.

pub fn optical(&self) -> Option<&Array<u8, Ix3>>

Returns reference to the raw RGB values of the thermogram's corresponding optical photo, if present. Otherwise None.

pub fn identifier(&self) -> &str

Provide the identifier for this thermogram, which is typically the file path. It can also be a randomly generated uuid or similar, however, if there is no path associated with the data.

pub fn path(&self) -> Option<&str>

pub fn render(
    &self,
    min_temp: f32,
    max_temp: f32,
    palette: [[f32; 3]; 256]
) -> Array<u8, Ix3>

Render the thermogram with the given color palette and using the given minimum and maximum temperature bounds.

pub fn render_defaults(&self) -> Array<u8, Ix3>

Render the thermogram using the minimum and maximum thermal value and the

pub fn export_thermal(&self, path: &PathBuf) -> Option<()>

Export thermal data to a tiff file.

pub fn save_render(
    &self,
    path: PathBuf,
    min_temp: f32,
    max_temp: f32,
    palette: [[f32; 3]; 256]
) -> Option<()>

Save render to file.

pub fn thermal_shape(&self) -> [usize; 2]

Gives the shape of the thermal data, in the order of [height, width].

pub fn has_optical(&self) -> bool

pub fn min_temp(&self) -> f32

Returns the lowest temperature in the thermogram, or f32::MAX if there is no such value.

pub fn max_temp(&self) -> f32

Returns the highest temperature in the thermogram, or f32::MIN if there is no such value.

pub fn normalized_minmax(&self) -> Array<f32, Ix2>

Normalized the thermal array to lie in the 0.0..=1.0 in such a way to prevent division by 0 errors.