ENH: Add a bulk mask read to MaskCompare and use it for every mask read

Abierto
#1,895 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 6 días

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
35/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
cpp
Área
backend, data

Línea de trabajo

Start with src/simplnx/Utilities/MaskCompareUtilities.hpp and .cpp to understand the existing mask interfaces, then inspect the listed OrientationAnalysis and SimplnxCore algorithms that bulk-read typed mask stores. Add a bulk read that reports transfer failures, route those algorithms through MaskCompare, and add the rule to docs/Code_Style_Guide.md. Done means in-core Release performance and out-of-core [ooc] tests meet the stated requirements.

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

Descripción

enhancement Out-of-Core

Summary

Request: give MaskCompare a bulk read of a range of mask values that works for bool and uint8 masks, on in-memory and out-of-core stores, without making in-core algorithms slower. Then change every algorithm that reads a mask to read it through MaskCompare, instead of reading the typed mask stores itself.

Why: today a mask can be read in two different ways, and both are copied around the code base.

  • MaskCompare (MaskCompareUtilities.hpp) handles bool and uint8 masks behind one interface, but it reads one element at a time through the virtual isTrue(index), bothTrue() and bothFalse(). On an out-of-core store, each element read can load a whole chunk, so algorithms that are optimized for out-of-core data do not use it for their main loops.
  • Those algorithms read the mask in bulk instead. Each one checks whether the mask is a UInt8Array or a BoolArray, calls copyIntoBuffer() on the matching store, and copies a bool mask through a contiguous bool scratch buffer, because std::vector<bool> is not contiguous. Each algorithm writes this branch itself.
  • A new algorithm then has to choose between a convenient helper that is slow out-of-core and a hand-written copy of the bulk pattern. Code that reads a mask only with getDataAs<BoolArray>() gets nullptr for a uint8 mask and silently ignores it.

Where it applies:

  • MaskCompare, BoolMaskCompare, UInt8MaskCompare and InstantiateMaskCompare() in src/simplnx/Utilities/MaskCompareUtilities.hpp and .cpp.
  • 27 files call InstantiateMaskCompare() (at 6dd86c67d).
  • These algorithms bulk-read the typed mask stores themselves. Several of them also use MaskCompare for element access, and some handle only one of the two mask types. Each one needs to be checked:
    • OrientationAnalysis: AlignSectionsMisorientation, AlignSectionsMutualInformation, BadDataNeighborOrientationCheckScanline, CAxisSegmentFeatures, ComputeFZQuaternions, EBSDSegmentFeatures, WriteStatsGenOdfAngleFile
    • SimplnxCore: AlignSectionsFeatureCentroid, ComputeArrayHistogram, ComputeArrayHistogramByFeature, ComputeArrayStatistics, ComputeFeaturePhasesBinary, CreateColorMapScanline, DBSCANScanline, ErodeDilateMask, ExtractVertexGeometry
  • Out-of-tree plugins, such as SimplnxReview, may contain the same pattern.

Requirements:

  • The bulk read returns a Result for a failed transfer.
  • In-core performance must not regress: compare the changed algorithms before and after in an in-core Release build.
  • Out-of-core behavior must not regress: run the [ooc] tests in the out-of-core build.
  • When MaskCompare has the bulk read, add a rule to docs/Code_Style_Guide.md that algorithms read masks through MaskCompare, in the same change.

The exact API (the signature of the bulk read, and whether it fills a uint8 or a bool buffer) is still open.

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

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.