Skip to content

Commit 6824dca

Browse files
committed
rebase me
1 parent 523a001 commit 6824dca

File tree

1 file changed

+20
-12
lines changed

1 file changed

+20
-12
lines changed

python/lsst/pipe/tasks/insertFakes.py

+20-12
Original file line numberDiff line numberDiff line change
@@ -371,6 +371,13 @@ class InsertFakesConfig(PipelineTaskConfig,
371371
default="disk_n",
372372
)
373373

374+
bulge_disk_flux_ratio_col = pexConfig.Field(
375+
doc="Source catalog column name for the bulge/disk flux ratio. See "
376+
"also: ``bulge_flux_fraction_col``.",
377+
dtype=str,
378+
default="bulge_disk_flux_ratio",
379+
)
380+
374381
mag_col = pexConfig.Field(
375382
doc="Source catalog column name template for magnitudes, in the format "
376383
"``filter name``_mag_col. E.g., if this config variable is set to "
@@ -382,7 +389,14 @@ class InsertFakesConfig(PipelineTaskConfig,
382389

383390
bulge_flux_fraction_col = pexConfig.Field(
384391
doc="Source catalog column name for fraction of flux in bulge "
385-
"component.",
392+
"component, in the format ``filter name``_bulge_flux_fraction. "
393+
"E.g., if this config variable is set to ``%s_bulge_flux_fraction,"
394+
"then the i-band bulge flux fraction will be search for in the "
395+
"``i_bulge_flux_fraction`` column of the source catalog. "
396+
"Note that if the source catalog contains both the config values "
397+
"for bulge_flux_fraction_col and bulge_disk_flux_ratio_col, then "
398+
"the fluxes will be determined from bulge_flux_fraction_col and "
399+
"the bulge_disk_flux_ratio_col column will be ignored.",
386400
dtype=str,
387401
default="%s_bulge_flux_fraction"
388402
)
@@ -408,13 +422,6 @@ class InsertFakesConfig(PipelineTaskConfig,
408422

409423
# Deprecated config variables
410424

411-
bulge_disk_flux_ratio_col = pexConfig.Field(
412-
doc="Source catalog column name for the bulge/disk flux ratio.",
413-
dtype=str,
414-
default="bulge_disk_flux_ratio",
415-
deprecated="Use `bulge_flux_fraction_col` instead."
416-
)
417-
418425
raColName = pexConfig.Field(
419426
doc="RA column name used in the fake source catalog.",
420427
dtype=str,
@@ -797,10 +804,11 @@ def add_to_replace_dict(new_name, depr_name, std_name):
797804
"axis ratio."
798805
)
799806

800-
# Populate bulge_flux_fraction using either new-style with string interpolation,
801-
# or old-style from b/d flux ratio. If neither are available, fall back to
802-
# deprecated behavior of bd flux ratio = 1.0, or equivalently,
803-
# bulge_flux_fraction=0.5
807+
# Standardize flux apportionment between bulge and disk using
808+
# `bulge_flux_fraction`. Prefer, in order:
809+
# - `bulge_flux_fraction_col`
810+
# - `bulge_disk_flux_ratio_col`
811+
# - bd_flux_ratio = 1.0, which is equivalent to bulge_flux_fraction=0.5
804812
if cfg.bulge_flux_fraction_col%band in fakeCat.columns:
805813
fakeCat = fakeCat.rename(
806814
columns={

0 commit comments

Comments
 (0)