DOC: Align Sections (Feature Centroid) says shifts are rounded, but they are truncated

Ouverte Adaptée aux débutants
#1,978 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 6 jours

Personne n'a encore pris cette issue.

Évaluation

Difficulté
2/5
Temps estimé
1-3 heures
Accessibilité débutants
65/100
Type d'issue
Documentation
Clarté
Plutôt claire
Activité
Active
Stack technique
cpp
Domaine
documentation

Piste de recherche

Lisez le calcul du décalage dans AlignSectionsFeatureCentroid.cpp (lignes 17-25), qui tronque vers zéro via static_cast<int64>. Modifiez ensuite AlignSectionsFeatureCentroidFilter.md : la ligne 21 indique que les décalages sont arrondis au multiple de Cell le plus proche, et la ligne 38 qu'ils sont arrondis à des incréments entiers de voxel. C'est terminé lorsque les deux lignes indiquent que les décalages sont tronqués vers zéro. Ne modifiez pas l'arithmétique, car le ticket laisse cette décision ouverte.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

documentation

Summary

The documentation of Align Sections (Feature Centroid) says that the section shifts are rounded to the nearest cell. The code truncates them toward zero. The page should describe what the code does.

How it works now. AlignSectionsFeatureCentroid.cpp lines 17-25 converts a centroid difference to a whole-cell shift with static_cast<int64>((centroid - referenceCentroid) / spacing). This truncates toward zero: a difference of +1.75 cells gives a shift of +1, and -1.75 cells gives -1. Both the in-core (Direct) and the out-of-core (Scanline) paths use this function.

What the documentation says. AlignSectionsFeatureCentroidFilter.md line 21 says "Round the shifts to the nearest multiple of the Cell resolution", and line 38 says "Shifts are rounded to integer voxel increments". A user who reads this expects +1.75 cells to give +2.

Why it matters. The documented and actual shifts differ by one cell whenever the fractional part of a centroid difference is 0.5 or more. A user who checks the output against the documentation sees a wrong result.

Where it applies. Only the documentation page. The request is to state that shifts are truncated toward zero. Whether the arithmetic should instead change to rounding (which would change results compared with DREAM3D 6.5.171 and the existing exemplars) is still open.

Found during the review of the #1908 batch 4 changes (items L77 and L78). No open issue covered it.

Langage dominant
C++
Étoiles
18
Forks
15
Merge moyen
4 j 23 h
PR mergées (30 j)
42

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de BlueQuartzSoftware/simplnx

Toutes les issues de BlueQuartzSoftware/simplnx

Issues similaires

Plus d'issues C++

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.