QuantifySubtraction

Quantify in various ways how good star subtraction

Space Telescope Science Institute

Synopsis

Quantify in various ways how good star subtraction is between two images, in which star fluxes have been calculated using MefPhot

usage: QuantifySubtraction.py orig_file subtracted_file [more pairs...]

Primary routines:

doit - Process a single pair of files do_many - Process multiple pairs and create comparison table

doit - Process a single pair of files: do_many - Process multiple pairs and create comparison table

History:

251229 ksl Coding begun 251229 ksl Refactored for modularity and result capture

`calculate_metrics`(orig, subtracted)	Calculate all subtraction quality metrics
`create_combined_figure`(orig, subtracted, outroot)	Create a single combined figure with all analysis types
`do_many`(file_pairs[, output_table])	Process multiple file pairs and create comparison table
`doit`(orig_phot, subtracted_phot[, outroot, combined])	Analyze subtraction quality for a single pair of files
`get_pairs`([xdir, prefix])
`steer`(argv)	Steering routine for command line usage

QuantifySubtraction.calculate_metrics(orig, subtracted)

Calculate all subtraction quality metrics

Returns a dictionary with summary statistics

QuantifySubtraction.create_combined_figure(orig, subtracted, outroot): Create a single combined figure with all analysis types

QuantifySubtraction.do_many(file_pairs, output_table='SubQual/comparison_metrics.fits')

Process multiple file pairs and create comparison table

QuantifySubtraction.doit(orig_phot, subtracted_phot, outroot='', combined=True)

Analyze subtraction quality for a single pair of files

orig_photstr: Path to original photometry table
subtracted_photstr: Path to subtracted photometry table
outrootstr: Root name for output files (derived from subtracted_phot if empty)
combinedbool: If True, create a single combined figure