Skip to content

Feature: correlation method after mommertz #31

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: develop
Choose a base branch
from

Conversation

ahms5
Copy link
Member

@ahms5 ahms5 commented Apr 25, 2025

Which issue(s) are closed by this pull request?

Closes #12

Changes proposed in this pull request:

  • introduce correlation method after mommertz, in other words, calcualte scattering coefficient from freefield measurements depending on the incident direciton

requires #32

@ahms5 ahms5 added this to the v0.1.0 milestone Apr 25, 2025
@ahms5 ahms5 added documentation Improvements or additions to documentation enhancement New feature or request labels Apr 25, 2025
@ahms5 ahms5 self-assigned this Apr 25, 2025
@ahms5 ahms5 moved this from Backlog to Require review in Weekly Planning May 9, 2025
@ahms5 ahms5 changed the title draft correlation method after mommertz Feature: correlation method after mommertz May 26, 2025
@ahms5 ahms5 requested a review from Copilot May 26, 2025 23:49
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR introduces a new correlation method to calculate the scattering coefficient from free-field measurements based on the Mommertz method. Key changes include:

  • Implementation of the correlation_method in imkar/scattering/freefield.py.
  • Addition of comprehensive tests for the new method in tests/test_scattering_freefield.py.
  • Updates to module exports and documentation to include the new scattering functionality.

Reviewed Changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
tests/test_scattering_freefield.py New tests validating the correlation_method behavior and type checks.
imkar/scattering/freefield.py Implementation of the new correlation_method following Mommertz.
imkar/scattering/init.py Updated module export for scattering functions.
imkar/init.py Updated package initialization to include the scattering module.
docs/modules/imkar.scattering.freefield.rst Documentation update for the new free-field scattering method.
docs/api_reference.rst Reference documentation updated to feature the new module.

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 enhancement New feature or request
Projects
Status: Require review
Development

Successfully merging this pull request may close these issues.

1 participant