InsertFakesConfig

class lsst.pipe.tasks.insertFakes.InsertFakesConfig(*args, **kwargs)

Bases: PipelineTaskConfig

Config for inserting fake sources

Deprecated since version v28.0: This task will be removed in v28.0 as it is replaced by source_injection tasks.

Attributes Summary

aBulge	The column name for the semi major axis length of the bulge component.
aDisk	The column name for the semi major axis length of the disk component used in the fake sourcecatalog.
angle_col	Source catalog column name for trail angle (in radians).
bBulge	The column name for the semi minor axis length of the bulge component used in the fake source catalog.
bDisk	The column name for the semi minor axis length of the disk component.
bulgeHLR	Column name for the bulge half light radius used in the fake source catalog.
bulge_axis_ratio_col	Source catalog column name for the axis ratio of the bulge half-light ellipse.
bulge_disk_flux_ratio_col	Source catalog column name for the bulge/disk flux ratio.
bulge_n_col	Source catalog column name for the Sersic index of the bulge.
bulge_pa_col	Source catalog column name for the position angle (measured from North through East in degrees) of the semimajor axis of the bulge half-light ellipse.
bulge_semimajor_col	Source catalog column name for the semimajor axis (in arcseconds) of the bulge half-light ellipse.
calibFluxRadius	Aperture radius (in pixels) that was used to define the calibration for this image+catalog.
coaddName	The name of the type of coadd used (str, default 'deep')
connections	Field which refers to a dynamically added configuration class which is based on a PipelineTaskConnections class.
decColName	Dec.
dec_col	Source catalog column name for dec (in radians).
diskHLR	Column name for the disk half light radius used in the fake source catalog.
disk_axis_ratio_col	Source catalog column name for the axis ratio of the disk half-light ellipse.
disk_n_col	Source catalog column name for the Sersic index of the disk.
disk_pa_col	Source catalog column name for the position angle (measured from North through East in degrees) of the semimajor axis of the disk half-light ellipse.
disk_semimajor_col	Source catalog column name for the semimajor axis (in arcseconds) of the disk half-light ellipse.
doCleanCat	If true removes bad sources from the catalog.
doProcessAllDataIds	If True, all input data IDs will be processed, even those containing no fake sources.
doSubSelectSources	Set to True if you wish to sub select sources to be input based on the value in the columnset in the sourceSelectionColName config option.
fakeType	What type of fake catalog to use, snapshot (includes variability in the magnitudes calculated from the MJD of the image), static (no variability) or filename for a user defined fitscatalog.
fits_alignment	How should injections from FITS files be aligned? (str, default 'pixel')
insertImages	Insert images directly? True or False.
insertOnlyStars	Insert only stars? True or False.
length_col	Source catalog column name for trail length (in pixels).
magVar	The column name for the magnitude calculated taking variability into account.
mag_col	Source catalog column name template for magnitudes, in the format ``filter name``_mag_col.
nBulge	The column name for the sersic index of the bulge component used in the fake source catalog.
nDisk	The column name for the sersic index of the disk component used in the fake source catalog.
paBulge	The column name for the PA of the bulge component used in the fake source catalog.
paDisk	The column name for the PA of the disk component used in the fake source catalog.
raColName	RA column name used in the fake source catalog.
ra_col	Source catalog column name for RA (in radians).
saveLogOutput	Flag to enable/disable saving of log output for a task, enabled by default.
select_col	Source catalog column name to be used to select which sources to add.
sourceSelectionColName	The name of the column in the input fakes catalogue to be used to determine which sources toadd, default is none and when this is used all sources are added.
sourceType	The column name for the source type used in the fake source catalog.
trimBuffer	Size of the pixel buffer surrounding the image.

Attributes Documentation

aBulge

The column name for the semi major axis length of the bulge component. Deprecated: Use bulge_semimajor_col, bulge_axis_ratio_col, and bulge_pa_col to specify disk half-light ellipse. (str, default 'a_b')

aDisk

The column name for the semi major axis length of the disk component used in the fake sourcecatalog. Deprecated: Use disk_semimajor_col, disk_axis_ratio_col, and disk_pa_col to specify disk half-light ellipse. (str, default 'a_d')

angle_col

Source catalog column name for trail angle (in radians). (str, default 'trail_angle')

bBulge

The column name for the semi minor axis length of the bulge component used in the fake source catalog. Deprecated: Use bulge_semimajor_col, bulge_axis_ratio_col, and bulge_pa_col to specify disk half-light ellipse. (str, default 'b_b')

bDisk

The column name for the semi minor axis length of the disk component. Deprecated: Use disk_semimajor_col, disk_axis_ratio_col, and disk_pa_col to specify disk half-light ellipse. (str, default 'b_d')

bulgeHLR

Column name for the bulge half light radius used in the fake source catalog. Deprecated: Use bulge_semimajor_col, bulge_axis_ratio_col, and bulge_pa_col to specify disk half-light ellipse. (str, default 'BulgeHalfLightRadius')

bulge_axis_ratio_col

Source catalog column name for the axis ratio of the bulge half-light ellipse. (str, default 'bulge_axis_ratio')

bulge_disk_flux_ratio_col

