You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/AnacondaPackages.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@
4
4
5
5
These builds can on the order of **multiple hours** to complete on x86 systems that predate Intel 13th Generation processors. Be patient. The build looks like it is stuck but python is just taking it's time to recursively figure out the needed DLLs because ITK and VTK create a ton of DLL libraries. This is especially slow on Windows systems.
Copy file name to clipboardExpand all lines: docs/Build_From_Source.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -78,7 +78,7 @@ This example shows how to configure simplnx to build using Visual Studio IDE
78
78
79
79
```shell
80
80
set BUILD_DIR=VisualStudio
81
-
set VCPKG_INSTALL_ROOT=C:/Appications/vcpkg
81
+
set VCPKG_INSTALL_ROOT=C:/Applications/vcpkg
82
82
cd simplnx
83
83
mkdir %BUILD_DIR%
84
84
cd %BUILD_DIR%
@@ -87,15 +87,15 @@ cmake -G "Visual Studio 17 2022" -A x64 -DCMAKE_TOOLCHAIN_FILE=%VCPKG_INSTALL_RO
87
87
88
88
### Windows with Ninja and IDE of choice (QtCreator, CLion, command line)
89
89
90
-
Adjust the below commands to the sytle of your shell (The below example is done in Windows Command Prompt Batch file style).
90
+
Adjust the below commands to the style of your shell (The below example is done in Windows Command Prompt Batch file style).
91
91
92
-
In this example we are building a Release version of compled into a directory called `Release` inside the source directory. We will be using the `ninja` generator so be sure that ninja.exe is on your PATH
92
+
In this example we are building a Release version compiled into a directory called `Release` inside the source directory. We will be using the `ninja` generator so be sure that ninja.exe is on your PATH
|`ITKImageProcessing_USE_JOB_POOL`|`BOOL`| When `ON` the amount of threads used to build `ITK` library plugin is capped (see `ITKImageProcessing_JOB_POOL`). Some of the `ITK` files more 2+ GB of memory to compile due to heavy templating. This is to prevent sytems from running out of memory during compilation. |
143
+
|`ITKImageProcessing_USE_JOB_POOL`|`BOOL`| When `ON` the amount of threads used to build `ITK` library plugin is capped (see `ITKImageProcessing_JOB_POOL`). Some of the `ITK` files more 2+ GB of memory to compile due to heavy templating. This is to prevent systems from running out of memory during compilation. |
144
144
|`ITKImageProcessing_JOB_POOL`|`STRING`| If `ITKImageProcessing_USE_JOB_POOL` is `ON`, this variable is the maximum number of threads available to the `ITK` plugin during compilation. For example on a system with 32 threads and 64GB of RAM a value of `16` will prevent out-of-memory errors during compilation. |
145
145
|`SIMPLNX_BUILD_TESTS`|`BOOL`| Turning this on will compile the filter/library tests and include them in the all ctests target |
146
146
|`SIMPLNX_BUILD_DOCS`|`BOOL`| Turning this on will build the library/filters documentation, `SPHINX_BUILD_EXECUTABLE` must be defined |
147
147
|`SPHINX_BUILD_EXECUTABLE`|`PATH`| The absolute path to to the sphinx executable; *required* for `SIMPLNX_BUILD_PYTHON_DOCS` and/or `SIMPLNX_BUILD_DOCS`|
148
-
|`SIMPLNX_EXTRA_PLUGINS`|`STRING`| A list of plugin targets (separated by `;`) to include into the library. Currently the only offical additional plugin not bundled is `SimplnxReview` which is untested filters |
149
-
|`SIMPLNX_ENABLE_BENCHMARK_UTILITY`|`BOOL`| Turning this on will include the preffered benchmarking library; Be sure to **add**`benchmark`**to**`VCPKG_MANIFEST_FEATURES`**list**|
148
+
|`SIMPLNX_EXTRA_PLUGINS`|`STRING`| A list of plugin targets (separated by `;`) to include into the library. Currently the only official additional plugin not bundled is `SimplnxReview` which is untested filters |
149
+
|`SIMPLNX_ENABLE_BENCHMARK_UTILITY`|`BOOL`| Turning this on will include the preferred benchmarking library; Be sure to **add**`benchmark`**to**`VCPKG_MANIFEST_FEATURES`**list**|
Copy file name to clipboardExpand all lines: docs/PortingFilters.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -73,7 +73,7 @@ folder.
73
73
74
74
The backwards compatibility will begin testing immediately as long as the filter is registered in the `PluginNameUUIDLegacyMapping.hpp` file. The only exception is new filters that have no **SIMPL** equivalent.
75
75
76
-
To run the test in advance select the `conversion_test` ctest target and run it. Most of the errors are from issues in the filter's `FromSIMPLJson()` function. The error messages should guide you towards a solution. The following cases are exceptions that can be hard to diagnose without apriori knowledge.
76
+
To run the test in advance select the `conversion_test` ctest target and run it. Most of the errors are from issues in the filter's `FromSIMPLJson()` function. The error messages should guide you towards a solution. The following cases are exceptions that can be hard to diagnose without a priori knowledge.
77
77
78
78
How To Update Test For Filter Changes/Ports
79
79
@@ -200,7 +200,7 @@ At the current time, the only filters that should be made parallel are those tha
200
200
201
201
### Syntax for Simplnx
202
202
203
-
This is an examplar use case and doesn't truly encompass all possible use cases for the functions, but instead serves to show how it should be structured in most cases.
203
+
This is an exemplar use case and doesn't truly encompass all possible use cases for the functions, but instead serves to show how it should be structured in most cases.
204
204
205
205
In an anonymous namespace:
206
206
```cpp
@@ -233,7 +233,7 @@ private:
233
233
};
234
234
```
235
235
236
-
In the exectuting function:
236
+
In the executing function:
237
237
238
238
```cpp
239
239
ParallelDataAlgorithm dataAlg;
@@ -275,7 +275,7 @@ For progress messaging a throttled messenger class is provided. To initialize it
Copy file name to clipboardExpand all lines: src/Plugins/OrientationAnalysis/src/OrientationAnalysis/Filters/Algorithms/ComputeFeatureReferenceMisorientations.cpp
returnMakeErrorResult(-34900, "Total features was zero. The filter cannot proceed. Check either the feature attribute matrix or the average quaternions for proper size");
79
79
}
80
80
81
-
// Create local storage for teh centers and center distances
81
+
// Create local storage for the centers and center distances
Copy file name to clipboardExpand all lines: src/Plugins/OrientationAnalysis/test/ComputeTwinBoundariesTest.cpp
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -143,7 +143,7 @@ TEST_CASE("OrientationAnalysis::ComputeTwinBoundariesFilter: No Incoherence", "[
143
143
144
144
// Compare the output arrays with those precalculated from the file
145
145
{
146
-
// The exemplar algorithm skips invalid values while this algorithm doesn't due to lack of apriori knowledge (face normals array) so we simulate it here
146
+
// The exemplar algorithm skips invalid values while this algorithm doesn't due to lack of a priori knowledge (face normals array) so we simulate it here
Copy file name to clipboardExpand all lines: src/Plugins/SimplnxCore/docs/CreateDataArrayAdvancedFilter.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,7 +24,7 @@ The *Step Operation* parameter is active when *Initialization Type* is set to **
24
24
-**Addition [0]**: Each successive element value is the previous value plus the step amount (ascending sequence).
25
25
-**Subtraction [1]**: Each successive element value is the previous value minus the step amount (descending sequence).
26
26
27
-
When initializing a multicomponent array square bracket notation can be used to specify different initialization values for each component. For example say that I want to intialize a 2 component array where the first component is 0 and the second component is 1 we would use the following input string for the *Initialization Value*
27
+
When initializing a multicomponent array square bracket notation can be used to specify different initialization values for each component. For example say that I want to initialize a 2 component array where the first component is 0 and the second component is 1 we would use the following input string for the *Initialization Value*
0 commit comments