galplane_priority_map¶
- rubin_sim.maf.maps.galplane_priority_map(nside=64, get_keys=False, ra=None, dec=None, pixels=None, interp=False, map_path=None, use_alt_maps=False)¶
Reads and saves the galactic plane priority maps.
- Parameters:
- nside: `int`
Healpixel resolution (2^x). At present, this must be 64.
- get_keys
bool
, opt Set this to True to retrieve only the keys (such as the science map names) for the maps. Default False.
- ra
np.ndarray
orfloat
, opt RA (can take numpy array). Default None sets up healpix array of nside. Radians.
- dec
np.ndarray
orfloat
, opt Dec (can take numpy array). Default None set up healpix array of nside. Radians.
- pixels
np.ndarray
, opt Healpixel IDs, to sub-select particular healpix points. Default uses all points. Easiest way to access healpix values. Note that the pixels in the healpix array MUST come from a healpix grid with the same nside as the galactic plane priority map. Using different nsides can potentially fail silently.
- interp
bool
, opt Should returned values be interpolated (True) or just nearest neighbor (False). Default False.
- map_path
str
, opt Path to directory containing dust map files. Default None, uses $RUBIN_SIM_DATA_DIR/maps.
- use_alt_maps
bool
, opt Use the priority_GalPlane_footprint_alt_map_data_{ugrizysum}.fits files instead of the default priority_galPlane_footprint_map_data_{ugrizysum}.fits files. Default False.