HPMCM: Heirarchical Pixel Multi-Catalog Matcher

Description

HPMCM does multi-catalog cross matching by clustering sources from individual catalogs using a heirarchical pixelization scheme.

Getting Started

• Overview
• Installation
  • Production Installation
  • Developer Installation
  • Adding your kernel to jupyter

Contributing

• Contribution Overview
  • Contributing to HPMCM
  • Where to contribute:
  • Contribution workflow

Demonstrations

• Example Notebooks
  • Checking input data
  • Matching catalogs using a specified WCS
  • Matching shear catalogs
  • Shear calibration

Command line interface

• hpmcm CLI
  • Matching using global WCS
  • Matching using cell-based coadd frame
  • Splitting input catalogs for shear matching
  • Making shear calibration reports
  • Merging shear calibration reports

API

• hpmcm package
  • Matchers
    • hpmcm.match module
    • hpmcm.shear_match module
    • hpmcm.wcs_match module
  • Input/Output Table Formats
    • hpmcm.input_tables module
    • hpmcm.output_tables module
    • hpmcm.table module
  • Internal Data Structures
    • hpmcm.cell module
    • hpmcm.cluster module
    • hpmcm.object module
    • hpmcm.shear_data module
    • hpmcm.footprint module
  • Utility Functions
    • hpmcm.classify module
    • hpmcm.match_utils module
    • hpmcm.package_utils module
    • hpmcm.shear_utils module
    • hpmcm.utils module
    • hpmcm.viz_utils module