update README, add file about 'goal and features', and 'releases changes' file

Author: lp-rep

CHANGES.md

@@ -0,0 +1,16 @@
+Release 1.02 (11 June 2021) -- compared to 1.01
+----------------------------------------------
+* Fix bug about profiles flags set to ON which were lost (i.e. set to OFF) for the box shown after a computation run (never the first run)
+* Fix the rejection of values > 999.999, from Ui, for micmac step values and spatial resolution
+* Improve micmac step values and spatial resolution numeric format compliance check from .jstackprof
+* Reject thresholdRejection values from .jstackprof below 0 or greater than 999.999 and add numeric format compliance check
+* Fix the display of valid reloaded threshold value and button state if an invalid value was typed and Cancel button used
+
+Release 1.01 (30 May 2021) -- compared to 1.0
+--------------------------------------------------
+* Fix the behavior after usage of 'set pixel conversion factors'
+  The application now considers correctly when no change was made about it, instead of considering as always changed
+
+Release 1.0 (28 May 2021) 
+--------------------------------------------------
+Initial commit. No Tag.

README.md

@@ -1,19 +1,19 @@
-
-StackProf
-=========
-
-This repository contains:
-
-- Stackprof application source code
-- Unit tests source code about stackprof and linked tools
-- Documentation to build and deliver the application for linux and macOS target
-- Documentation about the source code
-- Third party libraries licenses
-
-Stackprof binaries are located in this repository: https://github.com/IPGP/stackprof
-These are:
-- Stackprof application binaries for Linux and macOS target
-- User guide
-- application input/ouput files description
-- input data and images for stackprof unit tests
-
+
+StackProf
+=========
+
+This repository contains:
+
+- Stackprof application source code
+- Unit tests source code about stackprof and linked tools
+- Documentation to build and deliver the application for linux and macOS target
+- Documentation about the source code
+- Source code license
+- Third party libraries licenses
+
+Stackprof binaries are located in another repository: https://github.com/IPGP/stackprof
+These are:
+- Stackprof application binaries for  linux and macOS target
+- User guide (French)
+- Application's files format description (English): traces, project  and measures export 
+- Input data and images for stackprof tests and unit tests

goal_and_features.md

@@ -0,0 +1,38 @@
+
+
+### StackProf
+
+#### Goal
+
+The main goal of stackprof is to compute stacked profiles on displacement maps (with two components or just one) and provide graphic view on profiles to perform measurements. Its main target is to make measurements along seismic fault.
+
+#### Main features
+
+- Flexible view of input images or displacement maps: adjustable window size, move/zoom/center on a point, etc.
+- Edit one or more traces over an image or a displacement map
+- Add oriented stacked profile boxes along a trace using automatic distributions. Two methods available:
+  - Boxes as close to each other as possible
+  - Set distance between box centers
+- Add/move/resize/remove any oriented stacked profile boxes along a trace
+- Reversible profile orientation
+- Possible usage of correlation score map to compute weighted mean or weighted median
+- Filter values according to a threshold on correlation score map
+- Flexible view of computed stacked profiles curves: 
+  - adjustable window size
+  - up to three computed components displayed at the same time (Perpendicular, Parallel, deltaZ), sharing same y-axis range or not.
+- Adjustable profile center position for the offset measurement (in addition to left and right sides around the profile center)
+- Geo referencing: 
+  - converts trace to match project if required
+  - displays and exports WGS84 locations
+- Export results in ASCII and json
+
+With:
+
+- up to 100 000 x 100 000 pixels input images
+- get nearest pixel or 2x2 square of surrounding pixels to get pixel values for computation
+- Set pixel value conversion factor ('MicMac step value' and spatial resolution)
+- Possible exponentiation from 2 to 6 for weight to compute weighted mean or weighted median
+- Adjustable color and width of computed stacked profiles curves items
+- Flag any profile to filter them at export or other purpose
+- Edit and export trace from project
+