From f2ff68939996fe74fa4d7cfcc1633695e883bf24 Mon Sep 17 00:00:00 2001 From: Michael Jackson Date: Thu, 5 Oct 2023 19:37:10 -0400 Subject: [PATCH] Generate parameter section of markdown docs on the fly at compile time Signed-off-by: Michael Jackson --- .markdownlint-configure-file.json | 4 - CONTRIBUTING.md | 4 +- .../docs/AbaqusHexahedronWriterFilter.md | 37 +- .../ComplexCore/docs/AddBadDataFilter.md | 29 +- .../ComplexCore/docs/AlignGeometries.md | 25 +- .../AlignSectionsFeatureCentroidFilter.md | 28 +- .../docs/AlignSectionsListFilter.md | 23 +- .../docs/AppendImageGeometryZSliceFilter.md | 23 +- .../ApplyTransformationToGeometryFilter.md | 46 +- .../docs/ApproximatePointCloudHull.md | 27 +- .../ComplexCore/docs/ArrayCalculatorFilter.md | 24 +- .../AvizoRectilinearCoordinateWriterFilter.md | 25 +- .../AvizoUniformCoordinateWriterFilter.md | 25 +- .../docs/CalculateArrayHistogramFilter.md | 35 +- .../docs/CalculateFeatureSizesFilter.md | 29 +- .../docs/CalculateTriangleAreasFilter.md | 22 +- .../docs/ChangeAngleRepresentation.md | 24 +- .../docs/CombineAttributeArraysFilter.md | 27 +- .../ComplexCore/docs/CombineStlFilesFilter.md | 23 +- .../docs/ComputeFeatureRectFilter.md | 25 +- .../docs/ComputeMomentInvariants2DFilter.md | 33 +- .../ComplexCore/docs/ConditionalSetValue.md | 33 +- .../docs/ConvertColorToGrayScaleFilter.md | 30 +- .../ComplexCore/docs/ConvertDataFilter.md | 26 +- .../ComplexCore/docs/CopyDataObjectFilter.md | 25 +- .../docs/CopyFeatureArrayToElementArray.md | 25 +- .../docs/CreateAttributeMatrixFilter.md | 23 +- .../ComplexCore/docs/CreateDataArray.md | 28 +- .../ComplexCore/docs/CreateDataGroup.md | 22 +- .../CreateFeatureArrayFromElementArray.md | 26 +- .../ComplexCore/docs/CreateGeometryFilter.md | 43 +- .../ComplexCore/docs/CreateImageGeometry.md | 26 +- .../ComplexCore/docs/CropImageGeometry.md | 22 +- .../ComplexCore/docs/CropVertexGeometry.md | 24 +- src/Plugins/ComplexCore/docs/DeleteData.md | 22 +- .../docs/ErodeDilateBadDataFilter.md | 29 +- .../ErodeDilateCoordinationNumberFilter.md | 26 +- .../ComplexCore/docs/ErodeDilateMaskFilter.md | 28 +- .../ComplexCore/docs/ExecuteProcessFilter.md | 25 +- .../ComplexCore/docs/ExportDREAM3DFilter.md | 23 +- .../docs/ExtractComponentAsArrayFilter.md | 28 +- ...actInternalSurfacesFromTriangleGeometry.md | 22 +- .../docs/ExtractVertexGeometryFilter.md | 21 +- .../docs/FeatureDataCSVWriterFilter.md | 27 +- .../docs/FeatureFaceCurvatureFilter.md | 37 +- .../ComplexCore/docs/FillBadDataFilter.md | 27 +- .../docs/FindArrayStatisticsFilter.md | 58 +-- .../docs/FindBiasedFeaturesFilter.md | 28 +- .../docs/FindBoundaryCellsFilter.md | 27 +- .../FindBoundaryElementFractionsFilter.md | 26 +- .../ComplexCore/docs/FindDifferencesMap.md | 25 +- .../docs/FindEuclideanDistMapFilter.md | 33 +- .../docs/FindFeatureCentroidsFilter.md | 24 +- .../docs/FindFeatureClusteringFilter.md | 35 +- .../docs/FindFeaturePhasesBinaryFilter.md | 26 +- .../docs/FindFeaturePhasesFilter.md | 25 +- .../docs/FindLargestCrossSectionsFilter.md | 26 +- .../docs/FindNeighborListStatistics.md | 48 +-- .../docs/FindNeighborhoodsFilter.md | 29 +- src/Plugins/ComplexCore/docs/FindNeighbors.md | 32 +- .../ComplexCore/docs/FindNumFeaturesFilter.md | 25 +- .../docs/FindSurfaceAreaToVolumeFilter.md | 28 +- .../ComplexCore/docs/FindSurfaceFeatures.md | 25 +- .../docs/FindTriangleGeomCentroidsFilter.md | 25 +- .../docs/FindTriangleGeomSizesFilter.md | 25 +- .../FindVertexToTriangleDistancesFilter.md | 27 +- .../docs/FindVolFractionsFilter.md | 25 +- .../docs/GenerateColorTableFilter.md | 26 +- .../docs/GenerateVectorColorsFilter.md | 27 +- .../ComplexCore/docs/IdentifySample.md | 24 +- .../ComplexCore/docs/ImageContouringFilter.md | 22 +- .../docs/ImportBinaryCTNorthstarFilter.md | 30 +- .../ComplexCore/docs/ImportCSVDataFilter.md | 30 +- .../ComplexCore/docs/ImportDREAM3DFilter.md | 18 +- .../docs/ImportDeformKeyFileV12Filter.md | 24 +- .../ComplexCore/docs/ImportHDF5Dataset.md | 28 +- .../ComplexCore/docs/ImportTextFilter.md | 30 +- .../docs/ImportVolumeGraphicsFileFilter.md | 29 +- .../ComplexCore/docs/InitializeData.md | 29 +- ...nterpolatePointCloudToRegularGridFilter.md | 33 +- .../docs/IterativeClosestPointFilter.md | 29 +- src/Plugins/ComplexCore/docs/KMeansFilter.md | 31 +- .../ComplexCore/docs/KMedoidsFilter.md | 31 +- .../docs/LaplacianSmoothingFilter.md | 33 +- .../docs/LosAlamosFFTWriterFilter.md | 26 +- .../docs/MapPointCloudToRegularGridFilter.md | 30 +- src/Plugins/ComplexCore/docs/MinNeighbors.md | 28 +- src/Plugins/ComplexCore/docs/MoveData.md | 26 +- .../ComplexCore/docs/MultiThresholdObjects.md | 30 +- .../NearestPointFuseRegularGridsFilter.md | 23 +- .../docs/PartitionGeometryFilter.md | 27 +- .../docs/PointSampleTriangleGeometryFilter.md | 32 +- .../docs/QuickSurfaceMeshFilter.md | 34 +- .../ComplexCore/docs/RawBinaryReaderFilter.md | 28 +- .../RegularGridSampleSurfaceMeshFilter.md | 30 +- .../docs/RemoveFlaggedFeaturesFilter.md | 23 +- .../ComplexCore/docs/RemoveFlaggedVertices.md | 25 +- .../docs/RemoveMinimumSizeFeaturesFilter.md | 28 +- .../ComplexCore/docs/RenameDataObject.md | 24 +- ...ementAttributesWithNeighborValuesFilter.md | 27 +- .../docs/ResampleImageGeomFilter.md | 33 +- .../docs/ResampleRectGridToImageGeomFilter.md | 24 +- .../docs/ReverseTriangleWindingFilter.md | 22 +- .../docs/RobustAutomaticThreshold.md | 25 +- .../docs/RotateSampleRefFrameFilter.md | 27 +- .../docs/ScalarSegmentFeaturesFilter.md | 30 +- .../docs/SetImageGeomOriginScalingFilter.md | 27 +- .../docs/SharedFeatureFaceFilter.md | 29 +- .../ComplexCore/docs/SilhouetteFilter.md | 29 +- .../docs/SplitAttributeArrayFilter.md | 26 +- .../ComplexCore/docs/StlFileReaderFilter.md | 32 +- .../ComplexCore/docs/SurfaceNetsFilter.md | 32 +- .../docs/TriangleCentroidFilter.md | 22 +- .../docs/TriangleDihedralAngleFilter.md | 22 +- .../ComplexCore/docs/TriangleNormalFilter.md | 22 +- .../UncertainRegularGridSampleSurfaceMesh.md | 4 +- ...rtainRegularGridSampleSurfaceMeshFilter.md | 33 +- .../docs/VtkRectilinearGridWriterFilter.md | 33 +- .../ComplexCore/docs/WriteASCIIDataFilter.md | 28 +- .../ComplexCore/docs/WriteBinaryDataFilter.md | 26 +- .../ComplexCore/docs/WriteStlFileFilter.md | 28 +- .../Filters/FeatureFaceCurvatureFilter.cpp | 3 +- .../ITKImageProcessing/docs/ITKAbsImage.md | 26 +- .../ITKImageProcessing/docs/ITKAcosImage.md | 26 +- .../ITKAdaptiveHistogramEqualizationImage.md | 29 +- .../ITKImageProcessing/docs/ITKAsinImage.md | 26 +- .../ITKImageProcessing/docs/ITKAtanImage.md | 26 +- .../docs/ITKBinaryContourImage.md | 29 +- .../docs/ITKBinaryDilateImage.md | 31 +- .../docs/ITKBinaryErodeImage.md | 31 +- .../ITKBinaryMorphologicalClosingImage.md | 30 +- .../ITKBinaryMorphologicalOpeningImage.md | 30 +- .../ITKBinaryOpeningByReconstructionImage.md | 31 +- .../docs/ITKBinaryProjectionImage.md | 29 +- .../docs/ITKBinaryThinningImage.md | 26 +- .../docs/ITKBinaryThresholdImage.md | 30 +- .../docs/ITKBlackTopHatImage.md | 29 +- .../docs/ITKClosingByReconstructionImage.md | 30 +- .../ITKImageProcessing/docs/ITKCosImage.md | 26 +- .../docs/ITKDilateObjectMorphologyImage.md | 29 +- .../docs/ITKDiscreteGaussianImage.md | 30 +- .../docs/ITKErodeObjectMorphologyImage.md | 30 +- .../ITKImageProcessing/docs/ITKExpImage.md | 26 +- .../docs/ITKExpNegativeImage.md | 26 +- .../docs/ITKGradientMagnitudeImage.md | 27 +- .../docs/ITKGrayscaleDilateImage.md | 28 +- .../docs/ITKGrayscaleErodeImage.md | 28 +- .../docs/ITKGrayscaleFillholeImage.md | 27 +- .../docs/ITKGrayscaleGrindPeakImage.md | 27 +- .../ITKGrayscaleMorphologicalClosingImage.md | 29 +- .../ITKGrayscaleMorphologicalOpeningImage.md | 29 +- .../docs/ITKHConvexImage.md | 28 +- .../docs/ITKHMaximaImage.md | 27 +- .../docs/ITKHMinimaImage.md | 28 +- .../ITKImageProcessing/docs/ITKImageReader.md | 18 +- .../ITKImageProcessing/docs/ITKImageWriter.md | 26 +- .../docs/ITKImportFijiMontageFilter.md | 34 +- .../docs/ITKImportImageStack.md | 23 +- .../docs/ITKIntensityWindowingImage.md | 30 +- .../docs/ITKInvertIntensityImage.md | 27 +- .../docs/ITKLabelContourImage.md | 28 +- .../ITKImageProcessing/docs/ITKLog10Image.md | 26 +- .../ITKImageProcessing/docs/ITKLogImage.md | 26 +- .../ITKImageProcessing/docs/ITKMaskImage.md | 22 +- .../ITKImageProcessing/docs/ITKMedianImage.md | 27 +- .../docs/ITKMhaFileReader.md | 26 +- .../docs/ITKMorphologicalGradientImage.md | 28 +- .../docs/ITKMorphologicalWatershedImage.md | 29 +- .../docs/ITKNormalizeImage.md | 26 +- .../ITKImageProcessing/docs/ITKNotImage.md | 26 +- .../docs/ITKOpeningByReconstructionImage.md | 30 +- .../docs/ITKOtsuMultipleThresholdsImage.md | 31 +- .../docs/ITKRelabelComponentImage.md | 28 +- .../docs/ITKRescaleIntensityImage.md | 28 +- .../docs/ITKSigmoidImage.md | 30 +- .../docs/ITKSignedMaurerDistanceMapImage.md | 30 +- .../ITKImageProcessing/docs/ITKSinImage.md | 26 +- .../ITKImageProcessing/docs/ITKSqrtImage.md | 26 +- .../ITKImageProcessing/docs/ITKSquareImage.md | 26 +- .../ITKImageProcessing/docs/ITKTanImage.md | 26 +- .../docs/ITKThresholdImage.md | 29 +- .../docs/ITKValuedRegionalMaximaImage.md | 27 +- .../docs/ITKValuedRegionalMinimaImage.md | 27 +- .../docs/ITKWhiteTopHatImage.md | 29 +- .../docs/AlignSectionsMisorientationFilter.md | 36 +- .../AlignSectionsMutualInformationFilter.md | 30 +- .../BadDataNeighborOrientationCheckFilter.md | 28 +- .../docs/CAxisSegmentFeaturesFilter.md | 32 +- .../docs/ConvertOrientations.md | 28 +- .../docs/ConvertQuaternionFilter.md | 27 +- .../docs/CreateEnsembleInfoFilter.md | 27 +- .../docs/EBSDSegmentFeaturesFilter.md | 32 +- .../docs/EbsdToH5EbsdFilter.md | 20 +- .../docs/EnsembleInfoReaderFilter.md | 26 +- .../docs/ExportGBCDGMTFileFilter.md | 27 +- .../docs/ExportGBCDTriangleDataFilter.md | 27 +- .../docs/FindAvgCAxesFilter.md | 27 +- .../docs/FindAvgOrientationsFilter.md | 28 +- .../docs/FindBoundaryStrengthsFilter.md | 32 +- .../docs/FindCAxisLocationsFilter.md | 26 +- ...FeatureNeighborCAxisMisalignmentsFilter.md | 30 +- ...tureReferenceCAxisMisorientationsFilter.md | 30 +- ...ndFeatureReferenceMisorientationsFilter.md | 32 +- .../docs/FindGBCDFilter.md | 36 +- .../docs/FindGBCDMetricBasedFilter.md | 34 +- .../docs/FindGBPDMetricBasedFilter.md | 33 +- .../FindKernelAvgMisorientationsFilter.md | 29 +- .../docs/FindMisorientationsFilter.md | 30 +- .../docs/FindSchmidsFilter.md | 36 +- .../docs/FindShapesFilter.md | 30 +- .../docs/FindSlipTransmissionMetricsFilter.md | 30 +- .../docs/FindTriangleGeomShapesFilter.md | 30 +- .../docs/GenerateFZQuaternions.md | 29 +- .../docs/GenerateFaceIPFColoringFilter.md | 28 +- ...enerateFaceMisorientationColoringFilter.md | 27 +- .../docs/GenerateGBCDPoleFigureFilter.md | 31 +- .../docs/GenerateIPFColorsFilter.md | 30 +- .../docs/GeneratePoleFigureFilter.md | 4 +- .../docs/GenerateQuaternionConjugateFilter.md | 26 +- .../docs/INLWriterFilter.md | 29 +- .../docs/ImportH5EspritDataFilter.md | 65 +-- .../docs/ImportH5OimDataFilter.md | 56 +-- .../docs/MergeTwinsFilter.md | 35 +- .../NeighborOrientationCorrelationFilter.md | 29 +- .../docs/ReadAngDataFilter.md | 37 +- .../docs/ReadCtfDataFilter.md | 40 +- .../docs/ReadH5EbsdFilter.md | 33 +- .../docs/RodriguesConvertorFilter.md | 26 +- .../docs/RotateEulerRefFrameFilter.md | 24 +- .../docs/WritePoleFigureFilter.md | 41 +- .../docs/WriteStatsGenOdfAngleFileFilter.md | 27 +- wrapping/python/docs/generate_sphinx_docs.cpp | 408 +++++++++++++++++- wrapping/python/docs/index_template.rst | 14 +- wrapping/python/docs/source/DataObjects.rst | 25 +- 234 files changed, 1092 insertions(+), 5824 deletions(-) delete mode 100644 .markdownlint-configure-file.json diff --git a/.markdownlint-configure-file.json b/.markdownlint-configure-file.json deleted file mode 100644 index bf386c6936..0000000000 --- a/.markdownlint-configure-file.json +++ /dev/null @@ -1,4 +0,0 @@ -{ -"default" : true, -"MD013": {} -} \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 28fc51cd45..5323724a9a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 diff --git a/src/Plugins/ComplexCore/docs/AbaqusHexahedronWriterFilter.md b/src/Plugins/ComplexCore/docs/AbaqusHexahedronWriterFilter.md index 47c58c0dde..5165aa8521 100644 --- a/src/Plugins/ComplexCore/docs/AbaqusHexahedronWriterFilter.md +++ b/src/Plugins/ComplexCore/docs/AbaqusHexahedronWriterFilter.md @@ -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 @@ -27,9 +28,11 @@ The master file: ** ** ---------------------------------------------------------------- ** +``` The _nodes.inp file: +```text ** Generated by : DREAM3DLib Version 5.1.566.e1e7b7f ** ---------------------------------------------------------------- ** @@ -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 ** ---------------------------------------------------------------- ** @@ -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 ** ---------------------------------------------------------------- ** @@ -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 ** ---------------------------------------------------------------- ** @@ -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. diff --git a/src/Plugins/ComplexCore/docs/AddBadDataFilter.md b/src/Plugins/ComplexCore/docs/AddBadDataFilter.md index ac719f4c8c..b09ddd6fb5 100644 --- a/src/Plugins/ComplexCore/docs/AddBadDataFilter.md +++ b/src/Plugins/ComplexCore/docs/AddBadDataFilter.md @@ -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. diff --git a/src/Plugins/ComplexCore/docs/AlignGeometries.md b/src/Plugins/ComplexCore/docs/AlignGeometries.md index eecb0ad71d..9bfd71bc07 100644 --- a/src/Plugins/ComplexCore/docs/AlignGeometries.md +++ b/src/Plugins/ComplexCore/docs/AlignGeometries.md @@ -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. diff --git a/src/Plugins/ComplexCore/docs/AlignSectionsFeatureCentroidFilter.md b/src/Plugins/ComplexCore/docs/AlignSectionsFeatureCentroidFilter.md index c21d4853d6..4b0978a78d 100644 --- a/src/Plugins/ComplexCore/docs/AlignSectionsFeatureCentroidFilter.md +++ b/src/Plugins/ComplexCore/docs/AlignSectionsFeatureCentroidFilter.md @@ -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 @@ -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. diff --git a/src/Plugins/ComplexCore/docs/AlignSectionsListFilter.md b/src/Plugins/ComplexCore/docs/AlignSectionsListFilter.md index 1ddd24ba82..4e80d58bdf 100644 --- a/src/Plugins/ComplexCore/docs/AlignSectionsListFilter.md +++ b/src/Plugins/ComplexCore/docs/AlignSectionsListFilter.md @@ -22,24 +22,7 @@ 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 @@ -47,6 +30,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. diff --git a/src/Plugins/ComplexCore/docs/AppendImageGeometryZSliceFilter.md b/src/Plugins/ComplexCore/docs/AppendImageGeometryZSliceFilter.md index d50d27f612..116549b4ec 100644 --- a/src/Plugins/ComplexCore/docs/AppendImageGeometryZSliceFilter.md +++ b/src/Plugins/ComplexCore/docs/AppendImageGeometryZSliceFilter.md @@ -14,24 +14,7 @@ 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 @@ -39,6 +22,6 @@ Image 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. diff --git a/src/Plugins/ComplexCore/docs/ApplyTransformationToGeometryFilter.md b/src/Plugins/ComplexCore/docs/ApplyTransformationToGeometryFilter.md index e69af0b962..abb84908ae 100644 --- a/src/Plugins/ComplexCore/docs/ApplyTransformationToGeometryFilter.md +++ b/src/Plugins/ComplexCore/docs/ApplyTransformationToGeometryFilter.md @@ -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 (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 @@ -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. diff --git a/src/Plugins/ComplexCore/docs/ApproximatePointCloudHull.md b/src/Plugins/ComplexCore/docs/ApproximatePointCloudHull.md index cec9eeb89e..d4539448ab 100644 --- a/src/Plugins/ComplexCore/docs/ApproximatePointCloudHull.md +++ b/src/Plugins/ComplexCore/docs/ApproximatePointCloudHull.md @@ -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. diff --git a/src/Plugins/ComplexCore/docs/ArrayCalculatorFilter.md b/src/Plugins/ComplexCore/docs/ArrayCalculatorFilter.md index f3666fe569..ec92b234b3 100644 --- a/src/Plugins/ComplexCore/docs/ArrayCalculatorFilter.md +++ b/src/Plugins/ComplexCore/docs/ArrayCalculatorFilter.md @@ -135,25 +135,7 @@ This equation takes the cube root of *8* and stores the result in an array with This equation raises *3* to the power of the value stored in every component of every tuple in *Array1*. The resulting array has the same tuple and component size of *Array1*. -## Parameters - -None - -## Required Geometry - -Not Applicable - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Any **Attribute Matrix | None | Any | N/A | Source **Attribute Matrix** for arrays available to the mathematical expression | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Any **Attribute Array | Output | double | varies | Output of mathematical expression | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -161,6 +143,6 @@ Not Applicable 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. diff --git a/src/Plugins/ComplexCore/docs/AvizoRectilinearCoordinateWriterFilter.md b/src/Plugins/ComplexCore/docs/AvizoRectilinearCoordinateWriterFilter.md index 8d0803e603..ee86ac4567 100644 --- a/src/Plugins/ComplexCore/docs/AvizoRectilinearCoordinateWriterFilter.md +++ b/src/Plugins/ComplexCore/docs/AvizoRectilinearCoordinateWriterFilter.md @@ -30,26 +30,7 @@ This filter writes out a native Avizo Rectilinear Coordinate data file. Values s # Data section follows .. -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Output File | File Path | Amira Mesh .am file created| -| Write Binary File | Boolean | Binary file created, if checked | - -## Required Geometry - -Image - -## Required Objects - -| Type | Default Name | Type | Comp Dims | Description | -|------|--------------|-----|-----|-----------------------------------| -| Cell | FeatureIds | Ids (Int) that specify to which **Feature** each **Cell** belongs. | (1) | Filters Known to Create Data: Segment Features (Misorientation, C-Axis Misorientation, Scalar) (Reconstruction), Read Dx File (IO), Read Ph File (IO), Pack Primary Phases (SyntheticBuilding), Insert Precipitate Phases (SyntheticBuilding), Establish Matrix Phase (SyntheticBuilding) - -## Created Objects - -None +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -57,6 +38,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. diff --git a/src/Plugins/ComplexCore/docs/AvizoUniformCoordinateWriterFilter.md b/src/Plugins/ComplexCore/docs/AvizoUniformCoordinateWriterFilter.md index 553d59b91b..3fca61a2a1 100644 --- a/src/Plugins/ComplexCore/docs/AvizoUniformCoordinateWriterFilter.md +++ b/src/Plugins/ComplexCore/docs/AvizoUniformCoordinateWriterFilter.md @@ -31,26 +31,7 @@ This filter writes out a native Avizo Uniform Coordinate data file. Values shoul # Data section follows .. -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Output File | File Path | Amira Mesh .am file created| -| Write Binary File | Boolean | Binary file created, if checked | - -## Required Geometry - -Image - -## Required Objects - -| Type | Default Name | Type | Comp Dims | Description | -|------|--------------|-----|-----|-----------------------------------| -| Cell | FeatureIds | Ids (Int) that specify to which **Feature** each **Cell** belongs. | (1) | Filters Known to Create Data: Segment Features (Misorientation, C-Axis Misorientation, Scalar) (Reconstruction), Read Dx File (IO), Read Ph File (IO), Pack Primary Phases (SyntheticBuilding), Insert Precipitate Phases (SyntheticBuilding), Establish Matrix Phase (SyntheticBuilding) - -## Created Objects - -None +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -58,6 +39,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. diff --git a/src/Plugins/ComplexCore/docs/CalculateArrayHistogramFilter.md b/src/Plugins/ComplexCore/docs/CalculateArrayHistogramFilter.md index d8c0b08a30..45e87c208c 100644 --- a/src/Plugins/ComplexCore/docs/CalculateArrayHistogramFilter.md +++ b/src/Plugins/ComplexCore/docs/CalculateArrayHistogramFilter.md @@ -43,36 +43,7 @@ The range on the data is [1.6, 5.1]. Using 8 bins starting from 1.5 with a bin w Also see Histogram Quick Reference at [https://plot.ly/histogram/](https://plot.ly/histogram/). -## Parameters - -| Name | Type | Decision | -|------|------|------| -| Number of Bins | int32 | This determines how many bins the data is sorted into for histogram | -| Use Custom Min & Max Range | bool | Toggles on custom range values for the histogram | -| Min Value | float64 | Sets the lower limit for histogram range. Only needed if *Use Custom Min & Max Range* is checked | -| Max Value | float64 | Sets the higher limit for histogram range. Only needed if *Use Custom Min & Max Range* is checked | -| Create new DataGroup for Histograms | bool | If checked new **DataGroup** will be created to store the histogram(s) | -| Output DataGroup Path | DataPath | The **DataPath** to existing **DataGroup** to insert histogram(s) into | -| New DataGroup Path | DataPath | The **DataPath** to the new **DataGroup** that will store histogram(s). Replaces -*Output DataGroup Path* if *Create New DataGroup for Histograms* is checked | - -## Required Geometry - -None - -## Required Objects - -| Kind | Default Name | Type | Description | -|--------------|---------------|------|-----------------------------------------------| -| DataArray | DataArray(s) to Histogram | DataArray | Specifies to which **DataArray(s)** to create a histogram from | - -## Created Objects - -| Kind | Default Name | Type | Description | -|--------------|---------------|------|-----------------------------------------------| -| DataArray | DataArray** name + "Histogram" | DataArray | A new **DataArray** stored in specified **DataGroup** in which -the histogram will be generated based on **DataArray** specified in *DataArray(s) to Histogram* (One per **DataArray** in -*DataArray(s) to Histogram*) | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -83,9 +54,9 @@ the histogram will be generated based on **DataArray** specified in *DataArray(s 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. ### Example Data (Raw) diff --git a/src/Plugins/ComplexCore/docs/CalculateFeatureSizesFilter.md b/src/Plugins/ComplexCore/docs/CalculateFeatureSizesFilter.md index f13e8555de..60f7af27ec 100644 --- a/src/Plugins/ComplexCore/docs/CalculateFeatureSizesFilter.md +++ b/src/Plugins/ComplexCore/docs/CalculateFeatureSizesFilter.md @@ -10,30 +10,7 @@ This **Filter** calculates the sizes of all **Features**. The **Filter** simply During the computation of the **Feature** sizes, the size of each individual **Element** is computed and stored in the corresponding **Geometry**. By default, these sizes are deleted after executing the **Filter** to save memory. If you wish to store the **Element** sizes, select the *Generate Missing Element Sizes* option. The sizes will be stored within the **Geometry** definition itself, not as a separate **Attribute Array**. -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Generate Missing Element Sizes | bool | If checked this will generate and store the element sizes ONLY if the geometry does not already contain them | - -## Required Geometry - -Not Applicable - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Element Attribute Array | FeatureIds | int32_t | (1) | Specifies to which **Feature** each **Element** belongs | -| Attribute Matrix | FeatureData | Feature | N/A | Feature Attribute Matrix** of the selected *Feature Ids* | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Feature Attribute Array | EquivalentDiameters | float | (1) | Diameter of a sphere with the same volume as the **Feature | -| Feature Attribute Array | NumElements | int32_t | (1) | Number of **Elements** that are owned by the **Feature**. This value does not place any distinction between **Elements** that may be of a different size | -| Feature Attribute Array | Volumes | float | (1) | Volume of the **Feature**. This value may be "redundant" from the NumElements value if all **Elements** are the same size and is calculable from the EquivalentDiameters value | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -48,6 +25,6 @@ Not Applicable 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. diff --git a/src/Plugins/ComplexCore/docs/CalculateTriangleAreasFilter.md b/src/Plugins/ComplexCore/docs/CalculateTriangleAreasFilter.md index 29c54be5c1..86180454b8 100644 --- a/src/Plugins/ComplexCore/docs/CalculateTriangleAreasFilter.md +++ b/src/Plugins/ComplexCore/docs/CalculateTriangleAreasFilter.md @@ -12,23 +12,7 @@ This **Filter** computes the area of each **Triangle** in a **Triangle Geometry* where *O* is the angle between |AB| and |AC|. -## Parameters - -None - -## Required Geometry - -Triangle - -## Required Objects - -None - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Face Attribute Array | FaceAreas | double | (1) | Specifies the area of each Face | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -39,6 +23,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. diff --git a/src/Plugins/ComplexCore/docs/ChangeAngleRepresentation.md b/src/Plugins/ComplexCore/docs/ChangeAngleRepresentation.md index acf8dfcfb5..71f0f18e09 100644 --- a/src/Plugins/ComplexCore/docs/ChangeAngleRepresentation.md +++ b/src/Plugins/ComplexCore/docs/ChangeAngleRepresentation.md @@ -16,25 +16,7 @@ Generally, all **Filters** within DREAM.3D use radians as a default unit, but ** If the wrong conversion is selected (e.g., the user chooses *degrees to radians*, but their data is already in radians), the **Filter** will apply the conversion anyway and will result in erroneous data being used for the rest of the pipeline. If unsure about the units, check with the software supplier. -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Conversion Type | Enumeration | Tells the **Filter** which conversion is being made | - -## Required Geometry - -Not Applicable - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Element Attribute Array | None | float | (n) | Values that represent angles in degrees or radians | - -## Created Objects - -None +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -45,6 +27,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. diff --git a/src/Plugins/ComplexCore/docs/CombineAttributeArraysFilter.md b/src/Plugins/ComplexCore/docs/CombineAttributeArraysFilter.md index d6efdeeaf6..f06f0939db 100644 --- a/src/Plugins/ComplexCore/docs/CombineAttributeArraysFilter.md +++ b/src/Plugins/ComplexCore/docs/CombineAttributeArraysFilter.md @@ -30,28 +30,7 @@ _Combined (vector first)_: tuple 1 - { v1 v2 v3 s1 } ; tuple 2 - { v1 v2 v3 s1 } The user may also select to normalize the resulting combined array. The normalization procedure will enforce a range of [0, 1] for all values in the combined array. This may be useful for combining two arrays that have different order of magnitude data. Note that this option will fundamentally change the underlying data in the combined array from the original incoming arrays. -## Parameters - -| Name | Type | Description | -|------------------|------|-------------| -| Standardize Data | bool | Whether to standardize the combine data on the interval [0, 1] | -| Move Data | bool | Whether to remove the original arrays after combining the data | - -## Required Geometry - -Not Applicable - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Any **Attribute Array | None | Any | Any | Attribute Arrays** to combine | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Any **Attribute Array | CombinedData | Any | Any | Combined **Attribute Array** name | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -59,6 +38,6 @@ Not Applicable 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. diff --git a/src/Plugins/ComplexCore/docs/CombineStlFilesFilter.md b/src/Plugins/ComplexCore/docs/CombineStlFilesFilter.md index 794c26473c..44b6710279 100644 --- a/src/Plugins/ComplexCore/docs/CombineStlFilesFilter.md +++ b/src/Plugins/ComplexCore/docs/CombineStlFilesFilter.md @@ -8,24 +8,7 @@ AMProcessMonitoring (AMProcessMonitoring) This **Filter** combines all of the STL files from a given directory into a single triangle geometry. This filter will make use of the **Import STL File Filter** to read in each stl file in the given directory and then will proceed to combine each of the imported files into a single triangle geometry. -## Parameters - -| Name | Type | Description | -|------|------|------| -| Path to STL Files | Directory Path | The path to the folder containing all the STL files to be combined | - -## Required Geometry - -Not Applicable - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Geometry | TriangleGeometry | N/A | N/A | The path to the triangle geometry to be created from the combined STL files | -| Face Attribute Matrix | FaceData | Face | N/A | Created **Face Attribute Matrix** name for the combined geometry | -| Face Attribute Array | FaceNormals | double | (3) | Specifies the normal of each **Face** in the combined geometry | -| Vertex Attribute Matrix | VertexData | Vertex | N/A | Created **Vertex Attribute Matrix** name for the combined geometry | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -35,6 +18,6 @@ CombineStlFiles 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. diff --git a/src/Plugins/ComplexCore/docs/ComputeFeatureRectFilter.md b/src/Plugins/ComplexCore/docs/ComputeFeatureRectFilter.md index d50480ed81..58c98fb586 100644 --- a/src/Plugins/ComplexCore/docs/ComputeFeatureRectFilter.md +++ b/src/Plugins/ComplexCore/docs/ComputeFeatureRectFilter.md @@ -26,26 +26,7 @@ If the example matrix above which represents a single feature where the feature Y Max = 3 Z Max = 0 -## Parameters - -N/A - -## Required Geometry - -N/A - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| FeatureIds | FeatureIdsArrayName | int32_t | (1) | | -| Feature Attribute Matrix | N/A | Feature AttributeMatrix | N/A | The path to the cell feature **Attribute Matrix | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Feature Attribute Array | FeatureRect | uint32 | (6) | Xmin, Ymin, Zmin, Xmax, Ymax, Zmax | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -53,6 +34,6 @@ N/A 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. diff --git a/src/Plugins/ComplexCore/docs/ComputeMomentInvariants2DFilter.md b/src/Plugins/ComplexCore/docs/ComputeMomentInvariants2DFilter.md index d885cdc839..c36f245479 100644 --- a/src/Plugins/ComplexCore/docs/ComputeMomentInvariants2DFilter.md +++ b/src/Plugins/ComplexCore/docs/ComputeMomentInvariants2DFilter.md @@ -14,33 +14,7 @@ See below figure from [1] that can help the user classify objects. ![Example appllication of filter to identify elliptical particales (red) which are differentiated from non-elliptical particals (purple)](Images/ComputeMomentInvariants2D.png) -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Normalize MomentInvariants | Bool | Should the algorithm normalize the results to unit circle. | -| Save Central Moments | Bool | Write the Central Moments to a new Data Array | - -## Required Geometry - -ImageGeom - - CentralMomentsArrayPath 2 - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Cell **Attribute Array | FeatureIds | int32_t | (1) | The Feature Ids array to analyze for ellipsoids | -| Cell **Attribute Array | FeatureRectArray | uint32_t | (6) | Array holding the min xy and max xy pixel coordinates of each feature id | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Cell **Attribute Array | Omega1 | float | (1) | Omega1 value | -| Cell **Attribute Array | Omega2 | float | (1) | Omega2 value | -| Cell **Attribute Array | CentralMoments | float | (3)(3) | Central Moments value | +% Auto generated parameter table will be inserted here # Citations @@ -50,13 +24,12 @@ ImageGeom # Acknowledgements The authors would like to thank Dr. Marc De Graef from Carnegie Mellon University for enlightening discussions and a concrete implementation from which to start this filter. - ## 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. diff --git a/src/Plugins/ComplexCore/docs/ConditionalSetValue.md b/src/Plugins/ComplexCore/docs/ConditionalSetValue.md index 638ee93254..9294585937 100644 --- a/src/Plugins/ComplexCore/docs/ConditionalSetValue.md +++ b/src/Plugins/ComplexCore/docs/ConditionalSetValue.md @@ -24,39 +24,12 @@ This **Filter** replaces values in a user specified **Attribute Array** with a u | Double | 64 bit | -1.7e+308 to -2.2e-308, 0.0, 2.2e-308 to 1.7e+308 (15 digits)| | Boolean | 8 bit |0 = false and any other value will be forced to 1 = true| -## Parameters - -| Name | Type | Description | -|------------------|------|-------------| -| New Value | std::string | Value to replace the removed values in the array [will be typecasted to appropriate value later] | - -## Optional Data Mask - -| Name | Type | Description | -|------------------|------|-------------| -| Use Conditional Mask | bool | Whether to use a boolean mask array to replace values marked true | -| Invert Mask | bool | If checked values marked FALSE will be replaced instead | -| Any **Attribute Array | None | Bool | (1) | The complete path to the conditional array that will determine which values/entries will be replaced if index is true| -| Value to Replace | std::string | The numerical value that will be replaced in the array [will be typecasted to appropriate value later] | - -## Required Geometry - -Not Applicable - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Any **Attribute Array | None | Any | (1) | Path to **Attribute Array** that will have values replaced | - -## 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. diff --git a/src/Plugins/ComplexCore/docs/ConvertColorToGrayScaleFilter.md b/src/Plugins/ComplexCore/docs/ConvertColorToGrayScaleFilter.md index 0753da9540..3057199d7f 100644 --- a/src/Plugins/ComplexCore/docs/ConvertColorToGrayScaleFilter.md +++ b/src/Plugins/ComplexCore/docs/ConvertColorToGrayScaleFilter.md @@ -22,31 +22,7 @@ The following are some additional accepted grayscale conversions + RMY Greyscale: Red: 0.5 Green: 0.419 Blue: 0.081 + (YIQ/NTSC): Red: 0.299 Green: 0.587 Blue: 0.114 -## Parameters - -| Name | Type | Description | -|------|------|------| -| Flattening Method | Enumeration | Which method to use when flattening the RGB array | -| Luminosity Triplet | 3xFloats | Only used if Luminosity is selected as conversion method | -| Color Channel | 1 Int | Only needed if the Color Channel conversion method is selected | -| Output Array Prefix | String | This prefix will be added to each array name that is selected for conversion to form the new array name | - -## Required Geometry - -Not Applicable - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Element Attribute Array(s) | ImageData | uint8_t | (3) or (4) | RGB or RGBA values | - -## Created Objects - -| Kind | Default Name | Type | Component Dimensions (dimension, size) | Description | -|------|--------------|-----|-----|-----------------------------------| -| Element Attribute Array | GrayScale Data | uint8_t | (1) | Grayscale values | -| AttributeMatrix (Optional) | | | | | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -54,6 +30,6 @@ Not Applicable 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. diff --git a/src/Plugins/ComplexCore/docs/ConvertDataFilter.md b/src/Plugins/ComplexCore/docs/ConvertDataFilter.md index dbf3071b44..a6251c6db8 100644 --- a/src/Plugins/ComplexCore/docs/ConvertDataFilter.md +++ b/src/Plugins/ComplexCore/docs/ConvertDataFilter.md @@ -24,27 +24,7 @@ Down casting can have undefined behavior depending on the primitive types involv When converting data from signed values to unsigned values or vice-versa, there can also be undefined behavior. For example, if the user were to convert a signed 4 byte integer array to an unsigned 4 byte integer array and the input array has negative values, then the conversion rules are undefined and may differ from operating system to operating system. -## Parameters - -| Name | Type | Description | -|------------------|------|--------------| -| Scalar Type | Enumeration | Convert to this data type | - -## Required Geometry - -Not Applicable - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Any **Attribute Array** | None | Any | Any | Array to convert | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Any **Attribute Array | None | Any | Any | The converted array | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -52,6 +32,6 @@ Not Applicable 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. diff --git a/src/Plugins/ComplexCore/docs/CopyDataObjectFilter.md b/src/Plugins/ComplexCore/docs/CopyDataObjectFilter.md index 1c3c39c9ef..d214802e28 100644 --- a/src/Plugins/ComplexCore/docs/CopyDataObjectFilter.md +++ b/src/Plugins/ComplexCore/docs/CopyDataObjectFilter.md @@ -21,26 +21,7 @@ See the DataStructure section of the reference manual for a complete hierarchy. When the _Copy to New Parent_ is toggled true a new parameter will appear. This parameter, _Copied Parent Group_, allows for the selected arrays to all be copied into whatever data container you place here. -## Parameters - -None - -## Required Geometry - -Not Applicable - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| DataObject | N/A | N/A | N/A | The list of DataObjects to copy. | -| bool | false | N/A | N/A | Whether to copy the DataObjects to a new parent or not. | -| DataGroup | N/A | N/A | N/A | The group to be used as the parent for all the DataObject copies if the Copy to New Parent option is selected | -| string | _COPY | N/A | N/A | The suffix string to be appended to each copy's name | - -## Created Objects - -A deep copy of the DataObjects selected in the input. +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -48,6 +29,6 @@ A deep copy of the DataObjects selected in the input. 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. diff --git a/src/Plugins/ComplexCore/docs/CopyFeatureArrayToElementArray.md b/src/Plugins/ComplexCore/docs/CopyFeatureArrayToElementArray.md index b65293b732..191633ec44 100644 --- a/src/Plugins/ComplexCore/docs/CopyFeatureArrayToElementArray.md +++ b/src/Plugins/ComplexCore/docs/CopyFeatureArrayToElementArray.md @@ -8,26 +8,7 @@ Core (Memory/Management) This **Filter** copies the values associated with a **Feature** to all the **Elements** that belong to that **Feature**. Xmdf visualization files write only the **Element** attributes, so if the user wants to display a spatial map of a **Feature** level attribute, this **Filter** will transfer that information down to the **Element** level. -## Parameters - -None - -## Required Geometry - -Not Applicable - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Feature **Attribute Array** | None | Any | Any | Feature** data to copy to **Element** data | -| Element **Attribute Array | FeatureIds | int32_t | (1) | Specifies to which **Feature** each **Element** belongs | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Element **Attribute Array | None | Any | Any | Copied **Attribute Array** | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -35,6 +16,6 @@ Not Applicable 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. diff --git a/src/Plugins/ComplexCore/docs/CreateAttributeMatrixFilter.md b/src/Plugins/ComplexCore/docs/CreateAttributeMatrixFilter.md index 0316748fbb..a4a3ac885f 100644 --- a/src/Plugins/ComplexCore/docs/CreateAttributeMatrixFilter.md +++ b/src/Plugins/ComplexCore/docs/CreateAttributeMatrixFilter.md @@ -12,28 +12,7 @@ This **Filter** creates a new **Attribute Matrix**. If you wanted to create an **Attribute Matrix** to represent a 3D volume where the dimensions of the 3 orthogonal axesare X=3, y=4 and Z=5, then the *Tuple Dimensions* would have a value of (3, 4, 5). -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| DataObject Path | DataPath | Where **Attribute Matrix** will be created | -| Attribute Matrix Dimensions | Any | An array that contains the size of each tuple dimension | - -## Required Geometry - -Not Applicable - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Data Container | None | N/A | N/A | Data Container for the created **Attribute Matrix** | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Attribute Matrix** | None | Any | N/A | Created **Attribute Matrix** name | +% Auto generated parameter table will be inserted here ## Example Pipelines diff --git a/src/Plugins/ComplexCore/docs/CreateDataArray.md b/src/Plugins/ComplexCore/docs/CreateDataArray.md index cd75fdf33f..58289efdc7 100644 --- a/src/Plugins/ComplexCore/docs/CreateDataArray.md +++ b/src/Plugins/ComplexCore/docs/CreateDataArray.md @@ -55,29 +55,7 @@ If the parent is **NOT an Attribute Matrix**, then the user ***MUST*** set the t The number of components should be at least 1. Examples of *Number of Components* would be 3 for an RGB Image, 1 for a gray scale image, 1 for a scalar array, 4 for a quaternions array, etc. All values of the array will be initialized to the user set value. The initialization value text box must have a user entry or the default value *0* will be used. -## Parameters - -| Name | Type | Description | -|------------------|------|-------------| -| Set Tuple Dimensions | bool | This allows the user to set the tuple dimensions directly rather than just inheriting them. This option is NOT required if you are creating the Data Array in an Attribute Matrix | -| Numeric Type | Enumeration | Primitive data type for created array | -| Number of Components | int32_t | The number of components that each tuple contains. Matrix are row major form within SIMPL| -| Initialization Value | String | Initialization value for array | -| Data Format | String | This value will specify which data format is used by the array's data store. An empty string results in in-memory data store. | - -## Required Geometry - -Not Applicable - -## Required Objects - -None - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Any **Attribute Array | None | Any | Any | Created **Attribute Array** location and name | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -85,6 +63,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. diff --git a/src/Plugins/ComplexCore/docs/CreateDataGroup.md b/src/Plugins/ComplexCore/docs/CreateDataGroup.md index e3cee35018..d689600b43 100644 --- a/src/Plugins/ComplexCore/docs/CreateDataGroup.md +++ b/src/Plugins/ComplexCore/docs/CreateDataGroup.md @@ -10,23 +10,7 @@ This **Filter** creates a new **DataGroup**. Unlike _AttributeMatrix_, _DataGroup_s are capable of holding any _DataObject_ of any size. -## Parameters - -None - -## Required Geometry - -Not Applicable - -## Required Objects - -Not Applicable - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Data Container | DataContainer | N/A | N/A | Created **Data Container** name | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -34,6 +18,6 @@ Not Applicable 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. diff --git a/src/Plugins/ComplexCore/docs/CreateFeatureArrayFromElementArray.md b/src/Plugins/ComplexCore/docs/CreateFeatureArrayFromElementArray.md index fc8fbdb492..0b9e9eb6cc 100644 --- a/src/Plugins/ComplexCore/docs/CreateFeatureArrayFromElementArray.md +++ b/src/Plugins/ComplexCore/docs/CreateFeatureArrayFromElementArray.md @@ -8,27 +8,7 @@ Core (Memory/Management) This **Filter** copies all the associated **Element** data of a selected **Element Array** to the **Feature** to which the **Elements** belong. The value stored for each **Feature** will be the value of the *last element copied*. -## Parameters - -None - -## Required Geometry - -Not Applicable - -## Required Objects - -| Kind | Type | Comp Dims | Description | -|------|------|-------------|-------------| -| Element Array DataPath | Any | Any | Element** data to copy to **Feature** data | -| Element Array DataPath | int32_t | (1) | Specifies to which **Feature** each **Element** belongs | -| Cell Feature **Attribute Matrix | Cell Feauture | N/A | The path to the cell feature **Attribute Matrix | - -## Created Objects - -| Kind | Type | Comp Dims | Description | -|------|------|-------------|-------------| -| Feature Array DataPath | Any | Any | The copied array containing **Feature** data | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -36,6 +16,6 @@ Not Applicable 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. diff --git a/src/Plugins/ComplexCore/docs/CreateGeometryFilter.md b/src/Plugins/ComplexCore/docs/CreateGeometryFilter.md index 8bba09bf5c..af4e1b30ae 100644 --- a/src/Plugins/ComplexCore/docs/CreateGeometryFilter.md +++ b/src/Plugins/ComplexCore/docs/CreateGeometryFilter.md @@ -131,44 +131,7 @@ In this above example, the vertex information begins on line 4; thus, line 4 def When creating **Geometries**, remember to consider all the various rules for how a **Geometry** is stored and interpreted. In particular, remeber that **Element** Ids are always zero indexed, mesh-like **Geometries** obey the _right hand rule_ for windings and normal directions, and **Element** lists are by default considered _shared_. Note that although the storage scheme used by **DREAM.3D** (shared lists) is highly generic, some **Filters** may assume that the **Geometry** is reasonably _well formed_. -## Parameters - -| Geometry Type | Value | -| --|--| -| ImageGeometry | 0 | -| RectGridGeometry | 1 | -| VertexGeometry | 2 | -| EdgeGeometry | 3 | -| TriangleGeometry | 4 | -| QuadGeometry | 5 | -| TetGeometry | 6 | -| HexGeometry | 7 | - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Geometry Type | Enumeration | The type of **Geometry** to create | -| Treat Geometry Warnings as Errors | bool | Whether run time warnings for **Geometries** should be treated as errors | -| Array Handling | bool | Determines if the arrays that make up the geometry primitives should be **Moved** or **Copied** to the created Geometry object. | -| Dimensions | size_t (3x) | The number of cells in each of the X, Y, Z directions, if _Image_ is chosen | -| Origin | float (3x) | The origin of each of the axes in X, Y, Z order, if _Image_ is chosen | -| Resolution | float (3x) | The length scale of each voxel/pixel, if _Image_ is chosen | - -## Required Geometry # - -None - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Geometry Path | None | N/A | N/A | Data Path**in which to place the created**Geometry | -| Various **Attribute Arrays | None | float/int64_t | 1/2/3/4 | Various **Attribute Arrays** used to define the **Geometry** topology; see the above documentation for a detailed discussion of what kinds of information are needed for each **Geometry | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Various **Attribute Matrices | None | Vertex/Edge/Face/Cell | N/A | Various **Attribute Matrices** used to store information for the new **Geometry**; see the above documentation for a detailed discussion of what kinds of **Attribute Matrices** are created for each **Geometry | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -182,6 +145,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. diff --git a/src/Plugins/ComplexCore/docs/CreateImageGeometry.md b/src/Plugins/ComplexCore/docs/CreateImageGeometry.md index dad59dc424..d591fe8594 100644 --- a/src/Plugins/ComplexCore/docs/CreateImageGeometry.md +++ b/src/Plugins/ComplexCore/docs/CreateImageGeometry.md @@ -14,27 +14,7 @@ This **Filter** creates an **Image Geometry** specifically for the representatio If you are reading in raw binary data that represents data on a rectilinear grid, the user will need to run this filter first to create a description of the **Geometry**. -## Parameters - -| Name | Type | Description | -|------------------|------|-------------| -| Dimensions | size_t (3x) | The number of cells in each of the X, Y, Z directions | -| Origin | float (3x) | The origin of each of the axes in X, Y, Z order | -| Resolution | float (3x) | The length scale of each voxel/pixel | - -## Required Geometry - -Not Applicable - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Data Container | None | N/A | N/A | Data Container in which to place the created **Image Geometry | - -## Created Objects - -Not Applicable +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -42,6 +22,6 @@ Not Applicable 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. diff --git a/src/Plugins/ComplexCore/docs/CropImageGeometry.md b/src/Plugins/ComplexCore/docs/CropImageGeometry.md index 75706f2e27..160cee98a9 100644 --- a/src/Plugins/ComplexCore/docs/CropImageGeometry.md +++ b/src/Plugins/ComplexCore/docs/CropImageGeometry.md @@ -19,23 +19,7 @@ The user has the option to save the cropped volume as a new **Data Container** o Normally this **Filter** will leave the origin of the volume set at (0, 0, 0), which means output files like the Xdmf file will have the same (0, 0, 0) origin. When viewing both the original larger volume and the new cropped volume simultaneously the cropped volume and the original volume will have the same origin which makes the cropped volume look like it was shifted in space. In order to keep the cropped volume at the same absolute position in space the user should turn **ON** the *Update Origin* check box. -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Image Geom | DataPath | DataPath to the target ImageGeom | -| New Image Geom | DataPath | Created ImageGeom | -| Min Voxels | std::vector | Lower bounds of the volume to crop out | -| Max Voxels | std::vector | Upper bounds of the volume to crop out | -| Renumber Features | bool | Whether the **Features** should be renumbered | -| Features IDs | DataPath | DataPath to the target Feature IDs array | -| Voxel Arrays | std::vector | DataArrays to crop | -| New Cell Features Group Name | std::string | Specifies the name of the DataGroup containing cropped DataArrays | -| Remove Original Geometry | bool | Whether the current **Geometry** should be removed after cropping | - -## Required Geometry - -Image +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -43,6 +27,6 @@ Image 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. diff --git a/src/Plugins/ComplexCore/docs/CropVertexGeometry.md b/src/Plugins/ComplexCore/docs/CropVertexGeometry.md index c06deb0371..a614f7c4d2 100644 --- a/src/Plugins/ComplexCore/docs/CropVertexGeometry.md +++ b/src/Plugins/ComplexCore/docs/CropVertexGeometry.md @@ -10,29 +10,7 @@ This **Filter** crops a **Vertex Geometry** by the given bounding box. Unlike t *Note:* Since it cannot be known before run time how many **Vertices** will be removed during cropping, the new **Vertex Geometry** and all associated **Vertex** data to be copied will be initialized to have size 0. Any **Feature** or **Ensemble** information will retain the same dimensions and size. -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Cropped Vertex Geometry | DataPath | Created VertexGeom Path | -| Vertex Data Name | String | Name of Vertex DataObject | -| Minimum Vertex Position | vec3 | the minimum x,y,z position | -| Maximum Vertex Position | vec3 | the maximum x,y,z position | -| Vertex Data Arrays to Crop | DataPath(s) | The path to all vertex data arrays to crop | - -## Required Geometry # - -Vertex - -## Required Objects - -None - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Cropped **Data Group | CroppedDataContainer | N/A | N/A | Data Container holding the cropped **Vertex Geometry** and any copied **Attribute Matrices** and **Attribute Arrays | +% Auto generated parameter table will be inserted here ## Example Pipelines diff --git a/src/Plugins/ComplexCore/docs/DeleteData.md b/src/Plugins/ComplexCore/docs/DeleteData.md index b657ce0e8f..a1044ccbed 100644 --- a/src/Plugins/ComplexCore/docs/DeleteData.md +++ b/src/Plugins/ComplexCore/docs/DeleteData.md @@ -8,23 +8,7 @@ Core (Memory/Management) This **Filter** allows the user to remove specified objects from the existing structure. This can be helpful if the user has operations that need as much memory as possible and there are extra objects that are not needed residing in memory. Alternatively, this **Filter** allows the user to remove objects that may share a name with another object further in the **Pipeline** that another **Filter** tries to create, since DREAM.3D generally does not allows objects at the same hierarchy to share the same name. -## Parameters - -None - -## Required Geometry - -Not Applicable - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Any | None | Any | Any | Objects to delete | - -## Created Objects - -None +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -32,6 +16,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. diff --git a/src/Plugins/ComplexCore/docs/ErodeDilateBadDataFilter.md b/src/Plugins/ComplexCore/docs/ErodeDilateBadDataFilter.md index 8edbb42309..4e84a98109 100644 --- a/src/Plugins/ComplexCore/docs/ErodeDilateBadDataFilter.md +++ b/src/Plugins/ComplexCore/docs/ErodeDilateBadDataFilter.md @@ -47,30 +47,7 @@ would remove the single **Cells** and reduce the pores by one **Cell**. If this operation, then the pores would grow by one **Cell** and return to near their original size, while the single **Cells** would remain removed and not "grow back". -## Parameters - -| Name | Type | Description | -|-------------|-------------|------------------------------------------------------| -| Operation | Enumeration | Whether to erode (0) or dilate (1) | -| Number of Iterations | int32_t | The number of iterations to use for erosion/dilation | -| X Direction | bool | Whether to erode/dilate in the X direction | -| Y Direction | bool | Whether to erode/dilate in the Y direction | -| Z Direction | bool | Whether to erode/dilate in the Z direction | - -## Required Geometry - -Image - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Image Geometry** | Image Geometry | DataPath | N/A | The path to the Image Geometry where the feature Ids are stored. | -| Cell Attribute Array | FeatureIds | int32 | (1) | Specifies to which **Feature** each **Cell** belongs | - -## Created Objects - -None +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -82,6 +59,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. diff --git a/src/Plugins/ComplexCore/docs/ErodeDilateCoordinationNumberFilter.md b/src/Plugins/ComplexCore/docs/ErodeDilateCoordinationNumberFilter.md index fb76f6c4ad..ccdbe033b9 100644 --- a/src/Plugins/ComplexCore/docs/ErodeDilateCoordinationNumberFilter.md +++ b/src/Plugins/ComplexCore/docs/ErodeDilateCoordinationNumberFilter.md @@ -23,27 +23,7 @@ Gone* parameter, which will continue to run until no **Cells** fail the original |--------------------------------------|--------------------------------------| | ![](Images/ErodeDilateCoordinationNumber_Before.png) | ![](Images/ErodeDilateCoordinationNumber_After.png) | -## Parameters - -| Name | Type | Description | -|---------------------|---------|------------------------------------------------------------------------------------------------------------------------------------| -| Coordination Number | int32_t | Number of neighboring **Cells** that can be of opposite classification before a **Cell** will be removed | -| Loop Until Gone | bool | Whether to run a single iteration or iterate until no *bad* **Cells** have more than the above number of *good* neighbor **Cells | - -## Required Geometry - -Image - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Image Geometry** | Image Geometry | DataPath | N/A | The path to the Image Geometry where the feature Ids are stored. | -| 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 ## Example Pipelines @@ -51,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. diff --git a/src/Plugins/ComplexCore/docs/ErodeDilateMaskFilter.md b/src/Plugins/ComplexCore/docs/ErodeDilateMaskFilter.md index 20a3b849c7..aa6b31aeb8 100644 --- a/src/Plugins/ComplexCore/docs/ErodeDilateMaskFilter.md +++ b/src/Plugins/ComplexCore/docs/ErodeDilateMaskFilter.md @@ -25,29 +25,7 @@ The example images below were generated **AFTER** the execution of the filter an |--------------------------------------|--------------------------------------| | ![](Images/ErodeDilateMask_Before.png) | ![](Images/ErodeDilateMask_Erode.png) | -## Parameters - -| Name | Type | Description | -|-------------|-------------|------------------------------------------------------| -| Operation | Enumeration | Whether to dilate or erode | -| Number of Iterations | int32_t | The number of iterations to use for erosion/dilation | -| X Direction | bool | Whether to erode/dilate in the X direction | -| Y Direction | bool | Whether to erode/dilate in the Y direction | -| Z Direction | bool | Whether to erode/dilate in the Z direction | - -## Required Geometry - -Image - -## Required Objects - -| Kind | Default Name | Type | Component Dimensionss | Description | -|--------------------------|--------------|------|-----------------------|-----------------------------------------------------------| -| Cell Attribute Array | Mask | bool | (1) | Used to define whether the **Cells** are part of the mask | - -## Created Objects - -None +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -55,6 +33,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. diff --git a/src/Plugins/ComplexCore/docs/ExecuteProcessFilter.md b/src/Plugins/ComplexCore/docs/ExecuteProcessFilter.md index 5bec711da2..e8018b0952 100644 --- a/src/Plugins/ComplexCore/docs/ExecuteProcessFilter.md +++ b/src/Plugins/ComplexCore/docs/ExecuteProcessFilter.md @@ -22,26 +22,7 @@ For a command with spaces in the path > "C:/Program Files/DREAM3D-6.6.332/nxrunner.exe" "C:/Program Files/DREAM3D-6.6.332/PrebuiltPipelines/Workshop/EBSD Reconstruction/(01) SmallIN100 Archive.json" -## Parameters - -| Name | Type | Description | -|------------------|------|-------------| -| Command Line | String| The complete command to execute. | -| Should Block | Bool | Whether to block the pipeline process while the command executes or not. | -| Timeout | Int32 | The amount of time (in ms) to wait for the command to start/finish when blocking is selected. | -| Output Log File | File Path | The log file where the output from the process will be stored. | - -## Required Geometry - -Not Applicable - -## Required Objects - -None - -## Created Objects - -None +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -51,6 +32,6 @@ ExecuteProcess 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. diff --git a/src/Plugins/ComplexCore/docs/ExportDREAM3DFilter.md b/src/Plugins/ComplexCore/docs/ExportDREAM3DFilter.md index 1b765009ff..7df7886ab3 100644 --- a/src/Plugins/ComplexCore/docs/ExportDREAM3DFilter.md +++ b/src/Plugins/ComplexCore/docs/ExportDREAM3DFilter.md @@ -4,24 +4,7 @@ This **Filter** dumps the data structure to an hdf5 file with the .dream3d extension. -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Export File Path | Filesystem Path | The file path the DataStructure should be written to as an HDF5 file. | -| Write Xdmf File | bool | Whether or not to write the data out an xdmf file | - -## Required Geometry # - -None - -## Required Objects - -None - -## Created Objects - -None +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -31,6 +14,6 @@ ALL 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. diff --git a/src/Plugins/ComplexCore/docs/ExtractComponentAsArrayFilter.md b/src/Plugins/ComplexCore/docs/ExtractComponentAsArrayFilter.md index 11d3828940..ef4932af77 100644 --- a/src/Plugins/ComplexCore/docs/ExtractComponentAsArrayFilter.md +++ b/src/Plugins/ComplexCore/docs/ExtractComponentAsArrayFilter.md @@ -12,29 +12,7 @@ This **Filter** will do one of the following to one component of a multicomponen - Extract 1 component from multicomponent **Attribute Array** and store it in a new **DataArray** without removing from original - Extract 1 component from multicomponent **Attribute Array** and store it in a new **DataArray** and remove that component from the original -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Move Extracted Components To New Array | bool | The bool that determines if extracted components will be stored in new array | -| Remove Extracted Components from Old Array | bool | The bool that determines if extracted components will be deleted from original array | -| Component Number to Extract | int32_t | The index of which component to extract | - -## Required Geometry - -Not Applicable - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Any **Attribute Array | None | Any | >1 | Multicomponent **Attribute Array** to use as input | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Any **Attribute Array | None | Any | (1) | Scalar **Attribute Array** name | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -42,6 +20,6 @@ Not Applicable 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. diff --git a/src/Plugins/ComplexCore/docs/ExtractInternalSurfacesFromTriangleGeometry.md b/src/Plugins/ComplexCore/docs/ExtractInternalSurfacesFromTriangleGeometry.md index e3179a9444..f8a5d08a19 100644 --- a/src/Plugins/ComplexCore/docs/ExtractInternalSurfacesFromTriangleGeometry.md +++ b/src/Plugins/ComplexCore/docs/ExtractInternalSurfacesFromTriangleGeometry.md @@ -21,27 +21,7 @@ This **Filter** has the effect of removing any **Triangles** that only contain * It is unknown until runtime how the **Geometry** will be changed by removing certain **Vertices** and **Triangles**. -## Parameters - -None - -## Required Geometry # - -Triangle - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Vertex Data Array | NodeTypes | int8 | (1) | Specifies the type of node in the **Geometry | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Geometry | None | Triangle | N/A | The new Triangle Geometry | -| Attribute Matrix | Vertex Data | N/A | N/A | Created vertex data AttributeMatrix name | -| Attribute Matrix | Face Data | N/A | N/A | Created face data AttributeMatrix name | +% Auto generated parameter table will be inserted here ## Example Pipelines diff --git a/src/Plugins/ComplexCore/docs/ExtractVertexGeometryFilter.md b/src/Plugins/ComplexCore/docs/ExtractVertexGeometryFilter.md index 178415894f..8976d3062a 100644 --- a/src/Plugins/ComplexCore/docs/ExtractVertexGeometryFilter.md +++ b/src/Plugins/ComplexCore/docs/ExtractVertexGeometryFilter.md @@ -10,22 +10,7 @@ This filter will extract all the voxel centers of an Image Geometry or a Rectili into a new VertexGeometry. The user is given the option to copy or move cell arrays over to the newly created VertexGeometry. -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Array Handling | int | 0=Move Arrays, 1=Copy Arrays | -| Use Mask | Bool | Use a mask array to determine which vertices are extracted | -| Mask | DataPath | The path to the mask array | -| Input Geometry | DataPath | The path to the input geometry that will be extracted into a vertex geometry | -| Included Attribute Arrays | std::vector | List of DataPaths to either copy or move | -| Output Vertex Geometry | DataPath | The path to the vertex geometry that will be output by this filter | -| Output Vertex Attribute Matrix Name | string | The name of the vertex attribute matrix that will be created as a child of the output vertex geometry | -| Output Shared Vertex List Name | string | The name of the shared vertex list name that will be output with the vertex geometry | - -## Required Geometry - -Required Geometry Type: **ImageGeom** or **RectGridGeom** +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -35,6 +20,6 @@ PrebuiltPipelines/Examples/Extract Vertex Geometry.json 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. diff --git a/src/Plugins/ComplexCore/docs/FeatureDataCSVWriterFilter.md b/src/Plugins/ComplexCore/docs/FeatureDataCSVWriterFilter.md index c5f0945d46..af879ddbb2 100644 --- a/src/Plugins/ComplexCore/docs/FeatureDataCSVWriterFilter.md +++ b/src/Plugins/ComplexCore/docs/FeatureDataCSVWriterFilter.md @@ -39,28 +39,7 @@ The *CSV* file with Write Neighbor Data checked: 4,1,886 5,26,61,224,278,454,786,923,1119,1137,1478,1517,1525,1651,1812,1814,2227,2233,2731,2750,2907,2930,3175,3548,3619,4492,4791,5010 -## Parameters - -| Name | Type |Description | -|------|------|------| -| Output File | File Path | The output .csv file path | -| Write Neighbor Data | bool | Whether to write the **Feature** neighbor data | -| Write Number of Features Line | bool | Write the total number of features as the first line. Writing this line may interfere with standard CSV parsers. Default=ON | -| Delimiter | choice | The delimiter character used to parse the file (Takes *COMMA*, *SEMICOLON*, *COLON*, *TAB*, or *SPACE*) | - -## Required Geometry - -Not Applicable - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| AttributeMatrix | None | Feature | N/A | AttributeMatrix** that holds the data to write | - -## Created Objects - -None +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -70,6 +49,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. diff --git a/src/Plugins/ComplexCore/docs/FeatureFaceCurvatureFilter.md b/src/Plugins/ComplexCore/docs/FeatureFaceCurvatureFilter.md index 4422082d86..7a9b054680 100644 --- a/src/Plugins/ComplexCore/docs/FeatureFaceCurvatureFilter.md +++ b/src/Plugins/ComplexCore/docs/FeatureFaceCurvatureFilter.md @@ -16,42 +16,7 @@ Principal Curvatures 1 and 2 are the κ 1 and κ 2 1). Only created if *Compute Principal Direction Vectors*is checked | -|**Face Attribute Array**| PrincipalCurvature2 | double | (1) | Second set eigenvalues of the Wiengarten matrix (κ2). Only created if *Compute Principal Direction Vectors*is checked | -|**Face Attribute Array**| PrincipalDirection1 | double | (3) | First set of eigenvectors. Only created if *Compute Principal Direction Vectors*is checked | -|**Face Attribute Array**| PrincipalDirection2 | double | (3) | Second set of eigenvectors. Only created if *Compute Principal Direction Vectors*is checked | -|**Face Attribute Array**| MeanCurvatures | double | (1) | Mean curvature values. Only created if *Compute Mean Curvature*is checked | -|**Face Attribute Array**| GaussianCurvatures | double | (1) | Gaussian curvature values. Only created if *Compute Gaussian Curvature*is checked | -|**Face Attribute Array**| WeingartenMatrix | double | (4) | Weingarten matrix values. Only created if *Compute Weingarten Matrix*is checked | +% Auto generated parameter table will be inserted here ## References diff --git a/src/Plugins/ComplexCore/docs/FillBadDataFilter.md b/src/Plugins/ComplexCore/docs/FillBadDataFilter.md index 9f38ab1e53..5f98612b74 100644 --- a/src/Plugins/ComplexCore/docs/FillBadDataFilter.md +++ b/src/Plugins/ComplexCore/docs/FillBadDataFilter.md @@ -14,28 +14,7 @@ This **Filter** removes small *noise* in the data, but keeps larger regions that The above images show the before and after results of running this filter with a minimum defect size of 1000 voxels. Note that because the minimum defect size was set to 1000 voxels that the over scan area was not modified (the area in all black around the sample). -## Parameters - -| Name | Type | Decision | -|------|------|------| -| Minimum Allowed Defect Size | int32_t | The size at which a group of *bad* **Cells** are left unfilled as a "defect" | -| Replace Bad Data | bool | Whether to replace all data or just *Feature Ids* | -| Store Defects as New Phase | bool | Will update voxels that are part of larger defects to have a new phase value | - -## 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 | -| Cell Attribute Array | Phases | int32_t | (1) | Specifies to which **Ensemble** each **Cell** belongs. Only required if *Store Defects as New Phase* is checked | - -## Created Objects - -None +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -45,6 +24,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. diff --git a/src/Plugins/ComplexCore/docs/FindArrayStatisticsFilter.md b/src/Plugins/ComplexCore/docs/FindArrayStatisticsFilter.md index 00fe7b6205..c207afb58f 100644 --- a/src/Plugins/ComplexCore/docs/FindArrayStatisticsFilter.md +++ b/src/Plugins/ComplexCore/docs/FindArrayStatisticsFilter.md @@ -32,59 +32,7 @@ Special operations occur for certain statistics if the supplied array is of type **Note**: If *Find Histogram* is on AND *Compute Statistics Per Feature/Ensemble* is on, then any features that have the exact same value throughout the entire feature will have its first histogram bin set to the total count of feature values. All other bins will be 0. -## Parameters - -| Name | Type | Description | -|-----------------------------------------|----------|--------------------------------------------------------| -| Find Histogram | bool | Whether to compute the histogram of the input array | -| Histogram Min Value | double | Min cutoff value for histogram | -| Histogram Max Value | double | Max cutoff value for histogram | -| Number of Bins | int32_t | Number of bins in histogram | -| Use Full Range For Histogram | bool | If true, ignore min and max and use min and max from array upon which histogram is computed | -| Find Length | bool | Whether to compute the length of the input array | -| Find Minimum | bool | Whether to compute the minimum of the input array | -| Find Maximum | bool | Whether to compute the maximum of the input array | -| Find Mean | bool | Whether to compute the arithmetic mean of the input array | -| Find Median | bool | Whether to compute the median of the input array | -| Find Mode | bool | Whether to compute the mode of the input array. The input array may have multiple modes, so the modes are stored in a NeighborList. | -| Find Standard Deviation | bool | Whether to compute the standard deviation of the input array | -| Find Summation | bool | Whether to compute the summation of the input array | -| Find Number of Unique Values | bool | Whether to compute the number of unique values in the input array | -| Use Mask | bool | Whether to use a boolean mask array to ignore certain points flagged as *false* from the statistics | -| Compute Statistics Per Feature/Ensemble | bool | Whether the statistics should be computed on a **Feature/Ensemble** basis | -| Standardize Data | bool | Whether the input array should be standardized to have mean of 0 and unit variance; *Find Mean* and *Find Standard Deviation* must be selected to use this option | - -## Required Geometry - -None - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Any **Attribute Array | None | Any | (1) | Input **Attribute Array** for which to compute statistics | -| Attribute Array | None | int32_t | (1) | Specifies to which **Feature/Ensemble** each point in the input **Attribute Array** belongs, if *Compute Statistics Per Feature/Ensemble* is checked | -| Attribute Array | Mask | bool | (1) | Specifies if the point is to be counted in the statistics, if *Use Mask* is checked | -| Destination **Attribute Matrix | None | Any | N/A | Attribute Matrix** in which to store the computed statistics | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Attribute Array | Feature-Has-Data | bool | (1) | Indicates, for each feature, whether or not the feature actually contains any data (only usable when *Compute Statistics Per Feature/Ensemble* is turned on). This array is especially useful to help determine whether or not the outputted statistics are actually valid or not for a given feature. | -| Attribute Array | Histogram | uint64 | (Number of Bins) | Histogram of the input array, if *Find Histogram* is checked | -| Attribute Array | Most Populated Bin | uint64 | (2) | Most populated bin from the histogram of the input array, if *Find Histogram* is checked. First component is the bin index (0-based), second component is the number of values in the bin. | -| Neighbor List** | Modal Histogram Bin Ranges | float | (1) | Ranges, in physical units, of histogram bin(s) that contain mode value(s). *Find Histogram*, *Find Modal Histogram Bin Ranges*, and *Find Mode* must all be checked. The min/max values are stored in the neighbor list arrays from bin 0 - bin N (Example: [bin0min, bin0max, bin1min, bin1max, ... binNmin, binNmax]) | -| Attribute Array | Length | int64_t | (1) | Length of the input array, if *Find Length* is checked | -| Attribute Array | Minimum | same as input **Attribute Array | (1) | Minimum of the input array, if *Find Minimum* is checked | -| Attribute Array | Maximum | same as input **Attribute Array | (1) | Maximum of the input array, if *Find Maximum* is checked | -| Attribute Array | Mean | double | (1) | Arithmetic mean of the input array, if *Find Mean* is checked | -| Attribute Array | Median | double | (1) | Median of the input array, if *Find Median* is checked | -| Neighbor List** | Mode | same as input **Attribute Array | (1) | Modes of the input array, if *Find Mode* is checked | -| Attribute Array | Standard Deviation | double | (1) | Standard deviation of the input array, if *Find Standard Deviation* is checked | -| Attribute Array | Summation | double | (1) | Summation of the input array, if *Find Summation* is checked | -| Attribute Array | Standardized | double | (1) | Standardized version of the input array, if *Standardize Data* is checked | -| Attribute Array | Number of Unique Values | int32_t | (1) | The number of unique values in the input array, if *Find Number of Unique Values* is checked | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -92,6 +40,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. diff --git a/src/Plugins/ComplexCore/docs/FindBiasedFeaturesFilter.md b/src/Plugins/ComplexCore/docs/FindBiasedFeaturesFilter.md index 4863852434..788a7ee75a 100644 --- a/src/Plugins/ComplexCore/docs/FindBiasedFeaturesFilter.md +++ b/src/Plugins/ComplexCore/docs/FindBiasedFeaturesFilter.md @@ -22,29 +22,7 @@ By definition of the box, no **Feature** that intersects an outer surface of the The images below show the feature ids before and after running this filter. The image on the right shows the biased features colored in red, the unbiased features colored by their feature id, the bounding box (described in step 3 of the algorithm above), and the feature centroids (white for unbiased and purple for biased). ![2D Before and After Biased Features](Images/FindBiasedFeaturesBeforeAndAfter.png) -## Parameters - -| Name | Type | Description | -|------------------|------|-------------| -| Apply Phase by Phase | bool | Whether to apply the biased **Features** algorithm per Ensemble | - -## Required Geometry - -Image - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Feature Attribute Array | Centroids | float | (3) | X, Y, Z coordinates of **Feature** center of mass | -| Feature Attribute Array | SurfaceFeatures | bool | (1) | Flag of 1 if **Feature** touches an outer surface or of 0 if it does not | -| Feature Attribute Array | Phases | int32_t | (1) | Specifies to which **Ensemble** each **Feature** belongs. Only required if *Apply Phase by Phase* is checked | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Feature Attribute Array | BiasedFeatures | bool | (1) | Flag of 1 if **Feature** is biased or of 0 if it is not | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -54,6 +32,6 @@ Image 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. diff --git a/src/Plugins/ComplexCore/docs/FindBoundaryCellsFilter.md b/src/Plugins/ComplexCore/docs/FindBoundaryCellsFilter.md index b285de1a20..fd62731913 100644 --- a/src/Plugins/ComplexCore/docs/FindBoundaryCellsFilter.md +++ b/src/Plugins/ComplexCore/docs/FindBoundaryCellsFilter.md @@ -17,28 +17,7 @@ This **Filter** determines, for each **Cell**, the number of neighboring **Cells |--|--| | ![Feature Ids](Images/FindBoundaryCellsInput.png) | ![Boundary Cells](Images/FindBoundaryCellsOutput.png) | -## Parameters - -| Name | Type | Description | -|------------------|------|-------------| -| Ignore Feature 0 | bool | Do not use feature 0 | -| Include Volume Boundary | bool | Include the Cell boundaries | - -## 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 - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Cell Attribute Array | BoundaryCells | int8_t | (1) | The number of neighboring **Cells** of a given **Cell** that belong to a different **Feature** than itself. Values will range from *0* to *6* | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -48,6 +27,6 @@ Image 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. diff --git a/src/Plugins/ComplexCore/docs/FindBoundaryElementFractionsFilter.md b/src/Plugins/ComplexCore/docs/FindBoundaryElementFractionsFilter.md index f5f2b289a4..be767b02d5 100644 --- a/src/Plugins/ComplexCore/docs/FindBoundaryElementFractionsFilter.md +++ b/src/Plugins/ComplexCore/docs/FindBoundaryElementFractionsFilter.md @@ -8,27 +8,7 @@ Statistics (Morphological) This **Filter** calculates the fraction of **Elements** of each **Feature** that are on the "surface" of that **Feature**. The **Filter** simply iterates through all **Elements** asking for the **Feature** that owns them and if the **Element** is a "surface" **Element**. Each **Feature** counts the total number of **Elements** it owns and the number of those **Elements** that are "surface" **Elements**. The fraction is then stored for each **Feature**. -## Parameters - -None - -## Required Geometry - -Not Applicable - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Element Attribute Array | Feature Ids | int32 | (1) | Specifies to which **Feature** each **Element** belongs | -| Element Attribute Array | Surface Elements | int32 | (1) | The number of neighboring **Elements** of a given **Element** that belong to a different **Feature** than itself | -| Attribute Matrix | Feature Data | AttributeMatrix | N/A | Parent Attribute Matrix for the *Surface Element Fractions* Array to be created in | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Feature Attribute Array | Surface Element Fractions | float32 | (1) | Fraction of **Elements** belonging to the **Feature** that are "surface" **Elements | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -36,6 +16,6 @@ Not Applicable 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. diff --git a/src/Plugins/ComplexCore/docs/FindDifferencesMap.md b/src/Plugins/ComplexCore/docs/FindDifferencesMap.md index 473b36ab1a..fc629d7460 100644 --- a/src/Plugins/ComplexCore/docs/FindDifferencesMap.md +++ b/src/Plugins/ComplexCore/docs/FindDifferencesMap.md @@ -18,26 +18,7 @@ Note that in the above algorithm, the difference is taken as the *first selected **WARNING: The resulting difference values *may be negative* if the values of the first array are smaller than those in the second array. Therefore, if the two arrays are *unsigned integers*, it may be possible to underflow the resulting difference map values if the first array is sufficiently smaller than the second array. "Underflow" means that what should be a negative value will end up being a potentially very large value!** -## Parameters - -None - -## Required Geometry - -Not Applicable - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Any **Attribute Array | None | Any | Any | The first selected **Attribute Array**. This array's values will be the first argument for the subtraction operation | -| Any **Attribute Array | None | Any | Any | The second selected **Attribute Array**. This array's values will be subtracted from the first selected **Attribute Array** values | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Any **Attribute Array | DifferenceMap | Same as input arrays | Same as input arrays | The difference map **Attribute Array | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -45,6 +26,6 @@ Not Applicable 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. diff --git a/src/Plugins/ComplexCore/docs/FindEuclideanDistMapFilter.md b/src/Plugins/ComplexCore/docs/FindEuclideanDistMapFilter.md index 74476a061d..a1b755bd61 100644 --- a/src/Plugins/ComplexCore/docs/FindEuclideanDistMapFilter.md +++ b/src/Plugins/ComplexCore/docs/FindEuclideanDistMapFilter.md @@ -20,34 +20,7 @@ This **Filter** calculates the distance of each **Cell** from the nearest **Feat 4. If the option *Calculate Manhattan Distance* is *false*, then the "city-block" distances are overwritten with the *Euclidean Distance* from the **Cell** to its *nearest neighbor* **Cell** and stored in a *float* array instead of an *integer* array. -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Calculate Manhattan Distance | bool | Whether the distance to boundaries, triple lines and quadruple points is stored as "city block" or "Euclidean" distances | -| Calculate Distance to Boundaries | bool | Whetherthe distance of each **Cell** to a **Feature** boundary is calculated | -| Calculate Distance to Triple Lines | bool | Whetherthe distance of each **Cell** to a triple line between **Features** is calculated | -| Calculate Distance to Quadruple Points | bool | Whetherthe distance of each **Cell** to a quadruple point between **Features** is calculated | -| Store the Nearest Boundary Cells | bool | Whether to store the *nearest neighbors* of **Cell** - -## 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 - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Cell Attribute Array | GBEuclideanDistances | float | (1) | Distance the **Cells** are from the *boundary* of the **Feature** they belong to. Only created if *Calculate Distance to Boundaries* is checked | -| Cell Attribute Array | TJEuclideanDistances | float | (1) | Distance the **Cells** are from a *triple junction* of **Features**. Only created if *Calculate Distance to Triple Lines* is checked | -| Cell Attribute Array | QPEuclideanDistances | float | (1) | Distance the **Cells** are from a *quadruple point* of **Features**. Only created if *Calculate Distance to Quadruple Points* is checked | -| Cell Attribute Array | NearestNeighbors | int32_t | (3) | Indices of the closest **Cell** that touches a boundary, triple and quadruple point for each **Cell**. Only created if *Store the Nearest Boundary Cells* is checked | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -57,6 +30,6 @@ Image 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. diff --git a/src/Plugins/ComplexCore/docs/FindFeatureCentroidsFilter.md b/src/Plugins/ComplexCore/docs/FindFeatureCentroidsFilter.md index 2c41a73b1e..dbfad0da92 100644 --- a/src/Plugins/ComplexCore/docs/FindFeatureCentroidsFilter.md +++ b/src/Plugins/ComplexCore/docs/FindFeatureCentroidsFilter.md @@ -8,25 +8,7 @@ Generic (Misc) This **Filter** calculates the *centroid* of each **Feature** by determining the average X, Y, and Z position of all the **Cells** belonging to the **Feature**. Note that **Features** that intersect the outer surfaces of the sample will still have *centroids* calculated, but they will be *centroids* of the truncated part of the **Feature** that lies inside the sample. -## Parameters - -None - -## 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 - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Feature Attribute Array | Centroids | float | (3) | X, Y, Z coordinates of **Feature** center of mass | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -38,6 +20,6 @@ Image 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. diff --git a/src/Plugins/ComplexCore/docs/FindFeatureClusteringFilter.md b/src/Plugins/ComplexCore/docs/FindFeatureClusteringFilter.md index c04665d9b8..a62992b78c 100644 --- a/src/Plugins/ComplexCore/docs/FindFeatureClusteringFilter.md +++ b/src/Plugins/ComplexCore/docs/FindFeatureClusteringFilter.md @@ -16,36 +16,7 @@ This Filter determines the radial distribution function (RDF), as a histogram, o *Note:* Because the algorithm iterates over all the **Features**, each distance will be double counted. For example, the distance from **Feature** 1 to **Feature** 2 will be counted along with the distance from **Feature** 2 to **Feature** 1, which will be identical. -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Number of Bins for RDF | int32_t | Number of bins to split the RDF | -| Phase Index | int32_t | Ensemble** number for which to calculate the RDF and clustering list | -| Remove Biased Features | bool | Default=OFF | -| Set Random Seed | bool | When checked, allows the user to set the seed value used to randomly generate the points in the RDF (Default=ON) | -| Seed Value | uint64_t | The seed value used to generate the points in the RDF when the Set Random Seed option is ON | - -## Required Geometry - -Image - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Feature Attribute Array | EquivalentDiameters | float | (1) | Diameter of a sphere with the same volume as the **Feature | -| Feature Attribute Array | Phases | int32_t | (1) | Specifies to which **Ensemble** each **Feature** belongs | -| Feature Attribute Array | Centroids | float | (3) | X, Y, Z coordinates of **Feature** center of mass | -| Feature Attribute Array | BiasedFeatures | bool | (1) | Specifies which features are biased and therefor should be removed if the Remove Biased Features option is on | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Feature Attribute Array | ClusteringList | float | (1) | Distance of each **Features**'s centroid to ever other **Features**'s centroid | -| Ensemble Attribute Array | RDF | float | (Number of Bins) | A histogram of the normalized frequency at each bin | -| Ensemble Attribute Array | RDFMaxMinDistances | float | (2) | The max and min distance found between **Features | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -55,6 +26,6 @@ Image 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. diff --git a/src/Plugins/ComplexCore/docs/FindFeaturePhasesBinaryFilter.md b/src/Plugins/ComplexCore/docs/FindFeaturePhasesBinaryFilter.md index 539fd61990..6cb7a90b86 100644 --- a/src/Plugins/ComplexCore/docs/FindFeaturePhasesBinaryFilter.md +++ b/src/Plugins/ComplexCore/docs/FindFeaturePhasesBinaryFilter.md @@ -8,27 +8,7 @@ Generic (Misc) This **Filter** assigns an **Ensemble** Id number to binary data. The *true* **Cells** will be **Ensemble** 1, and *false* **Cells** will be **Ensemble** 0. This **Filter** is generally useful when the **Cell Ensembles** were not known ahead of time. For example, if an image is segmented into precipitates and non-precipitates, this **Filter** will assign the precipitates to **Ensemble** 1, and the non-precipitates to **Ensemble** 0. -## Parameters - -None - -## 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 | -| Cell Attribute Array | Mask | bool | (1) | Specifies if the **Cell** is to be counted in the algorithm | -| Attribute Matrix | Cell Data Attribute Matrix | Attribute Matrix | N/A | The *Cell Data* **Attribute Matrix** of the **Image Geometry** where the *Binary Phases Array* will be created | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Feature Attribute Array | Binary Feature Phases Array Name | int32_t | (1) | Specifies to which **Ensemble** each **Feature** belongs | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -36,6 +16,6 @@ Image 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. diff --git a/src/Plugins/ComplexCore/docs/FindFeaturePhasesFilter.md b/src/Plugins/ComplexCore/docs/FindFeaturePhasesFilter.md index 400fa891cf..e92cc94f0f 100644 --- a/src/Plugins/ComplexCore/docs/FindFeaturePhasesFilter.md +++ b/src/Plugins/ComplexCore/docs/FindFeaturePhasesFilter.md @@ -8,26 +8,7 @@ Generic (Misc) This **Filter** determines the **Ensemble** of each **Feature** by querying the **Ensemble** of the **Elements** that belong to the **Feature**. Note that it is assumed that all **Elements** belonging to a **Feature** are of the same **Feature**, and thus any **Element** can be used to determine the **Ensemble** of the **Feature** that owns that **Element**. -## Parameters - -None - -## Required Geometry - -Not Applicable - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Element Attribute Array | Phases | int32_t | (1) | Specifies to which **Ensemble** each **Element** belongs | -| Element Attribute Array | FeatureIds | int32_t | (1) | Specifies to which **Feature** each **Element** belongs | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Feature Attribute Array | Phases | int32_t | (1) | Specifies to which **Ensemble** each **Feature** belongs | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -39,6 +20,6 @@ Not Applicable 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. diff --git a/src/Plugins/ComplexCore/docs/FindLargestCrossSectionsFilter.md b/src/Plugins/ComplexCore/docs/FindLargestCrossSectionsFilter.md index e1ba30cb3d..fc61a4369c 100644 --- a/src/Plugins/ComplexCore/docs/FindLargestCrossSectionsFilter.md +++ b/src/Plugins/ComplexCore/docs/FindLargestCrossSectionsFilter.md @@ -8,27 +8,7 @@ Statistics (Morphological) This **Filter** calculates the largest cross-sectional area on a user-defined plane for all **Features**. The **Filter** simply iterates through all **Cells** (on each section) asking for **Feature** that owns them. On each section, the count of **Cells** for each **Feature** is then converted to an area and stored as the *LargestCrossSection* if the area for the current section is larger than the existing *LargestCrossSection* for that **Feature**. -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Plane of Interest | Enumeration | Specifies which plane to consider when determining the maximum cross-section for each **Feature | - -## 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 - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Feature Attribute Array | LargestCrossSection | flaot | (1) | Area of largest cross-section for **Feature** perpendicular to the user specified direction | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -36,6 +16,6 @@ Image 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. diff --git a/src/Plugins/ComplexCore/docs/FindNeighborListStatistics.md b/src/Plugins/ComplexCore/docs/FindNeighborListStatistics.md index ced992893f..771edc386d 100644 --- a/src/Plugins/ComplexCore/docs/FindNeighborListStatistics.md +++ b/src/Plugins/ComplexCore/docs/FindNeighborListStatistics.md @@ -16,54 +16,12 @@ This **Filter** finds the selected statistics for each list contained in a Neigh + Standard Deviation of each list + Summation of each list -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Find Length | Bool | Find the Length of each List | -| Find Minimum | Bool | Find the Minimum of each List | -| Find Maximum | Bool | Find the Maximum of each List | -| Find Mean | Bool | Find the Mean of each List | -| Find Median | Bool | Find the Median of each List | -| Find Standard Deviation | Bool | Find the Standard Deviation of each List | -| Find Summation | Bool | Find the Summation of each List | -| Input Neighbor List | NeighborList\ | The input NeighborList | -| Output AttributeMatrix | DataArrayPath | The Output NeighborList | -| Length Array Name | String | The name of the Output Length Attribute Array | -| Minimum Array Name | String | The name of the Output Minimum Attribute Array | -| Maximum Array Name | String | The name of the Output Maximum Attribute Array | -| Mean Array Name | String | The name of the Output Mean Attribute Array | -| Median Array Name | String | The name of the Output Median Attribute Array | -| Standard Deviation Array Name | String | The name of the Output Standard Deviation Attribute Array | -| Summation Array Name | String | The name of the Output Summation Attribute Array | - -## Required Geometry # - -Not Applicable - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Attribute Matrix | Attribute Matrix Name | N/A | N/A | Output Attribute Matrix | -| Input NeighborList | NeighborList Name | int32_t/float/etc. | (1) | The input NeighborList. Boolean Not allowed. | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Length Attribute Array | Length | float | (1) | Output Length Array | -| Minimum Attribute Array | Minimum | float | (1) | Output Minimum Array | -| Maximum Attribute Array | Maximum | float | (1) | Output Maximum Array | -| Mean Attribute Array | Mean | float | (1) | Output Mean Array | -| Median Attribute Array | Median | float | (1) | Output Median Array | -| Standard Deviation Attribute Array | Standard Deviation | float | (1) | Output Standard Deviation Array | -| Summation Attribute Array | Summation | float | (1) | Output Summation Array | +% 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. diff --git a/src/Plugins/ComplexCore/docs/FindNeighborhoodsFilter.md b/src/Plugins/ComplexCore/docs/FindNeighborhoodsFilter.md index 8d8bc94468..e05d865fc4 100644 --- a/src/Plugins/ComplexCore/docs/FindNeighborhoodsFilter.md +++ b/src/Plugins/ComplexCore/docs/FindNeighborhoodsFilter.md @@ -12,30 +12,7 @@ This **Filter** determines the number of **Features**, for each **Feature**, who 2. Check every other **Feature**'s *centroid* to see if it lies within the sphere and keep count and list of those that satisfy 3. Repeat 1. & 2. for all **Features** -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Multiples of Average Diameter | float | Defines the search radius to use when looking for "neighboring" **Features | - -## Required Geometry - -Image - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Feature Attribute Array | EquivalentDiameters | float | (1) | Diameter of a sphere with the same volume as the **Feature | -| Feature Attribute Array | Phases | int32_t | (1) | Specifies to which **Ensemble** each **Feature** belongs | -| Feature Attribute Array | Centroids | float | (3) | X, Y, Z coordinates of **Feature** center of mass | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Feature Attribute Array | Neighborhoods | int32_t | (1) | Number of **Features** that have their centroid within the user specified multiple of equivalent sphere diameters from each **Feature | -| Feature Attribute Array | NeighborhoodLists | List of int32_t | (1) | List of the **Features** whose centroids are within the user specified multiple of equivalent sphere diameter from each **Feature | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -47,6 +24,6 @@ Image 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. diff --git a/src/Plugins/ComplexCore/docs/FindNeighbors.md b/src/Plugins/ComplexCore/docs/FindNeighbors.md index 53d26daaaa..790bef4077 100644 --- a/src/Plugins/ComplexCore/docs/FindNeighbors.md +++ b/src/Plugins/ComplexCore/docs/FindNeighbors.md @@ -15,33 +15,7 @@ This **Filter** determines, for each **Feature**, the number of other **Features While performing the above steps, the number of neighboring **Cells** with a different **Feature** owner than a given **Cell** is stored, which identifies whether a **Cell** lies on the surface/edge/corner of a **Feature** (i.e. the **Feature** boundary). Additionally, the surface area shared between each set of contiguous **Features** is calculated by tracking the number of times two neighboring **Cells** correspond to a contiguous **Feature** pair. The **Filter** also notes which **Features** touch the outer surface of the sample (this is obtained for "free" while performing the above algorithm). The **Filter** gives the user the option whether or not they want to store this additional information. -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Store Boundary Cells Array | bool | Whether to store the boundary **Cells** array | -| Store Surface Features Array | bool | Whether to store the surface **Features** array | - -## 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 | -| Feature Attribute Matrix | CellFeatureData | Cell Feature | N/A | Feature Attribute Matrix** of the selected *Feature Ids* | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Cell Attribute Array | BoundaryCells | int8_t | (1) | The number of neighboring **Cells** of a given **Cell** that belong to a different **Feature** than itself. Values will range from *0* to *6*. Only created if *Store Boundary Cells Array* is checked| -| Feature Attribute Array | NumNeighbors | int32_t | (1) | Number of contiguous neighboring **Features** for a given **Feature | -| Feature Attribute Array** | NeighborList | List of int32_t | (1) | List of the contiguous neighboring **Features** for a given **Feature | -| Feature Attribute Array** | SharedSurfaceAreaLists | List of float | (1) | List of the shared surface area for each of the contiguous neighboring **Features** for a given **Feature | -| Feature Attribute Array** | SurfaceFeatures | bool | (1) | Flag equal to 1 if the **Feature** touches an outer surface of the sample and equal to 0 if it does not. Only created if *Store Surface Features Array* is checked | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -59,6 +33,6 @@ Image 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. diff --git a/src/Plugins/ComplexCore/docs/FindNumFeaturesFilter.md b/src/Plugins/ComplexCore/docs/FindNumFeaturesFilter.md index 57445fc791..16c242a516 100644 --- a/src/Plugins/ComplexCore/docs/FindNumFeaturesFilter.md +++ b/src/Plugins/ComplexCore/docs/FindNumFeaturesFilter.md @@ -8,26 +8,7 @@ Statistics (Morphological) This **Filter** determines the number of **Features** in each **Ensemble** by summing the total number of rows in the feature attribute matrix belonging to each phase. -## Parameters - -None - -## Required Geometry - -Not Applicable - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Feature Attribute Array | Phases | int32 | (1) | Specifies to which **Ensemble** each **Feature** belongs | -| Attribute Matrix | EnsembleData | Ensemble AttributeMatrix | N/A | The path to the ensemble **Attribute Matrix | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Ensemble Attribute Array | NumFeatures | int32 | (1) | Number of **Features** that belong each Ensemble | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -37,6 +18,6 @@ Not Applicable 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. diff --git a/src/Plugins/ComplexCore/docs/FindSurfaceAreaToVolumeFilter.md b/src/Plugins/ComplexCore/docs/FindSurfaceAreaToVolumeFilter.md index d6b196f900..f4b3ad37fa 100644 --- a/src/Plugins/ComplexCore/docs/FindSurfaceAreaToVolumeFilter.md +++ b/src/Plugins/ComplexCore/docs/FindSurfaceAreaToVolumeFilter.md @@ -14,29 +14,7 @@ This filter also optionally calculate the [Sphericity](https://en.wikipedia.org/ ![Equation for Sphericity used in the filter](Images/Sphericity_Equation.png) -## Parameters - -| Name | Type | -|------|------| -| Calculate Sphericity | Boolean | - -## 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 | -| Feature Attribute Array | NumCells | int32_t | (1) | Number of **Cells** that are owned by the **Feature**. This value does not place any distinction between **Cells** that may be of a different size | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Feature Attribute Array | SurfaceAreaVolumeRatio | float | (1) | Ratio of surface area to volume for each **Feature**. The units are inverse length | -| Feature Attribute Array | Sphericity | float | (1) | The sphericity of each feature | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -46,6 +24,6 @@ Image 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. diff --git a/src/Plugins/ComplexCore/docs/FindSurfaceFeatures.md b/src/Plugins/ComplexCore/docs/FindSurfaceFeatures.md index 40cd3d19c3..1447f1eca0 100644 --- a/src/Plugins/ComplexCore/docs/FindSurfaceFeatures.md +++ b/src/Plugins/ComplexCore/docs/FindSurfaceFeatures.md @@ -30,26 +30,7 @@ If the structure/data is actually 2D, then the dimension that is planar is not c | ![FindSurfaceFeatures_Cylinder](Images/FindSurfaceFeatures_Cylinder.png) | ![FindSurfaceFeatures_Square](Images/FindSurfaceFeatures_Square.png) | | Example showing features touching Feature ID=0 (Black voxels) | Example showing features touching the outer surface of the bounding box | -## Parameters - -None - -## 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 | -| Cell Feature **Attribute Matrix | Cell Feauture | N/A | The path to the cell feature **Attribute Matrix | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Feature Attribute Array | SurfaceFeatures | bool | (1) | Flag of 1 if **Feature** touches an outer surface or of 0 if it does not | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -59,6 +40,6 @@ Image 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. diff --git a/src/Plugins/ComplexCore/docs/FindTriangleGeomCentroidsFilter.md b/src/Plugins/ComplexCore/docs/FindTriangleGeomCentroidsFilter.md index d1d418e554..29ccd01c0d 100644 --- a/src/Plugins/ComplexCore/docs/FindTriangleGeomCentroidsFilter.md +++ b/src/Plugins/ComplexCore/docs/FindTriangleGeomCentroidsFilter.md @@ -14,26 +14,7 @@ using the following algorithm: node to be entered once for a given owner*) 3. For each **Feature**, find the average (x,y,z) coordinate from the set of nodes that bound it -## Parameters - -None - -## Required Geometry - -Triangle - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|--------------------------|-----------------|--------------|-------------|------------------------------------------------------------------| -| Face Attribute Array | FaceLabels | int32_t | (2) | Specifies which **Features** are on either side of each Face | -| Attribute Matrix** | FaceFeatureData | Face Feature | N/A | Feature Attribute Matrix** of the selected *Face Labels* | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|-----------------------------|--------------|-------|-------------|--------------------------------------------------------------------| -| Feature Attribute Array | Centroids | float | (3) | Coordinates of the center of mass for a given enclosed **Feature | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -41,6 +22,6 @@ Triangle 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. diff --git a/src/Plugins/ComplexCore/docs/FindTriangleGeomSizesFilter.md b/src/Plugins/ComplexCore/docs/FindTriangleGeomSizesFilter.md index 8d7146d208..2da2dc9091 100644 --- a/src/Plugins/ComplexCore/docs/FindTriangleGeomSizesFilter.md +++ b/src/Plugins/ComplexCore/docs/FindTriangleGeomSizesFilter.md @@ -23,26 +23,7 @@ unit element sizes for a set of **Features** (thus, the Find Feature Sizes would of **Features** in a **Triangle Geometry**, whereas this **Filter** is specialized to compute the enclosed volumes of ** Features** in a surface mesh). -## Parameters - -None - -## Required Geometry - -Triangle - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|--------------------------|--------------|---------|-------------|------------------------------------------------------------------| -| Face Attribute Array | FaceLabels | int32_t | (2) | Specifies which **Features** are on either side of each Face | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|-----------------------------|-----------------|--------------|-------------|-------------------------------------------| -| Attribute Matrix** | FaceFeatureData | Face Feature | N/A | Created **Feature Attribute Matrix** name | -| Feature Attribute Array | Volumes | float | (1) | Volume of the enclosed **Feature** | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -50,6 +31,6 @@ Triangle 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. diff --git a/src/Plugins/ComplexCore/docs/FindVertexToTriangleDistancesFilter.md b/src/Plugins/ComplexCore/docs/FindVertexToTriangleDistancesFilter.md index f04a1649f6..cc47fc32fc 100644 --- a/src/Plugins/ComplexCore/docs/FindVertexToTriangleDistancesFilter.md +++ b/src/Plugins/ComplexCore/docs/FindVertexToTriangleDistancesFilter.md @@ -9,33 +9,12 @@ Sampling (Spatial) This **Filter** computes distances between points in a **Vertex Geoemtry** and triangles in a **Triangle Geoemtry**. Specifically, for each point in the **Vertex Geometry**, the Euclidean distance to the closest triangle in the **Triangle Geoemtry** is stored. This distance is *signed*: if the point lies on the side of the triangle to which the triangle normal points, then the distance is positive; otherwise, the distance is negative. Additionally, the ID the closest triangle is stored for each point. -## Parameters - -None - -## Required Geometry - -Vertex and Triangle - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Data Container | None | N/A | N/A | Data Container holding the source **Vertex Geometry | -| Data Container | None | N/A | N/A | Data Container holding the target **Triangle Geometry | -| Face Attribute Array | None | float | (3)) | Normals for the target **Triangle Geometry | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Vertex Attribute Array | Distances | float | (1) | Euclidean distance to the closest triangle for each point | -| Vertex Attribute Array | ClosestTriangleId | int32_t | (1) | Id of the closest triangle for each point | +% 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. diff --git a/src/Plugins/ComplexCore/docs/FindVolFractionsFilter.md b/src/Plugins/ComplexCore/docs/FindVolFractionsFilter.md index 8b99f1ac31..69cf4e2f8f 100644 --- a/src/Plugins/ComplexCore/docs/FindVolFractionsFilter.md +++ b/src/Plugins/ComplexCore/docs/FindVolFractionsFilter.md @@ -8,26 +8,7 @@ Statistics (Morphological) This **Filter** determines the volume fraction of each **Ensemble**. The **Filter** counts the number of **Cells** belonging to each **Ensemble** and stores the number fraction. -## Parameters - -None - -## Required Geometry - -None - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Cell Attribute Array | Phases | int32 | (1) | Specifies to which **Ensemble** each **Cell** belongs | -| Attribute Matrix | CellEnsembleData | Ensemble AttributeMatrix | N/A | The path to the cell ensemble **Attribute Matrix | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Ensemble Attribute Array | VolFractions | float | (1) | Fraction of volume that belongs to each Ensemble | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -35,6 +16,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. diff --git a/src/Plugins/ComplexCore/docs/GenerateColorTableFilter.md b/src/Plugins/ComplexCore/docs/GenerateColorTableFilter.md index 0d956b1bde..b1278c60a1 100644 --- a/src/Plugins/ComplexCore/docs/GenerateColorTableFilter.md +++ b/src/Plugins/ComplexCore/docs/GenerateColorTableFilter.md @@ -5,27 +5,7 @@ This **Filter** generates a color table array for a given 1-component input array. Each element of the input array is normalized and converted to a color based on where the value falls in the spectrum of the selected color preset. -## Parameters - -| Name | Type | Description | -|-----------------|------|-------------------------------------------------------------------| -| Selected Preset | JSON | The selected color preset, used to generate the color table array | - -## Required Geometry # - -None - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|------|--------------|-----|-------------|----------------------------------------------------------------| -| Attribute Array | N/A | Any | (1) | 1-component input array used to generate the color table array | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|------|--------------|-------|-------------|---------------------------------------------------------| -| Attribute Array | N/A | uint8 | (3) | RGB output color table array | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -33,6 +13,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. diff --git a/src/Plugins/ComplexCore/docs/GenerateVectorColorsFilter.md b/src/Plugins/ComplexCore/docs/GenerateVectorColorsFilter.md index 590d54a2d2..98d13fc42f 100644 --- a/src/Plugins/ComplexCore/docs/GenerateVectorColorsFilter.md +++ b/src/Plugins/ComplexCore/docs/GenerateVectorColorsFilter.md @@ -10,28 +10,7 @@ This **Filter** generates a color for each **Element** based on the vector assig ![Images/VectorColors](Images/VectorColors.png) -## Parameters - -| Name | Type | Description | -|------------------|------|-------------| -| Apply to Good Voxels Only (Bad Voxels Will Be Black) | bool | Whether or not to assign colors to *bad* voxels or leave them black | - -## Required Geometry - -Not Applicable - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Element Attribute Array | VectorData | float32 | (3) | Vectors the colors will represent | -| Element Attribute Array | Mask | bool | (1) | Used to define **Elements** as *good* or *bad* | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Element Attribute Array | Colors | uint8 | (3) | RGB colors | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -39,6 +18,6 @@ Not Applicable 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. diff --git a/src/Plugins/ComplexCore/docs/IdentifySample.md b/src/Plugins/ComplexCore/docs/IdentifySample.md index 4321622bdb..68d3ae33f4 100644 --- a/src/Plugins/ComplexCore/docs/IdentifySample.md +++ b/src/Plugins/ComplexCore/docs/IdentifySample.md @@ -22,25 +22,7 @@ If *Fill Holes* is set to *true*: |![Small IN100 IPF Map](Images/Small_IN100.png) | Good dataset to use this filter | |![APTR IPF Colors](Images/aptr12_001_0.png) | NOT** a good data set to use because there is **no** overscan of the sample. | -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Fill Holes in Largest Feature | bool | Whether to fill holes within sample after it is identified | - -## Required Geometry - -Image - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Cell Attribute Array | Mask | bool | (1) | *Mask* array defining what is sample and what is not | - -## Created Objects - -None +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -52,6 +34,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. diff --git a/src/Plugins/ComplexCore/docs/ImageContouringFilter.md b/src/Plugins/ComplexCore/docs/ImageContouringFilter.md index 85e173b233..348ee5bce0 100644 --- a/src/Plugins/ComplexCore/docs/ImageContouringFilter.md +++ b/src/Plugins/ComplexCore/docs/ImageContouringFilter.md @@ -12,27 +12,7 @@ Here's what the results look like: ![3D-Contouring](Images/3D-contouring.png) -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Contour value | float64 | This is the thresholding value that will be used to create the *Contouring Geometry* | - -## Required Geometry - -Image - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Data Array | Data Array to Contour | Any | (1) | This is the array that will be parsed in order to create the contouring geometry, this is what the *Contour Value* will be compared against | - -## Created Objects - -| Kind | Default Name | Type | Description | -|--------------|---------------|------|-----------------------------------------------| -| Geometry | Contouring Geometry | TriangleGeom | This stores the 3D contouring line and the normals for the vertices | +% Auto generated parameter table will be inserted here ## License & Copyright diff --git a/src/Plugins/ComplexCore/docs/ImportBinaryCTNorthstarFilter.md b/src/Plugins/ComplexCore/docs/ImportBinaryCTNorthstarFilter.md index 0b21a0c8b9..786f151e5d 100644 --- a/src/Plugins/ComplexCore/docs/ImportBinaryCTNorthstarFilter.md +++ b/src/Plugins/ComplexCore/docs/ImportBinaryCTNorthstarFilter.md @@ -12,36 +12,12 @@ The user should note that when using the subvolume feature that the ending voxel The .nsihdr file will be read during preflight and the .nsidat file(s) will be extracted from there. The expectation is that the .nsidat files are in the same directory as the .nsihdr files. -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Input Header File | String | Path to the .nsihdr file | -| Length Unit | integer | Enumeration value into the units table. Default is mm | -| Import Subvolume | Boolean | Import a subvolume instead of the entire volume | -| Starting Voxel | 3xInteger | The voxel indices to start the subvolume import at. | -| Ending Voxel | 3xInteger | The voxel indices to end the subvolume import at (Inclusive). | - -## Required Geometry # - -Not Applicable - -## Required Objects - -Not Applicable - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Image Geometry | CT Image Geometry | ImageGeom | N/A | | -| Attribute Matrix | CT Scan Data | Attribute Matrix | N/A | | -| Data Array | Density | float | (1) | Density Data | +% 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. diff --git a/src/Plugins/ComplexCore/docs/ImportCSVDataFilter.md b/src/Plugins/ComplexCore/docs/ImportCSVDataFilter.md index deb7e55ac0..8b25fb20ec 100644 --- a/src/Plugins/ComplexCore/docs/ImportCSVDataFilter.md +++ b/src/Plugins/ComplexCore/docs/ImportCSVDataFilter.md @@ -34,31 +34,7 @@ If the data does not have any headers, the user can set a string value for each ![Setting Names of each Column which will be used as the name of each **Attribute Array** ](Images/Import_CSV_4.png) -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Wizard Data Object | CSVWizardData | The object that holds all relevant data collected from the wizard | -| Tuple Dimensions | DynamicTableData | The tuple dimensions for the arrays being imported from the file | -| Use Existing Group | bool | Determines whether or not to store the imported data arrays in an existing group | -| Existing Data Group (Use Existing Group - ON) | DataPath | The data path to the existing group where the imported arrays will be stored | -| New Data Group (Use Existing Group - OFF) | DataPath | The data path to the newly created group where the imported arrays will be stored | - -## Required Geometry - -Not Applicable - -## Required Objects - -| Kind | Default Name | Description | -|------|--------------|------|-------------|-------------| -| Data Group | None | The existing data group to store the imported data arrays (only if Existing Data Group is turned ON) | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| One or more **Element/Feature/Ensemble/etc. Data Arrays | None | Any | 1 | One or more arrays that are created due to importing CSV data via the wizard | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -66,6 +42,6 @@ Not Applicable 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. diff --git a/src/Plugins/ComplexCore/docs/ImportDREAM3DFilter.md b/src/Plugins/ComplexCore/docs/ImportDREAM3DFilter.md index 7821bc1db8..4f5d29f9e6 100644 --- a/src/Plugins/ComplexCore/docs/ImportDREAM3DFilter.md +++ b/src/Plugins/ComplexCore/docs/ImportDREAM3DFilter.md @@ -4,23 +4,7 @@ This **Filter** reads the data structure to an hdf5 file with the .dream3d extension. -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Import File Path | Filesystem Path | The file path the DataStructure should be read from as an HDF5 file. | - -## Required Geometry # - -None - -## Required Objects - -None - -## Created Objects - -None +% Auto generated parameter table will be inserted here ## Example Pipelines diff --git a/src/Plugins/ComplexCore/docs/ImportDeformKeyFileV12Filter.md b/src/Plugins/ComplexCore/docs/ImportDeformKeyFileV12Filter.md index 9ef2b039b4..3b04ddd21b 100644 --- a/src/Plugins/ComplexCore/docs/ImportDeformKeyFileV12Filter.md +++ b/src/Plugins/ComplexCore/docs/ImportDeformKeyFileV12Filter.md @@ -10,30 +10,12 @@ This **Filter** reads DEFORM v12 key files and saves the data in a newly created It reads the quadrilateral mesh data (nodal coordinates and connectivity), and the value of variables such as stress, strain, ndtmp, etc at cells and nodes. -## Parameters - -| Name | Type | Description | -|------|------|------| -| Input File | Path | Name and address of the input DEFORM v12 key file | - -## Required Geometry - -Not Applicable - -## Required Objects - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| QuadGeom | Quad Geometry | QuadGeom | N/A | Created **QuadGeom** path and name | -| Attribute Matrix | Vertex Data | Vertex | N/A | Created **Vertex Attribute Matrix** name | -| Attribute Matrix | Cell Data | Cell | N/A | Created **Cell Attribute Matrix** name | +% 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. diff --git a/src/Plugins/ComplexCore/docs/ImportHDF5Dataset.md b/src/Plugins/ComplexCore/docs/ImportHDF5Dataset.md index a966a857b0..b5a6a341fa 100644 --- a/src/Plugins/ComplexCore/docs/ImportHDF5Dataset.md +++ b/src/Plugins/ComplexCore/docs/ImportHDF5Dataset.md @@ -37,29 +37,7 @@ We can input component dimensions of **2** and set our destination attribute mat ![Example Image](Images/ImportHDF5Dataset_ui.png) -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| HDF5 File | String | The path to the HDF5 file | -| Checked Datasets | N/A | The checked datasets in the file tree to import | -| Comp Dims | String | The component dimensions that the imported dataset will have. This is a comma-delimited list of dimensional values | - -## Required Geometry - -Not Applicable - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Attribute Matrix** | None | DataArrayPath | N/A | Attribute Matrix** used to store imported data | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Data Array(s) | Name of dataset(s) from HDF5 file | Type from HDF5 file | Input as a filter parameter | The created Attribute Array(s) | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -67,6 +45,6 @@ Not Applicable 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. diff --git a/src/Plugins/ComplexCore/docs/ImportTextFilter.md b/src/Plugins/ComplexCore/docs/ImportTextFilter.md index b60aa87c5f..752ae5fe17 100644 --- a/src/Plugins/ComplexCore/docs/ImportTextFilter.md +++ b/src/Plugins/ComplexCore/docs/ImportTextFilter.md @@ -57,31 +57,7 @@ The example data below has 50 elements. This means that it could successfully be | 3 | colon | | 4 | tab | -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| InputFile | String | The path to the input file including the filename | -| ScalarType | int | See table above | -| Number of Components | int | The number of components in the array. | -| Skip Header Lines | int | If the file has some sort of a header, skip this many lines. | -| Delimeter | int | See Table above | - -## Required Geometry - -Not Applicable - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Attribute Matrix** | None | DataArrayPath | N/A | Attribute Matrix** to store imported data into | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Attribute Array | N/A | See Table above | based on number of components | The created Attribute Array | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -89,6 +65,6 @@ Not Applicable 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. diff --git a/src/Plugins/ComplexCore/docs/ImportVolumeGraphicsFileFilter.md b/src/Plugins/ComplexCore/docs/ImportVolumeGraphicsFileFilter.md index 2483f31ad8..82939e51c6 100644 --- a/src/Plugins/ComplexCore/docs/ImportVolumeGraphicsFileFilter.md +++ b/src/Plugins/ComplexCore/docs/ImportVolumeGraphicsFileFilter.md @@ -8,35 +8,12 @@ Import/Export This **Filter** will import Volume Graphics data files in the form of .vgi/.vol pairs. Both files must exist and be in the same directory for the filter to work. The .vgi file is read to find out the dimensions, spacing and units of the data. The name of the .vol file is also contained in the .vgi file. -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| VolumeGraphics .vgi File | std::filesystem::path | Path to the .vgi file on disk | -| Image Geometry | DataPath | Name of the created Image Geometry | -| Cell Attribute Matrix | std::string | Name of the created AttributeMatrix | -| Density | std::string | Name of the created Cell Data | - -## Required Geometry # - -Not Applicable - -## Required Objects - -Not Applicable - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Image Geometry | VolumeGraphics | Image Geometry | N/A | | -| Attribute Matrix | CT Data | Cell Attribute Matrix | N/A | | -| Element Attribute Array | Density | float | (1) | raw data | +% 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. diff --git a/src/Plugins/ComplexCore/docs/InitializeData.md b/src/Plugins/ComplexCore/docs/InitializeData.md index e8bfe25468..9329e4c126 100644 --- a/src/Plugins/ComplexCore/docs/InitializeData.md +++ b/src/Plugins/ComplexCore/docs/InitializeData.md @@ -8,30 +8,7 @@ Processing (Cleanup) This **Filter** allows the user to define a subvolume of the data set in which the **Filter** will reset all data by writing *zeros (0)* into every array for every **Cell** within the subvolume. -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| X Min | int32_t | Minimum X bound in **Cells | -| Y Min | int32_t | Minimum Y bound in **Cells | -| Z Min | int32_t | Minimum Z bound in **Cells | -| X Max | int32_t | Maximum X bound in **Cells | -| Y Max | int32_t | Maximum Y bound in **Cells | -| Z Max | int32_t | Maximum Z bound in **Cells | - -## Required Geometry - -Image - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Attribute Matrix | CellData | Cell | N/A | Cell** data in which to initialize a subvolume to zeros | - -## Created Objects - -None +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -39,6 +16,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. diff --git a/src/Plugins/ComplexCore/docs/InterpolatePointCloudToRegularGridFilter.md b/src/Plugins/ComplexCore/docs/InterpolatePointCloudToRegularGridFilter.md index 265b81dd6b..fc6e291ab8 100644 --- a/src/Plugins/ComplexCore/docs/InterpolatePointCloudToRegularGridFilter.md +++ b/src/Plugins/ComplexCore/docs/InterpolatePointCloudToRegularGridFilter.md @@ -17,39 +17,12 @@ The result of the above approach is a list of data at each voxel in the **Image A mask may be supplied to the filter. Points that are not within the mask are ignored during interpolation. Additionally, the distances between each voxel and the source point for the intersecting kernel may be stored; this significantly increases the required memory. Arrays may be passed through to the image geometry without applying any interpolation. This operation is equivalent to used a uniform kernel. -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Use Mask | bool | Whether to use a mask when interpolating the vertex arrays | -| Store Kernel Distances | bool | Whether to store the kernel distances for each vertex | -| Interpolation Technique | Enumeration | The type of kernel to use, either *Uniform* or *Gaussian* | -| Kernel Size | float 3x | The size of the interpolation kernel, in real space units | - -## Required Geometry # - -Vertex and Image - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Data Container | None | N/A | N/A | Data Container holding the **Vertex Geometry** to interpolate | -| Data Container | None | N/A | N/A | Data Container holding the **Image Geometry** that serves as the target grid for interpolation | -| Vertex Attribute Array | VoxelIndices | size_t | (1) | The indices that indicate in which voxel in the supplied **Image Geometry** each vertex lies | -| Various **Attribute Array | None | Varies | (1) | The **Vertex Attribute Arrays** to interpolate | -| Various **Attribute Array | None | Varies | (1) | The **Vertex Attribute Arrays** to copy | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Attribute Matrix | InterpolatedAttributeMatrix | Cell | N/A | Attribute Matrix**that stores the interpolated**Attribute Arrays | +% 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. diff --git a/src/Plugins/ComplexCore/docs/IterativeClosestPointFilter.md b/src/Plugins/ComplexCore/docs/IterativeClosestPointFilter.md index b30f18c7f2..49ac7b63a8 100644 --- a/src/Plugins/ComplexCore/docs/IterativeClosestPointFilter.md +++ b/src/Plugins/ComplexCore/docs/IterativeClosestPointFilter.md @@ -17,30 +17,7 @@ Iterations proceed for a fixed number of user-defined steps. The final rigid bo ICP has a number of advantages, such as robustness to noise and no requirement that the two sets of points to be the same size. However, peformance may suffer if the two sets of points are of siginficantly different size. -## Parameters - -| Name | Type | Description | -|------|------|------| -| Number of Iterations | int | Number if iterations for the ICP algorithm | -| Apply Transform to Moving Geometry | bool | Whether to apply the computed transform to the moving **Vertex Geometry | - -## Required Geometry - -Vertex - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Data Container | None | N/A | N/A | Data Container holding the moving **Vertex Geometry | -| Data Container | None | N/A | N/A | Data Container holding the target **Vertex Geometry | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Attribute Matrix | TransformAttributeMatrix | Generic | N/A | Attribute Matrix** that stores the computed transformation | -| Attribute Array | Transform | float | (4, 4) | Computed transformation matrix | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -48,6 +25,6 @@ Vertex 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. diff --git a/src/Plugins/ComplexCore/docs/KMeansFilter.md b/src/Plugins/ComplexCore/docs/KMeansFilter.md index eca0260656..3028265096 100644 --- a/src/Plugins/ComplexCore/docs/KMeansFilter.md +++ b/src/Plugins/ComplexCore/docs/KMeansFilter.md @@ -40,32 +40,7 @@ A clustering algorithm can be considered a kind of segmentation; this implementa This **Filter** will store the means for the final clusters within the created **Attribute Matrix**. -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Number of Clusters | int32_t | The number of clusters in which to partition the array | -| Distance Metric | Enumeration | The metric used to determine the distances between points; only 2-norm metrics (i.e., Euclidean or squared Euclidean) may be chosen | -| Use Mask | bool | Whether to use a boolean mask array to ignore certain points flagged as *false* from the algorithm | - -## Required Geometry # - -None - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Any **Attribute Array | None | Any| Any | The **Attribute Array** to cluster | -| Attrubute Array | Mask | bool | (1) | Specifies if the point is to be counted in the algorithm, if *Use Mask* is checked | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Attribute Matrix | ClusterData | Feature/Ensemble | N/A | The **Attribute Matrix** in which to store information associated with the created clusters | -| Attribute Array | ClusterIds | int32_t | (1) | Specifies to which cluster each point belongs | -| Attribute Array | ClusterMeans | double | (1) | The means of the final clusters | +% Auto generated parameter table will be inserted here ## References @@ -77,6 +52,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. diff --git a/src/Plugins/ComplexCore/docs/KMedoidsFilter.md b/src/Plugins/ComplexCore/docs/KMedoidsFilter.md index 35e2f46efa..aa188bdf91 100644 --- a/src/Plugins/ComplexCore/docs/KMedoidsFilter.md +++ b/src/Plugins/ComplexCore/docs/KMedoidsFilter.md @@ -41,32 +41,7 @@ A clustering algorithm can be considered a kind of segmentation; this implementa This **Filter** will store the medoids for the final clusters within the created **Attribute Matrix**. -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Number of Clusters | int32_t | The number of clusters in which to partition the array | -| Distance Metric | Enumeration | The metric used to determine the distances between points | -| Use Mask | bool | Whether to use a boolean mask array to ignore certain points flagged as *false* from the algorithm | - -## Required Geometry # - -None - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Any **Attribute Array | None | Any| Any | The **Attribute Array** to cluster | -| Attrubute Array | Mask | bool | (1) | Specifies if the point is to be counted in the algorithm, if *Use Mask* is checked | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Attribute Matrix | ClusterData | Feature/Ensemble | N/A | The **Attribute Matrix** in which to store information associated with the created clusters | -| Attribute Array | ClusterIds | int32_t | (1) | Specifies to which cluster each point belongs | -| Attribute Array | ClusterMeans | double | (1) | The means of the final clusters | +% Auto generated parameter table will be inserted here ## References @@ -78,6 +53,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. diff --git a/src/Plugins/ComplexCore/docs/LaplacianSmoothingFilter.md b/src/Plugins/ComplexCore/docs/LaplacianSmoothingFilter.md index 413f4bbffc..c56440a8b3 100644 --- a/src/Plugins/ComplexCore/docs/LaplacianSmoothingFilter.md +++ b/src/Plugins/ComplexCore/docs/LaplacianSmoothingFilter.md @@ -68,34 +68,7 @@ The values for the *Node Type* array can take one of the following values. For more information on surface meshing, visit the tutorial. -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Iteration Steps | int32_t | Number of iteration steps to perform. More steps causes more smoothing but will also cause the volume to shrink more. *Inreasing this number too high may cause collapse of points!* | -| Default Lambda | float | Value of λ to apply to general internal nodes that are not triple lines, quadruple points or on the surface of the volume | -| Use Taubin Smoothing | boolean | Use Taubin's Lambda-Mu algorithm. | -| Mu Factor | float | A value that is multipied by Lambda the result of which is the *mu* in Taubin's paper. The value should be a negative value. | -| Triple Line Lambda | float | Value of λ to apply to nodes designated as triple line nodes. | -| Quadruple Points Lambda | float | Value of λ to apply to nodes designated as quadruple points. | -| Outer Points Lambda | float | The value of λ to apply to nodes that lie on the outer surface of the volume | -| Outer Triple Line Lambda | float | Value of λ for triple lines that lie on the outer surface of the volume | -| Outer Quadruple Points Lambda | float | Value of λ for the quadruple Points that lie on the outer surface of the volume. | - -## Required Geometry - -Triangle - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Vertex Attribute Array | NodeTypes | int8_t | (1) | Specifies the type of node in the **Geometry | -| Face Attribute Array | FaceLabels | int32_t | (2) | Specifies which **Features** are on either side of each Face | - -## Created Objects - -None +% Auto generated parameter table will be inserted here ## References @@ -111,6 +84,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. diff --git a/src/Plugins/ComplexCore/docs/LosAlamosFFTWriterFilter.md b/src/Plugins/ComplexCore/docs/LosAlamosFFTWriterFilter.md index 9448287088..1a0fffaee0 100644 --- a/src/Plugins/ComplexCore/docs/LosAlamosFFTWriterFilter.md +++ b/src/Plugins/ComplexCore/docs/LosAlamosFFTWriterFilter.md @@ -41,27 +41,7 @@ The output file: 90.000 0.000 0.000 19 1 1 0 1 .. -## Parameters - -| Name | Type | Description | -|------------------|------|-------------| -| Output File | File Path | The output .txt file path | - -## Required Geometry - -Image - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Cell Attribute Array | FeaturesIds | int32_t | (1) | Specifies to which **Feature** each **Cell** belongs | -| Cell Attribute Array | EulerAngles | float | (3) | Three angles defining the orientation of the **Cell** in Bunge convention (Z-X-Z) | -| Cell Attribute Array | Phases | int32_t | (1) | Specifies to which **Ensemble** each **Cell** belongs | - -## Created Objects - -None +% Auto generated parameter table will be inserted here ## References @@ -73,6 +53,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. diff --git a/src/Plugins/ComplexCore/docs/MapPointCloudToRegularGridFilter.md b/src/Plugins/ComplexCore/docs/MapPointCloudToRegularGridFilter.md index 5c510d8b03..7f8603d7d9 100644 --- a/src/Plugins/ComplexCore/docs/MapPointCloudToRegularGridFilter.md +++ b/src/Plugins/ComplexCore/docs/MapPointCloudToRegularGridFilter.md @@ -11,36 +11,12 @@ This **Filter** determines, for a user-defined grid, in which voxel each point i Additionally, the user may opt to use a mask; points for which the mask are false are ignored when computing voxel indices (instead, they are initialized to voxel 0). -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Sampling Grid Type | Enumeration | The method used to create the sampling grid, either *Manual* or *Use Existing Image Geometry* | -| Grid Dimensions | int 3x | Dimensions of the sampling grid, if *Manual* is selected | -| Use Mask | bool | Whether to use a mask for the input **Vertex Geometry | - -## 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 | -| Data Container | None | N/A | N/A | Data Container holding the sampling **Image Geometry**, if *Use Existing Image Geometry* is selected | -| Vertex Attribute Array | None | bool | (1) | Vertex mask, if *Use Mask* is selected | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Vertex Attribute Array | VoxelIndices | size_t | (1) | Indices of the voxels in which each point lies | +% 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. diff --git a/src/Plugins/ComplexCore/docs/MinNeighbors.md b/src/Plugins/ComplexCore/docs/MinNeighbors.md index 31b0e1687f..208a0b667a 100644 --- a/src/Plugins/ComplexCore/docs/MinNeighbors.md +++ b/src/Plugins/ComplexCore/docs/MinNeighbors.md @@ -14,29 +14,7 @@ The **Filter** can be run in a mode where the minimum number of neighbors is app If any features are removed **and** the Cell Feature AttributeMatrix contains any *NeighborList* data arrays those arrays will be **REMOVED** because those lists are now invalid. Re-run the *Find Neighbors* filter to re-create the lists. -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Minimum Number Neighbors | int32_t | Number of neighbors a **Feature** must have to remain as a **Feature | -| Apply to Single Phase | bool | Whether to apply minimum to single ensemble or all ensembles | -| Phase Index | int32_t | Which **Ensemble** to apply minimum to. Only needed if *Apply to Single Phase Only* is checked | - -## 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 | -| Feature Attribute Array | Phases | int32_t | (1) | Specifies to which **Ensemble** each **Feature** belongs. Only required if *Apply to Single Phase Only* is checked | -| Feature Attribute Array | NumNeighbors | int32_t | (1) | Number of contiguous neighboring **Features** for each **Feature | - -## Created Objects - -None +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -47,6 +25,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. diff --git a/src/Plugins/ComplexCore/docs/MoveData.md b/src/Plugins/ComplexCore/docs/MoveData.md index c9c634f699..05231ee927 100644 --- a/src/Plugins/ComplexCore/docs/MoveData.md +++ b/src/Plugins/ComplexCore/docs/MoveData.md @@ -8,27 +8,7 @@ Core (Memory/Management) This **Filter** allows the user to move an **Attribute Array** from one **Attribute Matrix** to another compatible **Attribute Matrix** or to move an **Attribute Matrix** from one **Data Container** to another **Data Container**. **Attribute Matrices** are compatible if the *number of tuples* are equal, **not** the actual *tuple dimensions*. -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Data to Move | DataPath | The complete path to the data object to be moved | -| New Parent | DataPath | The complete path to the parent data object to which the data will be moved | - -## Required Geometry - -Not Applicable - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Data Object | None | Any | N/A | Data Object** to move | -| Base Group** Child | None | Any | Any | Base Group** to be moved into | - -## Created Objects - -None +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -36,6 +16,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. diff --git a/src/Plugins/ComplexCore/docs/MultiThresholdObjects.md b/src/Plugins/ComplexCore/docs/MultiThresholdObjects.md index 062158cba1..b6705b4980 100644 --- a/src/Plugins/ComplexCore/docs/MultiThresholdObjects.md +++ b/src/Plugins/ComplexCore/docs/MultiThresholdObjects.md @@ -16,31 +16,7 @@ It is possible to set custom values for both the TRUE and FALSE values that will **NOTE**: If custom TRUE/FALSE values are chosen, then using the resulting mask array in any other filters that require a mask array will break those other filters. This is because most other filters that require a mask array make the assumption that the true/false values are 1/0. -## Parameters - -| Name | Type | Description | -|--------------------------|-----------------|----------------------------------------------------------------------------------------------------------------| -| Data Arrays to Threshold | Comparison List | This is the set of criteria applied to the objects the selected arrays correspond to when doing the thresholding | -| Use Custom TRUE Value | bool | Specifies whether to output a custom TRUE value | -| Custom TRUE Value | float64 | The custom TRUE value (the default value is 1) | -| Use Custom FALSE Value | bool | Specifies whether to output a custom FALSE value | -| Custom FALSE Value | float64 | The custom FALSE value (the default value is 0) | - -## Required Geometry - -Not Applicable - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Any **Attribute Array | None | Any | (1) | Array(s) selected in criteria set | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Any **Attribute Array | Mask | bool | (1) | Specifies whether the objects passed the set of criteria applied during thresholding | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -48,6 +24,6 @@ Not Applicable 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. diff --git a/src/Plugins/ComplexCore/docs/NearestPointFuseRegularGridsFilter.md b/src/Plugins/ComplexCore/docs/NearestPointFuseRegularGridsFilter.md index d001d53471..d34e8619a8 100644 --- a/src/Plugins/ComplexCore/docs/NearestPointFuseRegularGridsFilter.md +++ b/src/Plugins/ComplexCore/docs/NearestPointFuseRegularGridsFilter.md @@ -10,29 +10,12 @@ This **Filter** fuses two **Image Geometry** data sets together. The grid of **C *Note:* The *Sampling* **Data Container** remains identical after this **Filter**, but the *Reference* **Data Container**, while "geometrically identical", gains all the attribute arrays from the *Sampling* **Data Container**. -## Parameters - -None - -## Required Geometry - -Image - -## Required Objects - -None - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Attribute Matrix | CellData | Cell | N/A | *Reference* **Cell** data to use for fusion | -| Attribute Matrix | CellData | Cell | N/A | *Sampling* **Cell** data to use for fusion | +% 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. diff --git a/src/Plugins/ComplexCore/docs/PartitionGeometryFilter.md b/src/Plugins/ComplexCore/docs/PartitionGeometryFilter.md index ef1aed88e0..825ce4dda1 100644 --- a/src/Plugins/ComplexCore/docs/PartitionGeometryFilter.md +++ b/src/Plugins/ComplexCore/docs/PartitionGeometryFilter.md @@ -104,28 +104,7 @@ On all partitioning modes, a vertex mask can be used with a vertex-based input g |:---:|:---:| | ![](Images/PartitionGeometry/UseVertexMask_1a.png) | ![](Images/PartitionGeometry/UseVertexMask_1b.png) | -## Parameters - -| Name | Type | Description | -|------|------|------| -| Input Geometry to Partition | DataPath | The path to the geometry object that the filter will partition. | -| Input Geometry Cell Attribute Matrix | DataPath | The path to the attribute matrix where the partition ids array will be stored. | -| Partitioning Mode | int | The mode used to partition the geometry. The choices are Basic, Advanced, Bounding Box, and Existing Partition Grid. | -| Starting Feature ID | int | The starting ID to use when creating the partition grid. | -| Out-Of-Bounds Feature ID | int | The default ID used when the voxel or node in the input geometry is out-of-bounds compared to the partition grid. Available in all modes except for Basic mode (not needed since all voxels are in-bounds). | -| Number of Cells Per Axis (X,Y,Z) | IntVec3 | The number of cells that will be created in each partition grid axis. | -| Partition Grid Origin (X,Y,Z) | FloatVec3 | The origin of the partition grid. Only available in Advanced mode. | -| Cell Length (X,Y,Z) | FloatVec3 | The length of each cell in each partition grid axis. Only available in Advanced mode. | -| Minimum Grid Coordinate (X,Y,Z) | FloatVec3 | The minimum coordinate for the bounding box of the partition grid. Only available in Bounding Box mode. | -| Maximum Grid Coordinate (X,Y,Z) | FloatVec3 | The maximum coordinate for the bounding box of the partition grid. Only available in Bounding Box mode. | -| Existing Partition Grid | DataPath | The path to an image geometry that contains an existing partition grid. Only available in Existing Partition Grid mode. | -| Use Vertex Mask | bool | Determines whether or not to use a vertex mask when partitioning the input geometry. | -| Vertex Mask | DataPath | The path to the vertex mask array. | -| Feature Attribute Matrix | string | The name of the feature attribute matrix that will be created. | -| Partition Ids | string | The name of the partition ids array that will be created. | -| Partition Grid Geometry | DataPath | The path to the partition grid geometry that will be created. | -| Cell Attribute Matrix | string | The name of the attribute matrix that will be created as a child of the partition grid geometry. | -| Feature Ids | string | The name of the feature ids array that will be created as a child of Cell Attribute Matrix. | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -135,6 +114,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. diff --git a/src/Plugins/ComplexCore/docs/PointSampleTriangleGeometryFilter.md b/src/Plugins/ComplexCore/docs/PointSampleTriangleGeometryFilter.md index a2c4060500..907f172ba6 100644 --- a/src/Plugins/ComplexCore/docs/PointSampleTriangleGeometryFilter.md +++ b/src/Plugins/ComplexCore/docs/PointSampleTriangleGeometryFilter.md @@ -26,33 +26,7 @@ where ![](Images/PSTG_2.png) are the coordinates of the sampled point; ![](Image The user may opt to use a mask to prevent certain **Triangles** from being sampled; where the mask is _false_, the **Triangle** will not be sampled. Additionally, the user may choose any number of **Face Attribute Arrays** to transfer to the created **Vertex Geometry**. The vertices in the new **Vertex Geometry** will gain the values of the **Faces** from which they were sampled. -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Source for Number of Samples | Enumeration | Whether to input the number of samples manually or use another **Geometry** to determine the number of samples | -| Number of Sample Points | int32_t | Number of sample points to use, if _Manual_ is selected for _Source for Number of Samples_ | -| Use Mask | bool | Whether to use a boolean mask array to ignore certain **Trianlges** flagged as _false_ from the sampling algorithm | - -## Required Geometry # - -Triangle - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Data Container | TriangleDataContainer | N/A | N/A | Data Container holding the **Triangle Geometry** to sample | -| Data Container | None | N/A | N/A | Data Container holding the **Geometry** used to determine the number of samples, if _Other Geometry_ is selected for _Source for Number of Samples_ | -| Face Attribute Array | FaceAreas | double | (1) | Specifies the area of each Face | -| Face Attribute Array | Mask | bool | (1) | Specifies if the **Face** can be sampled, if _Use Mask_ is checked | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Data Container | VertexDataContainer | N/A | N/A | Data Container holding the **Vertex Geometry** that represents the sampling points | -| Vertex Attribute Matrix | VertexData | Vertex | N/A | Vertex Attribute Matrix**for the created**Vertex Data Container | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -60,6 +34,6 @@ Triangle 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. diff --git a/src/Plugins/ComplexCore/docs/QuickSurfaceMeshFilter.md b/src/Plugins/ComplexCore/docs/QuickSurfaceMeshFilter.md index 26e1cbc5be..1d3ce15388 100644 --- a/src/Plugins/ComplexCore/docs/QuickSurfaceMeshFilter.md +++ b/src/Plugins/ComplexCore/docs/QuickSurfaceMeshFilter.md @@ -59,35 +59,7 @@ One of the arrays to come out of the algorithm is the "Node Type" vertex array. | 13 | Node that is on the exterior of the mesh and is a triple line | | 14 | Node that is on the exterior of the mesh and is a quadruple point | -## Parameters - -| Human Name | Description | Parameter Type | -|--------------|-------------|----------------| -| Attempt to Fix Problem Voxels | See help page. | complex.BoolParameter | -| Generate Triple Lines | Experimental feature. May not work. Keep this off. | complex.BoolParameter | - -## Required Geometry - -Image/RectGrid - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Cell Attribute Array | FeatureIds | int32_t | (1) | Specifies to which **Feature** each **Cell** belongs | -| Any **Cell Attribute Array | None | Any | Any | Specifies which **Cell Attribute Arrays** to transfer to the created **Triangle Geometry | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Data Container | TriangleDataContainer | N/A | N/A | Created **Data Container** name with a **Triangle Geometry | -| Attribute Matrix | VertexData | Vertex | N/A | Created **Vertex Attribute Matrix** name | -| Vertex Attribute Array | NodeTypes | int8_t | (1) | Specifies the type of node in the **Geometry | -| Attribute Matrix | FaceData | Face | N/A | Created **Face Attribute Matrix** name | -| Face Attribute Array | FaceLabels | int32_t | (2) | Specifies which **Features** are on either side of each Face | -| Attribute Matrix | FaceFeatureData | Face Feature | N/A | Feature Attribute Matrix** of the created *Face Labels* | -| Any **Face Attribute Array | None | Any | Any | The set of transferred **Cell Attribute Arrays | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -97,6 +69,6 @@ Image/RectGrid 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. diff --git a/src/Plugins/ComplexCore/docs/RawBinaryReaderFilter.md b/src/Plugins/ComplexCore/docs/RawBinaryReaderFilter.md index 8ff9fc510c..5e93e40d48 100644 --- a/src/Plugins/ComplexCore/docs/RawBinaryReaderFilter.md +++ b/src/Plugins/ComplexCore/docs/RawBinaryReaderFilter.md @@ -50,29 +50,7 @@ This setting is *crucial* to the correct interpretation of the binary data, so t If the raw binary file you are reading has a *header* before the actual data begins, the user can instruct the **Filter** to skip this header portion of the file. The user needs to know how lond the header is in bytes. Another way to use this value is if the user wants to read data out of the interior of a file by skipping a defined number of bytes. -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Input File | File Path | The input binary file path | -| Scalar Type | Enumeration | Data type of the binary data | -| Number of Components | int32_t | The number of values at each tuple | -| Endian | Enumeration | The endianness of the data | -| Skip Header Bytes | int32_t | Number of bytes to skip before reading data | - -## Required Geometry - -Not Applicable - -## Required Objects - -None - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Any | None | Any | Any | Created **Attribute Array** name | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -80,6 +58,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. diff --git a/src/Plugins/ComplexCore/docs/RegularGridSampleSurfaceMeshFilter.md b/src/Plugins/ComplexCore/docs/RegularGridSampleSurfaceMeshFilter.md index 57c9accd4e..dd91203360 100644 --- a/src/Plugins/ComplexCore/docs/RegularGridSampleSurfaceMeshFilter.md +++ b/src/Plugins/ComplexCore/docs/RegularGridSampleSurfaceMeshFilter.md @@ -13,36 +13,12 @@ This **Filter** "samples" a triangulated surface mesh on a rectilinear grid. The 3. For each bounding box a **Cell** falls in, check against that **Feature's** **Triangle** list to determine if the **Cell** falls within that n-sided polyhedra (*Note:* if the surface mesh is conformal, then each **Cell** will only belong to one **Feature**, but if not, the last **Feature** the **Cell** is found to fall inside of will *own* the **Cell**) 4. Assign the **Feature** number that the **Cell** falls within to the *Feature Ids* array in the new rectilinear grid geometry -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Dimensions | uint64 | Number of **Cells** along each axis | -| Resolution | float32 (3x) | The resolution values (dx, dy, dz) | -| Origin | float32 (3x) | The origin of the sampling volume | - -## Required Geometry - -Triangle - -## Required Objects - -| Type | Default Name | Type | Comp Dims | Description | -|------|--------------|-----|-----|-----------------------------------| -| Data Array | Face Labels | int32 | (2) | Specifies which **Features** are on either side of each **Face**. | - -## Created - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Image Geometry | Image Geometry | N/A | N/A | Created **Image Geometry** name and *DataPath* | -| Attribute Matrix | Cell Data | Cell | N/A | Created **Cell Attribute Matrix** name | -| Data Array | Feature Ids | int32 | (1) | Specifies to which **Feature** each **Cell** belongs | +% 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. diff --git a/src/Plugins/ComplexCore/docs/RemoveFlaggedFeaturesFilter.md b/src/Plugins/ComplexCore/docs/RemoveFlaggedFeaturesFilter.md index e63273b027..77b70277a9 100644 --- a/src/Plugins/ComplexCore/docs/RemoveFlaggedFeaturesFilter.md +++ b/src/Plugins/ComplexCore/docs/RemoveFlaggedFeaturesFilter.md @@ -8,24 +8,7 @@ Processing (Cleanup) This **Filter** will remove **Features** that have been flagged by another **Filter** from the structure. The **Filter** requires that the user point to a boolean array at the **Feature** level that tells the **Filter** whether the **Feature** should remain in the structure. If the boolean array is *false* for a **Feature**, then all **Cells** that belong to that **Feature** are temporarily *unassigned* and after all *undesired* **Features** are removed, the remaining **Features** are isotropically coarsened to fill in the gaps left by the removed **Features**. -## Parameters - -None - -## 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 | -| Feature Attribute Array | Active | bool | (1) | Specifies whether the **Feature** will remain in the structure or not | - -## Created Objects - -None +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -33,6 +16,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. diff --git a/src/Plugins/ComplexCore/docs/RemoveFlaggedVertices.md b/src/Plugins/ComplexCore/docs/RemoveFlaggedVertices.md index 3a26a8fa98..cb3d1b17bf 100644 --- a/src/Plugins/ComplexCore/docs/RemoveFlaggedVertices.md +++ b/src/Plugins/ComplexCore/docs/RemoveFlaggedVertices.md @@ -20,26 +20,7 @@ as the original source. all associated **Vertex** data to be copied will be initialized to have size 0. Any **Feature** or **Ensemble** information will retain the same dimensions and size. -## Parameters - -None - -## Required Geometry # - -Vertex - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Data Container | VertexDataContainer | N/A | N/A | Data Container holding the **Vertex Geometry** to reduce | -| Vertex Attribute Array | Mask | bool | (1) | Mask array specifying which **Vertices* to remove | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Reduced **Data Container | ReducedVertexDataContainer | N/A | N/A | Data Container holding the reduced **Vertex Geometry** and any copied **Attribute Matrices** and **Attribute Arrays | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -47,6 +28,6 @@ Vertex 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. diff --git a/src/Plugins/ComplexCore/docs/RemoveMinimumSizeFeaturesFilter.md b/src/Plugins/ComplexCore/docs/RemoveMinimumSizeFeaturesFilter.md index 652303fbe6..8e9099cecc 100644 --- a/src/Plugins/ComplexCore/docs/RemoveMinimumSizeFeaturesFilter.md +++ b/src/Plugins/ComplexCore/docs/RemoveMinimumSizeFeaturesFilter.md @@ -14,29 +14,7 @@ The **Filter** can be run in a mode where the minimum number of neighbors is app If any features are removed **and** the Cell Feature AttributeMatrix contains any *NeighborList* data arrays those arrays will be **REMOVED** because those lists are now invalid. Re-run the *Find Neighbors* filter to re-create the lists. -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Minimum Allowed Feature Size | int32_t | Number of **Cells** that must be present in the **Feature** for it to remain in the sample | -| Apply to Single Phase Only | bool | Tells the Filter whether to apply minimum to single ensemble or all ensembles | -| Phase Index | int32_t | Which **Ensemble** to apply minimum to. Only needed if *Apply to Single Phase Only* is checked | - -## 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 | -| Feature Attribute Array | Phases | int32_t | (1) | Specifies to which **Ensemble** each **Feature** belongs. Only required if *Apply to Single Phase Only* is checked | -| Feature Attribute Array | NumCells | int32_t | (1) | Specifies the number of **Cells** belonging to each **Feature | - -## Created Objects - -None +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -47,6 +25,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. diff --git a/src/Plugins/ComplexCore/docs/RenameDataObject.md b/src/Plugins/ComplexCore/docs/RenameDataObject.md index 16beaf8326..e50cf83073 100644 --- a/src/Plugins/ComplexCore/docs/RenameDataObject.md +++ b/src/Plugins/ComplexCore/docs/RenameDataObject.md @@ -8,25 +8,7 @@ Core (Memory/Management) This **Filter** renames a user chosen **Data Object** of any type. -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| New Data Object Name| String | New name for the selected **Data Object | - -## Required Geometry - -Not Applicable - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Data Object | None | N/A | N/A | Data Object** to rename | - -## Created Objects - -None +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -34,6 +16,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. diff --git a/src/Plugins/ComplexCore/docs/ReplaceElementAttributesWithNeighborValuesFilter.md b/src/Plugins/ComplexCore/docs/ReplaceElementAttributesWithNeighborValuesFilter.md index 9c299b6166..dfd47c773a 100644 --- a/src/Plugins/ComplexCore/docs/ReplaceElementAttributesWithNeighborValuesFilter.md +++ b/src/Plugins/ComplexCore/docs/ReplaceElementAttributesWithNeighborValuesFilter.md @@ -76,28 +76,7 @@ scan point was not indexed. By using the *Error* value from the data file we can Note the large areas of unindexed pixels in the original image (black pixels) and how they are all filled in. The filter can act much like a generic "flood fill" image processing algorithm if used improperly. -## Parameters - -| Name | Type | Description | -|---------------------|----------|--------------------------------------------------------------------------------------------------| -| Threshold Value | Any | Sets the threshold value a **Cell** must have to be considered for changing | -| Comparison Operator | Int | Selects the operator to use. 0 = < (Less Than). 1 = > (Greater Than) | -| Loop Until Gone | bool | Whether to iterate until all **Cells** are above the minimum tolerance or just run one iteration | -| Image Geometry | DataPath | The path to the Image Geometry | - -## Required Geometry - -Image - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|--------------------------|--------------|------|-------------|------------------------------------------------| -| Cell Attribute Array | N/A | Any | (1) | The DataArray to use as input into the filter. | - -## Created Objects - -None +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -111,6 +90,6 @@ The example pipeline (pipelines/Examples/ReplaceElementAttributesWithNeighbor.d3 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. diff --git a/src/Plugins/ComplexCore/docs/ResampleImageGeomFilter.md b/src/Plugins/ComplexCore/docs/ResampleImageGeomFilter.md index 1e8fbfab8f..80e3bd81d1 100644 --- a/src/Plugins/ComplexCore/docs/ResampleImageGeomFilter.md +++ b/src/Plugins/ComplexCore/docs/ResampleImageGeomFilter.md @@ -64,34 +64,7 @@ A new grid of **Cells** is created and "overlaid" on the existing grid of **Cell *Note:* This filter does NOT change the overall bounds of the volume, just the spacing and number of cells in the volume. To change the overall bounds of the volume, apply a scaling transformation with the [Apply Transformation To Geometry](./ApplyTransformationToGeometryFilter.md) filter. -## Parameters - -| Name | Type | Description | -|--------------------------|-------------|-------------------------------------------------------------------------------------------------------------| -| Resampling Mode | int | The resampling mode used to resample the image geometry. Choices are Spacing, Scaling, or Exact Dimensions | -| Spacing | float (3x) | The new resolution values (dx, dy, dz) | -| Scale Factor | float (3x) | The scale factor (dx, dy, dz), in percentages. | -| Exact Dimensions | uint64 (3x) | The exact dimensions (dx, dy, dz) to resample the geometry. | -| Renumber Features | bool | Whether the **Features** should be renumbered | -| Remove Original Geometry | bool | Whether the current **Geometry** should be removed after the resampling | - -## Required Geometry - -Image - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Attribute Matrix | CellData | Cell | N/A | Cell Attribute Matrix** that holds data for resolution change | -| Cell Attribute Array | FeatureIds | int32_t | (1) | Specifies to which **Feature** each **Cell** belongs. Only required if *Renumber Features* is checked | -| Attribute Matrix | CellFeatureData | Cell Feature | N/A | Feature Attribute Matrix** that corresponds to the **Feature** data for the selected *Feature Ids*. Only required if *Renumber Features* is checked | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Data Container | NewImageDataContainer | N/A | N/A | Created **Data Container** name with an **Image Geometry**. | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -101,6 +74,6 @@ ComplexCore/ResamplePorosityImage 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. diff --git a/src/Plugins/ComplexCore/docs/ResampleRectGridToImageGeomFilter.md b/src/Plugins/ComplexCore/docs/ResampleRectGridToImageGeomFilter.md index ea7d258b34..f2e2d729bd 100644 --- a/src/Plugins/ComplexCore/docs/ResampleRectGridToImageGeomFilter.md +++ b/src/Plugins/ComplexCore/docs/ResampleRectGridToImageGeomFilter.md @@ -14,25 +14,7 @@ The algorithm logic is thus: If the ImageGeometry cell would contain multiple Re The user can select which cell attribute matrix data arrays will be copied into the newly created Image Geometry Cell Attribute Matrix. -## Parameters - -| Name | Type | Description | -|------|------|------| -| Input Rectilinear Grid| DataPath | Path to the RectGrid Geometry to be re-sampled | -| Selected Cell Attribute Arrays to Copy | Array of (DataPath) | Rect Grid Cell Data to possibly copy | -| Image Geometry Voxel Dimensions | 3 x Int32 | The image geometry voxel dimensions in which to re-sample the rectilinear grid geometry | - -## Required Geometry - -Rectilinear Grid Geometry - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Image Geometry | Image Geometry | N/A | N/A | Path to the created Image Geometry | -| Attribute Matrix | Cell Data | Element/Feature/Ensemble/etc. | N/A | The name of the cell data Attribute Matrix created with the Image Geometry | -| Element/Feature/Ensemble/etc. Attribute Array | Copied from the input Data Container | int32_t/float/etc. | (1)/(3)/etc. | Cell level arrays copied over from the input to the resampled geometry | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -40,6 +22,6 @@ Rectilinear Grid 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. diff --git a/src/Plugins/ComplexCore/docs/ReverseTriangleWindingFilter.md b/src/Plugins/ComplexCore/docs/ReverseTriangleWindingFilter.md index c30b4acb80..01f633a0c2 100644 --- a/src/Plugins/ComplexCore/docs/ReverseTriangleWindingFilter.md +++ b/src/Plugins/ComplexCore/docs/ReverseTriangleWindingFilter.md @@ -8,23 +8,7 @@ Surface Meshing (Connectivity/Arrangement) This **Filter** reverses the *winding* for each **Triangle** in a **Triangle Geometry**. This will *reverse* the direction of calculated **Triangle** normals. Some analysis routines require the normals to be pointing "away" from the center of a **Feature**. This **Filter** allows for manipulation of this construct. -## Parameters - -None - -## Required Geometry - -Triangle - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Data Container | None | N/A | N/A | Data Container that holds the **Triangle Geometry** to reverse winding | - -## Created Objects - -None +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -32,6 +16,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. diff --git a/src/Plugins/ComplexCore/docs/RobustAutomaticThreshold.md b/src/Plugins/ComplexCore/docs/RobustAutomaticThreshold.md index 28d2fc15e6..3ff9199d86 100644 --- a/src/Plugins/ComplexCore/docs/RobustAutomaticThreshold.md +++ b/src/Plugins/ComplexCore/docs/RobustAutomaticThreshold.md @@ -12,26 +12,7 @@ This **Filter** automatically computes a threshold value for a scalar **Attribut where \f$ a \f$ is the input array, \f$ g \f$ is the gradient magnitude array, \f$ n \f$ is the length of the input array, and \f$ T \f$ is the computed threshold value. Computing a threshold in this manner will generally partition the input array where its gradient is highest. Gradients may be computed using the Find Derivatives **Filter**. The gradient magnitude may then be found by computing the 2-norm of the gradient. -## Parameters - -None - -## Required Geometry # - -None - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Any **Attribute Array | None | Any except bool | (1) | Attribute Array** to threshold | -| Attribute Array | None | float | (1) | Gradient magnitude of input **Attribute Array | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Attribute Array | Mask | bool | (1) | Mask array produced after application of the computed robust threshold to the input **Attribute Array | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -39,6 +20,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. diff --git a/src/Plugins/ComplexCore/docs/RotateSampleRefFrameFilter.md b/src/Plugins/ComplexCore/docs/RotateSampleRefFrameFilter.md index 799ee3b4ee..5d48dd6236 100644 --- a/src/Plugins/ComplexCore/docs/RotateSampleRefFrameFilter.md +++ b/src/Plugins/ComplexCore/docs/RotateSampleRefFrameFilter.md @@ -24,28 +24,7 @@ When importing EBSD data from EDAX typically the user will need to rotate the sa ![Imported EBSD Data Rotated about the <010> axis](Images/RotateSampleRefFrame_1.png) -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Rotation Representation | Enumeration | Which form used to represent rotation (**axis angle** or **rotation matrix) | -| Rotation Axis (ijk) | float (3x) | Axis in sample reference frame to rotate about (if **axis angle**) | -| Rotation Angle (Degrees) | float | Magnitude of rotation (in degrees) about the rotation axis (if **axis angle**) | -| Rotation Matrix | float (3x3) | Axis in sample reference frame to rotate about (if **rotation matrix**) | - -## Required Geometry - -Image - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| DataArray | N/A | Any | Same as geometry | List of **DataArrays** associated with the geometry | - -## Created Objects - -None +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -60,6 +39,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. diff --git a/src/Plugins/ComplexCore/docs/ScalarSegmentFeaturesFilter.md b/src/Plugins/ComplexCore/docs/ScalarSegmentFeaturesFilter.md index d1c42e4e25..90fde6845a 100644 --- a/src/Plugins/ComplexCore/docs/ScalarSegmentFeaturesFilter.md +++ b/src/Plugins/ComplexCore/docs/ScalarSegmentFeaturesFilter.md @@ -18,31 +18,7 @@ The user has the option to *Use Mask Array*, which allows the user to set a bool After all the **Features** have been identified, an **Attribute Matrix** is created for the **Features** and each **Feature** is flagged as *Active* in a boolean array in the matrix. -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Scalar Tolerance | float | Tolerance used to determine if neighboring **Cells** belong to the same **Feature | -| Use Mask Array | bool | Specifies whether to use a boolean array to exclude some **Cells** from the **Feature** identification process | - -## Required Geometry - -Image - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Cell Attribute Array | None | Any | (1) | Scalar array used during segmentation | -| Cell Attribute Array | Mask | bool | (1) | Specifies if the **Cell** is to be counted in the algorithm. Only required if *Use Mask Array* is checked | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Cell Attribute Array | FeatureIds | int32_t | (1) | Specifies to which **Feature** each **Cell** belongs. | -| Attribute Matrix | CellFeatureData | Cell Feature | N/A | Created **Feature Attribute Matrix** name | -| Feature Attribute Array | Active | bool | (1) | Specifies if the **Feature** is still in the sample (*true* if the **Feature** is in the sample and *false* if it is not). At the end of the **Filter**, all **Features** will be *Active* | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -52,6 +28,6 @@ Image 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. diff --git a/src/Plugins/ComplexCore/docs/SetImageGeomOriginScalingFilter.md b/src/Plugins/ComplexCore/docs/SetImageGeomOriginScalingFilter.md index 4b2dd693ff..620ef7e8de 100644 --- a/src/Plugins/ComplexCore/docs/SetImageGeomOriginScalingFilter.md +++ b/src/Plugins/ComplexCore/docs/SetImageGeomOriginScalingFilter.md @@ -12,28 +12,7 @@ This **Filter** changes the origin and/or the spacing of an **Image Geometry**. + Y Origin: 4 + Z Origin: 8 -## Parameters - -| Name | Type | Description | -|---------|-----------|--------| -| Origin | float (3x) | New origin for the **Image Geometry | -| Spacing | float (3x) | New spacing for the **Image Geometry | -| Change Origin | bool | Whether a new origin should be applied to the **Image Geometry | -| Change Spacing | bool | Whether a new spacing should be applied to the **Image Geometry | - -## Required Geometry - -Image - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Data Container | None | N/A | N/A | Data Container with an **Image Geometry** to modify | - -## Created Objects - -None +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -41,6 +20,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. diff --git a/src/Plugins/ComplexCore/docs/SharedFeatureFaceFilter.md b/src/Plugins/ComplexCore/docs/SharedFeatureFaceFilter.md index 7c8f5738bf..f36497e8aa 100644 --- a/src/Plugins/ComplexCore/docs/SharedFeatureFaceFilter.md +++ b/src/Plugins/ComplexCore/docs/SharedFeatureFaceFilter.md @@ -31,30 +31,7 @@ that store the following information: --------------- -## Parameters - -| Name | Type | Description | -|--------------------------|---------|-------------------------------------------------------------------------------------| -| Randomize Feature Values | boolean | Should the final 'FeatureFaceId' Array be randomized. This can aid in visualization | - -## Required Geometry - -Triangle - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|--------------------------|--------------|---------|-------------|------------------------------------------------------------------| -| Face Attribute Array | FaceLabels | int32_t | (2) | Specifies which **Features** are on either side of each Face | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|-----------------------------|-----------------|--------------|-------------|--------------------------------------------------------------------------------------| -| Face Attribute Array** | FeatureFaceId | int32_t | (1) | Specifies to which **Feature** each **Face** belongs | -| Attribute Matrix** | FaceFeatureData | Face Feature | N/A | Created **Feature Attribute Matrix** name | -| Feature Attribute Array | FaceLabels | int32_t | (2) | Specifies which _original_ **Features** are on either side of each _new_ **Feature | -| Feature Attribute Array | NumTriangles | int32_t | (1) | Number of **Triangles** in each **Feature** | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -64,6 +41,6 @@ Triangle 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. diff --git a/src/Plugins/ComplexCore/docs/SilhouetteFilter.md b/src/Plugins/ComplexCore/docs/SilhouetteFilter.md index 278d17a1bd..1906113d8b 100644 --- a/src/Plugins/ComplexCore/docs/SilhouetteFilter.md +++ b/src/Plugins/ComplexCore/docs/SilhouetteFilter.md @@ -14,30 +14,7 @@ where \f$ a \f$ is the average distance between point \f$ i \f$ and all other po The silhouette can be used to determine how well a particular clustering has performed, such as k means or k medoids. -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Distance Metric | Enumeration | The metric used to determine the distances between points | -| Use Mask | bool | Whether to use a boolean mask array to ignore certain points flagged as *false* from the algorithm | - -## Required Geometry # - -None - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Any **Attribute Array | None | Any| Any | The **Attribute Array** to silhouette | -| Attribute Array | ClusterIds | int32_t | (1) | Specifies to which cluster each point belongs | -| Attribute Array | Mask | bool | (1) | Specifies if the point is to be counted in the algorithm, if *Use Mask* is checked | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Attribute Array | Silhouette | double | (1) | Silhouette value for each point | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -45,6 +22,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. diff --git a/src/Plugins/ComplexCore/docs/SplitAttributeArrayFilter.md b/src/Plugins/ComplexCore/docs/SplitAttributeArrayFilter.md index b10a885da7..605c6c7bdc 100644 --- a/src/Plugins/ComplexCore/docs/SplitAttributeArrayFilter.md +++ b/src/Plugins/ComplexCore/docs/SplitAttributeArrayFilter.md @@ -22,27 +22,7 @@ There is an alternative option which allows the user to select a subset of compo This **Filter** is the opposite operation of the Combine Attribute Arrays **Filter**, and the generalized version of the Extract Component as Attribute Array **Filter**. -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Postfix | string | Postfix to add to the end of the split **Attribute Arrays**; this value may be empty | - -## Required Geometry # - -None - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Any **Attribute Array | None | Any | > (1) | The multicomponent **Attribute Array** to split | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Attribute Arrays | Input array name + *Postfix* + component number | Same as input array | (1)| The set of scalar **Attribute Arrays**, equal to the number of components of the input **Attribute Array | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -50,6 +30,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. diff --git a/src/Plugins/ComplexCore/docs/StlFileReaderFilter.md b/src/Plugins/ComplexCore/docs/StlFileReaderFilter.md index 7921e09a1a..4844791944 100644 --- a/src/Plugins/ComplexCore/docs/StlFileReaderFilter.md +++ b/src/Plugins/ComplexCore/docs/StlFileReaderFilter.md @@ -21,33 +21,7 @@ This **Filter** will read a binary STL File and create a **Triangle Geometry** **It is very important that the "Attribute byte Count" is correct as DREAM.3D follows the specification strictly.** If you are writing an STL file be sure that the value for the "Attribute byte count" is *zero* (0). If you chose to encode additional data into a section after each triangle then be sure that the "Attribute byte count" is set correctly. DREAM.3D will obey the value located in the "Attribute byte count". -## Parameters - -| Name | Type | Description | -|------|------|------| -| STL File | File Path | The input .stl file path | -| Scale Output | Bool | Should the output vertex values be scaled | -| Scale Factor | Float | Apply the scaling factor to each vertex | -| Vertex Attribute Matrix | String | Name of the created Vertex Attribute Matrix | -| Face Attribute Matrix | String | Name of the created Face Attribute Matrix | -| Shared Vertex Attribute Matrix | String | Name of the created Shared Vertex Attribute Matrix | -| Shared Face Attribute Matrix | String | Name of the created Shared Face Attribute Matrix | - -## Required Geometry - -Not Applicable - -## Required Objects - -None - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Data Container | TriangleDataContainer | N/A | N/A | Created **Data Container** name with a **Triangle Geometry | -| Attribute Matrix | FaceData | Face | N/A | Created **Face Attribute Matrix** name | -| Face Attribute Array | FaceNormals | double | (3) | Specifies the normal of each Face | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -55,6 +29,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. diff --git a/src/Plugins/ComplexCore/docs/SurfaceNetsFilter.md b/src/Plugins/ComplexCore/docs/SurfaceNetsFilter.md index 1cd7821327..766b6b5c1a 100644 --- a/src/Plugins/ComplexCore/docs/SurfaceNetsFilter.md +++ b/src/Plugins/ComplexCore/docs/SurfaceNetsFilter.md @@ -35,37 +35,7 @@ SurfaceNets output **with** the built-in smoothing operation applied. --------------- -## Parameters - -| Human Name | Description | Parameter Type | -|--------------|-------------|----------------| -| Apply Smoothing Operation | This will enable the built-in smoothing from the SurfaceNets algorithm | complex.BoolParameter | -| Relaxation Iterations | The number of smoothing iterations to perform | complex.Int32Parameter | -| Max Distance from Voxel | The maximum allowable distance that a node can move from the voxel center | complex.Float32Parameter | -| Relaxation Factor | How far a node can move during each smoothing operation | complex.Float32Parameter | - -## Required Geometry - -Image/RectGrid - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|------------------------------|--------------|---------|-------------|--------------------------------------------------------------------------------------------| -| Cell Attribute Array** | FeatureIds | int32_t | (1) | Specifies to which **Feature** each **Cell** belongs | -| Any **Cell Attribute Array | None | Any | Any | Specifies which **Cell Attribute Arrays** to transfer to the created **Triangle Geometry | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|------------------------------|-----------------------|------------------|-------------|------------------------------------------------------------------| -| Data Container | TriangleDataContainer | N/A | N/A | Created **Data Container** name with a **Triangle Geometry** | -| Attribute Matrix** | VertexData | Vertex | N/A | Created **Vertex Attribute Matrix** name | -| Vertex Attribute Array** | NodeTypes | int8_t | (1) | Specifies the type of node in the **Geometry** | -| Attribute Matrix** | FaceData | Face | N/A | Created **Face Attribute Matrix** name | -| Face Attribute Array** | FaceLabels | int32_t | (2) | Specifies which **Features** are on either side of each Face | -| Attribute Matrix** | FaceFeatureData | Face Feature | N/A | Feature Attribute Matrix** of the created _Face Labels_ | -| Any **Face Attribute Array | None | List of DataPath | Any | The set of transferred **Cell Attribute Arrays** | +% Auto generated parameter table will be inserted here ## Example Pipelines diff --git a/src/Plugins/ComplexCore/docs/TriangleCentroidFilter.md b/src/Plugins/ComplexCore/docs/TriangleCentroidFilter.md index 82c5f126a1..f9546e7ae1 100644 --- a/src/Plugins/ComplexCore/docs/TriangleCentroidFilter.md +++ b/src/Plugins/ComplexCore/docs/TriangleCentroidFilter.md @@ -9,23 +9,7 @@ Surface Meshing (Misc) This **Filter** computes the centroid of each **Triangle** in a **Triangle Geometry** by calculating the average position of all 3 **Vertices** that make up the **Triangle**. -## Parameters - -None - -## Required Geometry - -Triangle - -## Required Objects - -None - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|--------------------------|---------------|--------|-------------|-----------------------------------------| -| Face Attribute Array | FaceCentroids | float32 | (1) | Specifies the centroid of each Face | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -35,6 +19,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. diff --git a/src/Plugins/ComplexCore/docs/TriangleDihedralAngleFilter.md b/src/Plugins/ComplexCore/docs/TriangleDihedralAngleFilter.md index a88fded2e3..7c90b7d11c 100644 --- a/src/Plugins/ComplexCore/docs/TriangleDihedralAngleFilter.md +++ b/src/Plugins/ComplexCore/docs/TriangleDihedralAngleFilter.md @@ -8,23 +8,7 @@ Surface Meshing (Misc) This **Filter** computes the minimum dihedral angle of each **Triangle** in a **Triangle Geometry** by utilizing matrix mathematics -## Parameters - -None - -## Required Geometry - -Triangle - -## Required Objects - -None - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Face Attribute Array | dihedralAngles | double array | (1) | Specifies the minimum dihedral angle of each triangle of each Face | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -35,6 +19,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. diff --git a/src/Plugins/ComplexCore/docs/TriangleNormalFilter.md b/src/Plugins/ComplexCore/docs/TriangleNormalFilter.md index 038397a9f5..f05d60c171 100644 --- a/src/Plugins/ComplexCore/docs/TriangleNormalFilter.md +++ b/src/Plugins/ComplexCore/docs/TriangleNormalFilter.md @@ -15,23 +15,7 @@ This **Filter** computes the normal of each **Triangle** in a **Triangle Geometr Where "point#" represents a 3x1 Matrix of coordinates x, y, and z belonging to one of a Triangles vertexes and N represents the normal of the corresponding axis value -## Parameters - -None - -## Required Geometry - -Triangle - -## Required Objects - -None - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Face Attribute Array | FaceNormals | double array | (1) | Specifies the normal of each Face | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -42,6 +26,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. diff --git a/src/Plugins/ComplexCore/docs/UncertainRegularGridSampleSurfaceMesh.md b/src/Plugins/ComplexCore/docs/UncertainRegularGridSampleSurfaceMesh.md index eabb3a68cf..9ad3e584c0 100644 --- a/src/Plugins/ComplexCore/docs/UncertainRegularGridSampleSurfaceMesh.md +++ b/src/Plugins/ComplexCore/docs/UncertainRegularGridSampleSurfaceMesh.md @@ -49,6 +49,6 @@ Triangle 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. diff --git a/src/Plugins/ComplexCore/docs/UncertainRegularGridSampleSurfaceMeshFilter.md b/src/Plugins/ComplexCore/docs/UncertainRegularGridSampleSurfaceMeshFilter.md index eabb3a68cf..90ed738f08 100644 --- a/src/Plugins/ComplexCore/docs/UncertainRegularGridSampleSurfaceMeshFilter.md +++ b/src/Plugins/ComplexCore/docs/UncertainRegularGridSampleSurfaceMeshFilter.md @@ -16,39 +16,12 @@ This **Filter** "samples" a triangulated surface mesh on a rectilinear grid, but **Note that the unperturbed grid is where the *Feature Ids* actually live, but the perturbed locations are where the Cells are sampled from. Essentially, the *Feature Ids* are stored where the user *thinks* the sampling took place, not where it actually took place!** -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Use Seed | bool | If *true* user may set a set a seed for random generation | -| Seed | uint64 | This is the seed fed into the random generator | -| Dimensions | uint64 | Number of **Cells** along each axis | -| Resolution | float32 (3x) | The resolution values (dx, dy, dz) | -| Origin | float32 (3x) | The origin of the sampling volume | -| Uncertainty | float32 (3x) | Vector of uncertainty values associated with X, Y and Z positions of **Cells | - -## Required Geometry - -Triangle - -## Required Objects - -| Type | Default Name | Type | Comp Dims | Description | -|------|--------------|-----|-----|-----------------------------------| -| Data Array | Face Labels | int32 | (2) | Specifies which **Features** are on either side of each **Face**. | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Image Geometry | Image Geometry | N/A | N/A | Created **Image Geometry** name and *DataPath* | -| Attribute Matrix | Cell Data | Cell | N/A | Created **Cell Attribute Matrix** name | -| Data Array | Feature Ids | int32 | (1) | Specifies to which **Feature** each **Cell** belongs | +% 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. diff --git a/src/Plugins/ComplexCore/docs/VtkRectilinearGridWriterFilter.md b/src/Plugins/ComplexCore/docs/VtkRectilinearGridWriterFilter.md index 8d2cff3ed4..820ae1a9c0 100644 --- a/src/Plugins/ComplexCore/docs/VtkRectilinearGridWriterFilter.md +++ b/src/Plugins/ComplexCore/docs/VtkRectilinearGridWriterFilter.md @@ -8,34 +8,7 @@ I/O Filters This Filter reads the **Feature** and phase ids together with image parameters required by Vtk to an output file named by the user. The file is used to generate the image of the **Features** and phases of the **Features**. -## Parameters - -| Name | Type | -|------|------| -| Output File | Output File | -| Write **Feature** Ids | Boolean (On or Off) | -| Write Phase Ids | Boolean (On or Off) | -| Write Band Contrasts | Boolean (On or Off) | -| Write KAM Value | Boolean (On or Off) | -| Write GAM Values | Boolean (On or Off) | -| Write LMG Values | Boolean (On or Off) | -| Write Good **Cells | Boolean (On or Off) | -| Write IPF Colors | Boolean (On or Off) | -| Write Binary File | Boolean (On or Off) | - -## Required DataContainers - -Voxel - -## Required Objects - -| Type | Default Name | Description | Comment | Filters Known to Create Data | -|------|--------------|-----|-----|-----------------------------------| -| Cell | GrainIds | Ids (ints) that specify to which **Feature** each **Cell** belongs. | Values should be present from segmentation of experimental data or synthetic generation and cannot be determined by this filter. Not having these values will result in the filter to fail/not execute. | Segment Features (Misorientation, C-Axis Misorientation, Scalar) (Reconstruction), Read Dx File (IO), Read Ph File (IO), Pack Primary Phases (SyntheticBuilding), Insert Precipitate Phases (SyntheticBuilding), Establish Matrix Phase (SyntheticBuilding) - -## Created Objects - -None +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -43,6 +16,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. diff --git a/src/Plugins/ComplexCore/docs/WriteASCIIDataFilter.md b/src/Plugins/ComplexCore/docs/WriteASCIIDataFilter.md index e8cf42c07c..1bcd70a57a 100644 --- a/src/Plugins/ComplexCore/docs/WriteASCIIDataFilter.md +++ b/src/Plugins/ComplexCore/docs/WriteASCIIDataFilter.md @@ -8,34 +8,12 @@ IO (Output) (Write) (Export) (Text) (CSV) (ASCII) This **Filter** accepts DataArray(s) as input, extracts the data, creates the file(s), and writes it out according to parameter choices -## Parameters - -| Name | Type | Decision | -|-------|-----|----------| -| Output Type | OutputSytle enum class | Whether data is printed to one file or multiple | -| Output Path | Filesystem::path | Directory to store printed array files | -| File Extension | string | The file extension used for generated files | -| Maximum Tuples Per Line | int32 | Number of tuples printed before newline character is printed | -| Delimiter | Delimiter enum class | ASCII character used to seperate values | - -## Required Geometry - -None - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|-----|-------|------|--------|------------------------------------------------------| -| DataArray | Attribute Arrays to Export | DataArray | any | Specifies **DataArray** to have their values printed | - -## 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. diff --git a/src/Plugins/ComplexCore/docs/WriteBinaryDataFilter.md b/src/Plugins/ComplexCore/docs/WriteBinaryDataFilter.md index fb4304f698..6371651ccf 100644 --- a/src/Plugins/ComplexCore/docs/WriteBinaryDataFilter.md +++ b/src/Plugins/ComplexCore/docs/WriteBinaryDataFilter.md @@ -8,32 +8,12 @@ IO (Output) (Write) (Export) (Binary) This **Filter** accepts DataArray(s) as input, extracts the data, creates the file(s), and writes it out to a single file in binary -## Parameters - -| Name | Type | Decision | -|-------|------|----------| -| Endianess | Endianess enum class | Determines underlying ordering of binary, if unsure, use Little (most universal) | -| Output Path | Filesystem::path | Directory to store printed array files | -| File Extension | string | The file extension used for generated files | - -## Required Geometry - -None - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------|-------|------|------|-----------------------------------------------------| -| DataArray | Attribute Arrays to Export | DataArray | any | Specifies **DataArray** to have their values printed | - -## 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. diff --git a/src/Plugins/ComplexCore/docs/WriteStlFileFilter.md b/src/Plugins/ComplexCore/docs/WriteStlFileFilter.md index 1da91a9bda..2e5eeac52b 100644 --- a/src/Plugins/ComplexCore/docs/WriteStlFileFilter.md +++ b/src/Plugins/ComplexCore/docs/WriteStlFileFilter.md @@ -8,34 +8,12 @@ IO (Output) This **Filter** will write a binary STL File for each unique **Feature** Id in the associated **Triangle** geometry. The STL files will be named with the [Feature_Id].stl. The user can designate an optional prefix for the files. -## Parameters - -| Name | Type | Description | -|------|------|------| -| Group by Feature Phases | bool | When true this allows the STL files to be further broken down by Phases | -| Output STL Directory | File Path | The output directory path where all of the individual STL files will be saved | -| STL File Prefix | String | Optional Prefix to use when creating the STL file names | - -## Required Geometry - -Triangle - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Face Data Array | Face Labels | int32 | (2) | Specifies which **Features** are on either side of each Face | -| Phases Data Array | Feature Phases | int32 | (2) | Specifies which **Phases** of **Features** are on either side of each Face | -| Normals Data Array | Face Normals | int32 | (2) | These are the face normals to be printed to the stl | - -## 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. diff --git a/src/Plugins/ComplexCore/src/ComplexCore/Filters/FeatureFaceCurvatureFilter.cpp b/src/Plugins/ComplexCore/src/ComplexCore/Filters/FeatureFaceCurvatureFilter.cpp index e3855f20ed..d60eb6b2d7 100644 --- a/src/Plugins/ComplexCore/src/ComplexCore/Filters/FeatureFaceCurvatureFilter.cpp +++ b/src/Plugins/ComplexCore/src/ComplexCore/Filters/FeatureFaceCurvatureFilter.cpp @@ -71,7 +71,7 @@ Parameters FeatureFaceCurvatureFilter::parameters() const params.insertLinkableParameter(std::make_unique(k_UseFaceNormals_Key, "Use Face Normals for Curve Fitting", "Use the face normals for curve fitting.", true)); - params.insertSeparator(Parameters::Separator{"Face Data"}); + params.insertSeparator(Parameters::Separator{"Required Face Data"}); params.insert(std::make_unique(k_FaceAttribMatrix_Key, "Face Attribute Matrix", "The AttributeMatrix that holds the triangle face data.", DataPath())); params.insert(std::make_unique(k_FaceLabels_Key, "Face Labels", "The DataPath to the 'Face Labels' DataArray", DataPath(), ArraySelectionParameter::AllowedTypes{DataType::int32}, ArraySelectionParameter::AllowedComponentShapes{IArray::ShapeType{2}})); @@ -82,6 +82,7 @@ Parameters FeatureFaceCurvatureFilter::parameters() const params.insert(std::make_unique(k_FaceCentroids_Key, "Face Centroids", "The DataPath to the 'Face Centroids' DataArray", DataPath(), ArraySelectionParameter::AllowedTypes{DataType::float64}, ArraySelectionParameter::AllowedComponentShapes{IArray::ShapeType{3}})); + params.insertSeparator(Parameters::Separator{"Created Face Data"}); params.insert(std::make_unique(k_PrincipalCurvature1_Key, "Principal Curvature 1", "Output DataPath to hold the 'Principal Curvature 1' values", DataPath())); params.insert(std::make_unique(k_PrincipalCurvature2_Key, "Principal Curvature 2", "Output DataPath to hold the 'Principal Curvature 2' values", DataPath())); params.insert(std::make_unique(k_PrincipalDirection1_Key, "Principal Direction 1", "Output DataPath to hold the 'Principal Direction 1' values", DataPath())); diff --git a/src/Plugins/ITKImageProcessing/docs/ITKAbsImage.md b/src/Plugins/ITKImageProcessing/docs/ITKAbsImage.md index 23e330fea4..ffc44d2b39 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKAbsImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKAbsImage.md @@ -10,27 +10,7 @@ ITKImageIntensity (ImageIntensity) itk::Math::abs() is used to perform the computation. -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | - -## Required Geometry - -Image Geometry - -## Required Objects - -| Name |Type | Description | -|-----|------|-------------| -| Input Image Geometry | DataPath | DataPath to the Input Image Geometry | -| Input Image Data Array | DataPath | Path to input image with pixel type matching BasicPixelIDTypeList | - -## Created Objects - -| Name |Type | Description | -|-----|------|-------------| -| Output Image Data Array | DataPath | Path to output image with pixel type matching BasicPixelIDTypeList | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -38,6 +18,6 @@ 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. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKAcosImage.md b/src/Plugins/ITKImageProcessing/docs/ITKAcosImage.md index 4b849dd9b3..5ab81b03b1 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKAcosImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKAcosImage.md @@ -19,27 +19,7 @@ The filter walks over all the pixels in the input image, and for each pixel does The filter expects both images to have the same dimension (e.g. both 2D, or both 3D, or both ND). -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | - -## Required Geometry - -Image Geometry - -## Required Objects - -| Name |Type | Description | -|-----|------|-------------| -| Input Image Geometry | DataPath | DataPath to the Input Image Geometry | -| Input Image Data Array | DataPath | Path to input image with pixel type matching BasicPixelIDTypeList | - -## Created Objects - -| Name |Type | Description | -|-----|------|-------------| -| Output Image Data Array | DataPath | Path to output image with pixel type matching BasicPixelIDTypeList | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -47,6 +27,6 @@ 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. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKAdaptiveHistogramEqualizationImage.md b/src/Plugins/ITKImageProcessing/docs/ITKAdaptiveHistogramEqualizationImage.md index 5ed65ae916..40e8da17fd 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKAdaptiveHistogramEqualizationImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKAdaptiveHistogramEqualizationImage.md @@ -22,30 +22,7 @@ The boundary condition ignores the part of the neighborhood outside the image, a For detail description, reference "Adaptive Image Contrast Enhancement using Generalizations of Histogram Equalization." J.Alex Stark. IEEE Transactions on Image Processing, May 2000. -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Radius | uint32 | | -| Alpha | float32 | Set/Get the value of alpha. Alpha = 0 produces the adaptive histogram equalization (provided beta=0). Alpha = 1 produces an unsharp mask. Default is 0.3. | -| Beta | float32 | Set/Get the value of beta. If beta = 1 (and alpha = 1), then the output image matches the input image. As beta approaches 0, the filter behaves as an unsharp mask. Default is 0.3. | - -## Required Geometry - -Image Geometry - -## Required Objects - -| Name |Type | Description | -|-----|------|-------------| -| Input Image Geometry | DataPath | DataPath to the Input Image Geometry | -| Input Image Data Array | DataPath | Path to input image with pixel type matching BasicPixelIDTypeList | - -## Created Objects - -| Name |Type | Description | -|-----|------|-------------| -| Output Image Data Array | DataPath | Path to output image with pixel type matching BasicPixelIDTypeList | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -53,6 +30,6 @@ 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. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKAsinImage.md b/src/Plugins/ITKImageProcessing/docs/ITKAsinImage.md index b896decca8..2b430f8f31 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKAsinImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKAsinImage.md @@ -19,27 +19,7 @@ The filter walks over all the pixels in the input image, and for each pixel does The filter expects both images to have the same dimension (e.g. both 2D, or both 3D, or both ND) -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | - -## Required Geometry - -Image Geometry - -## Required Objects - -| Name |Type | Description | -|-----|------|-------------| -| Input Image Geometry | DataPath | DataPath to the Input Image Geometry | -| Input Image Data Array | DataPath | Path to input image with pixel type matching BasicPixelIDTypeList | - -## Created Objects - -| Name |Type | Description | -|-----|------|-------------| -| Output Image Data Array | DataPath | Path to output image with pixel type matching BasicPixelIDTypeList | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -47,6 +27,6 @@ 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. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKAtanImage.md b/src/Plugins/ITKImageProcessing/docs/ITKAtanImage.md index 08995ee8cd..6ed7d479e7 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKAtanImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKAtanImage.md @@ -17,27 +17,7 @@ The filter walks over all the pixels in the input image, and for each pixel does - cast the double value resulting from std::atan() to the pixel type of the output image, - store the cast value into the output image. -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | - -## Required Geometry - -Image Geometry - -## Required Objects - -| Name |Type | Description | -|-----|------|-------------| -| Input Image Geometry | DataPath | DataPath to the Input Image Geometry | -| Input Image Data Array | DataPath | Path to input image with pixel type matching BasicPixelIDTypeList | - -## Created Objects - -| Name |Type | Description | -|-----|------|-------------| -| Output Image Data Array | DataPath | Path to output image with pixel type matching BasicPixelIDTypeList | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -45,6 +25,6 @@ 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. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKBinaryContourImage.md b/src/Plugins/ITKImageProcessing/docs/ITKBinaryContourImage.md index 8babb8c46d..06d75c0e11 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKBinaryContourImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKBinaryContourImage.md @@ -22,30 +22,7 @@ The connectivity can be changed to minimum or maximum connectivity with SetFully - LabelContourImageFilter BinaryErodeImageFilter SimpleContourExtractorImageFilter -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| FullyConnected | bool | Whether the connected components are defined strictly by face connectivity (False) or by face+edge+vertex connectivity (True). Default is False | -| BackgroundValue | float64 | Set/Get the background value used to mark the pixels not on the border of the objects. | -| ForegroundValue | float64 | Set/Get the foreground value used to identify the objects in the input and output images. | - -## Required Geometry - -Image Geometry - -## Required Objects - -| Name |Type | Description | -|-----|------|-------------| -| Input Image Geometry | DataPath | DataPath to the Input Image Geometry | -| Input Image Data Array | DataPath | Path to input image with pixel type matching IntegerPixelIDTypeList | - -## Created Objects - -| Name |Type | Description | -|-----|------|-------------| -| Output Image Data Array | DataPath | Path to output image with pixel type matching IntegerPixelIDTypeList | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -53,6 +30,6 @@ 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. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKBinaryDilateImage.md b/src/Plugins/ITKImageProcessing/docs/ITKBinaryDilateImage.md index ea693ca5e6..259db05507 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKBinaryDilateImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKBinaryDilateImage.md @@ -23,32 +23,7 @@ N.Nikopoulos et al. "An efficient algorithm for 3d binary morphological transformations with 3d structuring elements for arbitrary size and shape". IEEE Transactions on Image Processing. Vol. 9. No. 3. 2000. pp. 283-286.* ImageToImageFilter BinaryErodeImageFilter BinaryMorphologyImageFilter -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| KernelRadius | uint32 | Set the radius of the kernel structuring element. | -| KernelType | KernelEnum | Set the kernel or structuring element used for the morphology. | -| BackgroundValue | float64 | The eroded pixels will receive the BackgroundValue. Default = non positive minimum | -| ForegroundValue | float64 | The pixel value considered 'Foreground' that will be eroded | -| BoundaryToForeground | bool | Mark the boundary between foreground and background. | - -## Required Geometry - -Image Geometry - -## Required Objects - -| Name |Type | Description | -|-----|------|-------------| -| Input Image Geometry | DataPath | DataPath to the Input Image Geometry | -| Input Image Data Array | DataPath | Path to input image with pixel type matching IntegerPixelIDTypeList | - -## Created Objects - -| Name |Type | Description | -|-----|------|-------------| -| Output Image Data Array | DataPath | Path to output image with pixel type matching IntegerPixelIDTypeList | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -56,6 +31,6 @@ 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. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKBinaryErodeImage.md b/src/Plugins/ITKImageProcessing/docs/ITKBinaryErodeImage.md index 483bfae44f..4127f3651f 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKBinaryErodeImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKBinaryErodeImage.md @@ -23,32 +23,7 @@ N.Nikopoulos et al. "An efficient algorithm for 3d binary morphological transformations with 3d structuring elements for arbitrary size and shape". IEEE Transactions on Image Processing. Vol. 9. No. 3. 2000. pp. 283-286.* ImageToImageFilter BinaryDilateImageFilter BinaryMorphologyImageFilter -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| KernelRadius | uint32 | Set the radius of the kernel structuring element. | -| KernelType | KernelEnum | Set the kernel or structuring element used for the morphology. | -| BackgroundValue | float64 | The eroded pixels will receive the BackgroundValue. Default = non positive minimum | -| ForegroundValue | float64 | The pixel value considered 'Foreground' that will be eroded | -| BoundaryToForeground | bool | Mark the boundary between foreground and background. | - -## Required Geometry - -Image Geometry - -## Required Objects - -| Name |Type | Description | -|-----|------|-------------| -| Input Image Geometry | DataPath | DataPath to the Input Image Geometry | -| Input Image Data Array | DataPath | Path to input image with pixel type matching IntegerPixelIDTypeList | - -## Created Objects - -| Name |Type | Description | -|-----|------|-------------| -| Output Image Data Array | DataPath | Path to output image with pixel type matching IntegerPixelIDTypeList | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -56,6 +31,6 @@ 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. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKBinaryMorphologicalClosingImage.md b/src/Plugins/ITKImageProcessing/docs/ITKBinaryMorphologicalClosingImage.md index 6db7b40008..0356fe415e 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKBinaryMorphologicalClosingImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKBinaryMorphologicalClosingImage.md @@ -22,31 +22,7 @@ This code was contributed in the Insight Journal paper: "Binary morphological cl - MorphologyImageFilter , GrayscaleDilateImageFilter , GrayscaleErodeImageFilter -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| KernelRadius | uint32 | Set the radius of the kernel structuring element. | -| KernelType | KernelEnum | Set the kernel or structuring element used for the morphology. | -| ForegroundValue | float64 | Set the value in the image to consider as "foreground". Defaults to maximum value of InputPixelType. | -| SafeBorder | bool | A safe border is added to input image to avoid borders effects and remove it once the closing is done | - -## Required Geometry - -Image Geometry - -## Required Objects - -| Name |Type | Description | -|-----|------|-------------| -| Input Image Geometry | DataPath | DataPath to the Input Image Geometry | -| Input Image Data Array | DataPath | Path to input image with pixel type matching IntegerPixelIDTypeList | - -## Created Objects - -| Name |Type | Description | -|-----|------|-------------| -| Output Image Data Array | DataPath | Path to output image with pixel type matching IntegerPixelIDTypeList | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -54,6 +30,6 @@ 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. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKBinaryMorphologicalOpeningImage.md b/src/Plugins/ITKImageProcessing/docs/ITKBinaryMorphologicalOpeningImage.md index f45c162fdd..5b2db56e80 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKBinaryMorphologicalOpeningImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKBinaryMorphologicalOpeningImage.md @@ -22,31 +22,7 @@ This code was contributed in the Insight Journal paper: "Binary morphological cl - MorphologyImageFilter , GrayscaleDilateImageFilter , GrayscaleErodeImageFilter -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| KernelRadius | uint32 | Set the radius of the kernel structuring element. | -| KernelType | KernelEnum | Set the kernel or structuring element used for the morphology. | -| BackgroundValue | float64 | Set the value in eroded part of the image. Defaults to zero | -| ForegroundValue | float64 | Set the value in the image to consider as "foreground". Defaults to maximum value of PixelType. | - -## Required Geometry - -Image Geometry - -## Required Objects - -| Name |Type | Description | -|-----|------|-------------| -| Input Image Geometry | DataPath | DataPath to the Input Image Geometry | -| Input Image Data Array | DataPath | Path to input image with pixel type matching IntegerPixelIDTypeList | - -## Created Objects - -| Name |Type | Description | -|-----|------|-------------| -| Output Image Data Array | DataPath | Path to output image with pixel type matching IntegerPixelIDTypeList | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -54,6 +30,6 @@ 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. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKBinaryOpeningByReconstructionImage.md b/src/Plugins/ITKImageProcessing/docs/ITKBinaryOpeningByReconstructionImage.md index c2db52244c..975227c828 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKBinaryOpeningByReconstructionImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKBinaryOpeningByReconstructionImage.md @@ -20,32 +20,7 @@ The structuring element is assumed to be composed of binary values (zero or one) This implementation was taken from the Insight Journal paper: * MorphologyImageFilter , OpeningByReconstructionImageFilter , BinaryClosingByReconstructionImageFilter -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| KernelRadius | uint32 | Set the radius of the kernel structuring element. | -| KernelType | KernelEnum | Set the kernel or structuring element used for the morphology. | -| ForegroundValue | float64 | Set the value in the image to consider as "foreground". Defaults to maximum value of PixelType. | -| BackgroundValue | float64 | Set the value in eroded part of the image. Defaults to zero | -| FullyConnected | bool | Whether the connected components are defined strictly by face connectivity (False) or by face+edge+vertex connectivity (True). Default is False | - -## Required Geometry - -Image Geometry - -## Required Objects - -| Name |Type | Description | -|-----|------|-------------| -| Input Image Geometry | DataPath | DataPath to the Input Image Geometry | -| Input Image Data Array | DataPath | Path to input image with pixel type matching IntegerPixelIDTypeList | - -## Created Objects - -| Name |Type | Description | -|-----|------|-------------| -| Output Image Data Array | DataPath | Path to output image with pixel type matching IntegerPixelIDTypeList | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -53,6 +28,6 @@ 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. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKBinaryProjectionImage.md b/src/Plugins/ITKImageProcessing/docs/ITKBinaryProjectionImage.md index 7871751521..2209a5e34d 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKBinaryProjectionImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKBinaryProjectionImage.md @@ -28,30 +28,7 @@ This class was contributed to the Insight Journal by Gaetan Lehmann. The origina - StandardDeviationProjectionImageFilter - SumProjectionImageFilter -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| ProjectionDimension | uint32 | The index of the projection dimension | -| ForegroundValue | float64 | Set the value in the image to consider as "foreground". Defaults to maximum value of PixelType. Subclasses may alias this to DilateValue or ErodeValue. | -| BackgroundValue | float64 | Set the value used as "background". Any pixel value which is not DilateValue is considered background. BackgroundValue is used for defining boundary conditions. Defaults to NumericTraits::NonpositiveMin() . | - -## Required Geometry - -Image Geometry - -## Required Objects - -| Name |Type | Description | -|-----|------|-------------| -| Input Image Geometry | DataPath | DataPath to the Input Image Geometry | -| Input Image Data Array | DataPath | Path to input image with pixel type matching BasicPixelIDTypeList | - -## Created Objects - -| Name |Type | Description | -|-----|------|-------------| -| Output Image Data Array | DataPath | Path to output image with pixel type matching BasicPixelIDTypeList | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -59,6 +36,6 @@ 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. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKBinaryThinningImage.md b/src/Plugins/ITKImageProcessing/docs/ITKBinaryThinningImage.md index 797eb27bad..8f784b3d4c 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKBinaryThinningImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKBinaryThinningImage.md @@ -20,27 +20,7 @@ Rafael C. Gonzales and Richard E. Woods. Digital Image Processing. Addison Wesle To do: Make this filter ND.* MorphologyImageFilter -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | - -## Required Geometry - -Image Geometry - -## Required Objects - -| Name |Type | Description | -|-----|------|-------------| -| Input Image Geometry | DataPath | DataPath to the Input Image Geometry | -| Input Image Data Array | DataPath | Path to input image with pixel type matching IntegerPixelIDTypeList | - -## Created Objects - -| Name |Type | Description | -|-----|------|-------------| -| Output Image Data Array | DataPath | Path to output image with pixel type matching IntegerPixelIDTypeList | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -48,6 +28,6 @@ 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. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKBinaryThresholdImage.md b/src/Plugins/ITKImageProcessing/docs/ITKBinaryThresholdImage.md index 865a4c7fe7..3bcca950d2 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKBinaryThresholdImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKBinaryThresholdImage.md @@ -20,31 +20,7 @@ The default values for LowerThreshold and UpperThreshold are: LowerThreshold = N Set the thresholds. The default lower threshold is NumericTraits::NonpositiveMin() . The default upper threshold is NumericTraits::max . An exception is thrown if the lower threshold is greater than the upper threshold. -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| LowerThreshold | float64 | The lower threshold that a pixel value could be and still be considered 'Inside Value' | -| UpperThreshold | float64 | The upper threshold that a pixel value could be and still be considered 'Inside Value'| -| InsideValue | uint8 | Set the "inside" pixel value. The default value NumericTraits::max() | -| OutsideValue | uint8 | Set the "outside" pixel value. The default value NumericTraits::ZeroValue() . | - -## Required Geometry - -Image Geometry - -## Required Objects - -| Name |Type | Description | -|-----|------|-------------| -| Input Image Geometry | DataPath | DataPath to the Input Image Geometry | -| Input Image Data Array | DataPath | Path to input image with pixel type matching BasicPixelIDTypeList | - -## Created Objects - -| Name |Type | Description | -|-----|------|-------------| -| Output Image Data Array | DataPath | Path to output image with pixel type matching BasicPixelIDTypeList | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -52,6 +28,6 @@ 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. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKBlackTopHatImage.md b/src/Plugins/ITKImageProcessing/docs/ITKBlackTopHatImage.md index f02f4144a2..161cfabcac 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKBlackTopHatImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKBlackTopHatImage.md @@ -18,30 +18,7 @@ Top-hats are described in Chapter 4.5 of Pierre Soille's book "Morphological Ima ### Related Filters -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| KernelRadius | uint32 | Set the radius of the kernel structuring element. | -| KernelType | KernelEnum | Set the kernel or structuring element used for the morphology. | -| SafeBorder | bool | A safe border is added to input image to avoid borders effects and remove it once the closing is done | - -## Required Geometry - -Image Geometry - -## Required Objects - -| Name |Type | Description | -|-----|------|-------------| -| Input Image Geometry | DataPath | DataPath to the Input Image Geometry | -| Input Image Data Array | DataPath | Path to input image with pixel type matching BasicPixelIDTypeList | - -## Created Objects - -| Name |Type | Description | -|-----|------|-------------| -| Output Image Data Array | DataPath | Path to output image with pixel type matching BasicPixelIDTypeList | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -49,6 +26,6 @@ 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. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKClosingByReconstructionImage.md b/src/Plugins/ITKImageProcessing/docs/ITKClosingByReconstructionImage.md index 0dde8b76f7..faea43eadc 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKClosingByReconstructionImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKClosingByReconstructionImage.md @@ -25,31 +25,7 @@ Applications", Second Edition, Springer, 2003. - GrayscaleMorphologicalClosingImageFilter -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| KernelRadius | uint32 | Set the radius of the kernel structuring element. | -| KernelType | KernelEnum | Set the kernel or structuring element used for the morphology. | -| FullyConnected | bool | Whether the connected components are defined strictly by face connectivity (False) or by face+edge+vertex connectivity (True). Default is False | -| PreserveIntensities | bool | Set/Get whether the original intensities of the image retained for those pixels unaffected by the opening by reconstruction. If Off, the output pixel contrast will be reduced. | - -## Required Geometry - -Image Geometry - -## Required Objects - -| Name |Type | Description | -|-----|------|-------------| -| Input Image Geometry | DataPath | DataPath to the Input Image Geometry | -| Input Image Data Array | DataPath | Path to input image with pixel type matching BasicPixelIDTypeList | - -## Created Objects - -| Name |Type | Description | -|-----|------|-------------| -| Output Image Data Array | DataPath | Path to output image with pixel type matching BasicPixelIDTypeList | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -57,6 +33,6 @@ 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. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKCosImage.md b/src/Plugins/ITKImageProcessing/docs/ITKCosImage.md index b2cfd351f9..46bfb9b097 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKCosImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKCosImage.md @@ -19,27 +19,7 @@ The filter walks over all of the pixels in the input image, and for each pixel d The filter expects both images to have the same dimension (e.g. both 2D, or both 3D, or both ND) -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | - -## Required Geometry - -Image Geometry - -## Required Objects - -| Name |Type | Description | -|-----|------|-------------| -| Input Image Geometry | DataPath | DataPath to the Input Image Geometry | -| Input Image Data Array | DataPath | Path to input image with pixel type matching BasicPixelIDTypeList | - -## Created Objects - -| Name |Type | Description | -|-----|------|-------------| -| Output Image Data Array | DataPath | Path to output image with pixel type matching BasicPixelIDTypeList | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -47,6 +27,6 @@ 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. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKDilateObjectMorphologyImage.md b/src/Plugins/ITKImageProcessing/docs/ITKDilateObjectMorphologyImage.md index 060883d9b9..5d48e71f5d 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKDilateObjectMorphologyImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKDilateObjectMorphologyImage.md @@ -14,30 +14,7 @@ If a pixel's value is equal to the object value and the pixel is adjacent to a n - BinaryDilateImageFilter -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| KernelRadius | uint32 | Set the radius of the kernel structuring element. | -| KernelType | KernelEnum | Set the kernel or structuring element used for the morphology. | -| ObjectValue | float64 | The pixel value of the 'Object' to be dilated | - -## Required Geometry - -Image Geometry - -## Required Objects - -| Name |Type | Description | -|-----|------|-------------| -| Input Image Geometry | DataPath | DataPath to the Input Image Geometry | -| Input Image Data Array | DataPath | Path to input image with pixel type matching BasicPixelIDTypeList | - -## Created Objects - -| Name |Type | Description | -|-----|------|-------------| -| Output Image Data Array | DataPath | Path to output image with pixel type matching BasicPixelIDTypeList | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -45,6 +22,6 @@ 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. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKDiscreteGaussianImage.md b/src/Plugins/ITKImageProcessing/docs/ITKDiscreteGaussianImage.md index 0eb9adda8a..3672ba877e 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKDiscreteGaussianImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKDiscreteGaussianImage.md @@ -19,31 +19,7 @@ When the Gaussian kernel is small, this filter tends to run faster than itk::Rec - NeighborhoodOperator - RecursiveGaussianImageFilter -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Variance | float64 | | -| MaximumKernelWidth | uint32 | Set the kernel to be no wider than MaximumKernelWidth pixels, even if MaximumError demands it. The default is 32 pixels. | -| MaximumError | float64 | | -| UseImageSpacing | bool | Set/Get whether or not the filter will use the spacing of the input image in its calculations. Use On to take the image spacing information into account and to specify the Gaussian variance in real world units; use Off to ignore the image spacing and to specify the Gaussian variance in voxel units. Default is On. | - -## Required Geometry - -Image Geometry - -## Required Objects - -| Name |Type | Description | -|-----|------|-------------| -| Input Image Geometry | DataPath | DataPath to the Input Image Geometry | -| Input Image Data Array | DataPath | Path to input image with pixel type matching BasicPixelIDTypeList | - -## Created Objects - -| Name |Type | Description | -|-----|------|-------------| -| Output Image Data Array | DataPath | Path to output image with pixel type matching BasicPixelIDTypeList | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -51,6 +27,6 @@ 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. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKErodeObjectMorphologyImage.md b/src/Plugins/ITKImageProcessing/docs/ITKErodeObjectMorphologyImage.md index 44e243f1e4..9c784a131f 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKErodeObjectMorphologyImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKErodeObjectMorphologyImage.md @@ -14,31 +14,7 @@ If the pixel covered by the center of the kernel has the pixel value ObjectValue - BinaryErodeImageFilter -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| KernelRadius | uint32 | Set the radius of the kernel structuring element. | -| KernelType | KernelEnum | Set the kernel or structuring element used for the morphology. | -| ObjectValue | float64 | The pixel value of the 'Object' to be eroded | -| BackgroundValue | float64 | Set the value to be assigned to eroded pixels | - -## Required Geometry - -Image Geometry - -## Required Objects - -| Name |Type | Description | -|-----|------|-------------| -| Input Image Geometry | DataPath | DataPath to the Input Image Geometry | -| Input Image Data Array | DataPath | Path to input image with pixel type matching BasicPixelIDTypeList | - -## Created Objects - -| Name |Type | Description | -|-----|------|-------------| -| Output Image Data Array | DataPath | Path to output image with pixel type matching BasicPixelIDTypeList | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -46,6 +22,6 @@ 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. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKExpImage.md b/src/Plugins/ITKImageProcessing/docs/ITKExpImage.md index dbaad75460..38963c2a43 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKExpImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKExpImage.md @@ -10,27 +10,7 @@ ITKImageIntensity (ImageIntensity) The computation is performed using std::exp(x). -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | - -## Required Geometry - -Image Geometry - -## Required Objects - -| Name |Type | Description | -|-----|------|-------------| -| Input Image Geometry | DataPath | DataPath to the Input Image Geometry | -| Input Image Data Array | DataPath | Path to input image with pixel type matching BasicPixelIDTypeList | - -## Created Objects - -| Name |Type | Description | -|-----|------|-------------| -| Output Image Data Array | DataPath | Path to output image with pixel type matching BasicPixelIDTypeList | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -38,6 +18,6 @@ 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. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKExpNegativeImage.md b/src/Plugins/ITKImageProcessing/docs/ITKExpNegativeImage.md index 9d494c77a8..db7a8e1da9 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKExpNegativeImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKExpNegativeImage.md @@ -10,27 +10,7 @@ ITKImageIntensity (ImageIntensity) Every output pixel is equal to std::exp(-K.x ). where x is the intensity of the homologous input pixel, and K is a user-provided constant. -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | - -## Required Geometry - -Image Geometry - -## Required Objects - -| Name |Type | Description | -|-----|------|-------------| -| Input Image Geometry | DataPath | DataPath to the Input Image Geometry | -| Input Image Data Array | DataPath | Path to input image with pixel type matching BasicPixelIDTypeList | - -## Created Objects - -| Name |Type | Description | -|-----|------|-------------| -| Output Image Data Array | DataPath | Path to output image with pixel type matching BasicPixelIDTypeList | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -38,6 +18,6 @@ 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. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKGradientMagnitudeImage.md b/src/Plugins/ITKImageProcessing/docs/ITKGradientMagnitudeImage.md index 9313d762d5..39a0a25c2e 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKGradientMagnitudeImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKGradientMagnitudeImage.md @@ -17,28 +17,7 @@ Computes the gradient magnitude of an image region at each pixel. - NeighborhoodOperator - NeighborhoodIterator -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| UseImageSpacing | bool | Set/Get whether or not the filter will use the spacing of the input image in the computation of the derivatives. Use On to compute the gradient in physical space; use Off to ignore image spacing and to compute the gradient in isotropic voxel space. Default is On. | - -## Required Geometry - -Image Geometry - -## Required Objects - -| Name |Type | Description | -|-----|------|-------------| -| Input Image Geometry | DataPath | DataPath to the Input Image Geometry | -| Input Image Data Array | DataPath | Path to input image with pixel type matching BasicPixelIDTypeList | - -## Created Objects - -| Name |Type | Description | -|-----|------|-------------| -| Output Image Data Array | DataPath | Path to output image with pixel type matching BasicPixelIDTypeList | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -46,6 +25,6 @@ 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. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleDilateImage.md b/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleDilateImage.md index c54dfbe64a..e46a6c0a20 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleDilateImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleDilateImage.md @@ -12,29 +12,7 @@ Dilate an image using grayscale morphology. Dilation takes the maximum of all th The structuring element is assumed to be composed of binary values (zero or one). Only elements of the structuring element having values > 0 are candidates for affecting the center pixel.* MorphologyImageFilter , GrayscaleFunctionDilateImageFilter , BinaryDilateImageFilter -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| KernelRadius | uint32 | Set the radius of the kernel structuring element. | -| KernelType | KernelEnum | Set the kernel or structuring element used for the morphology. | - -## Required Geometry - -Image Geometry - -## Required Objects - -| Name |Type | Description | -|-----|------|-------------| -| Input Image Geometry | DataPath | DataPath to the Input Image Geometry | -| Input Image Data Array | DataPath | Path to input image with pixel type matching BasicPixelIDTypeList | - -## Created Objects - -| Name |Type | Description | -|-----|------|-------------| -| Output Image Data Array | DataPath | Path to output image with pixel type matching BasicPixelIDTypeList | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -42,6 +20,6 @@ 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. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleErodeImage.md b/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleErodeImage.md index 89d6a58c0c..749267516b 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleErodeImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleErodeImage.md @@ -12,29 +12,7 @@ Erode an image using grayscale morphology. Erosion takes the maximum of all the The structuring element is assumed to be composed of binary values (zero or one). Only elements of the structuring element having values > 0 are candidates for affecting the center pixel.* MorphologyImageFilter , GrayscaleFunctionErodeImageFilter , BinaryErodeImageFilter -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| KernelRadius | uint32 | Set the radius of the kernel structuring element. | -| KernelType | KernelEnum | Set the kernel or structuring element used for the morphology. | - -## Required Geometry - -Image Geometry - -## Required Objects - -| Name |Type | Description | -|-----|------|-------------| -| Input Image Geometry | DataPath | DataPath to the Input Image Geometry | -| Input Image Data Array | DataPath | Path to input image with pixel type matching BasicPixelIDTypeList | - -## Created Objects - -| Name |Type | Description | -|-----|------|-------------| -| Output Image Data Array | DataPath | Path to output image with pixel type matching BasicPixelIDTypeList | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -42,6 +20,6 @@ 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. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleFillholeImage.md b/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleFillholeImage.md index 2a006f98a0..750eaf26cd 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleFillholeImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleFillholeImage.md @@ -19,28 +19,7 @@ Principles and Applications", Second Edition, Springer, 2003.* ReconstructionByE - MorphologyImageFilter , GrayscaleErodeImageFilter , GrayscaleFunctionErodeImageFilter , BinaryErodeImageFilter -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| FullyConnected | bool | Whether the connected components are defined strictly by face connectivity (False) or by face+edge+vertex connectivity (True). Default is False | - -## Required Geometry - -Image Geometry - -## Required Objects - -| Name |Type | Description | -|-----|------|-------------| -| Input Image Geometry | DataPath | DataPath to the Input Image Geometry | -| Input Image Data Array | DataPath | Path to input image with pixel type matching BasicPixelIDTypeList | - -## Created Objects - -| Name |Type | Description | -|-----|------|-------------| -| Output Image Data Array | DataPath | Path to output image with pixel type matching BasicPixelIDTypeList | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -48,6 +27,6 @@ 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. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleGrindPeakImage.md b/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleGrindPeakImage.md index cd71131e52..83c26fcf3c 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleGrindPeakImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleGrindPeakImage.md @@ -21,28 +21,7 @@ Principles and Applications", Second Edition, Springer, 2003.* GrayscaleGeodesic - MorphologyImageFilter , GrayscaleDilateImageFilter , GrayscaleFunctionDilateImageFilter , BinaryDilateImageFilter -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| FullyConnected | bool | Whether the connected components are defined strictly by face connectivity (False) or by face+edge+vertex connectivity (True). Default is False | - -## Required Geometry - -Image Geometry - -## Required Objects - -| Name |Type | Description | -|-----|------|-------------| -| Input Image Geometry | DataPath | DataPath to the Input Image Geometry | -| Input Image Data Array | DataPath | Path to input image with pixel type matching BasicPixelIDTypeList | - -## Created Objects - -| Name |Type | Description | -|-----|------|-------------| -| Output Image Data Array | DataPath | Path to output image with pixel type matching BasicPixelIDTypeList | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -50,6 +29,6 @@ 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. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleMorphologicalClosingImage.md b/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleMorphologicalClosingImage.md index 2d453e9ced..7417889967 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleMorphologicalClosingImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleMorphologicalClosingImage.md @@ -12,30 +12,7 @@ Close an image using grayscale morphology. The structuring element is assumed to be composed of binary values (zero or one). Only elements of the structuring element having values > 0 are candidates for affecting the center pixel.* MorphologyImageFilter , GrayscaleFunctionErodeImageFilter , BinaryErodeImageFilter -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| KernelRadius | uint32 | Set the radius of the kernel structuring element. | -| KernelType | KernelEnum | Set the kernel or structuring element used for the morphology. | -| SafeBorder | bool | A safe border is added to input image to avoid borders effects and remove it once the closing is done | - -## Required Geometry - -Image Geometry - -## Required Objects - -| Name |Type | Description | -|-----|------|-------------| -| Input Image Geometry | DataPath | DataPath to the Input Image Geometry | -| Input Image Data Array | DataPath | Path to input image with pixel type matching BasicPixelIDTypeList | - -## Created Objects - -| Name |Type | Description | -|-----|------|-------------| -| Output Image Data Array | DataPath | Path to output image with pixel type matching BasicPixelIDTypeList | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -43,6 +20,6 @@ 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. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleMorphologicalOpeningImage.md b/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleMorphologicalOpeningImage.md index 29bc6f8b5b..37a540b806 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleMorphologicalOpeningImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleMorphologicalOpeningImage.md @@ -12,30 +12,7 @@ Open an image using grayscale morphology. The structuring element is assumed to be composed of binary values (zero or one). Only elements of the structuring element having values > 0 are candidates for affecting the center pixel.* MorphologyImageFilter , GrayscaleFunctionDilateImageFilter , BinaryDilateImageFilter -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| KernelRadius | uint32 | Set the radius of the kernel structuring element. | -| KernelType | KernelEnum | Set the kernel or structuring element used for the morphology. | -| SafeBorder | bool | A safe border is added to input image to avoid borders effects and remove it once the closing is done | - -## Required Geometry - -Image Geometry - -## Required Objects - -| Name |Type | Description | -|-----|------|-------------| -| Input Image Geometry | DataPath | DataPath to the Input Image Geometry | -| Input Image Data Array | DataPath | Path to input image with pixel type matching BasicPixelIDTypeList | - -## Created Objects - -| Name |Type | Description | -|-----|------|-------------| -| Output Image Data Array | DataPath | Path to output image with pixel type matching BasicPixelIDTypeList | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -43,6 +20,6 @@ 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. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKHConvexImage.md b/src/Plugins/ITKImageProcessing/docs/ITKHConvexImage.md index e1587d51ba..625ac22323 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKHConvexImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKHConvexImage.md @@ -17,29 +17,7 @@ Principles and Applications", Second Edition, Springer, 2003.* GrayscaleGeodesic - MorphologyImageFilter , GrayscaleDilateImageFilter , GrayscaleFunctionDilateImageFilter , BinaryDilateImageFilter -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Height | float64 | Set/Get the height that a local maximum must be above the local background (local contrast) in order to survive the processing. Local maxima below this value are replaced with an estimate of the local background. | -| FullyConnected | bool | Whether the connected components are defined strictly by face connectivity (False) or by face+edge+vertex connectivity (True). Default is False | - -## Required Geometry - -Image Geometry - -## Required Objects - -| Name |Type | Description | -|-----|------|-------------| -| Input Image Geometry | DataPath | DataPath to the Input Image Geometry | -| Input Image Data Array | DataPath | Path to input image with pixel type matching BasicPixelIDTypeList | - -## Created Objects - -| Name |Type | Description | -|-----|------|-------------| -| Output Image Data Array | DataPath | Path to output image with pixel type matching BasicPixelIDTypeList | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -47,6 +25,6 @@ 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. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKHMaximaImage.md b/src/Plugins/ITKImageProcessing/docs/ITKHMaximaImage.md index 109daa5293..0362322d49 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKHMaximaImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKHMaximaImage.md @@ -21,28 +21,7 @@ The height parameter is set using SetHeight.* ReconstructionByDilationImageFilte - MorphologyImageFilter , GrayscaleDilateImageFilter , GrayscaleFunctionDilateImageFilter , BinaryDilateImageFilter -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Height | float64 | Set/Get the height that a local maximum must be above the local background (local contrast) in order to survive the processing. Local maxima below this value are replaced with an estimate of the local background. | - -## Required Geometry - -Image Geometry - -## Required Objects - -| Name |Type | Description | -|-----|------|-------------| -| Input Image Geometry | DataPath | DataPath to the Input Image Geometry | -| Input Image Data Array | DataPath | Path to input image with pixel type matching BasicPixelIDTypeList | - -## Created Objects - -| Name |Type | Description | -|-----|------|-------------| -| Output Image Data Array | DataPath | Path to output image with pixel type matching BasicPixelIDTypeList | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -50,6 +29,6 @@ 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. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKHMinimaImage.md b/src/Plugins/ITKImageProcessing/docs/ITKHMinimaImage.md index 2777929f2f..2424b9a4db 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKHMinimaImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKHMinimaImage.md @@ -19,29 +19,7 @@ Principles and Applications", Second Edition, Springer, 2003.* GrayscaleGeodesic - MorphologyImageFilter , GrayscaleDilateImageFilter , GrayscaleFunctionDilateImageFilter , BinaryDilateImageFilter -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Height | float64 | Set/Get the height that a local maximum must be above the local background (local contrast) in order to survive the processing. Local maxima below this value are replaced with an estimate of the local background. | -| FullyConnected | bool | Whether the connected components are defined strictly by face connectivity (False) or by face+edge+vertex connectivity (True). Default is False | - -## Required Geometry - -Image Geometry - -## Required Objects - -| Name |Type | Description | -|-----|------|-------------| -| Input Image Geometry | DataPath | DataPath to the Input Image Geometry | -| Input Image Data Array | DataPath | Path to input image with pixel type matching BasicPixelIDTypeList | - -## Created Objects - -| Name |Type | Description | -|-----|------|-------------| -| Output Image Data Array | DataPath | Path to output image with pixel type matching BasicPixelIDTypeList | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -49,6 +27,6 @@ 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. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKImageReader.md b/src/Plugins/ITKImageProcessing/docs/ITKImageReader.md index 580301cc27..c73e0baa26 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKImageReader.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKImageReader.md @@ -10,19 +10,7 @@ ITKImageProcessing (ITKImageProcessing) Reads images through ITK -## Parameters - -| Name | Type | -|------------------|------| -| Input File | String | Path to the input file to read. | - -## Required Objects - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Data Container | Data Container Name | N/A | N/A | Description of object... | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -32,6 +20,6 @@ Reads images through ITK 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. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKImageWriter.md b/src/Plugins/ITKImageProcessing/docs/ITKImageWriter.md index e0baf00b11..d988d050a6 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKImageWriter.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKImageWriter.md @@ -11,27 +11,7 @@ This **Filter** will save images based on an array that represents grayscale, RG An example of a **Filter** that produces color data that can be used as input to this **Filter** is the {ref}`Generate IFP Colors ` **Filter**, which will generate RGB values for each voxel in the volume. -## Parameters - -| Name | Type | Description | -|------------------|------| --------------| -| Output File | String | Path to the output file to write. | -| Plane | Enumeration | Selection for plane normal for writing the images (XY, XZ, or YZ) | -| Index Offeset | Integer | Default=0, This is the starting index when writing mulitple images | - -## Required Geometry - -Image - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Cell Attribute Array | None| uint8_t | (n) | Selected color data for output image. The data should represent grayscale, RGB or ARGB color values. The dimensionality of the array depends on the kind of image read: (1) for grayscale, (3) for RGB, and (4) for ARGB | - -## Created Objects - -None +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -44,6 +24,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. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKImportFijiMontageFilter.md b/src/Plugins/ITKImageProcessing/docs/ITKImportFijiMontageFilter.md index e4a1b8f852..c63f4e43f9 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKImportFijiMontageFilter.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKImportFijiMontageFilter.md @@ -23,21 +23,6 @@ Utilizes the *itkReadImage* and *ColorToGrayScale* filters SampleMosaic_p4.bmp; ; (0.23675, 1839.55) SampleMosaic_p5.bmp; ; (1227.31, 1839.55) -## Parameters - -| Name | Type | Comment | -|------------------|------|---------| -| Input Fiji Tile Configuration File | String | The configuration file in the same directory as all of the identified geometries | -| Name of Created DataGroup | String | Name of the overarching parent DataGroup | -| Length Unit | Int | Selected from predefined list. See table below | -| Parent DataGroup | Bool = ON | Parent all imported geometries under a DataGroup | -| Change Origin | Bool = OFF | Set the origin of the mosaic to a user defined value | -| Origin | Float 3 Vect | The new origin of the mosaic | -| Convert to GrayScale | Bool | The filter will show an error if the images are already in grayscale format | -| Color Weighting | Float 3 Vect | The luminosity values for the conversion | -| Data Container Prefix | String | A prefix that can be used for each data container. | -| Cell Attribute Matrix Name | String | The name of the Cell Attribute Matrix. | -| Image Data Array Name | String | The name of the import image data | ### Color To Gray Scale Notes @@ -79,24 +64,7 @@ The user can set the weightings to what ever values they would like. Unspecified = 100U Unknown = 101U -## Required DataContainers - -NONE - -## Required Objects - -NONE - -## Created Objects - -This filter will create one data container for each image tile that is in the xml file. That created Data Container will have a Cell Attribute Matrix which will also hold a single Attribute Array of the same type of the image (unless the user selects to convert images to Gray Scale images.) - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| DataGroup | Zen DataGroup | N/A | N/A | Parent DataGroup created in the datastructure | -| Image Geometry | Mosaic- | N/A | N/A | The prefix for all created Image Geometries | -| AttributeMatrix | Tile Data | N/A | N/A | The name of every created Attribute Matrix | -| DataArray | Image | N/A | N/A | The name of the created DataArray in each Image Geometry | +% Auto generated parameter table will be inserted here ## Example Pipelines diff --git a/src/Plugins/ITKImageProcessing/docs/ITKImportImageStack.md b/src/Plugins/ITKImageProcessing/docs/ITKImportImageStack.md index 51bb2b7919..a91ad4ed87 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKImportImageStack.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKImportImageStack.md @@ -13,24 +13,7 @@ scalar pixel types and the many file formats supported by ITK. Images are read in as an **Image Geomotry**. The user must specify the origin in physical space and resolution (uniform physical size of the resulting **Cells**). -## Parameters - -- Input Directory -- File Ordering (Ascending or Descending) -- Origin -- Resolution - -## Required Objects - -None - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Data Container | ImageDataContainer | N/A | N/A | Created **Data Container** name **Image Geometry | -| Attribute Matrix | CellData | Cell | N/A | Created **Cell Attribute Matrix** name | -| Cell Attribute Array | ImageData | Varies based on input | (n) | | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -41,6 +24,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. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKIntensityWindowingImage.md b/src/Plugins/ITKImageProcessing/docs/ITKIntensityWindowingImage.md index 2a3c88d98a..1bfc9d2a9a 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKIntensityWindowingImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKIntensityWindowingImage.md @@ -12,31 +12,7 @@ IntensityWindowingImageFilter applies pixel-wise a linear transformation to the All computations are performed in the precision of the input pixel's RealType. Before assigning the computed value to the output pixel.* RescaleIntensityImageFilter -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| WindowMinimum | float64 | Set/Get the values of the maximum and minimum intensities of the input intensity window. | -| WindowMaximum | float64 | Set/Get the values of the maximum and minimum intensities of the input intensity window. | -| OutputMinimum | float64 | Set/Get the values of the maximum and minimum intensities of the output image. | -| OutputMaximum | float64 | Set/Get the values of the maximum and minimum intensities of the output image. | - -## Required Geometry - -Image Geometry - -## Required Objects - -| Name |Type | Description | -|-----|------|-------------| -| Input Image Geometry | DataPath | DataPath to the Input Image Geometry | -| Input Image Data Array | DataPath | Path to input image with pixel type matching BasicPixelIDTypeList | - -## Created Objects - -| Name |Type | Description | -|-----|------|-------------| -| Output Image Data Array | DataPath | Path to output image with pixel type matching BasicPixelIDTypeList | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -44,6 +20,6 @@ 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. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKInvertIntensityImage.md b/src/Plugins/ITKImageProcessing/docs/ITKInvertIntensityImage.md index b5a4e71bcb..aeca74fd26 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKInvertIntensityImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKInvertIntensityImage.md @@ -18,28 +18,7 @@ InvertIntensityImageFilter inverts intensity of pixels by subtracting pixel valu - IntensityWindowingImageFilter ShiftScaleImageFilter -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Maximum | float64 | Set/Get the maximum intensity value for the inversion. | - -## Required Geometry - -Image Geometry - -## Required Objects - -| Name |Type | Description | -|-----|------|-------------| -| Input Image Geometry | DataPath | DataPath to the Input Image Geometry | -| Input Image Data Array | DataPath | Path to input image with pixel type matching BasicPixelIDTypeList | - -## Created Objects - -| Name |Type | Description | -|-----|------|-------------| -| Output Image Data Array | DataPath | Path to output image with pixel type matching BasicPixelIDTypeList | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -47,6 +26,6 @@ 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. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKLabelContourImage.md b/src/Plugins/ITKImageProcessing/docs/ITKLabelContourImage.md index 20b50e1b99..2beed3ce0d 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKLabelContourImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKLabelContourImage.md @@ -22,29 +22,7 @@ The connectivity can be changed to minimum or maximum connectivity with SetFully - BinaryContourImageFilter -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| FullyConnected | bool | Whether the connected components are defined strictly by face connectivity (False) or by face+edge+vertex connectivity (True). Default is False | -| BackgroundValue | float64 | Set/Get the background value used to identify the objects and mark the pixels not on the border of the objects. | - -## Required Geometry - -Image Geometry - -## Required Objects - -| Name |Type | Description | -|-----|------|-------------| -| Input Image Geometry | DataPath | DataPath to the Input Image Geometry | -| Input Image Data Array | DataPath | Path to input image with pixel type matching IntegerPixelIDTypeList | - -## Created Objects - -| Name |Type | Description | -|-----|------|-------------| -| Output Image Data Array | DataPath | Path to output image with pixel type matching IntegerPixelIDTypeList | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -52,6 +30,6 @@ 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. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKLog10Image.md b/src/Plugins/ITKImageProcessing/docs/ITKLog10Image.md index 3c4f4e4b01..61f678acc3 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKLog10Image.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKLog10Image.md @@ -10,27 +10,7 @@ ITKImageIntensity (ImageIntensity) The computation is performed using std::log10(x). -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | - -## Required Geometry - -Image Geometry - -## Required Objects - -| Name |Type | Description | -|-----|------|-------------| -| Input Image Geometry | DataPath | DataPath to the Input Image Geometry | -| Input Image Data Array | DataPath | Path to input image with pixel type matching BasicPixelIDTypeList | - -## Created Objects - -| Name |Type | Description | -|-----|------|-------------| -| Output Image Data Array | DataPath | Path to output image with pixel type matching BasicPixelIDTypeList | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -38,6 +18,6 @@ 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. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKLogImage.md b/src/Plugins/ITKImageProcessing/docs/ITKLogImage.md index 31aa1c406e..d7758d62bf 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKLogImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKLogImage.md @@ -8,27 +8,7 @@ ITKImageIntensity (ImageIntensity) ## Description -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | - -## Required Geometry - -Image Geometry - -## Required Objects - -| Name |Type | Description | -|-----|------|-------------| -| Input Image Geometry | DataPath | DataPath to the Input Image Geometry | -| Input Image Data Array | DataPath | Path to input image with pixel type matching BasicPixelIDTypeList | - -## Created Objects - -| Name |Type | Description | -|-----|------|-------------| -| Output Image Data Array | DataPath | Path to output image with pixel type matching BasicPixelIDTypeList | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -36,6 +16,6 @@ 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. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKMaskImage.md b/src/Plugins/ITKImageProcessing/docs/ITKMaskImage.md index 9ad7783b07..cdac541ede 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKMaskImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKMaskImage.md @@ -30,27 +30,7 @@ Note that the input and the mask images must be of the same size. Wiki Examples:*All Examples* Apply a mask to an image -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| OutsideValue | double| Method to explicitly set the outside value of the mask. Defaults to 0 | - -## Required Geometry - -Image - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Cell Attribute Array | None | N/A | (1) | Array containing input image - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Cell Attribute Array | None | | (1) | Array containing filtered image +% Auto generated parameter table will be inserted here ## References diff --git a/src/Plugins/ITKImageProcessing/docs/ITKMedianImage.md b/src/Plugins/ITKImageProcessing/docs/ITKMedianImage.md index c386b8c838..15b7b79b16 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKMedianImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKMedianImage.md @@ -18,28 +18,7 @@ This filter requires that the input pixel type provides an operator<() (LessThan - NeighborhoodOperator - NeighborhoodIterator -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Radius | uint32 | | - -## Required Geometry - -Image Geometry - -## Required Objects - -| Name |Type | Description | -|-----|------|-------------| -| Input Image Geometry | DataPath | DataPath to the Input Image Geometry | -| Input Image Data Array | DataPath | Path to input image with pixel type matching BasicPixelIDTypeList | - -## Created Objects - -| Name |Type | Description | -|-----|------|-------------| -| Output Image Data Array | DataPath | Path to output image with pixel type matching BasicPixelIDTypeList | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -47,6 +26,6 @@ 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. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKMhaFileReader.md b/src/Plugins/ITKImageProcessing/docs/ITKMhaFileReader.md index 2a0bb599b9..1dfb2f4e7a 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKMhaFileReader.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKMhaFileReader.md @@ -12,27 +12,7 @@ ITKImageProcessing (ITKImageProcessing) Reads MHA images and their transformation matrices using ITK -## Parameters - -| Name | Type | Description | -|------------------|------|-------------| -| Input MHA File | String | Path to the input .mha file to read. | -| Save Image Transformation As Array | Boolean | Determines whether or not to read and save the transformation matrix found in the .mha file to a data array. | -| Apply Image Transformation To Geometry | Boolean | Determines whether or not to read and apply the transformation matrix found in the .mha file to the created image geometry. | -| Interpolation Type | Choice | The interpolation type used when transforming the cell data arrays in the created image geometry. Only available if **Apply Image Transformation To Geometry** is set to True.| - -## Required Objects - -None. - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Image Geometry | ImageDataContainer | N/A | N/A | The created image geometry that contains the image data from the .mha file. | -| Cell Attribute Matrix | Cell Data | N/A | N/A | The created cell attribute matrix that contains the image data from the .mha file. | -| Data Array | ImageData | uint16 | 1 | The created data array that contains the image data from the .mha file. | -| Data Array | TransformationMatrix | float32 | 16 | 4x4 transformation matrix read from the .mha input file. Only available if **Save Image Transformation As Array** is set to True. | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -42,6 +22,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. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKMorphologicalGradientImage.md b/src/Plugins/ITKImageProcessing/docs/ITKMorphologicalGradientImage.md index 185c770f93..116e7a17ad 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKMorphologicalGradientImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKMorphologicalGradientImage.md @@ -10,29 +10,7 @@ ITKMathematicalMorphology (MathematicalMorphology) The structuring element is assumed to be composed of binary values (zero or one). Only elements of the structuring element having values > 0 are candidates for affecting the center pixel.* MorphologyImageFilter , GrayscaleFunctionDilateImageFilter , BinaryDilateImageFilter -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| KernelRadius | uint32 | Set the radius of the kernel structuring element. | -| KernelType | KernelEnum | Set the kernel or structuring element used for the morphology. | - -## Required Geometry - -Image Geometry - -## Required Objects - -| Name |Type | Description | -|-----|------|-------------| -| Input Image Geometry | DataPath | DataPath to the Input Image Geometry | -| Input Image Data Array | DataPath | Path to input image with pixel type matching BasicPixelIDTypeList | - -## Created Objects - -| Name |Type | Description | -|-----|------|-------------| -| Output Image Data Array | DataPath | Path to output image with pixel type matching BasicPixelIDTypeList | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -40,6 +18,6 @@ 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. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKMorphologicalWatershedImage.md b/src/Plugins/ITKImageProcessing/docs/ITKMorphologicalWatershedImage.md index 851b620ad0..06ed151f33 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKMorphologicalWatershedImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKMorphologicalWatershedImage.md @@ -23,30 +23,7 @@ This code was contributed in the Insight Journal paper: "The watershed transform - WatershedImageFilter , MorphologicalWatershedFromMarkersImageFilter -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Level | float64 | Set the 'level' variable to the filter | -| MarkWatershedLine | bool | Set/Get whether the watershed pixel must be marked or not. Default is true. Set it to false do not only avoid writing watershed pixels, it also decrease algorithm complexity. | -| FullyConnected | bool | Whether the connected components are defined strictly by face connectivity (False) or by face+edge+vertex connectivity (True). Default is False | - -## Required Geometry - -Image Geometry - -## Required Objects - -| Name |Type | Description | -|-----|------|-------------| -| Input Image Geometry | DataPath | DataPath to the Input Image Geometry | -| Input Image Data Array | DataPath | Path to input image with pixel type matching ScalarPixelIDTypeList | - -## Created Objects - -| Name |Type | Description | -|-----|------|-------------| -| Output Image Data Array | DataPath | Path to output image with pixel type matching ScalarPixelIDTypeList | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -54,6 +31,6 @@ 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. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKNormalizeImage.md b/src/Plugins/ITKImageProcessing/docs/ITKNormalizeImage.md index 81d160b3de..0384e94869 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKNormalizeImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKNormalizeImage.md @@ -12,27 +12,7 @@ NormalizeImageFilter shifts and scales an image so that the pixels in the image NB: since this filter normalizes the data such that the mean is at 0, and \f$-\sigma\f$ to \f$+\sigma\f$ is mapped to -1.0 to 1.0, output image integral types will produce an image that DOES NOT HAVE a unit variance due to 68% of the intensity values being mapped to the real number range of -1.0 to 1.0 and then cast to the output integral value.* NormalizeToConstantImageFilter -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | - -## Required Geometry - -Image Geometry - -## Required Objects - -| Name |Type | Description | -|-----|------|-------------| -| Input Image Geometry | DataPath | DataPath to the Input Image Geometry | -| Input Image Data Array | DataPath | Path to input image with pixel type matching BasicPixelIDTypeList | - -## Created Objects - -| Name |Type | Description | -|-----|------|-------------| -| Output Image Data Array | DataPath | Path to output image with pixel type matching BasicPixelIDTypeList | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -40,6 +20,6 @@ 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. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKNotImage.md b/src/Plugins/ITKImageProcessing/docs/ITKNotImage.md index 0bb9fcc59a..b6270bcae1 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKNotImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKNotImage.md @@ -29,27 +29,7 @@ return this->m_BackgroundValue; Where "!" is the unary Logical NOT operator in C++. -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | - -## Required Geometry - -Image Geometry - -## Required Objects - -| Name |Type | Description | -|-----|------|-------------| -| Input Image Geometry | DataPath | DataPath to the Input Image Geometry | -| Input Image Data Array | DataPath | Path to input image with pixel type matching IntegerPixelIDTypeList | - -## Created Objects - -| Name |Type | Description | -|-----|------|-------------| -| Output Image Data Array | DataPath | Path to output image with pixel type matching IntegerPixelIDTypeList | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -57,6 +37,6 @@ 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. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKOpeningByReconstructionImage.md b/src/Plugins/ITKImageProcessing/docs/ITKOpeningByReconstructionImage.md index 330b379737..44a649db04 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKOpeningByReconstructionImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKOpeningByReconstructionImage.md @@ -25,31 +25,7 @@ Applications", Second Edition, Springer, 2003. - GrayscaleMorphologicalOpeningImageFilter -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| KernelRadius | uint32 | Set the radius of the kernel structuring element. | -| KernelType | KernelEnum | Set the kernel or structuring element used for the morphology. | -| FullyConnected | bool | Whether the connected components are defined strictly by face connectivity (False) or by face+edge+vertex connectivity (True). Default is False | -| PreserveIntensities | bool | Set/Get whether the original intensities of the image retained for those pixels unaffected by the opening by reconstruction. If Off, the output pixel contrast will be reduced. | - -## Required Geometry - -Image Geometry - -## Required Objects - -| Name |Type | Description | -|-----|------|-------------| -| Input Image Geometry | DataPath | DataPath to the Input Image Geometry | -| Input Image Data Array | DataPath | Path to input image with pixel type matching BasicPixelIDTypeList | - -## Created Objects - -| Name |Type | Description | -|-----|------|-------------| -| Output Image Data Array | DataPath | Path to output image with pixel type matching BasicPixelIDTypeList | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -57,6 +33,6 @@ 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. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKOtsuMultipleThresholdsImage.md b/src/Plugins/ITKImageProcessing/docs/ITKOtsuMultipleThresholdsImage.md index af9bfa5b0e..f9250d4cca 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKOtsuMultipleThresholdsImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKOtsuMultipleThresholdsImage.md @@ -15,32 +15,7 @@ This filter also includes an option to use the valley emphasis algorithm from H. - OtsuMultipleThresholdsCalculator - ThresholdLabelerImageFilter -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| NumberOfThresholds | uint8 | Set/Get the number of thresholds. Default is 1. | -| LabelOffset | uint8 | Set/Get the offset which labels have to start from. Default is 0. | -| NumberOfHistogramBins | uint32 | Set/Get the number of histogram bins. Default is 128. | -| ValleyEmphasis | bool | Set/Get the use of valley emphasis. Default is false. | -| ReturnBinMidpoint | bool | Should the threshold value be mid-point of the bin or the maximum? Default is to return bin maximum. | - -## Required Geometry - -Image Geometry - -## Required Objects - -| Name |Type | Description | -|-----|------|-------------| -| Input Image Geometry | DataPath | DataPath to the Input Image Geometry | -| Input Image Data Array | DataPath | Path to input image with pixel type matching BasicPixelIDTypeList | - -## Created Objects - -| Name |Type | Description | -|-----|------|-------------| -| Output Image Data Array | DataPath | Path to output image with pixel type matching BasicPixelIDTypeList | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -48,6 +23,6 @@ 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. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKRelabelComponentImage.md b/src/Plugins/ITKImageProcessing/docs/ITKRelabelComponentImage.md index eed43763df..35e3041a8d 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKRelabelComponentImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKRelabelComponentImage.md @@ -20,29 +20,7 @@ If user sets a minimum object size, all objects with fewer pixels than the minim RelabelComponentImageFilter can be run as an "in place" filter, where it will overwrite its output. The default is run out of place (or generate a separate output). "In place" operation can be controlled via methods in the superclass, InPlaceImageFilter::InPlaceOn() and InPlaceImageFilter::InPlaceOff().* ConnectedComponentImageFilter , BinaryThresholdImageFilter , ThresholdImageFilter -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| MinimumObjectSize | uint64 | Set the minimum size in pixels for an object. All objects smaller than this size will be discarded and will not appear in the output label map. NumberOfObjects will count only the objects whose pixel counts are greater than or equal to the minimum size. Call GetOriginalNumberOfObjects to find out how many objects were present in the original label map. | -| SortByObjectSize | bool | Controls whether the object labels are sorted by size. If false, initial order of labels is kept. | - -## Required Geometry - -Image Geometry - -## Required Objects - -| Name |Type | Description | -|-----|------|-------------| -| Input Image Geometry | DataPath | DataPath to the Input Image Geometry | -| Input Image Data Array | DataPath | Path to input image with pixel type matching IntegerPixelIDTypeList | - -## Created Objects - -| Name |Type | Description | -|-----|------|-------------| -| Output Image Data Array | DataPath | Path to output image with pixel type matching IntegerPixelIDTypeList | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -50,6 +28,6 @@ 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. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKRescaleIntensityImage.md b/src/Plugins/ITKImageProcessing/docs/ITKRescaleIntensityImage.md index 7054009cf4..dfa61c2731 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKRescaleIntensityImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKRescaleIntensityImage.md @@ -18,29 +18,7 @@ All computations are performed in the precision of the input pixel's RealType. B NOTE: In this filter the minimum and maximum values of the input image are computed internally using the MinimumMaximumImageCalculator . Users are not supposed to set those values in this filter. If you need a filter where you can set the minimum and maximum values of the input, please use the IntensityWindowingImageFilter . If you want a filter that can use a user-defined linear transformation for the intensity, then please use the ShiftScaleImageFilter .* IntensityWindowingImageFilter -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| OutputMinimum | float64 | | -| OutputMaximum | float64 | | - -## Required Geometry - -Image Geometry - -## Required Objects - -| Name |Type | Description | -|-----|------|-------------| -| Input Image Geometry | DataPath | DataPath to the Input Image Geometry | -| Input Image Data Array | DataPath | Path to input image with pixel type matching BasicPixelIDTypeList | - -## Created Objects - -| Name |Type | Description | -|-----|------|-------------| -| Output Image Data Array | DataPath | Path to output image with pixel type matching BasicPixelIDTypeList | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -48,6 +26,6 @@ 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. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKSigmoidImage.md b/src/Plugins/ITKImageProcessing/docs/ITKSigmoidImage.md index c15f11e114..b0005d9d39 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKSigmoidImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKSigmoidImage.md @@ -14,31 +14,7 @@ A linear transformation is applied first on the argument of the sigmoid function Every output pixel is equal to f(x). Where x is the intensity of the homologous input pixel, and alpha and beta are user-provided constants. -## Parameters - -| Name | Type | Description | -|------|------|--------------------------| -| Alpha | float64 | Alpha in the above equation | -| Beta | float64 | Beta in the abvove equation | -| OutputMaximum | float64 | The maximum output value | -| OutputMinimum | float64 | The minimum output value | - -## Required Geometry - -Image Geometry - -## Required Objects - -| Name |Type | Description | -|-----|------|-------------| -| Input Image Geometry | DataPath | DataPath to the Input Image Geometry | -| Input Image Data Array | DataPath | Path to input image with pixel type matching BasicPixelIDTypeList | - -## Created Objects - -| Name |Type | Description | -|-----|------|-------------| -| Output Image Data Array | DataPath | Path to output image with pixel type matching BasicPixelIDTypeList | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -46,6 +22,6 @@ 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. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKSignedMaurerDistanceMapImage.md b/src/Plugins/ITKImageProcessing/docs/ITKSignedMaurerDistanceMapImage.md index 43b3a81951..96b9d4f198 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKSignedMaurerDistanceMapImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKSignedMaurerDistanceMapImage.md @@ -20,31 +20,7 @@ Reference: C. R. Maurer, Jr., R. Qi, and V. Raghavan, "A Linear Time Algorithm for Computing Exact Euclidean Distance Transforms of Binary Images in Arbitrary Dimensions", IEEE - Transactions on Pattern Analysis and Machine Intelligence, 25(2): 265-270, 2003. -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| InsideIsPositive | bool | Set if the inside represents positive values in the signed distance map. By convention ON pixels are treated as inside pixels. | -| SquaredDistance | bool | Set if the distance should be squared. | -| UseImageSpacing | bool | Set if image spacing should be used in computing distances. | -| BackgroundValue | float64 | Set the background value which defines the object. Usually this value is = 0. | - -## Required Geometry - -Image Geometry - -## Required Objects - -| Name |Type | Description | -|-----|------|-------------| -| Input Image Geometry | DataPath | DataPath to the Input Image Geometry | -| Input Image Data Array | DataPath | Path to input image with pixel type matching IntegerPixelIDTypeList | - -## Created Objects - -| Name |Type | Description | -|-----|------|-------------| -| Output Image Data Array | DataPath | Path to output image with pixel type matching IntegerPixelIDTypeList | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -52,6 +28,6 @@ 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. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKSinImage.md b/src/Plugins/ITKImageProcessing/docs/ITKSinImage.md index fababbf097..59949d837e 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKSinImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKSinImage.md @@ -10,27 +10,7 @@ ITKImageIntensity (ImageIntensity) The computations are performed using std::sin(x). -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | - -## Required Geometry - -Image Geometry - -## Required Objects - -| Name |Type | Description | -|-----|------|-------------| -| Input Image Geometry | DataPath | DataPath to the Input Image Geometry | -| Input Image Data Array | DataPath | Path to input image with pixel type matching BasicPixelIDTypeList | - -## Created Objects - -| Name |Type | Description | -|-----|------|-------------| -| Output Image Data Array | DataPath | Path to output image with pixel type matching BasicPixelIDTypeList | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -38,6 +18,6 @@ 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. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKSqrtImage.md b/src/Plugins/ITKImageProcessing/docs/ITKSqrtImage.md index 6e2a119a7a..b4078e06e0 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKSqrtImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKSqrtImage.md @@ -10,27 +10,7 @@ ITKImageIntensity (ImageIntensity) The computations are performed using std::sqrt(x). -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | - -## Required Geometry - -Image Geometry - -## Required Objects - -| Name |Type | Description | -|-----|------|-------------| -| Input Image Geometry | DataPath | DataPath to the Input Image Geometry | -| Input Image Data Array | DataPath | Path to input image with pixel type matching BasicPixelIDTypeList | - -## Created Objects - -| Name |Type | Description | -|-----|------|-------------| -| Output Image Data Array | DataPath | Path to output image with pixel type matching BasicPixelIDTypeList | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -38,6 +18,6 @@ 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. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKSquareImage.md b/src/Plugins/ITKImageProcessing/docs/ITKSquareImage.md index 7272e8aae3..69cf75ea15 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKSquareImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKSquareImage.md @@ -8,27 +8,7 @@ ITKImageIntensity (ImageIntensity) ## Description -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | - -## Required Geometry - -Image Geometry - -## Required Objects - -| Name |Type | Description | -|-----|------|-------------| -| Input Image Geometry | DataPath | DataPath to the Input Image Geometry | -| Input Image Data Array | DataPath | Path to input image with pixel type matching BasicPixelIDTypeList | - -## Created Objects - -| Name |Type | Description | -|-----|------|-------------| -| Output Image Data Array | DataPath | Path to output image with pixel type matching BasicPixelIDTypeList | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -36,6 +16,6 @@ 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. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKTanImage.md b/src/Plugins/ITKImageProcessing/docs/ITKTanImage.md index b42b9fa4c5..aab9915c28 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKTanImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKTanImage.md @@ -10,27 +10,7 @@ ITKImageIntensity (ImageIntensity) The computations are performed using std::tan(x). -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | - -## Required Geometry - -Image Geometry - -## Required Objects - -| Name |Type | Description | -|-----|------|-------------| -| Input Image Geometry | DataPath | DataPath to the Input Image Geometry | -| Input Image Data Array | DataPath | Path to input image with pixel type matching BasicPixelIDTypeList | - -## Created Objects - -| Name |Type | Description | -|-----|------|-------------| -| Output Image Data Array | DataPath | Path to output image with pixel type matching BasicPixelIDTypeList | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -38,6 +18,6 @@ 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. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKThresholdImage.md b/src/Plugins/ITKImageProcessing/docs/ITKThresholdImage.md index 8f017e9840..a5e318100c 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKThresholdImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKThresholdImage.md @@ -22,30 +22,7 @@ Note that these definitions indicate that pixels equal to the threshold value ar The pixels must support the operators >= and <=. -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Lower | float64 | Set/Get methods to set the lower threshold. | -| Upper | float64 | Set/Get methods to set the upper threshold. | -| OutsideValue | float64 | The pixel type must support comparison operators. Set the "outside" pixel value. The default value NumericTraits::ZeroValue() . | - -## Required Geometry - -Image Geometry - -## Required Objects - -| Name |Type | Description | -|-----|------|-------------| -| Input Image Geometry | DataPath | DataPath to the Input Image Geometry | -| Input Image Data Array | DataPath | Path to input image with pixel type matching BasicPixelIDTypeList | - -## Created Objects - -| Name |Type | Description | -|-----|------|-------------| -| Output Image Data Array | DataPath | Path to output image with pixel type matching BasicPixelIDTypeList | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -53,6 +30,6 @@ 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. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKValuedRegionalMaximaImage.md b/src/Plugins/ITKImageProcessing/docs/ITKValuedRegionalMaximaImage.md index ab2dc7e9ed..03fcdb1877 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKValuedRegionalMaximaImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKValuedRegionalMaximaImage.md @@ -30,28 +30,7 @@ This code was contributed in the Insight Journal paper: "Finding regional extrem - ValuedRegionalExtremaImageFilter - HMinimaImageFilter -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| FullyConnected | bool | Whether the connected components are defined strictly by face connectivity (False) or by face+edge+vertex connectivity (True). Default is False | - -## Required Geometry - -Image Geometry - -## Required Objects - -| Name |Type | Description | -|-----|------|-------------| -| Input Image Geometry | DataPath | DataPath to the Input Image Geometry | -| Input Image Data Array | DataPath | Path to input image with pixel type matching ScalarPixelIDTypeList | - -## Created Objects - -| Name |Type | Description | -|-----|------|-------------| -| Output Image Data Array | DataPath | Path to output image with pixel type matching ScalarPixelIDTypeList | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -59,6 +38,6 @@ 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. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKValuedRegionalMinimaImage.md b/src/Plugins/ITKImageProcessing/docs/ITKValuedRegionalMinimaImage.md index 3fb06fd958..3f4071ddcc 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKValuedRegionalMinimaImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKValuedRegionalMinimaImage.md @@ -21,28 +21,7 @@ This code was contributed in the Insight Journal paper: "Finding regional extrem - ValuedRegionalMaximaImageFilter , ValuedRegionalExtremaImageFilter , - HMinimaImageFilter -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| FullyConnected | bool | Whether the connected components are defined strictly by face connectivity (False) or by face+edge+vertex connectivity (True). Default is False | - -## Required Geometry - -Image Geometry - -## Required Objects - -| Name |Type | Description | -|-----|------|-------------| -| Input Image Geometry | DataPath | DataPath to the Input Image Geometry | -| Input Image Data Array | DataPath | Path to input image with pixel type matching ScalarPixelIDTypeList | - -## Created Objects - -| Name |Type | Description | -|-----|------|-------------| -| Output Image Data Array | DataPath | Path to output image with pixel type matching ScalarPixelIDTypeList | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -50,6 +29,6 @@ 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. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKWhiteTopHatImage.md b/src/Plugins/ITKImageProcessing/docs/ITKWhiteTopHatImage.md index 78850d1d14..5548c250e1 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKWhiteTopHatImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKWhiteTopHatImage.md @@ -16,30 +16,7 @@ Top-hats are described in Chapter 4.5 of Pierre Soille's book "Morphological Ima ### Related Filters -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| KernelRadius | uint32 | Set the radius of the kernel structuring element. | -| KernelType | KernelEnum | Set the kernel or structuring element used for the morphology. | -| SafeBorder | bool | A safe border is added to input image to avoid borders effects and remove it once the closing is done | - -## Required Geometry - -Image Geometry - -## Required Objects - -| Name |Type | Description | -|-----|------|-------------| -| Input Image Geometry | DataPath | DataPath to the Input Image Geometry | -| Input Image Data Array | DataPath | Path to input image with pixel type matching BasicPixelIDTypeList | - -## Created Objects - -| Name |Type | Description | -|-----|------|-------------| -| Output Image Data Array | DataPath | Path to output image with pixel type matching BasicPixelIDTypeList | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -47,6 +24,6 @@ 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. diff --git a/src/Plugins/OrientationAnalysis/docs/AlignSectionsMisorientationFilter.md b/src/Plugins/OrientationAnalysis/docs/AlignSectionsMisorientationFilter.md index f70d3ea753..c7d652935e 100644 --- a/src/Plugins/OrientationAnalysis/docs/AlignSectionsMisorientationFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/AlignSectionsMisorientationFilter.md @@ -1,8 +1,3 @@ -```{index} single: Filters; Align Sections (Misorientation) -``` - -(header_target)= - # Align Sections (Misorientation) ## Group (Subgroup) @@ -28,32 +23,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 | -|------------|------| --------------------------------- | -| Misorientation Tolerance | float | Tolerance used to decide if **Cells** above/below one another should be considered to be *the same*. The value selected should be similar to the tolerance one would use to define **Features** (i.e., 2-10 degrees) | -| 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 Mask Array | bool | Whether to remove some **Cells** from consideration in the alignment process | - -## Required Geometry - -Image - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Cell Attribute Array | Quats | float | (4) | Specifies the orientation of the **Cell** in quaternion representation | -| Cell Attribute Array | Phases | int32_t | (1) | Specifies to which **Ensemble** each **Cell** belongs | -| Cell Attribute Array | Mask | bool | (1) | Specifies if the **Cell** is to be counted in the algorithm. Only required if *Use Mask Array* is checked | -| Ensemble Attribute Array | CrystalStructures | uint32_t | (1) | Enumeration representing the crystal structure for each Ensemble | - -## Created Objects - -None +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -64,6 +34,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. diff --git a/src/Plugins/OrientationAnalysis/docs/AlignSectionsMutualInformationFilter.md b/src/Plugins/OrientationAnalysis/docs/AlignSectionsMutualInformationFilter.md index 745bbde1d0..2371317c04 100644 --- a/src/Plugins/OrientationAnalysis/docs/AlignSectionsMutualInformationFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/AlignSectionsMutualInformationFilter.md @@ -28,31 +28,7 @@ If the user elects to use a mask array, the **Cells** flagged as *false* in the The user can choose to write the determined shift to an output file by enabling *Write Alignment Shifts File* and providing a file path. -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Misorientation Tolerance | float | Tolerance used to decide if **Cells** above/below one another should be considered to be *the same*. The value selected should be similar to the tolerance one would use to define **Features** (i.e., 2-10 degrees) | -| 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 | -| Use Mask Array | bool | Whether to remove some **Cells** from consideration in the alignment process | - -## Required Geometry - -Image - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Cell Attribute Array | Quats | float | (4) | Specifies the orientation of the **Cell** in quaternion representation | -| Cell Attribute Array | Phases | int32_t | (1) | Specifies to which **Ensemble** each **Cell** belongs | -| Cell Attribute Array | Mask | bool | (1) | Specifies if the **Cell** is to be counted in the algorithm. Only required if *Use Mask Array* is checked | -| Ensemble Attribute Array | CrystalStructures | uint32_t | (1) | Enumeration representing the crystal structure for each Ensemble | - -## Created Objects - -None +% Auto generated parameter table will be inserted here ## References @@ -74,6 +50,6 @@ AlignSectionsMutualInformation 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. diff --git a/src/Plugins/OrientationAnalysis/docs/BadDataNeighborOrientationCheckFilter.md b/src/Plugins/OrientationAnalysis/docs/BadDataNeighborOrientationCheckFilter.md index 3193e9a55c..e087f31af5 100644 --- a/src/Plugins/OrientationAnalysis/docs/BadDataNeighborOrientationCheckFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/BadDataNeighborOrientationCheckFilter.md @@ -12,29 +12,7 @@ This **Filter** compares the orientations of *bad* **Cells** with their neighbor *Note:* The **Filter** will iteratively reduce the required number of neighbors from 6 until it reaches the user defined number. So, if the user selects a required number of neighbors of 4, then the **Filter** will run with a required number of neighbors of 6, then 5, then 4 before finishing. -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Misorientation Tolerance (Degrees) | float | Angular tolerance used to compare with neighboring **Cells | -| Required Number of Neighbors | int32_t | Minimum number of neighbor **Cells** that must have orientations within above tolerace to allow **Cell** to be changed | - -## Required Geometry - -Image - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Cell Attribute Array | Quaternions | flaot | (4) | Specifies the orientation of the **Cell** in quaternion representation | -| Cell Attribute Array | Mask | bool | (1) | Used to define **Cells** as *good* or *bad* | -| Cell Attribute Array | Cell Phases | int32_t | (1) | Specifies to which **Ensemble** each **Cell** belongs | -| Ensemble Attribute Array | Crystal Structures | uint32_t | (1) | Enumeration representing the crystal structure for each phase | - -## Created Objects - -None +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -47,6 +25,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. diff --git a/src/Plugins/OrientationAnalysis/docs/CAxisSegmentFeaturesFilter.md b/src/Plugins/OrientationAnalysis/docs/CAxisSegmentFeaturesFilter.md index bed129e80b..84ece2f2d1 100644 --- a/src/Plugins/OrientationAnalysis/docs/CAxisSegmentFeaturesFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/CAxisSegmentFeaturesFilter.md @@ -18,33 +18,7 @@ The user has the option to *Use Mask Array*, which allows the user to set a bool After all the **Features** have been identified, a **Feature Attribute Matrix** is created for the **Features** and each **Feature** is flagged as *Active* in a boolean array in the matrix. -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| C-Axis Misorientation Tolerance (Degrees) | float | Tolerance (in degrees) used to determine if neighboring **Cells** belong to the same **Feature | -| Use Mask Array | bool | Specifies whether to use a boolean array to exclude some **Cells** from the **Feature** identification process | - -## Required Geometry - -Image - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Cell Attribute Array | Quats | float | (4) | Specifies the orientation of the **Cell** in quaternion representation | -| Cell Attribute Array | Phases | int32_t | (1) | Specifies to which **Ensemble** each **Cell** belongs | -| Cell Attribute Array | Mask | bool | (1) | Specifies if the **Cell** is to be counted in the algorithm. Only required if *Use Mask Array* is checked | -| Ensemble Attribute Array | CrystalStructures | uint32_t | (1) | Enumeration representing the crystal structure for each Ensemble | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Cell Attribute Array | FeatureIds | int32_t | (1) | Specifies to which **Feature** each **Cell** belongs. | -| Attribute Matrix | CellFeatureData | Cell Feature | N/A | Created **Feature Attribute Matrix** name | -| Feature Attribute Array | Active | bool | (1) | Specifies if the **Feature** is still in the sample (*true* if the **Feature** is in the sample and *false* if it is not). At the end of the **Filter**, all **Features** will be *Active* | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -54,6 +28,6 @@ Combo-EBSD-osc_r0c0 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. diff --git a/src/Plugins/OrientationAnalysis/docs/ConvertOrientations.md b/src/Plugins/OrientationAnalysis/docs/ConvertOrientations.md index 1091a3abd5..5a459a9ee4 100644 --- a/src/Plugins/OrientationAnalysis/docs/ConvertOrientations.md +++ b/src/Plugins/OrientationAnalysis/docs/ConvertOrientations.md @@ -37,29 +37,7 @@ If the angles fall outside of this range the **original** Euler Input data **WIL While every effort has been made to ensure the correctness of each transformation algorithm, certain situations may arise where the initial precision of the input data is not large enough for the algorithm to calculate an answer that is intuitive. The user should be acutely aware of their input data and if their data may cause these situations to occur. Combinations of Euler angles close to 0, 180 and 360 can cause these issues to be hit. For instance an Euler angle of [180, 56, 360] is symmetrically the same as [180, 56, 0] and due to calculation errors and round off errors converting that Euler angle between representations may not give the numerical answer the user was anticipating but will give a symmetrically equivalent angle. -## Parameters - -| Name | Type | Description | -|------------------|------|-------------| -| Input Orientation Type | Enumeration | Specifies the incoming orientation representation | -| Output Orientation Type | Enumeration | Specifies to which orientation representation to convert the incoming data | -| Output Orientations | String | The name of the data array with the converted orientation representation | - -## Required Geometry - -Not Applicable - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Any **Data Array | Input Orientations | float | See above table | Incoming orientation representation | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Any **Data Array | *Output Orientations* | float | See above table | Converted orientation representation | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -76,6 +54,6 @@ Not Applicable 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. diff --git a/src/Plugins/OrientationAnalysis/docs/ConvertQuaternionFilter.md b/src/Plugins/OrientationAnalysis/docs/ConvertQuaternionFilter.md index 16f406eb92..b458ed857e 100644 --- a/src/Plugins/OrientationAnalysis/docs/ConvertQuaternionFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/ConvertQuaternionFilter.md @@ -10,28 +10,7 @@ Internally DREAM.3D assumes that a quaternion is laid out in the order such that For Example if the user has imported quaternion data in the form of Scalar-Vector then they would run this filter using a conversion type of **ToVectorScalar** and using the generated quaternions in subsequent filters. If the user wanted to then write out the Quaternions in the Scalar-Vector form then could add this filter again to the end of the pipeline (but before writing out data) to convert the Vector-Scalar quaternions array (assuming something modified the array). -## Parameters - -| Name | Type | Description | -|------|------|------| -| Delete Original Array | Boolean | Set this to TRUE/ON to have the original 3 component data array deleted at the end of the filter. | -| Conversion Type | Integer | 0=ToScalarVector, 1=ToVectorScalar | - -## Required Geometry - -Not Applicable - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Attribute Array | Quaternion Input | float | (4) | | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Attribute Array | Quaternion Ouput | float | (4) | | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -39,6 +18,6 @@ Not Applicable 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. diff --git a/src/Plugins/OrientationAnalysis/docs/CreateEnsembleInfoFilter.md b/src/Plugins/OrientationAnalysis/docs/CreateEnsembleInfoFilter.md index c0f4a83f68..3258519d29 100644 --- a/src/Plugins/OrientationAnalysis/docs/CreateEnsembleInfoFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/CreateEnsembleInfoFilter.md @@ -36,28 +36,7 @@ This **Filter** allows the user to enter basic crystallographic information abou | BoundaryPhase | 4 | | UnknownPhaseType | 999 | -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Ensemble | Create Ensemble Info | The created Ensemble crystal structures, phase types, and phase names | - -## Required Geometry - -Not Applicable - -## Required Objects - -None - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Attribute Matrix | EnsembleAttributeMatrix | Ensemble | N/A | Created Ensemble Attribute Matrix** name | -| Ensemble Attribute Array | CrystalStructures | uint32_t | (1) | Enumeration representing the crystal structure for each Ensemble | -| Ensemble Attribute Array | PhaseTypes | uint32_t | (1) | Enumeration representing the phase type for each Ensemble | -| String Data Array** | PhaseNames | String | (1) | The phase names for each Ensemble | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -67,6 +46,6 @@ Import_ASCII 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. diff --git a/src/Plugins/OrientationAnalysis/docs/EBSDSegmentFeaturesFilter.md b/src/Plugins/OrientationAnalysis/docs/EBSDSegmentFeaturesFilter.md index 0cc85e89e0..9abd375431 100644 --- a/src/Plugins/OrientationAnalysis/docs/EBSDSegmentFeaturesFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/EBSDSegmentFeaturesFilter.md @@ -18,33 +18,7 @@ The user has the option to *Use Mask Array*, which allows the user to set a bool After all the **Features** have been identified, a **Feature Attribute Matrix** is created for the **Features** and each **Feature** is flagged as *Active* in a boolean array in the matrix. -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Misorientation Tolerance (Degrees) | float | Tolerance (in degrees) used to determine if neighboring **Cells** belong to the same **Feature | -| Use Mask Array | bool | Specifies whether to use a boolean array to exclude some **Cells** from the **Feature** identification process | - -## Required Geometry - -Image - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Cell Attribute Array | Quats | float | (4) | Specifies the orientation of the **Cell** in quaternion representation | -| Cell Attribute Array | Phases | int32_t | (1) | Specifies to which **Ensemble** each **Cell** belongs | -| Cell Attribute Array | Mask | bool | (1) | Specifies if the **Cell** is to be counted in the algorithm. Only required if *Use Mask Array* is checked | -| Ensemble Attribute Array | CrystalStructures | uint32_t | (1) | Enumeration representing the crystal structure for each Ensemble | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Cell Attribute Array | FeatureIds | int32_t | (1) | Specifies to which **Feature** each **Cell** belongs. | -| Attribute Matrix | CellFeatureData | Cell Feature | N/A | Created **Feature Attribute Matrix** name | -| Feature Attribute Array | Active | bool | (1) | Specifies if the **Feature** is still in the sample (*true* if the **Feature** is in the sample and *false* if it is not). At the end of the **Filter**, all **Features** will be *Active* | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -57,6 +31,6 @@ Image 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. diff --git a/src/Plugins/OrientationAnalysis/docs/EbsdToH5EbsdFilter.md b/src/Plugins/OrientationAnalysis/docs/EbsdToH5EbsdFilter.md index f0305ea72b..65bc067d56 100644 --- a/src/Plugins/OrientationAnalysis/docs/EbsdToH5EbsdFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/EbsdToH5EbsdFilter.md @@ -63,21 +63,7 @@ The user needs to click the _Set Reference Frame_ button to set the proper refer Once all the inputs are correct the user can click the **Go** button to start the conversion. Progress will be displayed at the bottom of the DREAM3D user interface during the conversion. -## Parameters - -See Description - -## Required Geometry - -Not Applicable - -## Required Objects - -None - -## Created Objects - -None +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -88,6 +74,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. diff --git a/src/Plugins/OrientationAnalysis/docs/EnsembleInfoReaderFilter.md b/src/Plugins/OrientationAnalysis/docs/EnsembleInfoReaderFilter.md index 086c15760f..3c39595454 100644 --- a/src/Plugins/OrientationAnalysis/docs/EnsembleInfoReaderFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/EnsembleInfoReaderFilter.md @@ -52,27 +52,7 @@ For example, if you have a structure that has 2 phases that consist of a Cubic P CrystalStructure=Hexagonal_High PhaseType=MatrixPhase -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Input Ensemble Info File | File Path | The input file path | - -## Required Geometry - -Not Applicable - -## Required Objects - -None - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Attribute Matrix | EnsembleAttributeMatrix | Ensemble | N/A | Created Ensemble Attribute Matrix** name | -| Ensemble Attribute Array | CrystalStructures | uint32_t | (1) | Enumeration representing the crystal structure for each Ensemble | -| Ensemble Attribute Array | PhaseTypes | uint32_t | (1) | Enumeration representing the phase type for each Ensemble | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -80,6 +60,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. diff --git a/src/Plugins/OrientationAnalysis/docs/ExportGBCDGMTFileFilter.md b/src/Plugins/OrientationAnalysis/docs/ExportGBCDGMTFileFilter.md index c54f68fa42..f285d2d8ae 100644 --- a/src/Plugins/OrientationAnalysis/docs/ExportGBCDGMTFileFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/ExportGBCDGMTFileFilter.md @@ -10,28 +10,7 @@ This **Filter** creates a .dat file that can be used in conjunction with [GMT](h ![GMT Visualization of the Small IN100 GBCD Results](Images/ExportGBCDGMTFile.png) -## Parameters - -| Name | Type | Description | -|----------|------|-----------------------| -| Phase of Interest | int32_t | Index of the **Ensemble** for which to plot the pole figure | -| Crystal Structure | Enumeration | Crystal structure for GBCD. Currently supports from Hexagonal-High 6/mmm or Cubic-High m-3m symmetries | -| Misorientation Axis-Angle | float (4x) | Axis-Angle pair values for drawing GBCD | -| Output GMT File | File Path | The output .dat file path | - -## Required Geometry - -Triangle - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Ensemble Attribute Array | GBDC | double | (n,m,l,o,q,r) | 5 parameter GBCD data. The 6th component is used internally to track the northern vs. southern hemisphere of the Lambert sphere | - -## Created Objects - -None +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -41,6 +20,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. diff --git a/src/Plugins/OrientationAnalysis/docs/ExportGBCDTriangleDataFilter.md b/src/Plugins/OrientationAnalysis/docs/ExportGBCDTriangleDataFilter.md index 5682c0aa51..cbf8799e98 100644 --- a/src/Plugins/OrientationAnalysis/docs/ExportGBCDTriangleDataFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/ExportGBCDTriangleDataFilter.md @@ -27,28 +27,7 @@ This **Filter** writes relevant information about the Grain Boundary Character D 3.4109 0.6178 1.0586 0.2662 0.6970 4.4347 0.9822 0.1328 0.1328 0.0256 .. -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Output File | File Path | The output GBCD triangle file path | - -## Required Geometry - -Image + Triangle - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Face Attribute Array | FaceLabels | int32_t | (2) | Specifies which **Features** are on either side of each Face | -| Face Attribute Array | FaceNormals | double | (3) | Specifies the normal of each Face | -| Face Attribute Array | FaceAreas | double | (1) | Specifies the area of each Face | -| Feature Attribute Array** | AvgEulerAngles | float | (3) | Three angles defining the orientation of the **Feature** in Bunge convention (Z-X-Z). | - -## Created Objects - -None +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -56,6 +35,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. diff --git a/src/Plugins/OrientationAnalysis/docs/FindAvgCAxesFilter.md b/src/Plugins/OrientationAnalysis/docs/FindAvgCAxesFilter.md index 30ea245d1f..56afefbf33 100644 --- a/src/Plugins/OrientationAnalysis/docs/FindAvgCAxesFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/FindAvgCAxesFilter.md @@ -14,28 +14,7 @@ This **Filter** determines the average C-axis location of each **Feature** by th *Note:* This **Filter** will only work properly for *Hexagonal* materials. The **Filter** does not apply any symmetry operators because there is only one c-axis (<001>) in *Hexagonal* materials and thus all symmetry operators will leave the c-axis in the same position in the sample *reference frame*. However, in *Cubic* materials, for example, the {100} family of directions are all equivalent and the <001> direction will change location in the sample *reference frame* when symmetry operators are applied. -## Parameters - -None - -## Required Geometry - -Not Applicable - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Element Attribute Array** | Quats | float | (4) | Specifies the orientation of the **Element** in quaternion representation | -| Element Attribute Array | FeatureIds | int32_t | (1) | Specifies to which **Feature** each **Element** belongs. | -| Cell Attribute Array | Phases | int32_t | (1) | Specifies to which **Ensemble** each **Cell** belongs | -| Ensemble Attribute Array | CrystalStructures | uint32_t | (1) | Enumeration representing the crystal structure for each Ensemble | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Feature Attribute Array | AvgCAxes | float | (3) | The direction of the **Feature's** C-axis in the sample reference frame | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -45,6 +24,6 @@ Combo-EBSD-osc_r0c0 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. diff --git a/src/Plugins/OrientationAnalysis/docs/FindAvgOrientationsFilter.md b/src/Plugins/OrientationAnalysis/docs/FindAvgOrientationsFilter.md index 8607482ba0..47f73780f4 100644 --- a/src/Plugins/OrientationAnalysis/docs/FindAvgOrientationsFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/FindAvgOrientationsFilter.md @@ -17,29 +17,7 @@ This **Filter** determines the average orientation of each **Feature** by the fo *Note:* The quaternions can be averaged with a simple average because the quaternion space is not distorted like Euler space. -## Parameters - -None - -## Required Geometry - -Not Applicable - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Element Attribute Array | FeatureIds | int32_t | (1) | Specifies to which **Feature** each **Element** belongs | -| Element Attribute Array | Phases | int32_t | (1) | Specifies the **Ensemble** of the **Element | -| Element Attribute Array | Quats | float | (4) | Specifies the orientation of the **Element** in quaternion representation | -| Ensemble Attribute Array | CrystalStructures | uint32_t | (1) | Enumeration representing the crystal structure for each Ensemble | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Feature Attribute Array | AvgQuats | float | (4) | Specifies the average orientation of the **Feature** in quaternion representation | -| Feature Attribute Array | AvgEulerAngles | float | (3) | Specifies the orientation of each **Feature** in Bunge convention (Z-X-Z) | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -53,6 +31,6 @@ Not Applicable 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. diff --git a/src/Plugins/OrientationAnalysis/docs/FindBoundaryStrengthsFilter.md b/src/Plugins/OrientationAnalysis/docs/FindBoundaryStrengthsFilter.md index 689aa4ddef..d994fba6a9 100644 --- a/src/Plugins/OrientationAnalysis/docs/FindBoundaryStrengthsFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/FindBoundaryStrengthsFilter.md @@ -16,33 +16,7 @@ This **Filter** calculates the same metrics as in the Find Neighbor Slip Transmi *Note:* Each metric is calculated twice for the two different directions slip could approach the boundary. The values are stored on each **Face** in the **Face** map in a way that notes the direction (i.e., when **Feature** 1 has neighbor **Feature** 2 and when **Feature** 2 has neighbor **Feature** 1) because the direction across the boundary between the **Features** affects the value of the metric. -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Loading Direction | float32 (3x) | The loading axis for the sample | - -## Required Geometry - -Image + Triangle - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Face Attribute Array | FaceLabels | int32 | (2) | Specifies which **Features** are on either side of each Face | -| Feature Attribute Array | AvgQuats | float32 | (4) | Specifies the average orientation of each **Feature** in quaternion representation | -| Feature Attribute Array | Phases | int32 | (1) | Specifies to which **Ensemble** each **Feature** belongs | -| Ensemble Attribute Array | CrystalStructures | uint32 | (1) | Enumeration representing the crystal structure for each phase | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Face Attribute Array | F1s | float32 | (2) | | -| Face Attribute Array | F1spts | float32 | (2) | | -| Face Attribute Array | F7s | float32 | (2) | | -| Face Attribute Array | mPrimes | float32 | (2) | | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -50,6 +24,6 @@ Image + Triangle 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. diff --git a/src/Plugins/OrientationAnalysis/docs/FindCAxisLocationsFilter.md b/src/Plugins/OrientationAnalysis/docs/FindCAxisLocationsFilter.md index 20d19b0664..61743bcf94 100644 --- a/src/Plugins/OrientationAnalysis/docs/FindCAxisLocationsFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/FindCAxisLocationsFilter.md @@ -10,27 +10,7 @@ This **Filter** determines the direction of the C-axis for each **Elemen *Note:* This **Filter** will only work properly for *Hexagonal* materials. The **Filter** does not apply any symmetry operators because there is only one c-axis (<001>) in *Hexagonal* materials and thus all symmetry operators will leave the c-axis in the same position in the sample *reference frame*. However, in *Cubic* materials, for example, the {100} family of directions are all equivalent and the <001> direction will change location in the *sample reference frame* when symmetry operators are applied. -## Parameters - -None - -## Required Geometry - -Not Applicable - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Element Attribute Array | Quats | float | (4) | Specifies the orientation of the **Element** in quaternion representation | -| Cell Attribute Array | Phases | int32_t | (1) | Specifies to which **Ensemble** each **Cell** belongs | -| Ensemble Attribute Array | CrystalStructures | uint32_t | (1) | Enumeration representing the crystal structure for each Ensemble | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Element Attribute Array | CAxisLocation | float | (3) | Direction of the C-axis for each **Element** in the sample reference frame | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -40,6 +20,6 @@ Combo-EBSD-osc_r0c0 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. diff --git a/src/Plugins/OrientationAnalysis/docs/FindFeatureNeighborCAxisMisalignmentsFilter.md b/src/Plugins/OrientationAnalysis/docs/FindFeatureNeighborCAxisMisalignmentsFilter.md index ae74b73a18..c14e548c91 100644 --- a/src/Plugins/OrientationAnalysis/docs/FindFeatureNeighborCAxisMisalignmentsFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/FindFeatureNeighborCAxisMisalignmentsFilter.md @@ -12,31 +12,7 @@ This **Filter** determines, for each **Feature**, the C-axis misalignments with **NOTE:** Only features with identical phase values and a crystal structure of **Hexagonal_High** will be calculated. If two features have different phase values or a crystal structure that is *not* Hexagonal_High then a value of NaN is set for the misorientation. -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -|Find Average Misalignment Per Feature | bool | Whether the *average* of the C-axis misalignments with the neighboring **Features** should be stored for each **Feature | - -## Required Geometry - -Not Applicable - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Feature Attribute Array | NeighborLists | List of int32_t | (1) | List of the contiguous neighboring **Features** for a given **Feature | -| Feature Attribute Array | AvgQuats | float | (4) | Defines the average orientation of the **Feature** in quaternion representation | -| Feature Attribute Array | Phases | int32_t | (1) | Specifies to which **Ensemble** each **Feature** belongs | -| Ensemble Attribute Array | CrystalStructures | uint32_t | (1) | Enumeration representing the crystal structure for each Ensemble | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Feature Attribute Array | CAxisMisalignmentList | List of float | (1) | List of the C-axis misalignment angles (in degrees) with the contiguous neighboring **Features** for a given **Feature | -| Feature Attribute Array | AvgCAxisMisalignments | float | (1) | Number weighted average of neighbor C-axis misalignments. Only created if *Find Average Misalignment Per Feature* is checked | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -46,6 +22,6 @@ Combo-EBSD-osc_r0c0 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. diff --git a/src/Plugins/OrientationAnalysis/docs/FindFeatureReferenceCAxisMisorientationsFilter.md b/src/Plugins/OrientationAnalysis/docs/FindFeatureReferenceCAxisMisorientationsFilter.md index 7396526624..5a16e1ec2a 100644 --- a/src/Plugins/OrientationAnalysis/docs/FindFeatureReferenceCAxisMisorientationsFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/FindFeatureReferenceCAxisMisorientationsFilter.md @@ -10,31 +10,7 @@ This **Filter** calculates the misorientation angle between the C-axis of each * This filter requires at least one Hexagonal crystal structure phase (Hexagonal-Low 6/m or Hexagonal-High 6/mmm). Although it is not recommended, you can give input data with mixed phase types and all non hexagonal phases will be skipped in the calculations. -## Parameters - -None - -## 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 | -| Cell Attribute Array | Quats | float | (4) | Specifies the orientation of the **Cell** in quaternion representation | -| Cell Attribute Array** | Phases | int32_t | (1) | Specifies to which **Ensemble** each **Cell** belongs | -| Feature Attribute Array | AvgCAxes | float | (3) | The direction of the **Feature's** C-axis in the sample reference frame | -| Ensemble Attribute Array | CrystalStructures | uint32_t | (1) | Enumeration representing the crystal structure for each Ensemble | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Cell Attribute Array | FeatureReferenceCAxisMisorientations | float | (1) | Misorientation angle (in degrees) between **Cell's** C-axis and the C-axis of the **Feature** that owns that **Cell | -| Feature Attribute Array | FeatureAvgCAxisMisorientations | float | (1) | Average of the *FeatureReferenceCAxisMisorientation* values for all of the **Cells** that belong to the **Feature | -| Feature Attribute Array | FeatureStdevCAxisMisorientations | float | (1) | Standard deviation of the *FeatureReferenceCAxisMisorientation* values for all of the **Cells** that belong to the **Feature | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -44,6 +20,6 @@ Combo-EBSD-osc_r0c0 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. diff --git a/src/Plugins/OrientationAnalysis/docs/FindFeatureReferenceMisorientationsFilter.md b/src/Plugins/OrientationAnalysis/docs/FindFeatureReferenceMisorientationsFilter.md index 8111d8de03..f5201ade16 100644 --- a/src/Plugins/OrientationAnalysis/docs/FindFeatureReferenceMisorientationsFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/FindFeatureReferenceMisorientationsFilter.md @@ -10,33 +10,7 @@ This **Filter** calculates the misorientation angle between each **Cell** within Note: the average orientation of the **Feature** is a typical choice, but if the **Feature** has undergone plastic deformation and the amount of lattice rotation developed is of interest, then it may be more reasonable to use the orientation *near the center* of the **Feature** as it may not have rotated and thus serve as a better *reference orientation*. -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Reference Orientation | Enumeration | Specifies the *reference orientation* to use when comparing to each **Cell | - -## 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 | -| Cell Attribute Array** | Phases | int32_t | (1) | Specifies to which **Ensemble** each **Cell** belongs | -| Cell Attribute Array | Quats | float | (4) | Specifies the orientation of the **Cell** in quaternion representation | -| Feature Attribute Array | AvgQuats | float | (4) | Specifies the average orientation of the **Feature** in quaternion representation (, w). Only required if the *reference orientation* is selected to be the average of the **Feature | -| Cell Attribute Array | GBEuclideanDistances | float | (1) | Distance the **Cells** are from the *boundary* of the **Feature** they belong to. Only required if the *reference orientation* is selected to be the orientation at the **Feature** centroid | -| Ensemble Attribute Array | CrystalStructures | uint32_t | (1) | Enumeration representing the crystal structure for each Ensemble | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Cell Attribute Array | FeatureReferenceMisorientations | float | (1) | Misorientation angle (in degrees) between **Cell's** orientation and the reference orientation of the **Feature** that owns that **Cell | -| Feature Attribute Array | FeatureAvgMisorientations | float | (1) | Average of the *FeatureReferenceMisorientation* values for all of the **Cells** that belong to the **Feature | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -46,6 +20,6 @@ Image 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. diff --git a/src/Plugins/OrientationAnalysis/docs/FindGBCDFilter.md b/src/Plugins/OrientationAnalysis/docs/FindGBCDFilter.md index 0bc05898a6..d7e5be75b7 100644 --- a/src/Plugins/OrientationAnalysis/docs/FindGBCDFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/FindGBCDFilter.md @@ -8,37 +8,7 @@ Statistics (Crystallographic) This **Filter** computes the 5D grain boundary character distribution (GBCD) for a **Triangle Geometry**, which is the relative area of grain boundary for a given misorientation and normal. The GBCD can be visualized by using either the **Write GBCD Pole Figure (GMT)** or the **Write GBCD Pole Figure (VTK)** **Filters**. -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| GBCD Resolution (Degrees) | float | The resolution in degrees for the GBCD calculation | - -## Required Geometry - -Image + Triangle - -## Required Objects(From Triangle Geometry) - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Face Attribute Array | FaceLabels | int32_t | (2) | Specifies which **Features** are on either side of each Face | -| Face Attribute Array | FaceNormals | double | (3) | Specifies the normal of each Face | -| Face Attribute Array | FaceAreas | double | (1) | Specifies the area of each Face | - -## Required Objects(From Image Geometry) - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Feature Attribute Array | AvgEulerAngles | float | (3) | Three angles defining the orientation of the **Feature** in Bunge convention (Z-X-Z) | -| Feature Attribute Array | Phases | int32_t | (1) | Specifies to which phase each **Feature** belongs | -| Ensemble Attribute Array | CrystalStructures | uint32_t | (1) | Enumeration representing the crystal structure for each Ensemble | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Ensemble Attribute Array | GBDC | Double | (n,m,l,o,q,r) | 5 parameter GBCD data. The 6th component is used internally to track the northern vs. southern hemisphere of the Lambert sphere | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -48,6 +18,6 @@ Image + Triangle 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. diff --git a/src/Plugins/OrientationAnalysis/docs/FindGBCDMetricBasedFilter.md b/src/Plugins/OrientationAnalysis/docs/FindGBCDMetricBasedFilter.md index ba850f8705..8ad3ff6fd9 100644 --- a/src/Plugins/OrientationAnalysis/docs/FindGBCDMetricBasedFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/FindGBCDMetricBasedFilter.md @@ -38,39 +38,11 @@ Output files are formatted to be readable by GMT plotting program. The first lin Then, the directions are given as [ sin θ × cos φ , sin θ × sin φ , cos θ ]. -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Phase of Interest | int32_t | Index of the **Ensemble** for which to compute GBCD; boundaries having grains of this phase on both its sides will only be taken into account | -| Fixed Misorientation | float (4x) | Axis-angle representation of the misorientation of interest. Angle value should be in degrees. | -| Limiting Distances | float | ρm and ρp as defined above | -| Number of Sampling Points | int32_t | The **approximate** number of sampling directions | -| Exclude Triangles Directly Neighboring Triple Lines | bool | If checked, only interiors of **Faces** are included in GBCD | -| Output Distribution File | File Path | The output file path (extension .dat, GMT format) | -| Output Distribution Errors File | File Path | The output file path (extension .dat, GMT format) | -| Save Relative Errors Instead of Their Absolute Values | bool | What type of errors to save (see above description for more detail) | - -## Required Geometry - -Image + Triangle - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|-------|--------------|-------------|---------|-----| -| Vertex Attribute Array** | NodeTypes | int8_t | (1) | Specifies the type of node in the Geometry -| Face Attribute Array | FaceLabels | int32_t | (2) | Specifies which Features are on either side of each Face | -| Face Attribute Array | FaceNormals | double | (3) | Specifies the normal of each Face | -| Face Attribute Array | FaceAreas | double | (1) | Specifies the area of each Face | -| Feature Attribute Array | FaceLabels | int32_t | (2) | Specifies which *original* Features are on either side of each boundary **Feature | -| Feature Attribute Array | AvgEulerAngles | float | (3) | Three angles defining the orientation of the Feature in Bunge convention (Z-X-Z) | -| Feature Attribute Array | Phases | int32_t | (1) | Specifies to which phase each Feature belongs | -| Ensemble Attribute Array | CrystalStructures | uint32_t | (1) | Enumeration representing the crystal structure for each Ensemble | ## Feedback In the case of any questions, suggestions, bugs, etc., please feel free to email the author of this **Filter** at kglowinski *at* ymail.com +% Auto generated parameter table will be inserted here ## References @@ -86,6 +58,6 @@ This pipeline depends on previous pipelines in the Small IN100 reconstruction pi 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. diff --git a/src/Plugins/OrientationAnalysis/docs/FindGBPDMetricBasedFilter.md b/src/Plugins/OrientationAnalysis/docs/FindGBPDMetricBasedFilter.md index 39035cbe61..72134d7388 100644 --- a/src/Plugins/OrientationAnalysis/docs/FindGBPDMetricBasedFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/FindGBPDMetricBasedFilter.md @@ -18,34 +18,6 @@ is the relative error of the distribution function at a given point, *f* is the See also the documentation for {ref}`Find GBCD (Metric-based Approach) Filter ` for additional information. -## Parameters - -| Name | Type | Description | -|----------|------|-----------------------| -| Phase of Interest | int32_t | Index of the **Ensemble** for which to compute GBPD; boundaries having grains of this phase on both its sides will only be taken into account | -| Limiting Distance | float | ρp as defined above | -| Number of Sampling Points | int32_t | The **approximate** number of sampling directions | -| Exclude Triangles Directly Neighboring Triple Lines | bool | Only interiors of **Faces** are included in GBPD | -| Output Distribution File | File Path | The output file path (extension .dat, GMT format) | -| Output Distribution Errors File | File Path | The output file path (extension .dat, GMT format) | -| Save Relative Errors Instead of Their Absolute Values | bool | What type of errors to save (see above description for more detail) | - -## Required Geometry - -Image + Triangle - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|-------|--------------|-------------|---------|-----| -| Ensemble Attribute Array | CrystalStructures | uint32_t | (1) | Enumeration representing the crystal structure for each Ensemble | -| Feature Attribute Array | AvgEulerAngles | float | (3) | Three angles defining the orientation of the **Feature** in Bunge convention (Z-X-Z) | -| Feature Attribute Array | Phases | int32_t | (1) | Specifies to which phase each **Feature** belongs | -| Face Attribute Array | FaceLabels | int32_t | (2) | Specifies which **Features** are on either side of each Face | -| Face Attribute Array | FaceNormals | double | (3) | Specifies the normal of each Face | -| Face Attribute Array | FaceAreas | double | (1) | Specifies the area of each Face | -| Feature Face Attribute Array** | FaceLabels | int32_t | (2) | Specifies to which phase each **Face Feature** belongs | -| Vertex Attribute Array** | NodeTypes | int8_t | (1) | Specifies the type of node in the Geometry ## Format of Output Files @@ -60,6 +32,7 @@ Then, the directions are given as [ sin θ × cos φ , sin θ ## Feedback In the case of any questions, suggestions, bugs, etc., please feel free to email the author of this **Filter** at kglowinski *at* ymail.com +% Auto generated parameter table will be inserted here ## References @@ -71,6 +44,6 @@ In the case of any questions, suggestions, bugs, etc., please feel free to email 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. diff --git a/src/Plugins/OrientationAnalysis/docs/FindKernelAvgMisorientationsFilter.md b/src/Plugins/OrientationAnalysis/docs/FindKernelAvgMisorientationsFilter.md index 69ace7f343..13d33f12be 100644 --- a/src/Plugins/OrientationAnalysis/docs/FindKernelAvgMisorientationsFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/FindKernelAvgMisorientationsFilter.md @@ -13,30 +13,7 @@ This **Filter** determines the Kernel Average Misorientation (KAM) for each **Ce *Note:* All **Cells** in the kernel are weighted equally during the averaging, though they are not equidistant from the central **Cell**. -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Kernel Radius | int32_t (3x) | Size of the kernel in the X, Y and Z directions (in number of **Cells**) | - -## 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 | -| Cell Attribute Array** | Phases | int32_t | (1) | Specifies to which **Ensemble** each **Cell** belongs | -| Cell Attribute Array | Quats | float | (4) | Specifies the orientation of the **Cell** in quaternion representation | -| Ensemble Attribute Array | CrystalStructures | uint32_t | (1) | Enumeration representing the crystal structure for each Ensemble | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Cell Attribute Array | KernelAverageMisorientations | float | (1) | Average misorientation (in Degrees) for all **Cells** within the kernel and the central **Cell | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -47,6 +24,6 @@ Image 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. diff --git a/src/Plugins/OrientationAnalysis/docs/FindMisorientationsFilter.md b/src/Plugins/OrientationAnalysis/docs/FindMisorientationsFilter.md index 6ca3de8c29..a2cfa2b46a 100644 --- a/src/Plugins/OrientationAnalysis/docs/FindMisorientationsFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/FindMisorientationsFilter.md @@ -14,31 +14,7 @@ The user can also calculate the average misorientation between the feature and a **NOTE:** Only features with identical crystal structures will be calculated. If two features have different crystal structures then a value of NaN is set for the misorientation. -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Find Average Misorientation Per Feature | bool | Specifies if the *average* of the misorienations with the neighboring **Features** should be stored for each **Feature | - -## Required Geometry - -Not Applicable - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Feature Attribute Array | NeighborLists | List of int32_t | (1) | List of the contiguous neighboring **Features** for a given **Feature | -| Feature Attribute Array | AvgQuats | float | (4) | Defines the average orientation of the **Feature** in quaternion representation | -| Feature Attribute Array | Phases | int32_t | (1) | Specifies to which **Ensemble** each **Feature** belongs | -| Ensemble Attribute Array | CrystalStructures | uint32_t | (1) | Enumeration representing the crystal structure for each Ensemble | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Feature Attribute Array | MisorientationLists | List of float | (1) | List of the misorientation angles with the contiguous neighboring **Features** for a given **Feature | -| Feature Attribute Array | AvgMisorientation | float | (1) | Number weighted average of neighbor misorientations. Only created if *Find Average Misorientation Per Feature* is checked | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -48,6 +24,6 @@ Not Applicable 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. diff --git a/src/Plugins/OrientationAnalysis/docs/FindSchmidsFilter.md b/src/Plugins/OrientationAnalysis/docs/FindSchmidsFilter.md index fe3b3a662d..7500f03888 100644 --- a/src/Plugins/OrientationAnalysis/docs/FindSchmidsFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/FindSchmidsFilter.md @@ -14,37 +14,7 @@ Schmid Factor = (cos φ cos λ) The **Filter** determines the Schmid factor for each **Feature** by using the above equation for all possible slip systems (given the **Feature's** crystal structure). The largest Schmid factor from all of the slip systems is stored for the **Feature**. Only the Schmid factor is used in determining which slip system's Schmid factor to report. The critical resolved shear stress for the different slip systems is not considered. -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Loading Direction | float (3x) | The loading axis for the sample | -| Store Angle Components of Schmid Factor | bool | Whether to store the φ and λ for each **Feature | -| Override Default Slip System | bool | Allows the user to manually input the slip plane and slip direction | -| Slip Plane | float (3x) | Vector defining the slip plane normal. Only needed if *Override Default Slip System* is checked | -| Slip Direction | float (3x) | Vector defining the slip direction. Only needed if *Override Default Slip System* is checked | - -## Required Geometry - -Not Applicable - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Feature Attribute Array | Phases | int32_t | (1) | Specifies to which **Ensemble** each **Feature** belongs | -| Feature Attribute Array | AvgQuats | float | (4) | Specifies the average orienation of each **Feature** in quaternion representation | -| Ensemble Attribute Array | CrystalStructures | uint32_t | (1) | Enumeration representing the crystal structure for each Ensemble | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Feature Attribute Array | Schmids | Float | (1) | Value of the Schmid factor for the most favorably oriented slip system (i.e., the one with the highest Schmid factor) | -| Feature Attribute Array | SlipSystems | Int | (1) | Enumeration of the slip system that has the highest Schmid factor | -| Feature Attribute Array | Poles | Ints | (3) | Specifies the crystallographic pole that points along the user defined loading direction | -| Feature Attribute Array | SchmidPhis | Float | (1) | Angle between tensile axis and slip plane normal. Only created if *Store Angle Components of Schmid Factor* is checked | -| Feature Attribute Array | SchmidLambdas | Float | (1) | Angle between tensile axis and splid drirection. Only created if *Store Angle Components of Schmid Factor* is checked | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -54,6 +24,6 @@ Not Applicable 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. diff --git a/src/Plugins/OrientationAnalysis/docs/FindShapesFilter.md b/src/Plugins/OrientationAnalysis/docs/FindShapesFilter.md index deea91d789..493c7a267e 100644 --- a/src/Plugins/OrientationAnalysis/docs/FindShapesFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/FindShapesFilter.md @@ -17,31 +17,7 @@ This **Filter** calculates the second-order moments of each **Feature** in order 7. Determine the Euler angles required to represent the *principal axis directions* in the *sample reference frame* and store them as the **Feature**'s *Axis Euler Angles*. 8. Calculate the moment variant Omega3 as definied in [2] and is discussed further in [1] and [3] -## Parameters - -None - -## 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 | -| Feature Attribute Array | Centroids | float | (3) | X, Y, Z coordinates of **Feature** center of mass | -| Attribute Matrix | CellFeatureData | Cell Feature | N/A | Feature Attribute Matrix** of the selected *Feature Ids* | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Feature Attribute Array | AspectRatios | float | (2) | Ratio of semi-axis lengths (b/a and c/a) for best-fit ellipsoid to **Feature | -| Feature Attribute Array | AxisEulerAngles | float | (3) | Euler angles (in radians) necessary to rotate the sample reference frame to the reference frame of the **Feature**, where the prinicpal axes of the best-fit ellipsoid are (X, Y, Z) | -| Feature Attribute Array | SemiAxisLengths | float | (3) | Semi-axis lengths (a, b, c) for best-fit ellipsoid to **Feature | -| Feature Attribute Array | Omega3s | float | (1) | 3rd invariant of the second-order moment matrix for the **Feature**, does not assume a shape type (i.e., ellipsoid) | -| Feature Attribute Array | Volumes | float | (1) | The volume of each **Feature | +% Auto generated parameter table will be inserted here ## References ## @@ -62,6 +38,6 @@ Image 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. diff --git a/src/Plugins/OrientationAnalysis/docs/FindSlipTransmissionMetricsFilter.md b/src/Plugins/OrientationAnalysis/docs/FindSlipTransmissionMetricsFilter.md index cd23ff62dd..cfbaf5453c 100644 --- a/src/Plugins/OrientationAnalysis/docs/FindSlipTransmissionMetricsFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/FindSlipTransmissionMetricsFilter.md @@ -17,31 +17,7 @@ This **Filter** calculates a suite of *slip transmission metrics* that are relat *Note:* The transmission metrics are calculated using the average orientations for neighboring **Features** and not the local orientation near the boundary. Also, the metrics are calculated twice (i.e., when **Feature** 1 has neighbor **Feature** 2 and when **Feature** 2 has neighbor **Feature** 1) because the direction across the boundary between the **Features** affects the value of the metric. -## Parameters - -None - -## Required Geometry - -Not Applicable - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Feature Attribute Array | NeighborList | List of int32 | (1) | List of the contiguous neighboring **Features** for a given **Feature | -| Feature Attribute Array | AvgQuats | float32 | (4) | Specifies the average orienation of each **Feature** in quaternion representation | -| Feature Attribute Array | Phases | int32 | (1) | Specifies to which **Ensemble** each **Feature** belongs | -| Ensemble Attribute Array | CrystalStructures | uint32 | (1) | Enumeration representing the crystal structure for each Ensemble | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Feature Attribute Array | F1s | float32 | (2) | | -| Feature Attribute Array | F1spts | float32 | (2) | | -| Feature Attribute Array | F7s | float32 | (2) | | -| Feature Attribute Array | mPrimes | float32 | (2) | | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -49,6 +25,6 @@ Not Applicable 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. diff --git a/src/Plugins/OrientationAnalysis/docs/FindTriangleGeomShapesFilter.md b/src/Plugins/OrientationAnalysis/docs/FindTriangleGeomShapesFilter.md index 8c6024ff31..78e160bdb8 100644 --- a/src/Plugins/OrientationAnalysis/docs/FindTriangleGeomShapesFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/FindTriangleGeomShapesFilter.md @@ -30,31 +30,7 @@ for determining the moments and these values is as follows: represented, resulting in inaccurate Omega3 values. This problem is especially apparent for perfect rectangular prisms, but any shape with clear sharp corners may be affected. -## Parameters - -None - -## Required Geometry - -Triangle - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|-----------------------------|-----------------|--------------|-------------|--------------------------------------------------------------------| -| Face Attribute Array** | FaceLabels | int32_t | (2) | Specifies which **Features** are on either side of each **Face** | -| Feature Attribute Array | Centroids | float | (3) | Coordinates of the center of mass for a given enclosed **Feature | -| Feature Attribute Array | Volumes | float | (1) | Volume of the enclosed **Feature** | -| Attribute Matrix** | FaceFeatureData | Face Feature | N/A | Feature Attribute Matrix** of the selected _Face Labels | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|-----------------------------|-----------------|-------|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Feature Attribute Array | AspectRatios | float | (2) | Ratio of axis lengths (b/a and c/a) for best-fit ellipsoid to enclosed **Feature** | -| Feature Attribute Array | AxisEulerAngles | float | (3) | Euler angles (in radians) necessary to rotate the sample reference frame to the reference frame of the enclosed **Feature**, where the principal axes of the best-fit ellipsoid are (X, Y, Z) | -| Feature Attribute Array | AxisLengths | float | (3) | Axis lengths (a, b, c) for best-fit ellipsoid to enclosed **Feature** | -| Feature Attribute Array | Omega3s | float | (1) | 3rd invariant of the second-order moment matrix for the enclosed **Feature**, does not assume a shape type (i.e., ellipsoid) | +% Auto generated parameter table will be inserted here ## References ## @@ -76,6 +52,6 @@ Polycrystalline Microstructures, Part 1: Statistical Characterization Acta Mater 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. diff --git a/src/Plugins/OrientationAnalysis/docs/GenerateFZQuaternions.md b/src/Plugins/OrientationAnalysis/docs/GenerateFZQuaternions.md index 2627e20bf1..05fe3e61ca 100644 --- a/src/Plugins/OrientationAnalysis/docs/GenerateFZQuaternions.md +++ b/src/Plugins/OrientationAnalysis/docs/GenerateFZQuaternions.md @@ -17,25 +17,6 @@ The following figures represent a BCC Interstitial steel EBSD data set courtesy | ![ ](Images/GenerateFZQuats_1.png) | ![ ](Images/GenerateFZQuats_2.png) | | EBSD Dataset **before** the filter. IPF Colors are using a reference direction of < 001 >. The data is visualized in the 3D stereographic unit spheres with a superimposed Rodrigues Fundamental Zone. | EBSD Dataset **after** the filter. IPF Colors are using a reference direction of < 001 >. The data is visualized in the 3D stereographic unit spheres with a superimposed Rodrigues Fundamental Zone. | -## Parameters - -| Name | Type | Description | -|------|------|------| -| Apply to Good Elements Only (Bad Elements Will Be Black) | bool | Whether to assign a black color to "bad" **Elements | - -## Required Geometry - -Not Applicable - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Element Attribute Array | Quaternions | float | (4) | Quaternions ordered as (< x, y, z >, w) | -| Element Attribute Array | Phases | int32_t | (1) | Phase Id specifying the phase of the **Element | -| Element Attribute Array | Mask | bool | (1) | Used to define **Elements** as *good* or *bad*. Only required if *Apply to Good Elements Only (Bad Elements Will Be Black)* is checked | -| Ensemble Attribute Array | CrystalStructures | uint32_t | (1) | Enumeration representing the crystal structure for each **Ensemble**. | - ### Crystal Structure Table | String Name | Internal Value | Laue Name | @@ -53,11 +34,7 @@ Not Applicable | Trigonal_High | 10 | Trigonal-High -3m | | UnknownCrystalStructure | 999 | Undefined Crystal Structure | -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Element Attribute Array | FZ Quaternions | float | (4) | The Quaternion that represents an orientation within the fundamental zone for each **Element | +% Auto generated parameter table will be inserted here ## References @@ -70,6 +47,6 @@ Not Applicable 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. diff --git a/src/Plugins/OrientationAnalysis/docs/GenerateFaceIPFColoringFilter.md b/src/Plugins/OrientationAnalysis/docs/GenerateFaceIPFColoringFilter.md index 2b29480c4e..f421cb4449 100644 --- a/src/Plugins/OrientationAnalysis/docs/GenerateFaceIPFColoringFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/GenerateFaceIPFColoringFilter.md @@ -14,29 +14,7 @@ This **Filter** generates a pair of colors for each **Triangle** in a **Triangle ------------ -## Parameters - -None - -## Required Geometry - -Image + Triangle - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Face Attribute Array | FaceLabels | int32_t | (2) | Specifies which **Features** are on either side of each Face | -| Face Attribute Array | FaceNormals | double | (3) | Specifies the normal of each Face | -| Feature Attribute Array | AvgEulerAngles | float | (3) | Three angles defining the orientation of the **Feature** in Bunge convention (Z-X-Z) | -| Feature Attribute Array | Phases | int32_t | (1) | Specifies to which phase each **Feature** belongs | -| Ensemble Attribute Array | CrystalStructures | uint32_t | (1) | Enumeration representing the crystal structure for each Ensemble | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Face Attribute Array | IPFColors | uint8_t | (6) | A set of two RGB color schemes encoded as unsigned chars for each Face | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -46,6 +24,6 @@ Image + Triangle 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. diff --git a/src/Plugins/OrientationAnalysis/docs/GenerateFaceMisorientationColoringFilter.md b/src/Plugins/OrientationAnalysis/docs/GenerateFaceMisorientationColoringFilter.md index 6b61d2a8fb..e62d9e8596 100644 --- a/src/Plugins/OrientationAnalysis/docs/GenerateFaceMisorientationColoringFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/GenerateFaceMisorientationColoringFilter.md @@ -8,28 +8,7 @@ Processing (Crystallography) This **Filter** generates a 3 component vector for each **Triangle** in a **Triangle Geometry** that is the axis-angle of the misorientation associated with the **Features** that lie on either side of the **Triangle**. The axis is normalized, so if the magnitude of the vector is viewed, it will be the *misorientation angle* in degrees. -## Parameters - -None - -## Required Geometry - -Image + Triangle - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Face Attribute Array | FaceLabels | int32_t | (2) | Specifies which **Features** are on either side of each Face | -| Feature Attribute Array | AvgQuats | float | (4) | Specifies the average orientation of each **Feature** in quaternion representation | -| Feature Attribute Array | Phases | int32_t | (1) | Specifies to which phase each **Feature** belongs | -| Ensemble Attribute Array | CrystalStructures | uint32_t | (1) | Enumeration representing the crystal structure for each Ensemble | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Face Attribute Array | MisorientationColors | float | (3) | A set of RGB color schemes encoded as floats for each Face | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -39,6 +18,6 @@ Image + Triangle 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. diff --git a/src/Plugins/OrientationAnalysis/docs/GenerateGBCDPoleFigureFilter.md b/src/Plugins/OrientationAnalysis/docs/GenerateGBCDPoleFigureFilter.md index 380dc9b29d..1ddbd6ae8f 100644 --- a/src/Plugins/OrientationAnalysis/docs/GenerateGBCDPoleFigureFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/GenerateGBCDPoleFigureFilter.md @@ -12,32 +12,7 @@ This **Filter** creates a pole figure from the Grain Boundary Character Distribu ![Using ParaView's Threshold filter + Cells to Points + Delaunay2D Filters](Images/Small_IN100_GBCD_Delaunay2D.png) -## Parameters - -| Name | Type | Description | -|----------|------|-----------------------| -| Phase of Interest | int32 | Index of the **Ensemble** for which to plot the pole figure | -| Misorientation Axis-Angle | float (4x) | Axis-Angle pair values for drawing GBCD in the order of Axis (Degrees) then Axis (Normalized)| -| Output Image Dimension | int32 | The value to use for the x and y dimensions of the created Image Geometry | - -## Required Geometry - -Triangle - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Ensemble Attribute Array | GBDC | double | (n,m,l,o,q,r) | 5 parameter GBCD data. The 6th component is used internally to track the northern vs. southern hemisphere of the Lambert sphere | -| Crystal Structure | CrystalStructures | Enumeration | 1 | Crystal structure for GBCD. Currently supports from Hexagonal-High 6/mmm or Cubic-High m-3m symmetries | - -## Created Objects - -| Kind | Default Name | Description | -|------|--------------|-------------| -| Image Geometry | [ImageGeometry] | The Image Geometry to be created | -| Cell Attribute Matrix | Cell Data | The name of the cell attribute matrix created for the Image Geometry | -| Cell Intensity Array | Intensity | The data array to be created from the pole figures and stored in the Image Geometry cell attribute matrix | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -47,6 +22,6 @@ Triangle 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. diff --git a/src/Plugins/OrientationAnalysis/docs/GenerateIPFColorsFilter.md b/src/Plugins/OrientationAnalysis/docs/GenerateIPFColorsFilter.md index f26fb708b5..3e4ba1d82b 100644 --- a/src/Plugins/OrientationAnalysis/docs/GenerateIPFColorsFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/GenerateIPFColorsFilter.md @@ -21,31 +21,7 @@ This **Filter** will generate *inverse pole figure* (IPF) colors for cubic, hexa ![Example Data Set](Images/IPFColor_1.png) -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Reference Direction | float (3x) | The reference axis with respect to compute the IPF colors | -| Apply to Good Elements Only (Bad Elements Will Be Black) | bool | Whether to assign a black color to "bad" **Elements | - -## Required Geometry - -Not Applicable - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Element Data Array | Euler Angles | float | (3) | Three angles defining the orientation of the **Element** in Bunge convention (Z-X-Z) | -| Element Data Array | Phases | int32 | (1) | Phase Id specifying the phase of the **Element | -| Element Data Array | Mask | bool | (1) | Used to define **Elements** as *good* or *bad*. Only required if *Apply to Good Elements Only (Bad Elements Will Be Black)* is checked | -| Ensemble Data Array | Crystal Structures | uint32 | (1) | Enumeration representing the crystal structure for each Ensemble | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Element Data Array | IPFColor | uint8 | (3) | The RGB colors encoded as unsigned chars for each **Element | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -68,6 +44,6 @@ Not Applicable 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. diff --git a/src/Plugins/OrientationAnalysis/docs/GeneratePoleFigureFilter.md b/src/Plugins/OrientationAnalysis/docs/GeneratePoleFigureFilter.md index 0aebbea2cd..6e329a8cf7 100644 --- a/src/Plugins/OrientationAnalysis/docs/GeneratePoleFigureFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/GeneratePoleFigureFilter.md @@ -60,6 +60,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. diff --git a/src/Plugins/OrientationAnalysis/docs/GenerateQuaternionConjugateFilter.md b/src/Plugins/OrientationAnalysis/docs/GenerateQuaternionConjugateFilter.md index 69b1e51257..e69b2167c0 100644 --- a/src/Plugins/OrientationAnalysis/docs/GenerateQuaternionConjugateFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/GenerateQuaternionConjugateFilter.md @@ -15,27 +15,7 @@ transformation. If the incoming data was collected in such a way that the orient Quats, Eulers, Orientation Matrix, Rodrigues) was assumed to be a **Crystal to Sample** transformation then this filter can be applied to a quaternion to convert into a reference frame that DREAM.3D assumes. -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Delete Original Array | Boolean | Set this to TRUE/ON to have the original 3 component data array deleted at the end of the filter. | - -## Required Geometry - -Not Applicable - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------|------------------|-------|-------------|-------------| -| Attribute Array | Quaternion Input | float | (4) | | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------|------------------|-------|-------------|-------------| -| Attribute Array | Quaternion Ouput | float | (4) | | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -43,6 +23,6 @@ Not Applicable 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. diff --git a/src/Plugins/OrientationAnalysis/docs/INLWriterFilter.md b/src/Plugins/OrientationAnalysis/docs/INLWriterFilter.md index 258a94485c..7d7981a18c 100644 --- a/src/Plugins/OrientationAnalysis/docs/INLWriterFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/INLWriterFilter.md @@ -64,30 +64,7 @@ Some information about the phase is included in the header section of the file i 0.266234 0.697020 4.434729 -34.750004 10.250000 -29.000000 639 1 43 0.266234 0.697020 4.434729 -34.500004 10.250000 -29.000000 639 1 43 -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Output File | File Path | The output .inl file path | - -## Required Geometry - -Image - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Cell Attribute Array | FeatureIds | int32 | (1) | Specifies to which **Feature** each **Cell** belongs | -| Cell Attribute Array | Phases | int32 | (1) | Specifies to which **Ensemble** each **Cell** belongs | -| Cell Attribute Array | EulerAngles | float32 | (3) | Three angles defining the orientation of the **Cell** in Bunge convention (Z-X-Z) | -| Ensemble Attribute Array | CrystalStructures | uint32 | (1) | Enumeration representing the crystal structure for each Ensemble | -| Ensemble Attribute Array | Material Names | String | (1) | Name of each Ensemble | -| Ensemble Attribute Array | Number of Features | int32 | (1) | The number of **Features** per Ensemble | - -## Created Objects - -None +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -97,6 +74,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. diff --git a/src/Plugins/OrientationAnalysis/docs/ImportH5EspritDataFilter.md b/src/Plugins/OrientationAnalysis/docs/ImportH5EspritDataFilter.md index 9684414bab..5493adfbc0 100644 --- a/src/Plugins/OrientationAnalysis/docs/ImportH5EspritDataFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/ImportH5EspritDataFilter.md @@ -30,66 +30,7 @@ If the data has come from a TSL acquisition system and the settings of the acqui The user also may want to assign un-indexed pixels to be ignored by flagging them as "bad". The {ref}`Threshold Objects ` Filter can be used to define this *mask* by thresholding on values such as *MAD* > xx. -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Input File | File Path | The input .h5 file path | -| Scan Name | Enumeration | The name of the scan in the .h5 file. EDAX can store multiple scans in a single file | -| Z Spacing | float | The spacing in microns between each layer. | -| Origin | float (3x1) | The origin of the volume | -| Read Pattern Data | bool | Default=OFF | -| Combine phi1, PHI, phi2 into Single Euler Angles Attribute Array | bool | Default=ON | -| Convert Euler Angles to Radians | bool | Default=ON | - -## Required Geometry - -Not Applicable - -## Required Objects - -None - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Data Container | ImageDataContainer | N/A | N/A | Created **Data Container** name with an **Image Geometry | -| Attribute Matrix** | CellData | Cell | N/A | Created **Cell Attribute Matrix** name | -| Attribute Matrix** | CellEnsembleData | Cell Ensemble | N/A | Created **Cell Ensemble Attribute Matrix** name | - -### Created Cell Attribute Arrays - -These arrays will **most likely** be created but is not guaranteed. Additional arrays (unknown at the time of writing) may also be created. - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Cell Attribute Array | DD | float | (1) | | -| Cell Attribute Array | MAD | float | (1) | Mean Angular Deviation | -| Cell Attribute Array | MADPhase | int | (1) | | -| Cell Attribute Array | NIndexedBands | int | (1) | | -| Cell Attribute Array | PCX | float | (1) | Pattern Center X | -| Cell Attribute Array | PCY | float | (1) | Pattern Center Y | -| Cell Attribute Array | Phase | int | (1) | | -| Cell Attribute Array | RadonBandCount | int | (1) | | -| Cell Attribute Array | RadonQuality | float | (1) | | -| Cell Attribute Array | RawPatterns | float | (1) | | -| Cell Attribute Array | XBEAM | int | (1) | | -| Cell Attribute Array | YBEAM | int | (1) | | -| Cell Attribute Array | XSAMPLE | float | (1) | | -| Cell Attribute Array | YSAMPLE | float | (1) | | -| Cell Attribute Array | Euler Angles | float | (3) | Note the filter will create the Euler Angles array by interleaving the phi1, PHI and phi2 data arrays from the data file. | -| Cell Attribute Array | Pattern | uint8_t | (NxM) | The pattern data may be very large. There is an option to NOT read it into DREAM.3D if it is not needed by the analysis. | - -### Created Ensemble Attribute Arrays - -These arrays will **most likely** be created but is not guaranteed. Additional arrays (unknown at the time of writing) may also be created. - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Ensemble Attribute Array | CrystalStructures | uint32_t | (1) | Enumeration representing the crystal structure for each Ensemble | -| Ensemble Attribute Array | LatticeConstants | float | (6) | The 6 values that define the lattice constants for each **Ensemble**| -| Ensemble Attribute Array | MaterialName | String | (1) | Name of each Ensemble | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -97,6 +38,6 @@ These arrays will **most likely** be created but is not guaranteed. Additional a 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. diff --git a/src/Plugins/OrientationAnalysis/docs/ImportH5OimDataFilter.md b/src/Plugins/OrientationAnalysis/docs/ImportH5OimDataFilter.md index 087d5d3e2b..e7a7ce7643 100644 --- a/src/Plugins/OrientationAnalysis/docs/ImportH5OimDataFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/ImportH5OimDataFilter.md @@ -33,57 +33,7 @@ the user should **CHECK** the option **ON** for "Perform Slice By Slice Transfor The user also may want to assign un-indexed pixels to be ignored by flagging them as "bad". The {ref}`Threshold Objects ` **Filter** can be used to define this *mask* by thresholding on values such as *Confidence Index* > xx or *Image Quality* > desired quality. -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Input File | File Path | The input .h5 file path | -| Scan Name | Enumeration | The name of the scan in the .h5 file. EDAX can store multiple scans in a single file | -| Z Spacing | float | The spacing in microns between each layer. | -| Origin | float (3x1) | The origin of the volume | -| Read Pattern Data | bool | Default=OFF | - -## Required Geometry - -Not Applicable - -## Required Objects - -None - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Data Container | ImageDataContainer | N/A | N/A | Created **Data Container** name with an **Image Geometry | -| Attribute Matrix** | CellData | Cell | N/A | Created **Cell Attribute Matrix** name | -| Attribute Matrix** | CellEnsembleData | Cell Ensemble | N/A | Created **Cell Ensemble Attribute Matrix** name | - -### Created Cell Attribute Arrays - -These arrays will **most likely** be created but is not guaranteed. Additional arrays (unknown at the time of writing) may also be created. - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Cell Attribute Array | Confidence Index | float |(1) | Confidence of indexing | -| Cell Attribute Array | EulerAngles | float |(3) | Three angles defining the orientation of the **Cell** in Bunge convention (Z-X-Z) | -| Cell Attribute Array | Fit | float |(1) | Quality of fit for indexing | -| Cell Attribute Array | Image Quality | float |(1) | Quality of image | -| Cell Attribute Array | Phases | int32_t | (1) | Specifies to which phase each **Cell** belongs | -| Cell Attribute Array | SEM Signal | float |(1) | Value of SEM signal | -| Cell Attribute Array | X Position | float |(1) | X coordinate of **Cell** | -| Cell Attribute Array | Y Position | float |(1) | Y coordinate of **Cell** | -| Cell Attribute Array | Pattern | uint8_t | (NxM) | The pattern data may be very large. There is an option to NOT read it into DREAM.3D if it is not needed by the analysis. | - -### Created Ensemble Attribute Arrays - -These arrays will **most likely** be created but is not guaranteed. Additional arrays (unknown at the time of writing) may also be created. - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Ensemble Attribute Array | CrystalStructures | uint32_t | (1) | Enumeration representing the crystal structure for each Ensemble | -| Ensemble Attribute Array | LatticeConstants | float | (6) | The 6 values that define the lattice constants for each **Ensemble**| -| Ensemble Attribute Array | MaterialName | String | (1) | Name of each Ensemble | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -91,6 +41,6 @@ These arrays will **most likely** be created but is not guaranteed. Additional a 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. diff --git a/src/Plugins/OrientationAnalysis/docs/MergeTwinsFilter.md b/src/Plugins/OrientationAnalysis/docs/MergeTwinsFilter.md index 9da15390a9..c41f90024d 100644 --- a/src/Plugins/OrientationAnalysis/docs/MergeTwinsFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/MergeTwinsFilter.md @@ -10,36 +10,7 @@ Reconstruction (Grouping) This **Filter** groups neighboring **Features** that are in a twin relationship with each other (currently only FCC σ = 3 twins). The algorithm for grouping the **Features** is analogous to the algorithm for segmenting the **Features** - only the average orientation of the **Features** are used instead of the orientations of the individual **Elements**. The user can specify a tolerance on both the *axis* and the *angle* that defines the twin relationship (i.e., a tolerance of 1 degree for both tolerances would allow the neighboring **Features** to be grouped if their misorientation was between 59-61 degrees about an axis within 1 degree of <111>, since the Sigma 3 twin relationship is 60 degrees about <111>). -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Axis Tolerance (Degrees) | float | Tolerance allowed when comparing the axis part of the axis-angle representation of the misorientation | -| Angle Tolerance (Degrees) | float | Tolerance allowed when comparing the angle part of the axis-angle representation of the misorientation | - -## Required Geometry - -Not Applicable - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Feature Attribute Array | NonContiguousNeighbors | List of int32_t | (1) | List of non-contiguous neighbors for each **Feature**. Only needed if *Use Non-Contiguous Neighbors* is checked | -| Feature Attribute Array | NeighborList | List of int32_t | (1) | List of neighbors for each **Feature | -| Element Attribute Array | FeatureIds | int32_t | (1) | Specifies to which **Feature** each **Element** belongs | -| Feature Attribute Array | Phases | int32_t | (1) | Specifies to which **Ensemble** each **Feature** belongs | -| Feature Attribute Array | AvgQuats | float| (4) | Specifies the average orientation of the **Feature** in quaternion representation | -| Ensemble Attribute Array | CrystalStructures | uint32_t | (1) | Enumeration representing the crystal structure for each Ensemble | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Element Attribute Array | ParentIds | int32_t | (1) | Specifies to which *parent* each **Element** belongs | -| Attribute Matrix | NewFeatureData | Feature | N/A | Created **Feature Attribute Matrix** name | -| Feature Attribute Array | ParentIds | int32_t | (1) | Specifies to which *parent* each **Feature** belongs | -| Feature Attribute Array | Active | bool | (1) | Specifies if the **Feature** is still in the sample (*true* if the **Feature** is in the sample and *false* if it is not). At the end of the **Filter**, all **Features** will be *Active* | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -50,6 +21,6 @@ Not Applicable 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. diff --git a/src/Plugins/OrientationAnalysis/docs/NeighborOrientationCorrelationFilter.md b/src/Plugins/OrientationAnalysis/docs/NeighborOrientationCorrelationFilter.md index fe60d03f63..74f14f3bd0 100644 --- a/src/Plugins/OrientationAnalysis/docs/NeighborOrientationCorrelationFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/NeighborOrientationCorrelationFilter.md @@ -24,30 +24,7 @@ Schematic layout of the neighboring cells. Only the In-Plane neighbors are shown In this example cell (1,1) has a confidence index < 0.1 and the surrounding cells all have a misorientation tolerance not greater than 5 degrees. Comparing cell (1,1) with its neighbor cells we can see that the misorientation is greater than 5 Degrees. In this case the central cell (1,1) would have all of its attributes replaced with the "best" neighbor based on the phase of a neighbor cell matching the central cell. -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Minimum Confidence Index | float32 | Sets the minimum value of 'confidence' a **Cell** must have | -| Misorientation Tolerance (Degrees) | Float32 | Angular tolerance used to compare with neighboring **Cells | -| Cleanup Level | int32 | Minimum number of neighbor **Cells** that must have orientations within above tolerace to allow **Cell** to be changed | - -## Required Geometry - -Image - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Cell Attribute Array | Confidence Index | float32 | (1) | Specifies the confidence in the orientation of the **Cell** (TSL data) | -| Cell Attribute Array | Cell Phases | int32 | (1) | Specifies to which **Ensemble** each **Cell** belongs | -| Cell Attribute Array | Quaternions | float32 | (4) | Specifies the orientation of the **Cell** in quaternion representation | -| Ensemble Attribute Array | Crystal Structures | uint32 | (1) | Enumeration representing the crystal structure for each Ensemble | - -## Created Objects - -None +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -60,6 +37,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. diff --git a/src/Plugins/OrientationAnalysis/docs/ReadAngDataFilter.md b/src/Plugins/OrientationAnalysis/docs/ReadAngDataFilter.md index f61c84d143..faad519864 100644 --- a/src/Plugins/OrientationAnalysis/docs/ReadAngDataFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/ReadAngDataFilter.md @@ -17,38 +17,7 @@ If the data has come from a TSL acquisition system and the settings of the acqui The user also may want to assign un-indexed pixels to be ignored by flagging them as "bad". The Threshold Objects **Filter** can be used to define this *mask* by thresholding on values such as *Confidence Index* > 0.1 or *Image Quality* > desired quality. -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Input File | File Path | The input .ang file path | - -## Required Geometry - -Not Applicable - -## Required Objects - -None - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Data Container | ImageDataContainer | N/A | N/A | Created **Data Container** name with an **Image Geometry | -| Attribute Matrix** | CellData | Cell | N/A | Created **Cell Attribute Matrix** name | -| Attribute Matrix** | CellEnsembleData | Cell Ensemble | N/A | Created **Cell Ensemble Attribute Matrix** name | -| Cell Attribute Array | Confidence Index | float |(1) | Confidence of indexing | -| Cell Attribute Array | EulerAngles | float |(3) | Three angles defining the orientation of the **Cell** in Bunge convention (Z-X-Z) | -| Cell Attribute Array | Fit | float |(1) | Quality of fit for indexing | -| Cell Attribute Array | Image Quality | float |(1) | Quality of image | -| Cell Attribute Array | Phases | int32_t | (1) | Specifies to which phase each **Cell** belongs | -| Cell Attribute Array | SEM Signal | float |(1) | Value of SEM signal | -| Cell Attribute Array | X Position | float |(1) | X coordinate of **Cell** | -| Cell Attribute Array | Y Position | float |(1) | Y coordinate of **Cell** | -| Ensemble Attribute Array | CrystalStructures | uint32_t | (1) | Enumeration representing the crystal structure for each Ensemble | -| Ensemble Attribute Array | LatticeConstants | float | (6) | The 6 values that define the lattice constants for each **Ensemble**| -| Ensemble Attribute Array | MaterialName | String | (1) | Name of each Ensemble | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -61,6 +30,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. diff --git a/src/Plugins/OrientationAnalysis/docs/ReadCtfDataFilter.md b/src/Plugins/OrientationAnalysis/docs/ReadCtfDataFilter.md index 845bd1dd7f..615f1ee4df 100644 --- a/src/Plugins/OrientationAnalysis/docs/ReadCtfDataFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/ReadCtfDataFilter.md @@ -38,41 +38,7 @@ Most 2D .ctf files have their angles in **degrees** where as DREAM.3D expects ra | ![Figure showing 30 Degree conversions](Images/Hexagonal_Axis_Alignment.png) | | Figure 1:**showing TSL and Oxford Instr. conventions. EDAX/TSL is in **Green**. Oxford Inst. is in**Red | -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Input File | File Path |The input .ctf file path | -| Convert to Radians | bool | Should the filter convert the Eulers to Radians (Default = true)| -| Hexagonal Axis Alignment | bool | Should the filter convert a Hexagonal phase to the EDAX standard for x-axis alignment | - -## Required Geometry - -Not Applicable - -## Required Objects - -None - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Data Container | ImageDataContainer | N/A | N/A | Created **Data Container** name with an **Image Geometry | -| Attribute Matrix** | CellData | Cell | N/A | Created **Cell Attribute Matrix** name | -| Attribute Matrix** | CellEnsembleData | Cell Ensemble | N/A | Created **Cell Ensemble Attribute Matrix** name | -| Cell Attribute Array | BC | float | (1) | Band contrast levels | -| Cell Attribute Array | EulerAngles | float | (3) | Three angles defining the orientation of the **Cell** in Bunge convention (Z-X-Z) | -| Cell Attribute Array | BS | float | (1) | Band saturation levels | -| Cell Attribute Array | Bands | float | (1) | Number of bands | -| Cell Attribute Array | Phases | int32_t | (1) | Specifies to which phase each **Cell** belongs | -| Cell Attribute Array | MAD | float | (1) | Mean angular deviation. Typical threshold value is < 1.8 | -| Cell Attribute Array | X Position | float |(1) | X coordinate of **Cell** | -| Cell Attribute Array | Y Position | float |(1) | Y coordinate of **Cell** | -| Cell Attribute Array | Error | int32_t | (1) | Value = 0 is a well indexed scan point | -| Ensemble Attribute Array | CrystalStructures | uint32_t | (1) | Enumeration representing the crystal structure for each Ensemble | -| Ensemble Attribute Array | LatticeConstants | float | (6) | The 6 values that define the lattice constants for each **Ensemble**| -| Ensemble Attribute Array | MaterialName | String | (1) | Name of each Ensemble | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -87,6 +53,6 @@ Please see the description file distributed with this **Plugin** [1] Rollett, A.D. Lecture Slides located at [http://pajarito.materials.cmu.edu/rollett/27750/L17-EBSD-analysis-31Mar16.pdf](http://pajarito.materials.cmu.edu/rollett/27750/L17-EBSD-analysis-31Mar16.pdf) -## 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. diff --git a/src/Plugins/OrientationAnalysis/docs/ReadH5EbsdFilter.md b/src/Plugins/OrientationAnalysis/docs/ReadH5EbsdFilter.md index fd10b93714..aaf77140f1 100644 --- a/src/Plugins/OrientationAnalysis/docs/ReadH5EbsdFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/ReadH5EbsdFilter.md @@ -47,34 +47,7 @@ An excellant reference for this is the following PDF file: ![Figure 1 showing TSL \& Oxford Instr. conventions.](Images/Hexagonal_Axis_Alignment.png) -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Input File | File Path | The input .h5ebsd file path | -| Start Slice | Int | The first slice of data to read | -| End Slice | Int | The last slice of data to read | -| Use Recommended Transformations | bool | Whether to apply the listed recommended transformations | -| Data Arrays to Read | Bool(s) | Whether to read the listed arrays | -| Angle Representation | Int (0=Radians, 1=Degrees) | How the Euler Angles are represented. | - -## Required Geometry - -Not Applicable - -## Required Objects - -None - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Geometry | ImageGeometry | Image | N/A | Created **Image Geometry | -| Attribute Matrix | CellData | Cell | N/A | Created **Cell Attribute Matrix** name | -| Attribute Matrix | CellEnsembleData | Cell Ensemble | N/A | Created **Cell Ensemble Attribute Matrix** name | - -An array for each of the arrays selected in the *Data Arrays to Read* section will also be created. +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -96,6 +69,6 @@ Please see the description file distributed with this **Plugin** [2] Rollett, A.D. Lecture Slides located at [http://pajarito.materials.cmu.edu/rollett/27750/L17-EBSD-analysis-31Mar16.pdf](http://pajarito.materials.cmu.edu/rollett/27750/L17-EBSD-analysis-31Mar16.pdf) -## 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. diff --git a/src/Plugins/OrientationAnalysis/docs/RodriguesConvertorFilter.md b/src/Plugins/OrientationAnalysis/docs/RodriguesConvertorFilter.md index 353bcda19d..f6e0101386 100644 --- a/src/Plugins/OrientationAnalysis/docs/RodriguesConvertorFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/RodriguesConvertorFilter.md @@ -13,27 +13,7 @@ equations and algorithms. The algorithm is the following: + Divide each component by the length + Store the length as the 4th component in the output array -## Parameters - -| Name | Type | Description | -|----------|------|-----------------------| -| Delete Original Array | Boolean | Set this to TRUE/ON to have the original 3 component data array deleted at the end of the filter. | - -## Required Geometry - -Required Geometry Type -or- Not Applicable - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Attribute Array | Rodrigues Input Vector | float | (3) | | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Attribute Array | Rodrigues Ouput Vector | float | (4) | | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -43,6 +23,6 @@ List the names of the example pipelines where this filter is used. 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. diff --git a/src/Plugins/OrientationAnalysis/docs/RotateEulerRefFrameFilter.md b/src/Plugins/OrientationAnalysis/docs/RotateEulerRefFrameFilter.md index c83df81228..4a80354457 100644 --- a/src/Plugins/OrientationAnalysis/docs/RotateEulerRefFrameFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/RotateEulerRefFrameFilter.md @@ -8,25 +8,7 @@ Orientation Analysis (Conversion) This **Filter** performs a passive rotation (Right hand rule) of the Euler Angles about a user defined axis. The *reference frame* is being rotated and thus the *Euler Angles* necessary to represent the same orientation must change to account for the new *reference frame*. The user can set an *angle* and an *axis* to define the rotation of the *reference frame*. -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Rotation Axis-Angle | float (4x) | Axis-Angle in sample reference frame to rotate about. | - -## Required Geometry - -Not Applicable - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Element Data Array | EulerAngles | float | (3) | Three angles defining the orientation of the **Cell** in Bunge convention (Z-X-Z) | - -## Created Objects - -None +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -39,6 +21,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. diff --git a/src/Plugins/OrientationAnalysis/docs/WritePoleFigureFilter.md b/src/Plugins/OrientationAnalysis/docs/WritePoleFigureFilter.md index 4cd4a04d72..8688e14746 100644 --- a/src/Plugins/OrientationAnalysis/docs/WritePoleFigureFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/WritePoleFigureFilter.md @@ -24,42 +24,7 @@ The 3 pole figures can be laid out in a Square, Horizontal row or vertical colum |--------------------|----------| | ![Example Pole Figure Using Square Layout](Images/PoleFigure_Example.png) | ![Example Pole Figure Using Square Layout](Images/Pole_Figure_Discrete_Example.png) | -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Figure Title | String | The title of the figure. | -| Pole Figure Type | Enumeration: 0=Lambert, 1=Discrete | Controls the type of pole figure | -| Lambert Image Size (Pixels) | int32_t | Size of the Lambert square in pixels | -| Number of Colors | int32_t | Number of colors to use to make the pole figure | -| Image Layout | Enumeration | Layout for the resulting pole figure images, either square, horizontal, or vertical | -| Image Prefix | String | Prefix the prepend each pole figure file with | -| Output Path | File Path | Output directory path for images | -| Image Size (Square Pixels) | int32_t | Size of the output image in square pixels | -| Use Mask Array | bool | Specifies whether to use a boolean array to exclude some **Cells**. Only those cells that have a *Mask Array* value of 1 will be used. | -| Save as Image Geometry | Bool | Save the created Pole Figure as an Image Geometry | -| Output Image Geometry Path | DataPath | The DataPath to the created image geometry | - -## Required Geometry - -NONE - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Cell Attribute Array | EulerAngles | float | (3) | Three angles defining the orientation of the **Cell** in Bunge convention (Z-X-Z) | -| Cell Attribute Array | Phases | int32_t | (1) | Specifies to which **Ensemble** each **Cell** belongs | -| Cell Attribute Array | Mask | bool | (1) | Used to define **Cells** as *good* or *bad* | -| Ensemble Attribute Array | CrystalStructures | uint32_t | (1) | Enumeration representing the crystal structure for each Ensemble | - -## Created Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Geometry | ImageGeometry | Image | N/A | Created **Image Geometry | -| Attribute Matrix | CellData | Cell | N/A | Created **Cell Attribute Matrix** name | -| DataArray | Image | Data Array (uint8) | 4 | Created **DataArray** name | +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -70,6 +35,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. diff --git a/src/Plugins/OrientationAnalysis/docs/WriteStatsGenOdfAngleFileFilter.md b/src/Plugins/OrientationAnalysis/docs/WriteStatsGenOdfAngleFileFilter.md index 74e19947da..1e6c21dde4 100644 --- a/src/Plugins/OrientationAnalysis/docs/WriteStatsGenOdfAngleFileFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/WriteStatsGenOdfAngleFileFilter.md @@ -62,28 +62,7 @@ Choice of delimiter is as follows: 3 = : (colon) 4 = \t (tab) -## Parameters - -| Name | Type | Description | -|------------|------| --------------------------------- | -| Output File | File Path | Output angles file path | -| Default Weight | float | This value will be used for the Weight column | -| Default Sigma | int | This value will be used for the Sigma column | -| Delimiter | Enumeration | The delimiter separating the data | -| Convert to Degrees | bool | Whether to convert the Euler angles from radians to degrees. If the Euler angles are already in degrees, this option will "convert" the data again, resulting in garbage orientations! | -| Only Write Good Elements | bool | Whether to only write the Euler angles for those elements denoted as true in the supplied mask array | - -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------------|--------------|----------|--------|---------------------------------------------| -| Element Attribute Array | EulerAngles | float | (3) | Three angles defining the orientation of the **Element** in Bunge convention (Z-X-Z) | -| Element Attribute Array | Phases | int32_t | (1) | Specifies to which **Ensemble** each **Element** belongs | -| Element Attribute Array | Mask | bool | (1) | Used to define **Elements** as *good* or *bad*. Only required if *Only Write Good Elements* is checked | - -## Created Objects - -None +% Auto generated parameter table will be inserted here ## Example Pipelines @@ -93,6 +72,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. diff --git a/wrapping/python/docs/generate_sphinx_docs.cpp b/wrapping/python/docs/generate_sphinx_docs.cpp index 73566567cc..7a71cbe029 100644 --- a/wrapping/python/docs/generate_sphinx_docs.cpp +++ b/wrapping/python/docs/generate_sphinx_docs.cpp @@ -1,6 +1,12 @@ +#include "complex/Common/Types.hpp" +#include "complex/Common/TypesUtility.hpp" #include "complex/Core/Application.hpp" #include "complex/Filter/FilterHandle.hpp" #include "complex/Filter/IFilter.hpp" +#include "complex/Parameters/ArraySelectionParameter.hpp" +#include "complex/Parameters/GeometrySelectionParameter.hpp" +#include "complex/Parameters/VectorParameter.hpp" +#include "complex/Utilities/DataObjectUtilities.hpp" #include "complex/Utilities/FilterUtilities.hpp" #include "complex/Utilities/StringUtilities.hpp" @@ -46,16 +52,30 @@ void GenerateParameterList() ADD_PARAMETER_TRAIT(complex.DataTypeParameter, "d31358d5-3253-4c69-aff0-eb98618f851b") ADD_PARAMETER_TRAIT(complex.EnsembleInfoParameter, "10d3924f-b4c9-4e06-9225-ce11ec8dff89") ADD_PARAMETER_TRAIT(complex.ArrayThresholdsParameter, "e93251bc-cdad-44c2-9332-58fe26aedfbe") - ADD_PARAMETER_TRAIT(complex.MultiArraySelectionParameter, "d11e0bd8-f227-4fd1-b618-b6f16b259fc8") ADD_PARAMETER_TRAIT(complex.GenerateColorTableParameter, "7b0e5b25-564e-4797-b154-4324ef276bf0") ADD_PARAMETER_TRAIT(complex.DataObjectNameParameter, "fbc89375-3ca4-4eb2-8257-aad9bf8e1c94") ADD_PARAMETER_TRAIT(complex.NeighborListSelectionParameter, "ab0b7a7f-f9ab-4e6f-99b5-610e7b69fc5b") ADD_PARAMETER_TRAIT(complex.ChoicesParameter, "ee4d5ce2-9582-48fa-b182-8a766ce0feff") ADD_PARAMETER_TRAIT(complex.GeneratedFileListParameter, "aac15aa6-b367-508e-bf73-94ab6be0058b") - ADD_PARAMETER_TRAIT(complex.DataGroupCreationParameter, "bff2d4ac-04a6-5251-b188-4f83f7865074") ADD_PARAMETER_TRAIT(complex.DataPathSelectionParameter, "cd12d081-fbf0-46c4-8f4a-15e2e06e98b8") ADD_PARAMETER_TRAIT(complex.CalculatorParameter, "ba2d4937-dbec-5536-8c5c-c0a406e80f77") ADD_PARAMETER_TRAIT(complex.ImportCSVDataParameter, "4f6d6a33-48da-427a-8b17-61e07d1d5b45") + + ADD_PARAMETER_TRAIT(complex.MultiArraySelectionParameter, "d11e0bd8-f227-4fd1-b618-b6f16b259fc8") + ADD_PARAMETER_TRAIT(complex.ArraySelectionParameter, "ab047a7f-f9ab-4e6f-99b5-610e7b69fc5b") + ADD_PARAMETER_TRAIT(complex.DataGroupSelectionParameter, "bff3d4ac-04a6-5251-b178-4f83f7865074") + ADD_PARAMETER_TRAIT(complex.AttributeMatrixSelectionParameter, "a3619d74-a1d9-4bc2-9e03-ca001d65b119") + ADD_PARAMETER_TRAIT(complex.GeometrySelectionParameter, "3804cd7f-4ee4-400f-80ad-c5af17735de2") + + ADD_PARAMETER_TRAIT(complex.DataGroupCreationParameter, "bff2d4ac-04a6-5251-b188-4f83f7865074") + ADD_PARAMETER_TRAIT(complex.ArrayCreationParameter, "ab047a7d-f81b-4e6f-99b5-610e7b69fc5b") + + ADD_PARAMETER_TRAIT(complex.FileSystemPathParameter, "f9a93f3d-21ef-43a1-a958-e57cbf3b2909") + ADD_PARAMETER_TRAIT(complex.BoolParameter, "b6936d18-7476-4855-9e13-e795d717c50f") + ADD_PARAMETER_TRAIT(complex.ImportHDF5DatasetParameter, "32e83e13-ee4c-494e-8bab-4e699df74a5a") + ADD_PARAMETER_TRAIT(complex.Dream3dImportParameter, "170a257d-5952-4854-9a91-4281cd06f4f5") + ADD_PARAMETER_TRAIT(complex.DynamicTableParameter, "eea76f1a-fab9-4704-8da5-4c21057cf44e") + ADD_PARAMETER_TRAIT(complex.Int8Parameter, "cae73834-68f8-4235-b010-8bea87d8ff7a") ADD_PARAMETER_TRAIT(complex.UInt8Parameter, "6c3efeff-ce8f-47c0-83d1-262f2b2dd6cc") ADD_PARAMETER_TRAIT(complex.Int16Parameter, "44ae56e8-e6e7-4e4d-8128-dd3dc2c6696e") @@ -66,11 +86,7 @@ void GenerateParameterList() ADD_PARAMETER_TRAIT(complex.UInt64Parameter, "36d91b23-5500-4ed4-bdf3-d680f54ee5d1") ADD_PARAMETER_TRAIT(complex.Float32Parameter, "e4452dfe-2f70-4833-819e-0cbbec21289b") ADD_PARAMETER_TRAIT(complex.Float64Parameter, "f2a18fff-a095-47d7-b436-ede41b5ea21a") - ADD_PARAMETER_TRAIT(complex.ArraySelectionParameter, "ab047a7f-f9ab-4e6f-99b5-610e7b69fc5b") - ADD_PARAMETER_TRAIT(complex.FileSystemPathParameter, "f9a93f3d-21ef-43a1-a958-e57cbf3b2909") - ADD_PARAMETER_TRAIT(complex.DataGroupSelectionParameter, "bff3d4ac-04a6-5251-b178-4f83f7865074") - ADD_PARAMETER_TRAIT(complex.GeometrySelectionParameter, "3804cd7f-4ee4-400f-80ad-c5af17735de2") - ADD_PARAMETER_TRAIT(complex.BoolParameter, "b6936d18-7476-4855-9e13-e795d717c50f") + ADD_PARAMETER_TRAIT(complex.VectorInt8Parameter, "9f5f9683-e492-4a79-8378-79d727b2356a") ADD_PARAMETER_TRAIT(complex.VectorUInt8Parameter, "bff78ff3-35ef-482a-b3b1-df8806e7f7ef") ADD_PARAMETER_TRAIT(complex.VectorInt16Parameter, "43810a29-1a5f-4472-bec6-41de9ffe27f7") @@ -81,13 +97,177 @@ void GenerateParameterList() ADD_PARAMETER_TRAIT(complex.VectorUInt64Parameter, "17309744-c4e8-4d1e-807e-e7012387f1ec") ADD_PARAMETER_TRAIT(complex.VectorFloat32Parameter, "88f231a1-7956-41f5-98b7-4471705d2805") ADD_PARAMETER_TRAIT(complex.VectorFloat64Parameter, "57cbdfdf-9d1a-4de8-95d7-71d0c01c5c96") - ADD_PARAMETER_TRAIT(complex.AttributeMatrixSelectionParameter, "a3619d74-a1d9-4bc2-9e03-ca001d65b119") - ADD_PARAMETER_TRAIT(complex.ImportHDF5DatasetParameter, "32e83e13-ee4c-494e-8bab-4e699df74a5a") - ADD_PARAMETER_TRAIT(complex.Dream3dImportParameter, "170a257d-5952-4854-9a91-4281cd06f4f5") - ADD_PARAMETER_TRAIT(complex.DynamicTableParameter, "eea76f1a-fab9-4704-8da5-4c21057cf44e") - ADD_PARAMETER_TRAIT(complex.ArrayCreationParameter, "ab047a7d-f81b-4e6f-99b5-610e7b69fc5b") } +std::string ParseScalarType(const std::string& paramType) +{ + std::string temp = complex::StringUtilities::replace(paramType, "complex.", "Scalar Value |"); + temp = complex::StringUtilities::replace(temp, "Parameter", ""); + // temp = complex::StringUtilities::replace(temp, "Vector", " (Vector)"); + return temp; +} + +// std::string ParseVectorType(const std::string& paramType) +//{ +// std::string temp = complex::StringUtilities::replace(paramType, "complex.", ""); +// temp = complex::StringUtilities::replace(temp, "Vector", "Vector of Values |"); +// temp = complex::StringUtilities::replace(temp, "Parameter", ""); +// +// return temp; +// } + +bool CheckScalarPrimitive(std::ostream& rstStream, const complex::AnyParameter& paramValue) +{ + + static const std::set scalarPrimitives = { + complex::Uuid::FromString("a8ff9dbd-45e7-4ed6-8537-12dd53069bce").value(), complex::Uuid::FromString("44ae56e8-e6e7-4e4d-8128-dd3dc2c6696e").value(), + complex::Uuid::FromString("156a6f46-77e5-41d8-8f5a-65ba1da52f2a").value(), complex::Uuid::FromString("21acff45-a653-45db-a0d1-f43cd344b93a").value(), + complex::Uuid::FromString("e9521130-276c-40c7-95d7-0b4cb4f80649").value(), complex::Uuid::FromString("b2039349-bd3a-4dbb-93d2-b4b5c633e697").value(), + complex::Uuid::FromString("36d91b23-5500-4ed4-bdf3-d680f54ee5d1").value(), complex::Uuid::FromString("e4452dfe-2f70-4833-819e-0cbbec21289b").value(), + complex::Uuid::FromString("f2a18fff-a095-47d7-b436-ede41b5ea21a").value(), complex::Uuid::FromString("e9521130-276c-40c7-95d7-0b4cb4f80649").value()}; + + if(scalarPrimitives.find(paramValue->uuid()) != scalarPrimitives.end()) + { + rstStream << "| " << paramValue->humanName() << " | " << ParseScalarType(s_ParameterMap[paramValue->uuid()]) << " | " << paramValue->helpText() << " |\n"; + return true; + } + return false; +} + +bool CheckVectorPrimitive(std::ostream& rstStream, const complex::AnyParameter& paramValue) +{ + static const std::set vectorPrimitives = { + complex::Uuid::FromString("9f5f9683-e492-4a79-8378-79d727b2356a").value(), complex::Uuid::FromString("bff78ff3-35ef-482a-b3b1-df8806e7f7ef").value(), + complex::Uuid::FromString("43810a29-1a5f-4472-bec6-41de9ffe27f7").value(), complex::Uuid::FromString("2f1ba2f4-c5d5-403c-8b90-0bf60d2bde9b").value(), + complex::Uuid::FromString("d3188e18-e383-4727-ab32-88b5fda56ae8").value(), complex::Uuid::FromString("37322aa6-1a2f-4ecb-9aa1-8922d7ac1e49").value(), + complex::Uuid::FromString("4ceaffc1-7326-4f65-a33a-eae263dc22d1").value(), complex::Uuid::FromString("17309744-c4e8-4d1e-807e-e7012387f1ec").value(), + complex::Uuid::FromString("88f231a1-7956-41f5-98b7-4471705d2805").value(), complex::Uuid::FromString("57cbdfdf-9d1a-4de8-95d7-71d0c01c5c96").value()}; + + std::string paramTypeName = complex::StringUtilities::replace(s_ParameterMap[paramValue->uuid()], "complex.", ""); + paramTypeName = complex::StringUtilities::replace(paramTypeName, "Vector", ""); + paramTypeName = complex::StringUtilities::replace(paramTypeName, "Parameter", ""); + + if(vectorPrimitives.find(paramValue->uuid()) != vectorPrimitives.end()) + { + const VectorParameterBase* paramPtr = dynamic_cast(paramValue.get()); + rstStream << "| " << paramValue->humanName() << " | Vector of " << paramTypeName << " Values | Order="; + + auto names = paramPtr->names(); + int i = 0; + for(const auto& name : names) + { + rstStream << name; + i++; + if(i != names.size()) + { + rstStream << ","; + } + } + + rstStream << " | " << paramValue->helpText() << " |\n"; + return true; + } + return false; +} + +/** + * + * @param rstStream + * @param paramValue + * @return + */ +bool CheckArraySelectionParameter(std::ostream& rstStream, const complex::AnyParameter& paramValue) +{ + static const std::set param = {complex::Uuid::FromString("ab047a7f-f9ab-4e6f-99b5-610e7b69fc5b").value()}; + + std::string paramTypeName = s_ParameterMap[paramValue->uuid()]; + paramTypeName = complex::StringUtilities::replace(paramTypeName, "complex.", ""); + paramTypeName = complex::StringUtilities::replace(paramTypeName, "Parameter", ""); + paramTypeName = complex::StringUtilities::replace(paramTypeName, "Selection", " Selection"); + const ArraySelectionParameter* paramPtr = dynamic_cast(paramValue.get()); + if(paramPtr != nullptr) + { + rstStream << "| " << paramValue->humanName() << " | " << paramTypeName << " | Allowed Types: "; + auto allowedTypes = paramPtr->allowedTypes(); + int i = 0; + for(const auto& allowedType : allowedTypes) + { + rstStream << complex::DataTypeToString(allowedType).str(); + i++; + if(i != allowedTypes.size()) + { + rstStream << ", "; + } + } + auto compShapes = paramPtr->requiredComponentShapes(); + if(!compShapes.empty()) + { + rstStream << " Comp. Shape: "; + } + for(const auto& compShape : compShapes) + { + rstStream << fmt::format("{}", fmt::join(compShape, ",")); + } + rstStream << " | " << paramValue->helpText() << " |\n"; + return true; + } + + return false; +} + +bool CheckGeometrySelectionParameter(std::ostream& rstStream, const complex::AnyParameter& paramValue) +{ + static const std::set param = {complex::Uuid::FromString("d11e0bd8-f227-4fd1-b618-b6f16b259fc8").value()}; + + std::string paramTypeName = s_ParameterMap[paramValue->uuid()]; + paramTypeName = complex::StringUtilities::replace(paramTypeName, "complex.", ""); + paramTypeName = complex::StringUtilities::replace(paramTypeName, "Parameter", ""); + paramTypeName = complex::StringUtilities::replace(paramTypeName, "Selection", " Selection"); + const GeometrySelectionParameter* paramPtr = dynamic_cast(paramValue.get()); + if(paramPtr != nullptr) + { + + rstStream << "| " << paramValue->humanName() << " | " << paramTypeName << " | "; + + auto allowedTypes = paramPtr->allowedTypes(); + int i = 0; + for(const auto& allowedType : allowedTypes) + { + rstStream << complex::GeometryTypeToString(allowedType).str(); + i++; + if(i != allowedTypes.size()) + { + rstStream << ", "; + } + } + + rstStream << " | " << paramValue->helpText() << " |\n"; + return true; + } + + return false; +} + +/** + * + * @param rstStream + * @param paramValue + */ +void CheckParameter(std::ostream& rstStream, const complex::AnyParameter& paramValue) +{ + std::string paramTypeName = s_ParameterMap[paramValue->uuid()]; + paramTypeName = complex::StringUtilities::replace(paramTypeName, "complex.", ""); + paramTypeName = complex::StringUtilities::replace(paramTypeName, "Parameter", " | "); + + rstStream << "| " << paramValue->humanName() << " | " << paramTypeName << " | " << paramValue->helpText() << " |\n"; +} + +/** + * + * @param filePath + * @param trimLine + * @return + */ std::vector ReadFile(const std::filesystem::path& filePath, bool trimLine) { std::ifstream file = std::ifstream(filePath); @@ -298,10 +478,197 @@ std::vector FindTableColumnWidths(const Parameters& parameters) return {maxUIDisplay, maxPythonArg}; } +std::vector ConvertFilterDoc(const std::filesystem::path& docFilePath) +{ + // Open the existing doc file + // Extract out the first paragraph of the Filter's markdown documentation after the ## Description section marker + std::vector mdLines = ReadFile(docFilePath, false); + std::vector outputLines; + std::stringstream mdStream; + bool extractLines = true; + for(const auto& line : mdLines) + { + if(complex::StringUtilities::starts_with(line, "## Parameters")) + { + extractLines = false; + continue; + } + + if(complex::StringUtilities::starts_with(line, "## Example Pipelines")) + { + extractLines = true; + outputLines.push_back("@PARAMETER_TABLE@"); + } + + if(!extractLines && complex::StringUtilities::starts_with(line, "## License & Copyright")) + { + extractLines = true; + outputLines.push_back("@PARAMETER_TABLE@"); + } + if(extractLines) + { + outputLines.push_back(line); + } + } + + return outputLines; +} + +void GenerateMarkdownFilterParameterTable() +{ + auto* filterListPtr = Application::Instance()->getFilterList(); + + // Loop over each plugin and create a .rst file + const auto pluginListPtr = Application::Instance()->getPluginList(); + for(const auto& plugin : pluginListPtr) + { + std::string plugName = plugin->getName(); + const std::string pluginRootDir = fmt::format("{}", s_PluginDirMap[plugName]); + if(pluginRootDir.empty()) + { + continue; + } + + // This will alphabetize the filter list + const auto& pluginFilterHandles = plugin->getFilterHandles(); + std::map> filterHandles; + for(const auto& filterHandle : pluginFilterHandles) + { + filterHandles[filterHandle.getClassName()] = {filterHandle.getFilterId(), filterHandle.getPluginId()}; + } + + // Loop on each Filter + for(const auto& filterHandleIter : filterHandles) + { + std::string filterClassName = filterHandleIter.first; + FilterHandle const filterHandle(filterHandleIter.second.first, filterHandleIter.second.second); + IFilter::UniquePointer filter = filterListPtr->createFilter(filterHandle); + + std::stringstream pTableStream; + + // std::vector columnWidths = FindTableColumnWidths(parameters); + int needTableHeader = 0; + + const auto& parameters = filter->parameters(); + + for(const auto& layoutObj : parameters.getLayout()) + { + if(std::holds_alternative(layoutObj)) + { + + if(needTableHeader == 0) + { + pTableStream << "### Filter Parameters\n\n"; + pTableStream << "| Parameter Name | Parameter Type | Parameter Notes | Description |\n"; + pTableStream << "|----------------|----------------|-----------------|-------------|\n"; + } + + std::string key = std::get(layoutObj).key; + const auto& paramValue = parameters.at(key); + if(CheckScalarPrimitive(pTableStream, paramValue)) + { + continue; + } + if(CheckVectorPrimitive(pTableStream, paramValue)) + { + continue; + } + if(CheckArraySelectionParameter(pTableStream, paramValue)) + { + continue; + } + if(CheckGeometrySelectionParameter(pTableStream, paramValue)) + { + continue; + } + CheckParameter(pTableStream, paramValue); + } + else + { + std::string key = std::get(layoutObj).name; + pTableStream << "\n"; + pTableStream << "### " << key << "\n\n"; + pTableStream << "| Parameter Name | Parameter Type | Parameter Notes | Description |\n"; + pTableStream << "|----------------|----------------|-----------------|-------------|\n"; + } + needTableHeader++; + } + +#if SOMETHING + for(const auto& parameter : parameters) + { + auto const& paramValue = parameter.second; + if(paramValue->helpText().empty()) + { + std::cout << filter->name() << "::" << paramValue->name() << " HELP Text is empty\n"; + } + for(const auto& letter : paramValue->name()) + { + if(::isupper(letter) != 0) + { + std::cout << filter->name() << "::" << paramValue->name() << " HAS CAPS. Should be lower snake case\n"; + break; + } + } + + if(CheckScalarPrimitive(pTableStream, paramValue)) + { + continue; + } + if(CheckVectorPrimitive(pTableStream, paramValue)) + { + continue; + } + if(CheckArraySelectionParameter(pTableStream, paramValue)) + { + continue; + } + if(CheckGeometrySelectionParameter(pTableStream, paramValue)) + { + continue; + } + CheckParameter(pTableStream, paramValue); + } +#endif + + pTableStream << '\n'; + + // Read the Current Filter's Documentation File + const std::filesystem::path docFilePath = fmt::format("{}/docs/{}.md", pluginRootDir, filterClassName); + std::vector filterDocContents = ConvertFilterDoc(docFilePath); + + // Create a new output file + const std::filesystem::path rstFilePath = fmt::format("{}/nx_docs/source/{}/{}.md", COMPLEX_BUILD_DIR, plugName, filterClassName); + const Result<> createDirectoriesResult = complex::CreateOutputDirectories(rstFilePath.parent_path()); + + std::ofstream rstStream = std::ofstream(rstFilePath, std::ios_base::binary | std::ios_base::trunc); + if(!rstStream.is_open()) + { + std::cout << "ERROR:" << rstFilePath << "\n"; + return; + } + + rstStream << "```{index} single: Filters; " << filter->humanName() << "\n```\n"; + + for(const auto& line : filterDocContents) + { + if(line == "@PARAMETER_TABLE@") + { + rstStream << pTableStream.str(); + } + else + { + rstStream << line << "\n"; + } + } + } + } +} + /** * @brief */ -void GenerateRstFilterDocs() +void GeneratePythonRstFiles() { auto* filterListPtr = Application::Instance()->getFilterList(); @@ -466,7 +833,7 @@ std::string ReadIndexTemplateFile(const std::filesystem::path& path) /** * @brief Generates the index.rst file for the sphinx docs */ -void GenerateIndexRstFile() +void GeneratePythonSphinxIndex() { std::string indexTemplate; { @@ -515,18 +882,21 @@ void GenerateIndexRstFile() */ int main(int32_t argc, char** argv) { - try + // try { GenerateParameterList(); Application app; app.loadPlugins(COMPLEX_BIN_DIR, true); - GenerateRstFilterDocs(); - GenerateIndexRstFile(); - } catch(const std::exception& except) + GeneratePythonRstFiles(); + GeneratePythonSphinxIndex(); + + GenerateMarkdownFilterParameterTable(); + } + // catch(const std::exception& except) { - std::cout << "RST Doc Generator threw a runtime exception which should NOT happen" << std::endl; + // std::cout << "RST Doc Generator threw a runtime exception which should NOT happen" << std::endl; } return 0; } diff --git a/wrapping/python/docs/index_template.rst b/wrapping/python/docs/index_template.rst index 86830c4dc4..d98a189cde 100644 --- a/wrapping/python/docs/index_template.rst +++ b/wrapping/python/docs/index_template.rst @@ -5,6 +5,17 @@ DREAM3D-NX Python Docs ================================ +The *complex* library can be installed through an Anaconda packages from the *BlueQuartzSoftware* channel. This can be achieved +by creating a new virtual environment + +.. code:: shell + + conda config --add channels conda-forge + conda config --set channel_priority strict + conda create -n cxpython python=3.9 + conda activate cxpython + conda install -c bluequartzsoftware complex + .. toctree:: :maxdepth: 3 :caption: Contents: @@ -23,6 +34,3 @@ Indices and tables * :ref:`genindex` * :ref:`modindex` -* :ref:`search` - - diff --git a/wrapping/python/docs/source/DataObjects.rst b/wrapping/python/docs/source/DataObjects.rst index 7697eab748..8527f1b16e 100644 --- a/wrapping/python/docs/source/DataObjects.rst +++ b/wrapping/python/docs/source/DataObjects.rst @@ -30,6 +30,20 @@ This is the abstract base class for all other objects that can be inserted into DataStructure_ . It should never be used as the appropriate class from the list below should be used instead. + +DataPath +--------- + +A DataPath is a complex class that describes the path to a :ref:`DataObject` within +the DataStructure_ . The path is constructed as a python list of string objects. +For example if we have a top level group called **MyGroup** and a `DataArray` +called *Euler Angles* within that group the **DataPath** object that would be constructed is the following + +.. code:: python + + array_path = cx.DataPath(['MyGroup', 'Euler Angles']) + + .. _DataGroup: DataGroup @@ -48,17 +62,6 @@ any needed DataGroups. .. _DataPath: -DataPath ---------- - -A DataPath is a complex class that describes the path to a :ref:`DataObject` within -the DataStructure_ . The path is constructed as a python list of string objects. -For example if we have a top level group called **MyGroup** and a `DataArray` -called *Euler Angles* within that group the **DataPath** object that would be constructed is the following - -.. code:: python - - array_path = cx.DataPath(['MyGroup', 'Euler Angles']) .. _DataArray: