Skip to content

Commit a7a96cb

Browse files
author
eduardotogpi
committed
Updated README with basic instructions
1 parent f4243fe commit a7a96cb

File tree

1 file changed

+49
-0
lines changed

1 file changed

+49
-0
lines changed

README.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,58 @@ User-friendly scripts designed to make pyCRT accessible to non-programmers.
66

77
## Through the EXE file (Windows only)
88

9+
Assuming the settings in the configuration file haven't been altered, the
10+
following steps describe the entire usage of the program:
11+
12+
1. Navigate to the directory `dist/measure_crt/`
13+
2. Execute the file `measure_crt.exe`
14+
15+
Windows may block the execution of the program due to "unknown source". This
16+
is expected. Simply click "More info" -> "Run anyway".
17+
18+
3. Select whether you would like to measure CRT in a single video or in all
19+
the videos inside a directory.
20+
4. If a Region of Interest (ROI) was not specified in the configuration file
21+
(see below), press the spacebar key when pressure is being applied, click
22+
and drag the mouse to draw a square around the desired ROI.
23+
5. Check the terminal. If a ROI was selected manually, it should appear there
24+
as a tuple of 4 numbers.
25+
6. Wait for video playback to finish.
26+
7. If CRT measurement was successful, you should see plots of the average
27+
intensities in each channel and the CRT fit result.
28+
8. The aforementioned graphs are saved in the `dists/measure_crt/Plots`
29+
directory.
30+
9. The file `results_sheet.csv` is created automatically. It contains a
31+
spreadsheet of the parameters and results of every CRT measurement
32+
performed using the program. The file `results_sheet.xlsx` is the same
33+
spreadsheet, but in a format more suitable for spreadsheet software such as
34+
MS Excel.
35+
10. A log of all the messages printed on the terminal is kept in the file
36+
log.txt, organized by the date and time of execution of this program.
937

1038
## Through the command line
1139

40+
The script can also be executed in your Python environment. Simply run either
41+
`measure_crt.py` in the command line:
42+
43+
```
44+
python measure_crt.py
45+
```
46+
47+
Upon running the script, you may proceed according to the instructions for the
48+
EXE file.
49+
50+
In case you specifically want to measure CRT from a single video file or from
51+
an entire directory of videos, you may run the scripts `measure_crt_video.py`
52+
and `measure_crt_dir.py` respectively.
53+
54+
55+
## Configuration file
56+
57+
The CRT measurement parameters, as well as the program's settings can be
58+
configured with the `configuration.toml`, which is read at the start of each
59+
execution. More details to be added later...
60+
1261
# To-do
1362

1463
This is a list of features I would like to implement (I don't promise I will

0 commit comments

Comments
 (0)