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

DOC: Compute Feature Phases Binary describes a per-Cell output, but writes one value per Feature

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

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

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

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
76/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
cpp
領域
backend, documentation

調査の方向性

src/Plugins/SimplnxCore/docs/ComputeFeaturePhasesBinaryFilter.md と src/Plugins/SimplnxCore/src/SimplnxCore/Filters/ComputeFeaturePhasesBinaryFilter.cpp のパラメーター定義を読みます。ドキュメント、出力パラメーターのヘルプテキスト、separator を更新し、混在するマスクの動作を含めて、Feature Id でインデックス付けされた Feature ごとの配列について説明します。これらの説明で一貫して Feature Attribute Matrix を指定できれば完了です。preflight 検証と例示テストについては、issue で未解決の質問として残されています。

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

説明

documentation

Summary

The documentation and the parameter text of Compute Feature Phases Binary describe a per-Cell output, but the filter writes one value per Feature. A user who follows the documentation gets an array that does not contain what the documentation says.

What the documentation says now

  • The documentation page says that the filter "assigns a binary Ensemble Id number to each Cell", and that "every true Cell is assigned Ensemble 1 and every false Cell is assigned Ensemble 0" (ComputeFeaturePhasesBinaryFilter.md line 9).
  • The output Attribute Matrix parameter is named Cell Data Attribute Matrix, with the help text "The Cell Data Attribute Matrix within the Image Geometry where the Binary Phases Array will be created". The output parameters are under the separator Output Cell Data (ComputeFeaturePhasesBinaryFilter.cpp lines 63-68).

How the filter works now

  • The algorithm uses the Feature Id of each Cell as the output index: featurePhasesCache[featureId] = maskBuffer[index] != 0 (ComputeFeaturePhasesBinary.cpp lines 105-109). Output tuple n is the value for Feature n.
  • When the Cells of one Feature have different mask values, the last Cell of that Feature in Cell order sets the value of the Feature.
  • The output array gets the tuple shape of the selected Attribute Matrix (ComputeFeaturePhasesBinaryFilter.cpp line 98). When a user selects the Cell Attribute Matrix, as the parameter name tells them to, the result is a Cell-sized array. Its first tuples hold one value per Feature, and the other tuples stay 0.
  • This matches the legacy DREAM3D filter FindFeaturePhasesBinary, which creates its output in the Cell Feature Attribute Matrix by default (FindFeaturePhasesBinary.cpp line 56). The output parameter name Binary Feature Phases Array Name and its help text ("to specify to which Ensemble each Feature belongs") also describe a per-Feature array.
  • The exemplar test selects the Cell Attribute Matrix (EBSD Scan Data) as the output location, and compares with a legacy exemplar that is stored there (ComputeFeaturePhasesBinaryTest.cpp line 47).

What is requested

  • The documentation page describes the per-Feature output: the output is indexed by Feature Id, it belongs in a Feature Attribute Matrix, and the last Cell of a Feature with mixed mask values sets the value of that Feature.
  • The output Attribute Matrix parameter, its help text and the Output Cell Data separator describe a Feature Attribute Matrix.

Still open: whether preflight should also reject an output Attribute Matrix that is not a Feature Attribute Matrix, and whether the exemplar test should move its output to the Feature Attribute Matrix.

主要言語
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 を短くまとめたダイジェスト。