Skip to content

Update documentation for distance-based localization - #14312

Open
oddvarlia wants to merge 1 commit into
equinor:mainfrom
oddvarlia:master
Open

Update documentation for distance-based localization#14312
oddvarlia wants to merge 1 commit into
equinor:mainfrom
oddvarlia:master

Conversation

@oddvarlia

Copy link
Copy Markdown
Contributor

**Add some more details for how distance-based localization works and an illustration **

Resolves: #14300

@codecov-commenter

Copy link
Copy Markdown

❌ 1 Tests Failed:

Tests completed Failed Passed Skipped
86 1 85 0
View the top 1 failed test(s) by shortest run time
tests/ert/ui_tests/gui/test_docs_screenshots.py::test_that_all_png_files_under_the_docs_folder_has_been_considered_for_testing
Stack Traces | 0.052s run time
source_root = PosixPath('.../work/ert/ert')

    def test_that_all_png_files_under_the_docs_folder_has_been_considered_for_testing(
        source_root: Path,
    ):
        docs_folder = source_root / "docs"
        pngs_files_in_docs = set(docs_folder.rglob("*.png"))
    
        considered_pngs = {
            file
            for pattern in (
                *PNGS_NOT_APPLICABLE_FOR_GENERATION,
                *PNGS_TESTED_FOR_CHANGE,
                *TODOS,
            )
            for file in source_root.glob(pattern)
        }
    
        uncategorized_png_files = {
            str(file.relative_to(source_root))
            for file in pngs_files_in_docs - considered_pngs
        }
    
        newline = "\n  - "
>       assert not uncategorized_png_files, (
            "The following uncategorised png file(s) have been detected under the docs "
            f"folder:\n  - {newline.join(uncategorized_png_files)}\n"
            "If this is a screenshot of the gui consider adding a screenshot test for it\n"
            "and add the filepath to PNGS_TESTED_FOR_CHANGE list.\n"
            "Alternatively, add the filepath to either the TODOS or\n"
            "PNGS_NOT_APPLICABLE_FOR_GENERATION lists"
        )
E       AssertionError: The following uncategorised png file(s) have been detected under the docs folder:
E           - .../getting_started/howto/illustrating_influence_range.png
E         If this is a screenshot of the gui consider adding a screenshot test for it
E         and add the filepath to PNGS_TESTED_FOR_CHANGE list.
E         Alternatively, add the filepath to either the TODOS or
E         PNGS_NOT_APPLICABLE_FOR_GENERATION lists
E       assert not {'.../getting_started/howto/illustrating_influence_range.png'}

.../ui_tests/gui/test_docs_screenshots.py:524: AssertionError

To view more test analytics, go to the Test Analytics Dashboard
📋 Got 3 mins? Take this short survey to help us improve Test Analytics.

@xjules xjules added this to SCOUT Aug 28, 2026
@xjules xjules moved this to Ready for Review in SCOUT Aug 28, 2026

For theoretical background, see :ref:`distance_based_localization`.

Briefly how it works

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.

there is already a section How it works

---------------------

In distance-based localization, lateral distance (not including vertical distance)
is measured by Euclidean distance by using the (x, y) coordinates of the

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.

In distance-based localization, lateral (Euclidean) distance is estimated between the observation coordinate and field parameter location. This distance neglects vertical distance and uses purely horizontal one.

The implemented method ...

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

Labels

None yet

Projects

Status: Ready for Review

Development

Successfully merging this pull request may close these issues.

Comments to the documentation in the section called 'Distance-Based Localization'

3 participants