BaseSpatialSlicer

class rubin_sim.maf.slicers.BaseSpatialSlicer(lon_col='fieldRA', lat_col='fieldDec', rot_sky_pos_col_name='rotSkyPos', lat_lon_deg=True, verbose=True, badval=-666, leafsize=100, radius=2.45, use_camera=True, camera_footprint_file=None)

Bases: BaseSlicer

Base spatial slicer object, contains additional functionality for spatial slicing, including setting up and traversing a kdtree containing the simulated data points.

Parameters:
lon_colstr, optional

Name of the longitude (RA equivalent) column to use from the input data. Default fieldRA

lat_colstr, optional

Name of the latitude (Dec equivalent) column to use from the input data. Default fieldDec

rot_sky_pos_col_namestr, optional

Name of the rotSkyPos column in the input data. Only used if use_camera is True. Describes the orientation of the camera orientation compared to the sky. Default rotSkyPos.

lat_lon_degbool, optional

Flag indicating whether lat and lon values from input data are in degrees (True) or radians (False). Default True.

verbosebool, optional

Flag to indicate whether or not to write additional information to stdout during runtime. Default True.

badvalfloat, optional

Bad value flag, relevant for plotting. Default -666.

leafsizeint, optional

Leafsize value for kdtree. Default 100.

radiusfloat, optional

Radius for matching in the kdtree. Equivalent to the radius of the FOV. Degrees. Default 1.75.

use_camerabool, optional

Flag to indicate whether to use the LSST camera footprint or not. Default True.

camera_footprint_filestr, optional

Name of the camera footprint map to use. Can be None, which will use the default.

Methods Summary

setup_slicer(sim_data[, maps])

Use sim_data[self.lon_col] and sim_data[self.lat_col] (in radians) to set up KDTree.

Methods Documentation

setup_slicer(sim_data, maps=None)

Use sim_data[self.lon_col] and sim_data[self.lat_col] (in radians) to set up KDTree.

Parameters:
sim_datanumpy.ndarray

The simulated data, including the location of each pointing.

mapslist of rubin_sim.maf.maps objects, optional

List of maps (such as dust extinction) that will run to build up additional metadata at each slice_point. This additional metadata is available to metrics via the slice_point dictionary. Default None.