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

Đang mở
#1,895 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 6 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
35/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
cpp
Lĩnh vực
backend, data

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.

Ngôn ngữ chính
C++
Star
18
Fork
15
Merge trung bình
4 ngày 23 giờ
Pull request đã merge (30 ngày)
42

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của BlueQuartzSoftware/simplnx

Tất cả issue của BlueQuartzSoftware/simplnx

Issue tương tự

Thêm issue về C++

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.