Skip to content

Commit

Permalink
Manual documentation and __all__ updates following rebase to master.
Browse files Browse the repository at this point in the history
See ticket comment on details. Minor style corrections.
  • Loading branch information
Gabor Kovacs authored and mrawls committed Dec 19, 2018
1 parent 9c23429 commit 07a0009
Show file tree
Hide file tree
Showing 17 changed files with 30 additions and 34 deletions.
6 changes: 4 additions & 2 deletions python/lsst/pipe/tasks/colorterms.py
Original file line number Diff line number Diff line change
Expand Up @@ -158,8 +158,10 @@ class ColortermLibrary(Config):
...
}),
"sdss": ColortermDict(data={
'g': Colorterm(primary="g", secondary="r", c0=-0.00816446, c1=-0.08366937, c2=-0.00726883),
'r': Colorterm(primary="r", secondary="i", c0= 0.00231810, c1= 0.01284177, c2=-0.03068248),
'g': Colorterm(primary="g", secondary="r", c0=-0.00816446, c1=-0.08366937,
c2=-0.00726883),
'r': Colorterm(primary="r", secondary="i", c0= 0.00231810, c1= 0.01284177,
c2=-0.03068248),
...
}),
})
Expand Down
6 changes: 4 additions & 2 deletions python/lsst/pipe/tasks/imageDifference.py
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,9 @@
FwhmPerSigma = 2 * math.sqrt(2 * math.log(2))
IqrToSigma = 0.741

__all__ = ('ImageDifferenceConfig', 'ImageDifferenceTaskRunner',
'Winter2013ImageDifferenceConfig', 'Winter2013ImageDifferenceTask')
__all__ = ['ImageDifferenceConfig', 'ImageDifferenceTaskRunner',
'Winter2013ImageDifferenceConfig', 'Winter2013ImageDifferenceTask']


class ImageDifferenceConfig(pexConfig.Config):
"""Config for ImageDifferenceTask
Expand Down Expand Up @@ -872,6 +873,7 @@ def setDefaults(self):
ImageDifferenceConfig.setDefaults(self)
self.getTemplate.retarget(GetCalexpAsTemplateTask)


class Winter2013ImageDifferenceTask(ImageDifferenceTask):
"""Image difference Task used in the Winter 2013 data challege.
Enables testing the effects of registration shifts and scatter.
Expand Down
4 changes: 2 additions & 2 deletions python/lsst/pipe/tasks/ingest.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@
from lsst.pipe.base import Task, InputOnlyArgumentParser
from lsst.afw.fits import DEFAULT_HDU

__all__ = ('IngestArgumentParser', 'ParseConfig', 'ParseConfig', 'ParseTask', 'RegisterConfig',
'RegistryContext', 'RegisterTask', 'IngestConfig', 'IngestTask')
__all__ = ['IngestArgumentParser', 'ParseConfig', 'ParseConfig', 'ParseTask', 'RegisterConfig',
'RegistryContext', 'RegisterTask', 'IngestConfig', 'IngestTask']


class IngestArgumentParser(InputOnlyArgumentParser):
Expand Down
2 changes: 1 addition & 1 deletion python/lsst/pipe/tasks/ingestPgsql.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
except ImportError:
havePgSql = False

__all__ = ('PgsqlRegistryContext', 'PgsqlRegisterTask', 'PgsqlIngestConfig', 'PgsqlIngestTask')
__all__ = ['PgsqlRegistryContext', 'PgsqlRegisterTask', 'PgsqlIngestConfig', 'PgsqlIngestTask']


class PgsqlRegistryContext(RegistryContext):
Expand Down
2 changes: 1 addition & 1 deletion python/lsst/pipe/tasks/makeDiscreteSkyMap.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
from lsst.skymap import DiscreteSkyMap, BaseSkyMap
from lsst.pipe.base import ArgumentParser

__all__ = ('MakeDiscreteSkyMapConfig', 'MakeDiscreteSkyMapRunner', 'MakeDiscreteSkyMapTask')
__all__ = ['MakeDiscreteSkyMapConfig', 'MakeDiscreteSkyMapRunner', 'MakeDiscreteSkyMapTask']


class MakeDiscreteSkyMapConfig(pexConfig.Config):
Expand Down
2 changes: 1 addition & 1 deletion python/lsst/pipe/tasks/makeSkyMap.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
import lsst.pipe.base as pipeBase
from lsst.skymap import skyMapRegistry

__all__ = ('MakeSkyMapConfig', 'MakeSkyMapRunner', 'MakeSkyMapTask')
__all__ = ['MakeSkyMapConfig', 'MakeSkyMapRunner', 'MakeSkyMapTask']


class MakeSkyMapConfig(pexConfig.Config):
Expand Down
2 changes: 1 addition & 1 deletion python/lsst/pipe/tasks/matchBackgrounds.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
import lsst.pipe.base as pipeBase
import lsstDebug

__all__ = ('MatchBackgroundsConfig', 'MatchBackgroundsTask', 'DataRefMatcher')
__all__ = ['MatchBackgroundsConfig', 'MatchBackgroundsTask', 'DataRefMatcher']


