LSST Applications 27.0.0,g0265f82a02+469cd937ee,g02d81e74bb+21ad69e7e1,g1470d8bcf6+cbe83ee85a,g2079a07aa2+e67c6346a6,g212a7c68fe+04a9158687,g2305ad1205+94392ce272,g295015adf3+81dd352a9d,g2bbee38e9b+469cd937ee,g337abbeb29+469cd937ee,g3939d97d7f+72a9f7b576,g487adcacf7+71499e7cba,g50ff169b8f+5929b3527e,g52b1c1532d+a6fc98d2e7,g591dd9f2cf+df404f777f,g5a732f18d5+be83d3ecdb,g64a986408d+21ad69e7e1,g858d7b2824+21ad69e7e1,g8a8a8dda67+a6fc98d2e7,g99cad8db69+f62e5b0af5,g9ddcbc5298+d4bad12328,ga1e77700b3+9c366c4306,ga8c6da7877+71e4819109,gb0e22166c9+25ba2f69a1,gb6a65358fc+469cd937ee,gbb8dafda3b+69d3c0e320,gc07e1c2157+a98bf949bb,gc120e1dc64+615ec43309,gc28159a63d+469cd937ee,gcf0d15dbbd+72a9f7b576,gdaeeff99f8+a38ce5ea23,ge6526c86ff+3a7c1ac5f1,ge79ae78c31+469cd937ee,gee10cc3b42+a6fc98d2e7,gf1cff7945b+21ad69e7e1,gfbcc870c63+9a11dc8c8f
LSST Data Management Base Package
Loading...
Searching...
No Matches
Classes | Functions | Variables
lsst.pipe.tasks.script.registerDcrSubfilters Namespace Reference

Classes

class  InsertResults
 

Functions

 registerDcrSubfilters (repo, num_subfilters, band_names)
 

Variables

 _log = logging.getLogger(__name__)
 
str registeredMsg = "Registered subfilters {subfilters} for filter band \"{band}\"."
 
str notRegisteredMsg
 

Function Documentation

◆ registerDcrSubfilters()

lsst.pipe.tasks.script.registerDcrSubfilters.registerDcrSubfilters ( repo,
num_subfilters,
band_names )
Construct a set of subfilters for chromatic modeling and add them to a
registry.

Parameters
----------
repo : `str`
    URI to the location to read the repo.
num_subfilters : `int`
    The number of subfilters to add.
band_names : `list` [`str`]
    The filter band names to add.

Returns
-------
insertResults : ``InsertResults``
    A class that contains the results of the subfilters that were inserted
    or already exist in each filter band, that has a __str__ method so it
    can be easily printed to the CLI output.

Definition at line 97 of file registerDcrSubfilters.py.

97def registerDcrSubfilters(repo, num_subfilters, band_names):
98 """Construct a set of subfilters for chromatic modeling and add them to a
99 registry.
100
101 Parameters
102 ----------
103 repo : `str`
104 URI to the location to read the repo.
105 num_subfilters : `int`
106 The number of subfilters to add.
107 band_names : `list` [`str`]
108 The filter band names to add.
109
110 Returns
111 -------
112 insertResults : ``InsertResults``
113 A class that contains the results of the subfilters that were inserted
114 or already exist in each filter band, that has a __str__ method so it
115 can be easily printed to the CLI output.
116 """
117 butler = Butler(repo, writeable=True)
118 results = InsertResults()
119 for filterName in band_names:
120 try:
121 with butler.registry.transaction():
122 for sub in range(num_subfilters):
123 butler.registry.insertDimensionData("subfilter", {"band": filterName, "subfilter": sub})
124 results.add(filterName, sub, True)
125 except IntegrityError:
126 records = butler.registry.queryDimensionRecords("subfilter", dataId={"band": filterName})
127 for record in records:
128 results.add(filterName, record.id, False)
129
130 return results

Variable Documentation

◆ _log

lsst.pipe.tasks.script.registerDcrSubfilters._log = logging.getLogger(__name__)
protected

Definition at line 30 of file registerDcrSubfilters.py.

◆ notRegisteredMsg

str lsst.pipe.tasks.script.registerDcrSubfilters.notRegisteredMsg
Initial value:
1= \
2 "Not registering subfilters for filter band \"{band}\"; subfilters {subfilters} already existed."

Definition at line 34 of file registerDcrSubfilters.py.

◆ registeredMsg

str lsst.pipe.tasks.script.registerDcrSubfilters.registeredMsg = "Registered subfilters {subfilters} for filter band \"{band}\"."

Definition at line 33 of file registerDcrSubfilters.py.