Skip to content

Changes

Page history
Update cdsFilt authored by Ezekiel Dohmen's avatar Ezekiel Dohmen
Show whitespace changes
Inline Side-by-side
cdsFilt.md
View page @ 8191fe6e
......@@ -43,12 +43,12 @@ You do this by adding the name of the channel (without the '_DQ' suffix) to a DA
| `_IN2_DQ` | The latest value from the excitation input summed with the input to the filter. (IN2 on medm) | Full Model Rate, unless decimated in DAQ channel list |
| `_OUT_DQ` | The latest value of the filter, after all processing. (OUT on medm) | Full Model Rate, unless decimated in DAQ channel list |
### cdsFilt
## cdsFilt
> ![image](uploads/ee62f8c4c1e67cc7f1a5afa094489300/image.png)
The `cdsFilt` part has all the above mentioned EPICS channels.
### cdsFiltCtrl
## cdsFiltCtrl
> ![image](uploads/b3f22055273c4c6d873234badacd8c51/image.png)
The `cdsFiltCtrl` block adds two additional inputs and 1 additional output.
......@@ -57,14 +57,36 @@ The `cdsFiltCtrl` block adds two additional inputs and 1 additional output.
| In1 | Input sample, same as `cdsFilt`. |
| Cin | Control input. A bitfield containing controls bits for the filter provided by the realtime logic, instead of EPICS channels like in the `cdsFilt` case. |
| Mask | Local control (LC) bitfield mask. This specifies the control bits that are controlled by the models realtime logic, instead of EPICS channels like in the `cdsFilt` case.|
| Val | The output sample, same as `cdsFilt`. |
| Ctrl | The current commanded control state of the filter module. This include the state from the EPICS channels overridden by any control bits provided to Cin and masked by the Mask input. |
#### Cin/Mask Explanation
When valid bits are set in the Mask input the filter module will use the corresponding bits from the Cin input instead of the normal `_SW1` and `_SW2` EPICS channels. This allows the realtime model to control a subset of the filters control flags.
When valid bits are set in the Mask input, the filter module will use the corresponding bits from the Cin input instead of the normal `_SW1` and `_SW2` EPICS channels. This allows the realtime model to control a subset of the filters control flags. When these options are controlled in this manner, we call it being under "local control". The medm screens will draw a yellow "LC" by elements displayed on the filter screen that are being masked (corresponding bits high in Mask input).
> ![image](uploads/c7fa73a8681b970d828415cd15c7eca7/image.png)
The FMX bits tell the individual filters to enable, and the output, offset and enable bits control if those options should be enabled/disabled.
#### Additional EPICS channel
The `_MASK` channel is made available with `cdsFiltCtrl` and `cdsFiltCtrl2` parts. This is a read only channel that records the value of the Mask input port.
### cdsFiltCtrl2
## cdsFiltCtrl2
> ![image](uploads/57810c0ef713546b85e35fb780a6290c/image.png)
The `cdsFiltCtrl2` is the same as the `cdsFiltCtrl` part, except for some renamed inputs, additional inputs, outputs and control bits. This part only exposes more of the filter module for realtime control.
| Port Name | Function |
| --------- | -------- |
| Input | Input sample, same as `cdsFilt`. |
| CtrlIn | Control input. A bitfield containing controls bits for the filter provided by the realtime logic, instead of EPICS channels like in the `cdsFilt` case. |
| Mask | Local control (LC) bitfield mask. This specifies the control bits that are controlled by the models realtime logic, instead of EPICS channels like in the `cdsFilt` case.|
| OffsetIn | An offset value that should be used when masked and enabled with CtrlIn. |
| GainIn | A Gain value that should be used when masked and enabled with CtrlIn. |
| RampIN | A TRAMP value that should be used when masked and enabled with CtrlIn |
| Val | The output sample, same as `cdsFilt`. |
| Ctrl | The current commanded control state of the filter module. This include the state from the EPICS channels overridden by any control bits provided to Cin and masked by the Mask input. |
#### CtrlIn and Mask Explanation
> ![image](uploads/3df96fb0fcb57b6f8f7a5b24d0117e92/image.png)
This is the same bit order as the `cdsFiltCtrl`, however there are now three additional most significant bits that mask/control if the module should use the offset, gain and ramp provided by the realtime model instead of the EPICS inputs.