Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

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

Abierto Apto para principiantes
  • ¿Algo no está bien?
#1,886 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 4 días

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
76/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
cpp
Área
backend, documentation

Línea de trabajo

Lee src/Plugins/SimplnxCore/docs/ComputeFeaturePhasesBinaryFilter.md y las definiciones de parámetros en src/Plugins/SimplnxCore/src/SimplnxCore/Filters/ComputeFeaturePhasesBinaryFilter.cpp. Actualiza la documentación, el texto de ayuda del parámetro de salida y el separador para describir un array por Feature indexado por Feature Id, incluido el comportamiento de las máscaras mixtas. El trabajo estará completo cuando esas descripciones especifiquen de forma coherente una Feature Attribute Matrix; el issue deja abiertas las preguntas sobre la validación de preflight y la prueba de ejemplo.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
C++
Estrellas
18
Forks
15
Merge medio
4 d 20 h
PR fusionados (30 d)
23

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de BlueQuartzSoftware/simplnx

Todos los issues de BlueQuartzSoftware/simplnx

Issues similares

Más issues de C++

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.