Skip to content

Commit 07a0009

Browse files
Gabor Kovacsmrawls
Gabor Kovacs
authored andcommitted
Manual documentation and __all__ updates following rebase to master.
See ticket comment on details. Minor style corrections.
1 parent 9c23429 commit 07a0009

17 files changed

+30
-34
lines changed

python/lsst/pipe/tasks/colorterms.py

+4-2
Original file line numberDiff line numberDiff line change
@@ -158,8 +158,10 @@ class ColortermLibrary(Config):
158158
...
159159
}),
160160
"sdss": ColortermDict(data={
161-
'g': Colorterm(primary="g", secondary="r", c0=-0.00816446, c1=-0.08366937, c2=-0.00726883),
162-
'r': Colorterm(primary="r", secondary="i", c0= 0.00231810, c1= 0.01284177, c2=-0.03068248),
161+
'g': Colorterm(primary="g", secondary="r", c0=-0.00816446, c1=-0.08366937,
162+
c2=-0.00726883),
163+
'r': Colorterm(primary="r", secondary="i", c0= 0.00231810, c1= 0.01284177,
164+
c2=-0.03068248),
163165
...
164166
}),
165167
})

python/lsst/pipe/tasks/imageDifference.py

+4-2
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,9 @@
4646
FwhmPerSigma = 2 * math.sqrt(2 * math.log(2))
4747
IqrToSigma = 0.741
4848

49-
__all__ = ('ImageDifferenceConfig', 'ImageDifferenceTaskRunner',
50-
'Winter2013ImageDifferenceConfig', 'Winter2013ImageDifferenceTask')
49+
__all__ = ['ImageDifferenceConfig', 'ImageDifferenceTaskRunner',
50+
'Winter2013ImageDifferenceConfig', 'Winter2013ImageDifferenceTask']
51+
5152

5253
class ImageDifferenceConfig(pexConfig.Config):
5354
"""Config for ImageDifferenceTask
@@ -872,6 +873,7 @@ def setDefaults(self):
872873
ImageDifferenceConfig.setDefaults(self)
873874
self.getTemplate.retarget(GetCalexpAsTemplateTask)
874875

876+
875877
class Winter2013ImageDifferenceTask(ImageDifferenceTask):
876878
"""Image difference Task used in the Winter 2013 data challege.
877879
Enables testing the effects of registration shifts and scatter.

python/lsst/pipe/tasks/ingest.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@
1212
from lsst.pipe.base import Task, InputOnlyArgumentParser
1313
from lsst.afw.fits import DEFAULT_HDU
1414

15-
__all__ = ('IngestArgumentParser', 'ParseConfig', 'ParseConfig', 'ParseTask', 'RegisterConfig',
16-
'RegistryContext', 'RegisterTask', 'IngestConfig', 'IngestTask')
15+
__all__ = ['IngestArgumentParser', 'ParseConfig', 'ParseConfig', 'ParseTask', 'RegisterConfig',
16+
'RegistryContext', 'RegisterTask', 'IngestConfig', 'IngestTask']
1717

1818

1919
class IngestArgumentParser(InputOnlyArgumentParser):

python/lsst/pipe/tasks/ingestPgsql.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
except ImportError:
1111
havePgSql = False
1212

13-
__all__ = ('PgsqlRegistryContext', 'PgsqlRegisterTask', 'PgsqlIngestConfig', 'PgsqlIngestTask')
13+
__all__ = ['PgsqlRegistryContext', 'PgsqlRegisterTask', 'PgsqlIngestConfig', 'PgsqlIngestTask']
1414

1515

1616
class PgsqlRegistryContext(RegistryContext):

python/lsst/pipe/tasks/makeDiscreteSkyMap.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
from lsst.skymap import DiscreteSkyMap, BaseSkyMap
3131
from lsst.pipe.base import ArgumentParser
3232

