ztfimg reference documentation

ztfimg is a generic object-oriented API to enable to interact with Zwicky Transient Facility (ZTF) images. The dask cluster computing library is natively incorporated within the API such that one can use numpy or dask.array as smoothly as doing use_dask=True.

Objects

The ZTF camera (focalplane) is divided into 16 ccds themselves divided into 4 quadrants. ztfimg enables you to interact with the data at all levels and both for the raw data and the science images.

The data I/O is based on ztfquery. It is strongly recommended (but not mandatory) to have a running ztfquery environment.

Sharp start

from ztfimg import io
sciimg_path, maskimg_path = io.get_test_image() # load default images

import ztfimg
sci = ztfimg.ScienceQuadrant.from_filename(sciimg_path, maskimg_path)
data = sci.get_data(apply_mask=True) # see also e.g. rm_bkgd
fig = sci.show(data=data) # if data not provided, this will plot get_data()

Documentation

Getting Starting

• Quickstart: science data
• Dask in ztfimg
• Quadrant<->CCD<->FocalPlane
• Coordinate system and footprint
• Catalogs
• Aperture Photometry
• Source extraction (à la sextractor)
• Raw data: image alignment and overscan

API

• ztfimg package
  • Base
    • Image
      • Image.SHAPE
      • Image.from_filename()
      • Image.from_data()
      • Image.to_fits()
      • Image.set_header()
      • Image.set_data()
      • Image.get_data()
      • Image.get_header()
      • Image.get_value()
      • Image.get_aperture()
      • Image.show()
      • Image.use_dask
      • Image.data
      • Image.has_data()
      • Image.header
      • Image.shape
      • Image.filename
      • Image.filepath
      • Image.filtername
      • Image.exptime
      • Image.obsjd
      • Image.meta
    • Quadrant
      • Quadrant.SHAPE
      • Quadrant.get_ccd()
      • Quadrant.get_focalplane()
      • Quadrant.get_data()
      • Quadrant.get_catalog()
      • Quadrant.add_coord_to_catalog()
      • Quadrant.get_center()
      • Quadrant.get_corners()
      • Quadrant.compute()
      • Quadrant.persist()
      • Quadrant.qid
      • Quadrant.ccdid
      • Quadrant.rcid
    • CCD
      • CCD.SHAPE
      • CCD.from_single_filename()
      • CCD.from_quadrants()
      • CCD.from_filenames()
      • CCD.to_fits()
      • CCD.to_quadrant_fits()
      • CCD.load_data()
      • CCD.set_quadrant()
      • CCD.call_quadrants()
      • CCD.get_quadrant()
      • CCD.get_focalplane()
      • CCD.get_quadrantheader()
      • CCD.get_quadrantdata()
      • CCD.get_data()
      • CCD.get_catalog()
      • CCD.get_center()
      • CCD.get_corners()
      • CCD.add_coord_to_catalog()
      • CCD.show_footprint()
      • CCD.data
      • CCD.quadrants
      • CCD.has_quadrants()
      • CCD.qshape
      • CCD.ccdid
      • CCD.filenames
      • CCD.filepaths
    • FocalPlane
      • FocalPlane.from_filenames()
      • FocalPlane.from_single_filename()
      • FocalPlane.set_ccd()
      • FocalPlane.call_ccds()
      • FocalPlane.call_quadrants()
      • FocalPlane.get_ccd()
      • FocalPlane.get_quadrant()
      • FocalPlane.get_quadrantheader()
      • FocalPlane.get_data()
      • FocalPlane.show_footprint()
      • FocalPlane.ccds
      • FocalPlane.has_ccds()
      • FocalPlane.filenames
      • FocalPlane.filepaths
      • FocalPlane.shape_full
      • FocalPlane.shape
      • FocalPlane.ccdshape
      • FocalPlane.qshape
  • Raw
    • RawQuadrant
      • RawQuadrant.SHAPE_OVERSCAN
      • RawQuadrant.from_data()
      • RawQuadrant.from_filename()
      • RawQuadrant.from_filefracday()
      • RawQuadrant.read_rawfile_header()
      • RawQuadrant.set_overscan()
      • RawQuadrant.get_data_and_overscan()
      • RawQuadrant.get_data()
      • RawQuadrant.get_nonlinearity_corr()
      • RawQuadrant.get_overscan()
      • RawQuadrant.get_lastdata_firstoverscan()
      • RawQuadrant.get_sciimage()
      • RawQuadrant.show_overscan()
      • RawQuadrant.shape_overscan
      • RawQuadrant.overscan
      • RawQuadrant.qid
      • RawQuadrant.rcid
      • RawQuadrant.gain
      • RawQuadrant.darkcurrent
      • RawQuadrant.readnoise
    • RawCCD
      • RawCCD.from_filename()
      • RawCCD.from_single_filename()
      • RawCCD.from_filenames()
      • RawCCD.from_filefracday()
      • RawCCD.get_sciimage()
    • RawFocalPlane
      • RawFocalPlane.from_filenames()
      • RawFocalPlane.from_filefracday()
  • Science
    • ScienceQuadrant
      • ScienceQuadrant.from_filename()
      • ScienceQuadrant.load_wcs()
      • ScienceQuadrant.get_rawimage()
      • ScienceQuadrant.get_data()
      • ScienceQuadrant.get_source_mask()
      • ScienceQuadrant.get_aperture()
      • ScienceQuadrant.get_psfcat()
      • ScienceQuadrant.get_sexcat()
      • ScienceQuadrant.wcs
      • ScienceQuadrant.filtername
      • ScienceQuadrant.filterid
      • ScienceQuadrant.rcid
      • ScienceQuadrant.ccdid
      • ScienceQuadrant.qid
      • ScienceQuadrant.fieldid
      • ScienceQuadrant.filefracday
      • ScienceQuadrant.obsdate
    • ScienceCCD
      • ScienceCCD.meta
      • ScienceCCD.get_mask()
      • ScienceCCD.get_data()
      • ScienceCCD.radec_to_ij()
      • ScienceCCD.ij_to_radec()
      • ScienceCCD.ij_to_xy_qid()
    • ScienceFocalPlane
      • ScienceFocalPlane.get_files()
      • ScienceFocalPlane.meta
  • Collections
    • ImageCollection
      • ImageCollection.from_filenames()
      • ImageCollection.set_images()
      • ImageCollection.get_data()
      • ImageCollection.call_down()
      • ImageCollection.map_down()
      • ImageCollection.images
      • ImageCollection.use_dask
      • ImageCollection.nimages
  • Catalog
    • get_field_catalog()
    • download_vizier_catalog()
    • get_isolated()
    • match_and_merge()
  • I/O
    • get_test_image()
    • get_nonlinearity_table()
  • Module contents

Indices and tables

• Index

• Module Index

• Search Page