DM-14133: Enable Sphinx support for meas_astrom #105

morriscb · 2019-01-02T19:31:37Z

No description provided.

Fix lint errors.

Fix rst overline. Fix overline in package/index.rst Fix some numpydoc errors. Comment out doxygen for later conversion.

Add Task documention for AstrometryTask. Fix formating in AstrometryTask rst.

Fix links in docs. Touch up docs in display.py Clean up FitSipDistortion documentation. Fix rst heading. Change FitTanSip to numpydoc. Fix FitTanSipTask docs. Clean up setMatchDistance doc.

Fix task name.

Fix doc error.

Fix linter errors. Fix linting in astrometry.py

kfindeisen

Some style/consistency comments (including a lot of broken links), otherwise looks good.

kfindeisen · 2019-01-03T23:56:41Z

doc/lsst.meas.astrom/index.rst

+.. toctree linking to topics related to using the module's APIs.
+
+.. .. toctree::
+..    :maxdepth: 1


I don't see any translation of the content from mainpage.dox. Admittedly, it's not much, but it should be preserved.

Maybe I'm reading this wrong but shouldn't what is in mainpage.dox just be autogenerated under the different sections in this file? mainpage.dox just looks to be saying "here's AstrometryTask...". I've added a short sentence to the intro.

kfindeisen · 2019-01-03T23:57:34Z

doc/lsst.meas.astrom/index.rst

+============
+
+``lsst.meas.astrom`` is developed at https://github.com/lsst/meas_astrom.
+You can find Jira issues for this module under the `example <https://jira.lsstcorp.org/issues/?jql=project%20%3D%20DM%20AND%20component%20%3D%20example>`_ component.


Bad URL, please replace example -> meas_astrom and check that it goes to the right Jira page.

kfindeisen · 2019-01-04T00:02:47Z

doc/lsst.meas.astrom/tasks/lsst.meas.astrom.AstrometryTask.rst

+==================
+
+.. If the task does not break work down into multiple steps, don't use a list.
+.. Instead, summarize the computation itself in a paragraph or two.


I assume these comments are from the template. Are they still necessary?

I'm okay with keeping them in as they could be helpful is someone needs to update or expand the docs.

kfindeisen · 2019-01-04T00:11:49Z

doc/lsst.meas.astrom/tasks/lsst.meas.astrom.FitSipDistortion.rst

+
+``FitSipDistortionTask`` involves three steps:
+
+- We set the CRVAL and CRPIX reference points to the mean positions of


I think most of this needs to go into a "In Depth" section (see guidelines for Processing summary).

I'm going to leave this as is as it is merely a copy of what was in the doxygen.

kfindeisen · 2019-01-04T00:19:08Z

doc/lsst.meas.astrom/tasks/lsst.meas.astrom.RefMatchTask.rst

+
+.. lsst-task-config-fields:: lsst.meas.astrom.RefMatchTask
+
+.. _lsst.meas.astrom.RefMatchTask-debug:


This file looks like it's been cut off.

The doxygen for this class didn't some with any more examples or information so hence the lack sections in the rest of the file.

kfindeisen · 2019-01-04T00:44:22Z

python/lsst/meas/astrom/matchOptimisticB/matchOptimisticBContinued.py

@@ -13,19 +13,20 @@


 class MatchTolerance:
-    """ Stores match tolerances for use in AstrometryTask and later
-    iterations of the matcher.
+    """Stores match tolerances for use in `lsst.meas.astromAstrometryTask` and


Typo: astrom.AstrometryTask

kfindeisen · 2019-01-04T00:47:05Z

python/lsst/meas/astrom/matchOptimisticB/matchOptimisticBContinued.py

