improved documentation:

- fixed markdown issues
- added minutes for today's meeting
- now make clean also cleans the documentation temporary files

Makefile

@@ -11,7 +11,18 @@ BUILD_ROOT_PATH=$(shell pwd)/build
 PACKAGE_FILE_PATH=$(shell pwd)/lipase-$(LIPASE_VERSION).zip
 
 .PHONY: all
-all: test
+all: test doc
+
+.PHONY:
+doc: doc/lipase.pdf
+
+doc/lipase.pdf: doc/lipase.tex
+	cd doc; latexmk 
+
+.PHONY:
+clean_doc:
+	cd doc; rm lipase.pdf lipase.aux lipase.fls lipase.log lipase.fdb_latexmk lipase.dvi; 
+
 
 $(BUILD_ROOT_PATH)/jars/Lib/fr.univ-rennes1.ipr.lipase.lib.jar: $(LIB_SRC_FILES)
 	pushd ./src; \
@@ -91,6 +102,6 @@ test0001: install
 test: test0001
 
 .PHONY: clean
-clean:
+clean: clean_doc
 	rm -Rf $(BUILD_ROOT_PATH)
 	rm -Rf $(PACKAGE_FILE_PATH)

README.md

@@ -10,19 +10,23 @@ As the development is at its early stages, it does not much at the moment:
 
 - loads a sequence of images into fiji in the form of an hyperstack (5d images : width, height, depth, channels, time)
 
-## How to use
+## How to install
 
 1. make sure that fiji is installed on your computer. If not, get it from https://fiji.sc/