33-
__all__ = ('MakeDiscreteSkyMapConfig', 'MakeDiscreteSkyMapRunner', 'MakeDiscreteSkyMapTask')
33+
__all__ = ['MakeDiscreteSkyMapConfig', 'MakeDiscreteSkyMapRunner', 'MakeDiscreteSkyMapTask']
3434

3535

3636
class MakeDiscreteSkyMapConfig(pexConfig.Config):

python/lsst/pipe/tasks/makeSkyMap.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
import lsst.pipe.base as pipeBase
2828
from lsst.skymap import skyMapRegistry
2929

30-
__all__ = ('MakeSkyMapConfig', 'MakeSkyMapRunner', 'MakeSkyMapTask')
30+
__all__ = ['MakeSkyMapConfig', 'MakeSkyMapRunner', 'MakeSkyMapTask']
3131

3232

3333
class MakeSkyMapConfig(pexConfig.Config):

python/lsst/pipe/tasks/matchBackgrounds.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
import lsst.pipe.base as pipeBase
2727
import lsstDebug
2828

29-
__all__ = ('MatchBackgroundsConfig', 'MatchBackgroundsTask', 'DataRefMatcher')
29+
__all__ = ['MatchBackgroundsConfig', 'MatchBackgroundsTask', 'DataRefMatcher']
3030

3131

3232
class MatchBackgroundsConfig(pexConfig.Config):

python/lsst/pipe/tasks/measurePsf.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
import lsst.pex.config as pexConfig
2727
import lsst.pipe.base as pipeBase
2828

29-
__all__ = ('MeasurePsfConfig', 'MeasurePsfTask')
29+
__all__ = ['MeasurePsfConfig', 'MeasurePsfTask']
3030

3131

3232
class MeasurePsfConfig(pexConfig.Config):

python/lsst/pipe/tasks/multiBand.py

+1-7
Original file line numberDiff line numberDiff line change
@@ -32,11 +32,10 @@
3232
the mergeDet, meas, and ref dataset Footprints:
3333
- deepCoadd_peak_schema
3434
"""
35-
import numpy
3635

3736
from lsst.coadd.utils.coaddDataIdContainer import ExistingCoaddDataIdContainer
3837
from lsst.pipe.base import (CmdLineTask, Struct, ArgumentParser, ButlerInitializedTaskRunner,
39-
PipelineTask, InitOutputDatasetField, InputDatasetField, OutputDatasetField,
38+
InitOutputDatasetField, InputDatasetField, OutputDatasetField,
4039
QuantumConfig)
4140
from lsst.pex.config import Config, Field, ConfigurableField
4241
from lsst.meas.algorithms import DynamicDetectionTask
@@ -59,11 +58,6 @@
5958
from .multiBandUtils import getInputSchema, getShortFilterName, readCatalog, _makeMakeIdFactory # noqa: F401
6059

6160

62-
63-
64-
65-
##############################################################################################################
66-
6761
class DetectCoaddSourcesConfig(Config):
6862
"""Configuration parameters for the DetectCoaddSourcesTask
6963
"""

python/lsst/pipe/tasks/objectMasks.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
import lsst.afw.table as afwTable
55
from lsst.log import Log
66

7-
__all__ = ('ObjectMaskCatalog',)
7+
__all__ = ['ObjectMaskCatalog', ]
88

99

1010
class ObjectMaskCatalog:

python/lsst/pipe/tasks/repair.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
from lsst.afw.display import getDisplay
2929
from lsst.pipe.tasks.interpImage import InterpImageTask
3030

31-
__all__ = ('RepairConfig', 'RepairTask')
31+
__all__ = ['RepairConfig', 'RepairTask']
3232

3333

3434
class RepairConfig(pexConfig.Config):

python/lsst/pipe/tasks/scaleVariance.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
from lsst.pipe.base import Task
2727
from lsst.meas.algorithms import SubtractBackgroundTask
2828

29-
__all__ = ('ScaleVarianceConfig', 'ScaleVarianceTask')
29+
__all__ = ['ScaleVarianceConfig', 'ScaleVarianceTask']
3030

3131

3232
class ScaleVarianceConfig(Config):

python/lsst/pipe/tasks/scaleZeroPoint.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@
2626
import lsst.pipe.base as pipeBase
2727
from lsst.pipe.tasks.selectImages import BaseSelectImagesTask
2828

29-
__all__ = ("ImageScaler", "SpatialImageScaler", "ScaleZeroPointTask", "ScaleZeroPointConfig",
30-
"SpatialScaleZeroPointConfig", "SpatialScaleZeroPointTask")
29+
__all__ = ["ImageScaler", "SpatialImageScaler", "ScaleZeroPointTask", "ScaleZeroPointConfig",
30+
"SpatialScaleZeroPointConfig", "SpatialScaleZeroPointTask"]
3131

3232

3333
class ImageScaler:

python/lsst/pipe/tasks/setConfigFromEups.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,10 @@ def setAstrometryConfigFromEups(config, menu):
3333
3434
.. code-block:: none
3535
36-
menu = { "ps1": {}, # No changes
36+
menu = { "ps1*": {}, # No changes
3737
"ps1-without-y": { "solver.filterMap": {"y": "z"} }, # No y-band in this specific version
38-
"sdss": { "solver.filterMap": {"y": "z"} }, # No y-band, use z instead
39-
"2mass": { "solver.filterMap": {"y": "J"} }, # No y-band, use J instead
38+
"sdss*": { "solver.filterMap": {"y": "z"} }, # No y-band, use z instead
39+
"2mass*": { "solver.filterMap": {"y": "J"} }, # No y-band, use J instead
4040
}
4141
4242
"""

