Skip to content

saberioon/vegRV

Repository files navigation

STEROPES-WP4

DOI

License: EUPL-1.2

Command-line software for segmenting the vegetation from the RGB image

New Features

  • Calculating percentage of each cluster and report in a csv file for all images in one folder

Installation

To install and set up your command-line software and its dependencies, follow these steps:

  1. Ensure that Python and poetry are installed on your system. If not, please refer to the official documentation for installation instructions.

  2. Clone the repository or download the source code for your command-line software.

git clone https://github.com/saberioon/vegRV.git
  1. Navigate to the project directory in your terminal.

  2. Run the following command to install the dependencies using Poetry:

poetry install

This command will create a virtual environment and install all the required dependencies specified in the pyproject.toml file.

For more information about Poetry and its usage, refer to the official Poetry documentation.

  1. Once the dependencies are installed successfully, you are ready to use your command-line software.

Usage

To run your command-line software, follow these steps:

  1. Make sure you are in the project directory in your terminal.

  2. Activate the virtual environment created by Poetry by running the following command:

poetry shell
  1. run the commandline software using this command
python steropeswp4.py -i Input Folder -o Output Folder -c Colorspace {hsv, hls, yiq}

options:

-h, --help show this help message and exit -i INPUT, --input INPUT input folder

-o OUTPUT, --output OUTPUT output folder

-c COLORSPACE, --colorspace COLORSPACE colorspace hsv, hls, yiq

Additional Notes

  • It is recommended to always run your command-line software within the Poetry virtual environment to ensure proper dependency management and avoid conflicts with other packages installed on your system.

  • keep the input folder and output folder in seperate directory.

License

this software is released under EUROPEAN UNION PUBLIC LICENCE v. 1.2

Acknowledgements

This work was supported by the European Union’s Horizon H2020 research and innovation European Joint Programme Cofund on Agricultural Soil Management (EJP-SOIL grant number 862695) and was carried out in the framework of the STEROPES of EJP-SOIL

SteropesLogo

Citation

If you find this code useful in your research or work, please consider citing it:

@software{vegRV,
author = {M. Saberioon},
title = {vegRV: A Command-Line Software for segmenting plant residual from RGB images},
year = {2023},
url = {https://github.com/saberioon/vegRV
doi = {10.5281/zenodo.7925046}
}