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

Change fluxSigma to fluxErr and similarly for apCorr and covariances

    XMLWordPrintable

    Details

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

      Description

      Change fluxSigma to fluxErr, apCorrSigma to apCorrErr and similarly for the diagonal elements of covariance matrices. This includes variable names, argument names and afw table field names. This is necessary in order to implement RFC-333.

      Change afw::table::CovarianceMatrixKey to use "Err" as a suffix rather than "Sigma".

      Update the FITS catalog persistence as follows:

      • Bump the schema VERSION constant from 1 to 2 in SchemaImpl.h
      • When reading version 1 catalogs make a fooErr as an alias to every fooSigma field
      • When reading version 0 catalogs make Err aliases instead of Sigma aliases.

        Attachments

          Issue Links

            Activity

            rowen Russell Owen created issue -
            rowen Russell Owen made changes -
            Field Original Value New Value
            Epic Link DM-14447 [ 80385 ]
            rowen Russell Owen made changes -
            Link This issue is triggered by RFC-333 [ RFC-333 ]
            rowen Russell Owen made changes -
            Risk Score 0
            rowen Russell Owen made changes -
            Status To Do [ 10001 ] In Progress [ 3 ]
            rowen Russell Owen made changes -
            Summary Add support for "Err" suffix to CovarianceMatrixKey Change CovarianceMatrixKey field name suffix from Sigma to Err
            rowen Russell Owen made changes -
            Description {{afw::table::CovarianceMatrixKey}} should support "Err" as a suffix, as well as "Sigma". This is necessary in order to implement RFC-333.

            Simply allowing this suffix to be specified is probably trivial. However, for backwards compatibility it would be nice if we could read existing persisted tables with "Sigma" suffix as "Err", but I have no idea how practical that is. [~jbosch] do you have any ideas about this?

            My initial estimate of story points is based on either not implementing backwards compatibility or having it be fairly easy.
            {{afw::table::CovarianceMatrixKey}} should use "Err" instead of "Sigma" as its field name suffix for diagonal elements. This is necessary in order to implement RFC-333. Note that we have no use case for writing covariance matrices with a "Sigma" suffix. so I am changing the suffix instead of allowing different suffixes.

            Update the VERSION in SchemaImpl.h and add code that handles older catalogs.
            rowen Russell Owen made changes -
            Description {{afw::table::CovarianceMatrixKey}} should use "Err" instead of "Sigma" as its field name suffix for diagonal elements. This is necessary in order to implement RFC-333. Note that we have no use case for writing covariance matrices with a "Sigma" suffix. so I am changing the suffix instead of allowing different suffixes.

            Update the VERSION in SchemaImpl.h and add code that handles older catalogs.
            {{afw::table::CovarianceMatrixKey}} should support "Err" as a suffix, as well as "Sigma". This is necessary in order to implement RFC-333.

            Simply allowing this suffix to be specified is probably trivial. However, for backwards compatibility it would be nice if we could read existing persisted tables with "Sigma" suffix as "Err", but I have no idea how practical that is. [~jbosch] do you have any ideas about this?

            My initial estimate of story points is based on either not implementing backwards compatibility or having it be fairly easy. I also see that DM-
            rowen Russell Owen made changes -
            Story Points 2 5
            rowen Russell Owen made changes -
            Link This issue blocks DM-8828 [ DM-8828 ]
            rowen Russell Owen made changes -
            Link This issue duplicates DM-11168 [ DM-11168 ]
            rowen Russell Owen made changes -
            Summary Change CovarianceMatrixKey field name suffix from Sigma to Err Change fluxSigma to fluxErr and similarly for covariances
            rowen Russell Owen made changes -
            Description {{afw::table::CovarianceMatrixKey}} should support "Err" as a suffix, as well as "Sigma". This is necessary in order to implement RFC-333.

            Simply allowing this suffix to be specified is probably trivial. However, for backwards compatibility it would be nice if we could read existing persisted tables with "Sigma" suffix as "Err", but I have no idea how practical that is. [~jbosch] do you have any ideas about this?

            My initial estimate of story points is based on either not implementing backwards compatibility or having it be fairly easy. I also see that DM-
            Change fluxSigma to fluxErr, apCorrSigma to apCorrErr and similarly for the diagonal elements of covariance matrices. This includes variable names, argument names and afw table field names. This is necessary in order to implement RFC-333.

            Change {{afw::table::CovarianceMatrixKey}} to use "Err" as a suffix rather than "Sigma".

            Update the FITS catalog persistence as follows:
            - Bump the schema VERSION constant from 1 to 2 in SchemaImpl.h
            - When reading version 1 catalogs make a {{fooErr}} as an alias to every {{fooSigma}} field
            - When reading version 0 catalogs make {{Err}} aliases instead of {{Sigma}} aliases.
            rowen Russell Owen made changes -
            Summary Change fluxSigma to fluxErr and similarly for covariances Change fluxSigma to fluxErr and similarly for apCorr and covariances
            rowen Russell Owen made changes -
            Reviewers Jim Bosch [ jbosch ]
            Status In Progress [ 3 ] In Review [ 10004 ]
            rowen Russell Owen made changes -
            Reviewers Jim Bosch [ jbosch ] Jim Bosch, Sophie Reed [ jbosch, sophiereed ]
            rowen Russell Owen made changes -
            Status In Review [ 10004 ] Reviewed [ 10101 ]
            rowen Russell Owen made changes -
            Resolution Done [ 10000 ]
            Status Reviewed [ 10101 ] Done [ 10002 ]
            rowen Russell Owen made changes -
            Link This issue is triggering DM-15355 [ DM-15355 ]

              People

              Assignee:
              rowen Russell Owen
              Reporter:
              rowen Russell Owen
              Reviewers:
              Jim Bosch, Sophie Reed
              Watchers:
              Jim Bosch, John Parejko, Russell Owen, Sophie Reed
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Jenkins

                  No builds found.