survey.ztf

survey.ztf#

This module defines the ZTF survey class, including ZTF field geometry at different levels (quadrant, CCD, field) and tools to the load observing logs.

class skysurvey.survey.ztf.ZTF(data=None, level='quadrant', **kwargs)[source]#

Bases: GridSurvey

A class to model the ZTF survey.

Parameters:

  • data (pandas.DataFrame) – observing data.

  • level (str) – level of the ZTF fields (quadrant, ccd, field).

  • GridSurvey.__init__ (**kwargs goes to)

classmethod from_logs(**kwargs)[source]#

Load the ZTF survey from the logs.

Parameters:

**kwargs – goes to from_pointings

Return type:

ZTF

classmethod from_pointings(data, level='quadrant')[source]#

Load the ZTF survey from pointings.

Parameters:

  • data (pandas.DataFrame or dict) – observing data, must contain the rakey and deckey columns.

  • level (str) – level of the ZTF fields (quadrant, ccd, field).

Return type:

ZTF

get_skyarea(observed=True, buffer=0.5)[source]#

Compute the total sky area covered by the survey fields.

Parameters:

  • observed (bool, optional) – If True, only fields present in the observation log are included. If False, the area is calculated using all fields defined in the survey. Default is True.

  • buffer (float, optional) – Size of the padding (in degrees) to apply around the combined geometry. This helps smooth overlaps and fill small gaps between neighboring fields. Default is 0.5.

Returns:

A shapely geometry (Polygon or MultiPolygon) representing the combined sky coverage.

Return type:

shapely.geometry.base.BaseGeometry

show_ztf(data=None, fieldstat=None, **kwargs)[source]#

Show the sky coverage.

Parameters:

  • data (pandas.DataFrame, optional) – Data to be considered to get the field statistics. fieldstat will be derived from that (main grid only) groupby(fieldid).size(). Ignored is fieldstat is given.

  • fieldstat (pandas.Series, optional) – Field statistics.

  • **kwargs – Goes to ztffields.skyplot_fields.

Return type:

matplotlib.figure