convolve-rs 1.1.2

Rust port of beamcon from RACS-tools: smooth FITS images and cubes to a common beam via UV-plane (FFT) convolution
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65

# CLI usage

The `convolvers` binary is the command-line interface, a port of `beamcon_2D`
and `beamcon_3D` from
[RACS-tools](https://github.com/alecthomson/RACS-tools). Install it with:

```sh
cargo install convolve-rs
```

```{note}
The help text on this page is generated by running the binary at docs build
time, so it always matches the documented version.
```

```{command-output} cargo run -q --bin convolvers -- --help
:cwd: ..
```

## Common workflows

Smooth a set of images to their common beam:

```sh
convolvers 2d *.fits
```

Smooth to an explicit target beam (all three of `--bmaj`, `--bmin`, `--bpa`
required):

```sh
convolvers 2d --bmaj 20 --bmin 20 --bpa 0 image.fits
```

Report the common beam without writing anything:

```sh
convolvers 2d --dryrun *.fits
```

Smooth cubes channel-by-channel (`natural`, the default) or to one beam across
all channels and cubes (`total`):

```sh
convolvers 3d --mode total cube1.fits cube2.fits
```

## `convolvers 2d`

```{command-output} cargo run -q --bin convolvers -- 2d --help
:cwd: ..
```

## `convolvers 3d`

```{command-output} cargo run -q --bin convolvers -- 3d -h
:cwd: ..
```

Per-channel beams are read from, in priority order:

1. CASA `BEAMS` binary-table extension (`CASAMBM=T` in the header)
2. A co-located beamlog text file: `{dir}/beamlog.{stem}.txt`
3. Single `BMAJ`/`BMIN`/`BPA` from the primary header (broadcast to all
   channels)