Merge pull request #141 from OptiQS-Lab/fix-models

All models in bindings, extending docs

Author: superchromix

.gitignore

@@ -6,10 +6,8 @@ __pycache__
 
 # Gradle/IntelliJ
 Gpufit/java/gpufit/.gradle
-Gpufit/java/gpufit/build
 Gpufit/java/gpufit/out
 
 # build folders
-build/
-/docs/_build
+**/build/*
 

Cpufit/interface.cpp

@@ -117,6 +117,12 @@ void FitInterface::set_number_of_parameters(ModelID const model_id)
     case SPLINE_3D_PHASE_MULTICHANNEL:
         n_parameters_ = 6;
         break;
+    case SPLINE_4D:
+        n_parameters_ = 6;
+        break;
+    case SPLINE_5D:
+        n_parameters_ = 7;
+        break;
     default:
         throw std::runtime_error("unknown model ID");
     }

Cpufit/python/pycpufit/cpufit.py

@@ -71,6 +71,8 @@ class ModelID:
     SPLINE_3D = 10
     SPLINE_3D_MULTICHANNEL = 11
     SPLINE_3D_PHASE_MULTICHANNEL = 12
+    SPLINE_4D = 13
+    SPLINE_5D = 14
 
 class EstimatorID:
     LSE = 0

Gpufit/java/gpufit/src/main/java/com/github/gpufit/Model.java

@@ -6,7 +6,7 @@
  */
 public enum Model {
 
-    GAUSS_1D(0, 4), GAUSS_2D(1, 5), GAUSS_2D_ELLIPTIC(2, 6), GAUSS_2D_ROTATED(3, 7), CAUCHY_2D_ELLIPTIC(4, 6), LINEAR_1D(5, 2);
+    GAUSS_1D(0, 4), GAUSS_2D(1, 5), GAUSS_2D_ELLIPTIC(2, 6), GAUSS_2D_ROTATED(3, 7), CAUCHY_2D_ELLIPTIC(4, 6), LINEAR_1D(5, 2), FLETCHER_POWELL_HELIX(6, 3), BROWN_DENNIS(7, 4), SPLINE_1D(8, 3), SPLINE_2D(9, 4), SPLINE_3D(10, 5), SPLINE_3D_MULTICHANNEL(11, 5), SPLINE_3D_PHASE_MULTICHANNEL(12, 6), SPLINE_4D(13, 6), SPLINE_5D(15, 7);
 
     public final int id, numberParameters;
 

Gpufit/matlab/ModelID.m

@@ -13,6 +13,8 @@
         SPLINE_3D = 10
         SPLINE_3D_MULTICHANNEL = 11
         SPLINE_3D_PHASE_MULTICHANNEL = 12
+        SPLINE_4D = 13
+        SPLINE_5D = 14
     end
     methods (Static)
         function v = validID(id)

Gpufit/python/pygpufit/gpufit.py

@@ -60,6 +60,8 @@ class ModelID:
     SPLINE_3D = 10
     SPLINE_3D_MULTICHANNEL = 11
     SPLINE_3D_PHASE_MULTICHANNEL = 12
+    SPLINE_4D = 13
+    SPLINE_5D = 14
 
 
 class EstimatorID:

docs/customization.rst

@@ -27,7 +27,15 @@ of model parameters and dimensions must be specified as well.
 
 Detailed step by step instructions for adding a model function are given below.
 
-1. Define an additional model ID in file constants.h_. When using the language bindings, the model ID must also be added for Python (in gpufit.py), Matlab (in ModelID.m), Java (in Model.java). 
+1. Define an additional model ID in file `<Gpufit/constants.h>`_. To use wih Cpufit also add the model ID in `<Cpufit/interface.cpp>`_. When using the language bindings, the model ID must also be added 
+
+- for Python 
+    - in `<Gpufit/python/gpufit.py>`_ for pygpufit
+    - in `<Cpufit/python/cpufit.py>`_ for pycpufit
+- for Matlab in `<Gpufitmatlab/ModelID.m>`_
+- for  Java in `<Gpufit/java/gpufit/src/main/java/com/github/gpufit/Model.java>`_. 
+
+
 2. Implement a CUDA device function within a newly created .cuh file in folder Gpufit/Gpufit/models according to the following template. (The REAL type is defined in Gpufit/definitions.h to switch between single and double precision.)
 
 .. code-block:: cuda

docs/fit_model_functions.rst

@@ -395,4 +395,14 @@ spline coefficients. The model function :code:`g` exists for each x,y,z coordina
 
 :`p_4`: offset
 
-:`p_5`: phase
+:`p_5`: phase
+
+4D Spline function
+++++++++++++++++++
+
+**Documentation missing**
+
+5D Spline function
+++++++++++++++++++
+
+**Documentation missing**