Add default fractions to graphical_component_analysis #103
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… `components` module.
cgohlke
reviewed
Aug 21, 2024
There was a problem hiding this comment.
The description of the fractions parameter need to be updated:
fractions: array_like or int, optional
Number of equidistant fractions, or 1D array of fraction values.
Fraction values must be in range [0.0, 1.0].
If an integer, ``numpy.linspace(0.0, 1.0, fractions)`` fraction values
are used.
If None (default), the number of fractions is determined from the
longest distance between any pair of components and the radius of
the cursor (see Notes below).
src/phasorpy/components.py
Outdated
Comment on lines
186
to
196
| If no `fractions` are provided, the number of fractions (N) used is | ||
| determined by the longest distance between any pair of components (D) | ||
| and by the radius of the cursor (R): | ||
|
|
||
| .. math:: | ||
| N = \frac{2*D}{R} + 1 | ||
|
|
||
| The fractions can be retrieved by: | ||
|
|
||
| ``fractions = numpy.linspace(0.0, 1.0, len(counts[0]))`` | ||
|
|
There was a problem hiding this comment.
If no `fractions` are provided, the number of fractions (:math:`N`) used
is determined from the longest distance between any pair of components
(:math:`D`) and the radius of the cursor (:math:`R`):
.. math::
N = \frac{2 \cdot D}{R} + 1
The fractions can be retrieved by:
.. code-block:: python
fractions = numpy.linspace(0.0, 1.0, len(counts[0]))
src/phasorpy/components.py
Outdated
| ) | ||
| longest_distance = max(longest_distance, length) | ||
| fractions = numpy.linspace( | ||
| 0.0, 1.0, int(longest_distance / (radius / 2) + 1) |
…ns` default calculation and description. Round number of default fractions calculation.
cgohlke
approved these changes
Aug 22, 2024
schutyb
pushed a commit
to schutyb/phasorpy
that referenced
this pull request
Aug 30, 2024
schutyb
pushed a commit
to schutyb/phasorpy
that referenced
this pull request
Aug 30, 2024
schutyb
pushed a commit
to schutyb/phasorpy
that referenced
this pull request
Aug 30, 2024
schutyb
pushed a commit
to schutyb/phasorpy
that referenced
this pull request
Aug 30, 2024
schutyb
pushed a commit
to schutyb/phasorpy
that referenced
this pull request
Aug 30, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR proposes the addition of default values for
fractionsin thegraphical_component_analysisfunction in thecomponentsmodule. This was further discussed in #83, where the reasons for the proposed changes are stated.Release note
Summarize the changes in the code block below to be included in the
release notes:
Checklist