BlendingToolKit API

Module contents

Toolkit for fast simulation and analysis of overlapping objects for LSSTDESC.

The code generates on the fly images of overlapping parametric galaxies, while providing a framework to test user defined detection/deblending/measurement algorithms.

Submodules

• btk.catalog module
  • Catalog
    • Catalog.__init__()
    • Catalog.from_file()
    • Catalog.get_raw_catalog()
    • Catalog.name
  • Catalog.self.table
  • CatsimCatalog
    • CatsimCatalog.from_file()
  • CosmosCatalog
    • CosmosCatalog.__init__()
    • CosmosCatalog.from_file()
    • CosmosCatalog.get_galsim_catalog()
• btk.sampling_functions module
  • BasicSampling
    • BasicSampling.__call__()
    • BasicSampling.__init__()
  • DefaultSampling
    • DefaultSampling.__call__()
    • DefaultSampling.__init__()
  • DefaultSamplingShear
    • DefaultSamplingShear.__call__()
    • DefaultSamplingShear.__init__()
  • DensitySampling
    • DensitySampling.__call__()
    • DensitySampling.__init__()
  • FriendsOfFriendsSampling
    • FriendsOfFriendsSampling.__call__()
    • FriendsOfFriendsSampling.__init__()
  • PairSampling
    • PairSampling.__call__()
    • PairSampling.__init__()
  • RandomSquareSampling
    • RandomSquareSampling.__call__()
    • RandomSquareSampling.__init__()
  • SamplingFunction
    • SamplingFunction.__call__()
    • SamplingFunction.__init__()
• btk.survey module
  • Filter
    • Filter.from_surveycodex_filter()
  • Survey
    • Survey.from_surveycodex_survey()
    • Survey.get_filter()
  • get_psf_from_file()
  • get_surveys()
  • make_wcs()
• btk.blend_generator module
  • BlendGenerator
    • BlendGenerator.__init__()
• btk.draw_blends module
  • CatsimGenerator
    • CatsimGenerator.compatible_catalogs
    • CatsimGenerator.render_single()
  • CosmosGenerator
    • CosmosGenerator.__init__()
    • CosmosGenerator.compatible_catalogs
    • CosmosGenerator.render_single()
  • DrawBlendsGenerator
    • DrawBlendsGenerator.__init__()
    • DrawBlendsGenerator.compatible_catalogs
    • DrawBlendsGenerator.render_blend()
    • DrawBlendsGenerator.render_single()
  • SourceNotVisible
  • get_catsim_galaxy()
  • render_single_catsim_galaxy()
• btk.deblend module
  • DeblendGenerator
    • DeblendGenerator.__init__()
  • Deblender
    • Deblender.__call__()
    • Deblender.__init__()
    • Deblender.batch_call()
    • Deblender.deblend()
  • MultiResolutionDeblender
    • MultiResolutionDeblender.__call__()
    • MultiResolutionDeblender.__init__()
    • MultiResolutionDeblender.batch_call()
    • MultiResolutionDeblender.deblend()
  • PeakLocalMax
    • PeakLocalMax.__init__()
    • PeakLocalMax.deblend()
  • Scarlet
    • Scarlet.__init__()
    • Scarlet.deblend()
  • SepMultiBand
    • SepMultiBand.__init__()
    • SepMultiBand.deblend()
  • SepSingleBand
    • SepSingleBand.__init__()
    • SepSingleBand.deblend()
• btk.metrics module
  • btk.metrics.reconstruction module
    • MSE
    • PSNR
    • ReconstructionMetric
    • StructSim
  • btk.metrics.detection module
    • DetectionMetric
    • Efficiency
      • Efficiency.aggregate()
    • F1
    • Precision
    • Recall
  • btk.metrics.segmentation module
    • IoU
    • SegmentationMetric