Skip to content

Commit 4b9c371

Browse files
authored
Update README.md
1 parent d8babe1 commit 4b9c371

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -362,20 +362,30 @@ class NameOfYourPlugin(PluginBase):
362362
Then, add your plugin setting to `config/plugin_config.yaml`
363363

364364
```yaml
365-
example: # Use the same name as your file name.
365+
example: # Name of your filter
366+
type: "example" # Specify the name of your plugin (the name of your file name).
366367
enable: True # weather to load this plugin
367368
fill_nan: True # Fill nans to invalid cells of elevation layer.
368369
is_height_layer: True # If this is a height layer (such as elevation) or not (such as traversability)
369370
layer_name: "example_layer" # The layer name.
370371
extra_params: # This params are passed to the plugin class on initialization.
371372
add_value: 2.0 # Example param
373+
374+
example_large: # You can apply same filter with different name.
375+
type: "example" # Specify the name of your plugin (the name of your file name).
376+
enable: True # weather to load this plugin
377+
fill_nan: True # Fill nans to invalid cells of elevation layer.
378+
is_height_layer: True # If this is a height layer (such as elevation) or not (such as traversability)
379+
layer_name: "example_layer_large" # The layer name.
380+
extra_params: # This params are passed to the plugin class on initialization.
381+
add_value: 100.0 # Example param with larger value.
372382
```
373383

374384
Finally, add your layer name to publishers in `config/parameters.yaml`. You can create a new topic or add to existing topics.
375385

376386
```yaml
377387
plugin_example: # Topic name
378-
layers: [ 'elevation', 'example_layer' ]
388+
layers: [ 'elevation', 'example_layer', 'example_layer_large' ]
379389
basic_layers: [ 'example_layer' ]
380390
fps: 1.0 # The plugin is called with this fps.
381391
```

0 commit comments

Comments
 (0)