+        """Test that an object is good for use in the WCS fitter.
+
+        This is a hard coded version of the isGood flag from the old SourceInfo
+        class that used to be part of this class.


You removed the old note about sourceSelector not supporting a feature; is there an issue reference you could replace it with?

No, there isn't. I don't think this the plan is to ever add this support as matchLists are different beasts than the source catalogs that source selectors work on. This was something I wrote a while ago when creating the new mathcer. Once I finalize the change over the matchers this becomes much less important and eventually goes away.

kfindeisen · 2019-01-04T00:50:13Z

python/lsst/meas/astrom/matchPessimisticB.py

            Rotation around the sphere

        Return
        ------
-        float array
-            Spherical unit vector x, y, z  on the unit-sphere.
+        output_array : `numpy.array`, (N, 4)


There is no such type as numpy.array; did you mean numpy.ndarray? Same elsewhere.

kfindeisen · 2019-01-04T00:56:31Z

python/lsst/meas/astrom/ref_match.py

+        A reference object loader object
+    schema : `lsst.afw.table.Schema`
+        ignored; available for compatibility with an older astrometry task
+    kwargs


Should be **kwargs.

kfindeisen · 2019-01-04T00:59:25Z

python/lsst/meas/astrom/setMatchDistance.py

-        writes the distance field of each match
+    Notes
+    -----
+    WARNING : the coord field of the source in each match must be correct


You could reproduce the old behavior with

Suggested change

WARNING : the coord field of the source in each match must be correct

.. warning::

the coord field of the source in each match must be correct

Correct numpy.ndarray types in docs. Fix typo. Fix doc formating. Update copyright header. Fix output name in doc. Change from cpp type to proper sphinx type. Removed cpp type in docs. Fix python preamble. Fix kwargs name. Fixup docs in astrometry and denormalize. Add sphinx reference and short meas_astrom description. Remove packMatches reference due to doc crash in that package. Remove duplicate reference. Rename matchOptimsiticB task docs. Add afw.table.packMatches back as unlinked. Fixup TODO comment.

WERKSQUAD and others added 14 commits January 2, 2019 11:29

numpydoc

4c06dae

add doc

d2c34d3

Fix lint errors.

Migrate RefMatchTask docs to new numpydoc schema.`

ee17fbf

Update genDistoredImage docs to numpydoc.

9186f16

Update sourceMatchStatistics to new numpydocs.

a5338e0

Update sphix boilerplate.

de37f89

Fix rst overline. Fix overline in package/index.rst Fix some numpydoc errors. Comment out doxygen for later conversion.

Edit numpy docs for approximateWcs.

1334eca

Edit AstrometryTask numpydocs.

0840c85

Add Task documention for AstrometryTask. Fix formating in AstrometryTask rst.

Update Direct match documentation.

527f07a

Fix links in docs. Touch up docs in display.py Clean up FitSipDistortion documentation. Fix rst heading. Change FitTanSip to numpydoc. Fix FitTanSipTask docs. Clean up setMatchDistance doc.

Add doc to verifyWcs

4eaa667

Migrate MatchOptimisticB docs to new numpydoc format.

0620eb2

Fix task name.

Restructure doc to follow dir hierarchy.

07135e4

Update MatchPessimisticB docs to numpydoc.

a57bf99

Fix doc error.

Modify docs in pessimistic matcher for new numpydoc.

3d446a8

Fix linter errors. Fix linting in astrometry.py

morriscb force-pushed the tickets/DM-14133 branch from a6dd0d4 to 3d446a8 Compare January 2, 2019 20:07

kfindeisen approved these changes Jan 4, 2019

View reviewed changes

morriscb force-pushed the tickets/DM-14133 branch 2 times, most recently from fe48e56 to 3d12e56 Compare January 8, 2019 21:53

morriscb force-pushed the tickets/DM-14133 branch from 8f5c68e to 54dc09c Compare January 10, 2019 21:50

morriscb merged commit 54dc09c into master Jan 10, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DM-14133: Enable Sphinx support for meas_astrom #105

DM-14133: Enable Sphinx support for meas_astrom #105

morriscb commented Jan 2, 2019

kfindeisen left a comment

kfindeisen Jan 3, 2019

morriscb Jan 8, 2019

kfindeisen Jan 3, 2019

kfindeisen Jan 4, 2019

morriscb Jan 8, 2019

kfindeisen Jan 4, 2019

morriscb Jan 8, 2019

kfindeisen Jan 4, 2019

morriscb Jan 8, 2019

kfindeisen Jan 4, 2019

kfindeisen Jan 4, 2019

morriscb Jan 7, 2019

kfindeisen Jan 4, 2019

kfindeisen Jan 4, 2019

kfindeisen Jan 4, 2019 •

edited


		``FitSipDistortionTask`` involves three steps:

		- We set the CRVAL and CRPIX reference points to the mean positions of


		.. lsst-task-config-fields:: lsst.meas.astrom.RefMatchTask

		.. _lsst.meas.astrom.RefMatchTask-debug:

	WARNING : the coord field of the source in each match must be correct
	.. warning::
	the coord field of the source in each match must be correct

DM-14133: Enable Sphinx support for meas_astrom #105

DM-14133: Enable Sphinx support for meas_astrom #105

Conversation

morriscb commented Jan 2, 2019

kfindeisen left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kfindeisen Jan 4, 2019 • edited

Choose a reason for hiding this comment

kfindeisen Jan 4, 2019 •

edited