https://github.com/tdiprima/visionguard
Detecting, masking, and protecting sensitive information in images
https://github.com/tdiprima/visionguard
data-privacy dicom image-analysis image-processing medical-imaging ocr text-detection
Last synced: 4 days ago
JSON representation
Detecting, masking, and protecting sensitive information in images
- Host: GitHub
- URL: https://github.com/tdiprima/visionguard
- Owner: tdiprima
- License: mit
- Created: 2025-01-07T15:47:36.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-09-17T09:05:51.000Z (9 months ago)
- Last Synced: 2025-11-29T06:36:52.548Z (7 months ago)
- Topics: data-privacy, dicom, image-analysis, image-processing, medical-imaging, ocr, text-detection
- Language: Java
- Homepage:
- Size: 685 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# VisionGuard
VisionGuard is a medical image privacy protection system that detects and redacts sensitive text content from medical images, including DICOM files. Named "VisionGuard" because it acts as a guardian for visual medical data, the system identifies burned-in text, patient identifiers, dates, and other PHI (Protected Health Information) that may be embedded in medical images, then applies protective actions like masking, outlining, or quarantining to safeguard patient privacy and ensure HIPAA compliance.
## Features
- **Text Detection**:
- Detect text regions and extract textual content using Tesseract OCR.
- External API support via OllamaTextDetector for alternative text extraction methods.
- **Configurable Actions**:
- `OUTLINE`: Highlight detected text regions with bounding boxes.
- `MASK`: Obscure detected text regions for privacy purposes.
- `BURN`: Apply a semi-transparent red overlay to detected text regions.
- `EXPORT_TO_FOLDER`: Save processed images and metadata to a designated folder.
- `FLAG_FOR_REVIEW`: Mark images as needing further review by adding a "QUARANTINE" watermark.
- **Flexible Configuration**:
- CLI arguments for dynamic bounding box constraints and folder paths.
- Supports customizable detectors and actions.
- **Discrepancy Reporting**:
- Generate reports comparing results from multiple detectors.
## Installation
### Prerequisites
1. **Java Development Kit (JDK)**: Ensure you have JDK 8 or higher installed.
2. **Tesseract OCR**:
- Install Tesseract OCR on your system. For example:
```sh
brew install tesseract
# OR
sudo apt-get install tesseract-ocr
```
- Specify the Tesseract data path in CLI arguments or code configurations.
3. **Dependencies**:
- Add the required dependencies to your `pom.xml` or equivalent build configuration:
- [Tesseract4J](https://github.com/nguyenq/tess4j)
- [Google Gson](https://github.com/google/gson)
## Usage
### Running the Application
1. Compile and run the project:
```sh
javac -cp . com/tdiprima/visionguard/VisionGuard.java
java com.tdiprima.visionguard.VisionGuard [options]
```
2. Example command:
```sh
java VisionGuard input/ OUTLINE output/ report/ --minWidth=20 --minHeight=20 --maxWidth=500 --maxHeight=500
```
```sh
# Displays the actions and parameters, below
java VisionGuard --help
```
### Actions
| Action | Description |
|---------------------|-----------------------------------------------------------------------------|
| `OUTLINE` | Draw bounding boxes around detected text regions. |
| `MASK` | Obscure detected text regions. |
| `BURN` | Apply a semi-transparent red overlay to detected text regions. |
| `EXPORT_TO_FOLDER` | Save the processed image along with metadata to the specified folder. |
| `FLAG_FOR_REVIEW` | Add a "QUARANTINE" watermark and move the image to the quarantine folder. |
### Optional Parameters
| Parameter | Description | Default Value |
|-----------------------|----------------------------------------------------------|--------------------|
| `--ollama=true/false` | Enable or disable OllamaTextDetector | `false`
| `--minWidth=X` | Minimum width of bounding boxes. | `10` |
| `--minHeight=Y` | Minimum height of bounding boxes. | `10` |
| `--maxWidth=A` | Maximum width of bounding boxes. | `500` |
| `--maxHeight=B` | Maximum height of bounding boxes. | `500` |
## Project Structure
```
com/tdiprima/visionguard/
├── VisionGuard.java # Main application entry point
├── DetectorConfig.java # Configuration loader for CLI arguments
├── TextDetector.java # Interface defining detector methods
├── TesseractTextDetector.java # Tesseract OCR-based implementation
├── OllamaTextDetector.java # External API-based implementation
├── DetectorValidator.java # Utility for validating and comparing detection results
└── resources/ # Resource files (e.g., Tesseract training data)
```
## How to Contribute
Please see [CONTRIBUTING.md](docs/CONTRIBUTING.md)
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.