Source catalog column name for the bulge/disk flux ratio. (str, default 'bulge_disk_flux_ratio')

bulge_n_col

Source catalog column name for the Sersic index of the bulge. (str, default 'bulge_n')

bulge_pa_col

Source catalog column name for the position angle (measured from North through East in degrees) of the semimajor axis of the bulge half-light ellipse. (str, default 'bulge_pa')

bulge_semimajor_col

Source catalog column name for the semimajor axis (in arcseconds) of the bulge half-light ellipse. (str, default 'bulge_semimajor')

calibFluxRadius

Aperture radius (in pixels) that was used to define the calibration for this image+catalog. This will be used to produce the correct instrumental fluxes within the radius. This value should match that of the field defined in slot_CalibFlux_instFlux. (float, default 12.0)

coaddName

The name of the type of coadd used (str, default 'deep')

connections: pexConfig.ConfigField

Field which refers to a dynamically added configuration class which is based on a PipelineTaskConnections class.

decColName

Dec. column name used in the fake source catalog. Deprecated: Use dec_col instead. (str, default 'decJ2000')

dec_col

Source catalog column name for dec (in radians). (str, default 'dec')

diskHLR

Column name for the disk half light radius used in the fake source catalog. Deprecated: Use disk_semimajor_col, disk_axis_ratio_col, and disk_pa_col to specify disk half-light ellipse. (str, default 'DiskHalfLightRadius')

disk_axis_ratio_col

Source catalog column name for the axis ratio of the disk half-light ellipse. (str, default 'disk_axis_ratio')

disk_n_col

Source catalog column name for the Sersic index of the disk. (str, default 'disk_n')

disk_pa_col

Source catalog column name for the position angle (measured from North through East in degrees) of the semimajor axis of the disk half-light ellipse. (str, default 'disk_pa')

disk_semimajor_col

Source catalog column name for the semimajor axis (in arcseconds) of the disk half-light ellipse. (str, default 'disk_semimajor')

doCleanCat

If true removes bad sources from the catalog. (bool, default True)

doProcessAllDataIds

If True, all input data IDs will be processed, even those containing no fake sources. (bool, default False)

doSubSelectSources

Set to True if you wish to sub select sources to be input based on the value in the columnset in the sourceSelectionColName config option. (bool, default False)

fakeType

What type of fake catalog to use, snapshot (includes variability in the magnitudes calculated from the MJD of the image), static (no variability) or filename for a user defined fitscatalog. (str, default 'static')

fits_alignment

How should injections from FITS files be aligned? (str, default 'pixel')

Allowed values:

'wcs'

Input image will be transformed such that the local WCS in the FITS header matches the local WCS in the target image. I.e., North, East, and angular distances in the input image will match North, East, and angular distances in the target image.

'pixel'

Input image will _not_ be transformed. Up, right, and pixel distances in the input image will match up, right and pixel distances in the target image.

'None'

Field is optional

insertImages

Insert images directly? True or False. (bool, default False)

insertOnlyStars

Insert only stars? True or False. (bool, default False)

length_col

Source catalog column name for trail length (in pixels). (str, default 'trail_length')

magVar

The column name for the magnitude calculated taking variability into account. In the format filter name``magVar, e.g. imagVar for the magnitude in the i band. Deprecated: Use `mag_col` instead. (`str`, default ``'%smagVar')

mag_col

Source catalog column name template for magnitudes, in the format filter name``_mag_col.  E.g., if this config variable is set to ``%s_mag, then the i-band magnitude will be searched for in the i_mag column of the source catalog. (str, default '%s_mag')

nBulge

The column name for the sersic index of the bulge component used in the fake source catalog. Deprecated: Use bulge_n_col instead. (str, default 'bulge_n')

nDisk

The column name for the sersic index of the disk component used in the fake source catalog. Deprecated: Use disk_n_col instead. (str, default 'disk_n')

paBulge

The column name for the PA of the bulge component used in the fake source catalog. Deprecated: Use bulge_semimajor_col, bulge_axis_ratio_col, and bulge_pa_col to specify disk half-light ellipse. (str, default 'pa_bulge')

paDisk

The column name for the PA of the disk component used in the fake source catalog. Deprecated: Use disk_semimajor_col, disk_axis_ratio_col, and disk_pa_col to specify disk half-light ellipse. (str, default 'pa_disk')

raColName

RA column name used in the fake source catalog. Deprecated: Use ra_col instead. (str, default 'raJ2000')

ra_col

Source catalog column name for RA (in radians). (str, default 'ra')

saveLogOutput

Flag to enable/disable saving of log output for a task, enabled by default. (bool, default True)

select_col

Source catalog column name to be used to select which sources to add. (str, default 'select')

sourceSelectionColName

The name of the column in the input fakes catalogue to be used to determine which sources toadd, default is none and when this is used all sources are added. Deprecated: Use select_col instead. (str, default 'templateSource')

sourceType

The column name for the source type used in the fake source catalog. (str, default 'sourceType')

trimBuffer

Size of the pixel buffer surrounding the image. Only those fake sources with a centroidfalling within the image+buffer region will be considered for fake source injection. (int, default 100)