python/lsst/pipe/tasks/setPrimaryFlags.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
from lsst.pipe.base import Task
2626
from lsst.afw.geom import Box2D
2727

28-
__all__ = ('SetPrimaryFlagsConfig', 'SetPrimaryFlagsTask')
28+
__all__ = ['SetPrimaryFlagsConfig', 'SetPrimaryFlagsTask']
2929

3030

3131
class SetPrimaryFlagsConfig(Config):

python/lsst/pipe/tasks/snapCombine.py

+2-1
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,8 @@ def validate(self):
133133

134134

135135
class SnapCombineTask(pipeBase.Task):
136-
"""
136+
"""Combine snaps.
137+
137138
The lsst.pipe.base.cmdLineTask.CmdLineTask command line task interface supports a
138139
flag -d to import debug.py from your PYTHONPATH; see
139140
"http://lsst-web.ncsa.illinois.edu/~buildbot/doxygen/x_masterDoxyDoc/base_debug.html"

python/lsst/pipe/tasks/transformMeasurement.py

+3-6
Original file line numberDiff line numberDiff line change
@@ -188,8 +188,7 @@ class RunTransformTaskBase(pipeBase.CmdLineTask):
188188

189189
@property
190190
def inputSchemaType(self):
191-
"""
192-
The Butler dataset type for the schema of the input source catalog.
191+
"""The Butler dataset type for the schema of the input source catalog.
193192
194193
By default, we append `_schema` to the input source type. Subclasses may customize
195194
if required.
@@ -198,8 +197,7 @@ def inputSchemaType(self):
198197

199198
@property
200199
def outputDataset(self):
201-
"""
202-
The Butler dataset type for the schema of the output catalog.
200+
"""The Butler dataset type for the schema of the output catalog.
203201
204202
By default, we prepend `transformed` to the input source type. Subclasses may
205203
customize if required.
@@ -208,8 +206,7 @@ def outputDataset(self):
208206

209207
@property
210208
def measurementConfig(self):
211-
"""
212-
The configuration of the measurement operation used to generate the input catalog.
209+
"""The configuration of the measurement operation used to generate the input catalog.
213210
214211
By default we look for `measurement` under the root configuration of the
215212
generating task. Subclasses may customize this (e.g. to `calibrate.measurement`)

0 commit comments

Comments
 (0)