-2. make sure that fiji has the IJ-OpenCV-plugins
+2. make sure that fiji has the `IJ-OpenCV-plugins`
-    - in Fiji, select the Help->Update... menu item
+    - in Fiji, select the `Help->Update...` menu item
-    - in the Manage update sites window, tick the IJ-OpenCV-plugins (URL = http://sites.imagej.net/IJ-OpenCV/) if it's not ticked.
+    - in the **Manage update sites** window, tick the `IJ-OpenCV-plugins` (URL = http://sites.imagej.net/IJ-OpenCV/) if it's not ticked.
-    - click the close button of the Manage update sites window
+    - click the `close` button of the **Manage update sites** window
-    - click "Apply changes" button in the ImageJ Updater window
+    - click `Apply changes` button in the **ImageJ Updater** window
     - wait until the plugins are installed and quit Fiji
 3. Install lipase
-    - lipase is released as a package named "lipase-<lipase-version>.zip". This package can be build from sources using the 'make package' command, provided you have all the build tools on your machine (make, javac, zip).
+    - lipase is released as a package named `lipase-<lipase-version>.zip`. This package can be build from sources using the `make package` command, provided you have all the build tools on your machine (make, javac, zip).
-    - simply unzip the package "lipase-<lipase-version>.zip" in Fiji root directory
+    - simply unzip the package `lipase-<lipase-version>.zip` in Fiji root directory
-4. launch fiji and check that you have lipase tools in the menu Plugins/Ipr/Lipase
+4. launch fiji and check that you have lipase tools in the menu `Plugins/Ipr/Lipase`
+
+## How to use
+
+
 
 ## Notes
 

doc/notes/2018-06-19-meeting.md

@@ -15,24 +15,24 @@ Compte-rendu
 	- objectif x100
 		- 40 images de 60s avec chacun des 3 filtres
 		- 80 images de 30s avec chacun des 3 filtres
-	img_<temps>_DM300_<filtre>_<signal>_<prof>.tif
+	`img_<temps>_DM300_<filtre>_<signal>_<prof>.tif`
-		filtre :
+		- filtre :
-			327-353 : nm
+			- 327-353 : nm
-			420-480 : nm
+			- 420-480 : nm
-		signal:
+		- signal:
-			fluo
+			- fluo
-			vis
+			- vis
-		temps : exemple (000000021)
+		- temps : exemple (000000021)
-			numero sur 9 digits
+			- numero sur 9 digits
-		profondeur: exemple 003
+		- profondeur: exemple 003
-			numero sur 3 digits
+			- numero sur 3 digits
 - échantillons:
-	GGB : globule gras bovin
+	- GGB : globule gras bovin
-	ZeissObjectiveTurret-Label : 2-Ultrafluar 40x/0.60 Glyc
+	- ZeissObjectiveTurret-Label : 2-Ultrafluar 40x/0.60 Glyc
-		objectif à huile : glycerol
+		- objectif à huile : glycerol
-		ouverture 0.60
+		- ouverture 0.60
 - on a regardé
-	GGB_cin15_phaseG-I-No-enz_327-vis-352_40x_1
+	- GGB_cin15_phaseG-I-No-enz_327-vis-352_40x_1
 		- traitements à faire:
 			- estimer la surface des blobs au cours du temps
 			- estimer le niveau de gris moyen des blobs au cours du temps

doc/notes/2019-06-18-meeting.md

@@ -8,7 +8,7 @@ Présents
 
 Compte-rendu
 ------------
-- on a configuré son partable dell pour pouvoir lancer mes scripts :
+- on a configuré son portable dell pour pouvoir lancer mes scripts :
 	- git était déjà installé
 	- mise à jour de GlobuleGras/lipase.git
 	- install de fiji 32 bits

doc/notes/2019-07-02-meeting.md

@@ -26,9 +26,9 @@ Compte-rendu
 	- deconvolution: huygens
 		
 plan d'action :
-	- 1. mettre sur le cloud les données de la formation pendant que c'est possible
+1. mettre sur le cloud les données de la formation pendant que c'est possible
 		- telemosToolbox
 		- les données de la formation
 		- les pdf de la formation
-	- 2. utiliser les outils du tp pour traiter l'acquisition du tp de bout en bout
+2. utiliser les outils du tp pour traiter l'acquisition du tp de bout en bout
-	- 3. decide la suite
+3. decide la suite

doc/notes/2019-07-09-meeting.md

@@ -11,14 +11,14 @@ Compte-rendu
 
 
 plan
-	1. ouvrir les images
+1. ouvrir les images
-	2. adapter les prétraitements de Marie-Françoise matlab  en jython
+2. adapter les prétraitements de Marie-Françoise matlab  en jython
-	3. mesure de la diminution des globules au cours du temps
+3. mesure de la diminution des globules au cours du temps
-		3.1 suppression des pièges (masques + tracking)
+	1. suppression des pièges (masques + tracking)
-		3.2 detection des particules : 1 cinétique par particule
+    2. detection des particules : 1 cinétique par particule
 		- idée pour la séparation des particules : suivi de contour et detection de portions circulaires pour en déduire les particules en supposoant que'elles sont sphériques.
-	4. présenter les résultats 
+4. présenter les résultats 
-		4.1 tableau 7 colonnes
+	1. tableau 7 colonnes
 		- numéro de particule
 		- temps
 		- sphéricité

doc/notes/2020-01-31-meeting.md

@@ -9,11 +9,11 @@ Présents
 Compte-rendu
 ------------
 todo:
-	- ajouter une interface utilisateur pour que l'utilisateur puisse tester correct_non_uniform_lighting
+- ajouter une interface utilisateur pour que l'utilisateur puisse tester correct_non_uniform_lighting
-	- finaliser la generation du masque
+- finaliser la generation du masque
-	- pour le flood fill, prendre un pixel du coin plutôt qu'un pixel fourni par l'utilisateur
+- pour le flood fill, prendre un pixel du coin plutôt qu'un pixel fourni par l'utilisateur
-	- ajouter une interface utilisateur pour le match template
+- ajouter une interface utilisateur pour le match template
-	- ajouter une interface utilisateur pour le nettoyage d'un piège
+- ajouter une interface utilisateur pour le nettoyage d'un piège
-	- analyser la surface de la surface totale des particules sans regarder les particules individuellement
+- analyser la surface de la surface totale des particules sans regarder les particules individuellement
-	- nettoyage du fond (estimate white, mais pour les images visibles)
+- nettoyage du fond (estimate white, mais pour les images visibles)
 

doc/notes/2020-02-14-meeting.md

@@ -0,0 +1,20 @@
+Réunion d'avancement du 14/02/2020
+==================================
+
+Présents
+--------
+- Véronique Vié
+- Guillaume Raffy
+
+Compte-rendu
+------------
+
+todo :
+- remplacer les séquences hardcodées par un scan automatique du catalogue
+- nettoyage du fond (estimate white, mais pour les images visibles)
+- ajouter une interface utilisateur pour que l'utilisateur puisse tester correct_non_uniform_lighting
+- pour le flood fill, prendre un pixel du coin plutôt qu'un pixel fourni par l'utilisateur
+- ajouter une interface utilisateur pour le match template
+- ajouter une interface utilisateur pour le nettoyage d'un piège
+- analyser la surface de la surface totale des particules sans regarder les particules individuellement
+