Metadata-Version: 2.3
Name: contsub
Version: 1.0.0
Summary: Radio astronomy data continuum subtraction tools
License: MIT
Author: Amir Kazemi-Moridani, Sphesihle Makhathini, Mika Naidoo
Requires-Python: >=3.10,<3.13
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: astropy (>=6.0.0,<7.0.0)
Requires-Dist: numpy (>=1.22.4,<2.0.0)
Requires-Dist: scipy (>=1.12.0,<2.0.0)
Requires-Dist: stimela (>=2.1.2,<3.0.0)
Requires-Dist: xarray-fits
Requires-Dist: zarr (>=2.18,<3.0)
Description-Content-Type: text/markdown

# contsub
Image-Plane continuum subtraction for FITS cubes

## Installation
```bash
pip install git+https://github.com/laduma-dev/contsub.git
```

## Documentation
```bash
Usage: imcontsub [OPTIONS] INPUT_IMAGE

Options:
  --version                       Show the version and exit.
  --order TEXT                    Order of spline. If given as a list of size
                                  N, then N iterations will be perfomed.
  --segments TEXT                 Width of spline segments in km/s. If given
                                  as a list, then it must have same sixe as
                                  --order.
  --output-prefix PATH            Name of ouput image
  --mask-image PATH               Mask image
  --sigma-clip TEXT               Sigma clip for each iteration. Only required
                                  if mask-image is not given.
  --fit-model [polyn|spline|dct]
  --overwrite / --no-overwrite    Overwrite output image if it already exists
  --stokes-axis / --no-stokes-axis
                                  Set this flag if the input image has a
                                  stokes dimension. (Default is True).
  --help                          Show this message and exit.

```

Specifiy the list options (`--order`, `sigma-clip`, etc.,) using square brackets. For example
```bash
imcontsub --order [3,3] --segments [400,350] --sigma-clip [5,5] --mask-image fornax_lw13-cube_mask.fits fornax_lw13-cube_data.fits
```

