Skip to content

Latest commit

 

History

History
65 lines (55 loc) · 2.92 KB

README.md

File metadata and controls

65 lines (55 loc) · 2.92 KB


Cutting pixelized sky masks in a pipeline way


Skykatana is a pacakge to create and maniputate boolean spatial masks on the celestial sphere, by combining healsparse pixel maps accounting for various effects such as cutting out regions around bright stars, low depth, bad seeing, extended sources, among others. We call these partial maps stages, which are then combined into a final mask.

For each stage you can generate random points, quickly visualize masks, do plots overlaying bright stars, and apply the mask to an arbitrary catalog to select sources located inside.

Although mainly designed to work with the HSC-SSP survey, it is flexible to accomodate other surveys such as the upcoming half-sky dataset of the Vera Rubin Observatory.

Main Class

  • SkyMaskPipe() Main class for assembling and handling pixelized masks

Main Methods

  • build_footprint_mask(), build_patch_mask(), build_holes_mask(), etc --> Generate maps for each stage
  • combine_mask() --> Merge the maps created above to generate a final mask
  • plot() --> Visualize a mask stage by plotting randoms. Options to zoom, oveplot stars, etc.
  • plot2compare() --> Compare input sources on the left and a mask stage on the right
  • makerans() --> Generate randoms over a mask stage
  • apply() --> Cut out sources outside of a given mask stage

Dependencies

Install

There are two ways to get skykatana:

  1. pip install skykatana
  2. Clone the repo, switch to the pacakge directory and do pip install . . This has the advantage that you will get the latest version and all the files in /example_data (~210 MB)

Documentation

  • A quick introductory notebook is availables here
  • An indepth tutorial notebook can be found here
  • The full documentation is available here

Credits

Acknowledgements

This software was partially developed with the generous support of the LINCC Frameworks Incubator Program using LINCC resources. The healsparse code was written by Eli Rykoff and Javier Sanchez