class MatchBackgroundsConfig(pexConfig.Config):
Expand Down
2 changes: 1 addition & 1 deletion python/lsst/pipe/tasks/measurePsf.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
import lsst.pex.config as pexConfig
import lsst.pipe.base as pipeBase

__all__ = ('MeasurePsfConfig', 'MeasurePsfTask')
__all__ = ['MeasurePsfConfig', 'MeasurePsfTask']


class MeasurePsfConfig(pexConfig.Config):
Expand Down
8 changes: 1 addition & 7 deletions python/lsst/pipe/tasks/multiBand.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,10 @@
the mergeDet, meas, and ref dataset Footprints:
- deepCoadd_peak_schema
"""
import numpy

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





##############################################################################################################

class DetectCoaddSourcesConfig(Config):
"""Configuration parameters for the DetectCoaddSourcesTask
"""
Expand Down
2 changes: 1 addition & 1 deletion python/lsst/pipe/tasks/objectMasks.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
import lsst.afw.table as afwTable
from lsst.log import Log

__all__ = ('ObjectMaskCatalog',)
__all__ = ['ObjectMaskCatalog', ]


class ObjectMaskCatalog:
Expand Down
2 changes: 1 addition & 1 deletion python/lsst/pipe/tasks/repair.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
from lsst.afw.display import getDisplay
from lsst.pipe.tasks.interpImage import InterpImageTask

__all__ = ('RepairConfig', 'RepairTask')
__all__ = ['RepairConfig', 'RepairTask']


class RepairConfig(pexConfig.Config):
Expand Down
2 changes: 1 addition & 1 deletion python/lsst/pipe/tasks/scaleVariance.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
from lsst.pipe.base import Task
from lsst.meas.algorithms import SubtractBackgroundTask

__all__ = ('ScaleVarianceConfig', 'ScaleVarianceTask')
__all__ = ['ScaleVarianceConfig', 'ScaleVarianceTask']


class ScaleVarianceConfig(Config):
Expand Down
4 changes: 2 additions & 2 deletions python/lsst/pipe/tasks/scaleZeroPoint.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@
import lsst.pipe.base as pipeBase
from lsst.pipe.tasks.selectImages import BaseSelectImagesTask

__all__ = ("ImageScaler", "SpatialImageScaler", "ScaleZeroPointTask", "ScaleZeroPointConfig",
"SpatialScaleZeroPointConfig", "SpatialScaleZeroPointTask")
__all__ = ["ImageScaler", "SpatialImageScaler", "ScaleZeroPointTask", "ScaleZeroPointConfig",
"SpatialScaleZeroPointConfig", "SpatialScaleZeroPointTask"]


class ImageScaler:
Expand Down
6 changes: 3 additions & 3 deletions python/lsst/pipe/tasks/setConfigFromEups.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,10 @@ def setAstrometryConfigFromEups(config, menu):
.. code-block:: none
menu = { "ps1": {}, # No changes
menu = { "ps1*": {}, # No changes
"ps1-without-y": { "solver.filterMap": {"y": "z"} }, # No y-band in this specific version
"sdss": { "solver.filterMap": {"y": "z"} }, # No y-band, use z instead
"2mass": { "solver.filterMap": {"y": "J"} }, # No y-band, use J instead
"sdss*": { "solver.filterMap": {"y": "z"} }, # No y-band, use z instead
"2mass*": { "solver.filterMap": {"y": "J"} }, # No y-band, use J instead
}
"""
Expand Down
2 changes: 1 addition & 1 deletion python/lsst/pipe/tasks/setPrimaryFlags.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
from lsst.pipe.base import Task
from lsst.afw.geom import Box2D

__all__ = ('SetPrimaryFlagsConfig', 'SetPrimaryFlagsTask')
__all__ = ['SetPrimaryFlagsConfig', 'SetPrimaryFlagsTask']


class SetPrimaryFlagsConfig(Config):
Expand Down
3 changes: 2 additions & 1 deletion python/lsst/pipe/tasks/snapCombine.py
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,8 @@ def validate(self):


class SnapCombineTask(pipeBase.Task):
"""
"""Combine snaps.
The lsst.pipe.base.cmdLineTask.CmdLineTask command line task interface supports a
flag -d to import debug.py from your PYTHONPATH; see
"http://lsst-web.ncsa.illinois.edu/~buildbot/doxygen/x_masterDoxyDoc/base_debug.html"
Expand Down
9 changes: 3 additions & 6 deletions python/lsst/pipe/tasks/transformMeasurement.py
Original file line number Diff line number Diff line change
Expand Up @@ -188,8 +188,7 @@ class RunTransformTaskBase(pipeBase.CmdLineTask):

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

@property
def outputDataset(self):
"""
The Butler dataset type for the schema of the output catalog.
"""The Butler dataset type for the schema of the output catalog.
By default, we prepend `transformed` to the input source type. Subclasses may
customize if required.
Expand All @@ -208,8 +206,7 @@ def outputDataset(self):

@property
def measurementConfig(self):
"""
The configuration of the measurement operation used to generate the input catalog.
"""The configuration of the measurement operation used to generate the input catalog.
By default we look for `measurement` under the root configuration of the
generating task. Subclasses may customize this (e.g. to `calibrate.measurement`)
Expand Down

0 comments on commit 07a0009

Please sign in to comment.