Hacktoberfest 2026：メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

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

オープン 初心者向け
  • 何か問題がありますか？
#1,846 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 4 日以内に返信

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
68/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
活発
技術スタック
cpp
領域
documentation

調査の方向性

src/Plugins/OrientationAnalysis/docs/ConvertOrientationsToVertexGeometryFilter.mdを読み、キャプションをConvertOrientationsToVertexGeometry.cppの207行目付近にある実装と比較してください。フィルターが書き込むステレオ投影座標を説明するようにヘルプテキストを更新してください。フィルターの表示名も変更するかどうかは、issueでは未決定です。ページが座標を正確に説明し、命名の決定が解決したら完了です。

索引モデルが issue の本文から書いたものです。

説明

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.

主要言語
C++
スター
18
フォーク
15
平均マージ
4日 20時間
マージ済み PR（30日）
23

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

BlueQuartzSoftware/simplnx のほかの issue

BlueQuartzSoftware/simplnx の issue をすべて見る

似ている issue

C++ の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。