Apply pre-commit formatting

Author: jwlodek

.clang-format

@@ -0,0 +1,5 @@
+BasedOnStyle: Google
+IndentWidth: 4
+TabWidth: 4
+UseTab: Never
+ColumnLimit: 100

.gitignore

@@ -1,18 +1,18 @@
-*~
-*#
-bin
-lib
-include
-db
-dbd
-envPaths*
-*BAK.adl
-*/O.*
-*.swp
-.vscode/
-adcvTests/
-O.linux-x86_64/
-opencv/
-os/
-OLD_FILES/
-O.*-debug
+*~
+*#
+bin
+lib
+include
+db
+dbd
+envPaths*
+*BAK.adl
+*/O.*
+*.swp
+.vscode/
+adcvTests/
+O.linux-x86_64/
+opencv/
+os/
+OLD_FILES/
+O.*-debug

.pre-commit-config.yaml

@@ -0,0 +1,23 @@
+repos:
+  # General pre-commit hooks
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-merge-conflict
+      - id: check-added-large-files
+      - id: check-case-conflict
+      - id: check-executables-have-shebangs
+      - id: check-shebang-scripts-are-executable
+      - id: check-yaml
+      - id: check-json
+      - id: check-xml
+      - id: mixed-line-ending
+        args: ['--fix=lf']
+
+
+  - repo: https://github.com/pre-commit/mirrors-clang-format
+    rev: v14.0.6
+    hooks:
+    - id: clang-format

CONTRIBUTING.md

@@ -1,13 +1,13 @@
 # Guide to contributing to ADCompVision
 
-Some pointers:  
+Some pointers:
 * OpenCV uses Mat objects for images. They are written as a 'smart-pointer' class, meaning that they are passed
 by-reference by default. Because of this, make sure to pass the image into the function with (Mat &img).
 * The plugin works by calling functions in a helper library. If you wish to add an additional function for a more specific use case that the plugin does not support, follow the steps below.
 
 ## Adding a new CV function
 
-There are two primary ways to add a new CV function to ADCompVision to customize the plugin. 
+There are two primary ways to add a new CV function to ADCompVision to customize the plugin.
 
 ### Implementing user_function
 
@@ -25,12 +25,12 @@ This is a more complicated process than simply implementing the user_function, a
 To add a new CV function there are several files you will need to edit. First, in the NDCV.template file, find the record titled "CompVisionFunctionN", where N is an integer from 1 to 3. These are the three sets of supported functions, and generally follow the rule:
 * Function set 1 contains basic OpenCV image processing functions
 * Function set 2 contains more complex functions that are still general and with many use cases
-* Function set 3 contains functions for specific use cases and custom implementations.  
+* Function set 3 contains functions for specific use cases and custom implementations.
 
-Decide which of these sets your new function falls under, and add it to the Input and Output records.   
+Decide which of these sets your new function falls under, and add it to the Input and Output records.
 
 
-Next, in the `NDPluginCVHelper.h` file, change the `N_FUNC_#` value to take into account the new number of functions in the `CompVisionFunction#` PV you add your function to.  
+Next, in the `NDPluginCVHelper.h` file, change the `N_FUNC_#` value to take into account the new number of functions in the `CompVisionFunction#` PV you add your function to.
 Next, you will need to edit the `NDPluginCVHelper.cpp` and `NDPluginCVHelper.h` files. In `NDPluginCVHelper.h`, find the definition of `ADCVFunction_t` and add:
 ```
 // Some basic flag types
@@ -54,7 +54,7 @@ Make sure to add your function type in the appropriate position, this is importa
 ADCVStatus_t YOURFUNCTION(Mat &img, double* inputs, double* outputs);
 ADCVStatus_t get_YOURFUNCTION_description(string* inputDesc, string* outputDesc, string* description);
 ```
-in the 'public' portion of the class declaration. You may follow the standard set by the other functions.   
+in the 'public' portion of the class declaration. You may follow the standard set by the other functions.
 Next, in the `NDPluginCVHelper.cpp` file, add your new function definitions. They should take the following form:
 
 **The Wrapper**
