PUSH NOTE : convert-emd.md

content/open source/convert-emd.md

@@ -7,13 +7,13 @@ github: https://github.com/blleng/convert-emd
 document: https://pypi.org/project/convert-emd
 dg-publish: true
 maturity: tree
-index: "2"
+index: "1"
 date: 2024-09-09T06:42
-update: 2024-09-09T06:57
+update: 2024-09-10T12:14
 title: A tool for converting EMD (Velox) data into images - Convert EMD
 ---
 # Convert EMD
-This tool converts 2D signal in .emd files into images.
+Convert-EMD exports images and spectrum data from Velox generated EMD files.
 
 This project is based on [RosettaSciIO](https://github.com/hyperspy/rosettasciio) and [emd-converter](https://github.com/matao1984/emd-converter)
 
@@ -22,7 +22,8 @@ This project is based on [RosettaSciIO](https://github.com/hyperspy/rosettasciio
 >Pypi page: https://pypi.org/project/convert-emd
 
 ## Install
-Environment requirenments: `Python >= 3.8`
+
+Environment requirements: `Python >= 3.8`
 
 With pip:
 
@@ -93,22 +94,26 @@ NOTICE: Three arguments are required to specify the position and width of scale
 
 #### Color of Elements
 
-The `-e`/`--eds` option allow users to specify the color of elemental mappings (default: gray).
+Default colors of elemental mapppings are corresponding to the following list in sequnce (*Matplotlib* default colors):
+
+'<font color=#1f77b4>#1f77b4</font>', '<font color=#ff7f0e>#ff7f0e</font>', '<font color=#2ca02c>#2ca02c</font>', '<font color=#d62728>#d62728</font>', '<font color=#9467bd>#9467bd</font>', '<font color=#8c564b>#8c564b</font>', '<font color=#e377c2>#e377c2</font>', <font color=7f7f7f>7f7f7f</font>', '<font color=#bcbd22>#bcbd22</font>', '<font color=#17becf>#17becf</font>'
+
+Convert-EMD provides `-e`/`--eds` option for users to customize the color of elemental mappings.
 
 ```bash
 cemd -f INPUT_FILE -e ELEMENT_1 COLOR_1 ELEMENT_2 COLOR_2 ELEMENT_3 COLOR_3 ...
 ```
 
+NOTICE: You don't need to specify all elemental colors, those undefined ones will be set according to the default color list.
+
 #### Overlayed Mapping
 
-The `-oe`/`--overlay` option decides which elements are overlyed.
+The `-oe`/`--overlay` option decides which elements are overlyed (default: all).
 
 ```bash
 cemd -f INPUT_FILE -oe ELEMENT_1 ElEMENT_2 ...
 ```
 
-NOTICE: The colors in the overlayed mapping are corresponding to the color specified by the `-e` option.
-
 Moreover, `-oa`/`--overlay_alpha` and `-sa`/`--substrate_alpha` options are provided to adjust the transparency of elemental layers (default: 1.0) and the HAADF layer (default: 0.5) respectively. The argument should be a float number between 0 and 1, 0 means totally transparent.
 
 ### Contrast (Histogram Equalization)
@@ -119,4 +124,4 @@ With this method, the image is rescaled to include all intensities that fall wit
 
 ```bash
 cemd -f INPUT_FILE -c MIN MAX
-```
+```