Commit f1d4e649 authored by Pascal Palenda's avatar Pascal Palenda
Browse files

Add some inforamtion in the readme

parent 14c8d590
......@@ -3,6 +3,91 @@
ITASimulationScheduler is a C++ library and application collection to run distributed acoustic simulations.
It comes with scheduling features for real-time and sequential (offline) task procedures using threads and/or MPI.
### Possible Filter Configs
Listed below are the possible filter configs with all their respective keys.
Common Keys are:
- **Name** : The name by which the filter can be referred to.
- **Type** : The type of filter to be used.
- **NextFilter** : Name of the next filter to be evaluated after this filter.
Multiple comma separated names are supported to created branches in the evaluation.
- **UsageMode** : How the filter should be used: As a filter (0) or condition (1).
- **InvertCondition** : In case the filter is used as a condition, the result can be inverted.
```json
{
"Filter0" : {
"@Name" : "Unknown",
"@Type" : "PerceptiveRotationFilter",
"@NextFilter" : "",
"@UsageMode" : 0,
"@InvertCondition" : false,
"@StrengthFactor" : 1
},
"Filter1" : {
"@Name" : "Unknown",
"@Type" : "RateFilter",
"@NextFilter" : "",
"@UsageMode" : 0,
"@InvertCondition" : false,
"@Rate" : 1
},
"Filter2" : {
"@Name" : "Unknown",
"@Type" : "ReverberationRadiusFilter",
"@NextFilter" : "",
"@UsageMode" : 0,
"@InvertCondition" : false,
"@ReverberationRadius" : 5
},
"Filter3" : {
"@Name" : "Unknown",
"@Type" : "RotationFilter",
"@NextFilter" : "",
"@UsageMode" : 0,
"@InvertCondition" : false,
"@ReceiverThreshold" : 2.5,
"@SourceThreshold" : 2.5,
"@RotationMode" : 1
},
"Filter4" : {
"@Name" : "Unknown",
"@Type" : "TranslationFilter",
"@NextFilter" : "",
"@UsageMode" : 0,
"@InvertCondition" : false,
"@MinimumTranslation" : 5,
"@TranslationMode" : 1
},
"Filter5" : {
"@Name" : "Unknown",
"@Type" : "ZoneFilter",
"@NextFilter" : "",
"@UsageMode" : 0,
"@InvertCondition" : false,
"Zones" : {
"Zone0first" : [0, 0, 0],
"Zone0second" : [1, 1, 1]
}
}
}
```
### Adding Filters Or Workers
To add filters or worker to this project, derive your from the fitting interface class and add a corresponding config struct, also derived from the fitting interface config.
In order to use the new filter or worker, it can be added to their corresponding factory class
- at compile time by adding it to the map in the correspoding cpp file.
- at run time by calling the register function of the factory.
### License
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment