Skip to content

Commit

Permalink
ecg gen: README update
Browse files Browse the repository at this point in the history
  • Loading branch information
deepanshi-s committed May 24, 2024
1 parent 5c898fb commit f0126c0
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion codes/ecg-image-generator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,10 +57,10 @@ The basic mode of the tool creates ECG images without distortions. The mode of o
- `-r`: Resolution with default being 200; type: int
- `--pad_inches`: Padding of white border along the image with default padding of 0 inches; type: int
- `--print_header`: Add text from header file on all the generated images; default: False
- `--add_qr_code`: Add QR code to all the generated images, default: False.
- `--num_columns` : Number of columns of the ECG leads. The default(-1) will plot a single column for 2 lead data and 4 columns for the 12 or any other number of lead data. Default: -1; type: int
- `--full_mode`: Sets the lead to add at the bottom of the paper ECG as a long strip obtained from the WFDB record's `.hea` header file, if the lead II is not available plots the first lead from the header file; default: `'II'`; type: str
- `--mask_unplotted_samples`: Mask the samples not plotted in the images in the generated WFDB signal file; default: False. For example: for the 3x4 format, the code plots 2.5 seconds of each lead on the image and saves the complete signal in the WFDB file. If the flag is set, the code will mask the part of the signal not plotted in the image (In this case, t > 2.5seconds) with Nan values in the modified WFDB file.
- `--add_qr_code`: Add QR code to all the generated images, default: False.
- `--max_num_images`: Number of ECG images to be generated, if max_num_images is less than the number of files in the input directory it will generate maximum number of images and the order is dependent on the OS library; default: all files in the input directory; type: int
- `--remove_lead_names`: Remove lead names from all generated images, default=False.
- `--random_resolution`: Generate random resolutions of images, if True resolution is randomly picked from the range [50, `r`] else every image is generated at the `-r` resolution; default: False
Expand Down

0 comments on commit f0126c0

Please sign in to comment.