Skip to content

Welcome to PlantImagerLink

ROMI_ICON2_greenB.png

For full documentation of the ROMI project visit docs.romi-project.eu.

AboutLink

To be as clear as possible, we first define the following names:

  • PlantImager: hardware control of the ROMI 3D plant imager.
  • VirtualPlantImager: simulate the 3D plant imager using LPY to generate virtual plants and Blender for rendering RGB images.

We recommend using the VirtualPlantImager with a docker container.

Getting startedLink

Create a local databaseLink

If not done yet, start by creating a local plantdb database, whose path will be known as $ROMI_DB:

export ROMI_DB="/data/ROMI/"
mkdir -p "${ROMI_DB}"
touch "${ROMI_DB}/romidb"

To use the VirtualPlantImager, yu will also need the vscan_data folder accessible under plant-imager/database_example.

Set the permissionsLink

Create a romi group and give it rights over the local plantdb database

  1. Create the romi group with 2020 as GID:
    sudo addgroup romi --gid 2020
    
  2. Add the current user to the romi group:
    sudo usermod -a -G romi $USER
    
  3. Change the group of the local database:
    sudo chown -R :romi $ROMI_DB
    
  4. Check the rights with:
    ls -al $ROMI_DB
    
    This should yield something like:
    drwxrwxr-x  2 myuser romi     4096 nov.  21 12:00 .
    drwxrwxrwx 31 myuser myuser   4096 nov.  21 12:00 ..
    -rw-rw-r--  1 myuser romi        0 nov.  21 12:00 romidb
    
    Where myuser is your username.

Note

After step 2 you will need to re-open a terminal to belong to the romi group.

Getting started with DockerLink

We strongly recommend using the docker images to use this library.

PlantImager docker imageLink

Pull a pre-built imageLink

The simplest way to use the docker image is to pull the pre-built roboticsmicrofarms/plantimager docker image as follows:

docker pull roboticsmicrofarms/plantimager:latest

Start a containerLink

In the docker/plantimager/ directory, you will also find a convenience script named run.sh. To get usage information, from the plant-imager repository root folder:

./docker/plantimager/run.sh -h

For example, to generate a new plant scan dataset, here named my_scan, simply do:

./docker/plantimager/run.sh \
  -c "romi_run_task Scan /myapp/db/my_scan --config plant-imager/config/hardware_scan_rx0.toml"

VirtualPlantImager docker imageLink

Pull a pre-built imageLink

The simplest way to use the docker image is to pull the pre-built roboticsmicrofarms/virtualplantimager docker image as follows:

docker pull roboticsmicrofarms/virtualplantimager:latest

Start a containerLink

In the docker/virtualplantimager/ directory, you will also find a convenience script named run.sh. To get usage information, from the plant-imager repository root folder:

./docker/virtualplantimager/run.sh -h

For example, to generate a new virtual plant scan dataset, named vplant_test, simply do:

./docker/virtualplantimager/run.sh --test