| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `/root/.cargo/git/checkouts/incubator-teaclave-crates-c8106113f74feefc/ede1f68/rustface/src/lib.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lib.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../rustface/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../rustface/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span> |
| <span id="2">2</span> |
| <span id="3">3</span> |
| <span id="4">4</span> |
| <span id="5">5</span> |
| <span id="6">6</span> |
| <span id="7">7</span> |
| <span id="8">8</span> |
| <span id="9">9</span> |
| <span id="10">10</span> |
| <span id="11">11</span> |
| <span id="12">12</span> |
| <span id="13">13</span> |
| <span id="14">14</span> |
| <span id="15">15</span> |
| <span id="16">16</span> |
| <span id="17">17</span> |
| <span id="18">18</span> |
| <span id="19">19</span> |
| <span id="20">20</span> |
| <span id="21">21</span> |
| <span id="22">22</span> |
| <span id="23">23</span> |
| <span id="24">24</span> |
| <span id="25">25</span> |
| <span id="26">26</span> |
| <span id="27">27</span> |
| <span id="28">28</span> |
| <span id="29">29</span> |
| <span id="30">30</span> |
| <span id="31">31</span> |
| <span id="32">32</span> |
| <span id="33">33</span> |
| <span id="34">34</span> |
| <span id="35">35</span> |
| <span id="36">36</span> |
| <span id="37">37</span> |
| <span id="38">38</span> |
| <span id="39">39</span> |
| <span id="40">40</span> |
| <span id="41">41</span> |
| <span id="42">42</span> |
| <span id="43">43</span> |
| <span id="44">44</span> |
| <span id="45">45</span> |
| <span id="46">46</span> |
| <span id="47">47</span> |
| <span id="48">48</span> |
| <span id="49">49</span> |
| <span id="50">50</span> |
| <span id="51">51</span> |
| <span id="52">52</span> |
| <span id="53">53</span> |
| <span id="54">54</span> |
| <span id="55">55</span> |
| <span id="56">56</span> |
| <span id="57">57</span> |
| <span id="58">58</span> |
| <span id="59">59</span> |
| <span id="60">60</span> |
| <span id="61">61</span> |
| <span id="62">62</span> |
| <span id="63">63</span> |
| <span id="64">64</span> |
| <span id="65">65</span> |
| <span id="66">66</span> |
| <span id="67">67</span> |
| <span id="68">68</span> |
| <span id="69">69</span> |
| <span id="70">70</span> |
| <span id="71">71</span> |
| <span id="72">72</span> |
| <span id="73">73</span> |
| <span id="74">74</span> |
| <span id="75">75</span> |
| <span id="76">76</span> |
| <span id="77">77</span> |
| <span id="78">78</span> |
| <span id="79">79</span> |
| <span id="80">80</span> |
| <span id="81">81</span> |
| <span id="82">82</span> |
| <span id="83">83</span> |
| <span id="84">84</span> |
| <span id="85">85</span> |
| <span id="86">86</span> |
| <span id="87">87</span> |
| <span id="88">88</span> |
| <span id="89">89</span> |
| <span id="90">90</span> |
| <span id="91">91</span> |
| <span id="92">92</span> |
| <span id="93">93</span> |
| <span id="94">94</span> |
| <span id="95">95</span> |
| <span id="96">96</span> |
| <span id="97">97</span> |
| <span id="98">98</span> |
| <span id="99">99</span> |
| <span id="100">100</span> |
| <span id="101">101</span> |
| <span id="102">102</span> |
| <span id="103">103</span> |
| <span id="104">104</span> |
| <span id="105">105</span> |
| <span id="106">106</span> |
| <span id="107">107</span> |
| <span id="108">108</span> |
| <span id="109">109</span> |
| <span id="110">110</span> |
| <span id="111">111</span> |
| <span id="112">112</span> |
| <span id="113">113</span> |
| <span id="114">114</span> |
| <span id="115">115</span> |
| <span id="116">116</span> |
| <span id="117">117</span> |
| <span id="118">118</span> |
| <span id="119">119</span> |
| <span id="120">120</span> |
| <span id="121">121</span> |
| <span id="122">122</span> |
| <span id="123">123</span> |
| <span id="124">124</span> |
| <span id="125">125</span> |
| <span id="126">126</span> |
| <span id="127">127</span> |
| <span id="128">128</span> |
| <span id="129">129</span> |
| <span id="130">130</span> |
| <span id="131">131</span> |
| <span id="132">132</span> |
| <span id="133">133</span> |
| <span id="134">134</span> |
| <span id="135">135</span> |
| </pre><pre class="rust"><code><span class="comment">// This file is part of the open-source port of SeetaFace engine, which originally includes three modules: |
| // SeetaFace Detection, SeetaFace Alignment, and SeetaFace Identification. |
| // |
| // This file is part of the SeetaFace Detection module, containing codes implementing the face detection method described in the following paper: |
| // |
| // Funnel-structured cascade for multi-view face detection with alignment awareness, |
| // Shuzhe Wu, Meina Kan, Zhenliang He, Shiguang Shan, Xilin Chen. |
| // In Neurocomputing (under review) |
| // |
| // Copyright (C) 2016, Visual Information Processing and Learning (VIPL) group, |
| // Institute of Computing Technology, Chinese Academy of Sciences, Beijing, China. |
| // |
| // As an open-source face recognition engine: you can redistribute SeetaFace source codes |
| // and/or modify it under the terms of the BSD 2-Clause License. |
| // |
| // You should have received a copy of the BSD 2-Clause License along with the software. |
| // If not, see < https://opensource.org/licenses/BSD-2-Clause>. |
| |
| </span><span class="kw">mod </span>classifier; |
| <span class="kw">mod </span>common; |
| <span class="kw">mod </span>detector; |
| <span class="kw">mod </span>feat; |
| <span class="kw">pub mod </span>math; |
| <span class="kw">pub mod </span>model; |
| |
| <span class="kw">pub use </span><span class="kw">crate</span>::common::FaceInfo; |
| <span class="kw">pub use </span><span class="kw">crate</span>::common::ImageData; |
| <span class="kw">pub use </span><span class="kw">crate</span>::common::Rectangle; |
| <span class="kw">pub use </span><span class="kw">crate</span>::model::{read_model, Model}; |
| |
| <span class="kw">use </span><span class="kw">crate</span>::detector::FuStDetector; |
| <span class="kw">use </span>image::DynamicImage; |
| <span class="kw">use </span>std::io; |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"include_default_model"</span>)] |
| </span><span class="doccomment">/// Create a face detector with the default model file |
| </span><span class="kw">pub fn </span>create_default_detector() -> <span class="prelude-ty">Result</span><Box<<span class="kw">dyn </span>Detector>, io::Error> { |
| <span class="kw">let </span>bytes = <span class="macro">include_bytes!</span>(<span class="string">"../model/seeta_fd_frontal_v1.0.bin"</span>); |
| create_detector(bytes) |
| } |
| |
| <span class="doccomment">/// Create a face detector from model loaded to memory |
| </span><span class="kw">pub fn </span>create_detector(buf: <span class="kw-2">&</span>[u8]) -> <span class="prelude-ty">Result</span><Box<<span class="kw">dyn </span>Detector>, io::Error> { |
| <span class="kw">let </span>cursor = io::Cursor::new(buf.to_owned()); |
| <span class="kw">let </span>model = read_model(cursor)<span class="question-mark">?</span>; |
| <span class="prelude-val">Ok</span>(create_detector_with_model(model)) |
| } |
| |
| <span class="doccomment">/// Create a face detector, based on the provided model. |
| </span><span class="kw">pub fn </span>create_detector_with_model(model: Model) -> Box<<span class="kw">dyn </span>Detector> { |
| Box::new(FuStDetector::new(model)) |
| } |
| |
| <span class="doccomment">/// detect face bounding boxes |
| </span><span class="kw">pub fn </span>detect_faces(detector: <span class="kw-2">&mut </span><span class="kw">dyn </span>Detector, img: DynamicImage) -> Vec<FaceInfo> { |
| <span class="kw">let </span>gray = <span class="kw-2">&</span>img.to_luma8(); |
| <span class="kw">let </span>(width, height) = gray.dimensions(); |
| <span class="kw">let </span><span class="kw-2">mut </span>image = ImageData::new(gray, width, height); |
| |
| <span class="kw">let </span>faces = detector.detect(<span class="kw-2">&mut </span>image); |
| faces |
| } |
| |
| <span class="kw">pub trait </span>Detector { |
| <span class="doccomment">/// Detect faces on input image. |
| /// |
| /// (1) The input image should be gray-scale, i.e. `num_channels` set to 1. |
| /// (2) Currently this function does not give the Euler angles, which are |
| /// left with invalid values. |
| /// |
| /// # Panics |
| /// |
| /// Panics if `image` is not a legal image, e.g. it |
| /// - is not gray-scale (`num_channels` is not equal to 1) |
| /// - has `width` or `height` equal to 0 |
| </span><span class="kw">fn </span>detect(<span class="kw-2">&mut </span><span class="self">self</span>, image: <span class="kw-2">&</span>ImageData) -> Vec<FaceInfo>; |
| |
| <span class="doccomment">/// Set the size of the sliding window. |
| /// |
| /// The minimum size is constrained as no smaller than 20. |
| /// |
| /// # Panics |
| /// |
| /// Panics if `wnd_size` is less than 20. |
| </span><span class="kw">fn </span>set_window_size(<span class="kw-2">&mut </span><span class="self">self</span>, wnd_size: u32); |
| |
| <span class="doccomment">/// Set the sliding window step in horizontal and vertical directions. |
| /// |
| /// The steps should take positive values. |
| /// Usually a step of 4 is a reasonable choice. |
| /// |
| /// # Panics |
| /// |
| /// Panics if `step_x` or `step_y` is less than or equal to 0. |
| </span><span class="kw">fn </span>set_slide_window_step(<span class="kw-2">&mut </span><span class="self">self</span>, step_x: u32, step_y: u32); |
| |
| <span class="doccomment">/// Set the minimum size of faces to detect. |
| /// |
| /// The minimum size is constrained as no smaller than 20. |
| /// |
| /// # Panics |
| /// |
| /// Panics if `min_face_size` is less than 20. |
| </span><span class="kw">fn </span>set_min_face_size(<span class="kw-2">&mut </span><span class="self">self</span>, min_face_size: u32); |
| |
| <span class="doccomment">/// Set the maximum size of faces to detect. |
| /// |
| /// The maximum face size actually used is computed as the minimum among: |
| /// user specified size, image width, image height. |
| </span><span class="kw">fn </span>set_max_face_size(<span class="kw-2">&mut </span><span class="self">self</span>, max_face_size: u32); |
| |
| <span class="doccomment">/// Set the factor between adjacent scales of image pyramid. |
| /// |
| /// The value of the factor lies in (0.1, 0.99). For example, when it is set as 0.5, |
| /// an input image of size w x h will be resized to 0.5w x 0.5h, 0.25w x 0.25h, 0.125w x 0.125h, etc. |
| /// |
| /// # Panics |
| /// |
| /// Panics if `scale_factor` is less than 0.01 or greater than 0.99 |
| </span><span class="kw">fn </span>set_pyramid_scale_factor(<span class="kw-2">&mut </span><span class="self">self</span>, scale_factor: f32); |
| |
| <span class="doccomment">/// Set the score threshold of detected faces. |
| /// |
| /// Detections with scores smaller than the threshold will not be returned. |
| /// Typical threshold values include 0.95, 2.8, 4.5. One can adjust the |
| /// threshold based on his or her own test set. |
| /// |
| /// Smaller values result in more detections (possibly increasing the number of false positives), |
| /// larger values result in fewer detections (possibly increasing the number of false negatives). |
| /// |
| /// # Panics |
| /// |
| /// Panics if `thresh` is less than or equal to 0. |
| </span><span class="kw">fn </span>set_score_thresh(<span class="kw-2">&mut </span><span class="self">self</span>, thresh: f64); |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="rustface" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
