nbis-python 0.1.4__py3-none-macosx_11_0_arm64.whl

nbis_python-0.1.4.dist-info/METADATA

@@ -0,0 +1,224 @@
+Metadata-Version: 2.4
+Name: nbis-python
+Version: 0.1.4
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Rust
+Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
+License-File: LICENSE
+Summary: Python bindings for NBIS fingerprint processing using Rust + UniFFI
+Keywords: fingerprint,nbis,biometrics,rust,uniffi
+Home-Page: https://github.com/Seventh-Sense-Artificial-Intelligence/nbis-rs
+Author-email: Varun Chatterji <varun@seventhsense.ai>
+License: MIT
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Bug Tracker, https://github.com/Seventh-Sense-Artificial-Intelligence/nbis-rs/issues
+Project-URL: Documentation, https://github.com/Seventh-Sense-Artificial-Intelligence/nbis-rs
+Project-URL: Homepage, https://github.com/Seventh-Sense-Artificial-Intelligence/nbis-rs
+Project-URL: Repository, https://github.com/Seventh-Sense-Artificial-Intelligence/nbis-rs
+
+## NBIS-rs
+
+This is a Rust/Python binding to the [NIST Biometric Image Software](https://www.nist.gov/services-resources/software/nist-biometric-image-software-nbis) (NBIS) library, which is used for processing biometric images, particularly in the context of fingerprint recognition.
+
+For convenience, this library also binds to the [NIST Fingerprint Image Quality](https://www.nist.gov/services-resources/software/nfiq-2) (NFIQ) version 2. 
+
+## Features
+
+- Bindings to NBIS functions for minutia extraction, matching
+- Exports minutiae templates in ISO/IEC 19794-2:2005 format
+- Matches minutiae templates against each other using the NBIS Bozorth3 algorithm
+- Provides support for NFIQ2 quality assessment
+
+## Building from source
+
+Native dependencies (OpenCV 4, CMake, C++ toolchain) are required. See [DEPENDENCIES.md](DEPENDENCIES.md).
+
+```bash
+# macOS
+./scripts/install-deps-macos.sh
+
+# Linux (Debian/Ubuntu)
+./scripts/install-deps-linux.sh
+
+cargo build --release
+cargo test
+make python   # optional Python wheel
+```
+
+## Installation (Rust)
+
+To use NBIS-rs, add the following to your `Cargo.toml`:
+
+```toml
+[dependencies]
+nbis-rs = { git = "https://github.com/Seventh-Sense-Artificial-Intelligence/nbis-rs", branch = "main", version = "0.1.3" }
+```
+Or you can run the following command on the terminal of your new rust project:
+
+cargo add nbis-rs --git https://github.com/Seventh-Sense-Artificial-Intelligence/nbis-rs --branch main
+
+Running the above command will add the above dependency in your Cargo.toml
+
+Now you can use the nbis-rs rust library in your project as mentioned in next section.
+
+## Usage (Rust)
+
+Here's a simple example of how to use NBIS-rs in your project:
+
+```rust
+fn main() -> Result<(), Box<dyn std::error::Error>> {
+    use nbis;
+    use nbis::Minutiae;
+    use nbis::NbisExtractorSettings;
+    // Configuration for the NbisExtractor
+    let settings = NbisExtractorSettings {
+        // No filtering on minutiae quality (all minutiae will be included)
+        min_quality: 0.0,
+        // Do not compute ROI or center to save computing resources
+        get_center: false,
+        // Do not check if the image is a fingerprint using SIVV
+        check_fingerprint: false,
+        // compute the NFIQ score
+        compute_nfiq2: true,
+        // No specific PPI, use the default
+        ppi: None,
+    };
+
+    let extractor = nbis::NbisExtractor::new(settings)?;
+
+    // Read the bytes from a file (you could also use nbis::extract_minutiae_from_image_file)
+    // but here we just load the image bytes as image paths on mobile platforms can be tricky.
+    let image_bytes = std::fs::read("test_data/p1/p1_1.png")?;
+
+    let minutiae_1 = extractor.extract_minutiae(&image_bytes)?;
+
+    let image_bytes = std::fs::read("test_data/p1/p1_2.png")?;
+    let minutiae_2 = extractor.extract_minutiae(&image_bytes)?;
+
+    let image_bytes = std::fs::read("test_data/p1/p1_3.png")?;
+    let minutiae_3 = extractor.extract_minutiae(&image_bytes)?;
+
+    // Compare the two sets of minutiae
+    let score = minutiae_1.compare(&minutiae_2);
+    assert!(score > 35, "Expected a high similarity score between p1_1 and p1_2");
+    let score = minutiae_1.compare(&minutiae_3);
+    assert!(score > 35, "Expected a high similarity score between p1_1 and p1_3");
+    let score = minutiae_2.compare(&minutiae_3);
+    assert!(score > 35, "Expected a high similarity score between p1_2 and p1_3");
+
+    // Next we will demonstrate conversion to ISO/IEC 19794-2:2005 format
+    // and back to a `Minutiae` object.
+    // First, convert the minutiae to ISO template bytes
+    let iso_template: Vec<u8> = minutiae_1.to_iso_19794_2_2005();              
+    // And load it back
+    let minutiae_from_iso = extractor.load_iso_19794_2_2005(&iso_template)?;
+    // Compare the original minutiae with the one loaded from ISO template
+    for (a, b) in minutiae_from_iso.get().iter().zip(minutiae_1.get().iter()) {
+        assert_eq!(a.x(), b.x());
+        assert_eq!(a.y(), b.y());
+        assert_eq!(a.angle(), b.angle());
+        assert_eq!(a.kind(), b.kind());
+        // Reliability is quantized in the round-trip conversion,
+        // so we allow a small margin of error.
+        assert!((a.reliability() - b.reliability()).abs() < 1e-1);
+    }
+
+    // Finally we demonstrate loading from a file and comparing a negative match
+    let minutiae_4 = extractor.extract_minutiae_from_image_file("test_data/p2/p2_1.png")?;
+    let score = minutiae_1.compare(&minutiae_4);
+    assert!(score < 35, "Expected a low similarity score between p1_1 and p2_1");
+
+    // We can access the NFIQ2 quality via:
+    let nfiq2_quality = minutiae_1.quality();
+    assert!(nfiq2_quality.score > 50, "Expected a positive NFIQ2 quality score");
+
+    Ok(())
+}
+```
+
+## Installation (Python)
+To install the Python bindings, you can use pip:
+
+```bash
+pip install nbis-py
+```
+
+## Usage (Python)
+
+Here's a simple example of how to use the NBIS Python bindings:
+
+```python
+import nbis
+from nbis import NbisExtractor, NbisExtractorSettings
+
+ #Configuration for the NbisExtractor
+settings = NbisExtractorSettings(
+    # Do not filter on minutiae quality (get all minutiae)
+    min_quality=0.0,
+    # Do not get the fingerprint center or ROI
+    get_center=False,
+    # Do not use SIVV to check if the image is a fingerprint
+    check_fingerprint=False,
+    # Compute the NFIQ2 quality score
+    compute_nfiq2=True,
+    # No specific PPI, use the default
+    ppi=None,
+)
+
+extractor = nbis.new_nbis_extractor(settings)
+
+# Read the bytes from a file
+image_bytes = open("test_data/p1/p1_1.png", "rb").read()
+minutiae_1 = extractor.extract_minutiae(image_bytes)
+image_bytes = open("test_data/p1/p1_2.png", "rb").read()
+minutiae_2 = extractor.extract_minutiae(image_bytes)
+image_bytes = open("test_data/p1/p1_3.png", "rb").read()
+minutiae_3 = extractor.extract_minutiae(image_bytes)
+
+# Compare the two sets of minutiae
+score = minutiae_1.compare(minutiae_2)
+assert score > 50, "Expected a high similarity score between p1_1 and p1_2"
+score = minutiae_1.compare(minutiae_3)
+assert score > 50, "Expected a high similarity score between p1_1 and p1_3"
+score = minutiae_2.compare(minutiae_3)
+assert score > 50, "Expected a high similarity score between p1_2 and p1_3"
+
+# Convert minutiae to ISO/IEC 19794-2:2005 format
+iso_template = minutiae_1.to_iso_19794_2_2005()
+# Load it back
+minutiae_from_iso = extractor.load_iso_19794_2_2005(iso_template)
+# Compare the original minutiae with the one loaded from ISO template
+for a, b in zip(minutiae_from_iso.get(), minutiae_1.get()):
+    assert a.x() == b.x()
+    assert a.y() == b.y()
+    assert a.angle() == b.angle()
+    assert a.kind() == b.kind()
+    # Reliability is quantized in the round-trip conversion,
+    # so we allow a small margin of error.
+    assert abs(a.reliability() - b.reliability()) < 0.1
+
+# Finally we demonstrate loading from a file and comparing a negative match
+minutiae_4 = extractor.extract_minutiae_from_image_file("test_data/p2/p2_1.png")
+score = minutiae_1.compare(minutiae_4)
+assert score < 50, "Expected a low similarity score between p1_1 and p2_1"
+
+# We can access the NFIQ2 quality via:
+nfiq2_quality = minutiae_1.quality()
+assert nfiq2_quality.score > 50, "Expected a positive NFIQ2 quality score"
+```
+
+## Contributing
+
+Contributions are welcome! Please open an issue or submit a pull request on GitHub.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

nbis_python-0.1.4.dist-info/RECORD

@@ -0,0 +1,10 @@
+LICENSE,sha256=CRsdJdTqEyjgqdDVfl9aVJJDpMEl5LL2i0P8WruwZ_w,3395
+nbis/__init__.py,sha256=T-bUbFt5I9vMycw6iWawrVKs6OaBdweC6v1RxjJKFcQ,651
+nbis/nbis/__init__.py,sha256=JYcnMfeSWIRKp5e0rL5m2zy1gX6nOt-PaGn6a20FNVc,28
+nbis/nbis/libnbis.dylib,sha256=UBCAa-hWLCgebrfpqajN5-H6zXhO5dVIkmwpaq88ta0,31052272
+nbis/nbis/nbis.py,sha256=uFGt6O8-y-rm2qUehYpZOG1IEwV0CAllEDw_3lkR2HQ,82678
+nbis_python-0.1.4.dist-info/METADATA,sha256=lx8njy3Y0a7QAayQIJhvqLr-krfB2vUD5QXTVz0T748,8760
+nbis_python-0.1.4.dist-info/WHEEL,sha256=YxvB58IsRcvNDyvwuq2OMRTV0NDSKB8_Ti8Wdfvarzg,102
+nbis_python-0.1.4.dist-info/licenses/LICENSE,sha256=CRsdJdTqEyjgqdDVfl9aVJJDpMEl5LL2i0P8WruwZ_w,3395
+nbis_python-0.1.4.dist-info/sboms/nbis-rs.cyclonedx.json,sha256=-RVmRo0Twh4G4NP6KbFNtweNLXfko8q_5j0n3n6FJOk,243598
+nbis_python-0.1.4.dist-info/RECORD,,

nbis_python-0.1.4.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: maturin (1.13.3)
+Root-Is-Purelib: false
+Tag: py3-none-macosx_11_0_arm64

nbis_python-0.1.4.dist-info/licenses/LICENSE

@@ -0,0 +1,63 @@
+MIT License (Seventh Sense AI library)
+
+Copyright (c) 2025 Seventh Sense Artificial Intelligence Private Limited
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+----
+
+NIST NBIS License for Algorithms (Public Domain)
+
+This software and/or related materials was developed at the National Institute
+of Standards and Technology (NIST) by employees of the Federal Government
+in the course of their official duties. Pursuant to title 17 Section 105
+of the United States Code, this software is not subject to copyright
+protection and is in the public domain. 
+
+This software and/or related materials have been determined to be not subject
+to the EAR (see Part 734.3 of the EAR for exact details) because it is
+a publicly available technology and software, and is freely distributed
+to any interested party with no licensing requirements.  Therefore, it is 
+permissible to distribute this software as a free download from the internet.
+
+Disclaimer: 
+This software and/or related materials was developed to promote biometric
+standards and biometric technology testing for the Federal Government
+in accordance with the USA PATRIOT Act and the Enhanced Border Security
+and Visa Entry Reform Act. Specific hardware and software products identified
+in this software were used in order to perform the software development.
+In no case does such identification imply recommendation or endorsement
+by the National Institute of Standards and Technology, nor does it imply that
+the products and equipment identified are necessarily the best available
+for the purpose.
+
+This software and/or related materials are provided "AS-IS" without warranty
+of any kind including NO WARRANTY OF PERFORMANCE, MERCHANTABILITY,
+NO WARRANTY OF NON-INFRINGEMENT OF ANY 3RD PARTY INTELLECTUAL PROPERTY
+or FITNESS FOR A PARTICULAR PURPOSE or for any purpose whatsoever, for the
+licensed product, however used. In no event shall NIST be liable for any
+damages and/or costs, including but not limited to incidental or consequential
+damages of any kind, including economic damage or injury to property and lost
+profits, regardless of whether NIST shall be advised, have reason to know,
+or in fact shall know of the possibility.
+
+By using this software, you agree to bear all risk relating to quality,
+use and performance of the software and/or related materials.  You agree
+to hold the Government harmless from any claim arising from your use
+of the software.