Skip to content

Ⓜ️ BIIGLE module to perform a heuristic laser point detection on images

License

Notifications You must be signed in to change notification settings

biigle/laserpoints

Repository files navigation

BIIGLE Laserpoints Module

Test status

This is the BIIGLE module to perform a heuristic laser point detection on images.

Installation

This module is already included in biigle/biigle.

  1. Run composer require biigle/laserpoints.
  2. Add Biigle\Modules\Laserpoints\LaserpointsServiceProvider::class to the providers array in config/app.php.
  3. Run php artisan vendor:publish --tag=public to publish the public assets of this module.
  4. Run pip install -r vendor/biigle/laserpoints/requirements.txt to install the Python requirements.
  5. Configure a storage disk for the temporary laserpoints files LASERPOINTS_DISK variable to the name of this storage disk in the .env file. Example for a local disk:
    'laserpoints' => [
        'driver' => 'local',
        'root' => storage_path('framework/cache/laserpoints'),
    ],

References

Reference publications that you should cite if you use the laser point detection for one of your studies.

Developing

Take a look at the development guide of the core repository to get started with the development setup.

Want to develop a new module? Head over to the biigle/module template repository.

Contributions and bug reports

Contributions to BIIGLE are always welcome. Check out the contribution guide to get started.