Skip to content

Commit

Permalink
Fix #59, documented setSection=*,...
Browse files Browse the repository at this point in the history
  • Loading branch information
giuseppe-carboni committed Mar 22, 2024
1 parent e6015a0 commit 50f1ee7
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 0 deletions.
15 changes: 15 additions & 0 deletions user/medicina/Backend.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,11 @@ where:
* *[bins]* is the number of frequency bins for the given section
(not applicable for TPB)

To select all sections of the backend, an asterisk can be used instead of
specifying the desired section::

> setSection=*,*,[bw],*,*,[sampleRate],*

To leave a parameter at its previously set value, or equivalently skip it when
it is not applicable, use an asterisk.
For the TPB, in particular, always use::
Expand Down Expand Up @@ -169,6 +174,11 @@ where:
* *[sampleRate]* is also given in MHz
* *[bins]* is the number of frequency bins for the given section

To select all sections of the backend, an asterisk can be used instead of
specifying the desired section::

> setSection=*,[startFreq],[bw],[feed],[mode],[sampleRate],[bins]

However, the present implementation allows the user to change only part of
these parameters, in particular:

Expand Down Expand Up @@ -241,6 +251,11 @@ where:
* *[sampleRate]* is also given in MHz
* *[bins]* is the number of frequency bins for the given section

To select all sections of the backend, an asterisk can be used instead of
specifying the desired section::

> setSection=*,[startFreq],[bw],[feed],[mode],[sampleRate],[bins]

However, the present implementation allows the user to change only part of
these parameters, in particular:

Expand Down
5 changes: 5 additions & 0 deletions user/noto/Backend.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,11 @@ where:
* *[bins]* is the number of frequency bins for the given section
(not applicable for TPB)

To select all sections of the backend, an asterisk can be used instead of
specifying the desired section::

> setSection=*,*,[bw],*,*,[sampleRate],*

To leave a parameter at its previously set value, or equivalently skip it when
it is not applicable, use an asterisk.
For the TPB, in particular, always use::
Expand Down
15 changes: 15 additions & 0 deletions user/srt/source/Backend.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,11 @@ where:
* *[bins]* is the number of frequency bins for the given section
(not applicable for TPB)

To select all sections of the backend, an asterisk can be used instead of
specifying the desired section::

> setSection=*,*,[bw],*,*,[sampleRate],*

To leave a parameter at its previously set value, or equivalently skip it when
it is not applicable, use an asterisk.
For the TPB, in particular, always use::
Expand Down Expand Up @@ -154,6 +159,11 @@ where:
* *[sampleRate]* is also given in MHz
* *[bins]* is the number of frequency bins for the given section

To select all sections of the backend, an asterisk can be used instead of
specifying the desired section::

> setSection=*,[startFreq],[bw],[feed],[mode],[sampleRate],[bins]

However, the present implementation allows the user to change only part of
these parameters, in particular:

Expand Down Expand Up @@ -260,6 +270,11 @@ Users can change the frequency bin number to 16384, using::
> setSection=[sect],*,*,*,*,*,16384

Where *sect* is the section number.
To select all sections of the backend, an asterisk can be used instead of
specifying the desired section::

> setSection=*,*,*,*,*,*,16384

Users can also change the integration time::

> integration=[N]
Expand Down

0 comments on commit 50f1ee7

Please sign in to comment.