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

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

Aperta Adatta ai principianti
  • Qualcosa non va?
#1,886 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
76/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
cpp
Ambito
backend, documentation

Direzione di ricerca

Leggi src/Plugins/SimplnxCore/docs/ComputeFeaturePhasesBinaryFilter.md e le definizioni dei parametri in src/Plugins/SimplnxCore/src/SimplnxCore/Filters/ComputeFeaturePhasesBinaryFilter.cpp. Aggiorna la documentazione, il testo di aiuto del parametro di output e il separatore per descrivere un array per Feature indicizzato per Feature Id, incluso il comportamento delle maschere miste. Il lavoro è completo quando queste descrizioni specificano in modo coerente una Feature Attribute Matrix; l’issue lascia aperte le questioni della convalida preflight e del test esemplificativo.

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

Descrizione

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.

Lingua principale
C++
Stelle
18
Fork
15
Merge medio
5g 1h
PR unite (30g)
22

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.