Skip to content

Commit

Permalink
Update docstrings with improved formatting.
Browse files Browse the repository at this point in the history
  • Loading branch information
@erykoff
erykoff committed Jan 12, 2023
1 parent 9774e73 commit 9497905
Showing 1 changed file with 47 additions and 47 deletions.
94 changes: 47 additions & 47 deletions tests/fgcmcalTestBase.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -141,19 +141,19 @@ def _testFgcmMakeLut(self, instName, testName, nBand, i0Std, i0Recon, i10Std, i1
Parameters
----------
instName : `str`
Short name of the instrument
Short name of the instrument.
testName : `str`
Base name of the test collection
Base name of the test collection.
nBand : `int`
Number of bands tested
Number of bands tested.
i0Std : `np.ndarray'
Values of i0Std to compare to
Values of i0Std to compare to.
i10Std : `np.ndarray`
Values of i10Std to compare to
Values of i10Std to compare to.
i0Recon : `np.ndarray`
Values of reconstructed i0 to compare to
Values of reconstructed i0 to compare to.
i10Recon : `np.ndarray`
Values of reconsntructed i10 to compare to
Values of reconsntructed i10 to compare to.
"""
instCamel = instName.title()

Expand Down Expand Up @@ -233,17 +233,17 @@ def _testFgcmBuildStarsTable(self, instName, testName, queryString, visits, nSta
Parameters
----------
instName : `str`
Short name of the instrument
Short name of the instrument.
testName : `str`
Base name of the test collection
Base name of the test collection.
queryString : `str`
Query to send to the pipetask.
visits : `list`
List of visits to calibrate
List of visits to calibrate.
nStar : `int`
Number of stars expected
Number of stars expected.
nObs : `int`
Number of observations of stars expected
Number of observations of stars expected.
"""
instCamel = instName.title()

Expand Down Expand Up @@ -283,17 +283,17 @@ def _testFgcmBuildFromIsolatedStars(self, instName, testName, queryString, visit
Parameters
----------
instName : `str`
Short name of the instrument
Short name of the instrument.
testName : `str`
Base name of the test collection
Base name of the test collection.
queryString : `str`
Query to send to the pipetask.
visits : `list`
List of visits to calibrate
List of visits to calibrate.
nStar : `int`
Number of stars expected
Number of stars expected.
nObs : `int`
Number of observations of stars expected
Number of observations of stars expected.
"""
instCamel = instName.title()

Expand Down Expand Up @@ -337,23 +337,23 @@ def _testFgcmFitCycle(self, instName, testName, cycleNumber,
Parameters
----------
instName : `str`
Short name of the instrument
Short name of the instrument.
testName : `str`
Base name of the test collection
Base name of the test collection.
cycleNumber : `int`
Fit cycle number.
nZp : `int`
Number of zeropoints created by the task
Number of zeropoints created by the task.
nGoodZp : `int`
Number of good (photometric) zeropoints created
Number of good (photometric) zeropoints created.
nOkZp : `int`
Number of constrained zeropoints (photometric or not)
Number of constrained zeropoints (photometric or not).
nBadZp : `int`
Number of unconstrained (bad) zeropoints
Number of unconstrained (bad) zeropoints.
nStdStars : `int`
Number of standard stars produced
Number of standard stars produced.
nPlots : `int`
Number of plots produced
Number of plots produced.
skipChecks : `bool`, optional
Skip number checks, when running less-than-final cycle.
extraConfig : `str`, optional
Expand Down Expand Up @@ -448,19 +448,19 @@ def _testFgcmOutputProducts(self, instName, testName,
Parameters
----------
instName : `str`
Short name of the instrument
Short name of the instrument.
testName : `str`
Base name of the test collection
Base name of the test collection.
zpOffsets : `np.ndarray`
Zeropoint offsets expected
Zeropoint offsets expected.
testVisit : `int`
Visit id to check for round-trip computations
Visit id to check for round-trip computations.
testCcd : `int`
Ccd id to check for round-trip computations
Ccd id to check for round-trip computations.
testFilter : `str`
Filtername for testVisit/testCcd
Filtername for testVisit/testCcd.
testBandIndex : `int`
Band index for testVisit/testCcd
Band index for testVisit/testCcd.
"""
instCamel = instName.title()

Expand Down Expand Up @@ -643,15 +643,15 @@ def _testFgcmMultiFit(self, instName, testName, queryString, visits, zpOffsets):
Parameters
----------
instName : `str`
Short name of the instrument
Short name of the instrument.
testName : `str`
Base name of the test collection
Base name of the test collection.
queryString : `str`
Query to send to the pipetask.
visits : `list`
List of visits to calibrate
List of visits to calibrate.
zpOffsets : `np.ndarray`
Zeropoint offsets expected
Zeropoint offsets expected.
"""
instCamel = instName.title()

Expand Down Expand Up @@ -702,20 +702,20 @@ def _getMatchedVisitCat(self, butler, srcHandles, photoCals,
----------
butler : `lsst.daf.butler.Butler`
srcHandles : `list`
handles of source catalogs
Handles of source catalogs.
photoCals : `list`
photoCalib objects, matched to srcHandles.
rawStars : `lsst.afw.table.SourceCatalog`
Fgcm standard stars
Fgcm standard stars.
bandIndex : `int`
Index of the band for the source catalogs
Index of the band for the source catalogs.
offsets : `np.ndarray`
Testing calibration offsets to apply to rawStars
Testing calibration offsets to apply to rawStars.
Returns
-------
matchMag : `np.ndarray`
Array of matched magnitudes
Array of matched magnitudes.
matchDelta : `np.ndarray`
Array of matched deltas between src and standard stars.
"""
Expand Down Expand Up @@ -753,15 +753,15 @@ def _testFgcmCalibrateTract(self, instName, testName, visits, tract, skymapName,
Parameters
----------
instName : `str`
Short name of the instrument
Short name of the instrument.
testName : `str`
Base name of the test collection
Base name of the test collection.
visits : `list`
List of visits to calibrate
List of visits to calibrate.
tract : `int`
Tract number
Tract number.
skymapName : `str`
Name of the sky map
Name of the sky map.
rawRepeatability : `np.array`
Expected raw repeatability after convergence.
Length should be number of bands.
Expand Down Expand Up @@ -835,7 +835,7 @@ def _testFgcmCalibrateTract(self, instName, testName, visits, tract, skymapName,

@classmethod
def tearDownClass(cls):
"""Tear down and clear directories
"""Tear down and clear directories.
"""
if os.path.exists(cls.testDir):
shutil.rmtree(cls.testDir, True)

0 comments on commit 9497905

Please sign in to comment.