Merge pull request #134 from ornlneutronimaging/133_scenario

added documentation. this refs #133
ornlneutronimaging · Feb 3, 2022 · 4dd5e6a · 4dd5e6a
2 parents fc0a5a5 + 05d8f64
commit 4dd5e6a
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 0 deletions.
diff --git a/docs/usageScenarios/automatic_reconstruction_scenario.rst b/docs/usageScenarios/automatic_reconstruction_scenario.rst
@@ -0,0 +1,14 @@
+For this scenario, as soon as a full set of 3D acquisition is done (when all the rotation angle have been acquired)
+iMars3D should be automatically triggered and reconstruct the data and export them into the IPTS-XXXX/shared/processed_data folder.
+
+This scenario used to work and stopped working 2 years ago. Script used can be find in `/HFIR/CG1D/shared/autoreduce`
+
+This script took 2 arguments
+
+* input file
+* output folder
+
+example
+
+* input file -> /HFIR/CG1D/IPTS-25777/raw/ct-scans/iron_man/20191030_ironman_small_0070_348_000_0602.tiff
+* output folder -> /HFIR/CG1D/IPTS-25777/shared/processed_data/
diff --git a/docs/usageScenarios/command_line_scenario.rst b/docs/usageScenarios/command_line_scenario.rst
@@ -0,0 +1,13 @@
+Data used: IPTS-25777
+
+* Raw projections:   /HFIR/CG1D/IPTS-25777/raw/ct_scans/iron_man/*
+* ob: /HFIR/CG1D/IPTS-25777/raw/ob/Oct29_2019/*
+* df: /HFIR/CG1D/IPTS-25777/raw/df/Oct29_2019/*
+
+iMars3D should be available to the user as a conda or pip application and be executed using a simple command line
+that may look like
+
+```
+iMars3d --raw-projections /HFIR/CG1D/IPTS-25777/raw/ct_scans/iron_man/* --ob /HFIR/CG1D/IPTS-25777/raw/ob/Oct29_2019/*
+--df /HFIR/CG1D/IPTS-25777/raw/df/Oct29_2019/* --tilt-correction 0.01 --crop-x0 10 --crop-y0 20 --crop-x1 500 --crop-y1 390
+```