Uploaded image for project: 'Data Management'
  1. Data Management
  2. DM-2908

Add Gaussian PSF example to measurement task documentation

    Details

    • Type: Story
    • Status: To Do
    • Resolution: Unresolved
    • Fix Version/s: None
    • Component/s: meas_base
    • Labels:
      None
    • Story Points:
      1
    • Team:
      Data Release Production

      Description

      I see some documentation on how to add a placeholder Gaussian Psf to an image (to work around the fact that some algorithms require a Psf) was recently added to the release notes. I don't think that's actually appropriate, as the same algorithms also required Psfs in the framework - the failure mode was just different (previously, it'd just result in all objects being flagged and the peak position used for the centroid, so it may have been easy to miss - hence the change to a fatal error).

      I propose moving the example to the documentation for SingleFrameMeasurementTask, and taking it out of the release notes. I'll also make sure there's a link from the Measurement Framework Overhaul Release Notes page to the Doxygen for SingleFrameMeasurementTask - I'm not sure if that's sufficient to make up the visibility gap between the Doxygen docs and the release notes in Confluence, but I don't have any other short-term ideas.

        Attachments

          Issue Links

            Activity

            Hide
            ktl Kian-Tat Lim added a comment -

            Fine by me; this was just an emergency fix.

            Show
            ktl Kian-Tat Lim added a comment - Fine by me; this was just an emergency fix.
            Hide
            cwalter Chris Walter added a comment -

            Moving the example is fine as I mentioned in the chat. But I think a line mentioning the difference in the release notes and implying you can find instructions in the link is still appropriate since, to the user, it is an important change.

            Show
            cwalter Chris Walter added a comment - Moving the example is fine as I mentioned in the chat. But I think a line mentioning the difference in the release notes and implying you can find instructions in the link is still appropriate since, to the user, it is an important change.
            Hide
            swinbank John Swinbank added a comment -

            For reference, the release notes being referred to are for 10.1 (Winter 2015).

            Show
            swinbank John Swinbank added a comment - For reference, the release notes being referred to are for 10.1 (Winter 2015) .

              People

              • Assignee:
                jbosch Jim Bosch
                Reporter:
                jbosch Jim Bosch
                Watchers:
                Chris Walter, Jim Bosch, John Swinbank, Kian-Tat Lim, Robert Lupton
              • Votes:
                0 Vote for this issue
                Watchers:
                5 Start watching this issue

                Dates

                • Created:
                  Updated: