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

Correct CompensableImage docstring in ts_wep

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Done
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: ts_aos
    • Labels:
      None

      Description

      Current docstring in CompensableImage says in makeMask method

      pMask: padded mask for use at the offset planes
      cMask: non-padded mask corresponding to aperture

      Also, boundaryT parameter defines how far the computation mask extends beyond the pupil mask

      A quick experiment  changing `boundaryT` parameter shows that in fact pMask stands for the pupil mask, whereas cMask is the computation (padded) mask (see illustration below). Hence cMask is the padded (extended) version of pMask

      This ticket is to reflect that correction in the docstring whenever cMask or pMask are referenced  to avoid confusion.

       

       

        Attachments

          Activity

          Hide
          ksuberlak Krzysztof Suberlak added a comment -

          A notebook illustrating the point with  code used to make the attached image https://github.com/suberlak/AOS/blob/main/AOS_DM-34846_CompensableImage_ts_wep.ipynb

          Show
          ksuberlak Krzysztof Suberlak added a comment - A notebook illustrating the point with  code used to make the attached image https://github.com/suberlak/AOS/blob/main/AOS_DM-34846_CompensableImage_ts_wep.ipynb
          Hide
          ksuberlak Krzysztof Suberlak added a comment -

          A notebook with comparison of running the AOS loop before and after, as well as running ts_wep  tests and fitting batoid simulations https://github.com/suberlak/AOS/blob/main/AOS_DM-34846_compensable.ipynb 

          Show
          ksuberlak Krzysztof Suberlak added a comment - A notebook with comparison of running the AOS loop before and after, as well as running ts_wep  tests and fitting batoid simulations https://github.com/suberlak/AOS/blob/main/AOS_DM-34846_compensable.ipynb  
          Hide
          ttsai Te-Wei Tsai added a comment -

          Thanks for this great improvement!

          Show
          ttsai Te-Wei Tsai added a comment - Thanks for this great improvement!

            People

            Assignee:
            ksuberlak Krzysztof Suberlak
            Reporter:
            ksuberlak Krzysztof Suberlak
            Reviewers:
            Te-Wei Tsai
            Watchers:
            Andrew Connolly, Krzysztof Suberlak, Te-Wei Tsai
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Dates

              Due:
              Created:
              Updated:
              Resolved:
              Start date:

                Jenkins

                No builds found.