Skip to content

Commit

Permalink
Generate parameter section of markdown docs on the fly at compile time
Browse files Browse the repository at this point in the history 
Signed-off-by: Michael Jackson <[email protected]>
  • Loading branch information
@imikejackson
imikejackson committed Oct 11, 2023
1 parent e666745 commit f2ff689
Show file tree
Hide file tree
Showing 234 changed files with 1,092 additions and 5,824 deletions.
4 changes: 0 additions & 4 deletions .markdownlint-configure-file.json
View file

This file was deleted.

4 changes: 2 additions & 2 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -129,9 +129,9 @@ For the basic code styling complex uses `clang-format`, the formatting file is i
- Be sure to include the following at the bottom of all documentation files

```markdown
## DREAM3DNX Help ##
## DREAM3D-NX Help ##

Check out our GitHub community page at [DREAM3DNX-Issues](https://github.com/BlueQuartzSoftware/DREAM3DNX-Issues) to report bugs, ask the community for help, discuss features, or get help from the developers.
If you need help, need to file a bug report or want to request a new feature, please head over to the [DREAM3DNX-Issues](https://github.com/BlueQuartzSoftware/DREAM3DNX-Issues) GItHub site where the community of DREAM3D-NX users can help answer your questions.
```

## Community
Expand Down
37 changes: 13 additions & 24 deletions src/Plugins/ComplexCore/docs/AbaqusHexahedronWriterFilter.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ This **Filter** produces the basic five Abaqus .inp files for input into the Aba

The master file:

```text
*Heading
Job 101
** Job name : Job 101
Expand All @@ -27,9 +28,11 @@ The master file:
**
** ----------------------------------------------------------------
**
```

The _nodes.inp file:

```text
** Generated by : DREAM3DLib Version 5.1.566.e1e7b7f
** ----------------------------------------------------------------
**
Expand All @@ -39,9 +42,11 @@ The _nodes.inp file:
3, 1.000000, 0.000000, 0.000000
4, 1.500000, 0.000000, 0.000000
..
```

The _elset.inp file:

```text
** Generated by : DREAM3DLib Version 5.1.566.e1e7b7f
** ----------------------------------------------------------------
**
Expand Down Expand Up @@ -76,9 +81,11 @@ The _elset.inp file:
32448
*Elset, elset=Grain2_set
..
```

The _elems.inp file:

```text
** Generated by : DREAM3DLib Version 5.1.566.e1e7b7f
** ----------------------------------------------------------------
**
Expand All @@ -90,9 +97,11 @@ The _elems.inp file:
5, 1095, 6, 5, 1094, 1128, 39, 38, 1127
6, 1096, 7, 6, 1095, 1129, 40, 39, 1128
..
```

The _sects.inp file:

```text
** Generated by : DREAM3DLib Version 5.1.566.e1e7b7f
** ----------------------------------------------------------------
**
Expand All @@ -106,34 +115,14 @@ The _sects.inp file:
*Solid Section, elset=Grain2_set, material=Grain_Mat2
..
```

## Parameters

| Name | Type | Description |
|------------------|------|------------------------|
| Hour Glass Stiffness | int32_t | Only recommended if using C3D8R elements |
| Job Name | String | Job Name, if desired |
| Output Path | File Path | The output path for the .inp files |
| Output File Prefix | String | Prefix for the name of the 5 files |

## Required Geometry

Image

## Required Objects

| Kind | Default Name | Type | Comp Dims | Description |
|---------------------------|--------------|----------|--------|---------------------------------------------|
| Cell Attribute Array | FeatureIds | int32_t | (1) | Specifies to which **Feature** each **Cell** belongs |

## Created Objects

None
% Auto generated parameter table will be inserted here

## License & Copyright

Please see the description file distributed with this **Plugin**

## DREAM3DNX Help
## DREAM3D-NX Help

Check out our GitHub community page at [DREAM3DNX-Issues](https://github.com/BlueQuartzSoftware/DREAM3DNX-Issues) to report bugs, ask the community for help, discuss features, or get help from the developers.
If you need help, need to file a bug report or want to request a new feature, please head over to the [DREAM3DNX-Issues](https://github.com/BlueQuartzSoftware/DREAM3DNX-Issues) GItHub site where the community of DREAM3D-NX users can help answer your questions.
29 changes: 3 additions & 26 deletions src/Plugins/ComplexCore/docs/AddBadDataFilter.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,35 +12,12 @@ All **Attribute Arrays** that belong to the same **Attribute Matrix** as the sel

For more information on synthetic building, visit the tutorial.

## Parameters

| Name | Type | Description |
|------------|------| --------------------------------- |
| Use Seed | bool | Whether a seed shouold be used for random generation |
| Seed | uint64 | This is the value fed into the random generator |
| Add Random Noise | bool | Whether to add random Poisson noise to the whole volume |
| Volume Fraction Random Noise | float | Fraction of noise to add over the whole volume |
| Add Boundary Noise | bool | Whether to add noise to the boundary **Cells |
| Volume Fraction Boundary Noise | float | Fraction of noise to add to the boundary **Cells |

## Required Geometry

Image

## Required Objects

| Kind | Default Name | Type | Comp Dims | Description |
|---------------------------|--------------|----------|--------|---------------------------------------------|
| Cell Attribute Array | GBEuclideanDistances | int32 | (1) | Manhattan distances of each **Cell** to the closest **Feature** boundary |

## Created Objects

None
% Auto generated parameter table will be inserted here

## License & Copyright

Please see the description file distributed with this **Plugin**

## DREAM3DNX Help
## DREAM3D-NX Help

Check out our GitHub community page at [DREAM3DNX-Issues](https://github.com/BlueQuartzSoftware/DREAM3DNX-Issues) to report bugs, ask the community for help, discuss features, or get help from the developers.
If you need help, need to file a bug report or want to request a new feature, please head over to the [DREAM3DNX-Issues](https://github.com/BlueQuartzSoftware/DREAM3DNX-Issues) GItHub site where the community of DREAM3D-NX users can help answer your questions.
25 changes: 3 additions & 22 deletions src/Plugins/ComplexCore/docs/AlignGeometries.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,31 +19,12 @@ This **Filter** will align 2 Geometry objects using 1 of several alignment metho

The input geometries can be of any type. The *Moving* geometry is moved in space to the *Target* geometry.

## Parameters

| Name | Type | Description |
|------|------|------|
| Method | Integer | 0=Centroid, 1=Origin, 2-7 for the various planes |

## Required Geometry

Required Geometry Type -or- Not Applicable

## Required Objects

| Kind | Default Name | Type | Comp Dims | Description |
|---------------------------|--------------|----------|--------|---------------------------------------------|
| Data Container | Moving Geometry | Must have a geometry | N/A | The Geometry that is going to be moved |
| Data Container | Target Geometry |Must have a geometry | N/A | The Target Geometry that the moving is going to be aligned to. |

## Created Objects

None. The operation is done in place
% Auto generated parameter table will be inserted here

## License & Copyright

Please see the description file distributed with this plugin.

## DREAM3DNX Help
## DREAM3D-NX Help

Check out our GitHub community page at [DREAM3DNX-Issues](https://github.com/BlueQuartzSoftware/DREAM3DNX-Issues) to report bugs, ask the community for help, discuss features, or get help from the developers.
If you need help, need to file a bug report or want to request a new feature, please head over to the [DREAM3DNX-Issues](https://github.com/BlueQuartzSoftware/DREAM3DNX-Issues) GItHub site where the community of DREAM3D-NX users can help answer your questions.
28 changes: 3 additions & 25 deletions src/Plugins/ComplexCore/docs/AlignSectionsFeatureCentroidFilter.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,29 +20,7 @@ The user can choose to write the determined shift to an output file by enabling

The user can also decide to remove a *background shift* present in the sample. The process for this is to fit a line to the X and Y shifts along the Z-direction of the sample. The individual shifts are then modified to make the slope of the fit line be 0. Effectively, this process is trying to keep the top and bottom section of the sample fixed. Some combinations of sample geometry and internal features can result in this algorithm introducing a 'shear' in the sample and the *Linear Background Subtraction* will attempt to correct for this.

## Parameters

| Name | Type | Description |
|------------|------| --------------------------------- |
| Write Alignment Shift File | bool | Whether to write the shifts applied to each section to a file |
| Alignment File | File Path | The output file path where the user would like the shifts applied to the section to be written. Only needed if *Write Alignment Shifts File* is checked |
| Linear Background Subtraction | bool | Whether to remove a *background shift* present in the alignment |
| Use Refernece Slice | bool | Whether the centroids of each section should be compared to a reference slice instead of their neighboring section |
| Reference Slice | int32_t | Slice number to use as reference. Only needed if *Use Reference Slice* is checked |

## Required Geometry

Image

## Required Objects

| Kind | Default Name | Type | Comp Dims | Description |
|---------------------------|--------------|----------|--------|---------------------------------------------|
| Cell Attribute Array | Mask | bool | (1) | Specifies if the **Cell** is to be counted as part of the *sample* or not |

## Created Objects

None
% Auto generated parameter table will be inserted here

## Example Pipelines

Expand All @@ -53,6 +31,6 @@ None

Please see the description file distributed with this **Plugin**

## DREAM3DNX Help
## DREAM3D-NX Help

Check out our GitHub community page at [DREAM3DNX-Issues](https://github.com/BlueQuartzSoftware/DREAM3DNX-Issues) to report bugs, ask the community for help, discuss features, or get help from the developers.
If you need help, need to file a bug report or want to request a new feature, please head over to the [DREAM3DNX-Issues](https://github.com/BlueQuartzSoftware/DREAM3DNX-Issues) GItHub site where the community of DREAM3D-NX users can help answer your questions.
23 changes: 3 additions & 20 deletions src/Plugins/ComplexCore/docs/AlignSectionsListFilter.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,31 +22,14 @@ Otherwise, the format of the file is as follows:

The slices must be ordered from the bottom of the sample to the top of the sample (i.e., the first line of shifts should be the second slice relative to the first, then the next line is the third slice relative to the second, and so on). Also, the file must be either space or tab delimited.

## Parameters

| Name | Type | Description |
|------------|------| --------------------------------- |
| Input File | File Path | The input .txt file path containing the shifts to apply to the sections |
| DREAM.3D Alignment File | Bool | Turn this ON if the alignment file was generated by another DREAM.3D Alignment filter |

## Required Geometry

Image

## Required Objects

None

## Created Objects

None
% Auto generated parameter table will be inserted here

## Example Pipelines

## License & Copyright

Please see the description file distributed with this **Plugin**

## DREAM3DNX Help
## DREAM3D-NX Help

Check out our GitHub community page at [DREAM3DNX-Issues](https://github.com/BlueQuartzSoftware/DREAM3DNX-Issues) to report bugs, ask the community for help, discuss features, or get help from the developers.
If you need help, need to file a bug report or want to request a new feature, please head over to the [DREAM3DNX-Issues](https://github.com/BlueQuartzSoftware/DREAM3DNX-Issues) GItHub site where the community of DREAM3D-NX users can help answer your questions.
23 changes: 3 additions & 20 deletions src/Plugins/ComplexCore/docs/AppendImageGeometryZSliceFilter.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,31 +14,14 @@ For example, if the user has an already existing **Image Geometry** that is 100
*Y* direction and composed of 5 *Z* slices then appending another data set that is the same dimensions in X & Y but contains
10 *Z* slices then the resulting **Image Geometry** will have a total of 15 *Z* slices.

## Parameters

| Name | Type | Description |
|------------------|------| ------------|
| Check Resolution | Boolean | Checks to make sure the spacing for the input geometry and destination geometry match |
| Save as new geometry | Boolean | Instead of overwritting the existing destination geometry when appending the input data, save the results to a new geometry |
| New Image Geometry | DataPath | The full path to the new image geometry where the appended results are stored when the save as new geometry is on |

## Required Geometry

Image

## Required Arrays

| Kind | Default Name | Type | Comp Dims | Description |
|---------------------------|--------------|----------|--------|---------------------------------------------|
| Attribute Matrix | Input Cell Data | Cell | N/A | The incoming cell data that is to be appended. |
| Attribute Matrix | Destination Cell Data | Cell | N/A | The destination cell data that is the final location for the appended data. |
% Auto generated parameter table will be inserted here

## Example Pipelines

## License & Copyright

Please see the description file distributed with this **Plugin**

## DREAM3DNX Help
## DREAM3D-NX Help

Check out our GitHub community page at [DREAM3DNX-Issues](https://github.com/BlueQuartzSoftware/DREAM3DNX-Issues) to report bugs, ask the community for help, discuss features, or get help from the developers.
If you need help, need to file a bug report or want to request a new feature, please head over to the [DREAM3DNX-Issues](https://github.com/BlueQuartzSoftware/DREAM3DNX-Issues) GItHub site where the community of DREAM3D-NX users can help answer your questions.
46 changes: 3 additions & 43 deletions src/Plugins/ComplexCore/docs/ApplyTransformationToGeometryFilter.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,47 +50,7 @@ The user may select from a variety of options for the type of transformation to
| 4 | Translation | Translation by the supplied (x, y, z) values |
| 5 | Scale | Scaling by the supplied (x, y, z) values |

## Parameters

| Name | Type | Description |
|-----------------------------------------------------------|-------------|---------------------------------------------------------------------------------------------------------------------------------------------|
| Transformation Type | Enumeration | Type of transformation to be used. (0-5) |
| Transformation Matrix | float (4x4) | Entries of the 4x4 transformation matrix, if *Manual* is chosen for the *Transformation Type* |
| Rotation Axis-Angle (ijk) | float (4x) | axis-angle <x,y,z> (Angle in Degrees) |
| Translation | float (3x) | (x, y, z) translation values, if *Translation* is chosen for the *Transformation Type* |
| Scale | float (3x) | (x, y, z) scale values, if *Scale* is chosen for the *Transformation Type* |
| Translate Geometry To Global Origin Before Transformation | boolean | If enabled, translates the geometry to (0, 0, 0), applies the transformation, and then translates the geometry back to its original origin. |
| Precomputed Transformation Matrix Data Path | DataPath | |
| Geometry to be transformed. | DataPath | |

### Image Geometry Transformation Options

| Enum Value | Interpolation Type |
|------------|-------------------------------------------|
| 0 | No Interpolation |
| 1 | Nearest Neighbor |
| 2 | Linear/Bi linear/Tri linear Interpolation |

| Name | Type | Description |
|-----------------------|-------------|--------------------------------------------------------|
| Interpolation Type | Enumeration | Type of Interpolation to be used. (0-2) |
| Cell Attribute Matrix | DataPath | The path to the Image Geometry's Cell Attribute Matrix |

## Required Geometry

Any **Unstructured Geometry** or **Image Geometry**

## Required Objects

| Kind | Default Name | Type | Comp Dims | Description |
|------------------|-------------|----------|-------------|------------------------------------------------------------------------------------------------------------|
| Geometry | None | N/A | N/A | The unstructured **Geometry** or Image Geometry to transform |
| DataArray | TransformationMatrix | float | 4x4 | The pre-computed transformation matrix to apply, if *Pre-Computed* is chosen for the *Transformation Type* |

## Created Objects

+ Unstructured Geometry: None
+ Image Geometry: New Image Geometry (The input geometry is discarded)
% Auto generated parameter table will be inserted here

## Example Pipelines

Expand All @@ -102,6 +62,6 @@ Any **Unstructured Geometry** or **Image Geometry**

Please see the description file distributed with this plugin.

## DREAM3DNX Help
## DREAM3D-NX Help

Check out our GitHub community page at [DREAM3DNX-Issues](https://github.com/BlueQuartzSoftware/DREAM3DNX-Issues) to report bugs, ask the community for help, discuss features, or get help from the developers.
If you need help, need to file a bug report or want to request a new feature, please head over to the [DREAM3DNX-Issues](https://github.com/BlueQuartzSoftware/DREAM3DNX-Issues) GItHub site where the community of DREAM3D-NX users can help answer your questions.
27 changes: 3 additions & 24 deletions src/Plugins/ComplexCore/docs/ApproximatePointCloudHull.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,33 +20,12 @@ The above algorithm is significantly faster that other geometric approaches for

Note that the resulting hull geometry does not inherit any **Attribute Arrays** from the original point cloud.

## Parameters

| Name | Type | Description |
|------|------|------|
| Grid Resolution | float 3x | The resolution of the sampling grid |
| Minimum Number of Empty Neighbors | int | The minimum number of voxel neighbors that must contain 0 points for a voxel to be considered on the surface |

## Required Geometry

Vertex

## Required Objects

| Kind | Default Name | Type | Comp Dims | Description |
|---------------------------|--------------|----------|--------|---------------------------------------------|
| Data Container | None | N/A | N/A | Data Container holding the input **Vertex Geometry |

## Created Objects

| Kind | Default Name | Type | Comp Dims | Description |
|---------------------------|--------------|----------|--------|---------------------------------------------|
| Data Container | HullDataContainer | N/A | N/A | Data Container holding the approximated surface **Vertex Geometry |
% Auto generated parameter table will be inserted here

## License & Copyright

Please see the description file distributed with this plugin.

## DREAM3DNX Help
## DREAM3D-NX Help

Check out our GitHub community page at [DREAM3DNX-Issues](https://github.com/BlueQuartzSoftware/DREAM3DNX-Issues) to report bugs, ask the community for help, discuss features, or get help from the developers.
If you need help, need to file a bug report or want to request a new feature, please head over to the [DREAM3DNX-Issues](https://github.com/BlueQuartzSoftware/DREAM3DNX-Issues) GItHub site where the community of DREAM3D-NX users can help answer your questions.
Loading

0 comments on commit f2ff689

Please sign in to comment.