镜像站点 · 本页由第三方 GitHub 只读镜像提供,非 GitHub 官方站点,不接受任何登录或凭据输入。前往 github.com
Skip to content

(DOCS ONLY) Specific documentation of InSAR sas_output_file naming convention - #425

Open
Tyler-g-hudson wants to merge 1 commit into
isce-framework:developfrom
Tyler-g-hudson:insar_cfg_naming_doc
Open

Tyler-g-hudson wants to merge 1 commit into
isce-framework:developfrom
Tyler-g-hudson:insar_cfg_naming_doc

Conversation

@Tyler-g-hudson

Copy link
Copy Markdown
Contributor

The documentation in the default runconfig currently isn't clear about how the sas_output_file input maps to the set of output filenames in InSAR. The wording is currently:

            # In INSAR mode, GUNW, GOFF, RIFG, ROFF, and RUNW will be prepended
            # to sas_output_file

Which is technically true but not specific. What actually happens is that a lambda splits sas_output_file into its' directory part and filename part, e.g. outputs/ and product.h5, then prepends the product name(s) to the filename part with an underscore and recombines it all together e.g. outputs/GUNW_product.h5, outputs/RIFG_product.h5 and so on.

The code that does this is in h5_prep.py:

    # dict keying product type to dict of product type key(s) to output(s)
    # following lambda creates subproduct specific output path
    insar_path = lambda out_path, product: \
        os.path.join(os.path.dirname(out_path),
                     product + '_' + os.path.basename(out_path))

@Tyler-g-hudson Tyler-g-hudson added the documentation Improvements or additions to documentation label Nov 5, 2026

@xhuang-jpl xhuang-jpl left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @Tyler-g-hudson , LGTM

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants