Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
c4775b4
BUG: AlignSectionsFeatureCentroid - Shift the top section with a nonz…
imikejackson Nov 3, 2026
2ac9a35
BUG: ComputeFeatureClustering - Use every random reference pair in th…
imikejackson Nov 3, 2026
baf638a
BUG: ComputeVectorColors - Color a trend of exactly 360 degrees red
imikejackson Nov 3, 2026
4eb2444
BUG: QuickSurfaceMesh - Transfer cell and feature data in Face Labels…
imikejackson Nov 3, 2026
19acd18
BUG: ImageRotationUtilities - Take grid-rotation output spacing from …
imikejackson Nov 4, 2026
0f2974f
BUG: WriteVtkRectilinearGrid - Write ASCII coordinates with full prec…
imikejackson Nov 4, 2026
118f5cc
BUG: WriteVtk(RectilinearGrid|StructuredPoints) - Reject arrays with …
imikejackson Nov 4, 2026
57e9a75
BUG: AddBadData - Reject StringArray and NeighborList cell arrays in …
imikejackson Nov 4, 2026
05844c4
BUG: ExecuteProcess - Do not keep separator spaces in parsed arguments
imikejackson Nov 4, 2026
0fdae74
BUG: FeatureFaceCurvature - Write NaN for a one-triangle Feature face…
imikejackson Nov 4, 2026
c6c9223
BUG: ReadDREAM3D - Warn when an Include List path is not in the file
imikejackson Nov 3, 2026
b14dbe1
BUG: ReadStlFile - Reject a triangle count that the file is too short…
imikejackson Nov 3, 2026
47a1347
BUG: ReadVtkStructuredPoints - Read 2D and 1D files and reject a zero…
imikejackson Nov 3, 2026
39414a2
BUG: ReadH5OimData - Stack the selected scans in the chosen Z order
imikejackson Nov 3, 2026
efbaae5
BUG: WriteINLFile - Write the TSL symmetry code of every Laue class i…
imikejackson Nov 3, 2026
3fb7e60
BUG: WriteStatsGenOdfAngleFile - Write a colon when the Colon delimit…
imikejackson Nov 3, 2026
3f41bc7
BUG: ReadImage - Reject a TIFF page with a different pixel layout bef…
imikejackson Nov 4, 2026
f400b34
BUG: ProjectionImageFilters - Add Copy Non-Cell Attribute Matrices an…
imikejackson Nov 4, 2026
f7516fb
BUG: ReadImageStack - Report a slice with a different data type inste…
imikejackson Nov 4, 2026
a95cf0c
REV: ProjectionImageFilters - Keep only the in-place warning fix
imikejackson Nov 4, 2026
5ebb951
REV: AlignSectionsList - Ignore row 0 of the shift file again
imikejackson Nov 4, 2026
17c76ac
REV: AlignSectionsFeatureCentroid - Give an empty slice a zero shift
imikejackson Nov 4, 2026
a9cae87
REV: ReadImageStack - Check the slice data type where the slice is read
imikejackson Nov 4, 2026
cfa0e7e
REV: ImageRotationUtilities - Use the classified source axis for grid…
imikejackson Nov 4, 2026
4ca210f
REV: ReadVtkStructuredPoints - Center a plane or line on its VTK posi…
imikejackson Nov 4, 2026
123c01e
REV: ReadImage - State only what the multi-page TIFF checks compare
imikejackson Nov 4, 2026
ae1cab1
REV: AlignSectionsFeatureCentroid - Reject an out-of-range Reference …
imikejackson Nov 5, 2026
4533bbc
DOC: ProjectionImageFilters - Qualify which objects warning -8343 names
imikejackson Nov 5, 2026
857b89f
REV: Tests - Drop unneeded plugin loading, fix tags and split long co…
imikejackson Nov 13, 2026
23eddcf
REV: NXImageProcessing - Use the renamed plugin prefix in new test names
imikejackson Nov 13, 2026
66966ce
REV: ComputeFeatureClustering - Count every reference pair in the fou…
imikejackson Nov 13, 2026
4830a17
REV: Initialize projection test preferences directly
jmarquisbq Nov 13, 2026
92823db
REV: Remove unused include from WriteINLFile tests
jmarquisbq Nov 13, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions docs/Coding_Knowledge_Base.md
Original file line number Diff line number Diff line change
Expand Up @@ -1147,9 +1147,10 @@ set.
**Rule:** a test calls `UnitTest::LoadPlugins();` only when it calls `createFilter()` on the filter list, loads a
pipeline (`Pipeline::FromJson()`, `FromFile()`, `FromSIMPLJson()`, `FromSIMPLFile()`; every SIMPL
backwards-compatibility test does), or runs a filter whose code gets other filters from the filter list (`ReadH5Ebsd`
does). A test that constructs a filter or algorithm directly does not call it. A test that needs it calls it itself:
ctest runs each visible, individually registered `TEST_CASE` in its own process (a few hidden groups, such as
`[.OocStoreContract]`, run together in one).
does). Each test that needs plugin loading calls it itself. CTest runs each visible, individually registered
`TEST_CASE` in its own process. A few hidden groups, such as `[.OocStoreContract]`, run together in one process.
`UnitTest::PreferencesSentinel` needs an existing `Application` instance. If the test only needs that instance,
call `Application::GetOrCreateInstance()` before constructing the sentinel.

**Example of the broken rule:** the synthetic tuple-mismatch cases of `ComputeAvgCAxesTest.cpp` and
`ReplaceElementAttributesWithNeighborValuesTest.cpp` load the plugins although they construct the filter directly, and
Expand All @@ -1158,10 +1159,12 @@ ctest runs each visible, individually registered `TEST_CASE` in its own process
**Why:** the call loads every plugin library and fails the test when one does not load, so an unneeded call makes a
test fail for a plugin it does not use.

**What to look for:** `UnitTest::LoadPlugins()` in a test with no UUID lookup, pipeline load or registry-dependent
subfilter.
**What to look for:** `UnitTest::LoadPlugins()` in a test with no UUID lookup, pipeline load, registry-dependent
subfilter, or other need for plugin registration. A `PreferencesSentinel` constructed before the `Application`
instance exists dereferences a null pointer (PR #1915).

**Pattern to use:** direct filter construction without plugin loading, as in `test/GeometryTest.cpp`.
**Pattern to use:** construct filters directly as in `test/GeometryTest.cpp`. For a test that also uses a sentinel,
initialize the `Application` directly as in the projection warning cases in `MaximumProjectionImageFilterTest.cpp`.

### Give Catch2 a bool when you compare file times

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The **Projection Dimension** selects the collapsed axis: 0 = X, 1 = Y, 2 = Z.

The **Foreground Value** and **Background Value** are supplied as floating-point numbers and cast to the input element type; the foreground equality test is performed in the input element type. This matches the legacy ITK Binary Projection accumulator, which initializes each column to background and switches it to foreground the first time a voxel equal to the foreground value is encountered.

When **Perform In-Place** is enabled, the input Image Geometry is replaced by the projected (collapsed) geometry containing the output array. Because the whole original geometry is replaced, any *other* arrays that were in its cell-data Attribute Matrix are discarded (they have the original, non-collapsed shape and cannot survive the projection); the filter emits a preflight warning listing them. Disable **Perform In-Place** to keep the original geometry: the input geometry is then preserved and the result is written to a newly created geometry named by **Created Image Geometry**, whose cell-data Attribute Matrix name is copied from the input geometry.
When **Perform In-Place** is enabled, the input Image Geometry is replaced by the projected (collapsed) geometry containing the output array. Because the whole original geometry is replaced, any *other* arrays that were in its cell-data Attribute Matrix are discarded (they have the original, non-collapsed shape and cannot survive the projection). Preflight warning `-8343` names the discarded objects by their full paths, including other children of the geometry such as Cell Feature Data. There is one exception when the input array is outside Cell Data. A Cell Data array with the same name as the input array is discarded but is not named in the warning. Disable **Perform In-Place** to keep the original geometry: the input geometry is then preserved and the result is written to a newly created geometry named by **Created Image Geometry**, whose cell-data Attribute Matrix name is copied from the input geometry.

The input array must be single-component (scalar) and one of the scalar numeric types (`int8`, `uint8`, `int16`, `uint16`, `int32`, `uint32`, `int64`, `uint64`, `float32`, or `float64`). This is an ITK-free, out-of-core-capable reimplementation of the legacy ITK Binary Projection Image Filter.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Collapses the selected **Projection Dimension** of a scalar Image Geometry to a

The **Projection Dimension** selects the collapsed axis: 0 = X, 1 = Y, 2 = Z.

When **Perform In-Place** is enabled, the input Image Geometry is replaced by the projected (collapsed) geometry containing the output array. Because the whole original geometry is replaced, any *other* arrays that were in its cell-data Attribute Matrix are discarded (they have the original, non-collapsed shape and cannot survive the projection); the filter emits a preflight warning listing them. Disable **Perform In-Place** to keep the original geometry: the input geometry is then preserved and the result is written to a newly created geometry named by **Created Image Geometry**, whose cell-data Attribute Matrix name is copied from the input geometry.
When **Perform In-Place** is enabled, the input Image Geometry is replaced by the projected (collapsed) geometry containing the output array. Because the whole original geometry is replaced, any *other* arrays that were in its cell-data Attribute Matrix are discarded (they have the original, non-collapsed shape and cannot survive the projection). Preflight warning `-8343` names the discarded objects by their full paths, including other children of the geometry such as Cell Feature Data. There is one exception when the input array is outside Cell Data. A Cell Data array with the same name as the input array is discarded but is not named in the warning. Disable **Perform In-Place** to keep the original geometry: the input geometry is then preserved and the result is written to a newly created geometry named by **Created Image Geometry**, whose cell-data Attribute Matrix name is copied from the input geometry.

The input array must be single-component (scalar) and one of the supported types: `uint8`, `int16`, `uint16`, or `float32`. This is an ITK-free, out-of-core-capable reimplementation of the legacy ITK Maximum Projection Image Filter.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The **Projection Dimension** selects the collapsed axis: 0 = X, 1 = Y, 2 = Z.

The output element type is always **Float64** (double), regardless of the input element type, matching the legacy ITK Mean Projection Image Filter (the mean of an integer column is generally not an integer). The mean is accumulated with a Kahan-compensated running sum so that long columns do not lose precision.

When **Perform In-Place** is enabled, the input Image Geometry is replaced by the projected (collapsed) geometry containing the output array. Because the whole original geometry is replaced, any *other* arrays that were in its cell-data Attribute Matrix are discarded (they have the original, non-collapsed shape and cannot survive the projection); the filter emits a preflight warning listing them. Disable **Perform In-Place** to keep the original geometry: the input geometry is then preserved and the result is written to a newly created geometry named by **Created Image Geometry**, whose cell-data Attribute Matrix name is copied from the input geometry.
When **Perform In-Place** is enabled, the input Image Geometry is replaced by the projected (collapsed) geometry containing the output array. Because the whole original geometry is replaced, any *other* arrays that were in its cell-data Attribute Matrix are discarded (they have the original, non-collapsed shape and cannot survive the projection). Preflight warning `-8343` names the discarded objects by their full paths, including other children of the geometry such as Cell Feature Data. There is one exception when the input array is outside Cell Data. A Cell Data array with the same name as the input array is discarded but is not named in the warning. Disable **Perform In-Place** to keep the original geometry: the input geometry is then preserved and the result is written to a newly created geometry named by **Created Image Geometry**, whose cell-data Attribute Matrix name is copied from the input geometry.

The input array must be single-component (scalar) and one of the scalar numeric types (`int8`, `uint8`, `int16`, `uint16`, `int32`, `uint32`, `int64`, `uint64`, `float32`, or `float64`). This is an ITK-free, out-of-core-capable reimplementation of the legacy ITK Mean Projection Image Filter.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Collapses the selected **Projection Dimension** of a scalar Image Geometry to a

The **Projection Dimension** selects the collapsed axis: 0 = X, 1 = Y, 2 = Z.

When **Perform In-Place** is enabled, the input Image Geometry is replaced by the projected (collapsed) geometry containing the output array. Because the whole original geometry is replaced, any *other* arrays that were in its cell-data Attribute Matrix are discarded (they have the original, non-collapsed shape and cannot survive the projection); the filter emits a preflight warning listing them. Disable **Perform In-Place** to keep the original geometry: the input geometry is then preserved and the result is written to a newly created geometry named by **Created Image Geometry**, whose cell-data Attribute Matrix name is copied from the input geometry.
When **Perform In-Place** is enabled, the input Image Geometry is replaced by the projected (collapsed) geometry containing the output array. Because the whole original geometry is replaced, any *other* arrays that were in its cell-data Attribute Matrix are discarded (they have the original, non-collapsed shape and cannot survive the projection). Preflight warning `-8343` names the discarded objects by their full paths, including other children of the geometry such as Cell Feature Data. There is one exception when the input array is outside Cell Data. A Cell Data array with the same name as the input array is discarded but is not named in the warning. Disable **Perform In-Place** to keep the original geometry: the input geometry is then preserved and the result is written to a newly created geometry named by **Created Image Geometry**, whose cell-data Attribute Matrix name is copied from the input geometry.

The input array must be single-component (scalar) and one of the supported types: `uint8`, `int16`, `uint16`, or `float32`. This is an ITK-free, out-of-core-capable reimplementation of the legacy ITK Median Projection Image Filter.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Collapses the selected **Projection Dimension** of a scalar Image Geometry to a

The **Projection Dimension** selects the collapsed axis: 0 = X, 1 = Y, 2 = Z.

When **Perform In-Place** is enabled, the input Image Geometry is replaced by the projected (collapsed) geometry containing the output array. Because the whole original geometry is replaced, any *other* arrays that were in its cell-data Attribute Matrix are discarded (they have the original, non-collapsed shape and cannot survive the projection); the filter emits a preflight warning listing them. Disable **Perform In-Place** to keep the original geometry: the input geometry is then preserved and the result is written to a newly created geometry named by **Created Image Geometry**, whose cell-data Attribute Matrix name is copied from the input geometry.
When **Perform In-Place** is enabled, the input Image Geometry is replaced by the projected (collapsed) geometry containing the output array. Because the whole original geometry is replaced, any *other* arrays that were in its cell-data Attribute Matrix are discarded (they have the original, non-collapsed shape and cannot survive the projection). Preflight warning `-8343` names the discarded objects by their full paths, including other children of the geometry such as Cell Feature Data. There is one exception when the input array is outside Cell Data. A Cell Data array with the same name as the input array is discarded but is not named in the warning. Disable **Perform In-Place** to keep the original geometry: the input geometry is then preserved and the result is written to a newly created geometry named by **Created Image Geometry**, whose cell-data Attribute Matrix name is copied from the input geometry.

The input array must be single-component (scalar) and one of the supported types: `uint8`, `int16`, `uint16`, or `float32`. This is an ITK-free, out-of-core-capable reimplementation of the legacy ITK Minimum Projection Image Filter.

Expand Down
4 changes: 4 additions & 0 deletions src/Plugins/NXImageProcessing/docs/ReadImageFilter.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ The following image types are supported:
- TIFF / TIF, including multi-page TIFF read as a 3D Z-stack (via libtiff)
- NRRD (`.nrrd` attached, `.nhdr` detached) (ITK-free, zlib only)

All pages of a multi-page TIFF must have the same dimensions, component count, and scalar type. The filter compares the number of bytes per pixel and the dimensions of each page it reads with page 0. It does not compare component counts or scalar types. A change in component count or scalar type can go undetected when the number of bytes per pixel stays the same. This can cause incorrect pixel values.

If the first page is 8-bit RGB and a later page is 8-bit grayscale, the filter fails with error `-2007` when it reads that later page. The number of bytes per pixel differs (3 and 1), so it fails before it copies any pixels of that page. This intentionally differs from DREAM3D 6.5.171, which could crash on mixed-page TIFF files (KI-053).

### NRRD Volumes

For a [NRRD](https://teem.sourceforge.net/nrrd/format.html) input (attached single-file `.nrrd`, or detached `.nhdr` + external data file), the geometry is built directly from the NRRD header. Supported header features:
Expand Down
2 changes: 2 additions & 0 deletions src/Plugins/NXImageProcessing/docs/ReadImageStackFilter.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,8 @@ The *Output Data Type* parameter provides the following choices:
- **uint16 [1]**: Convert image data to 16-bit unsigned integer.
- **uint32 [2]**: Convert image data to 32-bit unsigned integer.

Preflight reads only the first file's image header. During execution, the filter checks each decoded slice kept by the Z crop before further processing or copying it into the stack. When *Set Image Data Type* is off, the first file in the list sets the stack's output type, also when the Z crop removes that file. If a slice cannot match the stack's output type, error `-23534` names the file and the expected and actual types. Earlier slices may already have been written when this error occurs. Mixed uint8 and uint16 slices can be read together when *Set Image Data Type* converts them to the same output type. This intentionally differs from the failure described in DREAM3D 6.5.171 errata KI-051.

### Cropping Caveats

The user can crop the incoming image geometry using the Cropping Options section. The cropping type options are:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The **Projection Dimension** selects the collapsed axis: 0 = X, 1 = Y, 2 = Z.

The standard deviation is the *sample* standard deviation: the column mean is formed with the population divisor *N*, but the sum of squared deviations is divided by *N − 1* before taking the square root, matching the legacy ITK Standard Deviation Projection Image Filter. A column of length 1 (or a degenerate projected axis) yields 0. The output element type is always **Float64** (double), regardless of the input element type. The statistic uses Welford's online update to avoid cancellation when large values have small differences.

When **Perform In-Place** is enabled, the input Image Geometry is replaced by the projected (collapsed) geometry containing the output array. Because the whole original geometry is replaced, any *other* arrays that were in its cell-data Attribute Matrix are discarded (they have the original, non-collapsed shape and cannot survive the projection); the filter emits a preflight warning listing them. Disable **Perform In-Place** to keep the original geometry: the input geometry is then preserved and the result is written to a newly created geometry named by **Created Image Geometry**, whose cell-data Attribute Matrix name is copied from the input geometry.
When **Perform In-Place** is enabled, the input Image Geometry is replaced by the projected (collapsed) geometry containing the output array. Because the whole original geometry is replaced, any *other* arrays that were in its cell-data Attribute Matrix are discarded (they have the original, non-collapsed shape and cannot survive the projection). Preflight warning `-8343` names the discarded objects by their full paths, including other children of the geometry such as Cell Feature Data. There is one exception when the input array is outside Cell Data. A Cell Data array with the same name as the input array is discarded but is not named in the warning. Disable **Perform In-Place** to keep the original geometry: the input geometry is then preserved and the result is written to a newly created geometry named by **Created Image Geometry**, whose cell-data Attribute Matrix name is copied from the input geometry.

The input array must be single-component (scalar) and one of the scalar numeric types (`int8`, `uint8`, `int16`, `uint16`, `int32`, `uint32`, `int64`, `uint64`, `float32`, or `float64`). This is an ITK-free, out-of-core-capable reimplementation of the legacy ITK Standard Deviation Projection Image Filter.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The **Projection Dimension** selects the collapsed axis: 0 = X, 1 = Y, 2 = Z.

The output element type is always **Float64** (double), regardless of the input element type, matching the legacy ITK Sum Projection Image Filter (the sum of an integer column readily overflows a narrow integer type). The sum is accumulated with a Kahan-compensated running sum so that long columns do not lose precision.

When **Perform In-Place** is enabled, the input Image Geometry is replaced by the projected (collapsed) geometry containing the output array. Because the whole original geometry is replaced, any *other* arrays that were in its cell-data Attribute Matrix are discarded (they have the original, non-collapsed shape and cannot survive the projection); the filter emits a preflight warning listing them. Disable **Perform In-Place** to keep the original geometry: the input geometry is then preserved and the result is written to a newly created geometry named by **Created Image Geometry**, whose cell-data Attribute Matrix name is copied from the input geometry.
When **Perform In-Place** is enabled, the input Image Geometry is replaced by the projected (collapsed) geometry containing the output array. Because the whole original geometry is replaced, any *other* arrays that were in its cell-data Attribute Matrix are discarded (they have the original, non-collapsed shape and cannot survive the projection). Preflight warning `-8343` names the discarded objects by their full paths, including other children of the geometry such as Cell Feature Data. There is one exception when the input array is outside Cell Data. A Cell Data array with the same name as the input array is discarded but is not named in the warning. Disable **Perform In-Place** to keep the original geometry: the input geometry is then preserved and the result is written to a newly created geometry named by **Created Image Geometry**, whose cell-data Attribute Matrix name is copied from the input geometry.

The input array must be single-component (scalar) and one of the scalar numeric types (`int8`, `uint8`, `int16`, `uint16`, `int32`, `uint32`, `int64`, `uint64`, `float32`, or `float64`). This is an ITK-free, out-of-core-capable reimplementation of the legacy ITK Sum Projection Image Filter.

Expand Down
Loading