vasca.vasca_pipe

Script that runs the VASCA pipeline.

Module Contents

Functions

set_pipe_dir	Creates the pipeline output directory and necessary parent directories.
set_logger	Setup logger. Gets configuration from global config variable set with get_config.
keep_base_field	Remove field data that is not needed for further analysis to save memory
run_field	Run analysis on a single field
run_field_docs	Run field-level analysis (docs-version)
run_cluster_fields	Helper function to do clustering for passed sources or detections. The main purpose is to only keep the needed tables, to save memory usage
run	Runs the VASCA pipeline
run_from_file	Run VASCA pipeline from a configuration file passed with the ArgumentParser

API

vasca.vasca_pipe.set_pipe_dir(vasca_cfg: dict) → pathlib.Path

Creates the pipeline output directory and necessary parent directories.

Returns:

Path object pointing to the pipeline directory

Return type:

Path

vasca.vasca_pipe.set_logger(vasca_cfg)

Setup logger. Gets configuration from global config variable set with get_config.

vasca_cfg: dict

Dictionary with the VASCA configuration, typically from a YAML file

None

vasca.vasca_pipe.keep_base_field(field)

Remove field data that is not needed for further analysis to save memory

field: vasca.field.BaseField

VASCA field

None

vasca.vasca_pipe.run_field(obs_nr, field_id, rg, vasca_cfg)

Run analysis on a single field

obs_nrint

Observation number in the config file.

field_idstr

Field ID of the field to run

rgvasca.region.Region

Region of the VASCA pipeline.

vasca_cfgdict

VASCA configuration

vasca.field.BaseField

Modified field with results

vasca.vasca_pipe.run_field_docs(obs_nr: int, field_id: str, rg: vasca.region.Region, vasca_cfg: dict) → vasca.field.BaseField | None

Run field-level analysis (docs-version)

Par obs_nr:

Observation list index

Par field_id:

Field ID

Par rg:

VASCA region object from where the fields are loaded

Par vasca_cfg:

Pipeline configuration

vasca.vasca_pipe.run_cluster_fields(meanshift_cfg, tt_fd_src, tt_fd_det=None, cluster_coadd=False)

Helper function to do clustering for passed sources or detections. The main purpose is to only keep the needed tables, to save memory usage

meanshift_cfg: dict

Mean shift parameters

tt_fd_src: astropy.table.Table

Table with sources

tt_fd_det: astropy.table.Table

Table with detections

cluster_coadd: bool

Clustering coadd sources?

vasca.tables.TableCollection

Table collection with calculated clusters

vasca.vasca_pipe.run(vasca_cfg)

Runs the VASCA pipeline

vasca_cfgdict

VASCA pipeline configuration dictionary

None

vasca.vasca_pipe.run_from_file()

Run VASCA pipeline from a configuration file passed with the ArgumentParser

None