Skip to content

Make galaxy cubes (X, Y, Lambda) with S-PLUS data.

License

Notifications You must be signed in to change notification settings

splus-collab/s-cubes

 
 

Repository files navigation

S-Cubes

S-Cubes version Docs build deployment License S-Cubes website

S-Cubes is a python package designed to make galaxy cubes (X, Y, Lambda) with S-PLUS data. The S-Cubes repository includes the scubes python package which allows the users to create their own codes. It also includes the data files to calibrate stamps with iDR4 zero-points correction and SExtractor to identify stars along the stamp (optionally).

Online Documentation: https://splus-collab.github.io/s-cubes/

Requirements

  • Python 3.8
  • SExtractor installed either locally or system-wide
  • An user account at S-PLUS Cloud in order to access the necessary data.

Installation

Clone the project:

git clone https://github.com/splus-collab/s-cubes.git

(optional) Create and activate a virtual enviroment for the package instalation and usage:

python3 -m venv .venv
source .venv/bin/activate

Install S-Cubes:

pip install .

Entry-point scripts

This package includes various entry-point command-line scripts for different tasks. They are: scubes, scubesml, get_lupton_RGB, sex_mask_stars, sex_mask_stars_cube, mltoheader and scubes_filters. In order to obtain a detailed description and the script usage run them with –help argument.

scubes Running example

This example will create a 500x500 pixels cube with the 12-bands images from S-PLUS TILE HYDRA-0045 for the NGC3312 galaxy. The fluxes and errors are calculated based on the calibration of the zero points of S-PLUS iDR4 (data package included), but they are not corrected for Galactic extinction.

The stamps are made centered at coordinates RA 10h37m02.5s and DEC -27d33’56". The input values of RA and DEC will be converted to degrees using the :meth:`scubes.utilities.io.convert_coord_to_degrees`. It accepts hourangle (using hms divisors, ex: 10h37m2.5s) and degrees (using : or dms divisords, ex: 10:37:2.5 or 10d37m2.5s). Note that 10h37m2.5s (159.26 deg) is a totally different angle from 10:37:2.5 (10.62 deg).

The resultant files will be created at directory workdir.

The program also uses SExtractor in order to create a spatial mask of stars, attempting to remove the areas enclosed by the brightest ones along the FOV (-M optional argument). Do not forget to include the SExtractor executable path using the option -x.

The call to the entry-point script scubes to this example would be:

scubes -I -M -F --w workdir -l 500 -x /usr/bin/source-extractor -- HYDRA-0045 10h37m02.5s -27d33\'56\" NGC3312

License

This code is distributed under the GNU GENERAL PUBLIC LICENSE v3.0. Please refer to the LICENSE.txt file in the repository for more details.

About

Make galaxy cubes (X, Y, Lambda) with S-PLUS data.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 99.3%
  • Shell 0.7%