Skip to content

Commit 48d0207

Browse files
author
Menno Prinzhorn
committed
fixed some buggs
1 parent 5189fe1 commit 48d0207

File tree

2 files changed

+18
-18
lines changed

2 files changed

+18
-18
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,9 @@ Creating a free and open source framework that contains the generic algorithms a
5050
4. [Filter individual channels](docs/clipping.md#64-filter-individual-channels)
5151
7. [Dedispersion](docs/dedispersion.md)
5252
1. [Dedisperse](docs/dedispersion.md#72-Dedisperse)
53-
2. [find_dm](docs/dedispersion.md#73-find_dm)
54-
3. [find_line](docs/dedispersion.md#74-find_line)
55-
4. [find_estimation_intensity](docs/dedispersion.md#75-find_estimation_intensity)
53+
2. [Find dispersion measure](docs/dedispersion.md#73-find_dm)
54+
3. [Find line](docs/dedispersion.md#74-find_line)
55+
4. [Find estimation intensity](docs/dedispersion.md#75-find_estimation_intensity)
5656
8. [Pipeline](docs/pipeline.md)
5757
1. [Introduction](docs/pipeline.md#71-introduction)
5858
2. [Read rows](docs/pipeline.md#72-read-rows)

docs/dedispersion.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,24 @@
44

55
- Pulsars produce a narrow beam of electromagnetic
66
radiation which rotates like a lighthouse beam, so
7-
a pulse is seen as it sweeps over a radiotelescope
7+
a pulse is seen as it sweeps over a radiotelescope.
88
The signal is spread over a wide frequency range.
99

1010
- If space was an empty vacuum, all the signals would
1111
travel at the same speed, but due to free electrons
1212
different frequencies travel at slightly different speeds
13-
(dispersion)
13+
(dispersion).
1414

1515
## 7.2 Dedisperse
1616

17-
This method performs dedispersion on the filterbank data
17+
This method performs dedispersion on the filterbank data.
1818

1919
### 7.2.1 Parameters
2020

2121
| Parameters | Description |
2222
|---|---|
23-
| Samples | 1-D array or sequence. Array or sequence containing the data to be plotted. |
24-
| DM | Dispersion measure (cm<sup>^3</sup> pc) |
23+
| Samples | Array or sequence containing the data to be plotted. |
24+
| DM | Dispersion measure (cm<sup>-3</sup> pc) |
2525

2626
### 7.2.2 Returns
2727

@@ -31,7 +31,7 @@ This method performs dedispersion on the filterbank data
3131

3232
## 7.3 find_dm
3333

34-
This method finds the dispersion measure
34+
This method finds the dispersion measure.
3535

3636
### 7.3.1 Parameters
3737

@@ -47,34 +47,34 @@ This method finds the dispersion measure
4747

4848
## 7.4 find_line
4949

50-
This method finds a line starting from the sample index given in the parameters. This will stop if there isn't a intensity within the max_delay higher than the average_intensity
50+
This method finds a line starting from the sample index given in the parameters. This will stop if there isn't a intensity within the max_delay higher than the average_intensity.
5151

5252
### 7.4.1 Parameters
5353

5454
| Parameters | Description |
5555
|---|---|
5656
| Samples | 1-D array or sequence. Array or sequence containing the data to be plotted. |
5757
| start_sample_index | The start sample index |
58-
| max_delay | The max delay |
59-
| average_intensity | The avarge intensity |
58+
| max_delay | The max delay of the recieved signal |
59+
| average_intensity | The average intensity |
6060

6161
### 7.4.2 Returns
6262

6363
| Variable | Description |
6464
|---|---|
65-
| start_sample_index | The first frequentie |
66-
| previous_sample_index | the higher frequentie |
65+
| start_sample_index | The first frequency |
66+
| previous_sample_index | The higher frequency |
6767

68-
### 7.5 find_estimation_intensity
68+
## 7.5 find_estimation_intensity
6969

70-
This method finds the average intensity for top x intensities
71-
The average_intensity is considered a requirement for intensities to be considered a pulsar
70+
This method finds the average intensity for top x intensities.
71+
The `average_intensity` is considered a requirement for intensities to be considered a pulsar.
7272

7373
### 7.5.1 Parameters
7474

7575
| Parameters | Description |
7676
|---|---|
77-
| Samples | 1-D array or sequence. Array or sequence containing the data to be plotted. |
77+
| Samples | Array or sequence containing the data to be plotted. |
7878

7979
### 7.5.2 Returns
8080

0 commit comments

Comments
 (0)