Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

DOC: Convert Orientations To Rodrigues Geometry help page says Rodrigues space, but the filter writes stereographic coordinates

Aperta Adatta ai principianti
  • Qualcosa non va?
#1,846 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 4 giorni

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
68/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
cpp
Ambito
documentation

Direzione di ricerca

Leggi src/Plugins/OrientationAnalysis/docs/ConvertOrientationsToVertexGeometryFilter.md e confronta la didascalia con l’implementazione in ConvertOrientationsToVertexGeometry.cpp intorno alla riga 207. Aggiorna il testo della guida per descrivere le coordinate stereografiche scritte dal filtro; l’issue lascia aperta la questione se debba cambiare anche il nome visualizzato del filtro. Il lavoro è completato quando la pagina descrive correttamente le coordinate e la decisione sul nome è risolta.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

documentation

Summary

The help page for Convert Orientations To Rodrigues Geometry contradicts itself and the code about which coordinates the filter creates.

What is requested: correct the description so that it names the coordinates the filter actually writes.

Why it is needed: a reader who takes the page at its word expects Rodrigues vectors. Rodrigues coordinates are unbounded: their length is tan(ω/2). The filter's vertices are stereographic coordinates, which stay inside the unit sphere. Measurements or plots built on the wrong space give wrong results, and it is hard to see why.

How it works now (develop at 2eb6b878f6ff408d1454754d4c0e63edd676d7e0):

  • The algorithm converts each orientation to a quaternion and writes its stereographic projection as the vertex coordinates (ConvertOrientationsToVertexGeometry.cpp, line 207: QuaternionDType(quat.getPositiveOrientation()).toStereographic()).
  • The first sentence of the description agrees with the code: "For each orientation a point inside the stereographic sphere of radius=1 is generated."
  • The caption of the first image does not: "This is an image of the conversion of a data set of rotation point group 432 into Rodrigues space." (ConvertOrientationsToVertexGeometryFilter.md line 11)
  • The filter's display name, "Convert Orientations To Rodrigues Geometry", and the page title also say Rodrigues. The class name (ConvertOrientationsToVertexGeometryFilter) does not.

Where it applies: src/Plugins/OrientationAnalysis/docs/ConvertOrientationsToVertexGeometryFilter.md, and possibly the filter's display name in ConvertOrientationsToVertexGeometryFilter.cpp.

A caption that matches the code could read: "This is an image of the conversion of a data set of rotation point group 432 into stereographic coordinates."

Still open: whether to rename the filter's display name too. That changes what users see in the filter list.

Found while reviewing #1838, which documents that these coordinates have no length unit.

Lingua principale
C++
Stelle
18
Fork
15
Merge medio
4g 7h
PR unite (30g)
21

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di BlueQuartzSoftware/simplnx

Tutte le issue di BlueQuartzSoftware/simplnx

Issue simili

Altre issue su C++

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.