Enum libblackbody::thermogram::Thermogram

pub enum Thermogram {
    Flir(FlirThermogram),
    Tiff(TiffThermogram),
}

The wrapper enum through which most processing of thermograms is recommend to happen. Use Thermogram::from_file() to read files.

The enum itself, and all thermogram formats it wraps, implement ThermogramTrait. Below several of its methods are listed. Consult the documentation of ThermogramTrait for more details.

pub trait ThermogramTrait {
    fn thermal(&self) -> &Array<f32, Ix2>;  // Extract the thermal data
    fn optical(&self) -> &Array<u8, Ix3>>;  // Extract embedded photos, if present
    fn identifier(&self) -> &str;  // A uniquely identifying string for this thermogram
    fn render(&self min_temp: f32, max_temp: f32, palette: [[f32; 3]; 256]) -> Array<u8, Ix3>;  // Thermal data render using the given palette
    fn render_defaults(&self) -> Array<u8, Ix3>;  // Thermal data rendered using the minimum and maximum thermal value and the `palette::TURBO` palette.
    fn thermal_shape(&self) -> [usize; 2];  // The [height, width] of the thermal data
    fn normalized_minmax(&self) -> Array<f32, Ix2>;  // Thermal data normalized to lie in the range 0.0..=1.0
}

Variants

Flir(FlirThermogram)

Tiff(TiffThermogram)

Implementations

impl Thermogram

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

Tries to recognize the file type based on its magic number and return a Thermogram.

Arguments

• path - A path to a thermogram file.

Returns

In case of success an Some<Thermogram>, otherwise None. A Thermogam implements ThermogramTrait, forwarding them to the wrapped struct.

Examples

let file_path = "/home/user/FLIR0123.jpg";
let r_thermogram = Thermogram::from_file(&file_path);
match r_thermogram {
    None => println!("Failed opening thermogram {:?}", file_path),
    Some(thermogram) => {
        println!("Successfully opened thermogram {:?}", file_path);
        // Do something with `thermogram`
        // ...
    },
}

Trait Implementations

impl Clone for Thermogram

pub fn clone(&self) -> Thermogram

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Thermogram

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

Formats the value using the given formatter.

impl ThermogramTrait for Thermogram

The ThermogramTrait implemented for the Thermogram enum. Method calls are forwarded to the specific format wrapped by the enum. Consult the trait for documentation on the supported methods.

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.