bilateralfilter_torch 1.1.0

Citation:

If you find our code useful, please cite our work

@article{wagner2022ultra,
  title={Ultra low-parameter denoising: Trainable bilateral filter layers in computed tomography},
  author={Wagner, Fabian and Thies, Mareike and Gu, Mingxuan and Huang, Yixing and Pechmann, Sabrina and Patwari, Mayank and Ploner, Stefan and Aust, Oliver and Uderhardt, Stefan and Schett, Georg and Christiansen, Silke and Maier, Andreas},
  journal={Medical Physics},
  year={2022},
  doi={https://doi.org/10.1002/mp.15718}
}

Setup:

The C++/CUDA implemented forward and backward functions are compiled via the setup.py script using setuptools:

1. Create and activate a python environment (python>=3.7).

2. Install Torch (tested versions: 1.7.1, 1.9.0).

3. Install the bilateral filter layer via pip:

pip install bilateralfilter_torch

In case you encounter problems with 3. install the layer directly from our GitHub repository:

3. Download the repository.

4. Navigate into the extracted repo.

5. Compile/install the bilateral filter layer by calling

python setup.py install

Example scripts:

• Can be found in our GitHub repository

• Try out the forward pass by running the example_filter.py (requires Matplotlib and scikit-image).

• Run the gradcheck.py script to verify the correct gradient implementation.

• Run example_optimization.py to optimize the parameters of a bilateral filter layer to automatically denoise an image.

Optimized bilateral filter prediction:

Implementation:

The general structure of the implementation follows the PyTorch documentation for creating custom C++ and CUDA extensions. The forward pass implementation of the layer is based on code from the Project MONAI framework, originally published under the Apache License, Version 2.0. The correct implementation of the analytical forward and backward pass can be verified by running the gradcheck.py script, comparing numerical gradients with the derived analytical gradient using the PyTorch built-in gradcheck function.

Troubleshooting

nvcc-related errors:

1. Compiling the filter layers requires the Nvidia CUDA toolkit. Check its version

   nvcc --version

   or install it via, e.g.,

   sudo apt update
   sudo apt install nvidia-cuda-toolkit

2. The NVIDIA CUDA toolkit 11.6 made some problems on a Windows machine in combination with pybind. Downgrading the toolkit to version 11.3 fixed the problem (see this discussion). #### Windows-related problems: Make sure the cl.exe environment variable is correctly set.