MatchFakesConfig

class lsst.pipe.tasks.matchFakes.MatchFakesConfig(*args, **kw)

Bases: InsertFakesConfig

Config for MatchFakesTask.

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.

doMatchVisit

Match visit to trim the fakeCat (bool, default False)

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')

history

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.

matchDistanceArcseconds

Distance in arcseconds to match within.

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.

saveMetadata

Flag to enable/disable metadata saving 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.

Methods Summary

compare(other[, shortcut, rtol, atol, output])

Compare this configuration to another Config for equality.

formatHistory(name, **kwargs)

Format a configuration field's history to a human-readable format.

freeze()

Make this config, and all subconfigs, read-only.

items()

Get configurations as (field name, field value) pairs.

keys()

Get field names.

load(filename[, root])

Modify this config in place by executing the Python code in a configuration file.

loadFromStream(stream[, root, filename])

Modify this Config in place by executing the Python code in the provided stream.

loadFromString(code[, root, filename])

Modify this Config in place by executing the Python code in the provided string.

names()

Get all the field names in the config, recursively.

save(filename[, root])

Save a Python script to the named file, which, when loaded, reproduces this config.

saveToStream(outfile[, root, skipImports])

Save a configuration file to a stream, which, when loaded, reproduces this config.

saveToString([skipImports])

Return the Python script form of this configuration as an executable string.

setDefaults()

Subclass hook for computing defaults.

toDict()

Make a dictionary of field names and their values.

update(**kw)

Update values of fields specified by the keyword arguments.

validate()

Validate the Config, raising an exception if invalid.

values()

Get field values.

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)

doMatchVisit

Match visit to trim the fakeCat (bool, default False)

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

history

Read-only history.

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')

matchDistanceArcseconds

Distance in arcseconds to match within. (float, default 0.5)

Valid Range = [0,10)

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)

saveMetadata

Flag to enable/disable metadata saving 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 matches. (int, default 100)

Methods Documentation

compare(other, shortcut=True, rtol=1e-08, atol=1e-08, output=None)

Compare this configuration to another Config for equality.

Parameters:
otherlsst.pex.config.Config

Other Config object to compare against this config.

shortcutbool, optional

If True, return as soon as an inequality is found. Default is True.

rtolfloat, optional

Relative tolerance for floating point comparisons.

atolfloat, optional

Absolute tolerance for floating point comparisons.

outputcallable, optional

A callable that takes a string, used (possibly repeatedly) to report inequalities.

Returns:
isEqualbool

True when the two lsst.pex.config.Config instances are equal. False if there is an inequality.

Notes

Unselected targets of RegistryField fields and unselected choices of ConfigChoiceField fields are not considered by this method.

Floating point comparisons are performed by numpy.allclose.

formatHistory(name, **kwargs)

Format a configuration field’s history to a human-readable format.

Parameters:
namestr

Name of a Field in this config.

kwargs

Keyword arguments passed to lsst.pex.config.history.format.

Returns:
historystr

A string containing the formatted history.

freeze()

Make this config, and all subconfigs, read-only.

items()

Get configurations as (field name, field value) pairs.

Returns:
itemsdict_items

Iterator of tuples for each configuration. Tuple items are:

  1. Field name.

  2. Field value.

keys()

Get field names.

Returns:
namesdict_keys

List of lsst.pex.config.Field names.

See also

lsst.pex.config.Config.iterkeys
load(filename, root='config')

Modify this config in place by executing the Python code in a configuration file.

Parameters:
filenamestr

Name of the configuration file. A configuration file is Python module.

rootstr, optional

Name of the variable in file that refers to the config being overridden.

For example, the value of root is "config" and the file contains:

config.myField = 5

Then this config’s field myField is set to 5.

loadFromStream(stream, root='config', filename=None)

Modify this Config in place by executing the Python code in the provided stream.

Parameters:
streamfile-like object, str, bytes, or compiled string

Stream containing configuration override code. If this is a code object, it should be compiled with mode="exec".

rootstr, optional

Name of the variable in file that refers to the config being overridden.

For example, the value of root is "config" and the file contains:

config.myField = 5

Then this config’s field myField is set to 5.

filenamestr, optional

Name of the configuration file, or None if unknown or contained in the stream. Used for error reporting.

Notes

For backwards compatibility reasons, this method accepts strings, bytes and code objects as well as file-like objects. New code should use loadFromString instead for most of these types.

loadFromString(code, root='config', filename=None)

Modify this Config in place by executing the Python code in the provided string.

Parameters:
codestr, bytes, or compiled string

Stream containing configuration override code.

rootstr, optional

Name of the variable in file that refers to the config being overridden.

For example, the value of root is "config" and the file contains:

config.myField = 5

Then this config’s field myField is set to 5.

filenamestr, optional

Name of the configuration file, or None if unknown or contained in the stream. Used for error reporting.

names()

Get all the field names in the config, recursively.

Returns:
nameslist of str

Field names.

save(filename, root='config')

Save a Python script to the named file, which, when loaded, reproduces this config.

Parameters:
filenamestr

Desination filename of this configuration.

rootstr, optional

Name to use for the root config variable. The same value must be used when loading (see lsst.pex.config.Config.load).

saveToStream(outfile, root='config', skipImports=False)

Save a configuration file to a stream, which, when loaded, reproduces this config.

Parameters:
outfilefile-like object

Destination file object write the config into. Accepts strings not bytes.

root

Name to use for the root config variable. The same value must be used when loading (see lsst.pex.config.Config.load).

skipImportsbool, optional

If True then do not include import statements in output, this is to support human-oriented output from pipetask where additional clutter is not useful.

saveToString(skipImports=False)

Return the Python script form of this configuration as an executable string.

Parameters:
skipImportsbool, optional

If True then do not include import statements in output, this is to support human-oriented output from pipetask where additional clutter is not useful.

Returns:
codestr

A code string readable by loadFromString.

setDefaults()

Subclass hook for computing defaults.

Notes

Derived Config classes that must compute defaults rather than using the Field instances’s defaults should do so here. To correctly use inherited defaults, implementations of setDefaults must call their base class’s setDefaults.

toDict()

Make a dictionary of field names and their values.

Returns:
dict_dict

Dictionary with keys that are Field names. Values are Field values.

Notes

This method uses the toDict method of individual fields. Subclasses of Field may need to implement a toDict method for this method to work.

update(**kw)

Update values of fields specified by the keyword arguments.

Parameters:
kw

Keywords are configuration field names. Values are configuration field values.

Notes

The __at and __label keyword arguments are special internal keywords. They are used to strip out any internal steps from the history tracebacks of the config. Do not modify these keywords to subvert a Config instance’s history.

Examples

This is a config with three fields:

>>> from lsst.pex.config import Config, Field
>>> class DemoConfig(Config):
...     fieldA = Field(doc='Field A', dtype=int, default=42)
...     fieldB = Field(doc='Field B', dtype=bool, default=True)
...     fieldC = Field(doc='Field C', dtype=str, default='Hello world')
...
>>> config = DemoConfig()

These are the default values of each field:

>>> for name, value in config.iteritems():
...     print(f"{name}: {value}")
...
fieldA: 42
fieldB: True
fieldC: 'Hello world'

Using this method to update fieldA and fieldC:

>>> config.update(fieldA=13, fieldC='Updated!')

Now the values of each field are:

>>> for name, value in config.iteritems():
...     print(f"{name}: {value}")
...
fieldA: 13
fieldB: True
fieldC: 'Updated!'
validate()

Validate the Config, raising an exception if invalid.

Raises:
lsst.pex.config.FieldValidationError

Raised if verification fails.

Notes

The base class implementation performs type checks on all fields by calling their validate methods.

Complex single-field validation can be defined by deriving new Field types. For convenience, some derived lsst.pex.config.Field-types (ConfigField and ConfigChoiceField) are defined in lsst.pex.config that handle recursing into subconfigs.

Inter-field relationships should only be checked in derived Config classes after calling this method, and base validation is complete.

values()

Get field values.

Returns:
valuesdict_values

Iterator of field values.