@@ -96,7 +96,7 @@ ADCVStatus_t NDPluginCVHelper::YOURFUNCTION(Mat &img, double* inputs, double* ou
 ```
 /**
  * Function that sets the I/O descriptions for YOURFUNCTION
- * 
+ *
  * @params[out]: inputDesc      -> array of input descriptions
  * @params[out]: outputDesc     -> array of output descriptions
  * @params[out]: description    -> overall function usage description
@@ -125,7 +125,7 @@ ADCVStatus_t NDPluginCVHelper::get_YOURFUNCTION_description(string* inputDesc, s
 ```
 python3 createIOmanual.py
 ```
-This will create a manual (in docs/manual.html) describing the inputs and outputs of each of the functions including your new custom function along with a description of each function as provided in the comments.  
+This will create a manual (in docs/manual.html) describing the inputs and outputs of each of the functions including your new custom function along with a description of each function as provided in the comments.
 
 Next, you must edit the `getFunctionDescription` function in `NDPluginCVHelper.cpp`. Add a case to the switch statement as follows:
 ```
@@ -146,4 +146,4 @@ This will tell ADCompVision which function to process when your function is requ
 
 Finally, the last remaining thing you must do, is to make sure that your function is thread safe. If it is not, you must add it to the array in `NDPluginCV.h` called `nonThreadSafeFunctions`. Note that in this case, multiple threads will not affect the performance of the plugin when such a function is selected.
 
-Your function should now be implemented into ADCompVision and is ready to be tested.
+Your function should now be implemented into ADCompVision and is ready to be tested.

LICENSE

@@ -26,4 +26,4 @@ DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Makefile

@@ -9,4 +9,4 @@ DIRS := $(DIRS) $(filter-out $(DIRS), $(wildcard *app))
 #DIRS := $(DIRS) $(filter-out $(DIRS), $(wildcard *app))
 
 
-include $(TOP)/configure/RULES_TOP
+include $(TOP)/configure/RULES_TOP

README.md

@@ -1,26 +1,26 @@
-# ADCompVision
-
-An [EPICS](http://www.aps.anl.gov/epics/) [areaDetector](https://github.com/areaDetector/areaDetector/blob/master/README.md) plugin that allows for general integration of OpenCV based computer vision routines with detector data.
-
-Supported Functions:
-* Gaussian blur
-* Median blur
-* Binary thresholding
-* Laplacian
-* Sharpening filter
-* Canny Edge Detection
-* Consecutive image subtraction (ex. for dual thresholding)
-* Statistics calculations
-* Video recording
-* Centroid identification
-* Movement vector calculations
-* Object Identification
-* Distance thresholding
-* Logarithmic scaling
-* User definable extra function
-
-Additional information:
-* [Documentation](https://areadetector.github.io/areaDetector/ADCompVision/ADCompVision.html)
-* [Release notes](https://github.com/areaDetector/ADCompVision/releases)
-
-Author: Jakub Wlodek
+# ADCompVision
+
+An [EPICS](http://www.aps.anl.gov/epics/) [areaDetector](https://github.com/areaDetector/areaDetector/blob/master/README.md) plugin that allows for general integration of OpenCV based computer vision routines with detector data.
+
+Supported Functions:
+* Gaussian blur
+* Median blur
+* Binary thresholding
+* Laplacian
+* Sharpening filter
+* Canny Edge Detection
+* Consecutive image subtraction (ex. for dual thresholding)
+* Statistics calculations
+* Video recording
+* Centroid identification
+* Movement vector calculations
+* Object Identification
+* Distance thresholding
+* Logarithmic scaling
+* User definable extra function
+
+Additional information:
+* [Documentation](https://areadetector.github.io/areaDetector/ADCompVision/ADCompVision.html)
+* [Release notes](https://github.com/areaDetector/ADCompVision/releases)
+
+Author: Jakub Wlodek