From 8e51005cd58fdeee09b1c3469e55dbc98fda5972 Mon Sep 17 00:00:00 2001 From: Michael Jackson Date: Wed, 4 Oct 2023 18:33:32 -0400 Subject: [PATCH] Use Markdown files for the Filer documentation. It actually works correctly. Signed-off-by: Michael Jackson --- PortingFilters.md | 38 +- README.md | 42 +- cmake/Plugin.cmake | 4 +- docs/Code_Style_Guide.md | 16 +- docs/Porting_Filters.md | 40 +- docs/index.rst | 21 - .../docs/AbaqusHexahedronWriterFilter.md | 4 +- .../docs/AbaqusHexahedronWriterFilter.rst | 168 -------- .../ComplexCore/docs/AddBadDataFilter.md | 6 +- .../ComplexCore/docs/AddBadDataFilter.rst | 75 ---- .../ComplexCore/docs/AlignGeometries.md | 18 +- .../ComplexCore/docs/AlignGeometries.rst | 70 --- .../AlignSectionsFeatureCentroidFilter.md | 22 +- .../AlignSectionsFeatureCentroidFilter.rst | 105 ----- .../docs/AlignSectionsListFilter.md | 18 +- .../docs/AlignSectionsListFilter.rst | 74 ---- .../docs/AppendImageGeometryZSliceFilter.md | 4 +- .../docs/AppendImageGeometryZSliceFilter.rst | 73 ---- .../ApplyTransformationToGeometryFilter.rst | 177 -------- .../docs/ApproximatePointCloudHull.md | 22 +- .../docs/ApproximatePointCloudHull.rst | 82 ---- .../ComplexCore/docs/ArrayCalculatorFilter.md | 46 +- .../docs/ArrayCalculatorFilter.rst | 283 ------------ .../AvizoRectilinearCoordinateWriterFilter.md | 16 +- ...AvizoRectilinearCoordinateWriterFilter.rst | 123 ------ .../AvizoUniformCoordinateWriterFilter.md | 16 +- .../AvizoUniformCoordinateWriterFilter.rst | 124 ------ .../docs/CalculateArrayHistogramFilter.rst | 406 ------------------ .../docs/CalculateFeatureSizesFilter.md | 26 +- .../docs/CalculateFeatureSizesFilter.rst | 104 ----- .../docs/CalculateTriangleAreasFilter.md | 22 +- .../docs/CalculateTriangleAreasFilter.rst | 64 --- .../docs/ChangeAngleRepresentation.md | 24 +- .../docs/ChangeAngleRepresentation.rst | 74 ---- .../docs/CombineAttributeArraysFilter.md | 32 +- .../docs/CombineAttributeArraysFilter.rst | 110 ----- .../ComplexCore/docs/CombineStlFilesFilter.md | 12 +- .../docs/CombineStlFilesFilter.rst | 65 --- .../docs/ComputeFeatureRectFilter.md | 26 +- .../docs/ComputeFeatureRectFilter.rst | 84 ---- .../docs/ComputeMomentInvariants2DFilter.md | 22 +- .../docs/ComputeMomentInvariants2DFilter.rst | 102 ----- .../ComplexCore/docs/ConditionalSetValue.md | 22 +- .../ComplexCore/docs/ConditionalSetValue.rst | 99 ----- .../docs/ConvertColorToGrayScaleFilter.md | 24 +- .../docs/ConvertColorToGrayScaleFilter.rst | 93 ---- .../ComplexCore/docs/ConvertDataFilter.md | 26 +- .../ComplexCore/docs/ConvertDataFilter.rst | 92 ---- .../ComplexCore/docs/CopyDataObjectFilter.md | 20 +- .../ComplexCore/docs/CopyDataObjectFilter.rst | 76 ---- .../docs/CopyFeatureArrayToElementArray.md | 24 +- .../docs/CopyFeatureArrayToElementArray.rst | 59 --- .../docs/CreateAttributeMatrixFilter.md | 30 +- .../docs/CreateAttributeMatrixFilter.rst | 61 --- .../ComplexCore/docs/CreateDataArray.md | 24 +- .../ComplexCore/docs/CreateDataArray.rst | 139 ------ .../ComplexCore/docs/CreateDataGroup.md | 20 +- .../ComplexCore/docs/CreateDataGroup.rst | 54 --- .../CreateFeatureArrayFromElementArray.md | 16 +- .../CreateFeatureArrayFromElementArray.rst | 59 --- .../ComplexCore/docs/CreateGeometryFilter.md | 54 +-- .../ComplexCore/docs/CreateGeometryFilter.rst | 373 ---------------- .../ComplexCore/docs/CreateImageGeometry.md | 22 +- .../ComplexCore/docs/CreateImageGeometry.rst | 66 --- .../ComplexCore/docs/CropImageGeometry.md | 12 +- .../ComplexCore/docs/CropImageGeometry.rst | 67 --- .../ComplexCore/docs/CropVertexGeometry.md | 22 +- .../ComplexCore/docs/CropVertexGeometry.rst | 66 --- src/Plugins/ComplexCore/docs/DeleteData.md | 20 +- src/Plugins/ComplexCore/docs/DeleteData.rst | 56 --- .../docs/ErodeDilateBadDataFilter.md | 4 +- .../docs/ErodeDilateBadDataFilter.rst | 123 ------ .../ErodeDilateCoordinationNumberFilter.md | 4 +- .../ErodeDilateCoordinationNumberFilter.rst | 87 ---- .../docs/ErodeDilateMaskFilter.rst | 90 ---- .../ComplexCore/docs/ExecuteProcessFilter.md | 16 +- .../ComplexCore/docs/ExecuteProcessFilter.rst | 76 ---- .../ComplexCore/docs/ExportDREAM3DFilter.md | 16 +- .../ComplexCore/docs/ExportDREAM3DFilter.rst | 50 --- .../docs/ExtractComponentAsArrayFilter.md | 26 +- .../docs/ExtractComponentAsArrayFilter.rst | 70 --- ...actInternalSurfacesFromTriangleGeometry.md | 24 +- ...ctInternalSurfacesFromTriangleGeometry.rst | 72 ---- .../docs/ExtractVertexGeometryFilter.md | 14 +- .../docs/ExtractVertexGeometryFilter.rst | 63 --- .../docs/FeatureDataCSVWriterFilter.md | 22 +- .../docs/FeatureDataCSVWriterFilter.rst | 111 ----- .../docs/FeatureFaceCurvatureFilter.md | 32 +- .../docs/FeatureFaceCurvatureFilter.rst | 100 ----- .../ComplexCore/docs/FillBadDataFilter.md | 4 +- .../ComplexCore/docs/FillBadDataFilter.rst | 83 ---- .../docs/FindArrayStatisticsFilter.md | 28 +- .../docs/FindArrayStatisticsFilter.rst | 234 ---------- .../docs/FindBiasedFeaturesFilter.md | 10 +- .../docs/FindBiasedFeaturesFilter.rst | 98 ----- .../docs/FindBoundaryCellsFilter.md | 10 +- .../docs/FindBoundaryCellsFilter.rst | 81 ---- .../FindBoundaryElementFractionsFilter.md | 8 +- .../FindBoundaryElementFractionsFilter.rst | 69 --- .../ComplexCore/docs/FindDifferencesMap.md | 24 +- .../ComplexCore/docs/FindDifferencesMap.rst | 85 ---- .../docs/FindEuclideanDistMapFilter.md | 26 +- .../docs/FindEuclideanDistMapFilter.rst | 116 ----- .../docs/FindFeatureCentroidsFilter.md | 24 +- .../docs/FindFeatureCentroidsFilter.rst | 69 --- .../docs/FindFeatureClusteringFilter.md | 10 +- .../docs/FindFeatureClusteringFilter.rst | 108 ----- .../docs/FindFeaturePhasesBinaryFilter.md | 8 +- .../docs/FindFeaturePhasesBinaryFilter.rst | 70 --- .../docs/FindFeaturePhasesFilter.md | 24 +- .../docs/FindFeaturePhasesFilter.rst | 70 --- .../docs/FindLargestCrossSectionsFilter.md | 10 +- .../docs/FindLargestCrossSectionsFilter.rst | 65 --- .../docs/FindNeighborListStatistics.md | 24 +- .../docs/FindNeighborListStatistics.rst | 88 ---- .../docs/FindNeighborhoodsFilter.md | 26 +- .../docs/FindNeighborhoodsFilter.rst | 92 ---- src/Plugins/ComplexCore/docs/FindNeighbors.md | 26 +- .../ComplexCore/docs/FindNeighbors.rst | 137 ------ .../ComplexCore/docs/FindNumFeaturesFilter.md | 26 +- .../docs/FindNumFeaturesFilter.rst | 64 --- .../docs/FindSurfaceAreaToVolumeFilter.md | 8 +- .../docs/FindSurfaceAreaToVolumeFilter.rst | 87 ---- .../ComplexCore/docs/FindSurfaceFeatures.md | 8 +- .../ComplexCore/docs/FindSurfaceFeatures.rst | 103 ----- .../docs/FindTriangleGeomCentroidsFilter.md | 2 +- .../docs/FindTriangleGeomCentroidsFilter.rst | 69 --- .../docs/FindTriangleGeomSizesFilter.md | 2 +- .../docs/FindTriangleGeomSizesFilter.rst | 76 ---- .../FindVertexToTriangleDistancesFilter.md | 22 +- .../FindVertexToTriangleDistancesFilter.rst | 60 --- .../docs/FindVolFractionsFilter.md | 26 +- .../docs/FindVolFractionsFilter.rst | 62 --- .../docs/GenerateColorTableFilter.md | 14 +- .../docs/GenerateColorTableFilter.rst | 56 --- .../docs/GenerateVectorColorsFilter.md | 26 +- .../docs/GenerateVectorColorsFilter.rst | 69 --- .../ComplexCore/docs/IdentifySample.md | 6 +- .../ComplexCore/docs/IdentifySample.rst | 94 ---- .../ComplexCore/docs/ImageContouringFilter.md | 6 +- .../docs/ImageContouringFilter.rst | 66 --- .../docs/ImportBinaryCTNorthstarFilter.md | 22 +- .../docs/ImportBinaryCTNorthstarFilter.rst | 66 --- .../ComplexCore/docs/ImportCSVDataFilter.md | 28 +- .../ComplexCore/docs/ImportCSVDataFilter.rst | 139 ------ .../ComplexCore/docs/ImportDREAM3DFilter.md | 16 +- .../ComplexCore/docs/ImportDREAM3DFilter.rst | 43 -- .../docs/ImportDeformKeyFileV12Filter.md | 4 +- .../docs/ImportDeformKeyFileV12Filter.rst | 56 --- .../ComplexCore/docs/ImportHDF5Dataset.md | 28 +- .../ComplexCore/docs/ImportHDF5Dataset.rst | 106 ----- .../ComplexCore/docs/ImportTextFilter.md | 32 +- .../ComplexCore/docs/ImportTextFilter.rst | 132 ------ .../docs/ImportVolumeGraphicsFileFilter.md | 22 +- .../docs/ImportVolumeGraphicsFileFilter.rst | 60 --- .../ComplexCore/docs/InitializeData.md | 22 +- .../ComplexCore/docs/InitializeData.rst | 62 --- ...nterpolatePointCloudToRegularGridFilter.md | 24 +- ...terpolatePointCloudToRegularGridFilter.rst | 92 ---- .../docs/IterativeClosestPointFilter.md | 24 +- .../docs/IterativeClosestPointFilter.rst | 82 ---- src/Plugins/ComplexCore/docs/KMeansFilter.md | 32 +- src/Plugins/ComplexCore/docs/KMeansFilter.rst | 135 ------ .../ComplexCore/docs/KMedoidsFilter.md | 32 +- .../ComplexCore/docs/KMedoidsFilter.rst | 136 ------ .../docs/LaplacianSmoothingFilter.md | 30 +- .../docs/LaplacianSmoothingFilter.rst | 177 -------- .../docs/LosAlamosFFTWriterFilter.md | 4 +- .../docs/LosAlamosFFTWriterFilter.rst | 109 ----- .../docs/MapPointCloudToRegularGridFilter.md | 20 +- .../docs/MapPointCloudToRegularGridFilter.rst | 74 ---- src/Plugins/ComplexCore/docs/MinNeighbors.md | 24 +- src/Plugins/ComplexCore/docs/MinNeighbors.rst | 95 ---- src/Plugins/ComplexCore/docs/MoveData.md | 22 +- src/Plugins/ComplexCore/docs/MoveData.rst | 60 --- .../ComplexCore/docs/MultiThresholdObjects.md | 24 +- .../docs/MultiThresholdObjects.rst | 96 ----- .../NearestPointFuseRegularGridsFilter.md | 4 +- .../NearestPointFuseRegularGridsFilter.rst | 58 --- .../docs/PartitionGeometryFilter.md | 22 +- .../docs/PartitionGeometryFilter.rst | 276 ------------ .../docs/PointSampleTriangleGeometryFilter.md | 28 +- .../PointSampleTriangleGeometryFilter.rst | 124 ------ .../docs/QuickSurfaceMeshFilter.md | 30 +- .../docs/QuickSurfaceMeshFilter.rst | 162 ------- .../ComplexCore/docs/RawBinaryReaderFilter.md | 30 +- .../docs/RawBinaryReaderFilter.rst | 128 ------ .../docs/RegularGridSampleSurfaceMesh.md | 8 +- .../docs/RegularGridSampleSurfaceMesh.rst | 68 --- .../RegularGridSampleSurfaceMeshFilter.md | 8 +- .../RegularGridSampleSurfaceMeshFilter.rst | 74 ---- .../docs/RemoveFlaggedFeaturesFilter.md | 20 +- .../docs/RemoveFlaggedFeaturesFilter.rst | 60 --- .../ComplexCore/docs/RemoveFlaggedVertices.md | 24 +- .../docs/RemoveFlaggedVertices.rst | 74 ---- .../docs/RemoveMinimumSizeFeaturesFilter.md | 24 +- .../docs/RemoveMinimumSizeFeaturesFilter.rst | 93 ---- .../ComplexCore/docs/RenameDataObject.md | 22 +- .../ComplexCore/docs/RenameDataObject.rst | 56 --- ...mentAttributesWithNeighborValuesFilter.rst | 170 -------- .../docs/ResampleImageGeomFilter.md | 30 +- .../docs/ResampleImageGeomFilter.rst | 161 ------- .../docs/ResampleRectGridToImageGeomFilter.md | 14 +- .../ResampleRectGridToImageGeomFilter.rst | 81 ---- .../docs/ReverseTriangleWindingFilter.md | 4 +- .../docs/ReverseTriangleWindingFilter.rst | 54 --- .../docs/RobustAutomaticThreshold.md | 24 +- .../docs/RobustAutomaticThreshold.rst | 76 ---- .../docs/RotateSampleRefFrameFilter.md | 24 +- .../docs/RotateSampleRefFrameFilter.rst | 94 ---- .../docs/ScalarSegmentFeaturesFilter.md | 26 +- .../docs/ScalarSegmentFeaturesFilter.rst | 103 ----- .../docs/SetImageGeomOriginScalingFilter.md | 20 +- .../docs/SetImageGeomOriginScalingFilter.rst | 64 --- .../docs/SharedFeatureFaceFilter.md | 4 +- .../docs/SharedFeatureFaceFilter.rst | 106 ----- .../ComplexCore/docs/SilhouetteFilter.md | 28 +- .../ComplexCore/docs/SilhouetteFilter.rst | 88 ---- .../docs/SplitAttributeArrayFilter.md | 26 +- .../docs/SplitAttributeArrayFilter.rst | 92 ---- .../ComplexCore/docs/StlFileReaderFilter.md | 22 +- .../ComplexCore/docs/StlFileReaderFilter.rst | 84 ---- .../ComplexCore/docs/SurfaceNetsFilter.md | 24 +- .../ComplexCore/docs/SurfaceNetsFilter.rst | 143 ------ .../docs/TriangleCentroidFilter.md | 18 +- .../docs/TriangleCentroidFilter.rst | 55 --- .../docs/TriangleDihedralAngleFilter.md | 22 +- .../docs/TriangleDihedralAngleFilter.rst | 60 --- .../ComplexCore/docs/TriangleNormalFilter.md | 22 +- .../ComplexCore/docs/TriangleNormalFilter.rst | 68 --- .../UncertainRegularGridSampleSurfaceMesh.md | 8 +- .../UncertainRegularGridSampleSurfaceMesh.rst | 85 ---- ...rtainRegularGridSampleSurfaceMeshFilter.md | 8 +- ...tainRegularGridSampleSurfaceMeshFilter.rst | 85 ---- .../docs/VtkRectilinearGridWriterFilter.md | 20 +- .../docs/VtkRectilinearGridWriterFilter.rst | 103 ----- .../ComplexCore/docs/WriteASCIIDataFilter.md | 14 +- .../ComplexCore/docs/WriteASCIIDataFilter.rst | 58 --- .../ComplexCore/docs/WriteBinaryDataFilter.md | 14 +- .../docs/WriteBinaryDataFilter.rst | 56 --- .../ComplexCore/docs/WriteStlFileFilter.md | 8 +- .../ComplexCore/docs/WriteStlFileFilter.rst | 63 --- .../PortingITKImageProcessingFilter.md | 8 +- .../PortingITKImageProcessingFilter.rst | 63 --- .../ITKImageProcessing/docs/ITKAbsImage.md | 2 +- .../ITKImageProcessing/docs/ITKAbsImage.rst | 62 --- .../ITKImageProcessing/docs/ITKAcosImage.md | 2 +- .../ITKImageProcessing/docs/ITKAcosImage.rst | 71 --- .../ITKAdaptiveHistogramEqualizationImage.md | 2 +- .../ITKAdaptiveHistogramEqualizationImage.rst | 93 ---- .../ITKImageProcessing/docs/ITKAsinImage.md | 2 +- .../ITKImageProcessing/docs/ITKAsinImage.rst | 71 --- .../ITKImageProcessing/docs/ITKAtanImage.md | 2 +- .../ITKImageProcessing/docs/ITKAtanImage.rst | 69 --- .../docs/ITKBinaryContourImage.md | 2 +- .../docs/ITKBinaryContourImage.rst | 88 ---- .../docs/ITKBinaryDilateImage.md | 2 +- .../docs/ITKBinaryDilateImage.rst | 86 ---- .../docs/ITKBinaryErodeImage.md | 2 +- .../docs/ITKBinaryErodeImage.rst | 87 ---- .../ITKBinaryMorphologicalClosingImage.md | 2 +- .../ITKBinaryMorphologicalClosingImage.rst | 90 ---- .../ITKBinaryMorphologicalOpeningImage.md | 2 +- .../ITKBinaryMorphologicalOpeningImage.rst | 88 ---- .../ITKBinaryOpeningByReconstructionImage.md | 2 +- .../ITKBinaryOpeningByReconstructionImage.rst | 90 ---- .../docs/ITKBinaryProjectionImage.md | 2 +- .../docs/ITKBinaryProjectionImage.rst | 93 ---- .../docs/ITKBinaryThinningImage.md | 2 +- .../docs/ITKBinaryThinningImage.rst | 74 ---- .../docs/ITKBinaryThresholdImage.md | 2 +- .../docs/ITKBinaryThresholdImage.rst | 95 ---- .../docs/ITKBlackTopHatImage.md | 2 +- .../docs/ITKBlackTopHatImage.rst | 81 ---- .../docs/ITKClosingByReconstructionImage.md | 2 +- .../docs/ITKClosingByReconstructionImage.rst | 95 ---- .../ITKImageProcessing/docs/ITKCosImage.md | 2 +- .../ITKImageProcessing/docs/ITKCosImage.rst | 71 --- .../docs/ITKDilateObjectMorphologyImage.md | 2 +- .../docs/ITKDilateObjectMorphologyImage.rst | 71 --- .../docs/ITKDiscreteGaussianImage.md | 2 +- .../docs/ITKDiscreteGaussianImage.rst | 85 ---- .../docs/ITKErodeObjectMorphologyImage.md | 2 +- .../docs/ITKErodeObjectMorphologyImage.rst | 72 ---- .../ITKImageProcessing/docs/ITKExpImage.md | 2 +- .../ITKImageProcessing/docs/ITKExpImage.rst | 62 --- .../docs/ITKExpNegativeImage.md | 2 +- .../docs/ITKExpNegativeImage.rst | 63 --- .../docs/ITKGradientMagnitudeImage.md | 2 +- .../docs/ITKGradientMagnitudeImage.rst | 75 ---- .../docs/ITKGrayscaleDilateImage.md | 2 +- .../docs/ITKGrayscaleDilateImage.rst | 69 --- .../docs/ITKGrayscaleErodeImage.md | 2 +- .../docs/ITKGrayscaleErodeImage.rst | 69 --- .../docs/ITKGrayscaleFillholeImage.md | 2 +- .../docs/ITKGrayscaleFillholeImage.rst | 78 ---- .../docs/ITKGrayscaleGrindPeakImage.md | 2 +- .../docs/ITKGrayscaleGrindPeakImage.rst | 82 ---- .../ITKGrayscaleMorphologicalClosingImage.md | 2 +- .../ITKGrayscaleMorphologicalClosingImage.rst | 73 ---- .../ITKGrayscaleMorphologicalOpeningImage.md | 2 +- .../ITKGrayscaleMorphologicalOpeningImage.rst | 73 ---- .../docs/ITKHConvexImage.md | 2 +- .../docs/ITKHConvexImage.rst | 78 ---- .../docs/ITKHMaximaImage.md | 2 +- .../docs/ITKHMaximaImage.rst | 82 ---- .../docs/ITKHMinimaImage.md | 2 +- .../docs/ITKHMinimaImage.rst | 84 ---- .../ITKImageProcessing/docs/ITKImageReader.md | 18 +- .../docs/ITKImageReader.rst | 53 --- .../ITKImageProcessing/docs/ITKImageWriter.md | 28 +- .../docs/ITKImageWriter.rst | 76 ---- .../docs/ITKImportFijiMontageFilter.md | 30 +- .../docs/ITKImportFijiMontageFilter.rst | 167 ------- .../docs/ITKImportImageStack.md | 18 +- .../docs/ITKImportImageStack.rst | 66 --- .../docs/ITKIntensityWindowingImage.md | 2 +- .../docs/ITKIntensityWindowingImage.rst | 73 ---- .../docs/ITKInvertIntensityImage.md | 2 +- .../docs/ITKInvertIntensityImage.rst | 75 ---- .../docs/ITKLabelContourImage.md | 2 +- .../docs/ITKLabelContourImage.rst | 85 ---- .../ITKImageProcessing/docs/ITKLog10Image.md | 2 +- .../ITKImageProcessing/docs/ITKLog10Image.rst | 62 --- .../ITKImageProcessing/docs/ITKLogImage.md | 2 +- .../ITKImageProcessing/docs/ITKLogImage.rst | 60 --- .../ITKImageProcessing/docs/ITKMaskImage.md | 30 +- .../ITKImageProcessing/docs/ITKMaskImage.rst | 94 ---- .../ITKImageProcessing/docs/ITKMedianImage.md | 2 +- .../docs/ITKMedianImage.rst | 70 --- .../docs/ITKMhaFileReader.md | 18 +- .../docs/ITKMhaFileReader.rst | 85 ---- .../docs/ITKMorphologicalGradientImage.md | 2 +- .../docs/ITKMorphologicalGradientImage.rst | 66 --- .../docs/ITKMorphologicalWatershedImage.md | 2 +- .../docs/ITKMorphologicalWatershedImage.rst | 89 ---- .../docs/ITKNormalizeImage.md | 2 +- .../docs/ITKNormalizeImage.rst | 73 ---- .../ITKImageProcessing/docs/ITKNotImage.md | 2 +- .../ITKImageProcessing/docs/ITKNotImage.rst | 83 ---- .../docs/ITKOpeningByReconstructionImage.md | 2 +- .../docs/ITKOpeningByReconstructionImage.rst | 97 ----- .../docs/ITKOtsuMultipleThresholdsImage.md | 2 +- .../docs/ITKOtsuMultipleThresholdsImage.rst | 83 ---- .../docs/ITKRelabelComponentImage.md | 2 +- .../docs/ITKRelabelComponentImage.rst | 96 ----- .../docs/ITKRescaleIntensityImage.md | 2 +- .../docs/ITKRescaleIntensityImage.rst | 84 ---- .../docs/ITKSigmoidImage.rst | 75 ---- .../docs/ITKSignedMaurerDistanceMapImage.md | 2 +- .../docs/ITKSignedMaurerDistanceMapImage.rst | 88 ---- .../ITKImageProcessing/docs/ITKSinImage.md | 2 +- .../ITKImageProcessing/docs/ITKSinImage.rst | 62 --- .../ITKImageProcessing/docs/ITKSqrtImage.md | 2 +- .../ITKImageProcessing/docs/ITKSqrtImage.rst | 62 --- .../ITKImageProcessing/docs/ITKSquareImage.md | 2 +- .../docs/ITKSquareImage.rst | 60 --- .../ITKImageProcessing/docs/ITKTanImage.md | 2 +- .../ITKImageProcessing/docs/ITKTanImage.rst | 62 --- .../docs/ITKThresholdImage.md | 2 +- .../docs/ITKThresholdImage.rst | 84 ---- .../docs/ITKValuedRegionalMaximaImage.md | 2 +- .../docs/ITKValuedRegionalMaximaImage.rst | 89 ---- .../docs/ITKValuedRegionalMinimaImage.md | 2 +- .../docs/ITKValuedRegionalMinimaImage.rst | 81 ---- .../docs/ITKWhiteTopHatImage.md | 2 +- .../docs/ITKWhiteTopHatImage.rst | 78 ---- .../ITKImageProcessing/tools/ReadMe.rst | 24 -- .../3rdParty/canvas_ity/ReadMe.rst | 6 - .../PortingOrientationAnalysisFilter.md | 8 +- .../PortingOrientationAnalysisFilter.rst | 63 --- .../Support/GMT/UsingGMT.md | 24 +- .../Support/GMT/UsingGMT.rst | 110 ----- .../OrientationAnalysis/data/ReadMe.rst | 18 - .../docs/AlignSectionsMisorientationFilter.md | 24 +- .../AlignSectionsMisorientationFilter.rst | 121 ------ .../AlignSectionsMutualInformationFilter.md | 28 +- .../AlignSectionsMutualInformationFilter.rst | 134 ------ .../BadDataNeighborOrientationCheckFilter.md | 24 +- .../BadDataNeighborOrientationCheckFilter.rst | 90 ---- .../docs/CAxisSegmentFeaturesFilter.md | 24 +- .../docs/CAxisSegmentFeaturesFilter.rst | 109 ----- .../docs/ConvertOrientations.md | 34 +- .../docs/ConvertOrientations.rst | 128 ------ .../docs/ConvertQuaternionFilter.md | 24 +- .../docs/ConvertQuaternionFilter.rst | 72 ---- .../docs/CreateEnsembleInfoFilter.md | 30 +- .../docs/CreateEnsembleInfoFilter.rst | 106 ----- .../docs/EBSDSegmentFeaturesFilter.md | 28 +- .../docs/EBSDSegmentFeaturesFilter.rst | 118 ----- .../docs/EbsdToH5EbsdFilter.md | 44 +- .../docs/EbsdToH5EbsdFilter.rst | 174 -------- .../docs/EnsembleInfoReaderFilter.md | 24 +- .../docs/EnsembleInfoReaderFilter.rst | 121 ------ .../docs/ExportGBCDGMTFileFilter.md | 26 +- .../docs/ExportGBCDGMTFileFilter.rst | 80 ---- .../docs/ExportGBCDTriangleDataFilter.md | 28 +- .../docs/ExportGBCDTriangleDataFilter.rst | 88 ---- .../docs/FindAvgCAxesFilter.md | 22 +- .../docs/FindAvgCAxesFilter.rst | 79 ---- .../docs/FindAvgOrientationsFilter.md | 26 +- .../docs/FindAvgOrientationsFilter.rst | 101 ----- .../docs/FindBoundaryStrengthsFilter.md | 12 +- .../docs/FindBoundaryStrengthsFilter.rst | 87 ---- .../docs/FindCAxisLocationsFilter.md | 10 +- .../docs/FindCAxisLocationsFilter.rst | 74 ---- ...FeatureNeighborCAxisMisalignmentsFilter.md | 18 +- ...eatureNeighborCAxisMisalignmentsFilter.rst | 88 ---- ...tureReferenceCAxisMisorientationsFilter.md | 22 +- ...ureReferenceCAxisMisorientationsFilter.rst | 89 ---- ...ndFeatureReferenceMisorientationsFilter.md | 28 +- ...dFeatureReferenceMisorientationsFilter.rst | 101 ----- .../docs/FindGBCDFilter.md | 40 +- .../docs/FindGBCDFilter.rst | 86 ---- .../docs/FindGBCDMetricBasedFilter.md | 26 +- .../docs/FindGBCDMetricBasedFilter.rst | 233 ---------- .../docs/FindGBPDMetricBasedFilter.md | 22 +- .../docs/FindGBPDMetricBasedFilter.rst | 198 --------- .../FindKernelAvgMisorientationsFilter.md | 28 +- .../FindKernelAvgMisorientationsFilter.rst | 87 ---- .../docs/FindMisorientationsFilter.md | 30 +- .../docs/FindMisorientationsFilter.rst | 92 ---- .../docs/FindSchmidsFilter.md | 28 +- .../docs/FindSchmidsFilter.rst | 112 ----- .../docs/FindShapesFilter.md | 24 +- .../docs/FindShapesFilter.rst | 115 ----- .../docs/FindSlipTransmissionMetricsFilter.md | 28 +- .../FindSlipTransmissionMetricsFilter.rst | 82 ---- .../docs/FindTriangleGeomShapesFilter.md | 16 +- .../docs/FindTriangleGeomShapesFilter.rst | 129 ------ .../docs/GenerateFZQuaternions.md | 26 +- .../docs/GenerateFZQuaternions.rst | 114 ----- .../docs/GenerateFaceIPFColoringFilter.md | 32 +- .../docs/GenerateFaceIPFColoringFilter.rst | 85 ---- ...enerateFaceMisorientationColoringFilter.md | 30 +- ...nerateFaceMisorientationColoringFilter.rst | 73 ---- .../docs/GenerateGBCDPoleFigureFilter.md | 26 +- .../docs/GenerateGBCDPoleFigureFilter.rst | 98 ----- .../docs/GenerateIPFColorsFilter.md | 36 +- .../docs/GenerateIPFColorsFilter.rst | 154 ------- .../docs/GeneratePoleFigureFilter.md | 14 +- .../docs/GeneratePoleFigureFilter.rst | 117 ----- .../docs/GenerateQuaternionConjugateFilter.md | 20 +- .../GenerateQuaternionConjugateFilter.rst | 68 --- .../docs/INLWriterFilter.md | 32 +- .../docs/INLWriterFilter.rst | 172 -------- .../docs/ImportH5EspritDataFilter.md | 38 +- .../docs/ImportH5EspritDataFilter.rst | 180 -------- .../docs/ImportH5OimDataFilter.md | 30 +- .../docs/ImportH5OimDataFilter.rst | 155 ------- .../docs/MergeTwinsFilter.md | 31 +- .../docs/MergeTwinsFilter.rst | 110 ----- .../NeighborOrientationCorrelationFilter.md | 26 +- .../NeighborOrientationCorrelationFilter.rst | 117 ----- .../docs/ReadAngDataFilter.md | 36 +- .../docs/ReadAngDataFilter.rst | 114 ----- .../docs/ReadCtfDataFilter.md | 45 +- .../docs/ReadCtfDataFilter.rst | 162 ------- .../docs/ReadH5EbsdFilter.md | 47 +- .../docs/ReadH5EbsdFilter.rst | 173 -------- .../docs/RodriguesConvertorFilter.md | 30 +- .../docs/RodriguesConvertorFilter.rst | 68 --- .../docs/RotateEulerRefFrameFilter.md | 22 +- .../docs/RotateEulerRefFrameFilter.rst | 65 --- .../docs/WritePoleFigureFilter.md | 16 +- .../docs/WritePoleFigureFilter.rst | 132 ------ .../docs/WriteStatsGenOdfAngleFileFilter.md | 23 +- .../docs/WriteStatsGenOdfAngleFileFilter.rst | 157 ------- .../TestOne/docs/DynamicTableExample.rst | 12 - .../TestOne/docs/ErrorWarningFilter.rst | 12 - src/Plugins/TestOne/docs/ExampleFilter1.rst | 12 - src/Plugins/TestOne/docs/ExampleFilter2.rst | 12 - src/Plugins/TestOne/docs/TestFilter.rst | 12 - src/Plugins/TestTwo/docs/Test2Filter.rst | 12 - wrapping/python/docs/CMakeLists.txt | 8 +- 475 files changed, 1950 insertions(+), 24377 deletions(-) delete mode 100644 docs/index.rst delete mode 100644 src/Plugins/ComplexCore/docs/AbaqusHexahedronWriterFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/AddBadDataFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/AlignGeometries.rst delete mode 100644 src/Plugins/ComplexCore/docs/AlignSectionsFeatureCentroidFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/AlignSectionsListFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/AppendImageGeometryZSliceFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/ApplyTransformationToGeometryFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/ApproximatePointCloudHull.rst delete mode 100644 src/Plugins/ComplexCore/docs/ArrayCalculatorFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/AvizoRectilinearCoordinateWriterFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/AvizoUniformCoordinateWriterFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/CalculateArrayHistogramFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/CalculateFeatureSizesFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/CalculateTriangleAreasFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/ChangeAngleRepresentation.rst delete mode 100644 src/Plugins/ComplexCore/docs/CombineAttributeArraysFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/CombineStlFilesFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/ComputeFeatureRectFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/ComputeMomentInvariants2DFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/ConditionalSetValue.rst delete mode 100644 src/Plugins/ComplexCore/docs/ConvertColorToGrayScaleFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/ConvertDataFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/CopyDataObjectFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/CopyFeatureArrayToElementArray.rst delete mode 100644 src/Plugins/ComplexCore/docs/CreateAttributeMatrixFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/CreateDataArray.rst delete mode 100644 src/Plugins/ComplexCore/docs/CreateDataGroup.rst delete mode 100644 src/Plugins/ComplexCore/docs/CreateFeatureArrayFromElementArray.rst delete mode 100644 src/Plugins/ComplexCore/docs/CreateGeometryFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/CreateImageGeometry.rst delete mode 100644 src/Plugins/ComplexCore/docs/CropImageGeometry.rst delete mode 100644 src/Plugins/ComplexCore/docs/CropVertexGeometry.rst delete mode 100644 src/Plugins/ComplexCore/docs/DeleteData.rst delete mode 100644 src/Plugins/ComplexCore/docs/ErodeDilateBadDataFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/ErodeDilateCoordinationNumberFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/ErodeDilateMaskFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/ExecuteProcessFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/ExportDREAM3DFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/ExtractComponentAsArrayFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/ExtractInternalSurfacesFromTriangleGeometry.rst delete mode 100644 src/Plugins/ComplexCore/docs/ExtractVertexGeometryFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/FeatureDataCSVWriterFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/FeatureFaceCurvatureFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/FillBadDataFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/FindArrayStatisticsFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/FindBiasedFeaturesFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/FindBoundaryCellsFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/FindBoundaryElementFractionsFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/FindDifferencesMap.rst delete mode 100644 src/Plugins/ComplexCore/docs/FindEuclideanDistMapFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/FindFeatureCentroidsFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/FindFeatureClusteringFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/FindFeaturePhasesBinaryFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/FindFeaturePhasesFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/FindLargestCrossSectionsFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/FindNeighborListStatistics.rst delete mode 100644 src/Plugins/ComplexCore/docs/FindNeighborhoodsFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/FindNeighbors.rst delete mode 100644 src/Plugins/ComplexCore/docs/FindNumFeaturesFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/FindSurfaceAreaToVolumeFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/FindSurfaceFeatures.rst delete mode 100644 src/Plugins/ComplexCore/docs/FindTriangleGeomCentroidsFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/FindTriangleGeomSizesFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/FindVertexToTriangleDistancesFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/FindVolFractionsFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/GenerateColorTableFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/GenerateVectorColorsFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/IdentifySample.rst delete mode 100644 src/Plugins/ComplexCore/docs/ImageContouringFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/ImportBinaryCTNorthstarFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/ImportCSVDataFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/ImportDREAM3DFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/ImportDeformKeyFileV12Filter.rst delete mode 100644 src/Plugins/ComplexCore/docs/ImportHDF5Dataset.rst delete mode 100644 src/Plugins/ComplexCore/docs/ImportTextFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/ImportVolumeGraphicsFileFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/InitializeData.rst delete mode 100644 src/Plugins/ComplexCore/docs/InterpolatePointCloudToRegularGridFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/IterativeClosestPointFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/KMeansFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/KMedoidsFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/LaplacianSmoothingFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/LosAlamosFFTWriterFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/MapPointCloudToRegularGridFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/MinNeighbors.rst delete mode 100644 src/Plugins/ComplexCore/docs/MoveData.rst delete mode 100644 src/Plugins/ComplexCore/docs/MultiThresholdObjects.rst delete mode 100644 src/Plugins/ComplexCore/docs/NearestPointFuseRegularGridsFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/PartitionGeometryFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/PointSampleTriangleGeometryFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/QuickSurfaceMeshFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/RawBinaryReaderFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/RegularGridSampleSurfaceMesh.rst delete mode 100644 src/Plugins/ComplexCore/docs/RegularGridSampleSurfaceMeshFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/RemoveFlaggedFeaturesFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/RemoveFlaggedVertices.rst delete mode 100644 src/Plugins/ComplexCore/docs/RemoveMinimumSizeFeaturesFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/RenameDataObject.rst delete mode 100644 src/Plugins/ComplexCore/docs/ReplaceElementAttributesWithNeighborValuesFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/ResampleImageGeomFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/ResampleRectGridToImageGeomFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/ReverseTriangleWindingFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/RobustAutomaticThreshold.rst delete mode 100644 src/Plugins/ComplexCore/docs/RotateSampleRefFrameFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/ScalarSegmentFeaturesFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/SetImageGeomOriginScalingFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/SharedFeatureFaceFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/SilhouetteFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/SplitAttributeArrayFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/StlFileReaderFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/SurfaceNetsFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/TriangleCentroidFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/TriangleDihedralAngleFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/TriangleNormalFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/UncertainRegularGridSampleSurfaceMesh.rst delete mode 100644 src/Plugins/ComplexCore/docs/UncertainRegularGridSampleSurfaceMeshFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/VtkRectilinearGridWriterFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/WriteASCIIDataFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/WriteBinaryDataFilter.rst delete mode 100644 src/Plugins/ComplexCore/docs/WriteStlFileFilter.rst delete mode 100644 src/Plugins/ITKImageProcessing/PortingITKImageProcessingFilter.rst delete mode 100644 src/Plugins/ITKImageProcessing/docs/ITKAbsImage.rst delete mode 100644 src/Plugins/ITKImageProcessing/docs/ITKAcosImage.rst delete mode 100644 src/Plugins/ITKImageProcessing/docs/ITKAdaptiveHistogramEqualizationImage.rst delete mode 100644 src/Plugins/ITKImageProcessing/docs/ITKAsinImage.rst delete mode 100644 src/Plugins/ITKImageProcessing/docs/ITKAtanImage.rst delete mode 100644 src/Plugins/ITKImageProcessing/docs/ITKBinaryContourImage.rst delete mode 100644 src/Plugins/ITKImageProcessing/docs/ITKBinaryDilateImage.rst delete mode 100644 src/Plugins/ITKImageProcessing/docs/ITKBinaryErodeImage.rst delete mode 100644 src/Plugins/ITKImageProcessing/docs/ITKBinaryMorphologicalClosingImage.rst delete mode 100644 src/Plugins/ITKImageProcessing/docs/ITKBinaryMorphologicalOpeningImage.rst delete mode 100644 src/Plugins/ITKImageProcessing/docs/ITKBinaryOpeningByReconstructionImage.rst delete mode 100644 src/Plugins/ITKImageProcessing/docs/ITKBinaryProjectionImage.rst delete mode 100644 src/Plugins/ITKImageProcessing/docs/ITKBinaryThinningImage.rst delete mode 100644 src/Plugins/ITKImageProcessing/docs/ITKBinaryThresholdImage.rst delete mode 100644 src/Plugins/ITKImageProcessing/docs/ITKBlackTopHatImage.rst delete mode 100644 src/Plugins/ITKImageProcessing/docs/ITKClosingByReconstructionImage.rst delete mode 100644 src/Plugins/ITKImageProcessing/docs/ITKCosImage.rst delete mode 100644 src/Plugins/ITKImageProcessing/docs/ITKDilateObjectMorphologyImage.rst delete mode 100644 src/Plugins/ITKImageProcessing/docs/ITKDiscreteGaussianImage.rst delete mode 100644 src/Plugins/ITKImageProcessing/docs/ITKErodeObjectMorphologyImage.rst delete mode 100644 src/Plugins/ITKImageProcessing/docs/ITKExpImage.rst delete mode 100644 src/Plugins/ITKImageProcessing/docs/ITKExpNegativeImage.rst delete mode 100644 src/Plugins/ITKImageProcessing/docs/ITKGradientMagnitudeImage.rst delete mode 100644 src/Plugins/ITKImageProcessing/docs/ITKGrayscaleDilateImage.rst delete mode 100644 src/Plugins/ITKImageProcessing/docs/ITKGrayscaleErodeImage.rst delete mode 100644 src/Plugins/ITKImageProcessing/docs/ITKGrayscaleFillholeImage.rst delete mode 100644 src/Plugins/ITKImageProcessing/docs/ITKGrayscaleGrindPeakImage.rst delete mode 100644 src/Plugins/ITKImageProcessing/docs/ITKGrayscaleMorphologicalClosingImage.rst delete mode 100644 src/Plugins/ITKImageProcessing/docs/ITKGrayscaleMorphologicalOpeningImage.rst delete mode 100644 src/Plugins/ITKImageProcessing/docs/ITKHConvexImage.rst delete mode 100644 src/Plugins/ITKImageProcessing/docs/ITKHMaximaImage.rst delete mode 100644 src/Plugins/ITKImageProcessing/docs/ITKHMinimaImage.rst delete mode 100644 src/Plugins/ITKImageProcessing/docs/ITKImageReader.rst delete mode 100644 src/Plugins/ITKImageProcessing/docs/ITKImageWriter.rst delete mode 100644 src/Plugins/ITKImageProcessing/docs/ITKImportFijiMontageFilter.rst delete mode 100644 src/Plugins/ITKImageProcessing/docs/ITKImportImageStack.rst delete mode 100644 src/Plugins/ITKImageProcessing/docs/ITKIntensityWindowingImage.rst delete mode 100644 src/Plugins/ITKImageProcessing/docs/ITKInvertIntensityImage.rst delete mode 100644 src/Plugins/ITKImageProcessing/docs/ITKLabelContourImage.rst delete mode 100644 src/Plugins/ITKImageProcessing/docs/ITKLog10Image.rst delete mode 100644 src/Plugins/ITKImageProcessing/docs/ITKLogImage.rst delete mode 100644 src/Plugins/ITKImageProcessing/docs/ITKMaskImage.rst delete mode 100644 src/Plugins/ITKImageProcessing/docs/ITKMedianImage.rst delete mode 100644 src/Plugins/ITKImageProcessing/docs/ITKMhaFileReader.rst delete mode 100644 src/Plugins/ITKImageProcessing/docs/ITKMorphologicalGradientImage.rst delete mode 100644 src/Plugins/ITKImageProcessing/docs/ITKMorphologicalWatershedImage.rst delete mode 100644 src/Plugins/ITKImageProcessing/docs/ITKNormalizeImage.rst delete mode 100644 src/Plugins/ITKImageProcessing/docs/ITKNotImage.rst delete mode 100644 src/Plugins/ITKImageProcessing/docs/ITKOpeningByReconstructionImage.rst delete mode 100644 src/Plugins/ITKImageProcessing/docs/ITKOtsuMultipleThresholdsImage.rst delete mode 100644 src/Plugins/ITKImageProcessing/docs/ITKRelabelComponentImage.rst delete mode 100644 src/Plugins/ITKImageProcessing/docs/ITKRescaleIntensityImage.rst delete mode 100644 src/Plugins/ITKImageProcessing/docs/ITKSigmoidImage.rst delete mode 100644 src/Plugins/ITKImageProcessing/docs/ITKSignedMaurerDistanceMapImage.rst delete mode 100644 src/Plugins/ITKImageProcessing/docs/ITKSinImage.rst delete mode 100644 src/Plugins/ITKImageProcessing/docs/ITKSqrtImage.rst delete mode 100644 src/Plugins/ITKImageProcessing/docs/ITKSquareImage.rst delete mode 100644 src/Plugins/ITKImageProcessing/docs/ITKTanImage.rst delete mode 100644 src/Plugins/ITKImageProcessing/docs/ITKThresholdImage.rst delete mode 100644 src/Plugins/ITKImageProcessing/docs/ITKValuedRegionalMaximaImage.rst delete mode 100644 src/Plugins/ITKImageProcessing/docs/ITKValuedRegionalMinimaImage.rst delete mode 100644 src/Plugins/ITKImageProcessing/docs/ITKWhiteTopHatImage.rst delete mode 100644 src/Plugins/ITKImageProcessing/tools/ReadMe.rst delete mode 100644 src/Plugins/OrientationAnalysis/3rdParty/canvas_ity/ReadMe.rst delete mode 100644 src/Plugins/OrientationAnalysis/PortingOrientationAnalysisFilter.rst delete mode 100644 src/Plugins/OrientationAnalysis/Support/GMT/UsingGMT.rst delete mode 100644 src/Plugins/OrientationAnalysis/data/ReadMe.rst delete mode 100644 src/Plugins/OrientationAnalysis/docs/AlignSectionsMisorientationFilter.rst delete mode 100644 src/Plugins/OrientationAnalysis/docs/AlignSectionsMutualInformationFilter.rst delete mode 100644 src/Plugins/OrientationAnalysis/docs/BadDataNeighborOrientationCheckFilter.rst delete mode 100644 src/Plugins/OrientationAnalysis/docs/CAxisSegmentFeaturesFilter.rst delete mode 100644 src/Plugins/OrientationAnalysis/docs/ConvertOrientations.rst delete mode 100644 src/Plugins/OrientationAnalysis/docs/ConvertQuaternionFilter.rst delete mode 100644 src/Plugins/OrientationAnalysis/docs/CreateEnsembleInfoFilter.rst delete mode 100644 src/Plugins/OrientationAnalysis/docs/EBSDSegmentFeaturesFilter.rst delete mode 100644 src/Plugins/OrientationAnalysis/docs/EbsdToH5EbsdFilter.rst delete mode 100644 src/Plugins/OrientationAnalysis/docs/EnsembleInfoReaderFilter.rst delete mode 100644 src/Plugins/OrientationAnalysis/docs/ExportGBCDGMTFileFilter.rst delete mode 100644 src/Plugins/OrientationAnalysis/docs/ExportGBCDTriangleDataFilter.rst delete mode 100644 src/Plugins/OrientationAnalysis/docs/FindAvgCAxesFilter.rst delete mode 100644 src/Plugins/OrientationAnalysis/docs/FindAvgOrientationsFilter.rst delete mode 100644 src/Plugins/OrientationAnalysis/docs/FindBoundaryStrengthsFilter.rst delete mode 100644 src/Plugins/OrientationAnalysis/docs/FindCAxisLocationsFilter.rst delete mode 100644 src/Plugins/OrientationAnalysis/docs/FindFeatureNeighborCAxisMisalignmentsFilter.rst delete mode 100644 src/Plugins/OrientationAnalysis/docs/FindFeatureReferenceCAxisMisorientationsFilter.rst delete mode 100644 src/Plugins/OrientationAnalysis/docs/FindFeatureReferenceMisorientationsFilter.rst delete mode 100644 src/Plugins/OrientationAnalysis/docs/FindGBCDFilter.rst delete mode 100644 src/Plugins/OrientationAnalysis/docs/FindGBCDMetricBasedFilter.rst delete mode 100644 src/Plugins/OrientationAnalysis/docs/FindGBPDMetricBasedFilter.rst delete mode 100644 src/Plugins/OrientationAnalysis/docs/FindKernelAvgMisorientationsFilter.rst delete mode 100644 src/Plugins/OrientationAnalysis/docs/FindMisorientationsFilter.rst delete mode 100644 src/Plugins/OrientationAnalysis/docs/FindSchmidsFilter.rst delete mode 100644 src/Plugins/OrientationAnalysis/docs/FindShapesFilter.rst delete mode 100644 src/Plugins/OrientationAnalysis/docs/FindSlipTransmissionMetricsFilter.rst delete mode 100644 src/Plugins/OrientationAnalysis/docs/FindTriangleGeomShapesFilter.rst delete mode 100644 src/Plugins/OrientationAnalysis/docs/GenerateFZQuaternions.rst delete mode 100644 src/Plugins/OrientationAnalysis/docs/GenerateFaceIPFColoringFilter.rst delete mode 100644 src/Plugins/OrientationAnalysis/docs/GenerateFaceMisorientationColoringFilter.rst delete mode 100644 src/Plugins/OrientationAnalysis/docs/GenerateGBCDPoleFigureFilter.rst delete mode 100644 src/Plugins/OrientationAnalysis/docs/GenerateIPFColorsFilter.rst delete mode 100644 src/Plugins/OrientationAnalysis/docs/GeneratePoleFigureFilter.rst delete mode 100644 src/Plugins/OrientationAnalysis/docs/GenerateQuaternionConjugateFilter.rst delete mode 100644 src/Plugins/OrientationAnalysis/docs/INLWriterFilter.rst delete mode 100644 src/Plugins/OrientationAnalysis/docs/ImportH5EspritDataFilter.rst delete mode 100644 src/Plugins/OrientationAnalysis/docs/ImportH5OimDataFilter.rst delete mode 100644 src/Plugins/OrientationAnalysis/docs/MergeTwinsFilter.rst delete mode 100644 src/Plugins/OrientationAnalysis/docs/NeighborOrientationCorrelationFilter.rst delete mode 100644 src/Plugins/OrientationAnalysis/docs/ReadAngDataFilter.rst delete mode 100644 src/Plugins/OrientationAnalysis/docs/ReadCtfDataFilter.rst delete mode 100644 src/Plugins/OrientationAnalysis/docs/ReadH5EbsdFilter.rst delete mode 100644 src/Plugins/OrientationAnalysis/docs/RodriguesConvertorFilter.rst delete mode 100644 src/Plugins/OrientationAnalysis/docs/RotateEulerRefFrameFilter.rst delete mode 100644 src/Plugins/OrientationAnalysis/docs/WritePoleFigureFilter.rst delete mode 100644 src/Plugins/OrientationAnalysis/docs/WriteStatsGenOdfAngleFileFilter.rst delete mode 100644 src/Plugins/TestOne/docs/DynamicTableExample.rst delete mode 100644 src/Plugins/TestOne/docs/ErrorWarningFilter.rst delete mode 100644 src/Plugins/TestOne/docs/ExampleFilter1.rst delete mode 100644 src/Plugins/TestOne/docs/ExampleFilter2.rst delete mode 100644 src/Plugins/TestOne/docs/TestFilter.rst delete mode 100644 src/Plugins/TestTwo/docs/Test2Filter.rst diff --git a/PortingFilters.md b/PortingFilters.md index b078c05604..7f2a2b267b 100644 --- a/PortingFilters.md +++ b/PortingFilters.md @@ -1,4 +1,4 @@ -# Porting a Filter # +# Porting a Filter Depending on where the ported filter is coming from determines what you need to do. The sections are as follows: @@ -13,17 +13,17 @@ do. The sections are as follows: -## SECTION 1 : Porting From ***SIMPL*** to ***Filters Folder*** ## +## SECTION 1 : Porting From ***SIMPL*** to ***Filters Folder*** This will be the most common type of Filter porting. The steps for this are as follows: -### Go to FreeNas and pull the custom build of DREAM3D ### +### Go to FreeNas and pull the custom build of DREAM3D This custom build has **ALL** ***SIMPL*** plugins compiled so you don't need to worry about what filters will be available -### Load up ***SIMPL*** DREAM3D and navigate to ***ComplexFilterGen*** ### +### Load up ***SIMPL*** DREAM3D and navigate to ***ComplexFilterGen*** Here you will need to set the command arguments using the following syntax: @@ -40,14 +40,14 @@ Some nuances to note for this are as follows: You will need to update the various CMake files inside the target complex plugin in order to start compiling the new filter code inside of a complex build. -## SECTION 2 : Porting stubs from existing folder to ***Filters Folder*** ## +## SECTION 2 : Porting stubs from existing folder to ***Filters Folder*** Some plugins have existing stubs in folders other than the primary ***Filters*** folder. -### Move the Filter and Algorithm files to the active ***Filters Folder*** ### +### Move the Filter and Algorithm files to the active ***Filters Folder*** -### Update the Legacy UUID Maps ### +### Update the Legacy UUID Maps
  1. Open the LegacyUUIDMapping header file for this Plugin
  2. Find and uncomment the include statement for the filter being moved
  3. @@ -63,12 +63,12 @@ folder. > ***@@__MAP__UPDATE__TOKEN__DO__NOT__DELETE__@@*** - ### Update the CMakeLists.txt files to reflect the changes ### + ### Update the CMakeLists.txt files to reflect the changes This includes the ones for the unit tests and the one at the plugin level -## SECTION 3 : Developing a Test File ## +## SECTION 3 : Developing a Test File Firstly, it is important to ensure that each unit test does not just instantiate filter. Current standards require the following:
      @@ -79,7 +79,7 @@ Firstly, it is important to ensure that each unit test does not just instantiate Test Files should **NOT** output strings to the terminal. Output should be in the form of catch2 errors. -### Adding a new data file to ***DREAM3D Data Repo*** ### +### Adding a new data file to ***DREAM3D Data Repo*** For adding the data file to the DREAM3D repo one should follow the following steps: @@ -100,7 +100,7 @@ GitHub Repo : REQUIRE(nullptr != filter); -## SECTION 4 : Multithreading ## +## SECTION 4 : Multithreading At the current time, the only filters that should be made parallel are those that could be considered "embarrassingly parallel". It is important to remember that the cost of creating a thread is hefty so it should only be done when there is a sizeable amount of work available for each thread. Complex has two types: ParallelTaskAlgorithm and ParallelDataAlgorithm. Task Runner is for parsing multiple objects and Data Runner is for parsing a single object. -### Syntax for Complex ### +### Syntax for Complex This is an examplar use case and doesn't truly encompass all possible use cases for the functions, but instead serves to show how it should be structured in most cases. @@ -163,11 +163,11 @@ In the exectuting function: > dataAlg.execute(::FilterNameImpl(object, argument)); -## SECTION 5 : Progress Updating ## +## SECTION 5 : Progress Updating With out of core functionality on the way, it is now a requirement for each and every filter to have progress updates and checks for cancel. This section shows threadsafe progress updating and message structuring. -### ThreadSafe Progress Messaging ### +### ThreadSafe Progress Messaging This is an example that aims to reduce the number of times a mutex lock is called. @@ -189,7 +189,7 @@ This is an example that aims to reduce the number of times a mutex lock is calle This function should avoid being called too many times in a thread as it would significantly slow it down. -### Message Structuring ### +### Message Structuring For error messaging the following syntax should be used: @@ -198,11 +198,11 @@ For error messaging the following syntax should be used: The number at the start is an arbitrary value save for the fact it must be negative. -## SECTION 6 : Utilizing API's to the fullest ## +## SECTION 6 : Utilizing API's to the fullest This section aims to tackle ***complex*** convenience functions from major API's: -### Utilizing the ExecuteDataFunction ### +### Utilizing the ExecuteDataFunction These templated varg functions aim to eliminate the need for type switches, this is done using functors. Below is example syntax: @@ -224,7 +224,7 @@ In the executing function: > ExecuteDataFunction(FilterNameFunctor{}, selectedArrayRef.getDataType(), selectedArrayRef, argumentBool); -## SECTION 7 : Useful Tips and Tricks ## +## SECTION 7 : Useful Tips and Tricks This section is just for basic genralized tips to help make our code better:
        diff --git a/README.md b/README.md index 1abf433f17..cb0323f8d4 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -# complex # +# complex [![windows](https://github.com/BlueQuartzSoftware/complex/actions/workflows/windows.yml/badge.svg)](https://github.com/BlueQuartzSoftware/complex/actions/workflows/windows.yml) [![linux](https://github.com/BlueQuartzSoftware/complex/actions/workflows/linux.yml/badge.svg)](https://github.com/BlueQuartzSoftware/complex/actions/workflows/linux.yml) [![macos](https://github.com/BlueQuartzSoftware/complex/actions/workflows/macos.yml/badge.svg)](https://github.com/BlueQuartzSoftware/complex/actions/workflows/macos.yml) [![clang-format](https://github.com/BlueQuartzSoftware/complex/actions/workflows/format_push.yml/badge.svg)](https://github.com/BlueQuartzSoftware/complex/actions/workflows/format_push.yml) -## License and Public Release Notice ## +## License and Public Release Notice This software library is directly supported by USAF Contract *FA8650-22-C-5290* and has been cleared as publicly releasable under the following: @@ -18,11 +18,11 @@ This software library is directly supported by USAF Contract *FA8650-22-C-5290* This clearance is in effect until 14 SEPT 2025 at which point any new additions created under USAF funding should be cleared. Public additions through the normal PR process will not be affected. -## Introduction ## +## Introduction `complex` is a rewrite of the [SIMPL](https://www.github.com/bluequartzsoftware/simpl) library upon which [DREAM3D](https://www.github.com/bluequartzsoftware/dream3d) is written. This library aims to be fully C++17 compliant, removes the need for Qt5 at the library level and brings more flexible data organization and grouping options. -## Dependent Libraries ## +## Dependent Libraries | Library Name | GitHub Source | Version | |--------------|---------------|---------| @@ -42,7 +42,7 @@ This clearance is in effect until 14 SEPT 2025 at which point any new additions | nod | | 0.5.2 | | reproc | | 14.2.4 | -## Prerequisites ## +## Prerequisites In order to compile `complex` you will need a C++17 compiler suite installed on your computer. @@ -51,11 +51,11 @@ In order to compile `complex` you will need a C++17 compiler suite installed on + macOS 11.0 and Xcode 12.4 or higher + Linux with GCC Version 9.0 or higher or clang. -## Install vcpkg ## +## Install vcpkg The `complex` project uses the [vcpkg](https://www.github.com/microsoft/vcpkg) to manage it's dependent libraries. If this is not already installed on your system then you will need to download and compile it. -### Windows ### +### Windows Clone the vcpkg repository into a location that it will be used from. inside your home directory or at `C:/vcpkg` is a reasonable spot. *DO NOT USE A PATH WITH SPACES IN ANY OF THE FOLDERS*. @@ -64,7 +64,7 @@ Clone the vcpkg repository into a location that it will be used from. inside you The `bootstrap-vcpkg.bat` file should be run automatically by CMake the first time. This will create the `vcpkg.exe` file. Additionally CMake should automatically find `vcpkg.exe`. If CMake does not find it, you may need to add it to your `PATH` variable. -## Clone Appropriate Repositories ## +## Clone Appropriate Repositories Within the folder DREAM3D-Dev clone both the `complex` and `DREAM3D_Data` repositories. The `DREAM3D_Data` repo is optional but does contain testing data. @@ -72,13 +72,13 @@ Create a location to keep the `complex` repositories and make builds. You can do git clone --recursive https://github.com/bluequartzsoftware/complex -## Configure complex with CMake ## +## Configure complex with CMake For this example we are going to do an "in-source" build. By default git will ignore some basic names for build directories such as `Debug, Release, x64`. CMake can generate lots of project files from ninja, to nmake to Visual Studio. For this example we are going to use the `ninja` generator so we will need to keep the Debug and Release builds separated. The first time `complex` is configured with CMake, VCPKG will download, build and install the needed dependent libraries. This can take a few minutes so be patient. After `complex` is configured you can build it using your IDE (Visual Studio) or ninja (QtCreator, CLion) or cmake itself. -### Windows with Visual Studio IDE ### +### Windows with Visual Studio IDE This example shows how to configure complex to build using Visual Studio IDE @@ -90,7 +90,7 @@ This example shows how to configure complex to build using Visual Studio IDE cmake -G "Visual Studio 16 2019" -A x64 -DCMAKE_TOOLCHAIN_FILE=%VCPKG_INSTALL_ROOT%/scripts/buildsystems/vcpkg.cmake -DCMAKE_BUILD_TYPE=%BUILD_DIR% -DVCPKG_MANIFEST_FEATURES="tests;parallel" -DDREAM3D_Data_Dir=../../DREAM3D_Data ../complex -### Windows with Ninja and IDE of choice (QtCreator, CLion, command line) ### +### Windows with Ninja and IDE of choice (QtCreator, CLion, command line) Adjust the below commands to the sytle of your shell (The below example is done in Windows Command Prompt Batch file style). @@ -106,7 +106,7 @@ In this example we are building a Release version of compled into a directory ca cmake -G Ninja -DCMAKE_TOOLCHAIN_FILE=%VCPKG_INSTALL_ROOT%/scripts/buildsystems/vcpkg.cmake -DCMAKE_BUILD_TYPE=%BUILD_DIR% -DVCPKG_MANIFEST_FEATURES="tests;parallel" -DDREAM3D_Data_Dir=../../DREAM3D_Data ../complex -### macOS ARM64/M1 Compile and IDE of choice (QtCreator, CLion, command line) ### +### macOS ARM64/M1 Compile and IDE of choice (QtCreator, CLion, command line) export NINJA_INSTALL=/opt/local/bin export PATH=$PATH:$NINJA_INSTALL @@ -122,7 +122,7 @@ In this example we are building a Release version of compled into a directory ca cmake -G Ninja -DCMAKE_TOOLCHAIN_FILE=$VCPKG_INSTALL_ROOT/scripts/buildsystems/vcpkg.cmake -DCMAKE_BUILD_TYPE=$BUILD_DIR -DVCPKG_MANIFEST_FEATURES="tests;parallel" -DDREAM3D_DATA_DIR=$HOME/Workspace1/DREAM3D_Data -DVCPKG_TARGET_TRIPLET:STRING=$VCPKG_TARGET_TRIPLET ../complex -## Required CMake Arguments ## +## Required CMake Arguments + `-G` and one of the supported CMake generator strings + `Ninja` works very well on all platforms if you have [ninja](https://github.com/ninja-build/ninja/releases) @@ -135,11 +135,11 @@ In this example we are building a Release version of compled into a directory ca + Linux: x64-linux-dynamic + Windows: -## Adding Plugins ## +## Adding Plugins By default the **only** plugin that is compiled is the `ComplexCore` plugin. If you would like to build any of the additional plugins you can provide additional arguments to the configuration command. **NOTE** For the `COMPLEX_EXTRA_PLUGINS` CMake argument, if you have multiple plugins separate each with a `;` character (which is why we double quote the value for the COMPLEX_EXTRA_PLUGINS variable.) -### ITKImageProcessing ### +### ITKImageProcessing This plugin gives complex access to the ability to read/write images and use the **ITK** library to process images. @@ -148,28 +148,28 @@ There are 2 arguments that need to be added to the CMake configuration command + `-DCOMPLEX_EXTRA_PLUGINS="ITKImageProcessing"` + `-DVCPKG_MANIFEST_FEATURES="tests;parallel;itk"` -### OrientationAnalysis ### +### OrientationAnalysis This plugin gives complex the ability to process typical EBSD style of data. + `-DCOMPLEX_EXTRA_PLUGINS="OrientationAnalysis"` + `-DVCPKG_MANIFEST_FEATURES="tests;parallel;ebsd"` -## VCPKG Options ## +## VCPKG Options -### Defining where VCPKG installs the dependent libraries ### +### Defining where VCPKG installs the dependent libraries By default VCPKG will install any library that it compiles into vcpkg specific and platform specific locations. If you would like to specifically set where those libraries are installed the following cmake code will allow that: + `-DVCPKG_INSTALLED_DIR=$HOME/workspace/vcpkg-installed` -### Disable VCPKG from checking for updates with each configuration ### +### Disable VCPKG from checking for updates with each configuration Be default VCPKG will check for updates to the libraries that it compiles. If you would like to skip this step each time the following CMake code is needed: + `-DVCPKG_MANIFEST_INSTALL=OFF` -## Defining where test data is stored ## +## Defining where test data is stored Complex and its plugins require test files to be able to perform the unit tests. By default these will be store inside the build directory. This means that if you have multiple build directories, a separate copy of all the test files will be downloaded for each build directory. The developer can set the `DREAM3D_DATA_DIR` variable to a path that will be used. They will need to set this for **each** build directory. You **MUST** define `DREAM3D_DATA_DIR` using an absolute path. Relative paths **will not work**. @@ -179,7 +179,7 @@ The developer can also turn off the downloading of any test data with the follow + `-DCOMPLEX_DOWNLOAD_TEST_FILES=OFF` -## Python Bindings ## +## Python Bindings Python bindings are available for complex. To install them, please use an Anaconda virtual environment like the following: diff --git a/cmake/Plugin.cmake b/cmake/Plugin.cmake index 23a7050ec8..36ba7eee74 100644 --- a/cmake/Plugin.cmake +++ b/cmake/Plugin.cmake @@ -222,8 +222,8 @@ function(create_complex_plugin) foreach(file_name ${ARGS_FILTER_LIST}) #message(STATUS "CHECKING DOCS FOR ${file_name}") #string(REPLACE "Filter" "" file_name ${file_name}) - if(NOT EXISTS "${${ARGS_NAME}_SOURCE_DIR}/docs/${file_name}.rst") - message(STATUS "!!!> DOCUMENTATION WARNING:${${ARGS_NAME}_SOURCE_DIR}/docs/${file_name}.rst Does Not Exist") + if(NOT EXISTS "${${ARGS_NAME}_SOURCE_DIR}/docs/${file_name}.md") + message(STATUS "!!!> DOCUMENTATION WARNING:${${ARGS_NAME}_SOURCE_DIR}/docs/${file_name}.md Does Not Exist") endif() endforeach() endif() diff --git a/docs/Code_Style_Guide.md b/docs/Code_Style_Guide.md index 8e8040f504..4c12550166 100644 --- a/docs/Code_Style_Guide.md +++ b/docs/Code_Style_Guide.md @@ -3,16 +3,16 @@ This is the style guide for the COMPLEX library. When contributing sources to the complex repository we ask that all contributions follow this style guide. These general rules have been developed over the years in an effort to allow efficient coding practices. -## Source Code Line Endings ## +## Source Code Line Endings All source code line endings should be in "Unix" style "\n". Every text editor understands these line endings on every platform **except** the "Notepad" application on Windows. -## Use of Tabs ## +## Use of Tabs Spaces should be used instead of hard tabs. This helps file portability across different editors. DREAM.3D uses a standard whereby all indents use two spaces. -## Always Use an Include Guard ## +## Always Use an Include Guard Always use @@ -20,7 +20,7 @@ Always use at the top of *EVERY* header file. -## Special Constants ## +## Special Constants nullptr should be used in conjunction with only raw pointers and 0 (zero) should be used in conjunction with numeric values: @@ -31,14 +31,14 @@ nullptr should be used in conjunction with only raw pointers and 0 (zero) should int i = NULL; // Bad -## Array Initialization ## +## Array Initialization Prefer the use of C++11 std::array instead of "C" style arrays. int32_t foo[3]; // BAD.. No initialization of the internal data std::array foo = {0,0,0}; -## The Dereference operator `*` and the Address-Of Operator `&` Should Be Directly Connected with the Type-Specifier ## +## The Dereference operator `*` and the Address-Of Operator `&` Should Be Directly Connected with the Type-Specifier int32* p; // Correct int32 *p; // Incorrect @@ -46,7 +46,7 @@ Prefer the use of C++11 std::array instead of "C" style arrays. The _int32* p;_ form emphasizes type over syntax while the _int32 *p;_ form emphasizes syntax over type. Although both forms are equally valid C++, the heavy emphasis on types in C++ suggests that _int32* p;_ is the preferable form. -## Always Implement the "Big Five" in C++ Classes ## +## Always Implement the "Big Five" in C++ Classes When writing C++ classes the programmer will always define the "Big Three" which are defined as: @@ -88,7 +88,7 @@ There is an include clang-tidy file that most IDE's can use to assist with some - Macros are `ALL_UPPER_SNAKE_CASE` -## String Constants ## +## String Constants String constants in C++ should be declared as: diff --git a/docs/Porting_Filters.md b/docs/Porting_Filters.md index 18a6067a6b..12c8c1cf8e 100644 --- a/docs/Porting_Filters.md +++ b/docs/Porting_Filters.md @@ -1,6 +1,6 @@ -# Porting Filter Notes # +# Porting Filter Notes -## Porting Checklist ## +## Porting Checklist - [ ] Parameters should be generally broken down into "Input Parameters", "Required Data Objects", "Created Data Objects". There can be exceptions to this. - [ ] ChoicesParameter selections should be an enumeration defined in the filer header @@ -15,7 +15,7 @@ static inline constexpr StringLiteral k_AlignmentType_Key = "alignment_type"; - [ ] Filters should have both the Filter class and Algorithm class for anything beyond trivial needs -## Converting Types ## +## Converting Types + QString => std::string + QVector<> => std::vector<> @@ -36,7 +36,7 @@ COMPLEX then you can optionally return the `result` variable if needed -## QString operations ## +## QString operations There are some substitutions for the QString operations. See [https://en.cppreference.com/w/cpp/string/basic_string](https://en.cppreference.com/w/cpp/string/basic_string) for @@ -44,7 +44,7 @@ more information about std::string There is a file `complex/Utilities/StringUtilities.hpp` that has some QString functionality that is needed. -## Getting a Geometry from the DataStructure ## +## Getting a Geometry from the DataStructure If you know the path to the Geometry: @@ -53,11 +53,11 @@ If you know the path to the Geometry: TriangleGeom& triangleGeom = dataStructure.getDataRefAs(triangleGeometryDataPath); ``` -## Resizing Attribute Matrix ## +## Resizing Attribute Matrix If your codes specifically resize the AttributeMatrix, this is not needed anymore. -## QString Formatting ## +## QString Formatting Use the `format` library @@ -69,7 +69,7 @@ QString msg = QString("Error reading Triangle '%1'. Object Count was %2 and shou std::string msg = fmt::format("Error reading Triangle '{}}'. Object Count was {} and should have been {}", t, objsRead, k_StlElementCount); ``` -## Get An Array from the DataStructure ## +## Get An Array from the DataStructure Example of getting an array and summing the values using range based for loop. @@ -83,13 +83,13 @@ Example of getting an array and summing the values using range based for loop. } ``` -## Chaining Together DataPath + String to form new DataPath ## +## Chaining Together DataPath + String to form new DataPath ```c++ DataPath triangleAreasDataPath = geometryPath.createChildPath(triangleFaceDataGroupName).createChildPath("Triangle Areas"); ``` -## Print out the preflight errors during a Unit Test ## +## Print out the preflight errors during a Unit Test ```c++ auto preflightResult = filter.preflight(dataGraph, args); @@ -102,7 +102,7 @@ Example of getting an array and summing the values using range based for loop. } ``` -## Moving from Pointer based array navigation ## +## Moving from Pointer based array navigation Previously inside of SIMPL one would have done the following to get the raw pointer to the data stored in a DataArray: @@ -123,7 +123,7 @@ Note the use of a *Reference Variable* instead of the pointer. The developer can code such as `vertex[index]` to get/set a value but the code `vertex = i` to move a pointer **will not work**. -## Selecting Geometry from a Parameter ## +## Selecting Geometry from a Parameter If you need to have the user select a Geometry then you should use a `DataPathSelectionParameter`. @@ -131,14 +131,14 @@ If you need to have the user select a Geometry then you should use a `DataPathSe params.insert(std::make_unique(k_TriangleGeometry_Key, "Triangle Geometry to Sample", "", DataPath{})); ``` -## Transferring Data from one Geometry to Another ## +## Transferring Data from one Geometry to Another There are several filters (those that create a new geometry from an existing one) where the user is allowed to "transfer" data from the source geometry onto the newly created geometry. QuickSurfaceMeshFilter and PointSampleTriangleGeometryFilter both are examples of how to perform this transfer of data. -## Parallel Algorithms ## +## Parallel Algorithms There are several classes that can be used to help the developer write parallel algorithms. @@ -147,7 +147,7 @@ on the situation. `AlignSections.cpp` and `CropImageGeoemtry.cpp` both use a tas parallelism. `RotateSampleRefFrameFilter.cpp` shows an example of using ParallelData3DAlgorithm. -## Constants for Pi and Others ## +## Constants for Pi and Others ```c++ #include "complex/Common/Numbers.hpp" @@ -159,7 +159,7 @@ and use it this way: double foo = complex::numbers::k_180OverPi * 232.0; ``` -## MessageHandler ## +## MessageHandler All filters give you access to the MessageHandler class that sends status, progress, error and warning messages back to the user. @@ -178,7 +178,7 @@ and m_MessageHandler(IFilter::Message::Type::Progress, progressMessage, static_cast(progressInt)); ``` -## Creating Array within an Attribute Matrix ## +## Creating Array within an Attribute Matrix If you have a filter that needs to create an array in something like a cell attribute matrix or a feature attribute matrix then the following filters have examples. @@ -217,7 +217,7 @@ then you replace the macro with the following template function: The first 2 arguments to the above function are used by the function, any additional arguments are passed directly to your functor implementation. -## Porting SIMPL Filter ## +## Porting SIMPL Filter + Create Filter class in "PLUGIN_NAME/src/PLUGIN_NAME/Filters/xxxxFilter[.hpp|.cpp]" + Update Plugin's top level CMakeLists.txt to include the filter @@ -225,7 +225,7 @@ your functor implementation. + Update Plugin's top level CMakeLists.txt to include the algorithm + Ensure the UUID is the proper UUID from the know mappings file. -### Parameters ### +### Parameters# Use proper grouping in the parameters to help the User Interface. @@ -245,7 +245,7 @@ There are potentially 3 sections of parameters: these should be used as needed by the filter. -## Processing a Geometry In Place ## +## Processing a Geometry In Place Sometimes a filter needs allow the user to process it's geometry "in place" in order to ease the number of filters that are needed to remove temporary DataObjecsts. If your filter needs this kind of capability, then take a look at the "CropImageGeometry" or "RotateSampleRefFrame" filters diff --git a/docs/index.rst b/docs/index.rst deleted file mode 100644 index c955ec6402..0000000000 --- a/docs/index.rst +++ /dev/null @@ -1,21 +0,0 @@ -.. complex documentation master file, created by - sphinx-quickstart on Sun Jun 20 22:11:48 2021. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -Welcome to complex's documentation! -=================================== - -.. toctree:: - :maxdepth: 2 - :caption: Contents: - -.. doxygenclass:: complex::IFilter - :members: - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` diff --git a/src/Plugins/ComplexCore/docs/AbaqusHexahedronWriterFilter.md b/src/Plugins/ComplexCore/docs/AbaqusHexahedronWriterFilter.md index 5b6ce313ba..770685bcf3 100644 --- a/src/Plugins/ComplexCore/docs/AbaqusHexahedronWriterFilter.md +++ b/src/Plugins/ComplexCore/docs/AbaqusHexahedronWriterFilter.md @@ -126,8 +126,8 @@ Image ## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| Kind | Default Name | Type | Comp Dims | Description | +|---------------------------|--------------|----------|--------|---------------------------------------------| | Cell Attribute Array | FeatureIds | int32_t | (1) | Specifies to which **Feature** each **Cell** belongs | ## Created Objects diff --git a/src/Plugins/ComplexCore/docs/AbaqusHexahedronWriterFilter.rst b/src/Plugins/ComplexCore/docs/AbaqusHexahedronWriterFilter.rst deleted file mode 100644 index 8fcdcb3a6b..0000000000 --- a/src/Plugins/ComplexCore/docs/AbaqusHexahedronWriterFilter.rst +++ /dev/null @@ -1,168 +0,0 @@ -========================== -Abaqus Hexahedron Exporter -========================== - - -Group (Subgroup) -================ - -IO (Output) - -Description -=========== - -This **Filter** produces the basic five Abaqus .inp files for input into the Abaqus analysis tool. The files created -are: xxx.inp (the master file), xxx_nodes.inp, xxx_elems.inp, xxx_elset.inp and xxx_sects.inp. This **Filter** is based -on a Python script developed by Matthew W. Priddy (Ga. Tech., early 2015). - -Example Output --------------- - -The master file: - -:: - - *Heading - Job 101 - ** Job name : Job 101 - ** Generated by : DREAM3DLib Version 5.1.566.e1e7b7f - *Preprint, echo = NO, model = NO, history = NO, contact = NO - ** - ** ----------------------------Geometry---------------------------- - ** - *Include, Input = 32x32x32_nodes.inp - *Include, Input = 32x32x32_elems.inp - *Include, Input = 32x32x32_elset.inp - *Include, Input = 32x32x32_sects.inp - ** - ** ---------------------------------------------------------------- - ** - -The \_nodes.inp file: - -:: - - ** Generated by : DREAM3DLib Version 5.1.566.e1e7b7f - ** ---------------------------------------------------------------- - ** - *Node - 1, 0.000000, 0.000000, 0.000000 - 2, 0.500000, 0.000000, 0.000000 - 3, 1.000000, 0.000000, 0.000000 - 4, 1.500000, 0.000000, 0.000000 - .. - -The \_elset.inp file: - -:: - - ** Generated by : DREAM3DLib Version 5.1.566.e1e7b7f - ** ---------------------------------------------------------------- - ** - ** The element sets - *Elset, elset=cube, generate - 1, 32768, 1 - ** - ** Each Grain is made up of multiple elements - ** - *Elset, elset=Grain1_set - 24126, 24127, 24128, 24159, 24160, 24191, 24192, 25085, 25086, 25087, 25117, 25118, 25119, 25120, 25149, 25150, - 25151, 25152, 25181, 25182, 25183, 25184, 25214, 25215, 25216, 25247, 25248, 26077, 26078, 26079, 26080, 26108, - 26109, 26110, 26111, 26112, 26140, 26141, 26142, 26143, 26144, 26172, 26173, 26174, 26175, 26176, 26204, 26205, - 26206, 26207, 26208, 26237, 26238, 26239, 26240, 26270, 26271, 26272, 26303, 26304, 27069, 27070, 27071, 27072, - 27100, 27101, 27102, 27103, 27104, 27131, 27132, 27133, 27134, 27135, 27136, 27163, 27164, 27165, 27166, 27167, - 27168, 27195, 27196, 27197, 27198, 27199, 27200, 27228, 27229, 27230, 27231, 27232, 27260, 27261, 27262, 27263, - 27264, 27294, 27295, 27296, 27326, 27327, 27328, 27359, 27360, 28093, 28094, 28095, 28096, 28123, 28124, 28125, - 28126, 28127, 28128, 28155, 28156, 28157, 28158, 28159, 28160, 28187, 28188, 28189, 28190, 28191, 28192, 28219, - 28220, 28221, 28222, 28223, 28224, 28252, 28253, 28254, 28255, 28256, 28284, 28285, 28286, 28287, 28288, 28317, - 28318, 28319, 28320, 28350, 28351, 28352, 28383, 28384, 28416, 29116, 29117, 29118, 29119, 29120, 29147, 29148, - 29149, 29150, 29151, 29152, 29179, 29180, 29181, 29182, 29183, 29184, 29211, 29212, 29213, 29214, 29215, 29216, - 29243, 29244, 29245, 29246, 29247, 29248, 29276, 29277, 29278, 29279, 29280, 29308, 29309, 29310, 29311, 29312, - 29341, 29342, 29343, 29344, 29374, 29375, 29376, 29407, 29408, 29440, 30140, 30141, 30142, 30143, 30144, 30171, - 30172, 30173, 30174, 30175, 30176, 30203, 30204, 30205, 30206, 30207, 30208, 30235, 30236, 30237, 30238, 30239, - 30240, 30267, 30268, 30269, 30270, 30271, 30272, 30300, 30301, 30302, 30303, 30304, 30332, 30333, 30334, 30335, - 30336, 30365, 30366, 30367, 30368, 30398, 30399, 30400, 30431, 30432, 31164, 31165, 31166, 31167, 31168, 31195, - 31196, 31197, 31198, 31199, 31200, 31227, 31228, 31229, 31230, 31231, 31232, 31259, 31260, 31261, 31262, 31263, - 31264, 31292, 31293, 31294, 31295, 31296, 31324, 31325, 31326, 31327, 31328, 31357, 31358, 31359, 31360, 31389, - 31390, 31391, 31392, 31422, 31423, 31424, 31455, 31456, 32188, 32189, 32190, 32191, 32192, 32220, 32221, 32222, - 32223, 32224, 32251, 32252, 32253, 32254, 32255, 32256, 32284, 32285, 32286, 32287, 32288, 32316, 32317, 32318, - 32319, 32320, 32348, 32349, 32350, 32351, 32352, 32381, 32382, 32383, 32384, 32413, 32414, 32415, 32416, 32447, - 32448 - *Elset, elset=Grain2_set - .. - -The \_elems.inp file: - -:: - - ** Generated by : DREAM3DLib Version 5.1.566.e1e7b7f - ** ---------------------------------------------------------------- - ** - *Element, type=C3D8 - 1, 1091, 2, 1, 1090, 1124, 35, 34, 1123 - 2, 1092, 3, 2, 1091, 1125, 36, 35, 1124 - 3, 1093, 4, 3, 1092, 1126, 37, 36, 1125 - 4, 1094, 5, 4, 1093, 1127, 38, 37, 1126 - 5, 1095, 6, 5, 1094, 1128, 39, 38, 1127 - 6, 1096, 7, 6, 1095, 1129, 40, 39, 1128 - .. - -The \_sects.inp file: - -:: - - ** Generated by : DREAM3DLib Version 5.1.566.e1e7b7f - ** ---------------------------------------------------------------- - ** - ** Each section is a separate grain - ** Section: Grain1 - *Solid Section, elset=Grain1_set, material=Grain_Mat1 - *Hourglass Stiffness - 250 - ** -------------------------------------- - ** Section: Grain2 - *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 - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/AddBadDataFilter.md b/src/Plugins/ComplexCore/docs/AddBadDataFilter.md index 16072c26a0..199104639c 100644 --- a/src/Plugins/ComplexCore/docs/AddBadDataFilter.md +++ b/src/Plugins/ComplexCore/docs/AddBadDataFilter.md @@ -15,7 +15,7 @@ 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 | @@ -29,8 +29,8 @@ Image ## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 diff --git a/src/Plugins/ComplexCore/docs/AddBadDataFilter.rst b/src/Plugins/ComplexCore/docs/AddBadDataFilter.rst deleted file mode 100644 index 23a048bc98..0000000000 --- a/src/Plugins/ComplexCore/docs/AddBadDataFilter.rst +++ /dev/null @@ -1,75 +0,0 @@ -============ -Add Bad Data -============ - - -Group (Subgroup) -================ - -Synthetic Building (Misc) - -Description -=========== - -This **Filter** adds “bad” data to an **Image Geometry**. This **Filter** is intended to add “realism” (i.e., more -representative of an experimental dataset) to synthetic structures that don not have any “bad” **Cells**. The user can -choose to add “random noise” and/or “noise” along **Feature** boundaries. For a given type of noise, the user must then -set the volume fraction of **Cells** to set as “bad”. The volume fractions entered apply to only the set of **Cells** -that the noise would affect. For example, if the user chose *0.2* for the volume fraction of boundary “noise”, then each -boundary **Cell** would have a *20%* chance of being changed to a “bad” **Cell** and all other **Cells** would have a -*0%* chance of being changed. In order to compute noise over the **Feature** boundaries, the **Filter** needs the -Manhattan distances for each **Cell** from the **Feature** boundaries. Note that the computed Manhattan distances are -floating point values, but this **Filter** requires an integer array. To create the necessary integer array, use the -Convert Attributer Data Type **Filter** to cast the Manhattan distance array to an integer array. - -All **Attribute Arrays** that belong to the same **Attribute Matrix** as the selected *Feature Boundary Euclidean -Distances* array will have noise added to them. To flag a value as “noise”, this **Filter** will initialize a selected -*tuple* in the **Attribute Array** to **0**. Note that a zero value *may not* necessarily represent a “bad” data point -in any kind of **Attribute Array**. - -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 | GBEuclid | int32 | (1) | Manhattan distances of each **Cell** to the | -| | eanDistances | | | closest **Feature** boundary | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Created Objects -=============== - -None - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/AlignGeometries.md b/src/Plugins/ComplexCore/docs/AlignGeometries.md index b5f2ef5460..674490b14b 100644 --- a/src/Plugins/ComplexCore/docs/AlignGeometries.md +++ b/src/Plugins/ComplexCore/docs/AlignGeometries.md @@ -1,10 +1,10 @@ # Align Geometries -## Group (Subgroup) ## +## Group (Subgroup) DREAM3DReview (DREAM3DReview) -## Description ## +## Description This **Filter** will align 2 Geometry objects using 1 of several alignment methods: @@ -19,28 +19,28 @@ 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 ## +## Parameters | Name | Type | Description | |------|------|------| | Method | Integer | 0=Centroid, 1=Origin, 2-7 for the various planes | -## Required Geometry ## +## Required Geometry Required Geometry Type -or- Not Applicable -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 ## +## Created Objects None. The operation is done in place -## License & Copyright ## +## License & Copyright Please see the description file distributed with this plugin. diff --git a/src/Plugins/ComplexCore/docs/AlignGeometries.rst b/src/Plugins/ComplexCore/docs/AlignGeometries.rst deleted file mode 100644 index b56486754b..0000000000 --- a/src/Plugins/ComplexCore/docs/AlignGeometries.rst +++ /dev/null @@ -1,70 +0,0 @@ -================ -Align Geometries -================ - - -Group (Subgroup) -================ - -DREAM3DReview (DREAM3DReview) - -Description -=========== - -This **Filter** will align 2 Geometry objects using 1 of several alignment methods: - -- Centroid -- Origin -- XY Min Plane -- XY Max Plane -- XZ Min Plane -- XZ Max Plane -- YZ Min Plane -- YZ Max Plane - -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 | Must | N/A | The Geometry that is going to be moved | -| | Geometry | have a | | | -| | | geometry | | | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Data Container | Target | Must | N/A | The Target Geometry that the moving is going to | -| | Geometry | have a | | be aligned to. | -| | | geometry | | | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Created Objects -=============== - -None. The operation is done in place - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/AlignSectionsFeatureCentroidFilter.md b/src/Plugins/ComplexCore/docs/AlignSectionsFeatureCentroidFilter.md index b8769140f2..5724a6d226 100644 --- a/src/Plugins/ComplexCore/docs/AlignSectionsFeatureCentroidFilter.md +++ b/src/Plugins/ComplexCore/docs/AlignSectionsFeatureCentroidFilter.md @@ -1,11 +1,11 @@ # Align Sections (Feature Centroid) -## Group (Subgroup) ## +## Group (Subgroup) Reconstruction (Alignment) -## Description ## +## Description This **Filter** attempts to align 'sections' of the sample perpendicular to the Z-direction by determining the position that closest aligns the centroid(s) of previously defined "regions". The "regions" are defined by a boolean array where the **Cells** have been flagged by another **Filter**. Typically, during reading/processing of the data, each **Cell** is subject to a "quality metric" (or threshold) that defines if the **Cell** is *good*. This threshold can be used to define areas of each slice that are bad, either due to actual features in the microstructure or external references inserted by the user/experimentalist. If these "regions" of *bad* **Cells** are believed to be consistent through sections, then this **Filter** will preserve that by aligning those "regions" on top of one another on consecutive sections. The algorithm of this **Filter** is as follows: @@ -21,36 +21,36 @@ 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 ## +## 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 ## +## Required Geometry Image -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 ## +## Created Objects None -## Example Pipelines ## +## Example Pipelines + (10) SmallIN100 Full Reconstruction + (03) SmallIN100 Alignment -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/ComplexCore/docs/AlignSectionsFeatureCentroidFilter.rst b/src/Plugins/ComplexCore/docs/AlignSectionsFeatureCentroidFilter.rst deleted file mode 100644 index 92e0a59d7a..0000000000 --- a/src/Plugins/ComplexCore/docs/AlignSectionsFeatureCentroidFilter.rst +++ /dev/null @@ -1,105 +0,0 @@ -================================= -Align Sections (Feature Centroid) -================================= - - -Group (Subgroup) -================ - -Reconstruction (Alignment) - -Description -=========== - -This **Filter** attempts to align ‘sections’ of the sample perpendicular to the Z-direction by determining the position -that closest aligns the centroid(s) of previously defined “regions”. The “regions” are defined by a boolean array where -the **Cells** have been flagged by another **Filter**. Typically, during reading/processing of the data, each **Cell** -is subject to a “quality metric” (or threshold) that defines if the **Cell** is *good*. This threshold can be used to -define areas of each slice that are bad, either due to actual features in the microstructure or external references -inserted by the user/experimentalist. If these “regions” of *bad* **Cells** are believed to be consistent through -sections, then this **Filter** will preserve that by aligning those “regions” on top of one another on consecutive -sections. The algorithm of this **Filter** is as follows: - -1. Determine the centroid of all **Cells** that are flagged with a boolean value equal to *true* for each section -2. Determine the shifts that place centroids of consecutive sections on top of one another -3. Round the shifts determined in step 2 to the nearest multiple of the **Cell** resolution. (This forces the sections - to be shifted by full **Cell** increments) - -If the user elects to *Use Reference Slice*, then each section’s centroid is shifted to lie on top of the reference -slice’s centroid position and not its neighboring section’s centroid position. - -**Note that this is algorithm cannot get caught in a local minimum!** - -The user can choose to write the determined shift to an output file by enabling *Write Alignment Shifts File* and -providing a file path. - -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 | bool | Whether to remove a *background shift* present in the | -| Subtraction | | 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 - -Example Pipelines -================= - -- - - (10) SmallIN100 Full Reconstruction - -- - - (3) SmallIN100 Alignment - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/AlignSectionsListFilter.md b/src/Plugins/ComplexCore/docs/AlignSectionsListFilter.md index c225ae7dfb..18da0248ca 100644 --- a/src/Plugins/ComplexCore/docs/AlignSectionsListFilter.md +++ b/src/Plugins/ComplexCore/docs/AlignSectionsListFilter.md @@ -1,11 +1,11 @@ # Align Sections (List) -## Group (Subgroup) ## +## Group (Subgroup) Reconstruction (Alignment) -## Description ## +## Description This **Filter** will apply the cell shifts from a user specified txt file to each section of an Image Geometry. It accepts an alignment .txt file that has full **Cells** shifts that have already been calculated in it. @@ -24,30 +24,30 @@ 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 ## +## 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 ## +## Required Geometry Image -## Required Objects ## +## Required Objects None -## Created Objects ## +## Created Objects None -## Example Pipelines ## +## Example Pipelines -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/ComplexCore/docs/AlignSectionsListFilter.rst b/src/Plugins/ComplexCore/docs/AlignSectionsListFilter.rst deleted file mode 100644 index 1f21cc54d1..0000000000 --- a/src/Plugins/ComplexCore/docs/AlignSectionsListFilter.rst +++ /dev/null @@ -1,74 +0,0 @@ -===================== -Align Sections (List) -===================== - - -Group (Subgroup) -================ - -Reconstruction (Alignment) - -Description -=========== - -This **Filter** will apply the cell shifts from a user specified txt file to each section of an Image Geometry. It -accepts an alignment .txt file that has full **Cells** shifts that have already been calculated in it. - -If the alignment file was generated by another DREAM.3D alignment filter then the DREAM.3D Alignment File format option -should be turned on and the format of the first 6 columns of each row in the file should be as follows: slice_m -slice_m+1 newxshift newyshift xshifts yshifts slice_n slice_n+1 newxshift newyshift xshifts yshifts etc… - -Otherwise, the format of the file is as follows: - -:: - - slice_number xshift yshift - slice_number xshift yshift - slice_number xshift yshift - etc... - -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 - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/AppendImageGeometryZSliceFilter.md b/src/Plugins/ComplexCore/docs/AppendImageGeometryZSliceFilter.md index 1eca53dc0d..e623cdfeda 100644 --- a/src/Plugins/ComplexCore/docs/AppendImageGeometryZSliceFilter.md +++ b/src/Plugins/ComplexCore/docs/AppendImageGeometryZSliceFilter.md @@ -31,8 +31,8 @@ Image ## Required Arrays -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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. | diff --git a/src/Plugins/ComplexCore/docs/AppendImageGeometryZSliceFilter.rst b/src/Plugins/ComplexCore/docs/AppendImageGeometryZSliceFilter.rst deleted file mode 100644 index 71b25e0384..0000000000 --- a/src/Plugins/ComplexCore/docs/AppendImageGeometryZSliceFilter.rst +++ /dev/null @@ -1,73 +0,0 @@ -============== -Append Z-Slice -============== - - -Group (Subgroup) -================ - -Sampling (Memory/Management) - -Description -=========== - -This filter allows the user to append an Image Geometry onto the “end” of another Image Geometry. The input and -destination **ImageGeometry** objects must have the same X&Y dimensions. Optional Checks for equal **Resolution** values -can also be performed. - -For example, if the user has an already existing **Image Geometry** that is 100 voxels in the *X* direction by 200 -pixels in the *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 | Cell | N/A | The incoming cell data that is to be appended. | -| | Data | | | | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Attribute Matrix | Destination | Cell | N/A | The destination cell data that is the final | -| | Cell Data | | | location for the appended data. | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/ApplyTransformationToGeometryFilter.rst b/src/Plugins/ComplexCore/docs/ApplyTransformationToGeometryFilter.rst deleted file mode 100644 index 0bca37447a..0000000000 --- a/src/Plugins/ComplexCore/docs/ApplyTransformationToGeometryFilter.rst +++ /dev/null @@ -1,177 +0,0 @@ -================================ -Apply Transformation to Geometry -================================ - - -Group (Subgroup) -================ - -Rotation & Transformation - -Description -=========== - -This **Filter** applies a spatial transformation to either and unstructured **Geometry** or an ImageGeometry. An ” -unstructured” **Geometry** is any geometry that requires explicit definition of **Vertex** positions. Specifically, -Vertex\ **,** Edge\ **,** Triangle\ **,** Quadrilateral\ **, and** Tetrahedral*\* **Geometries** may be transformed by -this Filter\ **. The transformation is applied in place, so the input** Geometry*\* will be modified. - -If the user selects an **Image Geometry** then they will need to select which kind of \**Interpolation Method\* will be -used when transferring the data from the old geometry to the newly transformed geometry. - -The linear/Bi-Linear/Tri-Linear Interpolation is adapted from the equations presented in -`https://www.cs.purdue.edu/homes/cs530/slides/04.DataStructure.pdf, page -36} `__ - -Caveats -------- - -If the user selects an **unstructured** based geometry, **NO** interpolation will take place as the only changes that -take place are the actual coordinates of the vertices. - -If the user selects an **Image Geometry** then the user should select one of the *Interpolation* methods and then also -select the appropriate *Cell Attribute Matrix*. - -The **Scale** and **Rotation** transformation types will automatically translate the volume to (0, 0, 0), apply the -scaling/rotation, and then translate the volume back to its original location. If the **Manual Transformation Matrix** -or **Pre-Computed Transformation Matrix** types are selected, then it is up to the user to make sure that those -translations are included, if necessary. - -Example Transformations -======================= - -================================== ==================== -Description Example Output Image -================================== ==================== -Untransformed |image1| -After Rotation of <001> 45 Degrees |image2| -Scaled (2.0, 2.0, 1.0) |image3| -================================== ==================== - -Transformation Information -========================== - -The user may select from a variety of options for the type of transformation to apply: - -+---------+-------------------------------+----------------------------------------------------------------------------+ -| Enum | Transformation Type | Representation | -| Value | | | -+=========+===============================+============================================================================+ -| 0 | No Transformation | Identity transformation | -+---------+-------------------------------+----------------------------------------------------------------------------+ -| 1 | Pre-Computed Transformation | A 4x4 transformation matrix, supplied by an **Attribute Array** in *row | -| | Matrix | major* order | -+---------+-------------------------------+----------------------------------------------------------------------------+ -| 2 | Manual Transformation Matrix | Manually entered 4x4 transformation matrix | -+---------+-------------------------------+----------------------------------------------------------------------------+ -| 3 | Rotation | Rotation about the supplied axis-angle (Angle in Degrees). | -+---------+-------------------------------+----------------------------------------------------------------------------+ -| 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 | Enu | Type of transformation to be used. (0-5) | -| | mera | | -| | tion | | -+--------------------------------+------+------------------------------------------------------------------------------+ -| Transformation Matrix | f | Entries of the 4x4 transformation matrix, if *Manual* is chosen for the | -| | loat | *Transformation Type* | -| | ( | | -| | 4x4) | | -+--------------------------------+------+------------------------------------------------------------------------------+ -| Rotation Axis-Angle (ijk) | f | axis-angle (Angle in Degrees) | -| | loat | | -| | (4x) | | -+--------------------------------+------+------------------------------------------------------------------------------+ -| Translation | f | (x, y, z) translation values, if *Translation* is chosen for the | -| | loat | *Transformation Type* | -| | (3x) | | -+--------------------------------+------+------------------------------------------------------------------------------+ -| Scale | f | (x, y, z) scale values, if *Scale* is chosen for the *Transformation Type* | -| | loat | | -| | (3x) | | -+--------------------------------+------+------------------------------------------------------------------------------+ -| Translate Geometry To Global | boo | If enabled, translates the geometry to (0, 0, 0), applies the | -| Origin Before Transformation | lean | transformation, and then translates the geometry back to its original | -| | | origin. | -+--------------------------------+------+------------------------------------------------------------------------------+ -| Precomputed Transformation | Data | | -| Matrix Data Path | Path | | -+--------------------------------+------+------------------------------------------------------------------------------+ -| Geometry to be transformed. | Data | | -| | Path | | -+--------------------------------+------+------------------------------------------------------------------------------+ - -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 | D | Type | Comp | Description | -| | efault | | Dims | | -| | Name | | | | -+============+========+======+========+===============================================================================+ -| Geometry | None | N/A | N/A | The unstructured **Geometry** or Image Geometry to transform | -+------------+--------+------+--------+-------------------------------------------------------------------------------+ -| DataArray | Tr | f | 4x4 | The pre-computed transformation matrix to apply, if *Pre-Computed* is chosen | -| | ansfor | loat | | for the *Transformation Type* | -| | mation | | | | -| | Matrix | | | | -+------------+--------+------+--------+-------------------------------------------------------------------------------+ - -Created Objects -=============== - -- Unstructured Geometry: None -- Image Geometry: New Image Geometry (The input geometry is discarded) - -Example Pipelines -================= - -- Pipelines/ComplexCore/Examples/apply_transformation_basic.d3dpipeline -- Pipelines/ComplexCore/Examples/apply_transformation_image.d3dpipeline -- Pipelines/ComplexCore/Examples/apply_transformation_node.d3dpipeline - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. - -.. |image1| image:: Images/ApplyTransformation_AsRead.png -.. |image2| image:: Images/ApplyTransformation_Rotated.png -.. |image3| image:: Images/ApplyTransformation_Scaled.png diff --git a/src/Plugins/ComplexCore/docs/ApproximatePointCloudHull.md b/src/Plugins/ComplexCore/docs/ApproximatePointCloudHull.md index 920ef93cd6..280a85da45 100644 --- a/src/Plugins/ComplexCore/docs/ApproximatePointCloudHull.md +++ b/src/Plugins/ComplexCore/docs/ApproximatePointCloudHull.md @@ -1,11 +1,11 @@ Approximate Point Cloud Hull ============= -## Group (Subgroup) ## +## Group (Subgroup) Point Cloud (Geometry) -## Description ## +## Description This **Filter** determines a set of points that approximates the surface (or *hull*) or a 3D point cloud represented by a **Vertex Geometry**. The hull is approximate in that the surface points are not guaranteed to hve belonged to the original point cloud; instead, the determined set of points is meant to represent a sampling of where the 3D point cloud surface occurs. To following steps are used to approximate the hull: @@ -20,28 +20,28 @@ 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 ## +## 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 ## +## Required Geometry Vertex -## Required Objects ## -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +## 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 | -|---------------------------|--------------|----------|------------|---------------------------------------------| +## Created Objects +| Kind | Default Name | Type | Comp Dims | Description | +|---------------------------|--------------|----------|--------|---------------------------------------------| | Data Container | HullDataContainer | N/A | N/A | Data Container holding the approximated surface **Vertex Geometry | -## License & Copyright ## +## License & Copyright Please see the description file distributed with this plugin. diff --git a/src/Plugins/ComplexCore/docs/ApproximatePointCloudHull.rst b/src/Plugins/ComplexCore/docs/ApproximatePointCloudHull.rst deleted file mode 100644 index a1e06bf08b..0000000000 --- a/src/Plugins/ComplexCore/docs/ApproximatePointCloudHull.rst +++ /dev/null @@ -1,82 +0,0 @@ -============================ -Approximate Point Cloud Hull -============================ - - -Group (Subgroup) -================ - -Point Cloud (Geometry) - -Description -=========== - -This **Filter** determines a set of points that approximates the surface (or *hull*) or a 3D point cloud represented by -a **Vertex Geometry**. The hull is approximate in that the surface points are not guaranteed to hve belonged to the -original point cloud; instead, the determined set of points is meant to represent a sampling of where the 3D point cloud -surface occurs. To following steps are used to approximate the hull: - -1. A structured rectilinear grid with user-defined resolution is overlaid on the point cloud. -2. Each point is mapped to the voxel it occupies in the sampling grid. -3. For each voxel in the sampling grid: - - 1. Each of its 26 neighbors is inspected to see if that neighbor contains any points. - 2. If the number of empty neighbors exceeds a user-defined threshold, the voxel is flagged as a “surface voxel”. - -4. For each voxel flagged as a “surface voxel”, the coordinates of the points in that voxel are averaged to produce a - new point that is inserted into the hull. - -The above algorithm is significantly faster that other geometric approaches for determining a point cloud surface, but -yields only an approximate solution. Note that this approach is able of handling concavities in the point cloud, -assuming the grid resolution is small enough to resolve any concavities. In general, a grid resolution should be chosen -small enough to resolve any surface features of interest. The algorithm is also sensitive to the minimum number of empty -neighbors parameter: consider modifying this parameter if the resulting hull is unsatisfactory. - -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 -============== ================= ==== ========== ================================================================== - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/ArrayCalculatorFilter.md b/src/Plugins/ComplexCore/docs/ArrayCalculatorFilter.md index 49741f2f49..4374ae4a92 100644 --- a/src/Plugins/ComplexCore/docs/ArrayCalculatorFilter.md +++ b/src/Plugins/ComplexCore/docs/ArrayCalculatorFilter.md @@ -1,29 +1,29 @@ # Attribute Array Calculator -## Group (Subgroup) ## +## Group (Subgroup) Core (Generation) -## Description ## +## Description This **Filter** performs calculations on **Attribute Arrays** using the mathematical expression entered by the user, referred to as the *infix expression*. Calculations follow standard mathematical order of operations rules. Parentheses may be used to influence priority. The output of the entered equation is stored as a new **Attribute Array** of type double in an **Attribute Matrix** chosen by the user. -## Usage & Syntax ## +## Usage & Syntax The user may enter any valid mathematical expression that uses numbers, operators and/or available **Attribute Arrays**. This expression may be typed into the **Filter** or entered using the available calculator interface. The **Filter** automatically determines how many tuples and component dimensions the output array requires. Should the entered expression use arrays, computations performed by the **Filter** are performed per tuple, i.e. each tuple has the same expression performed. Therefore, any **Attribute Arrays** used in the entered expression must have the same number of tuples. To help prevent most cases of tuple incompatibilities, the user must select an **Attribute Matrix** to serve as the source for arrays to be used in the expression. Additionally, the output array will have the same number of tuples as the arrays used in the infix expression, and must be placed in an **Attribute Matrix** that has the same number of tuples as the source **Attribute Matrix**. All items in the entered infix expression, including values within arrays, will be cast to doubles for computation, and the resulting output will be stored as doubles. If the output array needs to be a different type for use as input to another **Filter**, consider using the Convert Attribute Data Type **Filter**. -### Expressions Without Arrays ### +### Expressions Without Arrays It is possible to enter an infix expression that does not contain any **Attribute Array**, similar to a standard calculator. In this case, the output array is simply a single numeric value that is stored in a single component, one tuple array. Because the output array will only have one tuple, it must be placed in an **Attribute Matrix** that has exactly one tuple. If such an **Attribute Matrix** is not available in the data structure, it can be created using the Create Attribute Matrix **Filter**. -### Operators ### +### Operators There are several mathematical operators available for usage in an infix expression. Operators may either be *binary* (requiring two items to operate) or *unary* (requiring only one item to operate). Some unary operators may also require more than one argument. The tables below list the available mathematical operators. -#### Binary Operators #### +#### Binary Operators | Symbol | Name | Operation | |-----------|----------|---------------| @@ -33,7 +33,7 @@ There are several mathematical operators available for usage in an infix express | `/` | division | Divides two items | | x^y | exponentiation | Raises the base *x* to the *y* power | -#### Unary Operators #### +#### Unary Operators | Symbol | Name | Number of Arguments | Operation | |-----------|----------|-------------------------------|---------------| @@ -53,15 +53,15 @@ There are several mathematical operators available for usage in an infix express | log(b, x) | base *b* logarithm | 2 | Computes the base *b* logarithm of *x* | | root(r, ind) | *indth* root | 2 | Computes the *indth* root of the radicand*r* | -#### Trigonometric Operators and Degrees/Radians #### +#### Trigonometric Operators and Degrees/Radians The direct trigonometric operators (**sin**, **cos** and **tan**) can operate on either radians or degrees, which can be selected by the user from the **Filter** interface. Similarly, the inverse trigonometric operators (**asin**, **acos** and **atan**) will return either radians or degrees depending on the selection in the **Filter** interface. Note that by default, DREAM.3D **Filters** generally assume angle values are in radians. The Convert Angles to Degrees or Radians can be used to convert arrays from radians to degrees and vice versa. -#### Undefined Operations and Operators Out-Of-Range #### +#### Undefined Operations and Operators Out-Of-Range This **Filter** allows for undefined operations to occur. The return values for these operations will be the same return value obtained from the utilized C/C++ function. For example, the divide by zero operation in C/C++ is undefined behavior, so the result is not guaranteed (however, most platforms will follow the IEEE floating point standard and a value of +infinity will be returned). Similarly, a domain error may occur if an operator function is used with arguments out of range. For example, entering `arcsin(-2)`, `ln(-7.34)` or `sqrt(-14.89)` results in a domain error. The return value here is again not guaranteed, but would most likely be NaN. -### Using Arrays in Expressions ### +### Using Arrays in Expressions Any **Attribute Array** available in the selected **Attribute Matrix** is eligible to be used in the infix expression and multiple arrays may be used in the same expression, but all arrays in any given expression must have the same number of components. Arrays may be entered into the infix expression by typing their exact name, or by using the dropdown menus in the interface labeled *Scalars* (for single component arrays) or *Vectors* (for multi-component arrays). Operations on arrays are computed tuple-by-tuple. For example, consider a single component **Attribute Array** named *Foo* that has five tuples, with the values stored being the first 5 prime numbers. The array *Foo* then looks as follows: @@ -77,7 +77,7 @@ Now consider another single component array named *Bar* that has the value 4.25 If there is a third available array named *Baz* that has three components, it cannot be used in infix expressions with *Foo* or *Bar*. For example, the infix expression `Foo + Baz` is not valid, and a parsing error will be presented. -#### Using Multi-Component Arrays #### +#### Using Multi-Component Arrays There are two ways to enter multi-component arrays into the infix expression. Arrays may be entered without an index for a component. In this case, operations are performed both tuple-by-tuple *and* component-by-component, and the output array will have the same number of components as the input arrays. For example, consider two arrays *Foo* and *Bar* that are each 3-component arrays with two tuples whose values are as follows: @@ -98,7 +98,7 @@ The infix expression `Foo[0] * Bar[2]` multiplies the first component of *Foo* w [-3, -24] -#### Explicit Array Names #### +#### Explicit Array Names It is possible to force the **Filter** to treat a term in the infix expression as the literal name of an **Attribute Array**. To force an item to be considered an array name literal, surround it in double quotes. Forcing literal names in this fashion allows for arrays to take the same name as mathematical operators. Consider the following examples: @@ -110,7 +110,7 @@ It is possible to force the **Filter** to treat a term in the infix expression a In most cases, attempting to write equations like these without putting the double quotes around the desired array name will cause an error due to ambiguity. -## Examples ## +## Examples Confidence Index + 3 / ln(4*Fit) @@ -136,31 +136,31 @@ 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 ## +## Parameters None -## Required Geometry ## +## Required Geometry Not Applicable -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp Dims | Description | -|------|--------------|-------------|---------|----------------| +| 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 ## +## Created Objects -| Kind | Default Name | Type | Comp Dims | Description | -|------|--------------|-------------|---------|----------------| +| Kind | Default Name | Type | Comp Dims | Description | +|---------------------------|--------------|----------|--------|---------------------------------------------| | Any **Attribute Array | Output | double | varies | Output of mathematical expression | -## Example Pipelines ## +## Example Pipelines -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/ComplexCore/docs/ArrayCalculatorFilter.rst b/src/Plugins/ComplexCore/docs/ArrayCalculatorFilter.rst deleted file mode 100644 index 3329b24e15..0000000000 --- a/src/Plugins/ComplexCore/docs/ArrayCalculatorFilter.rst +++ /dev/null @@ -1,283 +0,0 @@ -========================== -Attribute Array Calculator -========================== - - -Group (Subgroup) -================ - -Core (Generation) - -Description -=========== - -This **Filter** performs calculations on **Attribute Arrays** using the mathematical expression entered by the user, -referred to as the *infix expression*. Calculations follow standard mathematical order of operations rules. Parentheses -may be used to influence priority. The output of the entered equation is stored as a new **Attribute Array** of type -double in an **Attribute Matrix** chosen by the user. - -Usage & Syntax -============== - -The user may enter any valid mathematical expression that uses numbers, operators and/or available **Attribute Arrays**. -This expression may be typed into the **Filter** or entered using the available calculator interface. The **Filter** -automatically determines how many tuples and component dimensions the output array requires. Should the entered -expression use arrays, computations performed by the **Filter** are performed per tuple, i.e. each tuple has the same -expression performed. Therefore, any **Attribute Arrays** used in the entered expression must have the same number of -tuples. To help prevent most cases of tuple incompatibilities, the user must select an **Attribute Matrix** to serve as -the source for arrays to be used in the expression. Additionally, the output array will have the same number of tuples -as the arrays used in the infix expression, and must be placed in an **Attribute Matrix** that has the same number of -tuples as the source **Attribute Matrix**. - -All items in the entered infix expression, including values within arrays, will be cast to doubles for computation, and -the resulting output will be stored as doubles. If the output array needs to be a different type for use as input to -another **Filter**, consider using the Convert Attribute Data Type **Filter**. - -Expressions Without Arrays --------------------------- - -It is possible to enter an infix expression that does not contain any **Attribute Array**, similar to a standard -calculator. In this case, the output array is simply a single numeric value that is stored in a single component, one -tuple array. Because the output array will only have one tuple, it must be placed in an **Attribute Matrix** that has -exactly one tuple. If such an **Attribute Matrix** is not available in the data structure, it can be created using the -Create Attribute Matrix **Filter**. - -Operators ---------- - -There are several mathematical operators available for usage in an infix expression. Operators may either be *binary* -(requiring two items to operate) or *unary* (requiring only one item to operate). Some unary operators may also require -more than one argument. The tables below list the available mathematical operators. - -Binary Operators -~~~~~~~~~~~~~~~~ - -====== ============== ==================================== -Symbol Name Operation -====== ============== ==================================== -``+`` addition Adds two items -``-`` subtraction Subtracts two items -``*`` multiplication Multiplies two items -``/`` division Divides two items -x^y exponentiation Raises the base *x* to the *y* power -====== ============== ==================================== - -Unary Operators -~~~~~~~~~~~~~~~ - -============ ==================== =================== ======================================================= -Symbol Name Number of Arguments Operation -============ ==================== =================== ======================================================= -e^y exponential function 1 Raises *e* to the *y* power -sin(x) sine function 1 Computes the sine of *x* -cos(x) cosine function 1 Computes the cosine of *x* -tan(x) tangent function 1 Computes the tangent of *x* -asin(x) arcsine function 1 Computes the arcsine of *x* -acos(x) arccosine function 1 Computes the arccosine of *x* -atan(x) arctangent function 1 Computes the arctangent of *x* -abs(x) absolute value 1 Returns the absolute value of *x* -ceil(x) ceiling function 1 Returns the smallest integral value not less than *x* -floor(x) floor function 1 Returns the largest integral value not greater than *x* -log10(x) base 10 logarithm 1 Computes the base 10 logarithm of *x* -ln(x) natural logarithm 1 Computes the natural logarithm of *x* -sqrt(x) square root 1 Computes the square root of *x* -log(b, x) base *b* logarithm 2 Computes the base *b* logarithm of *x* -root(r, ind) *indth* root 2 Computes the *indth* root of the radicand\ *r* -============ ==================== =================== ======================================================= - -Trigonometric Operators and Degrees/Radians -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The direct trigonometric operators (**sin**, **cos** and **tan**) can operate on either radians or degrees, which can be -selected by the user from the **Filter** interface. Similarly, the inverse trigonometric operators (**asin**, **acos** -and **atan**) will return either radians or degrees depending on the selection in the **Filter** interface. Note that by -default, DREAM.3D **Filters** generally assume angle values are in radians. The Convert Angles to Degrees or Radians can -be used to convert arrays from radians to degrees and vice versa. - -Undefined Operations and Operators Out-Of-Range -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -This **Filter** allows for undefined operations to occur. The return values for these operations will be the same return -value obtained from the utilized C/C++ function. For example, the divide by zero operation in C/C++ is undefined -behavior, so the result is not guaranteed (however, most platforms will follow the IEEE floating point standard and a -value of +infinity will be returned). Similarly, a domain error may occur if an operator function is used with arguments -out of range. For example, entering ``arcsin(-2)``, ``ln(-7.34)`` or ``sqrt(-14.89)`` results in a domain error. The -return value here is again not guaranteed, but would most likely be NaN. - -Using Arrays in Expressions ---------------------------- - -Any **Attribute Array** available in the selected **Attribute Matrix** is eligible to be used in the infix expression -and multiple arrays may be used in the same expression, but all arrays in any given expression must have the same number -of components. Arrays may be entered into the infix expression by typing their exact name, or by using the dropdown -menus in the interface labeled *Scalars* (for single component arrays) or *Vectors* (for multi-component arrays). -Operations on arrays are computed tuple-by-tuple. For example, consider a single component **Attribute Array** named -*Foo* that has five tuples, with the values stored being the first 5 prime numbers. The array *Foo* then looks as -follows: - -:: - - [2, 3, 5, 7, 11] - -If the user enters the infix expression ``Foo + 3``, the result of the **Filter** is a new array with exactly five -tuples that contains the values: - -:: - - [5, 6, 8, 10, 14] - -Now consider another single component array named *Bar* that has the value 4.25 at all tuples. If the infix expression -``(Foo + Bar) * 4`` is entered, then the output values are as follows: - -:: - - [25, 29, 37, 45, 61] - -If there is a third available array named *Baz* that has three components, it cannot be used in infix expressions with -*Foo* or *Bar*. For example, the infix expression ``Foo + Baz`` is not valid, and a parsing error will be presented. - -Using Multi-Component Arrays -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -There are two ways to enter multi-component arrays into the infix expression. Arrays may be entered without an index for -a component. In this case, operations are performed both tuple-by-tuple *and* component-by-component, and the output -array will have the same number of components as the input arrays. For example, consider two arrays *Foo* and *Bar* that -are each 3-component arrays with two tuples whose values are as follows: - -:: - - Foo: [{1, 2, 3}, {4, 5, 6}] - Bar: [{-1, -2, -3}, {-4, -5, -6}] - -If the infix expression ``Foo + Bar`` then the output values are as follows: - -:: - - [{0, 0, 0}, {0, 0, 0}] - -Alternatively, multi-component arrays may be entered specifying a particular *index*. In this case, operations are -performed tuple-by-tuple, but only for the specific component specified in each array, so the output array will always -be a scalar value. Indices are specified using ``[]`` notation after the array name. Additionally, indices are *zero -based*. For example, ``Foo[1]`` is valid syntax, but ``Foo[3]`` is not valid. Additionally, indices must be positive -integers only. If any array in the infix expression uses index notation, then all arrays must specify an index. - -Consider the infix expression ``Foo[0] + Foo[1] + Foo[2]``. This expression will add all the components of *Foo* for -each tuple. The result of this expression is the following: - -:: - - [6, 15] - -The infix expression ``Foo[0] * Bar[2]`` multiplies the first component of *Foo* with the third component of *Bar* for -each tuple. The result if this expression is as follows: - -:: - - [-3, -24] - -Explicit Array Names -~~~~~~~~~~~~~~~~~~~~ - -It is possible to force the **Filter** to treat a term in the infix expression as the literal name of an **Attribute -Array**. To force an item to be considered an array name literal, surround it in double quotes. Forcing literal names in -this fashion allows for arrays to take the same name as mathematical operators. Consider the following examples: - -1. If there is an array named “+”, the user can create a valid equation such as ``3 + "+"``. This equation adds three to - every element in the “+” array. - -2. For an array names “452”, the user can create a valid equation such as ``6 * "452"``. This equation multiplies every - element in the “452” array by 6. - -3. For array names “-” and “4” with 3 components each, the user can create a valid equation such as ``"-"[2] + "4"[0]``. - This equation adds the third component in array “-” to the first component in array “4” for each tuple. - -In most cases, attempting to write equations like these without putting the double quotes around the desired array name -will cause an error due to ambiguity. - -Examples -======== - -:: - - Confidence Index + 3 / ln(4*Fit) - -This equation multiplies every tuple in the *Fit* array by *4* and then finds the *natural logarithm* of those results. -Then, it divides *3* by those values and *adds* the results of that to every element in the *Confidence Index* array. - -:: - - Array1[0] - Array2[1] - -This equation subtracts the second component in *Array2* from the first component in *Array1* for each tuple. The -resulting array will have the same number of tuples as *Array1* and *Array2*, but only one component. - -:: - - Array1 + Array2 - -This equation adds every element in *Array2* with every element in *Array1*. The resulting array will have the same -number of tuples and components as *Array1* and *Array2*. - -:: - - 6 / 3 - -This equation divides *6* by *3* and stores the result in an array with exactly one component and one tuple. - -:: - - root(8, 3) - -This equation takes the cube root of *8* and stores the result in an array with exactly one component and one tuple. - -:: - - 3 ^ Array1 - -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 | None | Any | N/A | Source **Attribute Matrix** | -| \** | | | | for arrays available to the | -| Attribute | | | | mathematical expression | -| Matrix | | | | | -+-----------+---------------------------+-------------------------+-----------------+--------------------------------+ - -Created Objects -=============== - -====================== ============ ====== ========= ================================= -Kind Default Name Type Comp Dims Description -====================== ============ ====== ========= ================================= -Any \**Attribute Array Output double varies Output of mathematical expression -====================== ============ ====== ========= ================================= - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/AvizoRectilinearCoordinateWriterFilter.md b/src/Plugins/ComplexCore/docs/AvizoRectilinearCoordinateWriterFilter.md index a8a2241947..3637278c5d 100644 --- a/src/Plugins/ComplexCore/docs/AvizoRectilinearCoordinateWriterFilter.md +++ b/src/Plugins/ComplexCore/docs/AvizoRectilinearCoordinateWriterFilter.md @@ -5,7 +5,7 @@ IO (Output) -## Description +## Description This filter writes out a native Avizo Rectilinear Coordinate data file. 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. @@ -32,10 +32,10 @@ This filter writes out a native Avizo Rectilinear Coordinate data file. Values s # Data section follows .. -## Parameters +## Parameters | Name | Type | Description | -|------|------| ----------- | +|------------|------| --------------------------------- | | Output File | File Path | Amira Mesh .am file created| | Write Binary File | Boolean | Binary file created, if checked | @@ -43,22 +43,22 @@ This filter writes out a native Avizo Rectilinear Coordinate data file. Values s Image -## Required Objects +## 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 +## Created Objects None -## Example Pipelines +## Example Pipelines -## License & Copyright +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/ComplexCore/docs/AvizoRectilinearCoordinateWriterFilter.rst b/src/Plugins/ComplexCore/docs/AvizoRectilinearCoordinateWriterFilter.rst deleted file mode 100644 index 35aa68de86..0000000000 --- a/src/Plugins/ComplexCore/docs/AvizoRectilinearCoordinateWriterFilter.rst +++ /dev/null @@ -1,123 +0,0 @@ -=================================== -Avizo Rectilinear Coordinate Writer -=================================== - - -Group (Subgroup) -================ - -IO (Output) - -Description -=========== - -This filter writes out a native Avizo Rectilinear Coordinate data file. 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. - -Example Output --------------- - -:: - - # AmiraMesh BINARY-LITTLE-ENDIAN 2.1 - # Dimensions in x-, y-, and z-direction - define Lattice - define Coordinates - Parameters { - DREAM3DParams { - Author "DREAM3D", - DateTime " . M o n J u n 1 1 0 : 0 1 : 1 4 2 0 1 5 " - } - Units { - Coordinates "microns" - } - CoordType "rectilinear" - } - - Lattice { int FeatureIds } = @1 - Coordinates { float xyz } = @2 - # 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 | De | -| | | | | scription | -+==============+==================================+================================+=====================+===========+ -| Cell | FeatureIds | Ids (Int) that specify to | (1) | Filters | -| | | which **Feature** each | | Known to | -| | | **Cell** belongs. | | Create | -| | | | | Data: | -| | | | | Segment | -| | | | | Features | -| | | | | (Misori | -| | | | | entation, | -| | | | | C-Axis | -| | | | | Misori | -| | | | | entation, | -| | | | | Scalar) | -| | | | | (Reconst | -| | | | | ruction), | -| | | | | Read Dx | -| | | | | File | -| | | | | (IO), | -| | | | | Read Ph | -| | | | | File | -| | | | | (IO), | -| | | | | Pack | -| | | | | Primary | -| | | | | Phases | -| | | | | (S | -| | | | | yntheticB | -| | | | | uilding), | -| | | | | Insert | -| | | | | Pr | -| | | | | ecipitate | -| | | | | Phases | -| | | | | (S | -| | | | | yntheticB | -| | | | | uilding), | -| | | | | Establish | -| | | | | Matrix | -| | | | | Phase | -| | | | | ( | -| | | | | Synthetic | -| | | | | Building) | -+--------------+----------------------------------+--------------------------------+---------------------+-----------+ - -Created Objects -=============== - -None - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/AvizoUniformCoordinateWriterFilter.md b/src/Plugins/ComplexCore/docs/AvizoUniformCoordinateWriterFilter.md index 1f2ae2d4c1..486e72efe8 100644 --- a/src/Plugins/ComplexCore/docs/AvizoUniformCoordinateWriterFilter.md +++ b/src/Plugins/ComplexCore/docs/AvizoUniformCoordinateWriterFilter.md @@ -5,7 +5,7 @@ IO (Output) -## Description +## Description This filter writes out a native Avizo Uniform Coordinate data file. 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. @@ -33,10 +33,10 @@ This filter writes out a native Avizo Uniform Coordinate data file. Values shoul # Data section follows .. -## Parameters +## Parameters | Name | Type | Description | -|------|------| ----------- | +|------------|------| --------------------------------- | | Output File | File Path | Amira Mesh .am file created| | Write Binary File | Boolean | Binary file created, if checked | @@ -46,24 +46,24 @@ This filter writes out a native Avizo Uniform Coordinate data file. Values shoul Image -## Required Objects +## 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 +## Created Objects None -## Example Pipelines +## Example Pipelines -## License & Copyright +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/ComplexCore/docs/AvizoUniformCoordinateWriterFilter.rst b/src/Plugins/ComplexCore/docs/AvizoUniformCoordinateWriterFilter.rst deleted file mode 100644 index c7145bb46e..0000000000 --- a/src/Plugins/ComplexCore/docs/AvizoUniformCoordinateWriterFilter.rst +++ /dev/null @@ -1,124 +0,0 @@ -=============================== -Avizo Uniform Coordinate Writer -=============================== - - -Group (Subgroup) -================ - -IO (Output) - -Description -=========== - -This filter writes out a native Avizo Uniform Coordinate data file. 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. - -Example Output --------------- - -:: - - # AmiraMesh BINARY-LITTLE-ENDIAN 2.1 - # Dimensions in x-, y-, and z-direction - define Lattice - define Coordinates - Parameters { - DREAM3DParams { - Author "DREAM3D", - DateTime - } - Units { - Coordinates "microns" - } - Content " int, uniform coordinates", - # Bounding Box is xmin xmax ymin ymax zmin zmax - BoundingBox , - CoordType "uniform" - } - Lattice { int FeatureIds } = @1 - # 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 | De | -| | | | | scription | -+==============+==================================+================================+=====================+===========+ -| Cell | FeatureIds | Ids (Int) that specify to | (1) | Filters | -| | | which **Feature** each | | Known to | -| | | **Cell** belongs. | | Create | -| | | | | Data: | -| | | | | Segment | -| | | | | Features | -| | | | | (Misori | -| | | | | entation, | -| | | | | C-Axis | -| | | | | Misori | -| | | | | entation, | -| | | | | Scalar) | -| | | | | (Reconst | -| | | | | ruction), | -| | | | | Read Dx | -| | | | | File | -| | | | | (IO), | -| | | | | Read Ph | -| | | | | File | -| | | | | (IO), | -| | | | | Pack | -| | | | | Primary | -| | | | | Phases | -| | | | | (S | -| | | | | yntheticB | -| | | | | uilding), | -| | | | | Insert | -| | | | | Pr | -| | | | | ecipitate | -| | | | | Phases | -| | | | | (S | -| | | | | yntheticB | -| | | | | uilding), | -| | | | | Establish | -| | | | | Matrix | -| | | | | Phase | -| | | | | ( | -| | | | | Synthetic | -| | | | | Building) | -+--------------+----------------------------------+--------------------------------+---------------------+-----------+ - -Created Objects -=============== - -None - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/CalculateArrayHistogramFilter.rst b/src/Plugins/ComplexCore/docs/CalculateArrayHistogramFilter.rst deleted file mode 100644 index 2af341f5dc..0000000000 --- a/src/Plugins/ComplexCore/docs/CalculateArrayHistogramFilter.rst +++ /dev/null @@ -1,406 +0,0 @@ -======================= -CalculateArrayHistogram -======================= - - -Group (Subgroup) -================ - -Statistics(Ensemble) - -Description -=========== - -This **Filter** accepts **DataArray(s)** as input, creates histogram **DataArray(s)** in specified **DataGroup** from -input **DataArray(s)**, then calculates histogram values according to user parameters and stores values in created -histogram **DataArray(s)**. - -Example Data -============ - -Using some data about the “Old Faithful” geyser in the United States from the `R -site `__, here -is the top few lines of data: - -Duration, Wait Time {3.6,79}, {1.8,54}, {3.333,74}, {2.283,62}, {4.533,85}, {2.883,55}, {4.7,88}, .. - -Example Output --------------- - -The range on the data is [1.6, 5.1]. Using 8 bins starting from 1.5 with a bin width of 0.5 the expected output for a -“Left Closed, Right Open” histogram is the following table data. - -[1.5,2) 51 [2,2.5) 41 [2.5,3) 5 [3,3.5) 7 [3.5,4) 30 [4,4.5) 73 [4.5,5) 61 [5,5.5) 4 - -Example Plot ------------- - -.. figure:: Images/HistogramExample.png - :alt: Example Plot of the Frequency Data from the Old Faithful data set - - Example Plot of the Frequency Data from the Old Faithful data set - -Additional Information ----------------------- - -Also see Histogram Quick Reference at 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 | Data | Specifies to which **DataArray(s)** to create a histogram from | -| | Histogram | Array | | -+-------------------+--------------------+-------+-------------------------------------------------------------------+ - -Created Objects -=============== - -+-------------------+--------------------+-------+-------------------------------------------------------------------+ -| Kind | Default Name | Type | Description | -+===================+====================+=======+===================================================================+ -| DataArray | DataArray*\* name | Data | A new **DataArray** stored in specified **DataGroup** in which | -| | + “Histogram” | Array | | -+-------------------+--------------------+-------+-------------------------------------------------------------------+ - -the histogram will be generated based on **DataArray** specified in *DataArray(s) to Histogram* (One per **DataArray** -in *DataArray(s) to Histogram*) \| - -Example Pipelines -================= - -- Image Histogram -- Confidence Index Histogram - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. - -Example Data (Raw) ------------------- - -.. code:: text - - Index, Duration, Wait Time - {1,3.6,79}, - {2,1.8,54}, - {3,3.333,74}, - {4,2.283,62}, - {5,4.533,85}, - {6,2.883,55}, - {7,4.7,88}, - {8,3.6,85}, - {9,1.95,51}, - {10,4.35,85}, - {11,1.833,54}, - {12,3.917,84}, - {13,4.2,78}, - {14,1.75,47}, - {15,4.7,83}, - {16,2.167,52}, - {17,1.75,62}, - {18,4.8,84}, - {19,1.6,52}, - {20,4.25,79}, - {21,1.8,51}, - {22,1.75,47}, - {23,3.45,78}, - {24,3.067,69}, - {25,4.533,74}, - {26,3.6,83}, - {27,1.967,55}, - {28,4.083,76}, - {29,3.85,78}, - {30,4.433,79}, - {31,4.3,73}, - {32,4.467,77}, - {33,3.367,66}, - {34,4.033,80}, - {35,3.833,74}, - {36,2.017,52}, - {37,1.867,48}, - {38,4.833,80}, - {39,1.833,59}, - {40,4.783,90}, - {41,4.35,80}, - {42,1.883,58}, - {43,4.567,84}, - {44,1.75,58}, - {45,4.533,73}, - {46,3.317,83}, - {47,3.833,64}, - {48,2.1,53}, - {49,4.633,82}, - {50,2,59}, - {51,4.8,75}, - {52,4.716,90}, - {53,1.833,54}, - {54,4.833,80}, - {55,1.733,54}, - {56,4.883,83}, - {57,3.717,71}, - {58,1.667,64}, - {59,4.567,77}, - {60,4.317,81}, - {61,2.233,59}, - {62,4.5,84}, - {63,1.75,48}, - {64,4.8,82}, - {65,1.817,60}, - {66,4.4,92}, - {67,4.167,78}, - {68,4.7,78}, - {69,2.067,65}, - {70,4.7,73}, - {71,4.033,82}, - {72,1.967,56}, - {73,4.5,79}, - {74,4,71}, - {75,1.983,62}, - {76,5.067,76}, - {77,2.017,60}, - {78,4.567,78}, - {79,3.883,76}, - {80,3.6,83}, - {81,4.133,75}, - {82,4.333,82}, - {83,4.1,70}, - {84,2.633,65}, - {85,4.067,73}, - {86,4.933,88}, - {87,3.95,76}, - {88,4.517,80}, - {89,2.167,48}, - {90,4,86}, - {91,2.2,60}, - {92,4.333,90}, - {93,1.867,50}, - {94,4.817,78}, - {95,1.833,63}, - {96,4.3,72}, - {97,4.667,84}, - {98,3.75,75}, - {99,1.867,51}, - {100,4.9,82}, - {101,2.483,62}, - {102,4.367,88}, - {103,2.1,49}, - {104,4.5,83}, - {105,4.05,81}, - {106,1.867,47}, - {107,4.7,84}, - {108,1.783,52}, - {109,4.85,86}, - {110,3.683,81}, - {111,4.733,75}, - {112,2.3,59}, - {113,4.9,89}, - {114,4.417,79}, - {115,1.7,59}, - {116,4.633,81}, - {117,2.317,50}, - {118,4.6,85}, - {119,1.817,59}, - {120,4.417,87}, - {121,2.617,53}, - {122,4.067,69}, - {123,4.25,77}, - {124,1.967,56}, - {125,4.6,88}, - {126,3.767,81}, - {127,1.917,45}, - {128,4.5,82}, - {129,2.267,55}, - {130,4.65,90}, - {131,1.867,45}, - {132,4.167,83}, - {133,2.8,56}, - {134,4.333,89}, - {135,1.833,46}, - {136,4.383,82}, - {137,1.883,51}, - {138,4.933,86}, - {139,2.033,53}, - {140,3.733,79}, - {141,4.233,81}, - {142,2.233,60}, - {143,4.533,82}, - {144,4.817,77}, - {145,4.333,76}, - {146,1.983,59}, - {147,4.633,80}, - {148,2.017,49}, - {149,5.1,96}, - {150,1.8,53}, - {151,5.033,77}, - {152,4,77}, - {153,2.4,65}, - {154,4.6,81}, - {155,3.567,71}, - {156,4,70}, - {157,4.5,81}, - {158,4.083,93}, - {159,1.8,53}, - {160,3.967,89}, - {161,2.2,45}, - {162,4.15,86}, - {163,2,58}, - {164,3.833,78}, - {165,3.5,66}, - {166,4.583,76}, - {167,2.367,63}, - {168,5,88}, - {169,1.933,52}, - {170,4.617,93}, - {171,1.917,49}, - {172,2.083,57}, - {173,4.583,77}, - {174,3.333,68}, - {175,4.167,81}, - {176,4.333,81}, - {177,4.5,73}, - {178,2.417,50}, - {179,4,85}, - {180,4.167,74}, - {181,1.883,55}, - {182,4.583,77}, - {183,4.25,83}, - {184,3.767,83}, - {185,2.033,51}, - {186,4.433,78}, - {187,4.083,84}, - {188,1.833,46}, - {189,4.417,83}, - {190,2.183,55}, - {191,4.8,81}, - {192,1.833,57}, - {193,4.8,76}, - {194,4.1,84}, - {195,3.966,77}, - {196,4.233,81}, - {197,3.5,87}, - {198,4.366,77}, - {199,2.25,51}, - {200,4.667,78}, - {201,2.1,60}, - {202,4.35,82}, - {203,4.133,91}, - {204,1.867,53}, - {205,4.6,78}, - {206,1.783,46}, - {207,4.367,77}, - {208,3.85,84}, - {209,1.933,49}, - {210,4.5,83}, - {211,2.383,71}, - {212,4.7,80}, - {213,1.867,49}, - {214,3.833,75}, - {215,3.417,64}, - {216,4.233,76}, - {217,2.4,53}, - {218,4.8,94}, - {219,2,55}, - {220,4.15,76}, - {221,1.867,50}, - {222,4.267,82}, - {223,1.75,54}, - {224,4.483,75}, - {225,4,78}, - {226,4.117,79}, - {227,4.083,78}, - {228,4.267,78}, - {229,3.917,70}, - {230,4.55,79}, - {231,4.083,70}, - {232,2.417,54}, - {233,4.183,86}, - {234,2.217,50}, - {235,4.45,90}, - {236,1.883,54}, - {237,1.85,54}, - {238,4.283,77}, - {239,3.95,79}, - {240,2.333,64}, - {241,4.15,75}, - {242,2.35,47}, - {243,4.933,86}, - {244,2.9,63}, - {245,4.583,85}, - {246,3.833,82}, - {247,2.083,57}, - {248,4.367,82}, - {249,2.133,67}, - {250,4.35,74}, - {251,2.2,54}, - {252,4.45,83}, - {253,3.567,73}, - {254,4.5,73}, - {255,4.15,88}, - {256,3.817,80}, - {257,3.917,71}, - {258,4.45,83}, - {259,2,56}, - {260,4.283,79}, - {261,4.767,78}, - {262,4.533,84}, - {263,1.85,58}, - {264,4.25,83}, - {265,1.983,43}, - {266,2.25,60}, - {267,4.75,75}, - {268,4.117,81}, - {269,2.15,46}, - {270,4.417,90}, - {271,1.817,46}, - {272,4.467,74}} diff --git a/src/Plugins/ComplexCore/docs/CalculateFeatureSizesFilter.md b/src/Plugins/ComplexCore/docs/CalculateFeatureSizesFilter.md index 6edddeb9f0..f916310f26 100644 --- a/src/Plugins/ComplexCore/docs/CalculateFeatureSizesFilter.md +++ b/src/Plugins/ComplexCore/docs/CalculateFeatureSizesFilter.md @@ -1,42 +1,42 @@ # Find Feature Sizes -## Group (Subgroup) ## +## Group (Subgroup) Statistics (Morphological) -## Description ## +## Description This **Filter** calculates the sizes of all **Features**. The **Filter** simply iterates through all **Elements** querying for the **Feature** that owns them and keeping a tally for each **Feature**. The tally is then stored as *NumElements* and the *Volume* and *EquivalentDiameter* are also calculated (and stored) by knowing the volume of each **Element**. 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 ## +## 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 ## +## Required Geometry Not Applicable -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 ## +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | -## Example Pipelines ## +## Example Pipelines + (01) SmallIN100 Morphological Statistics + (10) SmallIN100 Full Reconstruction @@ -45,7 +45,7 @@ Not Applicable + (06) SmallIN100 Synthetic + (09) Image Segmentation -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/ComplexCore/docs/CalculateFeatureSizesFilter.rst b/src/Plugins/ComplexCore/docs/CalculateFeatureSizesFilter.rst deleted file mode 100644 index 24d3863e3b..0000000000 --- a/src/Plugins/ComplexCore/docs/CalculateFeatureSizesFilter.rst +++ /dev/null @@ -1,104 +0,0 @@ -================== -Find Feature Sizes -================== - - -Group (Subgroup) -================ - -Statistics (Morphological) - -Description -=========== - -This **Filter** calculates the sizes of all **Features**. The **Filter** simply iterates through all **Elements** -querying for the **Feature** that owns them and keeping a tally for each **Feature**. The tally is then stored as -*NumElements* and the *Volume* and *EquivalentDiameter* are also calculated (and stored) by knowing the volume of each -**Element**. - -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 | bool | If checked this will generate and store the element | -| Sizes | | 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 | Equival | float | (1) | Diameter of a sphere with the same volume as | -| | entDiameters | | | 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 | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Example Pipelines -================= - -- - - (1) SmallIN100 Morphological Statistics - -- - - (10) SmallIN100 Full Reconstruction - -- InsertTransformationPhase - -- - - (6) SmallIN100 Postsegmentation Processing - -- - - (6) SmallIN100 Synthetic - -- - - (9) Image Segmentation - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/CalculateTriangleAreasFilter.md b/src/Plugins/ComplexCore/docs/CalculateTriangleAreasFilter.md index 911fb4f96f..ffab668cbf 100644 --- a/src/Plugins/ComplexCore/docs/CalculateTriangleAreasFilter.md +++ b/src/Plugins/ComplexCore/docs/CalculateTriangleAreasFilter.md @@ -1,11 +1,11 @@ # Generate Triangle Areas -## Group (Subgroup) ## +## Group (Subgroup) Surface Meshing (Misc) -## Description ## +## Description This **Filter** computes the area of each **Triangle** in a **Triangle Geometry** by calculating the following: @@ -13,31 +13,31 @@ This **Filter** computes the area of each **Triangle** in a **Triangle Geometry* where *O* is the angle between |AB| and |AC|. -## Parameters ## +## Parameters None -## Required Geometry ## +## Required Geometry Triangle -## Required Objects ## +## Required Objects None -## Created Objects ## +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| -| Face Attribute Array | FaceAreas | double | (1) | Specifies the area of each **Face | +| Kind | Default Name | Type | Comp Dims | Description | +|---------------------------|--------------|----------|--------|---------------------------------------------| +| Face Attribute Array | FaceAreas | double | (1) | Specifies the area of each Face | -## Example Pipelines ## +## Example Pipelines + (03) SmallIN100 Mesh Statistics + Triangle_Face_Data_Demo.d3dpipeline -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/ComplexCore/docs/CalculateTriangleAreasFilter.rst b/src/Plugins/ComplexCore/docs/CalculateTriangleAreasFilter.rst deleted file mode 100644 index 30bec648ed..0000000000 --- a/src/Plugins/ComplexCore/docs/CalculateTriangleAreasFilter.rst +++ /dev/null @@ -1,64 +0,0 @@ -======================= -Generate Triangle Areas -======================= - - -Group (Subgroup) -================ - -Surface Meshing (Misc) - -Description -=========== - -This **Filter** computes the area of each **Triangle** in a **Triangle Geometry** by calculating the following: - -:: - - 1/2*|AB||AC|sin(O) - -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 -==================== ============ ====== ========== ================================== - -Example Pipelines -================= - -- - - (3) SmallIN100 Mesh Statistics - -- Triangle_Face_Data_Demo.d3dpipeline - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/ChangeAngleRepresentation.md b/src/Plugins/ComplexCore/docs/ChangeAngleRepresentation.md index fbe1e59efd..05eff56e8d 100644 --- a/src/Plugins/ComplexCore/docs/ChangeAngleRepresentation.md +++ b/src/Plugins/ComplexCore/docs/ChangeAngleRepresentation.md @@ -1,15 +1,15 @@ # Convert Angles to Degrees or Radians -## Group (Subgroup) ## +## Group (Subgroup) Orientation Analysis (Conversion) -## Description ## +## Description This **Filter** will multiply the values of every **Element** by a factor to convert *degrees to radians* or *radians to degrees*. The user needs to know the units of their data in order to use this **Filter** properly. -### Example Usage ### +### Example Usage 2D data files that are in *HKL*'s .ctf format use degrees. 3D data files in *HKL*'s .ctf format use radians. All files in *TSL*'s .ang format use radians. If other file types are used, determine the units before running this **Filter**. @@ -17,32 +17,32 @@ 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 ## +## Parameters | Name | Type | Description | -|------|------|-------------| +|------------|------| --------------------------------- | | Conversion Type | Enumeration | Tells the **Filter** which conversion is being made | -## Required Geometry ## +## Required Geometry Not Applicable -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| Kind | Default Name | Type | Comp Dims | Description | +|---------------------------|--------------|----------|--------|---------------------------------------------| | Element Attribute Array | None | float | (n) | Values that represent angles in degrees or radians | -## Created Objects ## +## Created Objects None -## Example Pipelines ## +## Example Pipelines + TxCopper_Exposed + TxCopper_Unexposed -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/ComplexCore/docs/ChangeAngleRepresentation.rst b/src/Plugins/ComplexCore/docs/ChangeAngleRepresentation.rst deleted file mode 100644 index 9c6634e8ce..0000000000 --- a/src/Plugins/ComplexCore/docs/ChangeAngleRepresentation.rst +++ /dev/null @@ -1,74 +0,0 @@ -==================================== -Convert Angles to Degrees or Radians -==================================== - - -Group (Subgroup) -================ - -Orientation Analysis (Conversion) - -Description -=========== - -This **Filter** will multiply the values of every **Element** by a factor to convert *degrees to radians* or *radians to -degrees*. The user needs to know the units of their data in order to use this **Filter** properly. - -Example Usage -------------- - -2D data files that are in *HKL*\ ’s .ctf format use degrees. 3D data files in *HKL*\ ’s .ctf format use radians. All -files in *TSL*\ ’s .ang format use radians. If other file types are used, determine the units before running this -**Filter**. - -Generally, all **Filters** within DREAM.3D use radians as a default unit, but **Filters** may be added that require the -Euler angles to be in degrees and this **Filter** will allow the user to move back-and-forth between the units. - -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 - -Example Pipelines -================= - -- TxCopper_Exposed -- TxCopper_Unexposed - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/CombineAttributeArraysFilter.md b/src/Plugins/ComplexCore/docs/CombineAttributeArraysFilter.md index 766bc77c0f..9c84292a7f 100644 --- a/src/Plugins/ComplexCore/docs/CombineAttributeArraysFilter.md +++ b/src/Plugins/ComplexCore/docs/CombineAttributeArraysFilter.md @@ -1,11 +1,11 @@ # Combine Attribute Arrays -## Group (Subgroup) ## +## Group (Subgroup) Core (Memory/Management) -## Description ## +## Description This **Filter** will "stack" any number of user-chosen **Attribute Arrays** into a single attribute array and allows the option to remove the original **Attribute Arrays** once this operation is completed. The arrays must all share the same primitive type and number of tuples, but may have differing component dimensions. The resulting combined array will have a total number of components equal to the sum of the number of components for each stacked array. The order in which the components are placed in the combined array is the same as the ordering chosen by the user when selecting the arrays. For example, consider two arrays, one that is a 3-vector and one that is a scalar. The values in memory appear as follows: @@ -15,24 +15,16 @@ _Scalar_: tuple 1 - { s1 } ; tuple 2 - { s1 } ; tuple 3 - { s1 } ... To have the components of the combined array contain the scalar values first, use the box and arrows to the right of the array selection to move the scalar array above the vector array: ------ - ![Combine Attribute Arrays: Scalar First](Images/CombineAttributeArraysGUI_1.png) ------ - After executing the **Filter**, the combined array will have component dimensions of 1 x 4, and will have values in memory as follows: _Combined (scalar first)_: tuple 1 - { s1 v1 v2 v3 } ; tuple 2 - { s1 v1 v2 v3 } ; tuple 3 - { s1 v1 v2 v3 } ... To have the components of the combined array contain the vector values first, simply move the vector array above the scalar array: ------ - ![Combine Attribute Arrays: Vector First](Images/CombineAttributeArraysGUI_2.png) ------ - After executing the **Filter**, the combined array will still have component dimensions of 1 x 4, and but now the values in memory are as follows: _Combined (vector first)_: tuple 1 - { v1 v2 v3 s1 } ; tuple 2 - { v1 v2 v3 s1 } ; tuple 3 - { v1 v2 v3 s1 } ... @@ -40,34 +32,34 @@ _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 ## +## 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 ## +## Required Geometry Not Applicable -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp Dims | Description | -|------|--------------|-------------|---------|----------------| +| Kind | Default Name | Type | Comp Dims | Description | +|---------------------------|--------------|----------|--------|---------------------------------------------| | Any **Attribute Array | None | Any | Any | Attribute Arrays** to combine | -## Created Objects ## +## Created Objects -| Kind | Default Name | Type | Comp Dims | Description | -|------|--------------|-------------|---------|----------------| +| Kind | Default Name | Type | Comp Dims | Description | +|---------------------------|--------------|----------|--------|---------------------------------------------| | Any **Attribute Array | CombinedData | Any | Any | Combined **Attribute Array** name | -## Example Pipelines ## +## Example Pipelines -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/ComplexCore/docs/CombineAttributeArraysFilter.rst b/src/Plugins/ComplexCore/docs/CombineAttributeArraysFilter.rst deleted file mode 100644 index ea6cb21fb5..0000000000 --- a/src/Plugins/ComplexCore/docs/CombineAttributeArraysFilter.rst +++ /dev/null @@ -1,110 +0,0 @@ -======================== -Combine Attribute Arrays -======================== - - -Group (Subgroup) -================ - -Core (Memory/Management) - -Description -=========== - -This **Filter** will “stack” any number of user-chosen **Attribute Arrays** into a single attribute array and allows the -option to remove the original **Attribute Arrays** once this operation is completed. The arrays must all share the same -primitive type and number of tuples, but may have differing component dimensions. The resulting combined array will have -a total number of components equal to the sum of the number of components for each stacked array. The order in which the -components are placed in the combined array is the same as the ordering chosen by the user when selecting the arrays. -For example, consider two arrays, one that is a 3-vector and one that is a scalar. The values in memory appear as -follows: - -*Vector*: tuple 1 - { v1 v2 v3 } ; tuple 2 - { v1 v2 v3 } ; tuple 3 - { v1 v2 v3 } … - -*Scalar*: tuple 1 - { s1 } ; tuple 2 - { s1 } ; tuple 3 - { s1 } … - -To have the components of the combined array contain the scalar values first, use the box and arrows to the right of the -array selection to move the scalar array above the vector array: - --------------- - -.. figure:: Images/CombineAttributeArraysGUI_1.png - :alt: Combine Attribute Arrays: Scalar First - - Combine Attribute Arrays: Scalar First - --------------- - -After executing the **Filter**, the combined array will have component dimensions of 1 x 4, and will have values in -memory as follows: - -*Combined (scalar first)*: tuple 1 - { s1 v1 v2 v3 } ; tuple 2 - { s1 v1 v2 v3 } ; tuple 3 - { s1 v1 v2 v3 } … - -To have the components of the combined array contain the vector values first, simply move the vector array above the -scalar array: - --------------- - -.. figure:: Images/CombineAttributeArraysGUI_2.png - :alt: Combine Attribute Arrays: Vector First - - Combine Attribute Arrays: Vector First - --------------- - -After executing the **Filter**, the combined array will still have component dimensions of 1 x 4, and but now the values -in memory are as follows: - -*Combined (vector first)*: tuple 1 - { v1 v2 v3 s1 } ; tuple 2 - { v1 v2 v3 s1 } ; tuple 3 - { 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 -====================== ============ ==== ========= ================================= - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/CombineStlFilesFilter.md b/src/Plugins/ComplexCore/docs/CombineStlFilesFilter.md index a5e058e53c..294e5964cc 100644 --- a/src/Plugins/ComplexCore/docs/CombineStlFilesFilter.md +++ b/src/Plugins/ComplexCore/docs/CombineStlFilesFilter.md @@ -4,11 +4,11 @@ AMProcessMonitoring (AMProcessMonitoring) -## Description +## Description 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 +## Parameters | Name | Type | Description | |------|------|------| | Path to STL Files | Directory Path | The path to the folder containing all the STL files to be combined | @@ -16,9 +16,9 @@ This **Filter** combines all of the STL files from a given directory into a sing ## Required Geometry Not Applicable -## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +## 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 | @@ -28,7 +28,7 @@ Not Applicable CombineStlFiles -## License & Copyright +## License & Copyright Please see the description file distributed with this plugin. diff --git a/src/Plugins/ComplexCore/docs/CombineStlFilesFilter.rst b/src/Plugins/ComplexCore/docs/CombineStlFilesFilter.rst deleted file mode 100644 index 7cd04dbd84..0000000000 --- a/src/Plugins/ComplexCore/docs/CombineStlFilesFilter.rst +++ /dev/null @@ -1,65 +0,0 @@ -================= -Combine STL Files -================= - - -Group (Subgroup) -================ - -AMProcessMonitoring (AMProcessMonitoring) - -Description -=========== - -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 | Tria | N/A | N/A | The path to the triangle geometry to be created | -| | ngleGeometry | | | 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 | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Example Pipelines -================= - -CombineStlFiles - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/ComputeFeatureRectFilter.md b/src/Plugins/ComplexCore/docs/ComputeFeatureRectFilter.md index 94cdbef196..ef2e5b3565 100644 --- a/src/Plugins/ComplexCore/docs/ComputeFeatureRectFilter.md +++ b/src/Plugins/ComplexCore/docs/ComputeFeatureRectFilter.md @@ -1,11 +1,11 @@ -# Compute Feature Rect # +# Compute Feature Rect -## Group (Subgroup) ## +## Group (Subgroup) Reconstruction (Reconstruction) -## Description ## +## Description This **Filter** computes the XYZ minimum and maximum coordinates for each **Feature** in a segmentation. This data can be important for finding the smallest encompassing volume. This values are given in **Pixel** coordinates. @@ -29,32 +29,32 @@ If the example matrix above which represents a single feature where the feature Z Max = 0 -## Parameters ## +## Parameters N/A -## Required Geometry ## +## Required Geometry N/A -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 ## +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| Kind | Default Name | Type | Comp Dims | Description | +|---------------------------|--------------|----------|--------|---------------------------------------------| | Feature Attribute Array | FeatureRect | uint32 | (6) | Xmin, Ymin, Zmin, Xmax, Ymax, Zmax | -## Example Pipelines ## +## Example Pipelines -## License & Copyright ## +## License & Copyright Please see the description file distributed with this plugin. diff --git a/src/Plugins/ComplexCore/docs/ComputeFeatureRectFilter.rst b/src/Plugins/ComplexCore/docs/ComputeFeatureRectFilter.rst deleted file mode 100644 index 817762678a..0000000000 --- a/src/Plugins/ComplexCore/docs/ComputeFeatureRectFilter.rst +++ /dev/null @@ -1,84 +0,0 @@ -==================== -Compute Feature Rect -==================== - - -Group (Subgroup) -================ - -Reconstruction (Reconstruction) - -Description -=========== - -This **Filter** computes the XYZ minimum and maximum coordinates for each **Feature** in a segmentation. This data can -be important for finding the smallest encompassing volume. This values are given in **Pixel** coordinates. - -== = = = = = -\ 0 1 2 3 4 -== = = = = = -0 0 0 1 0 0 -1 0 0 1 1 0 -2 0 1 1 1 1 -3 0 0 1 1 0 -4 0 0 0 0 0 -== = = = = = - -If the example matrix above which represents a single feature where the feature ID = 1, the output of the filter would -be: - -:: - - X Min = 1 - Y Min = 0 - Z Min = 0 - - X Max = 4 - 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 | N/A | Feature AttributeMatrix | N/A | The path to the cell | -| Matrix | | | | feature \**Attribute | -| | | | | Matrix | -+-------------------------+---------------------+-------------------------+------------+-------------------------+ - -Created Objects -=============== - -======================= ============ ====== ========== ================================== -Kind Default Name Type Comp. Dims Description -======================= ============ ====== ========== ================================== -Feature Attribute Array FeatureRect uint32 (6) Xmin, Ymin, Zmin, Xmax, Ymax, Zmax -======================= ============ ====== ========== ================================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/ComputeMomentInvariants2DFilter.md b/src/Plugins/ComplexCore/docs/ComputeMomentInvariants2DFilter.md index be73c3e54b..bf60172928 100644 --- a/src/Plugins/ComplexCore/docs/ComputeMomentInvariants2DFilter.md +++ b/src/Plugins/ComplexCore/docs/ComputeMomentInvariants2DFilter.md @@ -5,7 +5,7 @@ Statistics (Statistics) -## Description +## Description This **Filter** computes the 2D Omega-1 and Omega 2 values from the *Central Moments* matrix and optionally will normalize the values to a unit circle and also optionally save the *Central Moments* matrix as a DataArray to the *Cell Feature Attribute Matrix*. Based off the paper by MacSleyne et. al [1], the algorithm will calculate the 2D central moments for each feature starting at *feature id = 1*. Because *feature id 0* is of special significance and typically is a matrix or background it is ignored in this filter. If any feature id has a Z Delta of > 1, the feature will be skipped. This algorithm works strictly in the XY plane and is meant to be applied to a 2D image. Using the research from the cited paper certain shapes can be detected using the Omega-1 and Omega-2 values. An example usage is finding elliptical shapes in an image: @@ -19,10 +19,10 @@ See below figure from [1] that can help the user classify objects. -## Parameters +## 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 | @@ -34,19 +34,19 @@ ImageGeom CentralMomentsArrayPath 2 -## Required Objects +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | @@ -60,11 +60,11 @@ ImageGeom 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 +## Example Pipelines -## License & Copyright +## License & Copyright Please see the description file distributed with this plugin. diff --git a/src/Plugins/ComplexCore/docs/ComputeMomentInvariants2DFilter.rst b/src/Plugins/ComplexCore/docs/ComputeMomentInvariants2DFilter.rst deleted file mode 100644 index 53ad4091db..0000000000 --- a/src/Plugins/ComplexCore/docs/ComputeMomentInvariants2DFilter.rst +++ /dev/null @@ -1,102 +0,0 @@ -============================= -Compute MomentInvariants (2D) -============================= - - -Group (Subgroup) -================ - -Statistics (Statistics) - -Description -=========== - -This **Filter** computes the 2D Omega-1 and Omega 2 values from the *Central Moments* matrix and optionally will -normalize the values to a unit circle and also optionally save the *Central Moments* matrix as a DataArray to the *Cell -Feature Attribute Matrix*. Based off the paper by MacSleyne et. al [1], the algorithm will calculate the 2D central -moments for each feature starting at *feature id = 1*. Because *feature id 0* is of special significance and typically -is a matrix or background it is ignored in this filter. If any feature id has a Z Delta of > 1, the feature will be -skipped. This algorithm works strictly in the XY plane and is meant to be applied to a 2D image. Using the research from -the cited paper certain shapes can be detected using the Omega-1 and Omega-2 values. An example usage is finding -elliptical shapes in an image: - -See below figure from [1] that can help the user classify objects. - -.. figure:: Images/ComputeMomentInvariants_Fig1.png - :alt: Example appllication of filter to identify elliptical particales (red) which are differentiated from - non-elliptical particals (purple) - - Example appllication of filter to identify elliptical particales (red) which are differentiated from non-elliptical - particals (purple) - -.. figure:: Images/ComputeMomentInvariants2D.png - :alt: Example appllication of filter to identify elliptical particales (red) which are differentiated from - non-elliptical particals (purple) - - Example appllication of filter to identify elliptical particales (red) which are differentiated from non-elliptical - particals (purple) - -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 | Feat | uint32_t | (6) | Array holding the min xy and max xy pixel | -| | ureRectArray | | | 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 -======================= ============== ===== ========== ===================== - -Citations - -[1] J.P. MacSleyne, J.P. Simmons, M. De Graef, *On the use of 2-D moment invariants for the automated classification of -particle shapes*, Acta Materialia, Volume 56, Issue 3, February 2008, Pages 427-437, ISSN 1359-6454, -http://dx.doi.org/10.1016/j.actamat.2007.09.039. http://www.sciencedirect.com/science/article/pii/S1359645407006702 - -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 -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/ConditionalSetValue.md b/src/Plugins/ComplexCore/docs/ConditionalSetValue.md index c07887f8ec..8e247e50e7 100644 --- a/src/Plugins/ComplexCore/docs/ConditionalSetValue.md +++ b/src/Plugins/ComplexCore/docs/ConditionalSetValue.md @@ -1,14 +1,14 @@ # Replace Value in Array (Conditional) -## Group (Subgroup) ## +## Group (Subgroup) Core (Misc) -## Description ## +## Description This **Filter** replaces values in a user specified **Attribute Array** with a user specified value a second boolean **Attribute Array** specifies, but only when **Use Conditional Mask** is *true*. For example, if the user entered a *Replace Value* of *5.5*, then for every occurence of *true* in the conditional boolean array, the selected **Attribute Array** would be changed to 5.5. If **Use Conditional Mask** is *false*, then **Value to Replace** will be searched for in the provided **Attribute Array** and all instances will be replaced. Below are the ranges for the values that can be entered for the different primitive types of arrays (for user reference). The selected **Attribute Array** must be a scalar array. -### Primitive Data Types ## +### Primitive Data Types | Type | Size | Range | |------------------|------|--------------------| @@ -24,13 +24,13 @@ 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 ## +## 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 ## +## Optional Data Mask | Name | Type | Description | |------------------|------|-------------| | Use Conditional Mask | bool | Whether to use a boolean mask array to replace values marked true | @@ -38,21 +38,21 @@ This **Filter** replaces values in a user specified **Attribute Array** with a u | 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 ## +## Required Geometry Not Applicable -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp Dims | Description | -|------|--------------|-------------|---------|----------------| +| Kind | Default Name | Type | Comp Dims | Description | +|---------------------------|--------------|----------|--------|---------------------------------------------| | Any **Attribute Array | None | Any | (1) | Path to **Attribute Array** that will have values replaced | -## Created Objects ## +## Created Objects None -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/ComplexCore/docs/ConditionalSetValue.rst b/src/Plugins/ComplexCore/docs/ConditionalSetValue.rst deleted file mode 100644 index 7bb40cdeab..0000000000 --- a/src/Plugins/ComplexCore/docs/ConditionalSetValue.rst +++ /dev/null @@ -1,99 +0,0 @@ -==================================== -Replace Value in Array (Conditional) -==================================== - - -Group (Subgroup) -================ - -Core (Misc) - -Description -=========== - -This **Filter** replaces values in a user specified **Attribute Array** with a user specified value a second boolean -**Attribute Array** specifies, but only when **Use Conditional Mask** is *true*. For example, if the user entered a -*Replace Value* of *5.5*, then for every occurence of *true* in the conditional boolean array, the selected **Attribute -Array** would be changed to 5.5. If **Use Conditional Mask** is *false*, then **Value to Replace** will be searched for -in the provided **Attribute Array** and all instances will be replaced. Below are the ranges for the values that can be -entered for the different primitive types of arrays (for user reference). The selected **Attribute Array** must be a -scalar array. - -Primitive Data Types --------------------- - -================ ====== ============================================================= -Type Size Range -================ ====== ============================================================= -Signed Integer 8 bit 0 to 255 -Unsigned Integer 8 bit -128 to 127 -Signed Integer 16 bit -32,768 to 32,767 -Unsigned Integer 16 bit 0 to 65,535 -Signed Integer 32 bit -2,147,483,648 to 2,147,483,647 -Unsigned Integer 32 bit 0 to 4,294,967,295 -Signed Integer 64 bit 9,223,372,036,854,775,808 to 9,223,372,036,854,775,807 -Unsigned Integer 64 bit 0 to 18,446,744,073,709,551,615 -Float 32 bit -3.4e+38 to -1.1e-38, 0.0, 1.1e-38 to 3.4e+38 (7 digits) -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 | -+---------------------------------------------------------+------------------+-----------------------------------------+ -| 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 - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/ConvertColorToGrayScaleFilter.md b/src/Plugins/ComplexCore/docs/ConvertColorToGrayScaleFilter.md index 0ca9c4f1bf..e5ee71f2b9 100644 --- a/src/Plugins/ComplexCore/docs/ConvertColorToGrayScaleFilter.md +++ b/src/Plugins/ComplexCore/docs/ConvertColorToGrayScaleFilter.md @@ -1,11 +1,11 @@ # Color to GrayScale -## Group (Subgroup) ## +## Group (Subgroup) Processing (Image) -## Description ## +## Description This **Filter** allows the user to select a *flattening* method for turning an array of RGB or RGBa values into grayscale values. @@ -16,7 +16,7 @@ This **Filter** allows the user to select a *flattening* method for turning an a The user can select 1 or more image data arrays which are assumed to be multi-component arrays of unsigned 8 bit values. The user can create a new AttributeMatrix if they want to store all the newly created arrays in a separate AttributeMatrix. -### Additional GrayScale Conversions ### +### Additional GrayScale Conversions The following are some additional accepted grayscale conversions @@ -24,7 +24,7 @@ The following are some additional accepted grayscale conversions + (YIQ/NTSC): Red: 0.299 Green: 0.587 Blue: 0.114 -## Parameters ## +## Parameters | Name | Type | Description | |------|------|------| @@ -33,29 +33,29 @@ The following are some additional accepted grayscale conversions | 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 ## +## Required Geometry Not Applicable -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| Kind | Default Name | Type | Comp Dims | Description | +|---------------------------|--------------|----------|--------|---------------------------------------------| | Element Attribute Array(s) | ImageData | uint8_t | (3) or (4) | RGB or RGBA values | -## Created Objects ## +## Created Objects | Kind | Default Name | Type | Component Dimensions (dimension, size) | Description | -|------|--------------|-------------|---------|-----| +|------|--------------|-----|-----|-----------------------------------| | Element Attribute Array | GrayScale Data | uint8_t | (1) | Grayscale values | | AttributeMatrix (Optional) | | | | | -## Example Pipelines ## +## Example Pipelines -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/ComplexCore/docs/ConvertColorToGrayScaleFilter.rst b/src/Plugins/ComplexCore/docs/ConvertColorToGrayScaleFilter.rst deleted file mode 100644 index 56b50dd8f4..0000000000 --- a/src/Plugins/ComplexCore/docs/ConvertColorToGrayScaleFilter.rst +++ /dev/null @@ -1,93 +0,0 @@ -================== -Color to GrayScale -================== - - -Group (Subgroup) -================ - -Processing (Image) - -Description -=========== - -This **Filter** allows the user to select a *flattening* method for turning an array of RGB or RGBa values into -grayscale values. - -- Luminosity: The **luminosity** method is a more sophisticated version of the average method. It also averages the - values, but it forms a weighted average to account for human perception. We re more sensitive to green than other - colors, so green is weighted most heavily. The default formula for luminosity is BT709 Greyscale: Red: 0.2125 Green: - 0.7154 Blue: 0.0721. The user can set the weightings to what ever values they would like. -- Average (R + G + B) / 3 -- Lightness (max(R, G, B) + min(R, G, B)) / 2 -- Color Channel: The user selects a specific R|G|B channel to use as the GrayScale values. - -The user can select 1 or more image data arrays which are assumed to be multi-component arrays of unsigned 8 bit values. -The user can create a new AttributeMatrix if they want to store all the newly created arrays in a separate -AttributeMatrix. - -Additional GrayScale Conversions --------------------------------- - -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) -========================== ============== ======= ====================================== ================ - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/ConvertDataFilter.md b/src/Plugins/ComplexCore/docs/ConvertDataFilter.md index 511d478367..4866ee11c6 100644 --- a/src/Plugins/ComplexCore/docs/ConvertDataFilter.md +++ b/src/Plugins/ComplexCore/docs/ConvertDataFilter.md @@ -1,18 +1,18 @@ # Convert Attribute Data Type -## Group (Subgroup) ## +## Group (Subgroup) Core (Misc) -## Description ## +## Description This **Filter** converts attribute data from one primitive type to another by using the built in translation of the compiler. This **Filter** can be used if the user needs to convert an array into a type that is accepted by another **Filter**. For example, a **Filter** may need an input array to be of type _int32_t_ but the array that the user would like to use is _uint16_t_. The user may use this **Filter** to create a new array that has the proper target type (_int32_t_). **This Filter is here for convenience and should be used with great care and understanding of the input and output data. This Filter should rarely be required, and if the user thinks that they require this Filter then a detailed examination of all the data involved should be undertaken to avoid possible undefined behaviors.** -### Important Notes ### +### Important Notes **Up Casting** @@ -26,33 +26,33 @@ 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 ## +## Parameters | Name | Type | Description | |------------------|------|--------------| | Scalar Type | Enumeration | Convert to this data type | -## Required Geometry ## +## Required Geometry Not Applicable -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| Kind | Default Name | Type | Comp Dims | Description | +|---------------------------|--------------|----------|--------|---------------------------------------------| | Any **Attribute Array** | None | Any | Any | Array to convert | -## Created Objects ## +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| Kind | Default Name | Type | Comp Dims | Description | +|---------------------------|--------------|----------|--------|---------------------------------------------| | Any **Attribute Array | None | Any | Any | The converted array | -## Example Pipelines ## +## Example Pipelines -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/ComplexCore/docs/ConvertDataFilter.rst b/src/Plugins/ComplexCore/docs/ConvertDataFilter.rst deleted file mode 100644 index 5a3f4f6d1f..0000000000 --- a/src/Plugins/ComplexCore/docs/ConvertDataFilter.rst +++ /dev/null @@ -1,92 +0,0 @@ -=========================== -Convert Attribute Data Type -=========================== - - -Group (Subgroup) -================ - -Core (Misc) - -Description -=========== - -This **Filter** converts attribute data from one primitive type to another by using the built in translation of the -compiler. This **Filter** can be used if the user needs to convert an array into a type that is accepted by another -**Filter**. For example, a **Filter** may need an input array to be of type *int32_t* but the array that the user would -like to use is *uint16_t*. The user may use this **Filter** to create a new array that has the proper target type -(*int32_t*). - -**This Filter is here for convenience and should be used with great care and understanding of the input and output data. -This Filter should rarely be required, and if the user thinks that they require this Filter then a detailed examination -of all the data involved should be undertaken to avoid possible undefined behaviors.** - -Important Notes ---------------- - -**Up Casting** - -Upcasting is most likely well defined by the compilers. This is the act of creating a new array using a primitive value -that is represented by more bytes than the original data. For example, if the user converts 1 byte integers into 4 byte -integers or converted 4 byte floats into 8 byte floats. - -**Down Casting** - -Down casting can have undefined behavior depending on the primitive types involved. Down casting is the opposite of up -casting and involves converting data from a larger byte count representation to a representation of lower byte count. -For example, converting 4 byte integers into 2 byte integers or 8 byte floats into 4 byte floats. What happens to the -data depends on the range of values in the original array. If the target type’s range can hold all the values of the -original array’s values, then the conversion would have a well defined outcome. - -**Signed/Unsigned Conversions** - -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 -====================== ============ ==== ========== =================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/CopyDataObjectFilter.md b/src/Plugins/ComplexCore/docs/CopyDataObjectFilter.md index e2c09bbaea..d366a30f2c 100644 --- a/src/Plugins/ComplexCore/docs/CopyDataObjectFilter.md +++ b/src/Plugins/ComplexCore/docs/CopyDataObjectFilter.md @@ -1,11 +1,11 @@ # Copy Data Object -## Group (Subgroup) ## +## Group (Subgroup) Core (Generation) -## Description ## +## Description This **Filter** deep copies one or more DataObjects. @@ -21,32 +21,32 @@ 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 ## +## Parameters None -## Required Geometry ## +## Required Geometry Not Applicable -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp Dims | Description | -|------|--------------|-------------|---------|----------------| +| 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 ## +## Created Objects A deep copy of the DataObjects selected in the input. -## Example Pipelines ## +## Example Pipelines -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/ComplexCore/docs/CopyDataObjectFilter.rst b/src/Plugins/ComplexCore/docs/CopyDataObjectFilter.rst deleted file mode 100644 index c00235ddd7..0000000000 --- a/src/Plugins/ComplexCore/docs/CopyDataObjectFilter.rst +++ /dev/null @@ -1,76 +0,0 @@ -================ -Copy Data Object -================ - - -Group (Subgroup) -================ - -Core (Generation) - -Description -=========== - -This **Filter** deep copies one or more DataObjects. - -\**In the case of copying \_DataObject_s that inherit from *BaseGroup*\ **, such as DataGroup or AttributeMatrix,** it -will copy all of the child objects recursively*\*, that is to say all of an object’s children and childrens’ children -and so on will be copied if applicable. - -Commonly used *BaseGroup* children: - **ALL** Geometries - *DataGroup* - *AttributeMatrix* - *GridMontage* - -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 | -+===========+===========================+=========================+=================+================================+ -| D | N/A | N/A | N/A | The list of DataObjects to | -| ataObject | | | | 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. - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/CopyFeatureArrayToElementArray.md b/src/Plugins/ComplexCore/docs/CopyFeatureArrayToElementArray.md index 15ce69ce6d..42b0561d0d 100644 --- a/src/Plugins/ComplexCore/docs/CopyFeatureArrayToElementArray.md +++ b/src/Plugins/ComplexCore/docs/CopyFeatureArrayToElementArray.md @@ -1,42 +1,42 @@ # Create Element Array from Feature Array -## Group (Subgroup) ## +## Group (Subgroup) Core (Memory/Management) -## Description ## +## Description 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 ## +## Parameters None -## Required Geometry ## +## Required Geometry Not Applicable -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 ## +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| Kind | Default Name | Type | Comp Dims | Description | +|---------------------------|--------------|----------|--------|---------------------------------------------| | Element **Attribute Array | None | Any | Any | Copied **Attribute Array** | -## Example Pipelines ## +## Example Pipelines -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/ComplexCore/docs/CopyFeatureArrayToElementArray.rst b/src/Plugins/ComplexCore/docs/CopyFeatureArrayToElementArray.rst deleted file mode 100644 index ae330255ef..0000000000 --- a/src/Plugins/ComplexCore/docs/CopyFeatureArrayToElementArray.rst +++ /dev/null @@ -1,59 +0,0 @@ -======================================= -Create Element Array from Feature Array -======================================= - - -Group (Subgroup) -================ - -Core (Memory/Management) - -Description -=========== - -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** -========================== ============ ==== ========== ========================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/CreateAttributeMatrixFilter.md b/src/Plugins/ComplexCore/docs/CreateAttributeMatrixFilter.md index c55c390b3a..2e54004b2b 100644 --- a/src/Plugins/ComplexCore/docs/CreateAttributeMatrixFilter.md +++ b/src/Plugins/ComplexCore/docs/CreateAttributeMatrixFilter.md @@ -1,47 +1,47 @@ -# Create Attribute Matrix # +# Create Attribute Matrix -## Group (Subgroup) ## +## Group (Subgroup) Core (Generation) -## Description ## +## Description This **Filter** creates a new **Attribute Matrix**. -### Example Usage ### +### Example Usage 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 ## +## 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 ## +## Required Geometry Not Applicable -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| Kind | Default Name | Type | Comp Dims | Description | +|---------------------------|--------------|----------|--------|---------------------------------------------| | Data Container | None | N/A | N/A | Data Container for the created **Attribute Matrix** | -## Created Objects ## +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| Kind | Default Name | Type | Comp Dims | Description | +|---------------------------|--------------|----------|--------|---------------------------------------------| | Attribute Matrix** | None | Any | N/A | Created **Attribute Matrix** name | -## Example Pipelines ## +## Example Pipelines -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/ComplexCore/docs/CreateAttributeMatrixFilter.rst b/src/Plugins/ComplexCore/docs/CreateAttributeMatrixFilter.rst deleted file mode 100644 index 11c8b2a3be..0000000000 --- a/src/Plugins/ComplexCore/docs/CreateAttributeMatrixFilter.rst +++ /dev/null @@ -1,61 +0,0 @@ -======================= -Create Attribute Matrix -======================= - - -Group (Subgroup) -================ - -Core (Generation) - -Description -=========== - -This **Filter** creates a new **Attribute Matrix**. - -Example Usage -------------- - -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 -=================== ============ ==== ========== ================================= - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/ComplexCore/docs/CreateDataArray.md b/src/Plugins/ComplexCore/docs/CreateDataArray.md index b2cc9a0d2a..048d5fe654 100644 --- a/src/Plugins/ComplexCore/docs/CreateDataArray.md +++ b/src/Plugins/ComplexCore/docs/CreateDataArray.md @@ -1,10 +1,10 @@ # Create Data Array -## Group (Subgroup) ## +## Group (Subgroup) Core (Generation) -## Description ## +## Description This **Filter** creates an **Data Array** of any primitive type with any number of components along a *single component dimension*. For example, a scalar as (1) or a 3-vector as (3), but *not* a matrix as (3, 3). The array is initialized to a user define value or with random values within a specified range. @@ -22,7 +22,7 @@ When creating a Data Array within an Attribute matrix, the tuple dimensions will If the parent is **NOT an Attribute Matrix**, then the user ***MUST*** set the tuple dimensions themselves. -### Scalar Type Values ### +### Scalar Type Values static const int Int8 = 0; static const int UInt8 = 1; @@ -36,7 +36,7 @@ If the parent is **NOT an Attribute Matrix**, then the user ***MUST*** set the t static const int Double = 9; static const int Bool = 10; -### Primitive Data Type Valid Ranges ## +### Primitive Data Type Valid Ranges | Type | Size | Range | |------------------|------|--------------------| @@ -55,7 +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 ## +## Parameters | Name | Type | Description | |------------------|------|-------------| @@ -65,23 +65,23 @@ must have a user entry or the default value *0* will be used. | 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 ## +## Required Geometry Not Applicable -## Required Objects ## +## Required Objects None -## Created Objects ## +## Created Objects -| Kind | Default Name | Type | Comp Dims | Description | -|------|--------------|-------------|---------|----------------| +| Kind | Default Name | Type | Comp Dims | Description | +|---------------------------|--------------|----------|--------|---------------------------------------------| | Any **Attribute Array | None | Any | Any | Created **Attribute Array** location and name | -## Example Pipelines ## +## Example Pipelines -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/ComplexCore/docs/CreateDataArray.rst b/src/Plugins/ComplexCore/docs/CreateDataArray.rst deleted file mode 100644 index d2c39c4b95..0000000000 --- a/src/Plugins/ComplexCore/docs/CreateDataArray.rst +++ /dev/null @@ -1,139 +0,0 @@ -================= -Create Data Array -================= - - -Group (Subgroup) -================ - -Core (Generation) - -Description -=========== - -This **Filter** creates an **Data Array** of any primitive type with any number of components along a *single component -dimension*. For example, a scalar as (1) or a 3-vector as (3), but *not* a matrix as (3, 3). The array is initialized to -a user define value or with random values within a specified range. - -When initializing a multicomponent array square bracket notation can be used to specify different initialization values -for each component. For example say that I want to intialize a 2 component array where the first component is 0 and the -second component is 1 we would use the following input string for the *Initialization Value* - -:: - - 0;1 - -We are using semicolons instead of commas or decimal points due to different international standards (European versus -United States?). - -Another example is if you want to create a floating point array where each tuple has 10 components but you just want the -value of 2.5 to be used for each, then simply use: - -:: - - 2.5 - -When creating a Data Array within an Attribute matrix, the tuple dimensions will **always** be taken direct from the -Attribute Matrix. This means that the *Set Tuple Dimensions* parameter can be unchecked to hide the tuple dimensions -entry table. - -If the parent is **NOT an Attribute Matrix**, then the user **MUST** set the tuple dimensions themselves. - -Scalar Type Values ------------------- - -:: - - static const int Int8 = 0; - static const int UInt8 = 1; - static const int Int16 = 2; - static const int UInt16 = 3; - static const int Int32 = 4; - static const int UInt32 = 5; - static const int Int64 = 6; - static const int UInt64 = 7; - static const int Float = 8; - static const int Double = 9; - static const int Bool = 10; - -Primitive Data Type Valid Ranges --------------------------------- - -================ ====== ============================================================= -Type Size Range -================ ====== ============================================================= -Signed Integer 8 bit 0 to 255 -Unsigned Integer 8 bit -128 to 127 -Signed Integer 16 bit -32,768 to 32,767 -Unsigned Integer 16 bit 0 to 65,535 -Signed Integer 32 bit -2,147,483,648 to 2,147,483,647 -Unsigned Integer 32 bit 0 to 4,294,967,295 -Signed Integer 64 bit 9,223,372,036,854,775,808 to 9,223,372,036,854,775,807 -Unsigned Integer 64 bit 0 to 18,446,744,073,709,551,615 -Float 32 bit -3.4e+38 to -1.1e-38, 0.0, 1.1e-38 to 3.4e+38 (7 digits) -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 -================ ====== ============================================================= - -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 -====================== ============ ==== ========= ============================================= - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/CreateDataGroup.md b/src/Plugins/ComplexCore/docs/CreateDataGroup.md index 1b68c8f662..5266b4e353 100644 --- a/src/Plugins/ComplexCore/docs/CreateDataGroup.md +++ b/src/Plugins/ComplexCore/docs/CreateDataGroup.md @@ -1,40 +1,40 @@ # Create Data Group -## Group (Subgroup) ## +## Group (Subgroup) Core (Generation) -## Description ## +## Description This **Filter** creates a new **DataGroup**. Unlike _AttributeMatrix_, _DataGroup_s are capable of holding any *DataObject* of any size. -## Parameters ## +## Parameters None -## Required Geometry ## +## Required Geometry Not Applicable -## Required Objects ## +## Required Objects Not Applicable -## Created Objects ## +## Created Objects -| Kind | Default Name | Type | Comp Dims | Description | -|------|--------------|-------------|---------|----------------| +| Kind | Default Name | Type | Comp Dims | Description | +|---------------------------|--------------|----------|--------|---------------------------------------------| | Data Container | DataContainer | N/A | N/A | Created **Data Container** name | -## Example Pipelines ## +## Example Pipelines -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/ComplexCore/docs/CreateDataGroup.rst b/src/Plugins/ComplexCore/docs/CreateDataGroup.rst deleted file mode 100644 index ca4b25736d..0000000000 --- a/src/Plugins/ComplexCore/docs/CreateDataGroup.rst +++ /dev/null @@ -1,54 +0,0 @@ -================= -Create Data Group -================= - - -Group (Subgroup) -================ - -Core (Generation) - -Description -=========== - -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 -============== ============= ==== ========= =============================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/CreateFeatureArrayFromElementArray.md b/src/Plugins/ComplexCore/docs/CreateFeatureArrayFromElementArray.md index 6aa438f4b9..40594de01b 100644 --- a/src/Plugins/ComplexCore/docs/CreateFeatureArrayFromElementArray.md +++ b/src/Plugins/ComplexCore/docs/CreateFeatureArrayFromElementArray.md @@ -1,24 +1,24 @@ # Create Feature Array From Element Array -## Group (Subgroup) ## +## Group (Subgroup) Core (Memory/Management) -## Description ## +## Description 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 ## +## Parameters None -## Required Geometry ## +## Required Geometry Not Applicable -## Required Objects ## +## Required Objects | Kind | Type | Comp Dims | Description | |------|------|-------------|-------------| @@ -27,17 +27,17 @@ Not Applicable | Cell Feature **Attribute Matrix | Cell Feauture | N/A | The path to the cell feature **Attribute Matrix | -## Created Objects ## +## Created Objects | Kind | Type | Comp Dims | Description | |------|------|-------------|-------------| | Feature Array DataPath | Any | Any | The copied array containing **Feature** data | -## Example Pipelines ## +## Example Pipelines -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/ComplexCore/docs/CreateFeatureArrayFromElementArray.rst b/src/Plugins/ComplexCore/docs/CreateFeatureArrayFromElementArray.rst deleted file mode 100644 index 2fac703fa1..0000000000 --- a/src/Plugins/ComplexCore/docs/CreateFeatureArrayFromElementArray.rst +++ /dev/null @@ -1,59 +0,0 @@ -======================================= -Create Feature Array From Element Array -======================================= - - -Group (Subgroup) -================ - -Core (Memory/Management) - -Description -=========== - -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 -====================== ==== ========= ============================================ - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/CreateGeometryFilter.md b/src/Plugins/ComplexCore/docs/CreateGeometryFilter.md index a1e86e3d08..44140a4c13 100644 --- a/src/Plugins/ComplexCore/docs/CreateGeometryFilter.md +++ b/src/Plugins/ComplexCore/docs/CreateGeometryFilter.md @@ -1,11 +1,11 @@ # Create Geometry -## Group (Subgroup) ## +## Group (Subgroup) DREAM3D Review (Geometry) -## Description ## +## Description This **Filter** creates a **Geometry** object and the necessary **Element Attribute Matrices** on which to store **Attribute Arrays** and **Element Attribute Arrays** which define the geometry. The type of **Attribute Matrices** and **Attribute Arrays** created depends on the kind of **Geometry** being created: @@ -20,13 +20,13 @@ This **Filter** creates a **Geometry** object and the necessary **Element Attrib | Tetrahedral | Vertex + Cell | Vertices + Cells | | Hexahedral | Vertex + Cell | Vertices + Cells | -### Understanding Geometries ### +### Understanding Geometries This **Filter** requires the user to enter information that defines the topological information for the chosen **Geometry**. Choosing valid information for a given **Geometry** necessitates an understanding of how **DREAM.3D** stores and interprets this information. A general overview of the data model used in **DREAM.3D** may be found here. More specific information for **Geometry** objects is provided below. -#### Grid Geometries #### +#### Grid Geometries -##### Image ##### +##### Image An **Image Geometry** is a _grid-like_ **Geometry**, and is the simplest and most widely used of the basic **Geometry** types. An **Image Geometry** is a _regular, rectilinear grid_; if the *dimenionality* of the image is _d_, then only _3*d_ numbers are needed to completely define the **Geometry**: three _d_-vectors for the _dimensions_, _origin_, and _resolution_. Dimensions define the extents of the grid, the resolution defines the spacing between grid planes for each orthogonal direction (constant along a given direction), and the origin defines the physical location of the *bottom left* grid point in _d_-dimensional space. The dimensions are stored as _unsigned 64-bit integers_, while the origin and resolution are stored as _32-bit floats_. @@ -34,21 +34,21 @@ All **Image Geometries** in **DREAM.3D** are defined using 3-vectors (3D images) Since all **Image Geometries** are implicitly 3D (even when plane-like), the fundamental building-block of an image is a _voxel_, which is a 3D object; therefore, the basic **Element** type for an **Image Geometry** is **Cell**. **Attribute Arrays** associated with **Image Cells** are assumed to raster _x-y-z_, fastest to slowest. -##### Rectilinear Grid ##### +##### Rectilinear Grid A **Rectilinear Grid Geometry** is a _grid-like_ **Geometry**. Similar to an **Image Geometry**, a **Rectilinear Grid Geometry** has grid extents (dimensions), but is allowed to have variable *resolution* along each orthogonal direction. The **Geometry** then requires a total of (xdim + 1) + (ydim + 1) + (zdim + 1) numbers to define the topology. The values are stored in three separate arrays termed the _x bounds_, _y bounds_, and _z bounds_. These bounds arrays store the spatial location of all the planes along a given orthogonal direction. The spacing for a given plane (equivalent to the resolution for an **Image Geometry**) is then the difference between two of these contiguous array values. An origin does not need to be defined for a **Rectilinear Grid Geometry**, since the grid's location in space is explicitly encoded in its bounds arrays. This **Filter** requires the user to select **Attribute Arrays** that define the three bounds arrays. These arrays must be _single component, 32-bit float_ arrays. Additionally, the values for each of the bounds arrays must be _strictly increasing_, which guarantees that computing the spacing for a given plane yields a postive value. A **Rectilinear Grid Geometry** may be defined as 2D; the associated bounds array for the plane dimension is then exactly two. No bounds arrays may have less than two values. Since all **Rectilinear Grid Geometries** are implicitly 3D (even when plane-like), the fundamental building-block of an image is a _voxel_, which is a 3D object; therefore, the basic **Element** type for an **Image Geometry** is **Cell**. **Attribute Arrays** associated with **Rectilinear Grid Cells** are assumed to raster _x-y-z_, fastest to slowest. -#### Unstructured and Mesh-Like Geometries #### +#### Unstructured and Mesh-Like Geometries -##### Vertex ##### +##### Vertex A **Vertex Geometry** is an *unstructured* **Geometry**. An unstructured **Geometry** requires explicit definition of point coordinates. Sometimes referred to as a _point cloud_, a **Vertex Geometry** is simply a collection of points. Defining this topology requires a total number of values equal to *d* times the total number of points, where *d* is the dimensionality of the point cloud; within **DREAM.3D**, *d* is always taken to be three. The point coordinates are stored as _32-bit floats_; no other range restrictions are enforced. This **Filter** requires the user to select an **Attribute Array** that defines these point coordinates. The array must have *three components* and consist of _32-bit floats_. The number of *tuples* in the array defines the number of vertices in the resulting **Vertex Geometry**. The fundamental **Element** type of a **Vertex Geometry** is _vertices_. Data stored in a **Vertex Attribute Matrix** is ordered according to **Vertex** _Ids_. Therefore, the nth tuple in the supplied **Vertex** list corresponds to the data stored in the nth column of the **Vertex Attribute Matrix**. By convetion, **Vertex** Ids are _zero indexed_. -##### Mesh-Like Geometries ##### +##### Mesh-Like Geometries The following **Geometries** are considered _mesh-like_, and all share similar features concerning their storage and interpretation. A mesh-like **Geometry** is an unstructured **Geometry** that additionally requires explicit definition of the connectivity of its **Elements** and its **Vertices**. The **Element** type defines the kind of **Geometry** and the number of **Vertices** needed to define that **Element**: @@ -80,29 +80,29 @@ The shared list schema for mesh storage has the benefit of being space efficient Note that although the default interpretation of lists that define mesh-like **Geometries** is shared, no undefined behavior should be observed if the information is not stored shared (i.e., if the same **Vertex** is stored more than once with a different Id). Additionally, not all **Vertices** are required to be associated with an **Element**. The primary requirement is that the largest **Vertex** Ids listed in the **Element** list must not be larger than the total number of **Vertices**. -##### Edge ##### +##### Edge An **Edge Geometry** is the simplest _mesh-like_ **Geometry**, consisting of a collection of edges connecting two vertices. Creating an **Edge Geometry** requires supplying a shared **Vertex** list and an **Edge** list. -##### Triangle ##### +##### Triangle A **Triangle Geometry** is a _mesh-like_ **Geometry**, consisting of a collection of triangles connecting three vertices; it is a type of _surface mesh_. Creating a **Triangle Geometry** requires supplying a shared **Vertex** list and a **Triangle** list. -##### Quadrilateral ##### +##### Quadrilateral A **Quadrilateral Geometry** is a _mesh-like_ **Geometry**, consisting of a collection of quadrilaterals connecting four vertices; it is a type of _surface mesh_. Creating a **Quadrilateral Geometry** requires supplying a shared **Vertex** list and a **Quadrilateral** list. -##### Tetrahedral ##### +##### Tetrahedral A **Tetrahedral Geometry** is a _mesh-like_ **Geometry**, consisting of a collection of tetrahedra connecting four vertices; it is a type of _volume mesh_. Creating a **Tetrahedral Geometry** requires supplying a shared **Vertex** list and a **Tetrahedral** list. The winding that define tetrahedra require one additional convention to complement the right hand rule. By convention, the first three vertices define the tetrahedra _base_; the winding of these vertices by the right hand rule defines a normal that points _towards the fourth vertex_. This convention is useful since applying it consistently allows for the volume of the tetrahedra to be _signed_, which is important for determining if a tetrahedron is "inverted". -##### Hexahedral ##### +##### Hexahedral A **Hexahedral Geometry** is a _mesh-like_ **Geometry**, consisting of a collection of hexahedra connecting eight vertices; it is a type of _volume mesh_. Creating a **Hexahedral Geometry** requires supplying a shared **Vertex** list and a **Hexahedral** list. -### Defining Geometries with Attribute Arrays ### +### Defining Geometries with Attribute Arrays - For **Geometries** that require the selection of **Attribute Arrays** (all **Geometries** except **Image**), the arrays will be *copied* to create the new **Geometry**. Therefore, any operations on the original array will not affect the topology of the **Geometry**, and any geometric operations will not affect the original array. This behavior can be adjusted in the filter by using the *Array Handling* boolean. ### + For **Geometries** that require the selection of **Attribute Arrays** (all **Geometries** except **Image**), the arrays will be *copied* to create the new **Geometry**. Therefore, any operations on the original array will not affect the topology of the **Geometry**, and any geometric operations will not affect the original array. This behavior can be adjusted in the filter by using the *Array Handling* boolean. This **Filter** will validate that the arrays selected to define a **Geometry** "make sense", given the above information for how **Geometries** are stored in **DREAM.3D** (for example, no dimension for an **Image** may be less than or equal to zero, no bounds arrays for a **Rectilinear Grid** may have less than two values, and no **Vertex** Ids stored in a shared **Element** list may be larger than the total number of **Vertices** in the shared **Vertex** list). The checks that require accessing the actual array values (as opposed to just descriptive information) will be performed at run time. By default, these checks will only produce warnings, allowing the **Pipeline** to continue; the user may opt to change these warnings to errors by selecting the *Treat Geometry Warnings as Errors* option. @@ -132,7 +132,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 ## +## Parameters | Geometry Type | Value | | --|--| | ImageGeometry | 0 | @@ -145,7 +145,7 @@ In this above example, the vertex information begins on line 4; thus, line 4 def | 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. | @@ -153,24 +153,24 @@ In this above example, the vertex information begins on line 4; thus, line 4 def | 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 ### +## Required Geometry# None -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 ## +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | -## Example Pipelines ## +## Example Pipelines + CreateVertexGeometry + CreateTriangleGeometry @@ -178,7 +178,7 @@ None + CreateQuadGeometry + CreateRectilinearGrid -## License & Copyright ## +## License & Copyright Please see the description file distributed with this plugin. diff --git a/src/Plugins/ComplexCore/docs/CreateGeometryFilter.rst b/src/Plugins/ComplexCore/docs/CreateGeometryFilter.rst deleted file mode 100644 index ae309601bf..0000000000 --- a/src/Plugins/ComplexCore/docs/CreateGeometryFilter.rst +++ /dev/null @@ -1,373 +0,0 @@ -=============== -Create Geometry -=============== - - -Group (Subgroup) -================ - -DREAM3D Review (Geometry) - -Description -=========== - -This **Filter** creates a **Geometry** object and the necessary **Element Attribute Matrices** on which to store -**Attribute Arrays** and **Element Attribute Arrays** which define the geometry. The type of **Attribute Matrices** and -**Attribute Arrays** created depends on the kind of **Geometry** being created: - -================ ================== ================ -Type Attribute Matrices Attribute Arrays -================ ================== ================ -Image Cell -Rectilinear Grid Cell x, y, & z Bounds -Vertex Vertex Vertices -Edge Vertex + Edge Vertices + Edges -Triangle Vertex + Face Vertices + Faces -Quadrilateral Vertex + Face Vertices + Faces -Tetrahedral Vertex + Cell Vertices + Cells -Hexahedral Vertex + Cell Vertices + Cells -================ ================== ================ - -Understanding Geometries ------------------------- - -This **Filter** requires the user to enter information that defines the topological information for the chosen -**Geometry**. Choosing valid information for a given **Geometry** necessitates an understanding of how **DREAM.3D** -stores and interprets this information. A general overview of the data model used in **DREAM.3D** may be found here. -More specific information for **Geometry** objects is provided below. - -Grid Geometries -~~~~~~~~~~~~~~~ - -Image -^^^^^ - -An **Image Geometry** is a *grid-like* **Geometry**, and is the simplest and most widely used of the basic **Geometry** -types. An **Image Geometry** is a *regular, rectilinear grid*; if the *dimenionality* of the image is *d*, then only -\_3\ *d\_ numbers are needed to completely define the* **Geometry**\ *: three d-vectors for the dimensions, origin, and -resolution. Dimensions define the extents of the grid, the resolution defines the spacing between grid planes for each -orthogonal direction (constant along a given direction), and the origin defines the physical location of the* bottom -left\* grid point in *d*-dimensional space. The dimensions are stored as *unsigned 64-bit integers*, while the origin -and resolution are stored as *32-bit floats*. - -All **Image Geometries** in **DREAM.3D** are defined using 3-vectors (3D images). A 2D image is assumed when one of the -dimension values is exactly 1; the 2D image is then considered a plane. Most **DREAM.3D** **Filters** will properly take -account for the **Image** dimension if it matters (for example, the Find Feature Shapes **Filter** accounts for whether -the **Image** is 2D or 3D when computing values such as *aspect ratios* or *axis Euler angles*). No dimension may be -negative or equal to 0. The resolution and origin have no value restrictions. This **Filter** requires the user to enter -the nine values for the dimenions, origin, and resolution. - -Since all **Image Geometries** are implicitly 3D (even when plane-like), the fundamental building-block of an image is a -*voxel*, which is a 3D object; therefore, the basic **Element** type for an **Image Geometry** is **Cell**. **Attribute -Arrays** associated with **Image Cells** are assumed to raster *x-y-z*, fastest to slowest. - -Rectilinear Grid -^^^^^^^^^^^^^^^^ - -A **Rectilinear Grid Geometry** is a *grid-like* **Geometry**. Similar to an **Image Geometry**, a **Rectilinear Grid -Geometry** has grid extents (dimensions), but is allowed to have variable *resolution* along each orthogonal direction. -The **Geometry** then requires a total of (xdim + 1) + (ydim + 1) + (zdim + 1) numbers to define the topology. The -values are stored in three separate arrays termed the *x bounds*, *y bounds*, and *z bounds*. These bounds arrays store -the spatial location of all the planes along a given orthogonal direction. The spacing for a given plane (equivalent to -the resolution for an **Image Geometry**) is then the difference between two of these contiguous array values. An origin -does not need to be defined for a **Rectilinear Grid Geometry**, since the grid’s location in space is explicitly -encoded in its bounds arrays. This **Filter** requires the user to select **Attribute Arrays** that define the three -bounds arrays. These arrays must be *single component, 32-bit float* arrays. Additionally, the values for each of the -bounds arrays must be *strictly increasing*, which guarantees that computing the spacing for a given plane yields a -postive value. - -A **Rectilinear Grid Geometry** may be defined as 2D; the associated bounds array for the plane dimension is then -exactly two. No bounds arrays may have less than two values. Since all **Rectilinear Grid Geometries** are implicitly 3D -(even when plane-like), the fundamental building-block of an image is a *voxel*, which is a 3D object; therefore, the -basic **Element** type for an **Image Geometry** is **Cell**. **Attribute Arrays** associated with **Rectilinear Grid -Cells** are assumed to raster *x-y-z*, fastest to slowest. - -Unstructured and Mesh-Like Geometries -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Vertex -^^^^^^ - -A **Vertex Geometry** is an *unstructured* **Geometry**. An unstructured **Geometry** requires explicit definition of -point coordinates. Sometimes referred to as a *point cloud*, a **Vertex Geometry** is simply a collection of points. -Defining this topology requires a total number of values equal to *d* times the total number of points, where *d* is the -dimensionality of the point cloud; within **DREAM.3D**, *d* is always taken to be three. The point coordinates are -stored as *32-bit floats*; no other range restrictions are enforced. This **Filter** requires the user to select an -**Attribute Array** that defines these point coordinates. The array must have *three components* and consist of *32-bit -floats*. The number of *tuples* in the array defines the number of vertices in the resulting **Vertex Geometry**. - -The fundamental **Element** type of a **Vertex Geometry** is *vertices*. Data stored in a **Vertex Attribute Matrix** is -ordered according to **Vertex** *Ids*. Therefore, the nth tuple in the supplied **Vertex** list corresponds to the data -stored in the nth column of the **Vertex Attribute Matrix**. By convetion, **Vertex** Ids are *zero indexed*. - -Mesh-Like Geometries -^^^^^^^^^^^^^^^^^^^^ - -The following **Geometries** are considered *mesh-like*, and all share similar features concerning their storage and -interpretation. A mesh-like **Geometry** is an unstructured **Geometry** that additionally requires explicit definition -of the connectivity of its **Elements** and its **Vertices**. The **Element** type defines the kind of **Geometry** and -the number of **Vertices** needed to define that **Element**: - -============= ============= ============================== -Name Element Type Number of Vertices Per Element -============= ============= ============================== -Edge line 2 -Triangle triangle 3 -Quadrilateral quadrilateral 4 -Tetrahedral tetrahedron 4 -Hexahedral hexahedron 8 -============= ============= ============================== - -The storage scheme adopted by **DREAM.3D** requires at least two arrays to define mesh-like **Geometries**: a list of -**Vertices** (i.e., the vertex coordinates) and the **Element** connectivities (i.e., which vertices belong to a given -**Element**). To maintain simplicity, flexibility, and small memory overhead, **DREAM.3D** uses the concept of *shared -vertex lists*. In this paradigm, the vertex coordinates are stored only once per *unique* vertex. Consider a -**Quadrilateral Geometry** that consists of just two squares that share one side. In this example, there are exactly -*six* unique vertices. The **Attribute Array** that defines the coordinates of these **Vertices** would then have six -*tuples*, with three values at each tuple (the x, y, and z positions of that **Vertex**). Writing each tuple on one -line, the array could look like this: - -:: - - 0.0 0.0 0.0 // Vertex Id 0 - 1.0 0.0 0.0 // Vertex Id 1 - 0.0 1.0 0.0 // Vertex Id 2 - 1.0 1.0 0.0 // Vertex Id 3 - 2.0 0.0 0.0 // Vertex Id 4 - 2.0 1.0 0.0 // Vertex Id 5 - -**Element** connectivities are stored in **Attribute Arrays** that have a number of tuples equal to the total number of -**Elements**, with a number of components at each tuple equal to the number of vertices per element. In this example, a -quadrilateral list would have two tuples, with four values stored at each tuple (the four vertex Ids that define that -quadrilateral). When defining **Elements**, the order in which the **Vertex** Ids are listed, called the *winding*, is -important, since this ordering defines the direction of the normal. By convention, the *right hand rule* used. Thus, -given the above vertex positions, the following list of **Vertex** Ids defines two quadrilaterals whose normals point -along the positive z direction: - -:: - - 0 1 3 2 // Quad Id 0 - 1 4 5 3 // Quad Id 1 - -Creating any mesh-like **Geometry** requires the user to supply two arrays: one that defines the vertex coordinates (the -*shared vertex list*), which is a three component array of floats; and one that defines the **Element** connectivities, -which is a n-component array (where n is the number of vertices per element) of *signed 64-bit integers*. Note that any -**Element** Id values (**Vertex** or otherwise) are *zero indexed*. - -The shared list schema for mesh storage has the benefit of being space efficient, time efficient when iterating in -sequence over vertices or elements, and capable of storing *nonmanifold* meshes. An example of a nonmanifold mesh is a -**Triangle Geometry** that has more than two triangles sharing the same edge. This specific example of nonmanifold -meshes occurs frequently in **DREAM.3D** surface meshes of polycrystals, where many nonmanifold entities may exist -(i.e., triple lines and quad points). A significant downside of shared lists is that computing adjacency information, -such as the neighbors of a given element or the elements that share a vertex, requires iterating over the entire -**Geometry**; other mesh data structures avoid this limitation. Additionally, since the lists are stored as **Attribute -Arrays**, which hold information contiguously in memory, adding or removing vertices or elements is tedious and -potentially slow. - -Note that although the default interpretation of lists that define mesh-like **Geometries** is shared, no undefined -behavior should be observed if the information is not stored shared (i.e., if the same **Vertex** is stored more than -once with a different Id). Additionally, not all **Vertices** are required to be associated with an **Element**. The -primary requirement is that the largest **Vertex** Ids listed in the **Element** list must not be larger than the total -number of **Vertices**. - -Edge -^^^^ - -An **Edge Geometry** is the simplest *mesh-like* **Geometry**, consisting of a collection of edges connecting two -vertices. Creating an **Edge Geometry** requires supplying a shared **Vertex** list and an **Edge** list. - -Triangle -^^^^^^^^ - -A **Triangle Geometry** is a *mesh-like* **Geometry**, consisting of a collection of triangles connecting three -vertices; it is a type of *surface mesh*. Creating a **Triangle Geometry** requires supplying a shared **Vertex** list -and a **Triangle** list. - -Quadrilateral -^^^^^^^^^^^^^ - -A **Quadrilateral Geometry** is a *mesh-like* **Geometry**, consisting of a collection of quadrilaterals connecting four -vertices; it is a type of *surface mesh*. Creating a **Quadrilateral Geometry** requires supplying a shared **Vertex** -list and a **Quadrilateral** list. - -Tetrahedral -^^^^^^^^^^^ - -A **Tetrahedral Geometry** is a *mesh-like* **Geometry**, consisting of a collection of tetrahedra connecting four -vertices; it is a type of *volume mesh*. Creating a **Tetrahedral Geometry** requires supplying a shared **Vertex** list -and a **Tetrahedral** list. The winding that define tetrahedra require one additional convention to complement the right -hand rule. By convention, the first three vertices define the tetrahedra *base*; the winding of these vertices by the -right hand rule defines a normal that points *towards the fourth vertex*. This convention is useful since applying it -consistently allows for the volume of the tetrahedra to be *signed*, which is important for determining if a tetrahedron -is “inverted”. - -Hexahedral -^^^^^^^^^^ - -A **Hexahedral Geometry** is a *mesh-like* **Geometry**, consisting of a collection of hexahedra connecting eight -vertices; it is a type of *volume mesh*. Creating a **Hexahedral Geometry** requires supplying a shared **Vertex** list -and a **Hexahedral** list. - -Defining Geometries with Attribute Arrays ------------------------------------------ - -For **Geometries** that require the selection of **Attribute Arrays** (all **Geometries** except **Image**), the arrays -will be *copied* to create the new **Geometry**. Therefore, any operations on the original array will not affect the -topology of the **Geometry**, and any geometric operations will not affect the original array. This behavior can be -adjusted in the filter by using the *Array Handling* boolean. ### - -This **Filter** will validate that the arrays selected to define a **Geometry** “make sense”, given the above -information for how **Geometries** are stored in **DREAM.3D** (for example, no dimension for an **Image** may be less -than or equal to zero, no bounds arrays for a **Rectilinear Grid** may have less than two values, and no **Vertex** Ids -stored in a shared **Element** list may be larger than the total number of **Vertices** in the shared **Vertex** list). -The checks that require accessing the actual array values (as opposed to just descriptive information) will be performed -at run time. By default, these checks will only produce warnings, allowing the **Pipeline** to continue; the user may -opt to change these warnings to errors by selecting the *Treat Geometry Warnings as Errors* option. - -Generally, arrays used by this **Filter** to create **Geometries** must be supplied by the user. One method to import -geometric information into **DREAM.3D** is to read the information in from a text file using the Import ASCII Data -**Filter**. For example, imagine having an external simulation code that creates a tetrahedral volume mesh with two -associated field values, one stored on the mesh vertices and one stored on the mesh tetrahedra. It is possible to import -this mesh and corresponding information into **DREAM.3D** for further analysis. The user must supply at least two files: -one that contains the vertex information and one that contains the tetrahedra information. The vertex file would -contain, on each line, the three coordinates of the vertex and the value of the field array on that vertex. It may, for -example, look like this: - -:: - - # Some header information - # Some more header information - x_pos y_pos z_pos value - 1.235 2.323 1.562 465.2 - -12.3 3.456 2.323 567.4 - 3.450 9.782 6.567 120.2 - ..... - -In this above example, the vertex information begins on line 4; thus, line 4 defines **Vertex** Id 0, line 5 defines -**Vertex** Id 1, etc. Similarly, a file containing information about tetrahedra is needed: - -:: - - # Some header information - # Some more header information - vert_0 vert_1 vert_2 vert_3 value - 1 2 0 3 12.42 - 2 7 5 4 14.71 - 6 9 7 8 16.78 - ..... - -Again, the real information begins on line 4, which defines the connectivity for **Tetrahedra** Id 0. These Id values -refer to the **Vertex** Ids from the first file (for example, a **Vertex** Id of 0 corresponds to the information on -line 4 of the first file). Remember to consider the *right hand rule* when dealing with mesh-like **Geometries**, as -this will affect the **Vertex** ordering! - -Assuming it is possible to get the mesh into files similar to the above ones, it is straightforward to import the -information into **DREAM.3D**. First, create an emtpy Data Container. Then, run the Import ASCII Data **Filter** for the -vertex file. In the above example, line 3 could be used as headers to define the array names (remember that **Vertex** -positions must be of type *float*!). Allow the reader wizard to create an **Attribute Matrix** in which to store the -arrays. Repeat the process with another Import ASCII Data **Filter** to read the tetrahedra information (remember in -this case that Id values must be of type *int64_t*!). At this point, there will be two **Attribute Matrices** in the -**Data Container**, one with 4 arrays (the **Vertex** information) and one with 5 arrays (the **Tetrahedra** -information). The Create Geometry **Filter** wants the **Vertex** list as a three component array and the **Tetrahedra** -list as a four component array. To combine the individual arrays into ones of the proper component dimension, run the -Combine Attribute Arrays **Filter**. At this point, the Create Geometry **Filter** may be used to create a **Tetrahedral -Geometry** using the combined arrays. After this **Filter**, the Move Data **Filter** may be used to move the arrays -that represent the values stored on the **Vertices** and **Tetrahedra** into the created **Vertex** and **Cell Attribute -Matrices**. - -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 | bool | Whether run time warnings for **Geometries** should be | -| as Errors | | 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 | 1/2/3/4 | Various **Attribute Arrays** used to define the | -| | | /int64_t | | **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 | None | Verte | N/A | Various **Attribute Matrices** used to store | -| Matrices | | x/Edge/F | | information for the new **Geometry**; see the | -| | | ace/Cell | | above documentation for a detailed discussion | -| | | | | of what kinds of **Attribute Matrices** are | -| | | | | created for each \**Geometry | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Example Pipelines -================= - -- CreateVertexGeometry -- CreateTriangleGeometry -- CreateEdgeGeometry -- CreateQuadGeometry -- CreateRectilinearGrid - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/CreateImageGeometry.md b/src/Plugins/ComplexCore/docs/CreateImageGeometry.md index 64f1a30c37..464da74512 100644 --- a/src/Plugins/ComplexCore/docs/CreateImageGeometry.md +++ b/src/Plugins/ComplexCore/docs/CreateImageGeometry.md @@ -1,22 +1,22 @@ # Create Geometry (Image) -## Group (Subgroup) ## +## Group (Subgroup) Core (Generation) -## Description ## +## Description This **Filter** creates an **Image Geometry** specifically for the representation of a 3D rectilinear grid of voxels (3D) or pixels (2D). Each axis can have its starting point (origin), resolution, and length defined for the **Geometry**. The **Data Container** in which to place the **Image Geometry** must be specified. -### Example Usage ### +### Example Usage 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 ## +## Parameters | Name | Type | Description | |------------------|------|-------------| @@ -24,26 +24,26 @@ filter first to create a description of the **Geometry**. | 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 ## +## Required Geometry Not Applicable -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 ## +## Created Objects Not Applicable -## Example Pipelines ## +## Example Pipelines -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/ComplexCore/docs/CreateImageGeometry.rst b/src/Plugins/ComplexCore/docs/CreateImageGeometry.rst deleted file mode 100644 index eff5312071..0000000000 --- a/src/Plugins/ComplexCore/docs/CreateImageGeometry.rst +++ /dev/null @@ -1,66 +0,0 @@ -======================= -Create Geometry (Image) -======================= - - -Group (Subgroup) -================ - -Core (Generation) - -Description -=========== - -This **Filter** creates an **Image Geometry** specifically for the representation of a 3D rectilinear grid of voxels -(3D) or pixels (2D). Each axis can have its starting point (origin), resolution, and length defined for the -**Geometry**. The **Data Container** in which to place the **Image Geometry** must be specified. - -Example Usage -------------- - -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 - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/CropImageGeometry.md b/src/Plugins/ComplexCore/docs/CropImageGeometry.md index 3001f307dc..9eb78feec2 100644 --- a/src/Plugins/ComplexCore/docs/CropImageGeometry.md +++ b/src/Plugins/ComplexCore/docs/CropImageGeometry.md @@ -1,6 +1,6 @@ # Crop Geometry (Image) -## Description ## +## Description This **Filter** allows the user to crop an **Image Geometry** of interest. The input parameters are in units of **Cells**. For example, if a **Image Geometry** was 100x100x100 **Cells** and each **Cell** was 0.25 x 0.25 x 0.25 units of resolution, then if the user wanted to crop the last 5 microns in the X direction, then the user would enter the following: @@ -19,10 +19,10 @@ 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 ## +## 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 | @@ -33,13 +33,13 @@ Normally this **Filter** will leave the origin of the volume set at (0, 0, 0), w | 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 ## +## Required Geometry Image -## Example Pipelines ## +## Example Pipelines -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/ComplexCore/docs/CropImageGeometry.rst b/src/Plugins/ComplexCore/docs/CropImageGeometry.rst deleted file mode 100644 index 9de728ad09..0000000000 --- a/src/Plugins/ComplexCore/docs/CropImageGeometry.rst +++ /dev/null @@ -1,67 +0,0 @@ -===================== -Crop Geometry (Image) -===================== - - -Description -=========== - -This **Filter** allows the user to crop an **Image Geometry** of interest. The input parameters are in units of -**Cells**. For example, if a **Image Geometry** was 100x100x100 **Cells** and each **Cell** was 0.25 x 0.25 x 0.25 units -of resolution, then if the user wanted to crop the last 5 microns in the X direction, then the user would enter the -following: - -Xmin = 80, Xmax = 99, Ymin = 0, Ymax = 99, Zmin = 0, Zmax = 99 - -*Note:* The input parameters are *inclusive* and begin at *0*, so in the above example *0-99* covers the entire range of -**Cells** in a given dimension. - -It is possible with this **Filter** to fully remove **Features** from the volume, possibly resulting in consistency -errors if more **Filters** process the data in the pipeline. If the user selects to *Renumber Features* then the -*Feature Ids* array will be adjusted so that all **Features** are continuously numbered starting from 1. The user should -decide if they would like their **Features** renumbered or left alone (in the case where the cropped output is being -compared to some larger volume). - -The user has the option to save the cropped volume as a new **Data Container** or overwrite the current volume. - -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 - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/CropVertexGeometry.md b/src/Plugins/ComplexCore/docs/CropVertexGeometry.md index c5d24214e7..0609e09592 100644 --- a/src/Plugins/ComplexCore/docs/CropVertexGeometry.md +++ b/src/Plugins/ComplexCore/docs/CropVertexGeometry.md @@ -1,45 +1,45 @@ # Crop Geometry (Vertex) -## Group (Subgroup) ## +## Group (Subgroup) DREAM3D Review (Cropping/Cutting) -## Description ## +## Description This **Filter** crops a **Vertex Geometry** by the given bounding box. Unlike the cropping of an Image, it is unknown until run time how the **Geometry** will be changed by the cropping operation. Therefore, this **Filter** requires that a new **Data Container** be created to contain the cropped **Vertex Geometry**. This new **Data Container** will contain copies of any **Feature** or **Ensemble** **Attribute Matrices** from the original **Data Container**. Additionally, all **Vertex** data will be copied, with tuples *removed* for any **Vertices** outside the bounding box. The user must supply a name for the cropped **Data Container**, but all other copied objects (**Attribute Matrices** and **Data Arrays**) will retain the same names as the original source. _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 ## +## 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 ### +## Required Geometry# Vertex -## Required Objects ## +## Required Objects None -## Created Objects ## +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | -## Example Pipelines ## +## Example Pipelines -## License & Copyright ## +## License & Copyright Please see the description file distributed with this plugin. diff --git a/src/Plugins/ComplexCore/docs/CropVertexGeometry.rst b/src/Plugins/ComplexCore/docs/CropVertexGeometry.rst deleted file mode 100644 index 9c8cdfd11b..0000000000 --- a/src/Plugins/ComplexCore/docs/CropVertexGeometry.rst +++ /dev/null @@ -1,66 +0,0 @@ -====================== -Crop Geometry (Vertex) -====================== - - -Group (Subgroup) -================ - -DREAM3D Review (Cropping/Cutting) - -Description -=========== - -This **Filter** crops a **Vertex Geometry** by the given bounding box. Unlike the cropping of an Image, it is unknown -until run time how the **Geometry** will be changed by the cropping operation. Therefore, this **Filter** requires that -a new **Data Container** be created to contain the cropped **Vertex Geometry**. This new **Data Container** will contain -copies of any **Feature** or **Ensemble** **Attribute Matrices** from the original **Data Container**. Additionally, all -**Vertex** data will be copied, with tuples *removed* for any **Vertices** outside the bounding box. The user must -supply a name for the cropped **Data Container**, but all other copied objects (**Attribute Matrices** and **Data -Arrays**) will retain the same names as the original source. - -*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 | CroppedD | N/A | N/A | Data Container holding the cropped **Vertex | -| | ataContainer | | | Geometry** and any copied **Attribute | -| | | | | Matrices** and \**Attribute Arrays | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. diff --git a/src/Plugins/ComplexCore/docs/DeleteData.md b/src/Plugins/ComplexCore/docs/DeleteData.md index 2323b69ac2..3863a35d8e 100644 --- a/src/Plugins/ComplexCore/docs/DeleteData.md +++ b/src/Plugins/ComplexCore/docs/DeleteData.md @@ -1,37 +1,37 @@ # Delete Data -## Group (Subgroup) ## +## Group (Subgroup) Core (Memory/Management) -## Description ## +## Description 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 ## +## Parameters None -## Required Geometry ## +## Required Geometry Not Applicable -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| Kind | Default Name | Type | Comp Dims | Description | +|---------------------------|--------------|----------|--------|---------------------------------------------| | Any | None | Any | Any | Objects to delete | -## Created Objects ## +## Created Objects None -## Example Pipelines ## +## Example Pipelines -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/ComplexCore/docs/DeleteData.rst b/src/Plugins/ComplexCore/docs/DeleteData.rst deleted file mode 100644 index 9ecf5b99c2..0000000000 --- a/src/Plugins/ComplexCore/docs/DeleteData.rst +++ /dev/null @@ -1,56 +0,0 @@ -=========== -Delete Data -=========== - - -Group (Subgroup) -================ - -Core (Memory/Management) - -Description -=========== - -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 - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/ErodeDilateBadDataFilter.md b/src/Plugins/ComplexCore/docs/ErodeDilateBadDataFilter.md index 861ab82a07..109443e165 100644 --- a/src/Plugins/ComplexCore/docs/ErodeDilateBadDataFilter.md +++ b/src/Plugins/ComplexCore/docs/ErodeDilateBadDataFilter.md @@ -63,8 +63,8 @@ Image ## Required Objects -| Kind | Default Name | Type | Comp Dims | Description | -|--------------------------|----------------|----------|-------------|------------------------------------------------------------------| +| 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 | diff --git a/src/Plugins/ComplexCore/docs/ErodeDilateBadDataFilter.rst b/src/Plugins/ComplexCore/docs/ErodeDilateBadDataFilter.rst deleted file mode 100644 index 5d8e01deb4..0000000000 --- a/src/Plugins/ComplexCore/docs/ErodeDilateBadDataFilter.rst +++ /dev/null @@ -1,123 +0,0 @@ -===================== -Erode/Dilate Bad Data -===================== - - -Group (Subgroup) -================ - -Processing (Cleanup) - -Description -=========== - -Bad data refers to a **Cell** that has a *Feature Id* of *0*, which means the **Cell** has failed some sort of test and -been marked as a *bad* **Cell**. - -Dilation --------- - -If the **bad** data is *dilated*, the Filter grows the *bad* data by one **Cell** in an iterative sequence for a user -defined number of iterations. During the *dilate* process the *Feature Id* of any Cell neighboring a *bad* **Cell** will -be changed to *0*. - -=============== ============== -Before Dilation After Dilation -=============== ============== -|image1| |image2| -=============== ============== - -Erosion -------- - -If the *bad* data is *eroded*, the Filter shrinks the bad data by one **Cell** in an iterative sequence for a user -defined number of iterations. During the *erode* process the *Feature Id* of the *bad* **Cell** is changed from *0* to -the *Feature Id* of the majority of its neighbors. If there is a tie between two *Feature Ids*, then one of the *Feature -Ids*, chosen randomly, will be assigned to the *bad* **Cell**. - -============== ============= -Before Erosion After Erosion -============== ============= -|image3| |image4| -============== ============= - -\` - -Goals a user might be trying to accomplish with this Filter include: - -- Remove small or thin regions of bad data by running a single (or two) iteration *erode* operation. -- Increase the size of a *bad* data region by running an *dilate* operation. This might be useful if the experimental - technique tends to underestimates the size of certain objects. For example, when running EBSD, the pores (which show - up as *bad* data) are generally smaller in the scans than in the specimen, because the beam, when it is just inside - the pore, still can pick up signal from the material just beneath the pore. - -Running the *erode-dilate* operations in pairs can often change the size of some objects without affecting others. For -example, if there were a number of big pores and a number of single *bad* **Cells**, running a single *erode* operation -would remove the single **Cells** and reduce the pores by one **Cell**. If this is followed immediately by a *dilate* -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 | Type | Comp | Description | -| | Name | | Dims | | -+======================+=============+========+==========+===========================================================+ -| Image Geometry*\* | Image | Da | N/A | The path to the Image Geometry where the feature Ids are | -| | Geometry | taPath | | stored. | -+----------------------+-------------+--------+----------+-----------------------------------------------------------+ -| Cell Attribute Array | FeatureIds | int32 | (1) | Specifies to which **Feature** each **Cell** belongs | -+----------------------+-------------+--------+----------+-----------------------------------------------------------+ - -Created Objects -=============== - -None - -Example Pipelines -================= - -- - - (8) SmallIN100 Full Reconstruction - -- - - (7) SmallIN100 Final Processing - -- 04_Steiner Compact - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. - -.. |image1| image:: Images/ErodeDilateBadData_1.png -.. |image2| image:: Images/ErodeDilateBadData_2.png -.. |image3| image:: Images/ErodeDilateBadData_1.png -.. |image4| image:: Images/ErodeDilateBadData_3.png diff --git a/src/Plugins/ComplexCore/docs/ErodeDilateCoordinationNumberFilter.md b/src/Plugins/ComplexCore/docs/ErodeDilateCoordinationNumberFilter.md index 424cae6bef..55d4078bba 100644 --- a/src/Plugins/ComplexCore/docs/ErodeDilateCoordinationNumberFilter.md +++ b/src/Plugins/ComplexCore/docs/ErodeDilateCoordinationNumberFilter.md @@ -37,8 +37,8 @@ Image ## Required Objects -| Kind | Default Name | Type | Comp Dims | Description | -|--------------------------|----------------|----------|-------------|------------------------------------------------------------------| +| 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 | diff --git a/src/Plugins/ComplexCore/docs/ErodeDilateCoordinationNumberFilter.rst b/src/Plugins/ComplexCore/docs/ErodeDilateCoordinationNumberFilter.rst deleted file mode 100644 index fa9c0bde57..0000000000 --- a/src/Plugins/ComplexCore/docs/ErodeDilateCoordinationNumberFilter.rst +++ /dev/null @@ -1,87 +0,0 @@ -===================================== -Smooth Bad Data (Coordination Number) -===================================== - - -Group (Subgroup) -================ - -Processing (Cleanup) - -Description -=========== - -This **Filter** will smooth the interface between *good* and *bad* data. The user can specify a *coordination number*, -which is the number of neighboring **Cells** of opposite type (i.e., *good* or *bad*) compared to a given **Cell** that -is acceptable. For example, a single *bad* **Cell** surrounded by *good* **Cells** would have a *coordination number* of -*6*. The number entered by the user is actually the maximum tolerated *coordination number*. If the user entered a value -of *4*, then all *good* **Cells** with 5 or more *bad* neighbors and *bad* **Cells** with 5 or more *good* neighbors -would be removed. After **Cells** with unacceptable *coordination number* are removed, then the neighboring **Cells** -are *coarsened* to fill the removed **Cells**. - -By default, the **Filter** will only perform a single iteration and will not concern itself with the possibility that -after one iteration, **Cells** that were acceptable may become unacceptable by the original *coordination number* -criteria due to the small changes to the structure during the *coarsening*. The user can opt to enable the *Loop Until -Gone* parameter, which will continue to run until no **Cells** fail the original criteria. - -============= ============ -Before Filter After Filter -============= ============ -|image1| |image2| -============= ============ - -Parameters -========== - -+--------------+-----+------------------------------------------------------------------------------------------------+ -| Name | T | Description | -| | ype | | -+==============+=====+================================================================================================+ -| Coordination | i | Number of neighboring **Cells** that can be of opposite classification before a **Cell** will | -| Number | nt3 | be removed | -| | 2_t | | -+--------------+-----+------------------------------------------------------------------------------------------------+ -| Loop Until | b | Whether to run a single iteration or iterate until no *bad* **Cells** have more than the above | -| Gone | ool | number of *good* neighbor \**Cells | -+--------------+-----+------------------------------------------------------------------------------------------------+ - -Required Geometry -================= - -Image - -Required Objects -================ - -+----------------------+-------------+--------+----------+-----------------------------------------------------------+ -| Kind | Default | Type | Comp | Description | -| | Name | | Dims | | -+======================+=============+========+==========+===========================================================+ -| Image Geometry*\* | Image | Da | N/A | The path to the Image Geometry where the feature Ids are | -| | Geometry | taPath | | stored. | -+----------------------+-------------+--------+----------+-----------------------------------------------------------+ -| Cell Attribute Array | FeatureIds | i | (1) | Specifies to which **Feature** each **Cell** belongs | -| | | nt32_t | | | -+----------------------+-------------+--------+----------+-----------------------------------------------------------+ - -Created Objects -=============== - -None - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. - -.. |image1| image:: Images/ErodeDilateCoordinationNumber_Before.png -.. |image2| image:: Images/ErodeDilateCoordinationNumber_After.png diff --git a/src/Plugins/ComplexCore/docs/ErodeDilateMaskFilter.rst b/src/Plugins/ComplexCore/docs/ErodeDilateMaskFilter.rst deleted file mode 100644 index cd55802c02..0000000000 --- a/src/Plugins/ComplexCore/docs/ErodeDilateMaskFilter.rst +++ /dev/null @@ -1,90 +0,0 @@ -================= -Erode/Dilate Mask -================= - - -Group (Subgroup) -================ - -Processing (Cleanup) - -Description -=========== - -If the mask is *dilated*, the **Filter** grows the *true* regions by one **Cell** in an iterative sequence for a user -defined number of iterations. During the *dilate* process, the classification of any **Cell** neighboring a *false* -Cell*\* will be changed to *true*. If the mask is *eroded*, the **Filter** shrinks the *true* regions by one **Cell** in -an iterative sequence for a user defined number of iterations. During the *erode* process, the classification of the -*false* **Cells** is changed to *true* if one of its neighbors is *true*. The **Filter** also offers the option(s) to -turn on/off the erosion or dilation in specific directions (X, Y or Z). - -This filter will ONLY change the *Mask* data array and not any of the other data arrays in the same attribute matrix. - -The example images below were generated **AFTER** the execution of the filter and essentially any black pixel is where -the **Mask** was false and any other color is where the **Mask** is true. (The colors are the typical IPF Colors using a -<001> reference direction) - -================= ============== -Before Dilatation After Dilation -================= ============== -|image1| |image2| -================= ============== - -============== ============= -Before Erosion After Erosion -============== ============= -|image3| |image4| -============== ============= - -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 | Ty | Component | Description | -| | Name | pe | Dimensionss | | -+=======================+============+====+====================+======================================================+ -| Cell Attribute Array | Mask | bo | (1) | Used to define whether the **Cells** are part of the | -| | | ol | | mask | -+-----------------------+------------+----+--------------------+------------------------------------------------------+ - -Created Objects -=============== - -None - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. - -.. |image1| image:: Images/ErodeDilateMask_Before.png -.. |image2| image:: Images/ErodeDilateMask_Dilate.png -.. |image3| image:: Images/ErodeDilateMask_Before.png -.. |image4| image:: Images/ErodeDilateMask_Erode.png diff --git a/src/Plugins/ComplexCore/docs/ExecuteProcessFilter.md b/src/Plugins/ComplexCore/docs/ExecuteProcessFilter.md index 3a059b9b69..1e809f9271 100644 --- a/src/Plugins/ComplexCore/docs/ExecuteProcessFilter.md +++ b/src/Plugins/ComplexCore/docs/ExecuteProcessFilter.md @@ -1,11 +1,11 @@ # Execute Process -## Group (Subgroup) ## +## Group (Subgroup) Core (Misc) -## Description ## +## Description This filter allows the user to execute any application, program, shell script or any other executable program on the computer system. Any output can be found in the user specified log file. @@ -23,7 +23,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 ## +## Parameters | Name | Type | Description | |------------------|------|-------------| @@ -33,25 +33,25 @@ For a command with spaces in the path | Output Log File | File Path | The log file where the output from the process will be stored. | -## Required Geometry ## +## Required Geometry Not Applicable -## Required Objects ## +## Required Objects None -## Created Objects ## +## Created Objects None -## Example Pipelines ## +## Example Pipelines ExecuteProcess -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/ComplexCore/docs/ExecuteProcessFilter.rst b/src/Plugins/ComplexCore/docs/ExecuteProcessFilter.rst deleted file mode 100644 index 1a6a398911..0000000000 --- a/src/Plugins/ComplexCore/docs/ExecuteProcessFilter.rst +++ /dev/null @@ -1,76 +0,0 @@ -=============== -Execute Process -=============== - - -Group (Subgroup) -================ - -Core (Misc) - -Description -=========== - -This filter allows the user to execute any application, program, shell script or any other executable program on the -computer system. Any output can be found in the user specified log file. - -The Command Line Arguments parameter should contain the absolute path to the program you wish to execute as well as any -arguments that program requires. The formatting of this should follow the same general rules that you would follow when -executing the command from a terminal. The following examples show how various commands should be formatted in different -scenarios; - -Simple directory listing (for Mac/Linux users) - - /bin/ls - -Simple command with arguments (for Windows users) - - C:/Applications/DREAM3D-6.6.332/nxrunner.exe C:/Applications/DREAM3D/DREAM3D-6.6.332/Data/MyPipeline.json - -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 - -Example Pipelines -================= - -ExecuteProcess - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/ExportDREAM3DFilter.md b/src/Plugins/ComplexCore/docs/ExportDREAM3DFilter.md index 040f2c2347..cd9302d96c 100644 --- a/src/Plugins/ComplexCore/docs/ExportDREAM3DFilter.md +++ b/src/Plugins/ComplexCore/docs/ExportDREAM3DFilter.md @@ -1,34 +1,34 @@ # ExportDREAM3DFilter -## Description ## +## Description This **Filter** dumps the data structure to an hdf5 file with the .dream3d extension. -## Parameters ## +## 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 ### +## Required Geometry# None -## Required Objects ## +## Required Objects None -## Created Objects ## +## Created Objects None -## Example Pipelines ## +## Example Pipelines ALL -## License & Copyright ## +## License & Copyright Please see the description file distributed with this plugin. diff --git a/src/Plugins/ComplexCore/docs/ExportDREAM3DFilter.rst b/src/Plugins/ComplexCore/docs/ExportDREAM3DFilter.rst deleted file mode 100644 index 73909da4fc..0000000000 --- a/src/Plugins/ComplexCore/docs/ExportDREAM3DFilter.rst +++ /dev/null @@ -1,50 +0,0 @@ -=================== -ExportDREAM3DFilter -=================== - - -Description -=========== - -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 - -Example Pipelines -================= - -ALL - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/ExtractComponentAsArrayFilter.md b/src/Plugins/ComplexCore/docs/ExtractComponentAsArrayFilter.md index 47c67d21c0..f0de2e3f9a 100644 --- a/src/Plugins/ComplexCore/docs/ExtractComponentAsArrayFilter.md +++ b/src/Plugins/ComplexCore/docs/ExtractComponentAsArrayFilter.md @@ -1,48 +1,48 @@ # Extract Component as Attribute Array -## Group (Subgroup) ## +## Group (Subgroup) Core (Memory/Management) -## Description ## +## Description This **Filter** will do one of the following to one component of a multicomponent **Attribute Array**: - Remove 1 component from multicomponent **Attribute Array** completely [This is done implicitly so long as **Move Extracted Components To New Array** is false] - 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 ## +## 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 ## +## Required Geometry Not Applicable -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| Kind | Default Name | Type | Comp Dims | Description | +|---------------------------|--------------|----------|--------|---------------------------------------------| | Any **Attribute Array | None | Any | >1 | Multicomponent **Attribute Array** to use as input | -## Created Objects ## +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| Kind | Default Name | Type | Comp Dims | Description | +|---------------------------|--------------|----------|--------|---------------------------------------------| | Any **Attribute Array | None | Any | (1) | Scalar **Attribute Array** name | -## Example Pipelines ## +## Example Pipelines -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/ComplexCore/docs/ExtractComponentAsArrayFilter.rst b/src/Plugins/ComplexCore/docs/ExtractComponentAsArrayFilter.rst deleted file mode 100644 index 1927d7fa8e..0000000000 --- a/src/Plugins/ComplexCore/docs/ExtractComponentAsArrayFilter.rst +++ /dev/null @@ -1,70 +0,0 @@ -==================================== -Extract Component as Attribute Array -==================================== - - -Group (Subgroup) -================ - -Core (Memory/Management) - -Description -=========== - -This **Filter** will do one of the following to one component of a multicomponent **Attribute Array**: - Remove 1 -component from multicomponent **Attribute Array** completely [This is done implicitly so long as **Move Extracted -Components To New Array** is false] - 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 | bool | The bool that determines if extracted components will | -| New Array | | be stored in new array | -+------------------------------+------------------------------+--------------------------------------------------------+ -| Remove Extracted Components | bool | The bool that determines if extracted components will | -| from Old Array | | 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 -====================== ============ ==== ========== =============================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/ExtractInternalSurfacesFromTriangleGeometry.md b/src/Plugins/ComplexCore/docs/ExtractInternalSurfacesFromTriangleGeometry.md index 53306d9060..0b59557ea1 100644 --- a/src/Plugins/ComplexCore/docs/ExtractInternalSurfacesFromTriangleGeometry.md +++ b/src/Plugins/ComplexCore/docs/ExtractInternalSurfacesFromTriangleGeometry.md @@ -1,10 +1,10 @@ # Extract Internal Surfaces from Triangle Geometry -## Group (Subgroup) ## +## Group (Subgroup) Geometry -## Description ## +## Description This **Filter** extracts any **Triangles** from the supplied **Triangle Geometry** that contain any *internal nodes*, then uses these extracted **Triangles** to create a new **Data Container** with the reduced **Triangle Geometry**. This operation is the same as removing all **Triangles** that only lie of the outer surface of the supplied **Triangle Geometry**. The user must supply a **Vertex Attribute Array** that defines the type for each node of the **Triangle Geometry**. Node types may take the following values: @@ -21,33 +21,33 @@ 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 ## +## Parameters None -## Required Geometry ### +## Required Geometry# Triangle -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| Kind | Default Name | Type | Comp Dims | Description | +|---------------------------|--------------|----------|--------|---------------------------------------------| | Vertex Data Array | NodeTypes | int8 | (1) | Specifies the type of node in the **Geometry | -## Created Objects ## +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | -## Example Pipelines ## +## Example Pipelines -## License & Copyright ## +## License & Copyright Please see the description file distributed with this plugin. diff --git a/src/Plugins/ComplexCore/docs/ExtractInternalSurfacesFromTriangleGeometry.rst b/src/Plugins/ComplexCore/docs/ExtractInternalSurfacesFromTriangleGeometry.rst deleted file mode 100644 index db5e9b2d80..0000000000 --- a/src/Plugins/ComplexCore/docs/ExtractInternalSurfacesFromTriangleGeometry.rst +++ /dev/null @@ -1,72 +0,0 @@ -================================================ -Extract Internal Surfaces from Triangle Geometry -================================================ - - -Group (Subgroup) -================ - -Geometry - -Description -=========== - -This **Filter** extracts any **Triangles** from the supplied **Triangle Geometry** that contain any *internal nodes*, -then uses these extracted **Triangles** to create a new **Data Container** with the reduced **Triangle Geometry**. This -operation is the same as removing all **Triangles** that only lie of the outer surface of the supplied **Triangle -Geometry**. The user must supply a **Vertex Attribute Array** that defines the type for each node of the **Triangle -Geometry**. Node types may take the following values: - -======== ====================================== -Id Value Node Type -======== ====================================== -2 Normal \**Vertex -3 Triple Line -4 Quadruple Point -12 Normal **Vertex** on the outer surface -13 Triple Line on the outer surface -14 Quadruple Point on the outer surface -======== ====================================== - -This **Filter** has the effect of removing any **Triangles** that only contain **Vertices** whose node Id values are 12, -13, or 14. In general, this *node type* array is created when the original surface mesh is created. - -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 -================ ============ ======== ========== ======================================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. diff --git a/src/Plugins/ComplexCore/docs/ExtractVertexGeometryFilter.md b/src/Plugins/ComplexCore/docs/ExtractVertexGeometryFilter.md index 89b9330c24..3264dd0dfb 100644 --- a/src/Plugins/ComplexCore/docs/ExtractVertexGeometryFilter.md +++ b/src/Plugins/ComplexCore/docs/ExtractVertexGeometryFilter.md @@ -1,19 +1,19 @@ # Extract Vertex Geometry -## Group (Subgroup) ## +## Group (Subgroup) Core Filters (Conversion) -## Description ## +## Description This filter will extract all the voxel centers of an Image Geometry or a RectilinearGrid geometry into a new VertexGeometry. The user is given the option to copy or move cell arrays over to the newly created VertexGeometry. -## Parameters ## +## 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 | @@ -23,15 +23,15 @@ newly created VertexGeometry. | 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 Required Geometry Type: **ImageGeom** or **RectGridGeom** -## Example Pipelines ## +## Example Pipelines PrebuiltPipelines/Examples/Extract Vertex Geometry.json -## License & Copyright ## +## License & Copyright Please see the description file distributed with this plugin. diff --git a/src/Plugins/ComplexCore/docs/ExtractVertexGeometryFilter.rst b/src/Plugins/ComplexCore/docs/ExtractVertexGeometryFilter.rst deleted file mode 100644 index ec5526b1a8..0000000000 --- a/src/Plugins/ComplexCore/docs/ExtractVertexGeometryFilter.rst +++ /dev/null @@ -1,63 +0,0 @@ -======================= -Extract Vertex Geometry -======================= - - -Group (Subgroup) -================ - -Core Filters (Conversion) - -Description -=========== - -This filter will extract all the voxel centers of an Image Geometry or a RectilinearGrid geometry 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 | string | The name of the vertex attribute matrix that will be | -| Matrix Name | | created as a child of the output vertex geometry | -+---------------------------+---------------------------+-------------------------------------------------------------+ -| Output Shared Vertex List | string | The name of the shared vertex list name that will be output | -| Name | | with the vertex geometry | -+---------------------------+---------------------------+-------------------------------------------------------------+ - -Required Geometry -================= - -Required Geometry Type: **ImageGeom** or **RectGridGeom** - -Example Pipelines -================= - -PrebuiltPipelines/Examples/Extract Vertex Geometry.json - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/FeatureDataCSVWriterFilter.md b/src/Plugins/ComplexCore/docs/FeatureDataCSVWriterFilter.md index ce49ba031f..2b759c533e 100644 --- a/src/Plugins/ComplexCore/docs/FeatureDataCSVWriterFilter.md +++ b/src/Plugins/ComplexCore/docs/FeatureDataCSVWriterFilter.md @@ -1,15 +1,15 @@ # Write Feature Data as CSV File -## Group (Subgroup) ## +## Group (Subgroup) IO (Output) -## Description ## +## Description This **Filter** writes the data associated with each **Feature** to a file name specified by the user in *CSV* format. Every array in the **Feature** map is written as a column of data in the *CSV* file. The user can choose to also write the neighbor data. Neighbor data are data arrays that are associated with the neighbors of a **Feature**, such as: list of neighbors, list of misorientations, list of shared surface areas, etc. These blocks of info are written after the scalar data arrays. Since the number of neighbors is variable for each **Feature**, the data is written as follows (for each **Feature**): Id, number of neighbors, value1, value2,...valueN. -### Example Output ### +### Example Output The *CSV* file: @@ -41,7 +41,7 @@ The *CSV* file with Write Neighbor Data checked: 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 ## +## Parameters | Name | Type |Description | |------|------|------| @@ -50,25 +50,25 @@ The *CSV* file with Write Neighbor Data checked: | 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 ## +## Required Geometry Not Applicable -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| Kind | Default Name | Type | Comp Dims | Description | +|---------------------------|--------------|----------|--------|---------------------------------------------| | AttributeMatrix | None | Feature | N/A | AttributeMatrix** that holds the data to write | -## Created Objects ## +## Created Objects None -## Example Pipelines ## +## Example Pipelines None -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/ComplexCore/docs/FeatureDataCSVWriterFilter.rst b/src/Plugins/ComplexCore/docs/FeatureDataCSVWriterFilter.rst deleted file mode 100644 index 583b809245..0000000000 --- a/src/Plugins/ComplexCore/docs/FeatureDataCSVWriterFilter.rst +++ /dev/null @@ -1,111 +0,0 @@ -============================== -Write Feature Data as CSV File -============================== - - -Group (Subgroup) -================ - -IO (Output) - -Description -=========== - -This **Filter** writes the data associated with each **Feature** to a file name specified by the user in *CSV* format. -Every array in the **Feature** map is written as a column of data in the *CSV* file. The user can choose to also write -the neighbor data. Neighbor data are data arrays that are associated with the neighbors of a **Feature**, such as: list -of neighbors, list of misorientations, list of shared surface areas, etc. These blocks of info are written after the -scalar data arrays. Since the number of neighbors is variable for each **Feature**, the data is written as follows (for -each **Feature**): Id, number of neighbors, value1, value2,…valueN. - -Example Output --------------- - -The *CSV* file: - -:: - - 5414 - Feature_ID,Active,AvgEuler_0,AvgEuler_1,AvgEuler_2,AvgQuats_0,AvgQuats_1,AvgQuats_2,AvgQuats_3,NumNeighbors2,Phases - 1,1,4.7367158,0.40832964,1.1398145,-0.045759138,0.19751814,0.19773535,0.95905864,6,1 - 2,1,3.315398,0.74920797,3.2314293,0.3655816,0.015357733,-0.12232465,0.92257845,2,1 - 3,1,3.8660862,0.20160854,2.8935425,0.088968314,0.047029439,-0.23477697,0.96682608,2,1 - 4,1,1.2659892,0.89199567,5.6040425,-0.24293284,-0.35644585,-0.26093844,0.86362094,1,1 - 5,1,0.96062404,0.576078,5.2663703,-0.15617171,-0.23729226,0.026934497,0.95842445,26,1 - -The *CSV* file with Write Neighbor Data checked: - -:: - - 5414 - Feature_ID,Active,AvgEuler_0,AvgEuler_1,AvgEuler_2,AvgQuats_0,AvgQuats_1,AvgQuats_2,AvgQuats_3,NumNeighbors2,Phases - 1,1,4.7367158,0.40832964,1.1398145,-0.045759138,0.19751814,0.19773535,0.95905864,6,1 - 2,1,3.315398,0.74920797,3.2314293,0.3655816,0.015357733,-0.12232465,0.92257845,2,1 - 3,1,3.8660862,0.20160854,2.8935425,0.088968314,0.047029439,-0.23477697,0.96682608,2,1 - 4,1,1.2659892,0.89199567,5.6040425,-0.24293284,-0.35644585,-0.26093844,0.86362094,1,1 - 5,1,0.96062404,0.576078,5.2663703,-0.15617171,-0.23729226,0.026934497,0.95842445,26,1 - . - . - . - Feature_ID,NumNeighbors,NeighborList2 - 1,6,229,607,639,2432,3280,5057 - 2,2,518,3933 - 3,2,1561,3145 - 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 - -Example Pipelines -================= - -None - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/FeatureFaceCurvatureFilter.md b/src/Plugins/ComplexCore/docs/FeatureFaceCurvatureFilter.md index 85e7cc60b6..61eba0009d 100644 --- a/src/Plugins/ComplexCore/docs/FeatureFaceCurvatureFilter.md +++ b/src/Plugins/ComplexCore/docs/FeatureFaceCurvatureFilter.md @@ -1,10 +1,10 @@ -# Find Feature Face Curvature # +# Find Feature Face Curvature -## Group (Subgroup) ## +## Group (Subgroup) Surface Meshing (Curvature) -## Description ## +## Description This **Filter** calculates *principal direction vectors* and the *principal curvatures*, and optionally the *mean* and *Gaussian* curvature, for each **Triangle** in a **Triangle Geometry** using the technique in [1]. The groups of **Triangles** over which to compute the curvatures is determines by the **Features** they are associated, denoted by their **Face Labels**. The curvature information will be stored in a **Face Attribute Matrix**. @@ -13,14 +13,10 @@ Principal Curvatures 1 and 2 are the κ 1 and κ 2 1 and κ 2 `__ - -.. |Curvature Coloring of a Feature| image:: Images/FeatureFaceCurvatureFilter.png diff --git a/src/Plugins/ComplexCore/docs/FillBadDataFilter.md b/src/Plugins/ComplexCore/docs/FillBadDataFilter.md index f88a2a2c1a..9110d224eb 100644 --- a/src/Plugins/ComplexCore/docs/FillBadDataFilter.md +++ b/src/Plugins/ComplexCore/docs/FillBadDataFilter.md @@ -29,8 +29,8 @@ Image ## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | diff --git a/src/Plugins/ComplexCore/docs/FillBadDataFilter.rst b/src/Plugins/ComplexCore/docs/FillBadDataFilter.rst deleted file mode 100644 index 671a257302..0000000000 --- a/src/Plugins/ComplexCore/docs/FillBadDataFilter.rst +++ /dev/null @@ -1,83 +0,0 @@ -============= -Fill Bad Data -============= - - -Group (Subgroup) -================ - -Processing (Cleanup) - -Description -=========== - -This **Filter** removes small *noise* in the data, but keeps larger regions that are possibly **Features**, e.g., pores -or defects. This **Filter** collects the *bad* **Cells** (*Feature Id = 0*) and *erodes* them until none remain. -However, contiguous groups of *bad* **Cells** that have at least as many **Cells** as the minimum allowed defect size -entered by the user will not be *eroded*. - -================== ================= -Small IN100 Before Small IN100 After -================== ================= -|image1| |image2| -================== ================= - -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 - -Example Pipelines -================= - -- - - (8) SmallIN100 Full Reconstruction - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. - -.. |image1| image:: Images/fill_bad_data_before.png -.. |image2| image:: Images/fill_bad_data_after.png diff --git a/src/Plugins/ComplexCore/docs/FindArrayStatisticsFilter.md b/src/Plugins/ComplexCore/docs/FindArrayStatisticsFilter.md index a65ada29d8..25d8163e67 100644 --- a/src/Plugins/ComplexCore/docs/FindArrayStatisticsFilter.md +++ b/src/Plugins/ComplexCore/docs/FindArrayStatisticsFilter.md @@ -1,10 +1,10 @@ -# Find Attribute Array Statistics # +# Find Attribute Array Statistics -## Group (Subgroup) ## +## Group (Subgroup) DREAM3D Review (Statistics) -## Description ## +## Description This **Filter** computes a variety of statistics for a given scalar array. The currently available statistics are array length, minimum, maximum, (arithmetic) mean, median, mode, standard deviation, and summation; any combination of these statistics may be computed by this **Filter**. Any scalar array, of any primitive type, may be used as input. The type of the output arrays depends on the kind of statistic computed: @@ -32,7 +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 ## +## Parameters | Name | Type | Description | |-----------------------------------------|----------|--------------------------------------------------------| @@ -54,23 +54,23 @@ Special operations occur for certain statistics if the supplied array is of type | 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 ## +## Required Geometry None -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 ## +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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. | @@ -86,13 +86,13 @@ None | 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 | -## Example Pipelines ## +## Example Pipelines -## License & Copyright ## +## License & Copyright Please see the description file distributed with this plugin. -## DREAM3DNX Help ## +## DREAM3DNX 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. diff --git a/src/Plugins/ComplexCore/docs/FindArrayStatisticsFilter.rst b/src/Plugins/ComplexCore/docs/FindArrayStatisticsFilter.rst deleted file mode 100644 index 351885ef2d..0000000000 --- a/src/Plugins/ComplexCore/docs/FindArrayStatisticsFilter.rst +++ /dev/null @@ -1,234 +0,0 @@ -=============================== -Find Attribute Array Statistics -=============================== - - -Group (Subgroup) -================ - -DREAM3D Review (Statistics) - -Description -=========== - -This **Filter** computes a variety of statistics for a given scalar array. The currently available statistics are array -length, minimum, maximum, (arithmetic) mean, median, mode, standard deviation, and summation; any combination of these -statistics may be computed by this **Filter**. Any scalar array, of any primitive type, may be used as input. The type -of the output arrays depends on the kind of statistic computed: - -======================= =================================== -Statistic Primitive Type -======================= =================================== -Histogram uint64 (of user set component size) -Length signed 64-bit integer -Minimum same type as input -Maximum same type as input -Mean double -Median double -Mode same type as input -Standard Deviation double -Summation double -Standardized double -Number of Unique Values signed 32-bit integer -======================= =================================== - -The user may optionally use a mask to specify points to be ignored when computing the statistics; only points where the -supplied mask is *true* will be considered when computing statistics. Additionally, the user may select to have the -statistics computed per **Feature** or **Ensemble** by supplying an Ids array. For example, if the user opts to compute -statistics per **Feature** and selects an array that has 10 unique **Feature** Ids, then this **Filter** will compute 10 -sets of statistics (e.g., find the mean of the supplied array for each **Feature**, find the total number of points in -each **Feature** (the length), etc.). - -The input array may also be *standardized*, meaning that the array values will be adjusted such that they have a mean of -0 and unit variance. This *Standardize Data* option requires the selection of both the *Find Mean* and *Find Standard -Deviation* options. The standardized data will be saved as a new array object stored in the same **Attribute Matrix** as -the input array. Note that if the *Standardize Data* option is selected, the mean and standard deviation values created -by this **Filter** reflect the mean and standard deviation of the *original* array; the new standardized array has a -mean of 0 and unit variance. The standardized array will be computed in double precision. If the statistics are being -computed per **Feature** or **Ensemble**, then the array values are standardized according to the mean and standard -deviation *for each* **Feature/Ensemble**. For example, if 5 unique **Features** were being analyzed and *Standardize -Data* was selected, then the array values for **Feature** 1 would be standardized according to the mean and standard -deviation for **Feature** 1, then the array values for **Feature** 2 would be standardized according to the mean and -standard deviation for **Feature** 2, and so on for the remaining **Features**. - -The user must select a destination **Attribute Matrix** in which the computed statistics will be stored. If electing to -*Compute Statistics Per Feature/Ensemble*, then a reasonable selection for this array is the **Feature/Ensemble** -**Attribute Matrix** associated with the supplied **Feature/Ensemble** Ids. However, the only requirement is that the -number of columns in the selected destination **Attribute Matrix** match the number of **Features/Ensembles** specified -by the supplied Id array. This requirement is enforced at run time. If computing statistics for the entire input array, -then only one value is computed per statistic; therefore, the arrays produced only contain one value. In this case, the -destination **Attribute Matrix** should only contain 1 tuple. If such a **Generic Attribute Matrix** does not exist, it -can be created. - -Special operations occur for certain statistics if the supplied array is of type *bool* (for example, a mask array -produced `when thresholding <@ref%20multithresholdobjects>`__). The length, minimum, maximum, median, mode, and -summation are computed as normal (although the resulting values may be platform dependent). The mean and standard -deviation for a boolean array will be true if there are more instances of true in the array than false. If *Standardize -Data* is chosen for a boolean array, no actual modifications will be made to the input. These operations for boolean -inputs are chosen as a basic convention, and are not intended be representative of true boolean logic. - -**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 | None | Any | N/A | Attribute Matrix*\* in which to store the | -| Matrix | | | | computed statistics | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Created Objects -=============== - -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Kind | Default Name | Type | Comp. Dims | Description | -+=============================+==============+==========+============+=================================================+ -| Attribute Array | Feat | bool | (1) | Indicates, for each feature, whether or not the | -| | ure-Has-Data | | | 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 | Histogram of the input array, if *Find | -| | | | Bins) | Histogram* is checked | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Attribute Array | Most | uint64 | (2) | Most populated bin from the histogram of the | -| | Populated | | | input array, if *Find Histogram* is checked. | -| | Bin | | | First component is the bin index (0-based), | -| | | | | second component is the number of values in the | -| | | | | bin. | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Neighbor List*\* | Modal | float | (1) | Ranges, in physical units, of histogram bin(s) | -| | Histogram | | | that contain mode value(s). *Find Histogram*, | -| | Bin Ranges | | | *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 | (1) | Minimum of the input array, if *Find Minimum* | -| | | input | | is checked | -| | | \**A | | | -| | | ttribute | | | -| | | Array | | | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Attribute Array | Maximum | same as | (1) | Maximum of the input array, if *Find Maximum* | -| | | input | | is checked | -| | | \**A | | | -| | | ttribute | | | -| | | Array | | | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| 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 | (1) | Modes of the input array, if *Find Mode* is | -| | | input | | checked | -| | | \**A | | | -| | | ttribute | | | -| | | Array | | | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Attribute Array | Standard | double | (1) | Standard deviation of the input array, if *Find | -| | Deviation | | | 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 | int32_t | (1) | The number of unique values in the input array, | -| | Unique | | | if *Find Number of Unique Values* is checked | -| | Values | | | | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/FindBiasedFeaturesFilter.md b/src/Plugins/ComplexCore/docs/FindBiasedFeaturesFilter.md index e87c8b4e73..51d64b64b0 100644 --- a/src/Plugins/ComplexCore/docs/FindBiasedFeaturesFilter.md +++ b/src/Plugins/ComplexCore/docs/FindBiasedFeaturesFilter.md @@ -27,7 +27,7 @@ The images below show the feature ids before and after running this filter. The | Name | Type | Description | |------------------|------|-------------| -| Apply Phase by Phase | bool | Whether to apply the biased **Features** algorithm per **Ensemble | +| Apply Phase by Phase | bool | Whether to apply the biased **Features** algorithm per Ensemble | ## Required Geometry @@ -35,16 +35,16 @@ Image ## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | ## Example Pipelines diff --git a/src/Plugins/ComplexCore/docs/FindBiasedFeaturesFilter.rst b/src/Plugins/ComplexCore/docs/FindBiasedFeaturesFilter.rst deleted file mode 100644 index 42452406b8..0000000000 --- a/src/Plugins/ComplexCore/docs/FindBiasedFeaturesFilter.rst +++ /dev/null @@ -1,98 +0,0 @@ -=================================== -Find Biased Features (Bounding Box) -=================================== - - -Group (Subgroup) -================ - -Generic (Spatial) - -Description -=========== - -This **Filter** determines which **Features** are *biased* by the outer surfaces of the sample. Larger **Features** are -more likely to intersect the outer surfaces and thus it is not sufficient to only note which **Features** touch the -outer surfaces of the sample. Denoting which **Features** are biased is important so that they may be excluded from any -statistical analyses. The algorithm for determining whether a **Feature** is *biased* is as follows: - -1. The *centroids* of all **Features** are calculated -2. All **Features** are tested to determine if they touch an outer surface of the sample -3. The largest box is found that does not include any of the *centroids* of **Features** that intersect an outer surface - of the sample -4. Each **Feature**\ ’s *centroid* is checked to see whether it lies within the box. - -*If a* **Feature**\ *\ ’s* centroid\* lies within the box, then the **Feature** is said to be *unbiased*, and if it lies -outside the box, then the **Feature** is said to be *biased*.\* - -By definition of the box, no **Feature** that intersects an outer surface of the sample can be considered *unbiased*, -but it should be noted that **Features** that do not intersect the outer surfaces may still be considered *biased*. This -algorithm works to determine the biased **Features** because all **Features** have one (and only one) centroid, no -matter their size. Generally, this method will deem more small **Features** biased than the set of **Features** that -just intersect the outer surfaces - and this corrects for the increased likelihood that larger **Features** will touch -an outer surface. - -*Note:* This **Filter** is a modification of an algorithm from Dave Rowenhorst (Naval Research Laboratory). - -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| - -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 | Sur | bool | (1) | Flag of 1 if **Feature** touches an outer | -| | faceFeatures | | | 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 -======================= ============== ==== ========== ======================================================= - -Example Pipelines -================= - -- FindBiasedFeatures.d3dpipeline - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. - -.. |2D Before and After Biased Features| image:: Images/FindBiasedFeaturesBeforeAndAfter.png diff --git a/src/Plugins/ComplexCore/docs/FindBoundaryCellsFilter.md b/src/Plugins/ComplexCore/docs/FindBoundaryCellsFilter.md index 414140f7d7..c58dc026ec 100644 --- a/src/Plugins/ComplexCore/docs/FindBoundaryCellsFilter.md +++ b/src/Plugins/ComplexCore/docs/FindBoundaryCellsFilter.md @@ -32,17 +32,17 @@ Image ## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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* | -## Example Pipelines +## Example Pipelines + FindBoundaryCells.d3dpipeline diff --git a/src/Plugins/ComplexCore/docs/FindBoundaryCellsFilter.rst b/src/Plugins/ComplexCore/docs/FindBoundaryCellsFilter.rst deleted file mode 100644 index d970ad8e60..0000000000 --- a/src/Plugins/ComplexCore/docs/FindBoundaryCellsFilter.rst +++ /dev/null @@ -1,81 +0,0 @@ -=========================== -Find Boundary Cells (Image) -=========================== - - -Group (Subgroup) -================ - -Generic (Spatial) - -Description -=========== - -This **Filter** determines, for each **Cell**, the number of neighboring **Cells** that are owned by a different -**Feature**. The algorithm for determining this is as follows: - -1. Identify the **Feature** to which a **Cell** belongs -2. Identify the **Features** to which each of the current **Cell**\ ’s six (6) face-face neighboring **Cells** (front, - back, left, right, up, down) belong -3. Determine the number of those neighboring **Cells** belonging to a different **Feature** than the current **Cell**. -4. Repeat 1-3 for all **Cells** - -============================= ================================= -Small IN100 Feature Ids Input Small IN100 Boundary Cells Output -============================= ================================= -|Feature Ids| |Boundary Cells| -============================= ================================= - -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 | B | int8_t | (1) | The number of neighboring **Cells** of a given | -| | oundaryCells | | | **Cell** that belong to a different **Feature** | -| | | | | than itself. Values will range from *0* to *6* | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Example Pipelines -================= - -- FindBoundaryCells.d3dpipeline - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. - -.. |Feature Ids| image:: Images/FindBoundaryCellsInput.png -.. |Boundary Cells| image:: Images/FindBoundaryCellsOutput.png diff --git a/src/Plugins/ComplexCore/docs/FindBoundaryElementFractionsFilter.md b/src/Plugins/ComplexCore/docs/FindBoundaryElementFractionsFilter.md index 17914386bd..fa71c6fb54 100644 --- a/src/Plugins/ComplexCore/docs/FindBoundaryElementFractionsFilter.md +++ b/src/Plugins/ComplexCore/docs/FindBoundaryElementFractionsFilter.md @@ -19,16 +19,16 @@ Not Applicable ## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | ## Example Pipelines diff --git a/src/Plugins/ComplexCore/docs/FindBoundaryElementFractionsFilter.rst b/src/Plugins/ComplexCore/docs/FindBoundaryElementFractionsFilter.rst deleted file mode 100644 index 767c8f8d3b..0000000000 --- a/src/Plugins/ComplexCore/docs/FindBoundaryElementFractionsFilter.rst +++ /dev/null @@ -1,69 +0,0 @@ -======================================= -Find Feature Boundary Element Fractions -======================================= - - -Group (Subgroup) -================ - -Statistics (Morphological) - -Description -=========== - -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 | int32 | (1) | The number of neighboring **Elements** of a | -| | Elements | | | given **Element** that belong to a different | -| | | | | **Feature** than itself | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Attribute Matrix | Feature Data | Attribu | N/A | Parent Attribute Matrix for the *Surface | -| | | teMatrix | | Element Fractions* Array to be created in | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Created Objects -=============== - -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Kind | Default Name | Type | Comp. Dims | Description | -+=============================+==============+==========+============+=================================================+ -| Feature Attribute Array | Surface | float32 | (1) | Fraction of **Elements** belonging to the | -| | Element | | | **Feature** that are “surface” \**Elements | -| | Fractions | | | | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/FindDifferencesMap.md b/src/Plugins/ComplexCore/docs/FindDifferencesMap.md index f417a06238..a509b7b36e 100644 --- a/src/Plugins/ComplexCore/docs/FindDifferencesMap.md +++ b/src/Plugins/ComplexCore/docs/FindDifferencesMap.md @@ -1,11 +1,11 @@ # Find Difference Map -## Group (Subgroup) ## +## Group (Subgroup) Statistics (Misc) -## Description ## +## Description This **Filter** calculates the difference between two **Attribute Arrays**. The arrays must have the same *primitive type* (e.g., float), *component dimensions* and *number of tuples*. The **Filter** uses the following pseudocode to calculate the difference map: @@ -19,32 +19,32 @@ 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 ## +## Parameters None -## Required Geometry ## +## Required Geometry Not Applicable -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 ## +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| Kind | Default Name | Type | Comp Dims | Description | +|---------------------------|--------------|----------|--------|---------------------------------------------| | Any **Attribute Array | DifferenceMap | Same as input arrays | Same as input arrays | The difference map **Attribute Array | -## Example Pipelines ## +## Example Pipelines -## License & Copyright ## +## License & Copyright Please see the description file distributed with this plugin. diff --git a/src/Plugins/ComplexCore/docs/FindDifferencesMap.rst b/src/Plugins/ComplexCore/docs/FindDifferencesMap.rst deleted file mode 100644 index 2202ab8703..0000000000 --- a/src/Plugins/ComplexCore/docs/FindDifferencesMap.rst +++ /dev/null @@ -1,85 +0,0 @@ -=================== -Find Difference Map -=================== - - -Group (Subgroup) -================ - -Statistics (Misc) - -Description -=========== - -This **Filter** calculates the difference between two **Attribute Arrays**. The arrays must have the same *primitive -type* (e.g., float), *component dimensions* and *number of tuples*. The **Filter** uses the following pseudocode to -calculate the difference map: - -:: - - for i to all tuples in the arrays - for j to number of components of the arrays - differenceMap[number of components * i + j] = firstSelectedArray[number of components * i + j] - secondSelectedArray[number of components * i + j] - end loop over number of components - end loop over all tuples - -Note that in the above algorithm, the difference is taken as the *first selected* **Attribute Array** minus the *second -selected* **Attribute Array**. The differences are also taken *component by component*. Therefore, two selected scalar -arrays will result in a scalar difference map, whereas two selected 3 component vector arrays would result in a 3 -component vector difference map, where component values are the scalar differences between the components of the input -arrays. - -**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 | D | Same as | Same as | The difference map \**Attribute Array | -| | ifferenceMap | input | input | | -| | | arrays | arrays | | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/FindEuclideanDistMapFilter.md b/src/Plugins/ComplexCore/docs/FindEuclideanDistMapFilter.md index a67b5eb2cb..5b5f51e6f2 100644 --- a/src/Plugins/ComplexCore/docs/FindEuclideanDistMapFilter.md +++ b/src/Plugins/ComplexCore/docs/FindEuclideanDistMapFilter.md @@ -1,11 +1,11 @@ # Find Euclidean Distance Map -## Group (Subgroup) ## +## Group (Subgroup) Statistics (Morphological) -## Description ## +## Description This **Filter** calculates the distance of each **Cell** from the nearest **Feature** boundary, **triple line** and/or **quadruple point**. The following algorithm explains the process: @@ -22,10 +22,10 @@ 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 ## +## 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 | @@ -33,31 +33,31 @@ This **Filter** calculates the distance of each **Cell** from the nearest **Feat | Store the Nearest Boundary Cells | bool | Whether to store the *nearest neighbors* of **Cell** -## Required Geometry ## +## Required Geometry Image -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| Kind | Default Name | Type | Comp Dims | Description | +|---------------------------|--------------|----------|--------|---------------------------------------------| | Cell Attribute Array | FeatureIds | int32_t | (1) | Specifies to which **Feature** each **Cell** belongs | -## Created Objects ## +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | -## Example Pipelines ## +## Example Pipelines + (01) SmallIN100 Morphological Statistics -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/ComplexCore/docs/FindEuclideanDistMapFilter.rst b/src/Plugins/ComplexCore/docs/FindEuclideanDistMapFilter.rst deleted file mode 100644 index fc46a0e40b..0000000000 --- a/src/Plugins/ComplexCore/docs/FindEuclideanDistMapFilter.rst +++ /dev/null @@ -1,116 +0,0 @@ -=========================== -Find Euclidean Distance Map -=========================== - - -Group (Subgroup) -================ - -Statistics (Morphological) - -Description -=========== - -This **Filter** calculates the distance of each **Cell** from the nearest **Feature** boundary, **triple line** and/or -**quadruple point**. The following algorithm explains the process: - -1. Find the **Feature** that owns each **Cell** and its six face-face neighbors of each **Cell** -2. For all **Cells** that have *at least 2* different neighbors, set their *GBEuclideanDistance* to *0*. For all - **Cells** that have *at least 3* different neighbors, set their *TJEuclideanDistance* to *0*. For all **Cells** that - have *at least 4* different neighbors, set their *QPEuclideanDistance* to *0* -3. For each of the three *EuclideanDistace* maps, iteratively “grow” out from the **Cells** identified to have a - distance of *0* by the following sub-steps: - -- Determine the **Cells** that neighbor a **Cell** of distance *0* in the current map. - -- Assign a distance of *1* to those **Cells** and list the *0* **Cell** neighbor as their *nearest neighbor* - -- Repeat previous two sub-steps, increasing the distances by *1* each iteration, until no **Cells** remain without a - distance and *nearest neighbor* assigned. - - *Note:* the distances calculated at this point are “city-block” distances and not “shortest distance” distances. - -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 | bool | Whetherthe distance of each **Cell** to a **Feature** | -| Boundaries | | boundary is calculated | -+------------------------------+------------------------------+--------------------------------------------------------+ -| Calculate Distance to Triple | bool | Whetherthe distance of each **Cell** to a triple line | -| Lines | | between **Features** is calculated | -+------------------------------+------------------------------+--------------------------------------------------------+ -| Calculate Distance to | bool | Whetherthe distance of each **Cell** to a quadruple | -| Quadruple Points | | point between **Features** is calculated | -+------------------------------+------------------------------+--------------------------------------------------------+ -| Store the Nearest Boundary | bool | Whether to store the *nearest neighbors* of **Cell** | -| 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 -==================== ============ ======= ========== ==================================================== - -Created Objects -=============== - -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Kind | Default Name | Type | Comp. Dims | Description | -+=============================+==============+==========+============+=================================================+ -| Cell Attribute Array | GBEuclid | float | (1) | Distance the **Cells** are from the *boundary* | -| | eanDistances | | | of the **Feature** they belong to. Only created | -| | | | | if *Calculate Distance to Boundaries* is | -| | | | | checked | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Cell Attribute Array | TJEuclid | float | (1) | Distance the **Cells** are from a *triple | -| | eanDistances | | | junction* of **Features**. Only created if | -| | | | | *Calculate Distance to Triple Lines* is checked | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Cell Attribute Array | QPEuclid | float | (1) | Distance the **Cells** are from a *quadruple | -| | eanDistances | | | point* of **Features**. Only created if | -| | | | | *Calculate Distance to Quadruple Points* is | -| | | | | checked | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Cell Attribute Array | Near | int32_t | (3) | Indices of the closest **Cell** that touches a | -| | estNeighbors | | | boundary, triple and quadruple point for each | -| | | | | **Cell**. Only created if *Store the Nearest | -| | | | | Boundary Cells* is checked | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Example Pipelines -================= - -- - - (1) SmallIN100 Morphological Statistics - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/FindFeatureCentroidsFilter.md b/src/Plugins/ComplexCore/docs/FindFeatureCentroidsFilter.md index dd36cfb08c..1fb2a4c59a 100644 --- a/src/Plugins/ComplexCore/docs/FindFeatureCentroidsFilter.md +++ b/src/Plugins/ComplexCore/docs/FindFeatureCentroidsFilter.md @@ -1,41 +1,41 @@ # Find Feature Centroids -## Group (Subgroup) ## +## Group (Subgroup) Generic (Misc) -## Description ## +## Description 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 ## +## Parameters None -## Required Geometry ## +## Required Geometry Image -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| Kind | Default Name | Type | Comp Dims | Description | +|---------------------------|--------------|----------|--------|---------------------------------------------| | Cell Attribute Array | FeatureIds | int32_t | (1) | Specifies to which **Feature** each **Cell** belongs | -## Created Objects ## +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| Kind | Default Name | Type | Comp Dims | Description | +|---------------------------|--------------|----------|--------|---------------------------------------------| | Feature Attribute Array | Centroids | float | (3) | X, Y, Z coordinates of **Feature** center of mass | -## Example Pipelines ## +## Example Pipelines + (01) SmallIN100 Morphological Statistics + InsertTransformationPhase + (06) SmallIN100 Synthetic -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/ComplexCore/docs/FindFeatureCentroidsFilter.rst b/src/Plugins/ComplexCore/docs/FindFeatureCentroidsFilter.rst deleted file mode 100644 index dd5c422841..0000000000 --- a/src/Plugins/ComplexCore/docs/FindFeatureCentroidsFilter.rst +++ /dev/null @@ -1,69 +0,0 @@ -====================== -Find Feature Centroids -====================== - - -Group (Subgroup) -================ - -Generic (Misc) - -Description -=========== - -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 -======================= ============ ===== ========== ================================================= - -Example Pipelines -================= - -- - - (1) SmallIN100 Morphological Statistics - -- InsertTransformationPhase - -- - - (6) SmallIN100 Synthetic - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/FindFeatureClusteringFilter.md b/src/Plugins/ComplexCore/docs/FindFeatureClusteringFilter.md index 551e43e3c8..7c16bea121 100644 --- a/src/Plugins/ComplexCore/docs/FindFeatureClusteringFilter.md +++ b/src/Plugins/ComplexCore/docs/FindFeatureClusteringFilter.md @@ -20,7 +20,7 @@ This Filter determines the radial distribution function (RDF), as a histogram, o ## 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 | @@ -33,8 +33,8 @@ Image ## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | @@ -42,8 +42,8 @@ Image ## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | diff --git a/src/Plugins/ComplexCore/docs/FindFeatureClusteringFilter.rst b/src/Plugins/ComplexCore/docs/FindFeatureClusteringFilter.rst deleted file mode 100644 index 4ded5c9125..0000000000 --- a/src/Plugins/ComplexCore/docs/FindFeatureClusteringFilter.rst +++ /dev/null @@ -1,108 +0,0 @@ -======================= -Find Feature Clustering -======================= - - -Group (Subgroup) -================ - -Statistics (Morphological) - -Description -=========== - -This Filter determines the radial distribution function (RDF), as a histogram, of a given set of **Features**. -Currently, the **Features** need to be of the same **Ensemble** (specified by the user), and the resulting RDF is stored -as **Ensemble** data. This Filter also returns the clustering list (the list of all the inter-**Feature** distances) and -the minimum and maximum separation distances. The algorithm proceeds as follows: - -1. Find the Euclidean distance from the current **Feature** centroid to all other **Feature** centroids of the same - specified phase -2. Put all caclulated distances in a clustering list -3. Repeat 1-2 for all **Features** -4. Sort the data into the specified number of bins, all equally sized in distance from the minimum distance to the - maximum distance between **Features**. For example, if the user chooses 10 bins, and the minimum distance between - **Features** is 10 units and the maximum distance is 80 units, each bin will be 8 units -5. Normalize the RDF by the probability of finding the **Features** if distributed randomly in the given box - -*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 | Equival | float | (1) | Diameter of a sphere with the same volume as | -| | entDiameters | | | 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 | Bi | bool | (1) | Specifies which features are biased and | -| | asedFeatures | | | therefor should be removed if the Remove Biased | -| | | | | Features option is on | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Created Objects -=============== - -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Kind | Default Name | Type | Comp. Dims | Description | -+=============================+==============+==========+============+=================================================+ -| Feature Attribute Array | Cl | float | (1) | Distance of each **Features**\ ’s centroid to | -| | usteringList | | | ever other **Features**\ ’s centroid | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Ensemble Attribute Array | RDF | float | (Number of | A histogram of the normalized frequency at each | -| | | | Bins) | bin | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Ensemble Attribute Array | RDFMax | float | (2) | The max and min distance found between | -| | MinDistances | | | \**Features | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Example Pipelines -================= - -- PorosityAnalysis - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/FindFeaturePhasesBinaryFilter.md b/src/Plugins/ComplexCore/docs/FindFeaturePhasesBinaryFilter.md index ef4d56a68f..8b00a3daa7 100644 --- a/src/Plugins/ComplexCore/docs/FindFeaturePhasesBinaryFilter.md +++ b/src/Plugins/ComplexCore/docs/FindFeaturePhasesBinaryFilter.md @@ -18,16 +18,16 @@ Image ## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | ## Example Pipelines diff --git a/src/Plugins/ComplexCore/docs/FindFeaturePhasesBinaryFilter.rst b/src/Plugins/ComplexCore/docs/FindFeaturePhasesBinaryFilter.rst deleted file mode 100644 index a9a385649f..0000000000 --- a/src/Plugins/ComplexCore/docs/FindFeaturePhasesBinaryFilter.rst +++ /dev/null @@ -1,70 +0,0 @@ -========================== -Find Feature Phases Binary -========================== - - -Group (Subgroup) -================ - -Generic (Misc) - -Description -=========== - -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 | A | N/A | The *Cell Data* **Attribute Matrix** of the | -| | Attribute | ttribute | | **Image Geometry** where the *Binary Phases | -| | Matrix | Matrix | | Array* will be created | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Created Objects -=============== - -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Kind | Default Name | Type | Comp. Dims | Description | -+=============================+==============+==========+============+=================================================+ -| Feature Attribute Array | Binary | int32_t | (1) | Specifies to which **Ensemble** each | -| | Feature | | | **Feature** belongs | -| | Phases Array | | | | -| | Name | | | | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/FindFeaturePhasesFilter.md b/src/Plugins/ComplexCore/docs/FindFeaturePhasesFilter.md index 58c11f13c4..cd66aa6ed2 100644 --- a/src/Plugins/ComplexCore/docs/FindFeaturePhasesFilter.md +++ b/src/Plugins/ComplexCore/docs/FindFeaturePhasesFilter.md @@ -1,43 +1,43 @@ # Find Feature Phases -## Group (Subgroup) ## +## Group (Subgroup) Generic (Misc) -## Description ## +## Description 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 ## +## Parameters None -## Required Geometry ## +## Required Geometry Not Applicable -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 ## +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| Kind | Default Name | Type | Comp Dims | Description | +|---------------------------|--------------|----------|--------|---------------------------------------------| | Feature Attribute Array | Phases | int32_t | (1) | Specifies to which **Ensemble** each **Feature** belongs | -## Example Pipelines ## +## Example Pipelines + (10) SmallIN100 Full Reconstruction + INL Export + (06) SmallIN100 Postsegmentation Processing -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/ComplexCore/docs/FindFeaturePhasesFilter.rst b/src/Plugins/ComplexCore/docs/FindFeaturePhasesFilter.rst deleted file mode 100644 index a74a3dcb00..0000000000 --- a/src/Plugins/ComplexCore/docs/FindFeaturePhasesFilter.rst +++ /dev/null @@ -1,70 +0,0 @@ -=================== -Find Feature Phases -=================== - - -Group (Subgroup) -================ - -Generic (Misc) - -Description -=========== - -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 -======================= ============ ======= ========== ======================================================== - -Example Pipelines -================= - -- - - (10) SmallIN100 Full Reconstruction - -- INL Export - -- - - (6) SmallIN100 Postsegmentation Processing - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/FindLargestCrossSectionsFilter.md b/src/Plugins/ComplexCore/docs/FindLargestCrossSectionsFilter.md index 6f9bc95c13..dd21f12e51 100644 --- a/src/Plugins/ComplexCore/docs/FindLargestCrossSectionsFilter.md +++ b/src/Plugins/ComplexCore/docs/FindLargestCrossSectionsFilter.md @@ -12,7 +12,7 @@ This **Filter** calculates the largest cross-sectional area on a user-defined pl ## Parameters | Name | Type | Description | -|------|------| ----------- | +|------------|------| --------------------------------- | | Plane of Interest | Enumeration | Specifies which plane to consider when determining the maximum cross-section for each **Feature | ## Required Geometry @@ -21,14 +21,14 @@ Image ## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | diff --git a/src/Plugins/ComplexCore/docs/FindLargestCrossSectionsFilter.rst b/src/Plugins/ComplexCore/docs/FindLargestCrossSectionsFilter.rst deleted file mode 100644 index 1671203b3b..0000000000 --- a/src/Plugins/ComplexCore/docs/FindLargestCrossSectionsFilter.rst +++ /dev/null @@ -1,65 +0,0 @@ -======================================== -Find Feature Largest Cross-Section Areas -======================================== - - -Group (Subgroup) -================ - -Statistics (Morphological) - -Description -=========== - -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 | Largest | flaot | (1) | Area of largest cross-section for **Feature** | -| | CrossSection | | | perpendicular to the user specified direction | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/FindNeighborListStatistics.md b/src/Plugins/ComplexCore/docs/FindNeighborListStatistics.md index 20c0675f86..ca4b139639 100644 --- a/src/Plugins/ComplexCore/docs/FindNeighborListStatistics.md +++ b/src/Plugins/ComplexCore/docs/FindNeighborListStatistics.md @@ -1,10 +1,10 @@ # Find NeighborList Statistics -## Group (Subgroup) ## +## Group (Subgroup) Statistics (Misc Filters) -## Description ## +## Description This **Filter** finds the selected statistics for each list contained in a NeighborList container. Each of those statistics are reported back as new Attribute Arrays. The user selectable statistics are: @@ -16,10 +16,10 @@ This **Filter** finds the selected statistics for each list contained in a Neigh + Standard Deviation of each list + Summation of each list -## Parameters ## +## 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 | @@ -37,21 +37,21 @@ This **Filter** finds the selected statistics for each list contained in a Neigh | 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 ### +## Required Geometry# Not Applicable -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 ## +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | @@ -60,7 +60,7 @@ Not Applicable | Standard Deviation Attribute Array | Standard Deviation | float | (1) | Output Standard Deviation Array | | Summation Attribute Array | Summation | float | (1) | Output Summation Array | -## License & Copyright ## +## License & Copyright Please see the description file distributed with this plugin. diff --git a/src/Plugins/ComplexCore/docs/FindNeighborListStatistics.rst b/src/Plugins/ComplexCore/docs/FindNeighborListStatistics.rst deleted file mode 100644 index e1c3438f7e..0000000000 --- a/src/Plugins/ComplexCore/docs/FindNeighborListStatistics.rst +++ /dev/null @@ -1,88 +0,0 @@ -============================ -Find NeighborList Statistics -============================ - - -Group (Subgroup) -================ - -Statistics (Misc Filters) - -Description -=========== - -This **Filter** finds the selected statistics for each list contained in a NeighborList container. Each of those -statistics are reported back as new Attribute Arrays. The user selectable statistics are: - -- Length of each list -- Minimum value from each list -- Maximum value from each list -- Mean of each list -- Median of each list -- 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 -================================== ================== ===== ========== =============================== - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/FindNeighborhoodsFilter.md b/src/Plugins/ComplexCore/docs/FindNeighborhoodsFilter.md index 1922d09c2b..9bab343e42 100644 --- a/src/Plugins/ComplexCore/docs/FindNeighborhoodsFilter.md +++ b/src/Plugins/ComplexCore/docs/FindNeighborhoodsFilter.md @@ -1,11 +1,11 @@ # Find Feature Neighborhoods -## Group (Subgroup) ## +## Group (Subgroup) Statistics (Morphological) -## Description ## +## Description This **Filter** determines the number of **Features**, for each **Feature**, whose *centroids* lie within a distance equal to a user defined multiple of the average *Equivalent Sphere Diameter* (*average of all **Features**). The algorithm for determining the number of **Features** is given below: @@ -13,38 +13,38 @@ 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 ## +## Parameters | Name | Type | Description | -|------|------| ----------- | +|------------|------| --------------------------------- | | Multiples of Average Diameter | float | Defines the search radius to use when looking for "neighboring" **Features | -## Required Geometry ## +## Required Geometry Image -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 ## +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | -## Example Pipelines ## +## Example Pipelines + (01) SmallIN100 Morphological Statistics + InsertTransformationPhase + (06) SmallIN100 Synthetic -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/ComplexCore/docs/FindNeighborhoodsFilter.rst b/src/Plugins/ComplexCore/docs/FindNeighborhoodsFilter.rst deleted file mode 100644 index 49c431fad9..0000000000 --- a/src/Plugins/ComplexCore/docs/FindNeighborhoodsFilter.rst +++ /dev/null @@ -1,92 +0,0 @@ -========================== -Find Feature Neighborhoods -========================== - - -Group (Subgroup) -================ - -Statistics (Morphological) - -Description -=========== - -This **Filter** determines the number of **Features**, for each **Feature**, whose *centroids* lie within a distance -equal to a user defined multiple of the average *Equivalent Sphere Diameter* (\*average of all **Features**). The -algorithm for determining the number of **Features** is given below: - -1. Define a sphere centered at the **Feature**\ ’s *centroid* and with radius equal to the average equivalent sphere - diameter multiplied by the user defined multiple -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 | Equival | float | (1) | Diameter of a sphere with the same volume as | -| | entDiameters | | | 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 | N | int32_t | (1) | Number of **Features** that have their centroid | -| | eighborhoods | | | within the user specified multiple of | -| | | | | equivalent sphere diameters from each | -| | | | | \**Feature | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Feature Attribute Array | Neigh | List of | (1) | List of the **Features** whose centroids are | -| | borhoodLists | int32_t | | within the user specified multiple of | -| | | | | equivalent sphere diameter from each \**Feature | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Example Pipelines -================= - -- - - (1) SmallIN100 Morphological Statistics - -- InsertTransformationPhase - -- - - (6) SmallIN100 Synthetic - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/FindNeighbors.md b/src/Plugins/ComplexCore/docs/FindNeighbors.md index 60e82dcc39..3ef5cb469f 100644 --- a/src/Plugins/ComplexCore/docs/FindNeighbors.md +++ b/src/Plugins/ComplexCore/docs/FindNeighbors.md @@ -1,11 +1,11 @@ # Find Feature Neighbors -## Group (Subgroup) ## +## Group (Subgroup) Statistics (Morphological) -## Description ## +## Description This **Filter** determines, for each **Feature**, the number of other **Features** that are in contact with it. The algorithm for determining the number of "contiguous" neighbors of each **Feature** is as follows: @@ -16,35 +16,35 @@ 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 ## +## 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 ## +## Required Geometry Image -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 ## +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | -## Example Pipelines ## +## Example Pipelines + (01) SmallIN100 Morphological Statistics + (10) SmallIN100 Full Reconstruction @@ -56,7 +56,7 @@ Image + (04) Two Phase Cubic Hexagonal Particles Equiaxed + (06) SmallIN100 Synthetic -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/ComplexCore/docs/FindNeighbors.rst b/src/Plugins/ComplexCore/docs/FindNeighbors.rst deleted file mode 100644 index 897e439c89..0000000000 --- a/src/Plugins/ComplexCore/docs/FindNeighbors.rst +++ /dev/null @@ -1,137 +0,0 @@ -====================== -Find Feature Neighbors -====================== - - -Group (Subgroup) -================ - -Statistics (Morphological) - -Description -=========== - -This **Filter** determines, for each **Feature**, the number of other **Features** that are in contact with it. The -algorithm for determining the number of “contiguous” neighbors of each **Feature** is as follows: - -1. Identify the **Feature** to which a **Cell** belongs -2. Identify the **Features** to which each of the current **Cell**\ ’s six (6) face-face neighboring **Cells** (front, - back, left, right, up, down) belong -3. If a neighboring **Cell** belongs to a different **Feature** than the current **Cell**, then that **Feature** (owner - of the neighboring **Cell**) is added to the list of contiguous neighbors of the **Feature** that owns the current - **Cell** -4. Repeat 1-3 for all **Cells** - -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 | Cel | Cell | N/A | Feature Attribute Matrix*\* of the selected | -| | lFeatureData | Feature | | *Feature Ids* | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Created Objects -=============== - -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Kind | Default Name | Type | Comp. Dims | Description | -+=============================+==============+==========+============+=================================================+ -| Cell Attribute Array | B | int8_t | (1) | The number of neighboring **Cells** of a given | -| | oundaryCells | | | **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 | (1) | List of the contiguous neighboring **Features** | -| | | int32_t | | for a given \**Feature | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Feature Attribute Array*\* | SharedSurf | List of | (1) | List of the shared surface area for each of the | -| | aceAreaLists | float | | contiguous neighboring **Features** for a given | -| | | | | \**Feature | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Feature Attribute Array*\* | Sur | bool | (1) | Flag equal to 1 if the **Feature** touches an | -| | faceFeatures | | | outer surface of the sample and equal to 0 if | -| | | | | it does not. Only created if *Store Surface | -| | | | | Features Array* is checked | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Example Pipelines -================= - -- - - (1) SmallIN100 Morphological Statistics - -- - - (10) SmallIN100 Full Reconstruction - -- - - (2) Single Hexagonal Phase Equiaxed - -- - - (3) Single Cubic Phase Rolled - -- - - (5) Composite - -- - - (6) SmallIN100 Postsegmentation Processing - -- - - (1) Single Cubic Phase Equiaxed - -- - - (4) Two Phase Cubic Hexagonal Particles Equiaxed - -- - - (6) SmallIN100 Synthetic - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/FindNumFeaturesFilter.md b/src/Plugins/ComplexCore/docs/FindNumFeaturesFilter.md index b1cbce88de..ce9678860e 100644 --- a/src/Plugins/ComplexCore/docs/FindNumFeaturesFilter.md +++ b/src/Plugins/ComplexCore/docs/FindNumFeaturesFilter.md @@ -1,40 +1,40 @@ # Find Number of Features -## Group (Subgroup) ## +## Group (Subgroup) Statistics (Morphological) -## Description ## +## Description 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 ## +## Parameters None -## Required Geometry ## +## Required Geometry Not Applicable -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 ## +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| -| Ensemble Attribute Array | NumFeatures | int32 | (1) | Number of **Features** that belong each **Ensemble | +| Kind | Default Name | Type | Comp Dims | Description | +|---------------------------|--------------|----------|--------|---------------------------------------------| +| Ensemble Attribute Array | NumFeatures | int32 | (1) | Number of **Features** that belong each Ensemble | -## Example Pipelines ## +## Example Pipelines + INL Export -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/ComplexCore/docs/FindNumFeaturesFilter.rst b/src/Plugins/ComplexCore/docs/FindNumFeaturesFilter.rst deleted file mode 100644 index c0347905b0..0000000000 --- a/src/Plugins/ComplexCore/docs/FindNumFeaturesFilter.rst +++ /dev/null @@ -1,64 +0,0 @@ -======================= -Find Number of Features -======================= - - -Group (Subgroup) -================ - -Statistics (Morphological) - -Description -=========== - -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 -======================== ============ ===== ========== =================================================== - -Example Pipelines -================= - -- INL Export - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/FindSurfaceAreaToVolumeFilter.md b/src/Plugins/ComplexCore/docs/FindSurfaceAreaToVolumeFilter.md index 3e82959989..a9af3020f0 100644 --- a/src/Plugins/ComplexCore/docs/FindSurfaceAreaToVolumeFilter.md +++ b/src/Plugins/ComplexCore/docs/FindSurfaceAreaToVolumeFilter.md @@ -26,15 +26,15 @@ Image ## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | diff --git a/src/Plugins/ComplexCore/docs/FindSurfaceAreaToVolumeFilter.rst b/src/Plugins/ComplexCore/docs/FindSurfaceAreaToVolumeFilter.rst deleted file mode 100644 index b21dd35409..0000000000 --- a/src/Plugins/ComplexCore/docs/FindSurfaceAreaToVolumeFilter.rst +++ /dev/null @@ -1,87 +0,0 @@ -=========================== -Find Surface Area to Volume -=========================== - - -Group (Subgroup) -================ - -Statistics (Morphological) - -Description -=========== - -This **Filter** calculates the ratio of surface area to volume for each **Feature** in an **Image Geometry**. First, all -the boundary **Cells** are found for each **Feature**. Next, the surface area for each face that is in contact with a -different **Feature** is totalled. This number is divided by the volume of each **Feature**, calculated by taking the -number of **Cells** of each **Feature** and multiplying by the volume of a **Cell**. - -*Note:* The surface area will be the surface area of the **Cells** in contact with the neighboring **Feature** and will -be influenced by the aliasing of the structure. As a result, the surface area to volume will likely be over-estimated -with respect to the *real* **Feature**. - -This filter also optionally calculate the `Sphericity `__ of each feature. - -.. figure:: Images/Sphericity_Equation.png - :alt: Equation for Sphericity used in the filter - - Equation for Sphericity used in the filter - -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 | SurfaceAre | float | (1) | Ratio of surface area to volume for each | -| | aVolumeRatio | | | **Feature**. The units are inverse length | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Feature Attribute Array | Sphericity | float | (1) | The sphericity of each feature | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Example Pipelines -================= - -- - - (1) SmallIN100 Morphological Statistics - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/FindSurfaceFeatures.md b/src/Plugins/ComplexCore/docs/FindSurfaceFeatures.md index 8533d07b9c..ccb81db459 100644 --- a/src/Plugins/ComplexCore/docs/FindSurfaceFeatures.md +++ b/src/Plugins/ComplexCore/docs/FindSurfaceFeatures.md @@ -40,15 +40,15 @@ Image ## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | ## Example Pipelines diff --git a/src/Plugins/ComplexCore/docs/FindSurfaceFeatures.rst b/src/Plugins/ComplexCore/docs/FindSurfaceFeatures.rst deleted file mode 100644 index b88a3c84c9..0000000000 --- a/src/Plugins/ComplexCore/docs/FindSurfaceFeatures.rst +++ /dev/null @@ -1,103 +0,0 @@ -===================== -Find Surface Features -===================== - - -Group (Subgroup) -================ - -Generic (Spatial) - -Description -=========== - -This **Filter** determines whether a **Feature** touches an outer surface of the sample. This is accomplished by simply -querying the **Feature** owners of the **Cells** that sit at either . Any **Feature** that owns one of those **Cells** -is said to touch an outer surface and all other **Features** are said to not touch an outer surface of the sample. - -This **Filter** determines whether a **Feature** touches an outer *Surface* of the sample volume. A **Feature** is -considered touching the *Surface* of the sample if either of the following conditions are met: - -- Any cell location is xmin, xmax, ymin, ymax, zmin or zmax -- Any cell has **Feature ID = 0** as a neighbor. - -The output of this filter is a **Feature** level array of booleans where 0=Interior/Not touching and 1=Surface/Touching. - -*Note*: If there are voxels within the volume that have **Feature ID=0** then any feature touching those voxels will be -considered a *Surface* feature. - -*Note*: The version of this filter in legacy DREAM.3D had two bugs: one that indexed into neighboring features -incorrectly (DREAM3D repo issue #988), and another that incorrectly labeled feature 0 as a surface feature when feature -0 exists in the feature ids array (DREAM3D repo issue #989). Both of these bugs have been fixed in this new version. - -2D Image Geometry ------------------ - -If the structure/data is actually 2D, then the dimension that is planar is not considered and only the **Features** -touching the edges are considered surface **Features**. - -Example Output --------------- - -+-------------------------------------------------------+---------------------------------------------------------------+ -| |FindSurfaceFeatures_Cylinder| | |FindSurfaceFeatures_Square| | -+-------------------------------------------------------+---------------------------------------------------------------+ -| Example showing features touching Feature ID=0 (Black | Example showing features touching the outer surface of the | -| voxels) | 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 | Cell Feauture | N/A | The path to the cell | | -| Matrix | | | feature \**Attribute | | -| | | | Matrix | | -+----------------------------+---------------+---------+----------------------------+----------------------------+ - -Created Objects -=============== - -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Kind | Default Name | Type | Comp. Dims | Description | -+=============================+==============+==========+============+=================================================+ -| Feature Attribute Array | Sur | bool | (1) | Flag of 1 if **Feature** touches an outer | -| | faceFeatures | | | surface or of 0 if it does not | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Example Pipelines -================= - -- - - (6) SmallIN100 Synthetic - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. - -.. |FindSurfaceFeatures_Cylinder| image:: Images/FindSurfaceFeatures_Cylinder.png -.. |FindSurfaceFeatures_Square| image:: Images/FindSurfaceFeatures_Square.png diff --git a/src/Plugins/ComplexCore/docs/FindTriangleGeomCentroidsFilter.md b/src/Plugins/ComplexCore/docs/FindTriangleGeomCentroidsFilter.md index 2d8431ca2d..962fa6f916 100644 --- a/src/Plugins/ComplexCore/docs/FindTriangleGeomCentroidsFilter.md +++ b/src/Plugins/ComplexCore/docs/FindTriangleGeomCentroidsFilter.md @@ -26,7 +26,7 @@ Triangle | 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 | 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 diff --git a/src/Plugins/ComplexCore/docs/FindTriangleGeomCentroidsFilter.rst b/src/Plugins/ComplexCore/docs/FindTriangleGeomCentroidsFilter.rst deleted file mode 100644 index 865a1b6cb0..0000000000 --- a/src/Plugins/ComplexCore/docs/FindTriangleGeomCentroidsFilter.rst +++ /dev/null @@ -1,69 +0,0 @@ -============================================= -Find Feature Centroids from Triangle Geometry -============================================= - - -Group (Subgroup) -================ - -Statistics (Morphological) - -Description -=========== - -This **Filter** determines the centroids of each **Feature** in a **Triangle Geometry**. The centroids are determined -using the following algorithm: - -1. Query each triangle within the **Triangle Geometry** to determine its two owners -2. Add the 3 nodes of that triangle to the set of nodes bounding those two owners (*Note that a set will only allow each - 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 | Description | -| | | | Dims | | -+=====================+==============+===========+==========+=========================================================+ -| Face Attribute | FaceLabels | int32_t | (2) | Specifies which **Features** are on either side of each | -| Array | | | | \**Face | -+---------------------+--------------+-----------+----------+---------------------------------------------------------+ -| Attribute Matrix*\* | Fac | Face | N/A | Feature Attribute Matrix*\* of the selected *Face | -| | eFeatureData | Feature | | Labels* | -+---------------------+--------------+-----------+----------+---------------------------------------------------------+ - -Created Objects -=============== - -+-------------------------+-----------+-----+----------+-------------------------------------------------------------+ -| Kind | Default | T | Comp | Description | -| | Name | ype | Dims | | -+=========================+===========+=====+==========+=============================================================+ -| Feature Attribute Array | Centroids | fl | (3) | Coordinates of the center of mass for a given enclosed | -| | | oat | | \**Feature | -+-------------------------+-----------+-----+----------+-------------------------------------------------------------+ - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/FindTriangleGeomSizesFilter.md b/src/Plugins/ComplexCore/docs/FindTriangleGeomSizesFilter.md index 17da33a168..1374e20221 100644 --- a/src/Plugins/ComplexCore/docs/FindTriangleGeomSizesFilter.md +++ b/src/Plugins/ComplexCore/docs/FindTriangleGeomSizesFilter.md @@ -35,7 +35,7 @@ Triangle | 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 | FaceLabels | int32_t | (2) | Specifies which **Features** are on either side of each Face | ## Created Objects diff --git a/src/Plugins/ComplexCore/docs/FindTriangleGeomSizesFilter.rst b/src/Plugins/ComplexCore/docs/FindTriangleGeomSizesFilter.rst deleted file mode 100644 index 13fad5a593..0000000000 --- a/src/Plugins/ComplexCore/docs/FindTriangleGeomSizesFilter.rst +++ /dev/null @@ -1,76 +0,0 @@ -=========================================== -Find Feature Volumes from Triangle Geometry -=========================================== - - -Group (Subgroup) -================ - -Statistics (Morphological) - -Description -=========== - -This **Filter** computes the enclosed volume of each **Feature** in a **Triangle Geometry**. The result is the volume of -each surface meshed **Feature**, or alternatively the volume of each unique polyhedron defined by the given *Face -Labels* array. The volume of any generic polyhedron can be computed using the following algorithm: - -1. Triangulate each face of the polyhedron (in this case, each face is already a triangle within the **Triangle - Geometry**) -2. For each triangular face, ensure the normals are all consistent (this **Filter** uses the convention where normals - point inwards; note that the actual winding of the **Triangle Geometry** is not modified) -3. For each triangular face, create a tetrahedron where the fourth vertex is the origin -4. Compute the signed volume of each tetrahedron -5. Sum the signed tetrahedra volumes to obtain the volume of the enclosing polyhedron - -This computation is *not* the same as the Find Feature Sizes for **Triangle Geometries**, which computes the sum of the -unit element sizes for a set of **Features** (thus, the Find Feature Sizes would compute the *area* 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 | Type | Comp Dims | Description | -| | Name | | | | -+=======================+============+=======+===========+============================================================+ -| Face Attribute Array | FaceLabels | in | (2) | Specifies which **Features** are on either side of each | -| | | t32_t | | \**Face | -+-----------------------+------------+-------+-----------+------------------------------------------------------------+ - -Created Objects -=============== - -+-----------------------------+----------------+-------------+------------+-------------------------------------------+ -| Kind | Default Name | Type | Comp Dims | Description | -+=============================+================+=============+============+===========================================+ -| Attribute Matrix*\* | F | Face | N/A | Created **Feature Attribute Matrix** name | -| | aceFeatureData | Feature | | | -+-----------------------------+----------------+-------------+------------+-------------------------------------------+ -| Feature Attribute Array | Volumes | float | (1) | Volume of the enclosed **Feature** | -+-----------------------------+----------------+-------------+------------+-------------------------------------------+ - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/FindVertexToTriangleDistancesFilter.md b/src/Plugins/ComplexCore/docs/FindVertexToTriangleDistancesFilter.md index 441c519e13..1545744dde 100644 --- a/src/Plugins/ComplexCore/docs/FindVertexToTriangleDistancesFilter.md +++ b/src/Plugins/ComplexCore/docs/FindVertexToTriangleDistancesFilter.md @@ -1,33 +1,33 @@ Find Vertex to Triangle Distances ============= -## Group (Subgroup) ## +## Group (Subgroup) Sampling (Spatial) -## Description ## +## Description 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 ## +## Parameters None -## Required Geometry ## +## Required Geometry Vertex and Triangle -## Required Objects ## -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +## 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 | -|---------------------------|--------------|----------|------------|---------------------------------------------| +## 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 | -## License & Copyright ## +## License & Copyright Please see the description file distributed with this plugin. diff --git a/src/Plugins/ComplexCore/docs/FindVertexToTriangleDistancesFilter.rst b/src/Plugins/ComplexCore/docs/FindVertexToTriangleDistancesFilter.rst deleted file mode 100644 index ea0e45db5c..0000000000 --- a/src/Plugins/ComplexCore/docs/FindVertexToTriangleDistancesFilter.rst +++ /dev/null @@ -1,60 +0,0 @@ -================================= -Find Vertex to Triangle Distances -================================= - - -Group (Subgroup) -================ - -Sampling (Spatial) - -Description -=========== - -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 -====================== ================= ======= ========== ========================================================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/FindVolFractionsFilter.md b/src/Plugins/ComplexCore/docs/FindVolFractionsFilter.md index b010ae9ab7..56b9c16630 100644 --- a/src/Plugins/ComplexCore/docs/FindVolFractionsFilter.md +++ b/src/Plugins/ComplexCore/docs/FindVolFractionsFilter.md @@ -1,39 +1,39 @@ # Find Volume Fractions of Ensembles -## Group (Subgroup) ## +## Group (Subgroup) Statistics (Morphological) -## Description ## +## Description 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 ## +## Parameters None -## Required Geometry ## +## Required Geometry None -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 ## +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| -| Ensemble Attribute Array | VolFractions | float | (1) | Fraction of volume that belongs to each **Ensemble | +| Kind | Default Name | Type | Comp Dims | Description | +|---------------------------|--------------|----------|--------|---------------------------------------------| +| Ensemble Attribute Array | VolFractions | float | (1) | Fraction of volume that belongs to each Ensemble | -## Example Pipelines ## +## Example Pipelines -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/ComplexCore/docs/FindVolFractionsFilter.rst b/src/Plugins/ComplexCore/docs/FindVolFractionsFilter.rst deleted file mode 100644 index 500a178176..0000000000 --- a/src/Plugins/ComplexCore/docs/FindVolFractionsFilter.rst +++ /dev/null @@ -1,62 +0,0 @@ -================================== -Find Volume Fractions of Ensembles -================================== - - -Group (Subgroup) -================ - -Statistics (Morphological) - -Description -=========== - -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 | Cell | Ensemble | N/A | The path to the cell ensemble \**Attribute | -| | EnsembleData | Attribu | | Matrix | -| | | teMatrix | | | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Created Objects -=============== - -======================== ============ ===== ========== =================================================== -Kind Default Name Type Comp. Dims Description -======================== ============ ===== ========== =================================================== -Ensemble Attribute Array VolFractions float (1) Fraction of volume that belongs to each \**Ensemble -======================== ============ ===== ========== =================================================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/GenerateColorTableFilter.md b/src/Plugins/ComplexCore/docs/GenerateColorTableFilter.md index a544a26eb6..fc23acd2d4 100644 --- a/src/Plugins/ComplexCore/docs/GenerateColorTableFilter.md +++ b/src/Plugins/ComplexCore/docs/GenerateColorTableFilter.md @@ -1,37 +1,37 @@ # Generate Color Table -## Description ## +## Description 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 ## +## Parameters | Name | Type | Description | |-----------------|------|-------------------------------------------------------------------| | Selected Preset | JSON | The selected color preset, used to generate the color table array | -## Required Geometry ### +## Required Geometry# None -## Required Objects ## +## 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 ## +## Created Objects | Kind | Default Name | Type | Comp Dims | Description | |------|--------------|-------|-------------|---------------------------------------------------------| | Attribute Array | N/A | uint8 | (3) | RGB output color table array | -## Example Pipelines ## +## Example Pipelines -## License & Copyright ## +## License & Copyright Please see the description file distributed with this plugin. diff --git a/src/Plugins/ComplexCore/docs/GenerateColorTableFilter.rst b/src/Plugins/ComplexCore/docs/GenerateColorTableFilter.rst deleted file mode 100644 index 1804aaf9d5..0000000000 --- a/src/Plugins/ComplexCore/docs/GenerateColorTableFilter.rst +++ /dev/null @@ -1,56 +0,0 @@ -==================== -Generate Color Table -==================== - - -Description -=========== - -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 -=============== ============ ===== ========= ============================ - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/GenerateVectorColorsFilter.md b/src/Plugins/ComplexCore/docs/GenerateVectorColorsFilter.md index 9e1815ee4a..08d779a7e7 100644 --- a/src/Plugins/ComplexCore/docs/GenerateVectorColorsFilter.md +++ b/src/Plugins/ComplexCore/docs/GenerateVectorColorsFilter.md @@ -1,42 +1,42 @@ -# Generate Vector Colors # +# Generate Vector Colors -## Group (Subgroup) ## +## Group (Subgroup) Generic (Coloring) -## Description ## +## Description This **Filter** generates a color for each **Element** based on the vector assigned to that **Element** in the input vector data. The color scheme assigns a unique color to all points on the unit hemisphere using a HSV-like scheme. The color space is approximately represented by the following legend. ![Images/VectorColors](Images/VectorColors.png) -## Parameters ## +## 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 ## +## Required Geometry Not Applicable -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 ## +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| Kind | Default Name | Type | Comp Dims | Description | +|---------------------------|--------------|----------|--------|---------------------------------------------| | Element Attribute Array | Colors | uint8 | (3) | RGB colors | -## Example Pipelines ## +## Example Pipelines -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/ComplexCore/docs/GenerateVectorColorsFilter.rst b/src/Plugins/ComplexCore/docs/GenerateVectorColorsFilter.rst deleted file mode 100644 index ba0c5fb25a..0000000000 --- a/src/Plugins/ComplexCore/docs/GenerateVectorColorsFilter.rst +++ /dev/null @@ -1,69 +0,0 @@ -====================== -Generate Vector Colors -====================== - - -Group (Subgroup) -================ - -Generic (Coloring) - -Description -=========== - -This **Filter** generates a color for each **Element** based on the vector assigned to that **Element** in the input -vector data. The color scheme assigns a unique color to all points on the unit hemisphere using a HSV-like scheme. The -color space is approximately represented by the following legend. - -.. figure:: Images/VectorColors.png - :alt: Images/VectorColors - - Images/VectorColors - -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 -======================= ============ ===== ========== =========== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/IdentifySample.md b/src/Plugins/ComplexCore/docs/IdentifySample.md index 4c39472cc5..0145280cf2 100644 --- a/src/Plugins/ComplexCore/docs/IdentifySample.md +++ b/src/Plugins/ComplexCore/docs/IdentifySample.md @@ -25,7 +25,7 @@ If *Fill Holes* is set to *true*: ## Parameters | Name | Type | Description | -|------|------|-------------| +|------------|------| --------------------------------- | | Fill Holes in Largest Feature | bool | Whether to fill holes within sample after it is identified | ## Required Geometry @@ -34,8 +34,8 @@ Image ## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 diff --git a/src/Plugins/ComplexCore/docs/IdentifySample.rst b/src/Plugins/ComplexCore/docs/IdentifySample.rst deleted file mode 100644 index 3a8722583b..0000000000 --- a/src/Plugins/ComplexCore/docs/IdentifySample.rst +++ /dev/null @@ -1,94 +0,0 @@ -========================================= -Isolate Largest Feature (Identify Sample) -========================================= - - -Group (Subgroup) -================ - -Processing (Cleanup) - -Description -=========== - -Often when performing a serial sectioning experiment (especially in the FIB-SEM), the sample is *overscanned* resulting -in a border of *bad* data around the sample. This **Filter** attempts to *identify* the sample within the overscanned -volume. The **Filter** makes the assumption that there is only one contiguous set of **Cells** that belong to the -sample. The **Filter** requires that the user has already *thresheld* the data to determine which **Cells** are *good* -and which are *bad*. The algorithm for the identification of the sample is then as follows: - -1. Search for the largest contiguous set of *good* **Cells**. (This is assumed to be the sample) -2. Change all other *good* **Cells** to be *bad* **Cells**. (This removes the “speckling” of what was *thresheld* as - *good* data in the outer border region) - -If *Fill Holes* is set to *true*: 3. Search for the largest contiguous set of *bad* **Cells**. (This is assumed to be -the outer border region) 4. Change all other *bad* **Cells** to be *good* **Cells**. (This removes the “speckling” of -what was *thresheld* as *bad* data inside of the sample). - -*Note:* if there are in fact “holes” in the sample, then this **Filter** will “close” them (if *Fill Holes* is set to -true) by calling all the **Cells** “inside” the sample *good*. If the user wants to reidentify those holes, then reuse -the threshold **Filter** with the criteria of *GoodVoxels = 1* and whatever original criteria identified the “holes”, as -this will limit applying those original criteria to within the sample and not the outer border region. - -+------------------------------------+---------------------------------------------------------------------------------+ -| Name | Description | -+====================================+=================================================================================+ -| |Small IN100 IPF Map| | Good dataset to use this filter | -+------------------------------------+---------------------------------------------------------------------------------+ -| |APTR IPF Colors| | 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 - -Example Pipelines -================= - -- - - (10) SmallIN100 Full Reconstruction - -- INL Export - -- - - (3) SmallIN100 Alignment - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. - -.. |Small IN100 IPF Map| image:: Images/Small_IN100.png -.. |APTR IPF Colors| image:: Images/aptr12_001_0.png diff --git a/src/Plugins/ComplexCore/docs/ImageContouringFilter.md b/src/Plugins/ComplexCore/docs/ImageContouringFilter.md index 6c7b904804..21fa0c84c3 100644 --- a/src/Plugins/ComplexCore/docs/ImageContouringFilter.md +++ b/src/Plugins/ComplexCore/docs/ImageContouringFilter.md @@ -15,7 +15,7 @@ Here's what the results look like: ## Parameters | Name | Type | Description | -|------|------| ----------- | +|------------|------| --------------------------------- | | Contour value | float64 | This is the thresholding value that will be used to create the *Contouring Geometry* | ## Required Geometry @@ -24,8 +24,8 @@ Image ## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 diff --git a/src/Plugins/ComplexCore/docs/ImageContouringFilter.rst b/src/Plugins/ComplexCore/docs/ImageContouringFilter.rst deleted file mode 100644 index 9812d5b2a0..0000000000 --- a/src/Plugins/ComplexCore/docs/ImageContouringFilter.rst +++ /dev/null @@ -1,66 +0,0 @@ -========================== -Contour (Image Contouring) -========================== - - -Group (Subgroup) -================ - -Visual Analysis - -Description -=========== - -This filter will draw a 3 dimensional contouring line through an Image Geometry based on an input value. - -Here’s what the results look like: - -.. figure:: Images/3D-contouring.png - :alt: 3D-Contouring - - 3D-Contouring - -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 | Any | (1) | This is the array that will be parsed in order | -| | to Contour | | | 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 -======== =================== ============ =================================================================== - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM.3D Interaction -==================== - -If you need more help with a **Filter**, please consider asking your question on the `DREAM.3D Help -Forum! `__ diff --git a/src/Plugins/ComplexCore/docs/ImportBinaryCTNorthstarFilter.md b/src/Plugins/ComplexCore/docs/ImportBinaryCTNorthstarFilter.md index f1702a2ead..53574e396a 100644 --- a/src/Plugins/ComplexCore/docs/ImportBinaryCTNorthstarFilter.md +++ b/src/Plugins/ComplexCore/docs/ImportBinaryCTNorthstarFilter.md @@ -1,10 +1,10 @@ -# Import North Star Imaging CT File (Binary) # +# Import North Star Imaging CT File (Binary) -## Group (Subgroup) ## +## Group (Subgroup) IOFilters (Input) -## Description ## +## Description This **Filter** will import a NorthStar Imaging data set consisting of a single .nsihdr and one or more .nsidat files. The data is read into an Image Geometry. The user can import a subvolume instead of reading the entire data set into memory. @@ -12,33 +12,33 @@ 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 ## +## 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 ### +## Required Geometry# Not Applicable -## Required Objects ## +## Required Objects Not Applicable -## Created Objects ## +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | -## License & Copyright ## +## License & Copyright Please see the description file distributed with this plugin. diff --git a/src/Plugins/ComplexCore/docs/ImportBinaryCTNorthstarFilter.rst b/src/Plugins/ComplexCore/docs/ImportBinaryCTNorthstarFilter.rst deleted file mode 100644 index 281f984370..0000000000 --- a/src/Plugins/ComplexCore/docs/ImportBinaryCTNorthstarFilter.rst +++ /dev/null @@ -1,66 +0,0 @@ -========================================== -Import North Star Imaging CT File (Binary) -========================================== - - -Group (Subgroup) -================ - -IOFilters (Input) - -Description -=========== - -This **Filter** will import a NorthStar Imaging data set consisting of a single .nsihdr and one or more .nsidat files. -The data is read into an Image Geometry. The user can import a subvolume instead of reading the entire data set into -memory. - -The user should note that when using the subvolume feature that the ending voxels are **inclusive**. - -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 -================ ================= ================ ========== ============ - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/ImportCSVDataFilter.md b/src/Plugins/ComplexCore/docs/ImportCSVDataFilter.md index 68e7a49e17..f4c4d7826c 100644 --- a/src/Plugins/ComplexCore/docs/ImportCSVDataFilter.md +++ b/src/Plugins/ComplexCore/docs/ImportCSVDataFilter.md @@ -1,26 +1,26 @@ # Import CSV Data -## Group (Subgroup) ## +## Group (Subgroup) IO (Input) -## Description ## +## Description This **Filter** reads CSV data from any text-based file and imports the data into DREAM3D-NX-style arrays. The user uses the **Filter's** wizard to specify which file to import, how the data is formatted, what to call each array, and what type each array should be. *Note:* This **Filter** is intended to read data that is column-oriented, such that each created DREAM3D-NX array corresponds to a column of data in the CSV file. Therefore, this **Filter** will only import scalar arrays. If multiple columns are in fact different components of the same array, then the columns may be imported as separate arrays and then combined in the correct order using the Combine Attribute Arrays **Filter**. -### Separating the Data ### +### Separating the Data After clicking the **Import Data...** button and selecting a file, a wizard appears. The user can choose how the data is delimited: comma (,), tab, semicolon (;) or space ( ). The user may also elect to treat consecutive delimiters as one delimiter. ![Selecting how the data is separated](Images/Import_CSV_1.png) -### Selecting the Delimiter ### +### Selecting the Delimiter ![Selecting the delimiting character(s)](Images/Import_CSV_2.png) -### Selecting Import Rows, Data Representation and Column Headers ### +### Selecting Import Rows, Data Representation and Column Headers On the last page, the user can set the following information: @@ -36,36 +36,36 @@ 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 ## +## 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 ## +## Required Geometry Not Applicable -## Required Objects ## +## 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 ## +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | -## Example Pipelines ## +## Example Pipelines -## License & Copyright ## +## License & Copyright Please see the description file distributed with this plugin. diff --git a/src/Plugins/ComplexCore/docs/ImportCSVDataFilter.rst b/src/Plugins/ComplexCore/docs/ImportCSVDataFilter.rst deleted file mode 100644 index 494d9e20c0..0000000000 --- a/src/Plugins/ComplexCore/docs/ImportCSVDataFilter.rst +++ /dev/null @@ -1,139 +0,0 @@ -=============== -Import CSV Data -=============== - - -Group (Subgroup) -================ - -IO (Input) - -Description -=========== - -This **Filter** reads CSV data from any text-based file and imports the data into DREAM3D-NX-style arrays. The user uses -the **Filter’s** wizard to specify which file to import, how the data is formatted, what to call each array, and what -type each array should be. - -*Note:* This **Filter** is intended to read data that is column-oriented, such that each created DREAM3D-NX array -corresponds to a column of data in the CSV file. Therefore, this **Filter** will only import scalar arrays. If multiple -columns are in fact different components of the same array, then the columns may be imported as separate arrays and then -combined in the correct order using the Combine Attribute Arrays **Filter**. - -Separating the Data -------------------- - -After clicking the **Import Data…** button and selecting a file, a wizard appears. The user can choose how the data is -delimited: comma (,), tab, semicolon (;) or space ( ). The user may also elect to treat consecutive delimiters as one -delimiter. - -.. figure:: Images/Import_CSV_1.png - :alt: Selecting how the data is separated - - Selecting how the data is separated - -Selecting the Delimiter ------------------------ - -.. figure:: Images/Import_CSV_2.png - :alt: Selecting the delimiting character(s) - - Selecting the delimiting character(s) - -Selecting Import Rows, Data Representation and Column Headers -------------------------------------------------------------- - -On the last page, the user can set the following information: - -- Header names, either from a line number in the file or manually through a dialog box or select the generated header - values -- Row index to start the import -- Column data format (choosing the data type or deciding to skip the column) - -.. figure:: Images/Import_CSV_3.png - :alt: Setting Numerical Representations, Column Headers and other information - - Setting Numerical Representations, Column Headers and other information - -If the data does not have any headers, the user can set a string value for each column. These values will be used as the -name of the **Data Array** in DREAM3D-NX. - -.. figure:: Images/Import_CSV_4.png - :alt: Setting Names of each Column which will be used as the name of each **Attribute Array** - - Setting Names of each Column which will be used as the name of each **Attribute Array** - -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 | DataPath | The data path to the existing group where the imported | -| Existing Group - ON) | | arrays will be stored | -+---------------------------+---------------------------+-------------------------------------------------------------+ -| New Data Group (Use | DataPath | The data path to the newly created group where the imported | -| Existing Group - OFF) | | arrays will be stored | -+---------------------------+---------------------------+-------------------------------------------------------------+ - -Required Geometry -================= - -Not Applicable - -Required Objects -================ - -+------------+-------------------------------+------------+-----------------------------+-----------------------------+ -| Kind | Default Name | D | | | -| | | escription | | | -+============+===============================+============+=============================+=============================+ -| 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 | None | Any | 1 | One or more arrays that are created due to | -| \**El | | | | importing CSV data via the wizard | -| ement/Feature/Ensemble/etc. | | | | | -| Data Arrays | | | | | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/ImportDREAM3DFilter.md b/src/Plugins/ComplexCore/docs/ImportDREAM3DFilter.md index 52b9d92551..46680ae8de 100644 --- a/src/Plugins/ComplexCore/docs/ImportDREAM3DFilter.md +++ b/src/Plugins/ComplexCore/docs/ImportDREAM3DFilter.md @@ -1,32 +1,32 @@ # ImportDREAM3DFilter -## Description ## +## Description This **Filter** reads the data structure to an hdf5 file with the .dream3d extension. -## Parameters ## +## Parameters | Name | Type | Description | -|------|------|-------------| +|------------|------| --------------------------------- | | Import File Path | Filesystem Path | The file path the DataStructure should be read from as an HDF5 file. | -## Required Geometry ### +## Required Geometry# None -## Required Objects ## +## Required Objects None -## Created Objects ## +## Created Objects None -## Example Pipelines ## +## Example Pipelines ALL -## License & Copyright ## +## License & Copyright Please see the description file distributed with this plugin. diff --git a/src/Plugins/ComplexCore/docs/ImportDREAM3DFilter.rst b/src/Plugins/ComplexCore/docs/ImportDREAM3DFilter.rst deleted file mode 100644 index 50dbfa96df..0000000000 --- a/src/Plugins/ComplexCore/docs/ImportDREAM3DFilter.rst +++ /dev/null @@ -1,43 +0,0 @@ -=================== -ImportDREAM3DFilter -=================== - - -Description -=========== - -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 - -Example Pipelines -================= - -ALL - -License & Copyright -=================== - -Please see the description file distributed with this plugin. diff --git a/src/Plugins/ComplexCore/docs/ImportDeformKeyFileV12Filter.md b/src/Plugins/ComplexCore/docs/ImportDeformKeyFileV12Filter.md index 113013fde6..ba7a56557e 100644 --- a/src/Plugins/ComplexCore/docs/ImportDeformKeyFileV12Filter.md +++ b/src/Plugins/ComplexCore/docs/ImportDeformKeyFileV12Filter.md @@ -24,8 +24,8 @@ Not Applicable ## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | diff --git a/src/Plugins/ComplexCore/docs/ImportDeformKeyFileV12Filter.rst b/src/Plugins/ComplexCore/docs/ImportDeformKeyFileV12Filter.rst deleted file mode 100644 index 79bb656568..0000000000 --- a/src/Plugins/ComplexCore/docs/ImportDeformKeyFileV12Filter.rst +++ /dev/null @@ -1,56 +0,0 @@ -====================== -ImportDeformKeyFilev12 -====================== - - -Group (Subgroup) -================ - -SimulationIO (SimulationIO) - -Description -=========== - -This **Filter** reads DEFORM v12 key files and saves the data in a newly created **Data Container**. - -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 -================ ============= ======== ========== ======================================== - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/ImportHDF5Dataset.md b/src/Plugins/ComplexCore/docs/ImportHDF5Dataset.md index 30cf9ef53b..782d097702 100644 --- a/src/Plugins/ComplexCore/docs/ImportHDF5Dataset.md +++ b/src/Plugins/ComplexCore/docs/ImportHDF5Dataset.md @@ -1,10 +1,10 @@ # Import HDF5 Dataset -## Group (Subgroup) ## +## Group (Subgroup) Core (IO/Read) -## Description ## +## Description This **Filter** allows the user to import datasets from an HDF5 file and store them as attribute arrays in DREAM.3D. This filter supports importing datasets with any number of dimensions, as long as the created attribute array's total number of components and the tuple count of the destination attribute matrix multiply together to match the HDF5 dataset's total number of elements. @@ -14,7 +14,7 @@ The component dimensions are input as a comma-delimited list of dimensional valu 2. 5, 2, 1 = 5x2x1 3. 6 = 6 -### Examples ### +### Examples 1. Suppose we have a 1D dataset in an HDF5 file with dimension **12,000**. We can input component dimensions of **5, 2, 2** and set the destination attribute matrix tuple dimensions to **35 x 5 x 2 x 2** @@ -37,33 +37,33 @@ We can input component dimensions of **2** and set our destination attribute mat ![Example Image](Images/ImportHDF5Dataset_ui.png) -## Parameters ## +## 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 ## +## Required Geometry Not Applicable -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| Kind | Default Name | Type | Comp Dims | Description | +|---------------------------|--------------|----------|--------|---------------------------------------------| | Attribute Matrix** | None | DataArrayPath | N/A | Attribute Matrix** used to store imported data | -## Created Objects ## +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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) | -## Example Pipelines ## +## Example Pipelines -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/ComplexCore/docs/ImportHDF5Dataset.rst b/src/Plugins/ComplexCore/docs/ImportHDF5Dataset.rst deleted file mode 100644 index 95faf79a5e..0000000000 --- a/src/Plugins/ComplexCore/docs/ImportHDF5Dataset.rst +++ /dev/null @@ -1,106 +0,0 @@ -=================== -Import HDF5 Dataset -=================== - - -Group (Subgroup) -================ - -Core (IO/Read) - -Description -=========== - -This **Filter** allows the user to import datasets from an HDF5 file and store them as attribute arrays in DREAM.3D. -This filter supports importing datasets with any number of dimensions, as long as the created attribute array’s total -number of components and the tuple count of the destination attribute matrix multiply together to match the HDF5 -dataset’s total number of elements. - -The component dimensions are input as a comma-delimited list of dimensional values. For example: - -1. 3, 4 = 3x4 -2. 5, 2, 1 = 5x2x1 -3. 6 = 6 - -Examples --------- - -1. Suppose we have a 1D dataset in an HDF5 file with dimension **12,000**. We can input component dimensions of **5, 2, - 2** and set the destination attribute matrix tuple dimensions to **35 x 5 x 2 x 2** - -- The total number of elements for the HDF5 dataset is 12,000. -- The total number of tuples in the destination attribute matrix is 35*5*2*2 = 700. -- The total number of components for the created attribute array is 5*2*2 = 20. -- The total number of elements for the created attribute array will be 700*20 = 14,000. - -14,000 does not equal 12,000, so this will result in a preflight error. - -2. Suppose we have a 3D dataset in an HDF5 file with dimensions **1 x 16 x 1001 x 1001**. We can input component - dimensions of **2** and set our destination attribute matrix tuple dimensions to **134 x 67**. - -- The total number of elements for the HDF5 dataset is 1*16*1001*1001 = 16,032,016. -- The total number of tuples in the destination attribute matrix is 8*1001*1001 = 8,016,008. -- The total number of components for the created attribute array is 2. -- The total number of elements for the created attribute array will be 8,016,008*2 = 16,032,016. -- The total number of elements of the created attribute array (16,032,016) equals the total number of elements of the - HDF5 dataset (16,032,016), so we can import this dataset without errors (see below). - -.. figure:: Images/ImportHDF5Dataset_ui.png - :alt: Example Image - - Example Image - -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 | Type | Input as a | The created Attribute Array(s) | -| | dataset(s) | from | filter | | -| | from HDF5 | HDF5 | parameter | | -| | file | file | | | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/ImportTextFilter.md b/src/Plugins/ComplexCore/docs/ImportTextFilter.md index 149dbd5ec7..6ec86d97ec 100644 --- a/src/Plugins/ComplexCore/docs/ImportTextFilter.md +++ b/src/Plugins/ComplexCore/docs/ImportTextFilter.md @@ -1,12 +1,12 @@ # Import ASCII Attribute Array -## Group (Subgroup) ## +## Group (Subgroup) Core (IO/Read) -## Description ## +## Description This **Filter** allows the user to import a plain text file containing the contents of a single Attribute Array. The delimeters can be one of the following: @@ -22,7 +22,7 @@ The filter does not care about how many values per line but only about reading t + Create AttributeMatrix: Give the AttributeMatrix a name and set the tuple dimensions to match the number of values in the input file. + OPTIONAL: If the data exists as a regular set of data on a grid then the user can also use the "Create Geometry (Image)" filter before importing the data. -### Example Data ### +### Example Data The example data below has 50 elements. This means that it could successfully be read into an array that has 10 Tuples and 5 Componenets or 50 Tuples and 1 Component. The AttributeMatrix would need to have dimensions such that mulplying all the dimensions together yields 50. For example the AttributeMatrix could have X=5, Y=5 and Z=2 or X=10, Y=5 and Z=1. This filter does not require any type of Geometry as the filter is reading data directly into an array. @@ -35,7 +35,7 @@ The example data below has 50 elements. This means that it could successfully be ![](Images/ImportAsciDataArray_ui.png) -### Scalar Types ### +### Scalar Types | Value | Type | |--|------| @@ -50,7 +50,7 @@ The example data below has 50 elements. This means that it could successfully be | 8 | Float 32 bit | | 9 | Double 64 bit | -### Delimeter Types ### +### Delimeter Types | Value | Type | |--|------| @@ -62,10 +62,10 @@ The example data below has 50 elements. This means that it could successfully be -## Parameters ## +## 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. | @@ -73,27 +73,27 @@ The example data below has 50 elements. This means that it could successfully be | Delimeter | int | See Table above | -## Required Geometry ## +## Required Geometry Not Applicable -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| Kind | Default Name | Type | Comp Dims | Description | +|---------------------------|--------------|----------|--------|---------------------------------------------| | Attribute Matrix** | None | DataArrayPath | N/A | Attribute Matrix** to store imported data into | -## Created Objects ## +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| Kind | Default Name | Type | Comp Dims | Description | +|---------------------------|--------------|----------|--------|---------------------------------------------| | Attribute Array | N/A | See Table above | based on number of components | The created Attribute Array | -## Example Pipelines ## +## Example Pipelines -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/ComplexCore/docs/ImportTextFilter.rst b/src/Plugins/ComplexCore/docs/ImportTextFilter.rst deleted file mode 100644 index e4c86128ee..0000000000 --- a/src/Plugins/ComplexCore/docs/ImportTextFilter.rst +++ /dev/null @@ -1,132 +0,0 @@ -============================ -Import ASCII Attribute Array -============================ - - -Group (Subgroup) -================ - -Core (IO/Read) - -Description -=========== - -This **Filter** allows the user to import a plain text file containing the contents of a single Attribute Array. The -delimeters can be one of the following: - -:: - - + comma - + semicolon - + space - + colon - + tab - -The filter does not care about how many values per line but only about reading the proper number of values from the -file. If you are trying to read an array into DREAM.3D and there is no existing DataContainer or anything else to hold -the data then the user will need to insert the following filters **BEFORE** using this filter: - -:: - - + Create DataContainer: Give the DataContainer a name - + Create AttributeMatrix: Give the AttributeMatrix a name and set the tuple dimensions to match the number of values in the input file. - + OPTIONAL: If the data exists as a regular set of data on a grid then the user can also use the "Create Geometry (Image)" filter before importing the data. - -Example Data ------------- - -The example data below has 50 elements. This means that it could successfully be read into an array that has 10 Tuples -and 5 Componenets or 50 Tuples and 1 Component. The AttributeMatrix would need to have dimensions such that mulplying -all the dimensions together yields 50. For example the AttributeMatrix could have X=5, Y=5 and Z=2 or X=10, Y=5 and Z=1. -This filter does not require any type of Geometry as the filter is reading data directly into an array. - -:: - - 0 1 2 3 4 5 6 7 8 9 - 10 11 12 13 14 15 16 17 18 19 - 20 21 22 23 24 25 26 27 28 29 - 30 31 32 33 34 35 36 37 38 39 - 40 41 42 43 44 45 46 47 48 49 - -.. image:: Images/ImportAsciDataArray_ui.png - -Scalar Types ------------- - -===== =================== -Value Type -===== =================== -0 signed int 8 bit -1 unsigned int 8 bit -2 signed int 16 bit -3 unsigned int 16 bit -4 signed int 32 bit -5 unsigned int 32 bit -6 signed int 64 bit -7 unsigned int 64 bit -8 Float 32 bit -9 Double 64 bit -===== =================== - -Delimeter Types ---------------- - -===== ========= -Value Type -===== ========= -0 comma -1 semicolon -2 space -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 -=============== ============ =============== ============================= =========================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/ImportVolumeGraphicsFileFilter.md b/src/Plugins/ComplexCore/docs/ImportVolumeGraphicsFileFilter.md index c2dae26efe..34d319fbff 100644 --- a/src/Plugins/ComplexCore/docs/ImportVolumeGraphicsFileFilter.md +++ b/src/Plugins/ComplexCore/docs/ImportVolumeGraphicsFileFilter.md @@ -1,39 +1,39 @@ -# Import Volume Graphics Files (.vgi, .vol) # +# Import Volume Graphics Files (.vgi, .vol) -## Group (Subgroup) ## +## Group (Subgroup) Import/Export -## Description ## +## Description 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 ## +## 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 ### +## Required Geometry# Not Applicable -## Required Objects ## +## Required Objects Not Applicable -## Created Objects ## +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | -## License & Copyright ## +## License & Copyright Please see the description file distributed with this plugin. diff --git a/src/Plugins/ComplexCore/docs/ImportVolumeGraphicsFileFilter.rst b/src/Plugins/ComplexCore/docs/ImportVolumeGraphicsFileFilter.rst deleted file mode 100644 index 8218ab0916..0000000000 --- a/src/Plugins/ComplexCore/docs/ImportVolumeGraphicsFileFilter.rst +++ /dev/null @@ -1,60 +0,0 @@ -========================================= -Import Volume Graphics Files (.vgi, .vol) -========================================= - - -Group (Subgroup) -================ - -Import/Export - -Description -=========== - -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 -======================= ============== ===================== ========== =========== - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/InitializeData.md b/src/Plugins/ComplexCore/docs/InitializeData.md index 12435494c4..0e226f6a20 100644 --- a/src/Plugins/ComplexCore/docs/InitializeData.md +++ b/src/Plugins/ComplexCore/docs/InitializeData.md @@ -1,18 +1,18 @@ # Initialize Data -## Group (Subgroup) ## +## Group (Subgroup) Processing (Cleanup) -## Description ## +## Description 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 ## +## 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 | @@ -20,25 +20,25 @@ This **Filter** allows the user to define a subvolume of the data set in which t | Y Max | int32_t | Maximum Y bound in **Cells | | Z Max | int32_t | Maximum Z bound in **Cells | -## Required Geometry ## +## Required Geometry Image -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 ## +## Created Objects None -## Example Pipelines ## +## Example Pipelines -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/ComplexCore/docs/InitializeData.rst b/src/Plugins/ComplexCore/docs/InitializeData.rst deleted file mode 100644 index 6f67d90929..0000000000 --- a/src/Plugins/ComplexCore/docs/InitializeData.rst +++ /dev/null @@ -1,62 +0,0 @@ -=============== -Initialize Data -=============== - - -Group (Subgroup) -================ - -Processing (Cleanup) - -Description -=========== - -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 - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/InterpolatePointCloudToRegularGridFilter.md b/src/Plugins/ComplexCore/docs/InterpolatePointCloudToRegularGridFilter.md index 2e30ade4a6..77983ed81e 100644 --- a/src/Plugins/ComplexCore/docs/InterpolatePointCloudToRegularGridFilter.md +++ b/src/Plugins/ComplexCore/docs/InterpolatePointCloudToRegularGridFilter.md @@ -1,11 +1,11 @@ Interpolate Point Cloud to Regular Grid ============= -## Group (Subgroup) ## +## Group (Subgroup) Sampling (Interpolation) -## Description ## +## Description This **Filter** interpolates the values of arrays stored in a **Vertex Geometry** onto a user-selected **Image Geometry**. The user defines the (x,y,z) radii of a kernel in *real space units*. This kernel can be intialized to either *uniform* or *Gaussian*. The interpolation algorithm proceeds as follows: @@ -17,36 +17,36 @@ 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 ## +## 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 ### +## Required Geometry# Vertex and Image -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 ## +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| Kind | Default Name | Type | Comp Dims | Description | +|---------------------------|--------------|----------|--------|---------------------------------------------| | Attribute Matrix | InterpolatedAttributeMatrix | Cell | N/A | Attribute Matrix** that stores the interpolated **Attribute Arrays | -## License & Copyright ## +## License & Copyright Please see the description file distributed with this plugin. diff --git a/src/Plugins/ComplexCore/docs/InterpolatePointCloudToRegularGridFilter.rst b/src/Plugins/ComplexCore/docs/InterpolatePointCloudToRegularGridFilter.rst deleted file mode 100644 index 9674502368..0000000000 --- a/src/Plugins/ComplexCore/docs/InterpolatePointCloudToRegularGridFilter.rst +++ /dev/null @@ -1,92 +0,0 @@ -======================================= -Interpolate Point Cloud to Regular Grid -======================================= - - -Group (Subgroup) -================ - -Sampling (Interpolation) - -Description -=========== - -This **Filter** interpolates the values of arrays stored in a **Vertex Geometry** onto a user-selected **Image -Geometry**. The user defines the (x,y,z) radii of a kernel in *real space units*. This kernel can be intialized to -either *uniform* or *Gaussian*. The interpolation algorithm proceeds as follows: - -1. The kernel radii defined by the user in real space units are converted into voxel units, based on the spacing of the - supplied **Image Geometry**. -2. The kernel is centered on each vertex in the **Vertex Geometry**. -3. The values of each **Attribute Array** on the centered vertex are associated to each voxel intersected by the kernel. - This stored value is multiplied by the value of the kernel. - -The result of the above approach is a list of data at each voxel in the **Image Geometry** for each interpolated -**Attribute Array**. These lists may be of different lengths within each voxel, since the kernels from each point may -overlap. This duplication may result in significant memory usage if the number of points is large; the user may select a -subset of arrays to interpolate to alleviate this issue. Note that all arrays selected for interpolation must be scalar. - -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 | Int | Cell | N/A | Attribute Matrix*\* that stores the | -| | erpolatedAtt | | | interpolated \**Attribute Arrays | -| | ributeMatrix | | | | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/IterativeClosestPointFilter.md b/src/Plugins/ComplexCore/docs/IterativeClosestPointFilter.md index 1e2aa2420b..ac2b97e391 100644 --- a/src/Plugins/ComplexCore/docs/IterativeClosestPointFilter.md +++ b/src/Plugins/ComplexCore/docs/IterativeClosestPointFilter.md @@ -1,10 +1,10 @@ # IterativeClosestPoint -## Group (Subgroup) ## +## Group (Subgroup) Reconstruction (Alignment) -## Description ## +## Description This **Filter** estimates the rigid body transformation (i.e., rotation and translation) between two sets of points represted by **Vertex Geometries** using the *iterative closest point* (ICP) algorithm. The two **Vertex Geometries** are not required to have the same number of points. The **Filter** first initializes temporary storage for each set of points and a global transformation. Then, the alignment algorithm iterates through the following steps: @@ -17,37 +17,37 @@ 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 ## +## 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 ## +## Required Geometry Vertex -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 ## +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | -## Example Pipelines ## +## Example Pipelines -## License & Copyright ## +## License & Copyright Please see the description file distributed with this plugin. diff --git a/src/Plugins/ComplexCore/docs/IterativeClosestPointFilter.rst b/src/Plugins/ComplexCore/docs/IterativeClosestPointFilter.rst deleted file mode 100644 index 68485e8307..0000000000 --- a/src/Plugins/ComplexCore/docs/IterativeClosestPointFilter.rst +++ /dev/null @@ -1,82 +0,0 @@ -===================== -IterativeClosestPoint -===================== - - -Group (Subgroup) -================ - -Reconstruction (Alignment) - -Description -=========== - -This **Filter** estimates the rigid body transformation (i.e., rotation and translation) between two sets of points -represted by **Vertex Geometries** using the *iterative closest point* (ICP) algorithm. The two **Vertex Geometries** -are not required to have the same number of points. The **Filter** first initializes temporary storage for each set of -points and a global transformation. Then, the alignment algorithm iterates through the following steps: - -1. The closest point in the target geometry is determined for each point in the moving geoemetry; these are called the - correspondence points. “Closeness” is measured based on Euclidean distance. -2. The rigid body transformation between the moving and target correspondences is solved for analytically using least - squares. -3. The above transformation is applied to the moving points. -4. The global transformation is updated with the transformation computed for the current iteration. - -Iterations proceed for a fixed number of user-defined steps. The final rigid body transformation is stored as a 4x4 -transformation matrix in row-major order. The user has the option to apply this transformation to the moving **Vertex -Geometry**. Note that this transformation is applied to the moving geometry *in place* if the option is selected. - -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 | TransformAtt | Generic | N/A | Attribute Matrix*\* that stores the computed | -| | ributeMatrix | | | transformation | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Attribute Array | Transform | float | (4, 4) | Computed transformation matrix | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/KMeansFilter.md b/src/Plugins/ComplexCore/docs/KMeansFilter.md index 6ec8b93704..a915dde510 100644 --- a/src/Plugins/ComplexCore/docs/KMeansFilter.md +++ b/src/Plugins/ComplexCore/docs/KMeansFilter.md @@ -1,10 +1,10 @@ -# K Means # +# K Means -## Group (Subgroup) ## +## Group (Subgroup) DREAM3D Review (Clustering) -## Description ## +## Description ***Warning:* The randomnes in this filter is not currently consistent between operating systems even if the same seed is used. Specifically between Unix and Windows. This does not affect the results, but the IDs will not correspond. For example if the Cluster Identifier at index one on Linux is 1 it could be 2 on Windows, the overarching clusters will be the same, but their IDs will be different.** @@ -20,7 +20,7 @@ Optimal solutions to the k means partitioning problem are computationally diffic Convergence is defined as when the computed means change very little (precisely, when the differences are within machine epsilon). Since Lloyd's algorithm is iterative, it only serves as an approximation, and may result in different classifications on each execution with the same input data. The user may opt to use a mask to ignore certain points; where the mask is _false_, the points will be placed in cluster 0. -A clustering algorithm can be considered a kind of segmentation; this implementation of k means does not rely on the **Geometry** on which the data lie, only the *topology* of the space that the array itself forms. Therefore, this **Filter** has the effect of creating either **Features** or **Ensembles** depending on the kind of array passed to it for clustering. If an **Element** array (e.g., voxel-level **Cell** data) is passed to the **Filter**, then **Features** are created (in the previous example, a **Cell Feature Attribute Matrix** will be created). If a **Feature** array is passed to the **Filter**, then an **Ensemble Attribute Matrix** is created. The following table shows what type of **Attribute Matrix** is created based on what sort of array is used for clustering: +A clustering algorithm can be considered a kind of segmentation; this implementation of k means does not rely on the **Geometry** on which the data lie, only the *topology* of the space that the array itself forms. Therefore, this **Filter** has the effect of creating either **Features** or **Ensembles** depending on the kind of array passed to it for clustering. If an **Element** array (e.g., voxel-level **Cell** data) is passed to the **Filter**, then **Features** are created (in the previous example, a **Cell Feature Attribute Matrix** will be created). If a **Feature** array is passed to the **Filter**, then an Ensemble Attribute Matrix** is created. The following table shows what type of **Attribute Matrix** is created based on what sort of array is used for clustering: | Attribute Matrix Source | Attribute Matrix Created | |------------------|--------------------| @@ -40,40 +40,40 @@ 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 ## +## 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 ### +## Required Geometry# None -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 ## +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | -## References ## +## References [1] Least squares quantization in PCM, S.P. Lloyd, IEEE Transactions on Information Theory, vol. 28 (2), pp. 129-137, 1982. -## Example Pipelines ## +## Example Pipelines -## License & Copyright ## +## License & Copyright Please see the description file distributed with this plugin. diff --git a/src/Plugins/ComplexCore/docs/KMeansFilter.rst b/src/Plugins/ComplexCore/docs/KMeansFilter.rst deleted file mode 100644 index 83dac3c072..0000000000 --- a/src/Plugins/ComplexCore/docs/KMeansFilter.rst +++ /dev/null @@ -1,135 +0,0 @@ -======= -K Means -======= - - -Group (Subgroup) -================ - -DREAM3D Review (Clustering) - -Description -=========== - -**Warning: The randomnes in this filter is not currently consistent between operating systems even if the same seed is -used. Specifically between Unix and Windows. This does not affect the results, but the IDs will not correspond. For -example if the Cluster Identifier at index one on Linux is 1 it could be 2 on Windows, the overarching clusters will be -the same, but their IDs will be different.** - -This **Filter** applies the k means algorithm to an **Attribute Array**. K means is a *clustering algorithm* that -assigns to each point of the **Attribute Array** a *cluster Id*. The user must specify the number of clusters in which -to partition the array. Specifically, a k means partitioning is a *Voronoi tesselation*; an optimal solution to the k -means problem is such that each point in the data set is associated with the cluster that has the closest mean. This -partitioning is the one that minimizes the within cluster variance (i.e., minimizes the within cluster sum of squares -differences). Thus, the “metric” used for k means is the 2-norm (the *Euclidean norm*; the squared Euclidean norm may -also be used since this maintains the triangle inequality). - -Optimal solutions to the k means partitioning problem are computationally difficult; this **Filter** used *Lloyd’s -algorithm* to approximate the solution. Lloyd’s algorithm is an iterative algorithm that proceeds as follows: - -1. Choose k points at random to serve as the initial cluster “means” -2. Until convergence, repeat the following steps: - -- Associate each point with the closest mean, where “closest” is the smallest 2-norm distance -- Recompute the means based on the new tesselation - -Convergence is defined as when the computed means change very little (precisely, when the differences are within machine -epsilon). Since Lloyd’s algorithm is iterative, it only serves as an approximation, and may result in different -classifications on each execution with the same input data. The user may opt to use a mask to ignore certain points; -where the mask is *false*, the points will be placed in cluster 0. - -A clustering algorithm can be considered a kind of segmentation; this implementation of k means does not rely on the -**Geometry** on which the data lie, only the *topology* of the space that the array itself forms. Therefore, this -**Filter** has the effect of creating either **Features** or **Ensembles** depending on the kind of array passed to it -for clustering. If an **Element** array (e.g., voxel-level **Cell** data) is passed to the **Filter**, then **Features** -are created (in the previous example, a **Cell Feature Attribute Matrix** will be created). If a **Feature** array is -passed to the **Filter**, then an **Ensemble Attribute Matrix** is created. The following table shows what type of -**Attribute Matrix** is created based on what sort of array is used for clustering: - -======================= ======================== -Attribute Matrix Source Attribute Matrix Created -======================= ======================== -Generic Generic -Vertex Vertex Feature -Edge Edge Feature -Face Face Feature -Cell Cell Feature -Vertex Feature Vertex Ensemble -Edge Feature Edge Ensemble -Face Feature Face Ensemble -Cell Feature Cell Ensemble -Vertex Ensemble Vertex Ensemble -Edge Ensemble Edge Ensemble -Face Ensemble Face Ensemble -Cell Ensemble Cell Ensemble -======================= ======================== - -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/ | N/A | The **Attribute Matrix** in which to store | -| | | Ensemble | | 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 | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -References -========== - -[1] Least squares quantization in PCM, S.P. Lloyd, IEEE Transactions on Information Theory, vol. 28 (2), pp. 129-137, -1982. - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/KMedoidsFilter.md b/src/Plugins/ComplexCore/docs/KMedoidsFilter.md index 18f1262644..b8d9abe279 100644 --- a/src/Plugins/ComplexCore/docs/KMedoidsFilter.md +++ b/src/Plugins/ComplexCore/docs/KMedoidsFilter.md @@ -1,10 +1,10 @@ -# K Medoids # +# K Medoids -## Group (Subgroup) ## +## Group (Subgroup) DREAM3D Review (Clustering) -## Description ## +## Description ***Warning:* The randomnes in this filter is not currently consistent between operating systems even if the same seed is used. Specifically between Unix and Windows. This does not affect the results, but the IDs will not correspond. For example if the Cluster Identifier at index one on Linux is 1 it could be 2 on Windows, the overarching clusters will be the same, but their IDs will be different.** @@ -21,7 +21,7 @@ This **Filter** uses the *Voronoi iteration* algorithm to produce the clustering Convergence is defined as when the medoids no longer change position. Since the algorithm is iterative, it only serves as an approximation, and may result in different classifications on each execution with the same input data. The user may opt to use a mask to ignore certain points; where the mask is _false_, the points will be placed in cluster 0. -A clustering algorithm can be considered a kind of segmentation; this implementation of k medoids does not rely on the **Geometry** on which the data lie, only the *topology* of the space that the array itself forms. Therefore, this **Filter** has the effect of creating either **Features** or **Ensembles** depending on the kind of array passed to it for clustering. If an **Element** array (e.g., voxel-level **Cell** data) is passed to the **Filter**, then **Features** are created (in the previous example, a **Cell Feature Attribute Matrix** will be created). If a **Feature** array is passed to the **Filter**, then an **Ensemble Attribute Matrix** is created. The following table shows what type of **Attribute Matrix** is created based on what sort of array is used for clustering: +A clustering algorithm can be considered a kind of segmentation; this implementation of k medoids does not rely on the **Geometry** on which the data lie, only the *topology* of the space that the array itself forms. Therefore, this **Filter** has the effect of creating either **Features** or **Ensembles** depending on the kind of array passed to it for clustering. If an **Element** array (e.g., voxel-level **Cell** data) is passed to the **Filter**, then **Features** are created (in the previous example, a **Cell Feature Attribute Matrix** will be created). If a **Feature** array is passed to the **Filter**, then an Ensemble Attribute Matrix** is created. The following table shows what type of **Attribute Matrix** is created based on what sort of array is used for clustering: | Attribute Matrix Source | Attribute Matrix Created | |------------------|--------------------| @@ -41,40 +41,40 @@ 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 ## +## 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 ### +## Required Geometry# None -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 ## +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | -## References ## +## References [1] A simple and fast algorithm for K-medoids clustering, H.S. Park and C.H. Jun, Expert Systems with Applications, vol. 28 (2), pp. 3336-3341, 2009. -## Example Pipelines ## +## Example Pipelines -## License & Copyright ## +## License & Copyright Please see the description file distributed with this plugin. diff --git a/src/Plugins/ComplexCore/docs/KMedoidsFilter.rst b/src/Plugins/ComplexCore/docs/KMedoidsFilter.rst deleted file mode 100644 index e5cdf20574..0000000000 --- a/src/Plugins/ComplexCore/docs/KMedoidsFilter.rst +++ /dev/null @@ -1,136 +0,0 @@ -========= -K Medoids -========= - - -Group (Subgroup) -================ - -DREAM3D Review (Clustering) - -Description -=========== - -**Warning: The randomnes in this filter is not currently consistent between operating systems even if the same seed is -used. Specifically between Unix and Windows. This does not affect the results, but the IDs will not correspond. For -example if the Cluster Identifier at index one on Linux is 1 it could be 2 on Windows, the overarching clusters will be -the same, but their IDs will be different.** - -This **Filter** applies the k medoids algorithm to an **Attribute Array**. K medoids is a *clustering algorithm* that -assigns to each point of the **Attribute Array** a *cluster Id*. The user must specify the number of clusters in which -to partition the array. Specifically, a k medoids partitioning is such that each point in the data set is associated -with the cluster that minimizes the sum of the pair-wise distances between the data points and their associated cluster -centers (medoids). This approach is analogous to k means, but uses actual data points (the medoids) as the cluster -exemplars instead of the means. Medoids in this context refer to the data point in each cluster that is most like all -other data points, i.e., that data point whose average distance to all other data points in the cluster is smallest. -Unlike k means, since pair-wise distances are minimized instead of variance, any arbirtary concept of “distance” may be -used; this **Filter** allows for the selection of a variety of distance metrics. - -This **Filter** uses the *Voronoi iteration* algorithm to produce the clustering. The algorithm is iterative and -proceeds as follows: - -1. Choose k points at random to serve as the initial cluster medoids -2. Associate each point to the closest medoid -3. Until convergence, repeat the following steps: - -- For each cluster, change the medoid to the point in that cluster that minimizes the sum of distances between that - point and all other points in the cluster -- Reassign each point to the closest medoid - -Convergence is defined as when the medoids no longer change position. Since the algorithm is iterative, it only serves -as an approximation, and may result in different classifications on each execution with the same input data. The user -may opt to use a mask to ignore certain points; where the mask is *false*, the points will be placed in cluster 0. - -A clustering algorithm can be considered a kind of segmentation; this implementation of k medoids does not rely on the -**Geometry** on which the data lie, only the *topology* of the space that the array itself forms. Therefore, this -**Filter** has the effect of creating either **Features** or **Ensembles** depending on the kind of array passed to it -for clustering. If an **Element** array (e.g., voxel-level **Cell** data) is passed to the **Filter**, then **Features** -are created (in the previous example, a **Cell Feature Attribute Matrix** will be created). If a **Feature** array is -passed to the **Filter**, then an **Ensemble Attribute Matrix** is created. The following table shows what type of -**Attribute Matrix** is created based on what sort of array is used for clustering: - -======================= ======================== -Attribute Matrix Source Attribute Matrix Created -======================= ======================== -Generic Generic -Vertex Vertex Feature -Edge Edge Feature -Face Face Feature -Cell Cell Feature -Vertex Feature Vertex Ensemble -Edge Feature Edge Ensemble -Face Feature Face Ensemble -Cell Feature Cell Ensemble -Vertex Ensemble Vertex Ensemble -Edge Ensemble Edge Ensemble -Face Ensemble Face Ensemble -Cell Ensemble Cell Ensemble -======================= ======================== - -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/ | N/A | The **Attribute Matrix** in which to store | -| | | Ensemble | | 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 | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -References -========== - -[1] A simple and fast algorithm for K-medoids clustering, H.S. Park and C.H. Jun, Expert Systems with Applications, -vol. 28 (2), pp. 3336-3341, 2009. - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/LaplacianSmoothingFilter.md b/src/Plugins/ComplexCore/docs/LaplacianSmoothingFilter.md index 8ed19b386d..188a60f7b8 100644 --- a/src/Plugins/ComplexCore/docs/LaplacianSmoothingFilter.md +++ b/src/Plugins/ComplexCore/docs/LaplacianSmoothingFilter.md @@ -1,11 +1,11 @@ # Laplacian Smoothing -## Group (Subgroup) ## +## Group (Subgroup) Surface Meshing (Smoothing) -## Description ## +## Description This **Filter** applies Laplacian smoothing to a **Triangle Geometry** that represents a surface mesh. A. Belyaev [2] has a concise explanation of the Laplacian Smoothing as follows: @@ -38,11 +38,11 @@ If λ is too small, one needs more iterations for smoothing and the smooth In the Laplacian algorithm the λ term has a range of 0 ≤ λ ≤ 1 and defines a relative distance that a node can move relative to the positions of the nodes neighbors. A λ = 0 value will effectively stop those node types from any movement during the algorithm thus by allowing the user to set this value for specific types of nodes the user can arrest the shrinkage of the surface mesh during the smoothing process. -### Taubin's Lambda-Mu Smoothing Algorithm ## +### Taubin's Lambda-Mu Smoothing Algorithm One of the options for the filter allows the user to apply Taubin's Lambda-Mu variation on Laplacian smoothing. This variation removes the shrinkage typically found with Laplacian smoothing by adding an additional step within each iteration where the negative of the (Lambda value \* Mu Factor) which effectively moves the points in the **opposite** direction from the initial movement. Because of this negative movement the number of iterations to achieve the same level of smoothing is greatly increased, on the order of 10x to 20x. -### Algorithm Usage and Memory Requirements ### +### Algorithm Usage and Memory Requirements Currently, if you lock the *Default Lambda* value to zero (0), the triple lines and quadruple points will not be able to move because none of their neighbors can move. The user may want to consider allowing a small value of λ for the default nodes which will allow some movement of the triple lines and/or quadruple Points. @@ -72,10 +72,10 @@ The values for the *Node Type* array can take one of the following values. For more information on surface meshing, visit the tutorial. -## Parameters ## +## 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. | @@ -86,33 +86,33 @@ For more information on surface meshing, visit the tutorial. | 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 ## +## Required Geometry Triangle -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | FaceLabels | int32_t | (2) | Specifies which **Features** are on either side of each Face | -## Created Objects ## +## Created Objects None -## References ## +## References [1] D. A. Feature, (1988) Laplacian smoothing and Delaunay triangulations. Commun. appl. numer. methods, 4: 709 712. doi: 10.1002/cnm.1630040603 [2] A. Belyaev, Mesh smoothing and enhancing curvature estimation, [http://www.mpi-inf.mpg.de/ ag4-gm/handouts/06gm_surf3.pdf](http://www.mpi-inf.mpg.de/ ag4-gm/handouts/06gm_surf3.pdf). -## Example Pipelines ## +## Example Pipelines + (02) SmallIN100 Smooth Mesh -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/ComplexCore/docs/LaplacianSmoothingFilter.rst b/src/Plugins/ComplexCore/docs/LaplacianSmoothingFilter.rst deleted file mode 100644 index 70d44f874a..0000000000 --- a/src/Plugins/ComplexCore/docs/LaplacianSmoothingFilter.rst +++ /dev/null @@ -1,177 +0,0 @@ -=================== -Laplacian Smoothing -=================== - - -Group (Subgroup) -================ - -Surface Meshing (Smoothing) - -Description -=========== - -This **Filter** applies Laplacian smoothing to a **Triangle Geometry** that represents a surface mesh. A. Belyaev [2] -has a concise explanation of the Laplacian Smoothing as follows: - --------------- - -Let us consider a triangulated surface and for any vertex P let us define the so-called umbrella-operator - -.. image:: Images/Laplacian_Fig1.png - -where summation is taken over all neighbors of P and wi are positive weights. See Fig. 1 for the geometric idea behind -the umbrella-operator. - -.. image:: Images/Laplacian_Fig2.png - -The weights, can be defined, for example, as the inverse distances between P and its neighbors. The simplest -umbrella-operator is obtained if *w* i = 1 and the umbrella-operator has the form - -.. image:: Images/Laplacian_Eq1.png - -where n is the number of neighbors. The local update rule - -.. image:: Images/Laplacian_Eq2.png - -applied to every point of the triangulated surface is called Laplacian smoothing of the surface. Typically the factor λ -is a small positive number, and the process (2) is executed repeatedly. The Laplacian smoothing algorithm reduces the -high frequency surface information and tends to flatten the surface. See Fig. 2 where Laplacian smoothing is applied to -a triangulated model of a Noh mask. - -If λ is too small, one needs more iterations for smoothing and the smoothing process becomes time-consuming. If λ is not -small enough, the smoothing process becomes unstable. - --------------- - -In the Laplacian algorithm the λ term has a range of 0 ≤ λ ≤ 1 and defines a relative distance that a node can move -relative to the positions of the nodes neighbors. A λ = 0 value will effectively stop those node types from any movement -during the algorithm thus by allowing the user to set this value for specific types of nodes the user can arrest the -shrinkage of the surface mesh during the smoothing process. - -Taubin’s Lambda-Mu Smoothing Algorithm --------------------------------------- - -One of the options for the filter allows the user to apply Taubin’s Lambda-Mu variation on Laplacian smoothing. This -variation removes the shrinkage typically found with Laplacian smoothing by adding an additional step within each -iteration where the negative of the (Lambda value \* Mu Factor) which effectively moves the points in the **opposite** -direction from the initial movement. Because of this negative movement the number of iterations to achieve the same -level of smoothing is greatly increased, on the order of 10x to 20x. - -Algorithm Usage and Memory Requirements ---------------------------------------- - -Currently, if you lock the *Default Lambda* value to zero (0), the triple lines and quadruple points will not be able to -move because none of their neighbors can move. The user may want to consider allowing a small value of λ for the default -nodes which will allow some movement of the triple lines and/or quadruple Points. - -This **Filter** will create additional internal arrays in order to facilitate the calculations. These arrays are - -- Float - λ values (same size as nodes array) -- 64 bit integer - unique edges array -- 8 bit integer for node type (same size as nodes array) -- Integer for number of connections for each node (same size as nodes array) -- 64 bit float for delta values (3x size of nodes array) - -Due to these array allocations this **Filter** can consume large amounts of memory if the starting mesh has a large -number of nodes. The values for the *Node Type* array can take one of the following values. - -:: - - namespace SurfaceMesh { - namespace NodeType { - const int8_t Unused = -1; - const int8_t Default = 2; - const int8_t TriplePoint = 3; - const int8_t QuadPoint = 4; - const int8_t SurfaceDefault = 12; - const int8_t SurfaceTriplePoint = 13; - const int8_t SurfaceQuadPoint = 14; - } - } - -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 | float | Value of λ for the quadruple Points that lie on the outer | -| Lambda | | 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 - -References -========== - -[1] D. A. Feature, (1988) Laplacian smoothing and Delaunay triangulations. Commun. appl. numer. methods, 4: 709 712. -doi: 10.1002/cnm.1630040603 - -[2] A. Belyaev, Mesh smoothing and enhancing curvature estimation, `http://www.mpi-inf.mpg.de/ -ag4-gm/handouts/06gm_surf3.pdf `__. - -Example Pipelines -================= - -- - - (2) SmallIN100 Smooth Mesh - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/LosAlamosFFTWriterFilter.md b/src/Plugins/ComplexCore/docs/LosAlamosFFTWriterFilter.md index 0afc36d37a..c2ddf6f662 100644 --- a/src/Plugins/ComplexCore/docs/LosAlamosFFTWriterFilter.md +++ b/src/Plugins/ComplexCore/docs/LosAlamosFFTWriterFilter.md @@ -53,8 +53,8 @@ Image ## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | diff --git a/src/Plugins/ComplexCore/docs/LosAlamosFFTWriterFilter.rst b/src/Plugins/ComplexCore/docs/LosAlamosFFTWriterFilter.rst deleted file mode 100644 index c72053dfcc..0000000000 --- a/src/Plugins/ComplexCore/docs/LosAlamosFFTWriterFilter.rst +++ /dev/null @@ -1,109 +0,0 @@ -===================== -Los Alamos FFT Writer -===================== - - -Group (Subgroup) -================ - -IO (Output) - -Description -=========== - -This **Filter** will create the directories along the path to the file if possible. - -This **Filter** writes out **CellData** from an **Image Geometry** to a file that is appropriate to use as an input into -Ricardo Lebensohn’s FFT 3D simulation codes[1]. - -The format of the file is an ASCII text file with the following space delimited information: - -:: - - Phi1 Phi Phi2 X Y Z Feature_ID Phase_ID - -The Euler angles are in degrees. X, Y, Z are integer indices into the **Image** geometry. Feature ID & Phase ID are the -integer values for the feature and phase **Starting at One (1)**. - -Example Output --------------- - -The output file: - -:: - - 90.000 0.000 0.000 1 1 1 0 1 - 90.000 0.000 0.000 2 1 1 0 1 - 90.000 0.000 0.000 3 1 1 0 1 - 90.000 0.000 0.000 4 1 1 0 1 - 90.000 0.000 0.000 5 1 1 0 1 - 90.000 0.000 0.000 6 1 1 0 1 - 90.000 0.000 0.000 7 1 1 0 1 - 90.000 0.000 0.000 8 1 1 0 1 - 90.000 0.000 0.000 9 1 1 0 1 - 90.000 0.000 0.000 10 1 1 0 1 - 90.000 0.000 0.000 11 1 1 0 1 - 90.000 0.000 0.000 12 1 1 0 1 - 90.000 0.000 0.000 13 1 1 0 1 - 90.000 0.000 0.000 14 1 1 0 1 - 90.000 0.000 0.000 15 1 1 0 1 - 90.000 0.000 0.000 16 1 1 0 1 - 90.000 0.000 0.000 17 1 1 0 1 - 135.009 55.304 295.274 18 1 1 1742 1 - 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 - -References -========== - -[1] R.A. Lebensohn, 2001. N-site modeling of a 3D viscoplastic polycrystal using Fast Fourier Transform. Acta mater. 49, -2723-2737. - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/MapPointCloudToRegularGridFilter.md b/src/Plugins/ComplexCore/docs/MapPointCloudToRegularGridFilter.md index a96639c329..1b5043ae8d 100644 --- a/src/Plugins/ComplexCore/docs/MapPointCloudToRegularGridFilter.md +++ b/src/Plugins/ComplexCore/docs/MapPointCloudToRegularGridFilter.md @@ -5,16 +5,16 @@ Map Point Cloud to Regular Grid Sampling (Mapping) -## Description +## Description This **Filter** determines, for a user-defined grid, in which voxel each point in a **Vertex Geometry** lies. The user can either construct a sampling grid by specifying the dimensions, or select a pre-existing **Image Geometry** to use as the sampling grid. The voxel indices that each point lies in are stored on the vertices. 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 +## 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 | @@ -23,21 +23,21 @@ Additionally, the user may opt to use a mask; points for which the mask are fals Vertex -## Required Objects +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| Kind | Default Name | Type | Comp Dims | Description | +|---------------------------|--------------|----------|--------|---------------------------------------------| | Vertex Attribute Array | VoxelIndices | size_t | (1) | Indices of the voxels in which each point lies | -## License & Copyright +## License & Copyright Please see the description file distributed with this plugin. diff --git a/src/Plugins/ComplexCore/docs/MapPointCloudToRegularGridFilter.rst b/src/Plugins/ComplexCore/docs/MapPointCloudToRegularGridFilter.rst deleted file mode 100644 index 9b7455ee47..0000000000 --- a/src/Plugins/ComplexCore/docs/MapPointCloudToRegularGridFilter.rst +++ /dev/null @@ -1,74 +0,0 @@ -=============================== -Map Point Cloud to Regular Grid -=============================== - - -Group (Subgroup) -================ - -Sampling (Mapping) - -Description -=========== - -This **Filter** determines, for a user-defined grid, in which voxel each point in a **Vertex Geometry** lies. The user -can either construct a sampling grid by specifying the dimensions, or select a pre-existing **Image Geometry** to use as -the sampling grid. The voxel indices that each point lies in are stored on the vertices. - -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 -====================== ============ ====== ========== ============================================== - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/MinNeighbors.md b/src/Plugins/ComplexCore/docs/MinNeighbors.md index 1b38b83601..bc005f300f 100644 --- a/src/Plugins/ComplexCore/docs/MinNeighbors.md +++ b/src/Plugins/ComplexCore/docs/MinNeighbors.md @@ -1,50 +1,50 @@ # Minimum Number of Neighbors -## Group (Subgroup) ## +## Group (Subgroup) Processing (Cleanup) -## Description ## +## Description This **Filter** sets the minimum number of contiguous neighboring **Features** a **Feature** must have to remain in the structure. Entering zero results in nothing changing. Entering a number larger than the maximum number of neighbors of any **Feature** generates an *error* (since all **Features** would be removed). The user needs to proceed conservatively here when choosing the value for the minimum to avoid accidentally exceeding the maximum. After **Features** are removed for not having enough neighbors, the remaining **Features** are *coarsened* iteratively, one **Cell** per iteration, until the gaps left by the removed **Features** are filled. Effectively, this is an isotropic **Feature** growth in the regions around removed **Features**. The **Filter** can be run in a mode where the minimum number of neighbors is applied to a single **Ensemble**. The user can select to apply the minimum to one specific **Ensemble**. -## Notes ## +## Notes 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 ## +## 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 ## +## Required Geometry Image -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 ## +## Created Objects None -## Example Pipelines ## +## Example Pipelines + (10) SmallIN100 Full Reconstruction + (06) SmallIN100 Postsegmentation Processing -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/ComplexCore/docs/MinNeighbors.rst b/src/Plugins/ComplexCore/docs/MinNeighbors.rst deleted file mode 100644 index f77d2293f4..0000000000 --- a/src/Plugins/ComplexCore/docs/MinNeighbors.rst +++ /dev/null @@ -1,95 +0,0 @@ -=========================== -Minimum Number of Neighbors -=========================== - - -Group (Subgroup) -================ - -Processing (Cleanup) - -Description -=========== - -This **Filter** sets the minimum number of contiguous neighboring **Features** a **Feature** must have to remain in the -structure. Entering zero results in nothing changing. Entering a number larger than the maximum number of neighbors of -any **Feature** generates an *error* (since all **Features** would be removed). The user needs to proceed conservatively -here when choosing the value for the minimum to avoid accidentally exceeding the maximum. After **Features** are removed -for not having enough neighbors, the remaining **Features** are *coarsened* iteratively, one **Cell** per iteration, -until the gaps left by the removed **Features** are filled. Effectively, this is an isotropic **Feature** growth in the -regions around removed **Features**. - -The **Filter** can be run in a mode where the minimum number of neighbors is applied to a single **Ensemble**. The user -can select to apply the minimum to one specific **Ensemble**. - -Notes -===== - -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 - -Example Pipelines -================= - -- - - (10) SmallIN100 Full Reconstruction - -- - - (6) SmallIN100 Postsegmentation Processing - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/MoveData.md b/src/Plugins/ComplexCore/docs/MoveData.md index 3f45168e0d..5b57cfa0a9 100644 --- a/src/Plugins/ComplexCore/docs/MoveData.md +++ b/src/Plugins/ComplexCore/docs/MoveData.md @@ -1,41 +1,41 @@ # Move Data -## Group (Subgroup) ## +## Group (Subgroup) Core (Memory/Management) -## Description ## +## Description 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 ## +## 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 ## +## Required Geometry Not Applicable -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 ## +## Created Objects None -## Example Pipelines ## +## Example Pipelines -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/ComplexCore/docs/MoveData.rst b/src/Plugins/ComplexCore/docs/MoveData.rst deleted file mode 100644 index 83a59d8e5c..0000000000 --- a/src/Plugins/ComplexCore/docs/MoveData.rst +++ /dev/null @@ -1,60 +0,0 @@ -========= -Move Data -========= - - -Group (Subgroup) -================ - -Core (Memory/Management) - -Description -=========== - -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 - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/MultiThresholdObjects.md b/src/Plugins/ComplexCore/docs/MultiThresholdObjects.md index 450df5f3ca..7b25b86e0b 100644 --- a/src/Plugins/ComplexCore/docs/MultiThresholdObjects.md +++ b/src/Plugins/ComplexCore/docs/MultiThresholdObjects.md @@ -1,11 +1,11 @@ # Threshold Objects 2 -## Group (Subgroup) ## +## Group (Subgroup) Processing (Threshold) -## Description ## +## Description This **Filter** allows the user to input single or multiple criteria for thresholding **Attribute Arrays** in an **Attribute Matrix**. Internally, the algorithm creates the output boolean arrays for each comparison that the user creates. Comparisons can be either a value and boolean operator (*Less Than*, *Greater Than*, *Equal To*, *Not Equal To*) or a collective set of comparisons. Then all the output arrays are compared with their given comparison operator ( *And* / *Or* ) with the value of a set being the result of its own comparisons calculated from top to bottom. @@ -17,7 +17,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 ## +## Parameters | Name | Type | Description | |--------------------------|-----------------|----------------------------------------------------------------------------------------------------------------| @@ -27,28 +27,28 @@ It is possible to set custom values for both the TRUE and FALSE values that will | 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 ## +## Required Geometry Not Applicable -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| Kind | Default Name | Type | Comp Dims | Description | +|---------------------------|--------------|----------|--------|---------------------------------------------| | Any **Attribute Array | None | Any | (1) | Array(s) selected in criteria set | -## Created Objects ## +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | -## Example Pipelines ## +## Example Pipelines -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/ComplexCore/docs/MultiThresholdObjects.rst b/src/Plugins/ComplexCore/docs/MultiThresholdObjects.rst deleted file mode 100644 index c3ca117c26..0000000000 --- a/src/Plugins/ComplexCore/docs/MultiThresholdObjects.rst +++ /dev/null @@ -1,96 +0,0 @@ -=================== -Threshold Objects 2 -=================== - - -Group (Subgroup) -================ - -Processing (Threshold) - -Description -=========== - -This **Filter** allows the user to input single or multiple criteria for thresholding **Attribute Arrays** in an -**Attribute Matrix**. Internally, the algorithm creates the output boolean arrays for each comparison that the user -creates. Comparisons can be either a value and boolean operator (*Less Than*, *Greater Than*, *Equal To*, *Not Equal -To*) or a collective set of comparisons. Then all the output arrays are compared with their given comparison operator ( -*And* / *Or* ) with the value of a set being the result of its own comparisons calculated from top to bottom. - -An example of this **Filter’s** use would be after EBSD data is read into DREAM.3D and the user wants to have DREAM.3D -consider **Cells** that the user considers *good*. The user would insert this **Filter** and select the criteria that -makes a **Cell** *good*. All arrays **must** come from the same **Attribute Matrix** in order for the **Filter** to -execute. - -For example, an integer array contains the values 1, 2, 3, 4, 5. For a comparison value of 3 and the comparison operator -greater than, the boolean threshold array produced will contain *false*, *false*, *false*, *true*, *true*. For the -comparison set { *Greater Than* 2 AND *Less Than* 5} OR *Equals* 1, the boolean threshold array produced will contain -*true*, *false*, *true*, *true*, *false*. - -It is possible to set custom values for both the TRUE and FALSE values that will be output to the threshold array. For -example, if the user selects an output threshold array type of uint32, then they could set a custom FALSE value of 5 and -a custom TRUE value of 20. So then instead of outputting 0’s and 1’s to the threshold array, the filter would output 5’s -and 20’s. - -**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 | Comparison | This is the set of criteria applied to the objects the selected arrays correspond | -| Threshold | List | to when doing the thresholding | -+-------------------+------------+-------------------------------------------------------------------------------------+ -| Use Custom TRUE | bool | Specifies whether to output a custom TRUE value | -| Value | | | -+-------------------+------------+-------------------------------------------------------------------------------------+ -| Custom TRUE Value | float64 | The custom TRUE value (the default value is 1) | -+-------------------+------------+-------------------------------------------------------------------------------------+ -| Use Custom FALSE | bool | Specifies whether to output a custom FALSE value | -| Value | | | -+-------------------+------------+-------------------------------------------------------------------------------------+ -| Custom FALSE | float64 | The custom FALSE value (the default value is 0) | -| Value | | | -+-------------------+------------+-------------------------------------------------------------------------------------+ - -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 | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/NearestPointFuseRegularGridsFilter.md b/src/Plugins/ComplexCore/docs/NearestPointFuseRegularGridsFilter.md index e5c90a8f0e..661008c1eb 100644 --- a/src/Plugins/ComplexCore/docs/NearestPointFuseRegularGridsFilter.md +++ b/src/Plugins/ComplexCore/docs/NearestPointFuseRegularGridsFilter.md @@ -24,8 +24,8 @@ None ## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | diff --git a/src/Plugins/ComplexCore/docs/NearestPointFuseRegularGridsFilter.rst b/src/Plugins/ComplexCore/docs/NearestPointFuseRegularGridsFilter.rst deleted file mode 100644 index 9c8813ecb3..0000000000 --- a/src/Plugins/ComplexCore/docs/NearestPointFuseRegularGridsFilter.rst +++ /dev/null @@ -1,58 +0,0 @@ -=================================== -Fuse Regular Grids (Nearest Points) -=================================== - - -Group (Subgroup) -================ - -Sampling (Resolution) - -Description -=========== - -This **Filter** fuses two **Image Geometry** data sets together. The grid of **Cells** in the *Reference* **Data -Container** is overlaid on the grid of **Cells** in the *Sampling* **Data Container**. Each **Cell** in the *Reference* -**Data Container** is associated with the nearest point in the *Sampling* **Data Container** (i.e., no *interpolation* -is performed). All the attributes of the **Cell** in the *Sampling* **Data Container** are then assigned to the **Cell** -in the *Reference* **Data Container**. Additional to the **Cell** attributes being copied, all **Feature and Ensemble -Attribute Matrices** from the *Sampling* **Data Container** are copied to the *Reference* **Data Container**. - -*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 -================ ============ ==== ========== =========================================== - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/PartitionGeometryFilter.md b/src/Plugins/ComplexCore/docs/PartitionGeometryFilter.md index 824dbdd0b8..f9d28c97b2 100644 --- a/src/Plugins/ComplexCore/docs/PartitionGeometryFilter.md +++ b/src/Plugins/ComplexCore/docs/PartitionGeometryFilter.md @@ -1,19 +1,19 @@ # Partition Geometry -## Group (Subgroup) ## +## Group (Subgroup) Reconstruction (Reconstruction) -## Description ## +## Description This **Filter** generates a partition grid and assigns partition IDs for every voxel/node of a given geometry. If the **Filter** determines that any voxel/node of the original geometry is out-of-bounds compared to the generated partition grid, the **Out-Of-Bounds Cell ID** will be used as the partition ID in the output partition IDs array. -## Partitioning Modes ## +## Partitioning Modes There are four available partitioning modes to choose from: **1. Basic**, **2. Advanced**, **3. Bounding Box**, and **4. Existing Partition Grid** -### Basic ### +### Basic This partitioning mode is commonly used to create a partition grid that is exactly the same size as the input geometry and divided up into a specific number of cells in the X, Y, & Z dimensions. This mode requires the **Starting Feature ID**, **Number of Cells Per Axis**, and (optionally) the **Use Vertex Mask** input parameters. @@ -35,7 +35,7 @@ In **Figure 1** above, the PartitionGeometry filter is using the SmallIN100 imag In **Figure 1A** above, feature ID 111 is shown highlighted in the newly created partition grid. In **Figure 1B** above, the same 111 feature ID is shown as the assigned partition ID for the currently highlighted voxel. -### **Advanced** ### +### **Advanced** This partitioning mode is commonly used to create a custom sized partition grid that the input geometry may or may not fit within. This mode requires the **Starting Feature ID**, **Out-of-Bounds Feature ID**, **Number of Cells Per Axis**, **Partition Grid Origin**, **Cell Length**, and (optionally) the **Use Vertex Mask** input parameters. @@ -75,7 +75,7 @@ In **Figure 3A** above, the newly created partition grid is shown intersecting t In **Figure 3B** above, the SmallIN100 dataset is sliced open to show the partition IDs that have been set with the corresponding feature IDs from the partition grid. -### **Bounding Box** ### +### **Bounding Box** This partitioning mode is commonly used to create a custom sized partition grid using a minimum and maximum grid coordinate. The input geometry may or may not fit within this partition grid. This mode is very similar to the **Advanced** partitioning mode; it requires the **Starting Feature ID**, **Out-of-Bounds Feature ID**, **Number of Cells Per Axis**, **Minimum Grid Coordinate**, **Maximum Grid Coordinate**, and (optionally) the **Use Vertex Mask** input parameters. Basically, instead of specifying a partition grid origin and cell length to determine the location and physical size of the partition grid, the minimum and maximum grid coordinates are used. @@ -91,11 +91,11 @@ In **Figure 4** above, the PartitionGeometry filter is using the SmallIN100 imag In **Figure 4A** above, the SmallIN100 dataset is shown. In **Figure 4B** above, the dataset is sliced to show the newly created partition grid contained within. The partition grid is about 5 units smaller on all sides compared to the SmallIN100 input geometry. -### **Existing Partition Grid** ### +### **Existing Partition Grid** This partitioning mode is chosen when the user already has a partition grid from a previous run of the Partition Geometry filter. Just select an existing **Partition Grid Geometry** and pick the **Out-of-Bounds Feature ID**, and then partition IDs will be assigned to the input dataset when the filter is executed. -## Using A Vertex Mask ## +## Using A Vertex Mask On all partitioning modes, a vertex mask can be used with a vertex-based input geometry to determine which vertices should be assigned a valid partition ID. Any vertices with a mask value of 0 or False will have its Partition ID set to the Out-of-Bounds Feature ID. @@ -103,7 +103,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 ## +## Parameters | Name | Type | Description | |------|------|------| @@ -126,11 +126,11 @@ On all partitioning modes, a vertex mask can be used with a vertex-based input g | 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. | -## Example Pipelines ## +## Example Pipelines None -## License & Copyright ## +## License & Copyright Please see the description file distributed with this plugin. diff --git a/src/Plugins/ComplexCore/docs/PartitionGeometryFilter.rst b/src/Plugins/ComplexCore/docs/PartitionGeometryFilter.rst deleted file mode 100644 index f4f85002c3..0000000000 --- a/src/Plugins/ComplexCore/docs/PartitionGeometryFilter.rst +++ /dev/null @@ -1,276 +0,0 @@ -================== -Partition Geometry -================== - - -Group (Subgroup) -================ - -Reconstruction (Reconstruction) - -Description -=========== - -This **Filter** generates a partition grid and assigns partition IDs for every voxel/node of a given geometry. - -If the **Filter** determines that any voxel/node of the original geometry is out-of-bounds compared to the generated -partition grid, the **Out-Of-Bounds Cell ID** will be used as the partition ID in the output partition IDs array. - -Partitioning Modes -================== - -There are four available partitioning modes to choose from: **1. Basic**, **2. Advanced**, **3. Bounding Box**, and **4. -Existing Partition Grid** - -Basic ------ - -This partitioning mode is commonly used to create a partition grid that is exactly the same size as the input geometry -and divided up into a specific number of cells in the X, Y, & Z dimensions. This mode requires the **Starting Feature -ID**, **Number of Cells Per Axis**, and (optionally) the **Use Vertex Mask** input parameters. - -+--------------------------------+ -| Figure 1: 5x5x5 Partition Grid | -+================================+ -+--------------------------------+ - -.. image:: Images/PartitionGeometry/Basic_Mode.png - -In **Figure 1** above, the PartitionGeometry filter is using the SmallIN100 image geometry as an input geometry to -generate a 5x5x5 partition grid with 125 features and the following outputs: - -1. An image geometry called **Partition Grid Geometry** with a data array containing all the partition grid ids called - **Feature Ids**. -2. An attribute matrix called **Cell Data** that contains all the cell data arrays for the newly created partition grid. -3. A cell data array called **Feature Ids** that contains the newly created partition grid’s ids. -4. An attribute matrix called **Feature Data**, used to store any future feature data for the given SmallIN100 input - geometry. -5. A cell data array called **Partition Ids** that contains the assigned partition ids for all voxels in the SmallIN100 - input geometry. - -======================================== ====================================== -Figure 1A: Partition Grid Feature Id 111 Figure 1B: SmallIN100 Partition Id 111 -======================================== ====================================== -|image1| |image2| -======================================== ====================================== - -In **Figure 1A** above, feature ID 111 is shown highlighted in the newly created partition grid. In **Figure 1B** above, -the same 111 feature ID is shown as the assigned partition ID for the currently highlighted voxel. - -**Advanced** ------------- - -This partitioning mode is commonly used to create a custom sized partition grid that the input geometry may or may not -fit within. This mode requires the **Starting Feature ID**, **Out-of-Bounds Feature ID**, **Number of Cells Per Axis**, -**Partition Grid Origin**, **Cell Length**, and (optionally) the **Use Vertex Mask** input parameters. - -*Note*: If the given input geometry does not fit within the partition grid, any out of bounds voxels/nodes will be -assigned the **Out-of-Bounds Feature ID** as their **Partition ID**. - -+-------------------------------------------------------------------------------------------------+ -| Figure 2: 12x4x6 Partition Grid, Partition Grid Origin = (-50, -15, -40), Cell Lengths = 5x19x7 | -+=================================================================================================+ -| |image3| | -+-------------------------------------------------------------------------------------------------+ - -In **Figure 2** above, the PartitionGeometry filter is using the SmallIN100 image geometry as an input geometry to -generate a 12x4x6 partition grid with 288 features, cell length 5x19x7, and the following outputs: - -1. An image geometry called **Partition Grid Geometry** with a data array containing all the partition grid ids called - **Feature Ids**. -2. An attribute matrix called **Cell Data** that contains all the cell data arrays for the newly created partition grid. -3. A cell data array called **Feature Ids** that contains the newly created partition grid’s ids. -4. An attribute matrix called **Feature Data**, used to store any future feature data for the given SmallIN100 input - geometry. -5. A cell data array called **Partition Ids** that contains the assigned partition ids for all voxels in the SmallIN100 - input geometry. - -========================= ================================ -Figure 2A: Partition Grid Figure 2B: Sliced Partition Grid -========================= ================================ -|image4| |image5| -========================= ================================ - -In **Figure 2A** above, the newly created partition grid is shown. It is a 12x4x6 grid with an origin of (-50, -15, --40), and cell length 5x19x7. - -In **Figure 2B** above, the partition grid is sliced open to show the SmallIN100 dataset that is contained inside of it. -The SmallIN100 dataset has partition IDs that correspond to the feature IDs in the partition grid. - -+------------------------------------------------------------------------------------------------+ -| Figure 3: 5x4x6 Partition Grid, Partition Grid Origin = (-20, -15, -15), Cell Lengths = 4x19x7 | -+================================================================================================+ -| |image6| | -+------------------------------------------------------------------------------------------------+ - -In **Figure 3** above, the PartitionGeometry filter is using the SmallIN100 image geometry as an input geometry to -generate a 5x4x6 partition grid with 120 features, cell lengths 4x19x7. - -===================================================== ===================================================== -Figure 3A: Dataset Does Not Fit Inside Partition Grid Figure 3B: Dataset Does Not Fit Inside Partition Grid -===================================================== ===================================================== -|image7| |image8| -===================================================== ===================================================== - -In **Figure 3A** above, the newly created partition grid is shown intersecting the SmallIN100 dataset. Any part of the -SmallIN100 dataset that is outside the partition grid is marked with the **Out-of-Bounds Feature ID**, which in this -case is 0. - -In **Figure 3B** above, the SmallIN100 dataset is sliced open to show the partition IDs that have been set with the -corresponding feature IDs from the partition grid. - -**Bounding Box** ----------------- - -This partitioning mode is commonly used to create a custom sized partition grid using a minimum and maximum grid -coordinate. The input geometry may or may not fit within this partition grid. This mode is very similar to the -**Advanced** partitioning mode; it requires the **Starting Feature ID**, **Out-of-Bounds Feature ID**, **Number of Cells -Per Axis**, **Minimum Grid Coordinate**, **Maximum Grid Coordinate**, and (optionally) the **Use Vertex Mask** input -parameters. Basically, instead of specifying a partition grid origin and cell length to determine the location and -physical size of the partition grid, the minimum and maximum grid coordinates are used. - -+--------------------------------+ -| Figure 4: 5x5x5 Partition Grid | -+================================+ -| |image9| | -+--------------------------------+ - -In **Figure 4** above, the PartitionGeometry filter is using the SmallIN100 image geometry as an input geometry to -generate a 5x5x5 partition grid with 125 features, a minimum coordinate of (-42, 5, -24), and a maximum coordinate of -(-4.75, 45.25, -4.75). - -======================================== ================================================= -Figure 4A: Partition Grid Inside Dataset Figure 4B: Partition Grid Inside Dataset - Sliced -======================================== ================================================= -|image10| |image11| -======================================== ================================================= - -In **Figure 4A** above, the SmallIN100 dataset is shown. In **Figure 4B** above, the dataset is sliced to show the newly -created partition grid contained within. The partition grid is about 5 units smaller on all sides compared to the -SmallIN100 input geometry. - -**Existing Partition Grid** ---------------------------- - -This partitioning mode is chosen when the user already has a partition grid from a previous run of the Partition -Geometry filter. Just select an existing **Partition Grid Geometry** and pick the **Out-of-Bounds Feature ID**, and then -partition IDs will be assigned to the input dataset when the filter is executed. - -Using A Vertex Mask -=================== - -On all partitioning modes, a vertex mask can be used with a vertex-based input geometry to determine which vertices -should be assigned a valid partition ID. Any vertices with a mask value of 0 or False will have its Partition ID set to -the Out-of-Bounds Feature ID. - -======================================== ========================================= -Figure 5A: Vertex With Mask Value = True Figure 5B: Vertex With Mask Value = False -======================================== ========================================= -|image12| |image13| -======================================== ========================================= - -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. | -+---------------------------------------+---------------------------------------+---------------------------------------+ - -Example Pipelines -================= - -None - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. - -.. |image1| image:: Images/PartitionGeometry/Basic_Mode_Result1a.png -.. |image2| image:: Images/PartitionGeometry/Basic_Mode_Result1b.png -.. |image3| image:: Images/PartitionGeometry/Advanced_Mode_1.png -.. |image4| image:: Images/PartitionGeometry/Advanced_Mode_1a.png -.. |image5| image:: Images/PartitionGeometry/Advanced_Mode_1b.png -.. |image6| image:: Images/PartitionGeometry/Advanced_Mode_2.png -.. |image7| image:: Images/PartitionGeometry/Advanced_Mode_2a.png -.. |image8| image:: Images/PartitionGeometry/Advanced_Mode_2b.png -.. |image9| image:: Images/PartitionGeometry/BoundingBox_Mode_1.png -.. |image10| image:: Images/PartitionGeometry/BoundingBox_Mode_1a.png -.. |image11| image:: Images/PartitionGeometry/BoundingBox_Mode_1b.png -.. |image12| image:: Images/PartitionGeometry/UseVertexMask_1a.png -.. |image13| image:: Images/PartitionGeometry/UseVertexMask_1b.png diff --git a/src/Plugins/ComplexCore/docs/PointSampleTriangleGeometryFilter.md b/src/Plugins/ComplexCore/docs/PointSampleTriangleGeometryFilter.md index ab73a9041a..c6b9efe7d8 100644 --- a/src/Plugins/ComplexCore/docs/PointSampleTriangleGeometryFilter.md +++ b/src/Plugins/ComplexCore/docs/PointSampleTriangleGeometryFilter.md @@ -1,10 +1,10 @@ # Point Sample Triangle Geometry -## Group (Subgroup) ## +## Group (Subgroup) DREAM3D Review (Geometry) -## Description ## +## Description This **Filter** randomly samples point locations on **Triangles** in a **Triangle Geometry**. The sampled point locations are then used to construct a **Vertex Geometry**. The number of point samples may either be specified manually or by inferring from another **Geometry**: @@ -27,37 +27,37 @@ 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 ## +## 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 ### +## Required Geometry# Triangle -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | 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 ## +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | -## Example Pipelines ## +## Example Pipelines -## License & Copyright ## +## License & Copyright Please see the description file distributed with this plugin. diff --git a/src/Plugins/ComplexCore/docs/PointSampleTriangleGeometryFilter.rst b/src/Plugins/ComplexCore/docs/PointSampleTriangleGeometryFilter.rst deleted file mode 100644 index 19b2e964f7..0000000000 --- a/src/Plugins/ComplexCore/docs/PointSampleTriangleGeometryFilter.rst +++ /dev/null @@ -1,124 +0,0 @@ -============================== -Point Sample Triangle Geometry -============================== - - -Group (Subgroup) -================ - -DREAM3D Review (Geometry) - -Description -=========== - -This **Filter** randomly samples point locations on **Triangles** in a **Triangle Geometry**. The sampled point -locations are then used to construct a **Vertex Geometry**. The number of point samples may either be specified manually -or by inferring from another **Geometry**: - -================ ============================ -Geometry Source for Number of Samples -================ ============================ -Image Number of cells -Rectilinear Grid Number of cells -Vertex Number of vertices -Edge Number of vertices -Triangle Number of vertices -Quadrilateral Number of vertices -Tetrahedral Number of vertices -================ ============================ - -In order to ensure an even sampling of the total surface are of the **Triangle Geometry**, the average number of points -sampled per triangle is made proportional to the area of the triangle. Within a given **Triangle**, a point is chosen -using the following approach: - -.. figure:: Images/PointSampleTriangleGeometry_Eqn1.png - :alt: Equation 1 - - Equation 1 - -where |image1| are the coordinates of the sampled point; |image2|, |image3|, and |image4| are the coordinates of the -vertices beloning to the **Triangle**; and |image5| and |image6| are random real numbers on the interval |image7|. This -approach has the benefit of uniform sampling within the **Triangle** area, and functions correctly regardless of the -dimensionality of the space embedding (i.e., whether the **Triangle** is in the plane or embedded in 3D). - -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 | Enumeration | Whether to input the number of samples manually or use | -| Samples | | 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 | TriangleD | N/A | N/A | Data Container holding the **Triangle | -| | ataContainer | | | 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 | VertexD | N/A | N/A | Data Container holding the **Vertex Geometry** | -| | ataContainer | | | that represents the sampling points | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Vertex Attribute Matrix | VertexData | Vertex | N/A | Vertex Attribute Matrix*\* for the created | -| | | | | \**Vertex Data Container | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. - -.. |image1| image:: Images/PSTG_2.png -.. |image2| image:: Images/PSTG_3.png -.. |image3| image:: Images/PSTG_4.png -.. |image4| image:: Images/PSTG_5.png -.. |image5| image:: Images/PSTG_6.png -.. |image6| image:: Images/PSTG_7.png -.. |image7| image:: Images/PSTG_8.png diff --git a/src/Plugins/ComplexCore/docs/QuickSurfaceMeshFilter.md b/src/Plugins/ComplexCore/docs/QuickSurfaceMeshFilter.md index fdc9d2884a..c8666a3b5b 100644 --- a/src/Plugins/ComplexCore/docs/QuickSurfaceMeshFilter.md +++ b/src/Plugins/ComplexCore/docs/QuickSurfaceMeshFilter.md @@ -1,10 +1,10 @@ -# Quick Surface Mesh # +# Quick Surface Mesh -## Group (Subgroup) ## +## Group (Subgroup) Surface Meshing (Generation) -## Description ## +## Description This **Filter** generates a **Triangle Geometry** from a grid **Geometry** (either an **Image Geometry** or a **RectGrid Geometry**) that represents a surface mesh of the present **Features**. The algorithm proceeds by creating a pair of **Triangles** for each face of the **Cell** where the neighboring **Cells** have a different **Feature** Id value. The meshing operation is extremely quick but can result in a surface mesh that is very "stair stepped". The user is encouraged to use a smoothing operation to reduce this "blockiness". @@ -46,7 +46,7 @@ NodeType = 4 --------------- -### Node Types ### +### Node Types One of the arrays to come out of the algorithm is the "Node Type" vertex array. This array uses a value to label each vertex as to what kind of node it was determined to be during the meshing process. @@ -59,41 +59,41 @@ 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 ## +## 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 ## +## Required Geometry Image/RectGrid -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 ## +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | +| 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 | -## Example Pipelines ## +## Example Pipelines + (01) SmallIN100 Quick Mesh -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/ComplexCore/docs/QuickSurfaceMeshFilter.rst b/src/Plugins/ComplexCore/docs/QuickSurfaceMeshFilter.rst deleted file mode 100644 index c3fb0d2404..0000000000 --- a/src/Plugins/ComplexCore/docs/QuickSurfaceMeshFilter.rst +++ /dev/null @@ -1,162 +0,0 @@ -================== -Quick Surface Mesh -================== - - -Group (Subgroup) -================ - -Surface Meshing (Generation) - -Description -=========== - -This **Filter** generates a **Triangle Geometry** from a grid **Geometry** (either an **Image Geometry** or a **RectGrid -Geometry**) that represents a surface mesh of the present **Features**. The algorithm proceeds by creating a pair of -**Triangles** for each face of the **Cell** where the neighboring **Cells** have a different **Feature** Id value. The -meshing operation is extremely quick but can result in a surface mesh that is very “stair stepped”. The user is -encouraged to use a smoothing operation to reduce this “blockiness”. - -The user may choose any number of **Cell Attribute Arrays** to transfer to the created **Triangle Geometry**. The -**Faces** will gain the values of the **Cells** from which they were created. Currently, the **Filter** disallows the -transferring of data that has a *multi-dimensional* component dimensions vector. For example, scalar values and vector -values are allowed to be transferred, but N x M matrices cannot currently be transferred. - -This filter will ensure that the smaller of the 2 **FaceLabel** values will always be in the first component -(component[0]). This will allow assumptions made in downstream filters to continue to work correctly. - -For more information on surface meshing, visit the tutorial. - --------------- - -.. figure:: Images/QuickSurface_Output.png - :alt: Example Quick Mesh Output - - Example Quick Mesh Output - -Quick Surface Mesh output **without** any extra smoothing applied - --------------- - -.. figure:: Images/QuickSurface_Smooth_Output.png - :alt: Example Quick Mesh Output - - Example Quick Mesh Output - -Quick Surface Mesh output **with** Laplacian Smoothing filter applied. - --------------- - -.. figure:: Images/QuickMesh_NodeType_2.png - :alt: NodeType = 2 - - NodeType = 2 - -NodeType = 2 - --------------- - -.. figure:: Images/QuickMesh_NodeType_3.png - :alt: NodeType = 3 - - NodeType = 3 - -NodeType = 3 - --------------- - -.. figure:: Images/QuickMesh_NodeType_4.png - :alt: NodeType = 4 - - NodeType = 4 - -NodeType = 4 - --------------- - -Node Types ----------- - -One of the arrays to come out of the algorithm is the “Node Type” vertex array. This array uses a value to label each -vertex as to what kind of node it was determined to be during the meshing process. - -===== ================================================================= -Value Description -===== ================================================================= -2 Node within the interior of the grain face. -3 Node along a triple line -4 Node that is a Quadruple point -12 Node that is on the exterior of the mesh -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 | TriangleD | N/A | N/A | Created **Data Container** name with a | -| | ataContainer | | | \**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 | Fac | Face | N/A | Feature Attribute Matrix*\* of the created | -| | eFeatureData | Feature | | *Face Labels* | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Any \**Face Attribute Array | None | Any | Any | The set of transferred \**Cell Attribute Arrays | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Example Pipelines -================= - -- - - (1) SmallIN100 Quick Mesh - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/RawBinaryReaderFilter.md b/src/Plugins/ComplexCore/docs/RawBinaryReaderFilter.md index 08b0d06e1f..0791ee990b 100644 --- a/src/Plugins/ComplexCore/docs/RawBinaryReaderFilter.md +++ b/src/Plugins/ComplexCore/docs/RawBinaryReaderFilter.md @@ -1,17 +1,17 @@ # Raw Binary Reader -## Group (Subgroup) ## +## Group (Subgroup) IO (Input) -## Description ## +## Description This **Filter** is designed to read data stored in files on the users system in *binary* form. The data file should **not** have any type of header before the data in the file. The user should know exactly how the data is stored in the file and properly define this in the user interface. Not correctly identifying the type of data can cause serious issues since this **Filter** is simply reading the data into a pre-allocated array interpreted as the user defines. This **Filter** will error out and block the **Pipeline** from running if the total number of bytes that would need to be read from the file is larger than the actual file itself. The user can use an input file that is actually **larger** than the number of bytes required by the **Filter**; in this case, the **Filter** will only read the first part of the file unless an amount of bytes to skip is set. -### Scalar Type ### +### Scalar Type Computer data comes in 10 basic types on modern 32 bit and 64 bit operating systems. Data can be categorized as either *integer* or _floating point_. With each of these types, the number of bits that represent the data determine their maximum and minimum values. For integer values, the standard types are 8, 16, 32 and 64 bit (1, 2, 4, and 8 bytes). For floating point values, there are either 32 bit or 64 bit (4 or 8 bytes). Integer types can be either *signed* or _unsigned_. A signed integer can take negative values. An unsigned integer can only take positive values, but will have twice the positive value range as a signed integer. @@ -31,11 +31,11 @@ The types of data that can be read with this **Filter** include: --- -### Number of Components ### +### Number of Components This parameter tells the program how many values are present for each _tuple_. For example, a grayscale image would typically have just a single value of type unsigned 8 bit integer at every pixel/voxel. A color image will have at least 3 components for red (R), breen (G) and blue (B), and sometimes 4 values if the alpha (A) channel is also stored. Euler angles are typically stored as a 3 component vector of 32 bit floating point values. -### Endian ### +### Endian This parameter tells the program which byte is *most significant* for multibyte values. Intel architecture computers are little endian while Power PC, Sun Sparc and DEC Alpha CPUs are big endian. Consider the following example: @@ -49,42 +49,42 @@ This parameter tells the program which byte is *most significant* for multibyte This setting is *crucial* to the correct interpretation of the binary data, so the user must be aware of how their binary data was encoded. -### Skip Header Bytes ### +### Skip Header Bytes 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 ## +## 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 ## +## Required Geometry Not Applicable -## Required Objects ## +## Required Objects None -## Created Objects ## +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| Kind | Default Name | Type | Comp Dims | Description | +|---------------------------|--------------|----------|--------|---------------------------------------------| | Any | None | Any | Any | Created **Attribute Array** name | -## Example Pipelines ## +## Example Pipelines -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/ComplexCore/docs/RawBinaryReaderFilter.rst b/src/Plugins/ComplexCore/docs/RawBinaryReaderFilter.rst deleted file mode 100644 index 897cd4aa53..0000000000 --- a/src/Plugins/ComplexCore/docs/RawBinaryReaderFilter.rst +++ /dev/null @@ -1,128 +0,0 @@ -================= -Raw Binary Reader -================= - - -Group (Subgroup) -================ - -IO (Input) - -Description -=========== - -This **Filter** is designed to read data stored in files on the users system in *binary* form. The data file should -**not** have any type of header before the data in the file. The user should know exactly how the data is stored in the -file and properly define this in the user interface. Not correctly identifying the type of data can cause serious issues -since this **Filter** is simply reading the data into a pre-allocated array interpreted as the user defines. - -This **Filter** will error out and block the **Pipeline** from running if the total number of bytes that would need to -be read from the file is larger than the actual file itself. The user can use an input file that is actually **larger** -than the number of bytes required by the **Filter**; in this case, the **Filter** will only read the first part of the -file unless an amount of bytes to skip is set. - -Scalar Type ------------ - -Computer data comes in 10 basic types on modern 32 bit and 64 bit operating systems. Data can be categorized as either -*integer* or *floating point*. With each of these types, the number of bits that represent the data determine their -maximum and minimum values. For integer values, the standard types are 8, 16, 32 and 64 bit (1, 2, 4, and 8 bytes). For -floating point values, there are either 32 bit or 64 bit (4 or 8 bytes). Integer types can be either *signed* or -*unsigned*. A signed integer can take negative values. An unsigned integer can only take positive values, but will have -twice the positive value range as a signed integer. - -The types of data that can be read with this **Filter** include: - -:: - - signed Int8 - unsigned UInt8 - signed Int16 - unsigned UInt16 - signed Int32 - unsigned UInt32 - signed Int64 - unsigned UInt64 - Float 32 bit - Double 64 bit - --------------- - -Number of Components --------------------- - -This parameter tells the program how many values are present for each *tuple*. For example, a grayscale image would -typically have just a single value of type unsigned 8 bit integer at every pixel/voxel. A color image will have at least -3 components for red (R), breen (G) and blue (B), and sometimes 4 values if the alpha (A) channel is also stored. Euler -angles are typically stored as a 3 component vector of 32 bit floating point values. - -Endian ------- - -This parameter tells the program which byte is *most significant* for multibyte values. Intel architecture computers are -little endian while Power PC, Sun Sparc and DEC Alpha CPUs are big endian. Consider the following example: - -**Byte Ordering Example for 32 Bit Signed Integer** - -====== ====== ====== ====== ===================== -Byte 0 Byte 1 Byte 2 Byte 3 Interpretation -====== ====== ====== ====== ===================== -FF AA 00 00 -5636096 (Big Endian) -00 00 AA FF 43775 (Little Endian) -====== ====== ====== ====== ===================== - -This setting is *crucial* to the correct interpretation of the binary data, so the user must be aware of how their -binary data was encoded. - -Skip Header Bytes ------------------ - -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 -==== ============ ==== ========== ================================ - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/RegularGridSampleSurfaceMesh.md b/src/Plugins/ComplexCore/docs/RegularGridSampleSurfaceMesh.md index 3489c3f47c..739d7862c9 100644 --- a/src/Plugins/ComplexCore/docs/RegularGridSampleSurfaceMesh.md +++ b/src/Plugins/ComplexCore/docs/RegularGridSampleSurfaceMesh.md @@ -16,7 +16,7 @@ This **Filter** "samples" a triangulated surface mesh on a rectilinear grid. The ## 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 | @@ -28,13 +28,13 @@ 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 | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | diff --git a/src/Plugins/ComplexCore/docs/RegularGridSampleSurfaceMesh.rst b/src/Plugins/ComplexCore/docs/RegularGridSampleSurfaceMesh.rst deleted file mode 100644 index b4f5bb60f7..0000000000 --- a/src/Plugins/ComplexCore/docs/RegularGridSampleSurfaceMesh.rst +++ /dev/null @@ -1,68 +0,0 @@ -======================================== -Sample Triangle Geometry on Regular Grid -======================================== - - -Group (Subgroup) -================ - -Sampling (Resolution) - -Description -=========== - -This **Filter** “samples” a triangulated surface mesh on a rectilinear grid. The user can specify the number of -**Cells** along the X, Y, and Z directions in addition to the resolution in each direction and origin to define a -rectilinear grid. The sampling is then performed by the following steps: - -1. Determine the bounding box and **Triangle** list of each **Feature** by scanning all **Triangles** and noting the - **Features** on either side of the **Triangle** -2. For each **Cell** in the rectilinear grid, determine which bounding box(es) they fall in (*Note:* the bounding box of - multiple **Features** can overlap) -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 -================ ============== ===== ========== ==================================================== - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/ComplexCore/docs/RegularGridSampleSurfaceMeshFilter.md b/src/Plugins/ComplexCore/docs/RegularGridSampleSurfaceMeshFilter.md index dde8b8484c..d3f62df383 100644 --- a/src/Plugins/ComplexCore/docs/RegularGridSampleSurfaceMeshFilter.md +++ b/src/Plugins/ComplexCore/docs/RegularGridSampleSurfaceMeshFilter.md @@ -16,7 +16,7 @@ This **Filter** "samples" a triangulated surface mesh on a rectilinear grid. The ## 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 | @@ -28,13 +28,13 @@ 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 | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | diff --git a/src/Plugins/ComplexCore/docs/RegularGridSampleSurfaceMeshFilter.rst b/src/Plugins/ComplexCore/docs/RegularGridSampleSurfaceMeshFilter.rst deleted file mode 100644 index 4e563385ee..0000000000 --- a/src/Plugins/ComplexCore/docs/RegularGridSampleSurfaceMeshFilter.rst +++ /dev/null @@ -1,74 +0,0 @@ -======================================== -Sample Triangle Geometry on Regular Grid -======================================== - - -Group (Subgroup) -================ - -Sampling (Resolution) - -Description -=========== - -This **Filter** “samples” a triangulated surface mesh on a rectilinear grid. The user can specify the number of -**Cells** along the X, Y, and Z directions in addition to the resolution in each direction and origin to define a -rectilinear grid. The sampling is then performed by the following steps: - -1. Determine the bounding box and **Triangle** list of each **Feature** by scanning all **Triangles** and noting the - **Features** on either side of the **Triangle** -2. For each **Cell** in the rectilinear grid, determine which bounding box(es) they fall in (*Note:* the bounding box of - multiple **Features** can overlap) -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 -================ ============== ===== ========== ==================================================== - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/RemoveFlaggedFeaturesFilter.md b/src/Plugins/ComplexCore/docs/RemoveFlaggedFeaturesFilter.md index bbc29b8200..8e104cb4bb 100644 --- a/src/Plugins/ComplexCore/docs/RemoveFlaggedFeaturesFilter.md +++ b/src/Plugins/ComplexCore/docs/RemoveFlaggedFeaturesFilter.md @@ -1,38 +1,38 @@ # Remove Flagged Features -## Group (Subgroup) ## +## Group (Subgroup) Processing (Cleanup) -## Description ## +## Description 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 ## +## Parameters None -## Required Geometry ## +## Required Geometry Image -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 ## +## Created Objects None -## Example Pipelines ## +## Example Pipelines -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/ComplexCore/docs/RemoveFlaggedFeaturesFilter.rst b/src/Plugins/ComplexCore/docs/RemoveFlaggedFeaturesFilter.rst deleted file mode 100644 index 0273a40de3..0000000000 --- a/src/Plugins/ComplexCore/docs/RemoveFlaggedFeaturesFilter.rst +++ /dev/null @@ -1,60 +0,0 @@ -======================= -Remove Flagged Features -======================= - - -Group (Subgroup) -================ - -Processing (Cleanup) - -Description -=========== - -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 - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/RemoveFlaggedVertices.md b/src/Plugins/ComplexCore/docs/RemoveFlaggedVertices.md index 2dbab9cb85..06b8f8c5f9 100644 --- a/src/Plugins/ComplexCore/docs/RemoveFlaggedVertices.md +++ b/src/Plugins/ComplexCore/docs/RemoveFlaggedVertices.md @@ -1,10 +1,10 @@ # Remove Flagged Vertices -## Group (Subgroup) ## +## Group (Subgroup) DREAM3D Review (Geometry) -## Description ## +## Description This **Filter** removes **Vertices** from the supplied **Vertex Geometry** that are flagged by a boolean mask array. Specifically, **Vertices** flagged as *true* are removed from the **Geometry**. A new reduced **Vertex Geometry** is @@ -20,30 +20,30 @@ _Note:_ Since it cannot be known before run time how many **Vertices** will be r 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 ## +## Parameters None -## Required Geometry ### +## Required Geometry# Vertex -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 ## +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | -## Example Pipelines ## +## Example Pipelines -## License & Copyright ## +## License & Copyright Please see the description file distributed with this plugin. diff --git a/src/Plugins/ComplexCore/docs/RemoveFlaggedVertices.rst b/src/Plugins/ComplexCore/docs/RemoveFlaggedVertices.rst deleted file mode 100644 index 6a952e23e9..0000000000 --- a/src/Plugins/ComplexCore/docs/RemoveFlaggedVertices.rst +++ /dev/null @@ -1,74 +0,0 @@ -======================= -Remove Flagged Vertices -======================= - - -Group (Subgroup) -================ - -DREAM3D Review (Geometry) - -Description -=========== - -This **Filter** removes **Vertices** from the supplied **Vertex Geometry** that are flagged by a boolean mask array. -Specifically, **Vertices** flagged as *true* are removed from the **Geometry**. A new reduced **Vertex Geometry** is -created that contains all the remaining **Vertices**. It is unknown until run time how many **Vertices** will be removed -from the **Geometry**. Therefore, this **Filter** requires that a new **Data Container** be created to contain the -reduced **Vertex Geometry**. This new **Data Container** will contain copies of any **Feature** or **Ensemble** -Attribute Matrices*\* from the original **Data Container**. Additionally, all **Vertex** data will be copied, with -tuples *removed* for any **Vertices** removed by the **Filter**. The user must supply a name for the reduced **Data -Container**, but all other copied objects (**Attribute Matrices** and **Attribute Arrays**) will retain the same names -as the original source. - -*Note:* Since it cannot be known before run time how many **Vertices** will be removed, 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 -========== - -None - -Required Geometry -================= - -Vertex - -Required Objects -================ - -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Kind | Default Name | Type | Comp. Dims | Description | -+=============================+==============+==========+============+=================================================+ -| Data Container | VertexD | N/A | N/A | Data Container holding the **Vertex Geometry** | -| | ataContainer | | | 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 | Re | N/A | N/A | Data Container holding the reduced **Vertex | -| | ducedVertexD | | | Geometry** and any copied **Attribute | -| | ataContainer | | | Matrices** and \**Attribute Arrays | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/RemoveMinimumSizeFeaturesFilter.md b/src/Plugins/ComplexCore/docs/RemoveMinimumSizeFeaturesFilter.md index 3f83d6c369..a7dcc7312e 100644 --- a/src/Plugins/ComplexCore/docs/RemoveMinimumSizeFeaturesFilter.md +++ b/src/Plugins/ComplexCore/docs/RemoveMinimumSizeFeaturesFilter.md @@ -1,50 +1,50 @@ # Minimum Size -## Group (Subgroup) ## +## Group (Subgroup) Processing (Cleanup) -## Description ## +## Description This **Filter** removes **Features** that have a total number of **Cells** below the minimum threshold defined by the user. Entering a number larger than the largest **Feature** generates an *error* (since all **Features** would be removed). Hence, a choice of threshold should be carefully be chosen if it is not known how many **Cells** are in the largest **Features**. After removing all the small **Features**, the remaining **Features** are isotropically coarsened to fill the gaps left by the small **Features**. The **Filter** can be run in a mode where the minimum number of neighbors is applied to a single **Ensemble**. The user can select to apply the minimum to one specific **Ensemble**. -## Notes ## +## Notes 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 ## +## 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 ## +## Required Geometry Image -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 ## +## Created Objects None -## Example Pipelines ## +## Example Pipelines + (10) SmallIN100 Full Reconstruction + (06) SmallIN100 Postsegmentation Processing -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/ComplexCore/docs/RemoveMinimumSizeFeaturesFilter.rst b/src/Plugins/ComplexCore/docs/RemoveMinimumSizeFeaturesFilter.rst deleted file mode 100644 index 2490ffa037..0000000000 --- a/src/Plugins/ComplexCore/docs/RemoveMinimumSizeFeaturesFilter.rst +++ /dev/null @@ -1,93 +0,0 @@ -============ -Minimum Size -============ - - -Group (Subgroup) -================ - -Processing (Cleanup) - -Description -=========== - -This **Filter** removes **Features** that have a total number of **Cells** below the minimum threshold defined by the -user. Entering a number larger than the largest **Feature** generates an *error* (since all **Features** would be -removed). Hence, a choice of threshold should be carefully be chosen if it is not known how many **Cells** are in the -largest **Features**. After removing all the small **Features**, the remaining **Features** are isotropically coarsened -to fill the gaps left by the small **Features**. - -The **Filter** can be run in a mode where the minimum number of neighbors is applied to a single **Ensemble**. The user -can select to apply the minimum to one specific **Ensemble**. - -Notes -===== - -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 | int32_t | Number of **Cells** that must be present in the **Feature** | -| Size | | for it to remain in the sample | -+---------------------------+---------------------------+-------------------------------------------------------------+ -| Apply to Single Phase | bool | Tells the Filter whether to apply minimum to single | -| Only | | 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 - -Example Pipelines -================= - -- - - (10) SmallIN100 Full Reconstruction - -- - - (6) SmallIN100 Postsegmentation Processing - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/RenameDataObject.md b/src/Plugins/ComplexCore/docs/RenameDataObject.md index b176f26074..110875ae46 100644 --- a/src/Plugins/ComplexCore/docs/RenameDataObject.md +++ b/src/Plugins/ComplexCore/docs/RenameDataObject.md @@ -1,38 +1,38 @@ # RenameDataObject -## Group (Subgroup) ## +## Group (Subgroup) Core (Memory/Management) -## Description ## +## Description This **Filter** renames a user chosen **Data Object** of any type. -## Parameters ## +## Parameters | Name | Type | Description | -|------|------| ----------- | +|------------|------| --------------------------------- | | New Data Object Name| String | New name for the selected **Data Object | -## Required Geometry ## +## Required Geometry Not Applicable -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| Kind | Default Name | Type | Comp Dims | Description | +|---------------------------|--------------|----------|--------|---------------------------------------------| | Data Object | None | N/A | N/A | Data Object** to rename | -## Created Objects ## +## Created Objects None -## Example Pipelines ## +## Example Pipelines -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/ComplexCore/docs/RenameDataObject.rst b/src/Plugins/ComplexCore/docs/RenameDataObject.rst deleted file mode 100644 index 9bc0f027f7..0000000000 --- a/src/Plugins/ComplexCore/docs/RenameDataObject.rst +++ /dev/null @@ -1,56 +0,0 @@ -================ -RenameDataObject -================ - - -Group (Subgroup) -================ - -Core (Memory/Management) - -Description -=========== - -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 - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/ReplaceElementAttributesWithNeighborValuesFilter.rst b/src/Plugins/ComplexCore/docs/ReplaceElementAttributesWithNeighborValuesFilter.rst deleted file mode 100644 index 14b1e36951..0000000000 --- a/src/Plugins/ComplexCore/docs/ReplaceElementAttributesWithNeighborValuesFilter.rst +++ /dev/null @@ -1,170 +0,0 @@ -==================================================== -Replace Element Attributes with Neighbor (Threshold) -==================================================== - - -Group (Subgroup) -================ - -Processing (Cleanup) - -Description -=========== - -This **Filter** first identifies all **Cells** that have a value that meets the selected threshold value set by the -user. Then, for each of those **Cells**, their neighboring **Cells** are checked to determine the neighbor **Cell** with -maximum or minimum value. The attributes of the neighbor with the maximum/minimum value are then reassigned to the -reference **Cell**. - -*Note:* By default, the **Filter** will run only one iteration of the cleanup. If the user selects the *Loop Until Gone* -option, then the **Filter** will run iteratively until no **Cells** exist that meet the users criteria. So, if a -**Cell** meets the threshold and so are all of its neighbors, then that **Cell** will not be changed during that -iteration and will remain unchanged until one of its neighbors gets changed by a **Cell** further away. - -Examples -======== - -TSL Data (.ang) File --------------------- - -When attempting to “clean up” EBSD data generated by EDAX/TSL the Attribute Array “Confidence Index” can be used. -Confidence Index is a measure of how confident in the indexing results given by the OIM Analysis software and ranges -from 0.0 (No confidence) to 1.0 (Absolute confidence). More information about the Confidence Index can be found in the -OIM analysis user manual. Typical inputs for TSL (.ang) Data might be the following. - -================ ============================================= -Filter Parameter Value -================ ============================================= -Threshold Value 0.1 -Operator < -Selected Array [DataContainer] / CellData / Confidence Index -Loop Until Gone User dependent -================ ============================================= - -Using these values says that for every cell that has a confidence index < 0.1 it’s neighbor cells will be considered. If -the neighbor cell has a confidence > 0.1 AND is greater than the other neighbors then this cell’s data will be copied -into the original cell data location. - -Example EDAX Results --------------------- - -**Reasonable Use of the Filter** - -+------------------------------------------+---+--------------------------------------+--------------------------------+ -| Original Data | | After Running Filter | True Data | -+==========================================+===+======================================+================================+ -| |Original Data| | | |Text| | |image1| | -+------------------------------------------+---+--------------------------------------+--------------------------------+ - -**Example of Too Much Replacement** - -+-------------------------+-----------------------------------------------+----------------------+--------------------+ -| Original Data | Threshold CI < 0.1 | After Running Filter | True Data | -+=========================+===============================================+======================+====================+ -| |image2| | |Original Data. Black pixels have Confidence | |image3| | |image4| | -| | Index < 0.1| | | | -+-------------------------+-----------------------------------------------+----------------------+--------------------+ - -Note how in the above use of the filter the grain morphology is substantially changed from the exemplar data. Except for -very large grains being similar most of the fine grains and twins are **NOT** reproduced from the original. - -Oxford/Bruker (.ctf) File -------------------------- - -Oxford Instruments and Bruker CTF data files do not include a “Confidence Index” measure. There are several measures -such as *Mean Angular Deviation (MAD)* or *Bands* but these values are not filled in or are defaulted to 0 (Zero) if the -scan point was not indexed. By using the *Error* value from the data file we can get the same effect as the EDAX -*Confidence Index*. The user would use the following input values: - -================ ================================== -Filter Parameter Value -================ ================================== -Threshold Value 0.0 -Operator > -Selected Array [DataContainer] / CellData / Error -Loop Until Gone User dependent -================ ================================== - -Example Oxford/Bruker Results ------------------------------ - -============= ==================== -Original Data After Running Filter -============= ==================== -|image5| |image6| -============= ==================== - -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 | Int | Selects the operator to use. 0 = < (Less Than). 1 = > (Greater Than) | -| Operator | | | -+------------------+--------+------------------------------------------------------------------------------------------+ -| Loop Until Gone | bool | Whether to iterate until all **Cells** are above the minimum tolerance or just run one | -| | | iteration | -+------------------+--------+------------------------------------------------------------------------------------------+ -| Image Geometry | Da | The path to the Image Geometry | -| | taPath | | -+------------------+--------+------------------------------------------------------------------------------------------+ - -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 - -Example Pipelines -================= - -The example pipeline (pipelines/Examples/ReplaceElementAttributesWithNeighbor.d3dpipeline) will give output similar to -the following images. - -+-----------------------------------------------------------+-----------------------------------------------------------+ -| Before Filter | After Filter | -+===========================================================+===========================================================+ -| |image7| | |image8| | -+-----------------------------------------------------------+-----------------------------------------------------------+ - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. - -.. |Original Data| image:: Images/NeighborReplace_No_Cleanup_2.png -.. |Text| image:: Images/NeighborReplace_After_Cleanup_2.png -.. |image1| image:: Images/NeighborReplace_Exemplar.bmp -.. |image2| image:: Images/NeighborReplace_No_Cleanup.png -.. |Original Data. Black pixels have Confidence Index < 0.1| image:: Images/NeighborReplace_No_Cleanup_Mask.png -.. |image3| image:: Images/NeighborReplace_After_Cleanup.png -.. |image4| image:: Images/NeighborReplace_Exemplar.bmp -.. |image5| image:: Images/NeighborReplace_CTF_Before.png -.. |image6| image:: Images/NeighborReplace_CTF_After.png -.. |image7| image:: Images/NeighborReplace_Small_IN100_Before.png -.. |image8| image:: Images/NeighborReplace_Small_IN100_After.png diff --git a/src/Plugins/ComplexCore/docs/ResampleImageGeomFilter.md b/src/Plugins/ComplexCore/docs/ResampleImageGeomFilter.md index 155e91cecf..256d880bf7 100644 --- a/src/Plugins/ComplexCore/docs/ResampleImageGeomFilter.md +++ b/src/Plugins/ComplexCore/docs/ResampleImageGeomFilter.md @@ -1,14 +1,14 @@ # Resample Image Geometry -## Group (Subgroup) ## +## Group (Subgroup) Sampling (Resample) -## Description ## +## Description This **Filter** changes the **Cell** spacing/resolution based on inputs from the user. There are several resampling modes: -### Spacing ### +### Spacing The values entered are the desired new spacings (not multiples of the current resolution). The number of **Cells** in the volume will change when the spacing values are changed and thus the user should be cautious of generating "too many" **Cells** by entering very small values (i.e., very high resolution). **Example 1**: @@ -23,7 +23,7 @@ Image Geometry with cell dimensions (524, 390, 164) and spacing (1, 1, 1). If the new spacing value is (0.25, 0.7, 2.3), then the geometry will have cell dimensions (2096, 557, 71) and spacing (0.25, 0.7, 2.3). -### Scale Factor ### +### Scale Factor The values entered are the desired scaling factor for each dimension, in percentages. **Example 1**: @@ -38,7 +38,7 @@ Image Geometry with cell dimensions (524, 390, 164) and spacing (1, 1, 1). If the new scaling value is (120.4%, 50.74%, 68.12%), then the geometry will have cell dimensions (630, 197, 111) and spacing (0.830565, 1.97083, 1.468). -### Exact Dimensions ### +### Exact Dimensions The values entered are the desired cell dimensions of the resampled geometry. (100, 100, 100) would resample the geometry so that there are 100 cells in each dimension. **Example 1**: @@ -61,7 +61,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 ## +## Parameters | Name | Type | Description | |--------------------------|-------------|-------------------------------------------------------------------------------------------------------------| @@ -72,29 +72,29 @@ A new grid of **Cells** is created and "overlaid" on the existing grid of **Cell | 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 ## +## Required Geometry Image -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 ## +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| Kind | Default Name | Type | Comp Dims | Description | +|---------------------------|--------------|----------|--------|---------------------------------------------| | Data Container | NewImageDataContainer | N/A | N/A | Created **Data Container** name with an **Image Geometry**. | -## Example Pipelines ## +## Example Pipelines ComplexCore/ResamplePorosityImage -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/ComplexCore/docs/ResampleImageGeomFilter.rst b/src/Plugins/ComplexCore/docs/ResampleImageGeomFilter.rst deleted file mode 100644 index 72236737a3..0000000000 --- a/src/Plugins/ComplexCore/docs/ResampleImageGeomFilter.rst +++ /dev/null @@ -1,161 +0,0 @@ -======================= -Resample Image Geometry -======================= - - -Group (Subgroup) -================ - -Sampling (Resample) - -Description -=========== - -This **Filter** changes the **Cell** spacing/resolution based on inputs from the user. There are several resampling -modes: - -Spacing -------- - -The values entered are the desired new spacings (not multiples of the current resolution). The number of **Cells** in -the volume will change when the spacing values are changed and thus the user should be cautious of generating “too many” -**Cells** by entering very small values (i.e., very high resolution). - -**Example 1**: - -Image Geometry with cell dimensions (524, 390, 164) and spacing (1, 1, 1). - -If the new spacing value is (2, 2, 2), then the geometry will have cell dimensions (262, 195, 82) and spacing (2, 2, 2). - -**Example 2**: - -Image Geometry with cell dimensions (524, 390, 164) and spacing (1, 1, 1). - -If the new spacing value is (0.25, 0.7, 2.3), then the geometry will have cell dimensions (2096, 557, 71) and spacing -(0.25, 0.7, 2.3). - -Scale Factor ------------- - -The values entered are the desired scaling factor for each dimension, in percentages. - -**Example 1**: - -Image Geometry with cell dimensions (524, 390, 164) and spacing (1, 1, 1). - -If the new scaling value is (30%, 30%, 30%), then the geometry will have cell dimensions (157, 117, 49) and spacing -(3.3333, 3.3333, 3.3333). - -**Example 2**: - -Image Geometry with cell dimensions (524, 390, 164) and spacing (1, 1, 1). - -If the new scaling value is (120.4%, 50.74%, 68.12%), then the geometry will have cell dimensions (630, 197, 111) and -spacing (0.830565, 1.97083, 1.468). - -Exact Dimensions ----------------- - -The values entered are the desired cell dimensions of the resampled geometry. (100, 100, 100) would resample the -geometry so that there are 100 cells in each dimension. - -**Example 1**: - -Image Geometry with cell dimensions (524, 390, 164) and spacing (1, 1, 1). - -If the new exact dimensions are (100, 100, 100), then the geometry will have cell dimensions (100, 100, 100) and spacing -(5.24, 3.9, 1.64). - -**Example 2**: - -Image Geometry with cell dimensions (524, 390, 164) and spacing (1, 1, 1). - -If the new exact dimensions are (100, 500, 20), then the geometry will have cell dimensions (100, 500, 20) and spacing -(5.24, 0.78, 8.2). - --------------- - -A new grid of **Cells** is created and “overlaid” on the existing grid of **Cells**. There is currently no -*interpolation* performed, rather the attributes of the old **Cell** that is closest to each new **Cell’s** is assigned -to that new **Cell**. - -*Note:* Present **Features** may disappear when down-sampling to coarse resolutions. If *Renumber Features* is checked, -the **Filter** will check if this is the case and resize the corresponding **Feature Attribute Matrix** to comply with -any changes. Additionally, the **Filter** will renumber **Features** such that they remain contiguous. - -*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 | The new resolution values (dx, dy, dz) | -| | (3x) | | -+--------------------+---------+---------------------------------------------------------------------------------------+ -| Scale Factor | float | The scale factor (dx, dy, dz), in percentages. | -| | (3x) | | -+--------------------+---------+---------------------------------------------------------------------------------------+ -| Exact Dimensions | uint64 | The exact dimensions (dx, dy, dz) to resample the geometry. | -| | (3x) | | -+--------------------+---------+---------------------------------------------------------------------------------------+ -| Renumber Features | bool | Whether the **Features** should be renumbered | -+--------------------+---------+---------------------------------------------------------------------------------------+ -| Remove Original | bool | Whether the current **Geometry** should be removed after the resampling | -| Geometry | | | -+--------------------+---------+---------------------------------------------------------------------------------------+ - -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 | Cel | Cell | N/A | Feature Attribute Matrix*\* that corresponds to | -| | lFeatureData | Feature | | 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**. -============== ===================== ==== ========== =========================================================== - -Example Pipelines -================= - -ComplexCore/ResamplePorosityImage - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/ResampleRectGridToImageGeomFilter.md b/src/Plugins/ComplexCore/docs/ResampleRectGridToImageGeomFilter.md index dbf70afa5c..f2640d5393 100644 --- a/src/Plugins/ComplexCore/docs/ResampleRectGridToImageGeomFilter.md +++ b/src/Plugins/ComplexCore/docs/ResampleRectGridToImageGeomFilter.md @@ -4,7 +4,7 @@ Sampling (Sampling) -## Description +## Description This **Filter** will resample an existing RectilinearGrid onto a regular grid (Image Geometry) and copy cell data into the newly created Image Geometry Data Container during the process. @@ -14,7 +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 +## Parameters | Name | Type | Description | |------|------|------| @@ -26,17 +26,17 @@ The user can select which cell attribute matrix data arrays will be copied into Rectilinear Grid Geometry -## Created Objects +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | -## Example Pipelines +## Example Pipelines -## License & Copyright +## License & Copyright Please see the description file distributed with this plugin. diff --git a/src/Plugins/ComplexCore/docs/ResampleRectGridToImageGeomFilter.rst b/src/Plugins/ComplexCore/docs/ResampleRectGridToImageGeomFilter.rst deleted file mode 100644 index 7ed256a6d1..0000000000 --- a/src/Plugins/ComplexCore/docs/ResampleRectGridToImageGeomFilter.rst +++ /dev/null @@ -1,81 +0,0 @@ -============================== -Resample RectGrid To ImageGeom -============================== - - -Group (Subgroup) -================ - -Sampling (Sampling) - -Description -=========== - -This **Filter** will resample an existing RectilinearGrid onto a regular grid (Image Geometry) and copy cell data into -the newly created Image Geometry Data Container during the process. - -The sampling algorithm is a simple “last one wins” algorithm due to the likely hood that interpolating data is probably -not the correct algorithm to bring in data to the new Image Geometry. - -The algorithm logic is thus: If the ImageGeometry cell would contain multiple RectilinearGrid cells, then we select from -the covered cells the cell with the largest X, Y and Z index and copy that data into the Image Geometry Cell Attribute -Matrix. - -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 | Array of (DataPath) | Rect Grid Cell Data to possibly copy | -| 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 | N/A | N/A | Path to the created Image Geometry | -| | Geometry | | | | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Attribute Matrix | Cell Data | Eleme | N/A | The name of the cell data Attribute Matrix | -| | | nt/Featu | | created with the Image Geometry | -| | | re/Ensem | | | -| | | ble/etc. | | | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| El | Copied from | in | (1 | Cell level arrays copied over from the input to | -| ement/Feature/Ensemble/etc. | the input | t32_t/fl | )/(3)/etc. | the resampled geometry | -| Attribute Array | Data | oat/etc. | | | -| | Container | | | | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/ReverseTriangleWindingFilter.md b/src/Plugins/ComplexCore/docs/ReverseTriangleWindingFilter.md index f9bb2ec309..491a5727a3 100644 --- a/src/Plugins/ComplexCore/docs/ReverseTriangleWindingFilter.md +++ b/src/Plugins/ComplexCore/docs/ReverseTriangleWindingFilter.md @@ -18,8 +18,8 @@ Triangle ## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 diff --git a/src/Plugins/ComplexCore/docs/ReverseTriangleWindingFilter.rst b/src/Plugins/ComplexCore/docs/ReverseTriangleWindingFilter.rst deleted file mode 100644 index 60f85e90b1..0000000000 --- a/src/Plugins/ComplexCore/docs/ReverseTriangleWindingFilter.rst +++ /dev/null @@ -1,54 +0,0 @@ -======================== -Reverse Triangle Winding -======================== - - -Group (Subgroup) -================ - -Surface Meshing (Connectivity/Arrangement) - -Description -=========== - -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 - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/RobustAutomaticThreshold.md b/src/Plugins/ComplexCore/docs/RobustAutomaticThreshold.md index d1210e4c55..1c0685e396 100644 --- a/src/Plugins/ComplexCore/docs/RobustAutomaticThreshold.md +++ b/src/Plugins/ComplexCore/docs/RobustAutomaticThreshold.md @@ -1,10 +1,10 @@ # Robust Automatic Threshold -## Group (Subgroup) ## +## Group (Subgroup) DREAM3D Review (Threshold) -## Description ## +## Description This **Filter** automatically computes a threshold value for a scalar **Attribute Array** based on the array's gradient magnitude, producing a boolean array that is *false* where the input array is less than the threshold value and *true* otherwise. The threshold value is computed using the following equation: @@ -12,32 +12,32 @@ 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 ## +## Parameters None -## Required Geometry ### +## Required Geometry# None -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 ## +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | -## Example Pipelines ## +## Example Pipelines -## License & Copyright ## +## License & Copyright Please see the description file distributed with this plugin. diff --git a/src/Plugins/ComplexCore/docs/RobustAutomaticThreshold.rst b/src/Plugins/ComplexCore/docs/RobustAutomaticThreshold.rst deleted file mode 100644 index 95f9930c61..0000000000 --- a/src/Plugins/ComplexCore/docs/RobustAutomaticThreshold.rst +++ /dev/null @@ -1,76 +0,0 @@ -========================== -Robust Automatic Threshold -========================== - - -.. role:: raw-latex(raw) - :format: latex -.. - -Group (Subgroup) -================ - -DREAM3D Review (Threshold) - -Description -=========== - -This **Filter** automatically computes a threshold value for a scalar **Attribute Array** based on the array’s gradient -magnitude, producing a boolean array that is *false* where the input array is less than the threshold value and *true* -otherwise. The threshold value is computed using the following equation: - -.. figure:: Images/latex24.png - :alt: :raw-latex:`\f[` T = :raw-latex:`\sum`\_{i = 1}^{n} :raw-latex:`\frac{a_{i} g_{i}}{g_{i}}` :raw-latex:`\f]` - - :raw-latex:`\f[` T = :raw-latex:`\sum`\_{i = 1}^{n} :raw-latex:`\frac{a_{i} g_{i}}{g_{i}}` :raw-latex:`\f]` - -where :raw-latex:`\f`$ a :raw-latex:`\f`$ is the input array, :raw-latex:`\f`$ g :raw-latex:`\f`$ is the gradient -magnitude array, :raw-latex:`\f`$ n :raw-latex:`\f`$ is the length of the input array, and :raw-latex:`\f`$ T -:raw-latex:`\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 | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/RotateSampleRefFrameFilter.md b/src/Plugins/ComplexCore/docs/RotateSampleRefFrameFilter.md index 57ad677052..eeea77fe50 100644 --- a/src/Plugins/ComplexCore/docs/RotateSampleRefFrameFilter.md +++ b/src/Plugins/ComplexCore/docs/RotateSampleRefFrameFilter.md @@ -1,10 +1,10 @@ # Rotate Sample Reference Frame -## Group (Subgroup) ## +## Group (Subgroup) Sampling (Rotating/Transforming) -## Description ## +## Description **NOTE: As of July 2023, this filter is only verified to work with a rotation angle of 180 degrees, a rotation axis of (010), and a (0, 0, 0) origin.** @@ -18,36 +18,36 @@ The equivalent rotation matrix for the above rotation would be the following: | 1 | 0 | 0 | | 0 | 0 | 1 | -## Example ## +## Example When importing EBSD data from EDAX typically the user will need to rotate the sample reference frame about the <010> (Y) axis. This results in the image comparison below. Note that in the original image the origin of the data is at (0, 0) microns but after rotation the origin now becomes (-189, 0) microns. If you need to reset the origin back to (0,0) then the filter "Set Origin & Spacing" can be run. ![Imported EBSD Data Rotated about the <010> axis](Images/RotateSampleRefFrame_1.png) -## Parameters ## +## 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 ## +## Required Geometry Image -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| Kind | Default Name | Type | Comp Dims | Description | +|---------------------------|--------------|----------|--------|---------------------------------------------| | DataArray | N/A | Any | Same as geometry | List of **DataArrays** associated with the geometry | -## Created Objects ## +## Created Objects None -## Example Pipelines ## +## Example Pipelines + INL Export + Export Small IN100 ODF Data (StatsGenerator) @@ -56,7 +56,7 @@ None + Edax IPF Colors + Confidence Index Histogram -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/ComplexCore/docs/RotateSampleRefFrameFilter.rst b/src/Plugins/ComplexCore/docs/RotateSampleRefFrameFilter.rst deleted file mode 100644 index 7f33a814c0..0000000000 --- a/src/Plugins/ComplexCore/docs/RotateSampleRefFrameFilter.rst +++ /dev/null @@ -1,94 +0,0 @@ -============================= -Rotate Sample Reference Frame -============================= - - -Group (Subgroup) -================ - -Sampling (Rotating/Transforming) - -Description -=========== - -**NOTE: As of July 2023, this filter is only verified to work with a rotation angle of 180 degrees, a rotation axis of -(010), and a (0, 0, 0) origin.** - -This **Filter** will rotate the *spatial reference frame* around a user defined axis, by a user defined angle. The -**Filter** will modify the (X, Y, Z) positions of each **Cell** to correctly represent where the **Cell** sits in the -newly defined reference frame. For example, if a user selected a *rotation angle* of 90o and a *rotation axis* of (001), -then a **Cell** sitting at (10, 0, 0) would be transformed to (0, -10, 0), since the new *reference frame* would have -x’=y and y’=-x. - -The equivalent rotation matrix for the above rotation would be the following: - -= == = -0 -1 0 -1 0 0 -0 0 1 -= == = - -Example -======= - -When importing EBSD data from EDAX typically the user will need to rotate the sample reference frame about the <010> (Y) -axis. This results in the image comparison below. Note that in the original image the origin of the data is at (0, 0) -microns but after rotation the origin now becomes (-189, 0) microns. If you need to reset the origin back to (0,0) then -the filter “Set Origin & Spacing” can be run. - -.. figure:: Images/RotateSampleRefFrame_1.png - :alt: Imported EBSD Data Rotated about the <010> axis - - Imported EBSD Data Rotated about the <010> axis - -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 - -Example Pipelines -================= - -- INL Export -- Export Small IN100 ODF Data (StatsGenerator) -- TxCopper_Exposed -- TxCopper_Unexposed -- Edax IPF Colors -- Confidence Index Histogram - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/ScalarSegmentFeaturesFilter.md b/src/Plugins/ComplexCore/docs/ScalarSegmentFeaturesFilter.md index 2d743f26ba..453084326b 100644 --- a/src/Plugins/ComplexCore/docs/ScalarSegmentFeaturesFilter.md +++ b/src/Plugins/ComplexCore/docs/ScalarSegmentFeaturesFilter.md @@ -1,11 +1,11 @@ # Segment Features (Scalar) -## Group (Subgroup) ## +## Group (Subgroup) Reconstruction (Segmentation) -## Description ## +## Description This **Filter** segments the **Features** by grouping neighboring **Cells** that satisfy the *scalar tolerance*, i.e., have a scalar difference less than the value set by the user. The process by which the **Features** are identified is given below and is a standard *burn algorithm*. @@ -19,38 +19,38 @@ 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 ## +## 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 ## +## Required Geometry Image -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 ## +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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* | -## Example Pipelines ## +## Example Pipelines + (09) Image Segmentation -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/ComplexCore/docs/ScalarSegmentFeaturesFilter.rst b/src/Plugins/ComplexCore/docs/ScalarSegmentFeaturesFilter.rst deleted file mode 100644 index fa5c463e2f..0000000000 --- a/src/Plugins/ComplexCore/docs/ScalarSegmentFeaturesFilter.rst +++ /dev/null @@ -1,103 +0,0 @@ -========================= -Segment Features (Scalar) -========================= - - -Group (Subgroup) -================ - -Reconstruction (Segmentation) - -Description -=========== - -This **Filter** segments the **Features** by grouping neighboring **Cells** that satisfy the *scalar tolerance*, i.e., -have a scalar difference less than the value set by the user. The process by which the **Features** are identified is -given below and is a standard *burn algorithm*. - -1. Randomly select a **Cell**, add it to an empty list and set its *FeatureId* to the current **Feature** -2. Compare the **Cell** to each of its six (6) face-sharing neighbors (i.e., calculate the scalar difference with each - neighbor) -3. Add each neighbor **Cell** that has a scalar difference below the user defined tolerance to the list created in 1) - and set the *FeatureId* of the neighbor **Cell** to the current **Feature** -4. Remove the current **Cell** from the list and move to the next **Cell** and repeat 2. and 3.; continue until no - **Cells** are left in the list -5. Increment the current **Feature** counter and repeat steps 1. through 4.; continue until no **Cells** remain - unassigned in the dataset - -The user has the option to *Use Mask Array*, which allows the user to set a boolean array for the **Cells** that remove -**Cells** with a value of *false* from consideration in the above algorithm. This option is useful if the user has an -array that either specifies the domain of the “sample” in the “image” or specifies if the orientation on the **Cell** is -trusted/correct. - -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 | Cel | Cell | N/A | Created **Feature Attribute Matrix** name | -| | lFeatureData | Feature | | | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| 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* | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Example Pipelines -================= - -- - - (9) Image Segmentation - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/SetImageGeomOriginScalingFilter.md b/src/Plugins/ComplexCore/docs/SetImageGeomOriginScalingFilter.md index 4045671f34..0365185478 100644 --- a/src/Plugins/ComplexCore/docs/SetImageGeomOriginScalingFilter.md +++ b/src/Plugins/ComplexCore/docs/SetImageGeomOriginScalingFilter.md @@ -1,11 +1,11 @@ # Set Origin & Spacing (Image Geometry) -## Group (Subgroup) ## +## Group (Subgroup) Core (Spatial) -## Description ## +## Description This **Filter** changes the origin and/or the spacing of an **Image Geometry**. For example, if the current origin is at (0, 0, 0) and the user would like the origin to be (10, 4, 8), then the user should enter the following input values: @@ -13,7 +13,7 @@ This **Filter** changes the origin and/or the spacing of an **Image Geometry**. + Y Origin: 4 + Z Origin: 8 -## Parameters ## +## Parameters | Name | Type | Description | |---------|-----------|--------| @@ -22,25 +22,25 @@ This **Filter** changes the origin and/or the spacing of an **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 ## +## Required Geometry Image -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| Kind | Default Name | Type | Comp Dims | Description | +|---------------------------|--------------|----------|--------|---------------------------------------------| | Data Container | None | N/A | N/A | Data Container with an **Image Geometry** to modify | -## Created Objects ## +## Created Objects None -## Example Pipelines ## +## Example Pipelines -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/ComplexCore/docs/SetImageGeomOriginScalingFilter.rst b/src/Plugins/ComplexCore/docs/SetImageGeomOriginScalingFilter.rst deleted file mode 100644 index 5724800a88..0000000000 --- a/src/Plugins/ComplexCore/docs/SetImageGeomOriginScalingFilter.rst +++ /dev/null @@ -1,64 +0,0 @@ -===================================== -Set Origin & Spacing (Image Geometry) -===================================== - - -Group (Subgroup) -================ - -Core (Spatial) - -Description -=========== - -This **Filter** changes the origin and/or the spacing of an **Image Geometry**. For example, if the current origin is at -(0, 0, 0) and the user would like the origin to be (10, 4, 8), then the user should enter the following input values: - -- X Origin: 10 -- 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 - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/SharedFeatureFaceFilter.md b/src/Plugins/ComplexCore/docs/SharedFeatureFaceFilter.md index 95eb32ca25..c58d67fefe 100644 --- a/src/Plugins/ComplexCore/docs/SharedFeatureFaceFilter.md +++ b/src/Plugins/ComplexCore/docs/SharedFeatureFaceFilter.md @@ -31,7 +31,7 @@ that store the following information: --------------- -## Parameters ## +## Parameters | Name | Type | Description | |--------------------------|---------|-------------------------------------------------------------------------------------| @@ -45,7 +45,7 @@ Triangle | 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 | FaceLabels | int32_t | (2) | Specifies which **Features** are on either side of each Face | ## Created Objects diff --git a/src/Plugins/ComplexCore/docs/SharedFeatureFaceFilter.rst b/src/Plugins/ComplexCore/docs/SharedFeatureFaceFilter.rst deleted file mode 100644 index 08534e44df..0000000000 --- a/src/Plugins/ComplexCore/docs/SharedFeatureFaceFilter.rst +++ /dev/null @@ -1,106 +0,0 @@ -========================== -Generate Triangle Face Ids -========================== - - -Group (Subgroup) -================ - -Surface Meshing (Connectivity/Arrangement) - -Description -=========== - -This **Filter** assigns a unique Id to each **Triangle** in a **Triangle Geometry** that represents the *unique -boundary* on which that **Triangle** resides. For example, if there were only two **Features** that shared one boundary, -then the **Triangles** on that boundary would be labeled with a single unique Id. This procedure creates *unique groups* -of **Triangles**, which themselves are a set of **Features**. Thus, this **Filter** also creates a **Feature Attribute -Matrix** for this new set of **Features**, and creates **Attribute Arrays** for their Ids and number of **Triangles**. -This process can be considered a **segmentation** where each unique id is the shared boundary between two features. - -Because the algorithm is essentially segmenting the triangles based on the unique combination of face labels, the filter -will also generate a Feature level Attribute Matrix and place two additional *DataArrays* into that feature attribute -matrix that store the following information: - -1. The number of triangles in each unique boundary -2. The pair of Face Label values that made up the unique boundary. - -Generated Feature Boundaries *with* Randomization -------------------------------------------------- - -.. figure:: Images/SharedFeaturFace_1.png - :alt: Example Surface Mesh Coloring By Feature Face Id - - Example Surface Mesh Coloring By Feature Face Id - -Generated Feature Boundaries *without* Randomization ----------------------------------------------------- - -.. figure:: Images/SharedFeaturFace_2.png - :alt: Example Surface Mesh Coloring By Feature Face Id - - Example Surface Mesh Coloring By Feature Face Id - --------------- - -Parameters -========== - -+-------------------------+--------+------------------------------------------------------------------------------------+ -| Name | Type | Description | -+=========================+========+====================================================================================+ -| Randomize Feature | b | Should the final ‘FeatureFaceId’ Array be randomized. This can aid in | -| Values | oolean | visualization | -+-------------------------+--------+------------------------------------------------------------------------------------+ - -Required Geometry -================= - -Triangle - -Required Objects -================ - -+-----------------------+------------+-------+-----------+------------------------------------------------------------+ -| Kind | Default | Type | Comp Dims | Description | -| | Name | | | | -+=======================+============+=======+===========+============================================================+ -| Face Attribute Array | FaceLabels | in | (2) | Specifies which **Features** are on either side of each | -| | | t32_t | | \**Face | -+-----------------------+------------+-------+-----------+------------------------------------------------------------+ - -Created Objects -=============== - -+--------------------+-----------+---------+--------+---------------------------------------------------------------+ -| Kind | Default | Type | Comp | Description | -| | Name | | Dims | | -+====================+===========+=========+========+===============================================================+ -| Face Attribute | Feat | int32_t | (1) | Specifies to which **Feature** each **Face** belongs | -| Array*\* | ureFaceId | | | | -+--------------------+-----------+---------+--------+---------------------------------------------------------------+ -| Attribute | FaceFe | Face | N/A | Created **Feature Attribute Matrix** name | -| Matrix*\* | atureData | Feature | | | -+--------------------+-----------+---------+--------+---------------------------------------------------------------+ -| Feature Attribute | F | int32_t | (2) | Specifies which *original* **Features** are on either side of | -| Array | aceLabels | | | each *new* \**Feature | -+--------------------+-----------+---------+--------+---------------------------------------------------------------+ -| Feature Attribute | Num | int32_t | (1) | Number of **Triangles** in each **Feature** | -| Array | Triangles | | | | -+--------------------+-----------+---------+--------+---------------------------------------------------------------+ - -Example Pipelines -================= - -“(03) Small IN100 Mesh Statistics.d3dpipeline” - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/SilhouetteFilter.md b/src/Plugins/ComplexCore/docs/SilhouetteFilter.md index 8f0c706319..958694734c 100644 --- a/src/Plugins/ComplexCore/docs/SilhouetteFilter.md +++ b/src/Plugins/ComplexCore/docs/SilhouetteFilter.md @@ -1,10 +1,10 @@ -# Silhouette # +# Silhouette -## Group (Subgroup) ## +## Group (Subgroup) DREAM3D Review (Clustering) -## Description ## +## Description This **Filter** computes the silhouette for a clustered **Attribute Array**. The user must select both the original array that has been clustered and the array of cluster Ids. The silhouette represents a measure for the quality of a clustering. Specifically, the silhouette provides a measure for how strongly a given point belongs to its own cluster compared to all other clusters. The silhouette is computed as follows: @@ -14,34 +14,34 @@ 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 ## +## 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 ### +## Required Geometry# None -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 ## +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| Kind | Default Name | Type | Comp Dims | Description | +|---------------------------|--------------|----------|--------|---------------------------------------------| | Attribute Array | Silhouette | double | (1) | Silhouette value for each point | -## Example Pipelines ## +## Example Pipelines -## License & Copyright ## +## License & Copyright Please see the description file distributed with this plugin. diff --git a/src/Plugins/ComplexCore/docs/SilhouetteFilter.rst b/src/Plugins/ComplexCore/docs/SilhouetteFilter.rst deleted file mode 100644 index da7f44f014..0000000000 --- a/src/Plugins/ComplexCore/docs/SilhouetteFilter.rst +++ /dev/null @@ -1,88 +0,0 @@ -========== -Silhouette -========== - - -.. role:: raw-latex(raw) - :format: latex -.. - -Group (Subgroup) -================ - -DREAM3D Review (Clustering) - -Description -=========== - -This **Filter** computes the silhouette for a clustered **Attribute Array**. The user must select both the original -array that has been clustered and the array of cluster Ids. The silhouette represents a measure for the quality of a -clustering. Specifically, the silhouette provides a measure for how strongly a given point belongs to its own cluster -compared to all other clusters. The silhouette is computed as follows: - -:raw-latex:`\f[` s\_{i} = :raw-latex:`\frac{b_{i} - a_{i}}{\max\{a_{i},b_{i}\}}` :raw-latex:`\f]` - -where :raw-latex:`\f`$ a :raw-latex:`\f`$ is the average distance between point :raw-latex:`\f`$ i :raw-latex:`\f`$ and -all other points in the cluster point :raw-latex:`\f`$ i :raw-latex:`\f`$ belongs to, :raw-latex:`\f`$ b -:raw-latex:`\f`$ is the *next closest* average distance among all other clusters, and :raw-latex:`\f`$ s -:raw-latex:`\f`$ is the silhouette value. Using this definition, :raw-latex:`\f`$ s :raw-latex:`\f`$ exists on the -interval :raw-latex:`\f`$ [-1, 1] :raw-latex:`\f`$, where 1 indicates that the point strongly belongs to its current -cluster and -1 indicates that the point does not belong well to its current cluster. The user may select from a variety -of options to use as the distance metric. Additionally, the user may opt to use a mask array to ignore points in the -silhouette; these points will contain a silhouette value of 0. - -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 -=============== ============ ====== ========== =============================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/SplitAttributeArrayFilter.md b/src/Plugins/ComplexCore/docs/SplitAttributeArrayFilter.md index fcd8be5dcb..c64f81caf1 100644 --- a/src/Plugins/ComplexCore/docs/SplitAttributeArrayFilter.md +++ b/src/Plugins/ComplexCore/docs/SplitAttributeArrayFilter.md @@ -1,11 +1,11 @@ # Split Multicomponent Attribute Array -## Group (Subgroup) ## +## Group (Subgroup) DREAM3D Review (Memory/Management) -## Description ## +## Description This **Filter** splits an n-component **Attribute Array** into **n** scalar arrays, where each array is one of the original components. Any arbitrary component array may be split in this manner, and the output arrays will have the same primitive type as the input array. The original array is not modified (unless the option to remove the original array is selected); instead, **n** new arrays are created. For example, consider an unsigned 8-bit array with three components: @@ -23,33 +23,33 @@ 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 ## +## Parameters | Name | Type | Description | -|------|------|-------------| +|------------|------| --------------------------------- | | Postfix | string | Postfix to add to the end of the split **Attribute Arrays**; this value may be empty | -## Required Geometry ### +## Required Geometry# None -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| Kind | Default Name | Type | Comp Dims | Description | +|---------------------------|--------------|----------|--------|---------------------------------------------| | Any **Attribute Array | None | Any | > (1) | The multicomponent **Attribute Array** to split | -## Created Objects ## +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | -## Example Pipelines ## +## Example Pipelines -## License & Copyright ## +## License & Copyright Please see the description file distributed with this plugin. diff --git a/src/Plugins/ComplexCore/docs/SplitAttributeArrayFilter.rst b/src/Plugins/ComplexCore/docs/SplitAttributeArrayFilter.rst deleted file mode 100644 index 0d0243387f..0000000000 --- a/src/Plugins/ComplexCore/docs/SplitAttributeArrayFilter.rst +++ /dev/null @@ -1,92 +0,0 @@ -==================================== -Split Multicomponent Attribute Array -==================================== - - -Group (Subgroup) -================ - -DREAM3D Review (Memory/Management) - -Description -=========== - -This **Filter** splits an n-component **Attribute Array** into **n** scalar arrays, where each array is one of the -original components. Any arbitrary component array may be split in this manner, and the output arrays will have the same -primitive type as the input array. The original array is not modified (unless the option to remove the original array is -selected); instead, **n** new arrays are created. For example, consider an unsigned 8-bit array with three components: - -:: - - { v1 v2 v3 }, { v4 v5 v6 }, { v7 v8 v9 } ... - -This **Filter** will produce three new scalar unsigned 8-bit arrays: - -:: - - { v1 }, { v4 }, { v7 } ... - { v2 }, { v5 }, { v8 } ... - { v3 }, { v6 }, { v9 } ... - -The user must specificy a postfix string to add to the newly created arrays. For example, if the original multicomponent -**Attribute Array** is named “Foo” and the postfix is set to “Component”, this **Filter** will produce three new arrays -named “FooComponent0”, “FooComponent1”, and “FooComponent2”. The numbering will always be present regardless of how the -postfix is set. - -There is an alternative option which allows the user to select a subset of components to extract instead of extracting -all the components by entering the components to be extracted. The components should be specified starting with the -first componet as 0. So if the original array has 3 components and the user wanted the first and second components, the -unput to the component table should be 0 and 1 respectively. - -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 | Same as | (1) | The set of scalar **Attribute Arrays**, equal | -| | name + | input | | to the number of components of the input | -| | *Postfix* + | array | | \**Attribute Array | -| | component | | | | -| | number | | | | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/StlFileReaderFilter.md b/src/Plugins/ComplexCore/docs/StlFileReaderFilter.md index b5dc7689a7..6b66aea5aa 100644 --- a/src/Plugins/ComplexCore/docs/StlFileReaderFilter.md +++ b/src/Plugins/ComplexCore/docs/StlFileReaderFilter.md @@ -1,11 +1,11 @@ # Read STL File -## Group (Subgroup) ## +## Group (Subgroup) IO (Input) -## Description ## +## Description This **Filter** will read a binary STL File and create a **Triangle Geometry** object in memory. The STL reader is very strict to the STL specification. An explanation of the STL file format can be found on [Wikipedia](https://en.wikipedia.org/wiki/STL). The structure of the file is as follows: @@ -22,7 +22,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 ## +## Parameters | Name | Type | Description | |------|------|------| @@ -34,28 +34,28 @@ This **Filter** will read a binary STL File and create a **Triangle Geometry** | 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 ## +## Required Geometry Not Applicable -## Required Objects ## +## Required Objects None -## Created Objects ## +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | +| Face Attribute Array | FaceNormals | double | (3) | Specifies the normal of each Face | -## Example Pipelines ## +## Example Pipelines -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/ComplexCore/docs/StlFileReaderFilter.rst b/src/Plugins/ComplexCore/docs/StlFileReaderFilter.rst deleted file mode 100644 index ab5cbbcd8d..0000000000 --- a/src/Plugins/ComplexCore/docs/StlFileReaderFilter.rst +++ /dev/null @@ -1,84 +0,0 @@ -============= -Read STL File -============= - - -Group (Subgroup) -================ - -IO (Input) - -Description -=========== - -This **Filter** will read a binary STL File and create a **Triangle Geometry** object in memory. The STL reader is very -strict to the STL specification. An explanation of the STL file format can be found on -`Wikipedia `__. The structure of the file is as follows: - -:: - - UINT8[80] Header - UINT32 Number of triangles - - foreach triangle - REAL32[3] Normal vector - REAL32[3] Vertex 1 - REAL32[3] Vertex 2 - REAL32[3] Vertex 3 - UINT16 Attribute byte count - end - -**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 -==================== ===================== ====== ========== =========================================================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/SurfaceNetsFilter.md b/src/Plugins/ComplexCore/docs/SurfaceNetsFilter.md index 30ada175ed..2647c06fc0 100644 --- a/src/Plugins/ComplexCore/docs/SurfaceNetsFilter.md +++ b/src/Plugins/ComplexCore/docs/SurfaceNetsFilter.md @@ -1,10 +1,10 @@ -# SurfaceNets Filter # +# SurfaceNets Filter -## Group (Subgroup) ## +## Group (Subgroup) Surface Meshing (Generation) -## Description ## +## Description This filter uses the algorithm from {1} to produce a triangle surface mesh. The code is directly based on the sample code from the paper but has been modified to work with the complex library classes. This filter uses a different algorithm that aims to produce a mush that keeps sharp edges @@ -35,7 +35,7 @@ SurfaceNets output **with** the built-in smoothing operation applied. --------------- -## Parameters ## +## Parameters | Human Name | Description | Parameter Type | |--------------|-------------|----------------| @@ -44,18 +44,18 @@ SurfaceNets output **with** the built-in smoothing operation applied. | 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 ## +## Required Geometry Image/RectGrid -## Required Objects ## +## 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 ## +## Created Objects | Kind | Default Name | Type | Comp Dims | Description | |------------------------------|-----------------------|------------------|-------------|------------------------------------------------------------------| @@ -63,25 +63,25 @@ Image/RectGrid | 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 | +| 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** | -## Example Pipelines ## +## Example Pipelines Pipelines/ComplexCore/SurfaceNets_Demo.d3dpipeline -## Citations ## +## Citations {1}[SurfaceNets for Multi-Label Segmentations with Preservation of Sharp Boundaries](https://jcgt.org/published/0011/01/03/paper.pdf) -## License & Copyright ## +## License & Copyright `Sarah F. Frisken, SurfaceNets for Multi-Label Segmentations with Preservation of Sharp Boundaries, Journal of Computer Graphics Techniques (JCGT), vol. 11, no. 1, 34–54, 2022` [http://jcgt.org/published/0011/01/03](http://jcgt.org/published/0011/01/03) -## DREAM.3D Mailing Lists ## +## DREAM.3D Mailing Lists If you need more help with a **Filter**, please consider asking your question on the [DREAM.3D Users Google group!](https://groups.google.com/forum/?hl=en#!forum/dream3d-users) diff --git a/src/Plugins/ComplexCore/docs/SurfaceNetsFilter.rst b/src/Plugins/ComplexCore/docs/SurfaceNetsFilter.rst deleted file mode 100644 index 7ab0f7cb8c..0000000000 --- a/src/Plugins/ComplexCore/docs/SurfaceNetsFilter.rst +++ /dev/null @@ -1,143 +0,0 @@ -================== -SurfaceNets Filter -================== - - -Group (Subgroup) -================ - -Surface Meshing (Generation) - -Description -=========== - -This filter uses the algorithm from {1} to produce a triangle surface mesh. The code is directly based on the sample -code from the paper but has been modified to work with the complex library classes. This filter uses a different -algorithm that aims to produce a mush that keeps sharp edges while still producing a mesh superior to marching cubes or -QuickMesh. - -From the abstract of the paper: - -:: - - We extend 3D SurfaceNets to generate surfaces of segmented 3D medical images composed - of multiple materials represented as indexed labels. Our extension generates smooth, high- - quality triangle meshes suitable for rendering and tetrahedralization, preserves topology and - sharp boundaries between materials, guarantees a user-specified accuracy, and is fast enough - that users can interactively explore the trade-off between accuracy and surface smoothness. - -This filter will ensure that the smallest of the 2 **FaceLabel** values will always be in the first component -(component[0]). This will allow assumptions made in downstream filters to continue to work correctly. - --------------- - -.. figure:: Images/SurfaceNets_Output.png - :alt: Example SurfaceNets Output - - Example SurfaceNets Output - -SurfaceNets without the built-in smoothing applied - --------------- - -.. figure:: Images/SurfaceNets_Smooth_Output.png - :alt: Example SurfaceNets Output - - Example SurfaceNets Output - -SurfaceNets output **with** the built-in smoothing operation applied. - --------------- - -Parameters -========== - -+--------------------------------------+-----------------------------------+-------------------------------------------+ -| Human Name | Description | Parameter Type | -+======================================+===================================+===========================================+ -| Apply Smoothing Operation | This will enable the built-in | complex.BoolParameter | -| | smoothing from the SurfaceNets | | -| | algorithm | | -+--------------------------------------+-----------------------------------+-------------------------------------------+ -| Relaxation Iterations | The number of smoothing | complex.Int32Parameter | -| | iterations to perform | | -+--------------------------------------+-----------------------------------+-------------------------------------------+ -| Max Distance from Voxel | The maximum allowable distance | complex.Float32Parameter | -| | that a node can move from the | | -| | voxel center | | -+--------------------------------------+-----------------------------------+-------------------------------------------+ -| Relaxation Factor | How far a node can move during | complex.Float32Parameter | -| | each smoothing operation | | -+--------------------------------------+-----------------------------------+-------------------------------------------+ - -Required Geometry -================= - -Image/RectGrid - -Required Objects -================ - -+---------------------+---------+-----+--------+--------------------------------------------------------------------+ -| Kind | Default | T | Comp | Description | -| | Name | ype | Dims | | -+=====================+=========+=====+========+====================================================================+ -| Cell Attribute | Fea | i | (1) | Specifies to which **Feature** each **Cell** belongs | -| Array*\* | tureIds | nt3 | | | -| | | 2_t | | | -+---------------------+---------+-----+--------+--------------------------------------------------------------------+ -| Any \**Cell | None | Any | Any | Specifies which **Cell Attribute Arrays** to transfer to the | -| Attribute Array | | | | created \**Triangle Geometry | -+---------------------+---------+-----+--------+--------------------------------------------------------------------+ - -Created Objects -=============== - -+-----------------------+-----------------+-------------+---------+---------------------------------------------------+ -| Kind | Default Name | Type | Comp | Description | -| | | | Dims | | -+=======================+=================+=============+=========+===================================================+ -| Data Container | Triang | N/A | N/A | Created **Data Container** name with a **Triangle | -| | leDataContainer | | | Geometry** | -+-----------------------+-----------------+-------------+---------+---------------------------------------------------+ -| Attribute Matrix*\* | VertexData | Vertex | N/A | Created **Vertex Attribute Matrix** name | -+-----------------------+-----------------+-------------+---------+---------------------------------------------------+ -| Vertex Attribute | NodeTypes | int8_t | (1) | Specifies the type of node in the **Geometry** | -| Array*\* | | | | | -+-----------------------+-----------------+-------------+---------+---------------------------------------------------+ -| Attribute Matrix*\* | FaceData | Face | N/A | Created **Face Attribute Matrix** name | -+-----------------------+-----------------+-------------+---------+---------------------------------------------------+ -| Face Attribute | FaceLabels | int32_t | (2) | Specifies which **Features** are on either side | -| Array*\* | | | | of each \**Face | -+-----------------------+-----------------+-------------+---------+---------------------------------------------------+ -| Attribute Matrix*\* | FaceFeatureData | Face | N/A | Feature Attribute Matrix*\* of the created *Face | -| | | Feature | | Labels* | -+-----------------------+-----------------+-------------+---------+---------------------------------------------------+ -| Any \**Face Attribute | None | List of | Any | The set of transferred **Cell Attribute Arrays** | -| Array | | DataPath | | | -+-----------------------+-----------------+-------------+---------+---------------------------------------------------+ - -Example Pipelines -================= - -:: - - Pipelines/ComplexCore/SurfaceNets_Demo.d3dpipeline - -Citations -========= - -{1}\ `SurfaceNets for Multi-Label Segmentations with Preservation of Sharp -Boundaries `__ - -License & Copyright -=================== - -``Sarah F. Frisken, SurfaceNets for Multi-Label Segmentations with Preservation of Sharp Boundaries, Journal of Computer Graphics Techniques (JCGT), vol. 11, no. 1, 34–54, 2022`` -http://jcgt.org/published/0011/01/03 - -DREAM.3D Mailing Lists -====================== - -If you need more help with a **Filter**, please consider asking your question on the `DREAM.3D Users Google -group! `__ diff --git a/src/Plugins/ComplexCore/docs/TriangleCentroidFilter.md b/src/Plugins/ComplexCore/docs/TriangleCentroidFilter.md index 34cef2af8c..d52ea8148f 100644 --- a/src/Plugins/ComplexCore/docs/TriangleCentroidFilter.md +++ b/src/Plugins/ComplexCore/docs/TriangleCentroidFilter.md @@ -1,37 +1,37 @@ Generate Triangle Centroids ============ -## Group (Subgroup) ## +## Group (Subgroup) Surface Meshing (Misc) -## Description ## +## Description 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 ## +## Parameters None -## Required Geometry ## +## Required Geometry Triangle -## Required Objects ## +## Required Objects None -## Created Objects ## +## Created Objects | Kind | Default Name | Type | Comp Dims | Description | |--------------------------|---------------|--------|-------------|-----------------------------------------| -| Face Attribute Array | FaceCentroids | float32 | (1) | Specifies the centroid of each **Face | +| Face Attribute Array | FaceCentroids | float32 | (1) | Specifies the centroid of each Face | -## Example Pipelines ## +## Example Pipelines + Triangle_Face_Data_Demo.d3dpipeline -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/ComplexCore/docs/TriangleCentroidFilter.rst b/src/Plugins/ComplexCore/docs/TriangleCentroidFilter.rst deleted file mode 100644 index fd7fb36580..0000000000 --- a/src/Plugins/ComplexCore/docs/TriangleCentroidFilter.rst +++ /dev/null @@ -1,55 +0,0 @@ -=========================== -Generate Triangle Centroids -=========================== - - -Group (Subgroup) -================ - -Surface Meshing (Misc) - -Description -=========== - -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 -==================== ============= ======= ========= ====================================== - -Example Pipelines -================= - -- Triangle_Face_Data_Demo.d3dpipeline - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/TriangleDihedralAngleFilter.md b/src/Plugins/ComplexCore/docs/TriangleDihedralAngleFilter.md index 99b7068222..0670d31c49 100644 --- a/src/Plugins/ComplexCore/docs/TriangleDihedralAngleFilter.md +++ b/src/Plugins/ComplexCore/docs/TriangleDihedralAngleFilter.md @@ -1,39 +1,39 @@ # TriangleDihedralAngleFilter -## Group (Subgroup) ## +## Group (Subgroup) Surface Meshing (Misc) -## Description ## +## Description This **Filter** computes the minimum dihedral angle of each **Triangle** in a **Triangle Geometry** by utilizing matrix mathematics -## Parameters ## +## Parameters None -## Required Geometry ## +## Required Geometry Triangle -## Required Objects ## +## Required Objects None -## Created Objects ## +## 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 | +| 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 | -## Example Pipelines ## +## Example Pipelines + (03) SmallIN100 Mesh Statistics + Triangle_Face_Data_Demo.d3dpipeline -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/ComplexCore/docs/TriangleDihedralAngleFilter.rst b/src/Plugins/ComplexCore/docs/TriangleDihedralAngleFilter.rst deleted file mode 100644 index 79cbda1989..0000000000 --- a/src/Plugins/ComplexCore/docs/TriangleDihedralAngleFilter.rst +++ /dev/null @@ -1,60 +0,0 @@ -=========================== -TriangleDihedralAngleFilter -=========================== - - -Group (Subgroup) -================ - -Surface Meshing (Misc) - -Description -=========== - -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 | di | double | (1) | Specifies the minimum dihedral angle of each | -| | hedralAngles | array | | triangle of each \**Face | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Example Pipelines -================= - -- - - (3) SmallIN100 Mesh Statistics - -- Triangle_Face_Data_Demo.d3dpipeline - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/TriangleNormalFilter.md b/src/Plugins/ComplexCore/docs/TriangleNormalFilter.md index f8e584d6a8..d63b25249a 100644 --- a/src/Plugins/ComplexCore/docs/TriangleNormalFilter.md +++ b/src/Plugins/ComplexCore/docs/TriangleNormalFilter.md @@ -1,11 +1,11 @@ # Calculate Triangle Normals -## Group (Subgroup) ## +## Group (Subgroup) Surface Meshing (Misc) -## Description ## +## Description This **Filter** computes the normal of each **Triangle** in a **Triangle Geometry** by utilizing matrix subtraction, cross product, and normalization to implement the following theory: For a triangle with point1, point2, point3, if the vector U = point2 - point1 and the vector V = point3 - point1 @@ -17,31 +17,31 @@ 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 ## +## Parameters None -## Required Geometry ## +## Required Geometry Triangle -## Required Objects ## +## Required Objects None -## Created Objects ## +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| -| Face Attribute Array | FaceNormals | double array | (1) | Specifies the normal of each **Face | +| Kind | Default Name | Type | Comp Dims | Description | +|---------------------------|--------------|----------|--------|---------------------------------------------| +| Face Attribute Array | FaceNormals | double array | (1) | Specifies the normal of each Face | -## Example Pipelines ## +## Example Pipelines + (03) SmallIN100 Mesh Statistics + Triangle_Face_Data_Demo.d3dpipeline -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/ComplexCore/docs/TriangleNormalFilter.rst b/src/Plugins/ComplexCore/docs/TriangleNormalFilter.rst deleted file mode 100644 index 929c32bcd0..0000000000 --- a/src/Plugins/ComplexCore/docs/TriangleNormalFilter.rst +++ /dev/null @@ -1,68 +0,0 @@ -========================== -Calculate Triangle Normals -========================== - - -Group (Subgroup) -================ - -Surface Meshing (Misc) - -Description -=========== - -This **Filter** computes the normal of each **Triangle** in a **Triangle Geometry** by utilizing matrix subtraction, -cross product, and normalization to implement the following theory: For a triangle with point1, point2, point3, if the -vector U = point2 - point1 and the vector V = point3 - point1 - -:: - - Nx = UyVz - UzVy - Ny = UzVx - UxVz - Nz = UxVy - UyVx - - 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 -==================== ============ ============ ========== ==================================== - -Example Pipelines -================= - -- - - (3) SmallIN100 Mesh Statistics - -- Triangle_Face_Data_Demo.d3dpipeline - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/UncertainRegularGridSampleSurfaceMesh.md b/src/Plugins/ComplexCore/docs/UncertainRegularGridSampleSurfaceMesh.md index 7085e09267..eabb3a68cf 100644 --- a/src/Plugins/ComplexCore/docs/UncertainRegularGridSampleSurfaceMesh.md +++ b/src/Plugins/ComplexCore/docs/UncertainRegularGridSampleSurfaceMesh.md @@ -19,7 +19,7 @@ This **Filter** "samples" a triangulated surface mesh on a rectilinear grid, but ## 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 | @@ -34,13 +34,13 @@ 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 | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | diff --git a/src/Plugins/ComplexCore/docs/UncertainRegularGridSampleSurfaceMesh.rst b/src/Plugins/ComplexCore/docs/UncertainRegularGridSampleSurfaceMesh.rst deleted file mode 100644 index 80cfe02245..0000000000 --- a/src/Plugins/ComplexCore/docs/UncertainRegularGridSampleSurfaceMesh.rst +++ /dev/null @@ -1,85 +0,0 @@ -================================================== -Sample Triangle Geometry on Uncertain Regular Grid -================================================== - - -Group (Subgroup) -================ - -Sampling (Resolution) - -Description -=========== - -This **Filter** “samples” a triangulated surface mesh on a rectilinear grid, but with “uncertainty” in the absolute -position of the **Cells**. The “uncertainty” is meant to simulate the possible positioning error in a sampling probe. -The user can specify the number of **Cells** along the X, Y, and Z directions in addition to the resolution in each -direction and origin to define a rectilinear grid. The sampling, with “uncertainty”, is then performed by the following -steps: - -1. Determine the bounding box and **Triangle** list of each **Feature** by scanning all **Triangles** and noting the - **Features** on either side of the **Triangle** -2. For each **Cell** in the rectilinear grid, perturb the location of the **Cell** by generating a three random numbers - between [-1, 1] and multiplying them by the three uncertainty values (one for each direction) -3. For each perturbed **Cell** in the rectilinear grid, determine which bounding box(es) they fall in (*Note:* the - bounding box of multiple **Features** can overlap) -4. 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**) -5. Assign the **Feature** number that the **Cell** falls within to the *Feature Ids* array in the new rectilinear grid - geometry - -**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 -================ ============== ===== ========== ==================================================== - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/UncertainRegularGridSampleSurfaceMeshFilter.md b/src/Plugins/ComplexCore/docs/UncertainRegularGridSampleSurfaceMeshFilter.md index 6c95da9240..9d0cf733b4 100644 --- a/src/Plugins/ComplexCore/docs/UncertainRegularGridSampleSurfaceMeshFilter.md +++ b/src/Plugins/ComplexCore/docs/UncertainRegularGridSampleSurfaceMeshFilter.md @@ -19,7 +19,7 @@ This **Filter** "samples" a triangulated surface mesh on a rectilinear grid, but ## 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 | @@ -34,13 +34,13 @@ 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 | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | diff --git a/src/Plugins/ComplexCore/docs/UncertainRegularGridSampleSurfaceMeshFilter.rst b/src/Plugins/ComplexCore/docs/UncertainRegularGridSampleSurfaceMeshFilter.rst deleted file mode 100644 index 80cfe02245..0000000000 --- a/src/Plugins/ComplexCore/docs/UncertainRegularGridSampleSurfaceMeshFilter.rst +++ /dev/null @@ -1,85 +0,0 @@ -================================================== -Sample Triangle Geometry on Uncertain Regular Grid -================================================== - - -Group (Subgroup) -================ - -Sampling (Resolution) - -Description -=========== - -This **Filter** “samples” a triangulated surface mesh on a rectilinear grid, but with “uncertainty” in the absolute -position of the **Cells**. The “uncertainty” is meant to simulate the possible positioning error in a sampling probe. -The user can specify the number of **Cells** along the X, Y, and Z directions in addition to the resolution in each -direction and origin to define a rectilinear grid. The sampling, with “uncertainty”, is then performed by the following -steps: - -1. Determine the bounding box and **Triangle** list of each **Feature** by scanning all **Triangles** and noting the - **Features** on either side of the **Triangle** -2. For each **Cell** in the rectilinear grid, perturb the location of the **Cell** by generating a three random numbers - between [-1, 1] and multiplying them by the three uncertainty values (one for each direction) -3. For each perturbed **Cell** in the rectilinear grid, determine which bounding box(es) they fall in (*Note:* the - bounding box of multiple **Features** can overlap) -4. 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**) -5. Assign the **Feature** number that the **Cell** falls within to the *Feature Ids* array in the new rectilinear grid - geometry - -**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 -================ ============== ===== ========== ==================================================== - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/VtkRectilinearGridWriterFilter.md b/src/Plugins/ComplexCore/docs/VtkRectilinearGridWriterFilter.md index 7d0d48f469..91c411e7cc 100644 --- a/src/Plugins/ComplexCore/docs/VtkRectilinearGridWriterFilter.md +++ b/src/Plugins/ComplexCore/docs/VtkRectilinearGridWriterFilter.md @@ -1,17 +1,17 @@ -# Vtk Rectilinear Grid Exporter # +# Vtk Rectilinear Grid Exporter -## Group (Subgroup) ## +## Group (Subgroup) I/O Filters -## Description ## +## Description 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 ## +## Parameters | Name | Type | |------|------| @@ -26,26 +26,26 @@ This Filter reads the **Feature** and phase ids together with image parameters r | Write IPF Colors | Boolean (On or Off) | | Write Binary File | Boolean (On or Off) | -## Required DataContainers ## +## Required DataContainers Voxel -## Required Objects ## +## 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 ## +## Created Objects None -## Example Pipelines ## +## Example Pipelines -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/ComplexCore/docs/VtkRectilinearGridWriterFilter.rst b/src/Plugins/ComplexCore/docs/VtkRectilinearGridWriterFilter.rst deleted file mode 100644 index 3497506e2f..0000000000 --- a/src/Plugins/ComplexCore/docs/VtkRectilinearGridWriterFilter.rst +++ /dev/null @@ -1,103 +0,0 @@ -============================= -Vtk Rectilinear Grid Exporter -============================= - - -Group (Subgroup) -================ - -I/O Filters - -Description -=========== - -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 | Values should be | Segment | -| | | which **Feature** each | present from | Features | -| | | **Cell** belongs. | segmentation of | (Misori | -| | | | experimental data | entation, | -| | | | or synthetic | C-Axis | -| | | | generation and | Misori | -| | | | cannot be | entation, | -| | | | determined by this | Scalar) | -| | | | filter. Not having | (Reconst | -| | | | these values will | ruction), | -| | | | result in the | Read Dx | -| | | | filter to fail/not | File | -| | | | execute. | (IO), | -| | | | | Read Ph | -| | | | | File | -| | | | | (IO), | -| | | | | Pack | -| | | | | Primary | -| | | | | Phases | -| | | | | (S | -| | | | | yntheticB | -| | | | | uilding), | -| | | | | Insert | -| | | | | Pr | -| | | | | ecipitate | -| | | | | Phases | -| | | | | (S | -| | | | | yntheticB | -| | | | | uilding), | -| | | | | Establish | -| | | | | Matrix | -| | | | | Phase | -| | | | | ( | -| | | | | Synthetic | -| | | | | Building) | -+--------------+----------------------------------+--------------------------------+---------------------+-----------+ - -Created Objects -=============== - -None - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/WriteASCIIDataFilter.md b/src/Plugins/ComplexCore/docs/WriteASCIIDataFilter.md index 5a10b841ad..cb65ac6c45 100644 --- a/src/Plugins/ComplexCore/docs/WriteASCIIDataFilter.md +++ b/src/Plugins/ComplexCore/docs/WriteASCIIDataFilter.md @@ -1,15 +1,15 @@ # Write ASCII Data -## Group (Subgroup) ## +## Group (Subgroup) IO (Output) (Write) (Export) (Text) (CSV) (ASCII) -## Description ## +## Description This **Filter** accepts DataArray(s) as input, extracts the data, creates the file(s), and writes it out according to parameter choices -## Parameters ## +## Parameters | Name | Type | Decision | |-------|-----|----------| @@ -19,21 +19,21 @@ This **Filter** accepts DataArray(s) as input, extracts the data, creates the fi | 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 ## +## Required Geometry None -## Required Objects ## +## 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 ## +## Created Objects None -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/ComplexCore/docs/WriteASCIIDataFilter.rst b/src/Plugins/ComplexCore/docs/WriteASCIIDataFilter.rst deleted file mode 100644 index d268f20d1a..0000000000 --- a/src/Plugins/ComplexCore/docs/WriteASCIIDataFilter.rst +++ /dev/null @@ -1,58 +0,0 @@ -================ -Write ASCII Data -================ - - -Group (Subgroup) -================ - -IO (Output) (Write) (Export) (Text) (CSV) (ASCII) - -Description -=========== - -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 - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/WriteBinaryDataFilter.md b/src/Plugins/ComplexCore/docs/WriteBinaryDataFilter.md index 6ae49bd682..45c95390de 100644 --- a/src/Plugins/ComplexCore/docs/WriteBinaryDataFilter.md +++ b/src/Plugins/ComplexCore/docs/WriteBinaryDataFilter.md @@ -1,15 +1,15 @@ # WriteBinaryData -## Group (Subgroup) ## +## Group (Subgroup) IO (Output) (Write) (Export) (Binary) -## Description ## +## Description 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 ## +## Parameters | Name | Type | Decision | |-------|------|----------| @@ -17,21 +17,21 @@ This **Filter** accepts DataArray(s) as input, extracts the data, creates the fi | Output Path | Filesystem::path | Directory to store printed array files | | File Extension | string | The file extension used for generated files | -## Required Geometry ## +## Required Geometry None -## Required Objects ## +## 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 ## +## Created Objects None -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/ComplexCore/docs/WriteBinaryDataFilter.rst b/src/Plugins/ComplexCore/docs/WriteBinaryDataFilter.rst deleted file mode 100644 index 97475c7875..0000000000 --- a/src/Plugins/ComplexCore/docs/WriteBinaryDataFilter.rst +++ /dev/null @@ -1,56 +0,0 @@ -=============== -WriteBinaryData -=============== - - -Group (Subgroup) -================ - -IO (Output) (Write) (Export) (Binary) - -Description -=========== - -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 - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ComplexCore/docs/WriteStlFileFilter.md b/src/Plugins/ComplexCore/docs/WriteStlFileFilter.md index da6b35cd7b..9d28762033 100644 --- a/src/Plugins/ComplexCore/docs/WriteStlFileFilter.md +++ b/src/Plugins/ComplexCore/docs/WriteStlFileFilter.md @@ -22,10 +22,10 @@ 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 | +| 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 diff --git a/src/Plugins/ComplexCore/docs/WriteStlFileFilter.rst b/src/Plugins/ComplexCore/docs/WriteStlFileFilter.rst deleted file mode 100644 index 8caf924a13..0000000000 --- a/src/Plugins/ComplexCore/docs/WriteStlFileFilter.rst +++ /dev/null @@ -1,63 +0,0 @@ -======================================= -Export STL Files From Triangle Geometry -======================================= - - -Group (Subgroup) -================ - -IO (Output) - -Description -=========== - -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 | int32 | (2) | Specifies which **Phases** of **Features** are | -| | Phases | | | 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 - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ITKImageProcessing/PortingITKImageProcessingFilter.md b/src/Plugins/ITKImageProcessing/PortingITKImageProcessingFilter.md index 14d9e0f01f..8101614b92 100644 --- a/src/Plugins/ITKImageProcessing/PortingITKImageProcessingFilter.md +++ b/src/Plugins/ITKImageProcessing/PortingITKImageProcessingFilter.md @@ -1,15 +1,15 @@ -# Porting ITK Image Processing Filter # +# Porting ITK Image Processing Filter -## Updating the Legacy UUID Maps ## +## Updating the Legacy UUID Maps This **Plugin** contains three folders of filters instructions for porting to and moving to ***Filters Folder*** are below: -### If Porting From ***SIMPL*** to ***Filters Folder*** ### +### If Porting From ***SIMPL*** to ***Filters Folder*** Use the **ComplexFilterGen** module distributed in ***SIMPL DREAM3D***. This module will automatically update the LegacyUUIDMapping for this **Plugin**. - ### If Moving to ***Filters*** ### + ### If Moving to ***Filters***
        1. Open the LegacyUUIDMapping header file for this Plugin
        2. Uncomment the include statement for the filter being moved
        3. diff --git a/src/Plugins/ITKImageProcessing/PortingITKImageProcessingFilter.rst b/src/Plugins/ITKImageProcessing/PortingITKImageProcessingFilter.rst deleted file mode 100644 index 407d56dcfa..0000000000 --- a/src/Plugins/ITKImageProcessing/PortingITKImageProcessingFilter.rst +++ /dev/null @@ -1,63 +0,0 @@ -=================================== -Porting ITK Image Processing Filter -=================================== - - -Updating the Legacy UUID Maps -============================= - -This **Plugin** contains three folders of filters instructions for porting to and moving to **Filters Folder** are -below: - -If Porting From **SIMPL** to **Filters Folder** ------------------------------------------------ - -Use the **ComplexFilterGen** module distributed in **SIMPL DREAM3D**. This module will automatically update the -LegacyUUIDMapping for this **Plugin**. - -### If Moving to **Filters** ### - -.. raw:: html - -
            - -.. raw:: html - -
          1. - -Open the LegacyUUIDMapping header file for this Plugin - -.. raw:: html - -
          2. - -.. raw:: html - -
          3. - -Uncomment the include statement for the filter being moved - -.. raw:: html - -
          4. - -.. raw:: html - -
          5. - -Uncomment the map entry for the filter being moved - -.. raw:: html - -
          6. - -.. raw:: html - -
          - -When working with the **LegacyUUIDMapping** header file in this **Plugin** be sure to make sure the commented out tokens -are not removed. Their syntax is one of the following: \*\ **@@\__HEADER\__TOKEN\__DO\__NOT\__DELETE\_\_@@\*** - -or - -\*\ **@@\__MAP\__UPDATE\__TOKEN\__DO\__NOT\__DELETE\_\_@@\*** diff --git a/src/Plugins/ITKImageProcessing/docs/ITKAbsImage.md b/src/Plugins/ITKImageProcessing/docs/ITKAbsImage.md index 2dd1425208..55239853e4 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKAbsImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKAbsImage.md @@ -13,7 +13,7 @@ itk::Math::abs() is used to perform the computation. ## Parameters | Name | Type | Description | -|------|------|-------------| +|------------|------| --------------------------------- | ## Required Geometry diff --git a/src/Plugins/ITKImageProcessing/docs/ITKAbsImage.rst b/src/Plugins/ITKImageProcessing/docs/ITKAbsImage.rst deleted file mode 100644 index 2d0925422a..0000000000 --- a/src/Plugins/ITKImageProcessing/docs/ITKAbsImage.rst +++ /dev/null @@ -1,62 +0,0 @@ -==================== -ITK Abs Image Filter -==================== - - -Computes the absolute value of each pixel. - -Group (Subgroup) -================ - -ITKImageIntensity (ImageIntensity) - -Description -=========== - -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 -======================= ======== ================================================================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKAcosImage.md b/src/Plugins/ITKImageProcessing/docs/ITKAcosImage.md index 4c30689d74..f826759703 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKAcosImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKAcosImage.md @@ -24,7 +24,7 @@ The filter expects both images to have the same dimension (e.g. both 2D, or both ## Parameters | Name | Type | Description | -|------|------|-------------| +|------------|------| --------------------------------- | ## Required Geometry diff --git a/src/Plugins/ITKImageProcessing/docs/ITKAcosImage.rst b/src/Plugins/ITKImageProcessing/docs/ITKAcosImage.rst deleted file mode 100644 index b4a3e10434..0000000000 --- a/src/Plugins/ITKImageProcessing/docs/ITKAcosImage.rst +++ /dev/null @@ -1,71 +0,0 @@ -===================== -ITK Acos Image Filter -===================== - - -Computes the inverse cosine of each pixel. - -Group (Subgroup) -================ - -ITKImageIntensity (ImageIntensity) - -Description -=========== - -This filter is templated over the pixel type of the input image and the pixel type of the output image. - -The filter walks over all the pixels in the input image, and for each pixel does do the following: - -- cast the pixel value to double , -- apply the std::acos() function to the double value -- cast the double value resulting from std::acos() to the pixel type of the output image -- store the casted value into the output image. - -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 -======================= ======== ================================================================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKAdaptiveHistogramEqualizationImage.md b/src/Plugins/ITKImageProcessing/docs/ITKAdaptiveHistogramEqualizationImage.md index bf34451d32..40d7376d40 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKAdaptiveHistogramEqualizationImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKAdaptiveHistogramEqualizationImage.md @@ -25,7 +25,7 @@ For detail description, reference "Adaptive Image Contrast Enhancement using Gen ## 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. | diff --git a/src/Plugins/ITKImageProcessing/docs/ITKAdaptiveHistogramEqualizationImage.rst b/src/Plugins/ITKImageProcessing/docs/ITKAdaptiveHistogramEqualizationImage.rst deleted file mode 100644 index 34066eb885..0000000000 --- a/src/Plugins/ITKImageProcessing/docs/ITKAdaptiveHistogramEqualizationImage.rst +++ /dev/null @@ -1,93 +0,0 @@ -================================================ -ITK Adaptive Histogram Equalization Image Filter -================================================ - - -Power Law Adaptive Histogram Equalization. - -Group (Subgroup) -================ - -ITKImageStatistics (ImageStatistics) - -Description -=========== - -Histogram equalization modifies the contrast in an image. The AdaptiveHistogramEqualizationImageFilter is a superset of -many contrast enhancing filters. By modifying its parameters (alpha, beta, and window), the -AdaptiveHistogramEqualizationImageFilter can produce an adaptively equalized histogram or a version of unsharp mask -(local mean subtraction). Instead of applying a strict histogram equalization in a window about a pixel, this filter -prescribes a mapping function (power law) controlled by the parameters alpha and beta. - -The parameter alpha controls how much the filter acts like the classical histogram equalization method (alpha=0) to how -much the filter acts like an unsharp mask (alpha=1). - -The parameter beta controls how much the filter acts like an unsharp mask (beta=0) to much the filter acts like pass -through (beta=1, with alpha=1). - -The parameter window controls the size of the region over which local statistics are calculated. The size of the window -is controlled by SetRadius the default Radius is 5 in all directions. - -By altering alpha, beta and window, a host of equalization and unsharp masking filters is available. - -The boundary condition ignores the part of the neighborhood outside the image, and over-weights the valid part of the -neighborhood. - -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 -======================= ======== ================================================================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKAsinImage.md b/src/Plugins/ITKImageProcessing/docs/ITKAsinImage.md index 092dd764e8..1763e93925 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKAsinImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKAsinImage.md @@ -24,7 +24,7 @@ The filter expects both images to have the same dimension (e.g. both 2D, or both ## Parameters | Name | Type | Description | -|------|------|-------------| +|------------|------| --------------------------------- | ## Required Geometry diff --git a/src/Plugins/ITKImageProcessing/docs/ITKAsinImage.rst b/src/Plugins/ITKImageProcessing/docs/ITKAsinImage.rst deleted file mode 100644 index 22f20a3842..0000000000 --- a/src/Plugins/ITKImageProcessing/docs/ITKAsinImage.rst +++ /dev/null @@ -1,71 +0,0 @@ -===================== -ITK Asin Image Filter -===================== - - -Computes the sine of each pixel. - -Group (Subgroup) -================ - -ITKImageIntensity (ImageIntensity) - -Description -=========== - -This filter is templated over the pixel type of the input image and the pixel type of the output image. - -The filter walks over all the pixels in the input image, and for each pixel does the following: - -- cast the pixel value to double , -- apply the std::asin() function to the double value, -- cast the double value resulting from std::asin() to the pixel type of the output image, -- store the casted value into the output image. - -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 -======================= ======== ================================================================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKAtanImage.md b/src/Plugins/ITKImageProcessing/docs/ITKAtanImage.md index b4892e9141..6e466e21f1 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKAtanImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKAtanImage.md @@ -20,7 +20,7 @@ The filter walks over all the pixels in the input image, and for each pixel does ## Parameters | Name | Type | Description | -|------|------|-------------| +|------------|------| --------------------------------- | ## Required Geometry diff --git a/src/Plugins/ITKImageProcessing/docs/ITKAtanImage.rst b/src/Plugins/ITKImageProcessing/docs/ITKAtanImage.rst deleted file mode 100644 index 6670194936..0000000000 --- a/src/Plugins/ITKImageProcessing/docs/ITKAtanImage.rst +++ /dev/null @@ -1,69 +0,0 @@ -===================== -ITK Atan Image Filter -===================== - - -Computes the one-argument inverse tangent of each pixel. - -Group (Subgroup) -================ - -ITKImageIntensity (ImageIntensity) - -Description -=========== - -This filter is templated over the pixel type of the input image and the pixel type of the output image. - -The filter walks over all the pixels in the input image, and for each pixel does the following: - -- cast the pixel value to double , -- apply the std::atan() function to the double value, -- 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 -======================= ======== ================================================================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKBinaryContourImage.md b/src/Plugins/ITKImageProcessing/docs/ITKBinaryContourImage.md index 88c9fc1285..23dca91ca2 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKBinaryContourImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKBinaryContourImage.md @@ -25,7 +25,7 @@ https://www.insight-journal.org/browse/publication/217 ## 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. | diff --git a/src/Plugins/ITKImageProcessing/docs/ITKBinaryContourImage.rst b/src/Plugins/ITKImageProcessing/docs/ITKBinaryContourImage.rst deleted file mode 100644 index 3081231a15..0000000000 --- a/src/Plugins/ITKImageProcessing/docs/ITKBinaryContourImage.rst +++ /dev/null @@ -1,88 +0,0 @@ -=============================== -ITK Binary Contour Image Filter -=============================== - - -Labels the pixels on the border of the objects in a binary image. - -Group (Subgroup) -================ - -ITKImageLabel (ImageLabel) - -Description -=========== - -BinaryContourImageFilter takes a binary image as input, where the pixels in the objects are the pixels with a value -equal to ForegroundValue. Only the pixels on the contours of the objects are kept. The pixels not on the border are -changed to BackgroundValue. - -The connectivity can be changed to minimum or maximum connectivity with SetFullyConnected() . Full connectivity produces -thicker contours. - -https://www.insight-journal.org/browse/publication/217 - -Author ------- - -Gaetan Lehmann. Biologie du Developpement et de la Reproduction, INRA de Jouy-en-Josas, France. - -Related Filters ---------------- - -- 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 -======================= ======== ==================================================================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKBinaryDilateImage.md b/src/Plugins/ITKImageProcessing/docs/ITKBinaryDilateImage.md index 81969d23fd..91ae955c8e 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKBinaryDilateImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKBinaryDilateImage.md @@ -26,7 +26,7 @@ for arbitrary size and shape". IEEE Transactions on Image Processing. Vol. 9. No ## 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 | diff --git a/src/Plugins/ITKImageProcessing/docs/ITKBinaryDilateImage.rst b/src/Plugins/ITKImageProcessing/docs/ITKBinaryDilateImage.rst deleted file mode 100644 index 93b04ddabb..0000000000 --- a/src/Plugins/ITKImageProcessing/docs/ITKBinaryDilateImage.rst +++ /dev/null @@ -1,86 +0,0 @@ -============================== -ITK Binary Dilate Image Filter -============================== - - -Fast binary dilation of a single intensity value in the image. - -Group (Subgroup) -================ - -ITKBinaryMathematicalMorphology (BinaryMathematicalMorphology) - -Description -=========== - -BinaryDilateImageFilter is a binary dilation morphologic operation on the foreground of an image. Only the value -designated by the intensity value “SetForegroundValue()” (alias as SetDilateValue() ) is considered as foreground, and -other intensity values are considered background. - -Grayscale images can be processed as binary images by selecting a “ForegroundValue” (alias “DilateValue”). Pixel values -matching the dilate value are considered the “foreground” and all other pixels are “background”. This is useful in -processing segmented images where all pixels in segment #1 have value 1 and pixels in segment #2 have value 2, etc. A -particular “segment number” can be processed. ForegroundValue defaults to the maximum possible value of the PixelType. - -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. A reasonable choice of structuring element is -itk::BinaryBallStructuringElement . - -This implementation is based on the papers: - -L.Vincent “Morphological transformations of binary images with arbitrary structuring elements”, and - -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 -======================= ======== ==================================================================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKBinaryErodeImage.md b/src/Plugins/ITKImageProcessing/docs/ITKBinaryErodeImage.md index 445dc83303..53cfa6c073 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKBinaryErodeImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKBinaryErodeImage.md @@ -26,7 +26,7 @@ for arbitrary size and shape". IEEE Transactions on Image Processing. Vol. 9. No ## 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 | diff --git a/src/Plugins/ITKImageProcessing/docs/ITKBinaryErodeImage.rst b/src/Plugins/ITKImageProcessing/docs/ITKBinaryErodeImage.rst deleted file mode 100644 index 0beddd919f..0000000000 --- a/src/Plugins/ITKImageProcessing/docs/ITKBinaryErodeImage.rst +++ /dev/null @@ -1,87 +0,0 @@ -============================= -ITK Binary Erode Image Filter -============================= - - -Fast binary erosion of a single intensity value in the image. - -Group (Subgroup) -================ - -ITKBinaryMathematicalMorphology (BinaryMathematicalMorphology) - -Description -=========== - -BinaryErodeImageFilter is a binary erosion morphologic operation on the foreground of an image. Only the value -designated by the intensity value “SetForegroundValue()” (alias as SetErodeValue() ) is considered as foreground, and -other intensity values are considered background. - -Grayscale images can be processed as binary images by selecting a “ForegroundValue” (alias “ErodeValue”). Pixel values -matching the erode value are considered the “foreground” and all other pixels are “background”. This is useful in -processing segmented images where all pixels in segment #1 have value 1 and pixels in segment #2 have value 2, etc. A -particular “segment number” can be processed. ForegroundValue defaults to the maximum possible value of the PixelType. -The eroded pixels will receive the BackgroundValue (defaults to NumericTraits::NonpositiveMin() ). - -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. A reasonable choice of structuring element is -itk::BinaryBallStructuringElement . - -This implementation is based on the papers: - -L.Vincent “Morphological transformations of binary images with arbitrary structuring elements”, and - -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 -======================= ======== ==================================================================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKBinaryMorphologicalClosingImage.md b/src/Plugins/ITKImageProcessing/docs/ITKBinaryMorphologicalClosingImage.md index 68eb248e72..2024d1787e 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKBinaryMorphologicalClosingImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKBinaryMorphologicalClosingImage.md @@ -25,7 +25,7 @@ This code was contributed in the Insight Journal paper: "Binary morphological cl ## 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. | diff --git a/src/Plugins/ITKImageProcessing/docs/ITKBinaryMorphologicalClosingImage.rst b/src/Plugins/ITKImageProcessing/docs/ITKBinaryMorphologicalClosingImage.rst deleted file mode 100644 index a96694597c..0000000000 --- a/src/Plugins/ITKImageProcessing/docs/ITKBinaryMorphologicalClosingImage.rst +++ /dev/null @@ -1,90 +0,0 @@ -============================================= -ITK Binary Morphological Closing Image Filter -============================================= - - -binary morphological closing of an image. - -Group (Subgroup) -================ - -ITKBinaryMathematicalMorphology (BinaryMathematicalMorphology) - -Description -=========== - -This filter removes small (i.e., smaller than the structuring element) holes and tube like structures in the interior or -at the boundaries of the image. The morphological closing of an image “f” is defined as: Closing(f) = -Erosion(Dilation(f)). - -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. - -This code was contributed in the Insight Journal paper: “Binary morphological closing and opening image filters” by -Lehmann G. https://www.insight-journal.org/browse/publication/58 - -Author ------- - -Gaetan Lehmann. Biologie du Developpement et de la Reproduction, INRA de Jouy-en-Josas, France. - -Related Filters ---------------- - -- 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 -======================= ======== ==================================================================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKBinaryMorphologicalOpeningImage.md b/src/Plugins/ITKImageProcessing/docs/ITKBinaryMorphologicalOpeningImage.md index b19ed50fab..faaa657156 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKBinaryMorphologicalOpeningImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKBinaryMorphologicalOpeningImage.md @@ -25,7 +25,7 @@ This code was contributed in the Insight Journal paper: "Binary morphological cl ## 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 | diff --git a/src/Plugins/ITKImageProcessing/docs/ITKBinaryMorphologicalOpeningImage.rst b/src/Plugins/ITKImageProcessing/docs/ITKBinaryMorphologicalOpeningImage.rst deleted file mode 100644 index 7fbd500f11..0000000000 --- a/src/Plugins/ITKImageProcessing/docs/ITKBinaryMorphologicalOpeningImage.rst +++ /dev/null @@ -1,88 +0,0 @@ -============================================= -ITK Binary Morphological Opening Image Filter -============================================= - - -binary morphological opening of an image. - -Group (Subgroup) -================ - -ITKBinaryMathematicalMorphology (BinaryMathematicalMorphology) - -Description -=========== - -This filter removes small (i.e., smaller than the structuring element) structures in the interior or at the boundaries -of the image. The morphological opening of an image “f” is defined as: Opening(f) = Dilatation(Erosion(f)). - -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. - -This code was contributed in the Insight Journal paper: “Binary morphological closing and opening image filters” by -Lehmann G. https://www.insight-journal.org/browse/publication/58 - -Author ------- - -Gaetan Lehmann. Biologie du Developpement et de la Reproduction, INRA de Jouy-en-Josas, France. - -Related Filters ---------------- - -- 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 -======================= ======== ==================================================================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKBinaryOpeningByReconstructionImage.md b/src/Plugins/ITKImageProcessing/docs/ITKBinaryOpeningByReconstructionImage.md index b0486ae8b9..2b2682270a 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKBinaryOpeningByReconstructionImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKBinaryOpeningByReconstructionImage.md @@ -25,7 +25,7 @@ This implementation was taken from the Insight Journal paper: https://www.insigh ## 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. | diff --git a/src/Plugins/ITKImageProcessing/docs/ITKBinaryOpeningByReconstructionImage.rst b/src/Plugins/ITKImageProcessing/docs/ITKBinaryOpeningByReconstructionImage.rst deleted file mode 100644 index 9d500ed5fb..0000000000 --- a/src/Plugins/ITKImageProcessing/docs/ITKBinaryOpeningByReconstructionImage.rst +++ /dev/null @@ -1,90 +0,0 @@ -================================================= -ITK Binary Opening By Reconstruction Image Filter -================================================= - - -binary morphological closing of an image. - -Group (Subgroup) -================ - -ITKBinaryMathematicalMorphology (BinaryMathematicalMorphology) - -Description -=========== - -This filter removes small (i.e., smaller than the structuring element) objects in the image. It is defined as: -Opening(f) = ReconstructionByDilatation(Erosion(f)). - -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. - -Author ------- - -Gaetan Lehmann. Biologie du Developpement et de la Reproduction, INRA de Jouy-en-Josas, France. - -Related Filters ---------------- - -This implementation was taken from the Insight Journal paper: https://www.insight-journal.org/browse/publication/176 \* -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 -======================= ======== ==================================================================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKBinaryProjectionImage.md b/src/Plugins/ITKImageProcessing/docs/ITKBinaryProjectionImage.md index 0fa137c122..58cd72ec04 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKBinaryProjectionImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKBinaryProjectionImage.md @@ -31,7 +31,7 @@ This class was contributed to the Insight Journal by Gaetan Lehmann. The origina ## 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() . | diff --git a/src/Plugins/ITKImageProcessing/docs/ITKBinaryProjectionImage.rst b/src/Plugins/ITKImageProcessing/docs/ITKBinaryProjectionImage.rst deleted file mode 100644 index 0935be9ca2..0000000000 --- a/src/Plugins/ITKImageProcessing/docs/ITKBinaryProjectionImage.rst +++ /dev/null @@ -1,93 +0,0 @@ -================================== -ITK Binary Projection Image Filter -================================== - - -Binary projection. - -Group (Subgroup) -================ - -ITKImageStatistics (ImageStatistics) - -Description -=========== - -Image projection is a very common task in image analysis to reduce the dimension of an image. A base filter is provided -with some specialized filters which implement different projection methods. - -This class was contributed to the Insight Journal by Gaetan Lehmann. The original paper can be found at -https://www.insight-journal.org/browse/publication/71 - -Author ------- - -Gaetan Lehmann. Biologie du Developpement et de la Reproduction, INRA de Jouy-en-Josas, France. - -Related Filters ---------------- - -- ProjectionImageFilter -- MedianProjectionImageFilter -- MeanProjectionImageFilter -- MeanProjectionImageFilter -- MaximumProjectionImageFilter -- MinimumProjectionImageFilter -- 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 -======================= ======== ================================================================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKBinaryThinningImage.md b/src/Plugins/ITKImageProcessing/docs/ITKBinaryThinningImage.md index 8bb5cb6a31..8ccb7b8b24 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKBinaryThinningImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKBinaryThinningImage.md @@ -23,7 +23,7 @@ To do: Make this filter ND.* MorphologyImageFilter ## Parameters | Name | Type | Description | -|------|------|-------------| +|------------|------| --------------------------------- | ## Required Geometry diff --git a/src/Plugins/ITKImageProcessing/docs/ITKBinaryThinningImage.rst b/src/Plugins/ITKImageProcessing/docs/ITKBinaryThinningImage.rst deleted file mode 100644 index 09b7105f89..0000000000 --- a/src/Plugins/ITKImageProcessing/docs/ITKBinaryThinningImage.rst +++ /dev/null @@ -1,74 +0,0 @@ -================================ -ITK Binary Thinning Image Filter -================================ - - -This filter computes one-pixel-wide edges of the input image. - -Group (Subgroup) -================ - -ITKBinaryMathematicalMorphology (BinaryMathematicalMorphology) - -Description -=========== - -This class is parameterized over the type of the input image and the type of the output image. - -The input is assumed to be a binary image. If the foreground pixels of the input image do not have a value of 1, they -are rescaled to 1 internally to simplify the computation. - -The filter will produce a skeleton of the object. The output background values are 0, and the foreground values are 1. - -This filter is a sequential thinning algorithm and known to be computational time dependable on the image size. The -algorithm corresponds with the 2D implementation described in: - -Rafael C. Gonzales and Richard E. Woods. Digital Image Processing. Addison Wesley, 491-494, (1993). - -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 -======================= ======== ==================================================================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKBinaryThresholdImage.md b/src/Plugins/ITKImageProcessing/docs/ITKBinaryThresholdImage.md index 73a5a9e78d..cd7fc3d0ac 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKBinaryThresholdImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKBinaryThresholdImage.md @@ -22,7 +22,7 @@ Set the thresholds. The default lower threshold is NumericTraits ## 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() | diff --git a/src/Plugins/ITKImageProcessing/docs/ITKBinaryThresholdImage.rst b/src/Plugins/ITKImageProcessing/docs/ITKBinaryThresholdImage.rst deleted file mode 100644 index d22e8b7fe8..0000000000 --- a/src/Plugins/ITKImageProcessing/docs/ITKBinaryThresholdImage.rst +++ /dev/null @@ -1,95 +0,0 @@ -================================= -ITK Binary Threshold Image Filter -================================= - - -.. role:: raw-latex(raw) - :format: latex -.. - -Binarize an input image by thresholding. - -Group (Subgroup) -================ - -ITKThresholding (Thresholding) - -Description -=========== - -This filter produces an output image whose pixels are either one of two values ( OutsideValue or InsideValue ), -depending on whether the corresponding input image pixels lie between the two thresholds ( LowerThreshold and -UpperThreshold ). Values equal to either threshold is considered to be between the thresholds. - -More precisely :raw-latex:`\f[` Output(x_i) = - -.. raw:: latex - - \begin{cases} InsideValue & \text{if \f$LowerThreshold \leq x_i \leq UpperThreshold\f$} \\ OutsideValue & \text{otherwise} \end{cases} - -:raw-latex:`\f]` - -This filter is templated over the input image type and the output image type. - -The filter expect both images to have the same number of dimensions. - -The default values for LowerThreshold and UpperThreshold are: LowerThreshold = NumericTraits::NonpositiveMin() ; -UpperThreshold = NumericTraits::max() ; Therefore, generally only one of these needs to be set, depending on whether the -user wants to threshold above or below the desired threshold. - -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 -======================= ======== ================================================================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKBlackTopHatImage.md b/src/Plugins/ITKImageProcessing/docs/ITKBlackTopHatImage.md index c7e6d516ab..dc6fde2646 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKBlackTopHatImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKBlackTopHatImage.md @@ -22,7 +22,7 @@ Top-hats are described in Chapter 4.5 of Pierre Soille's book "Morphological Ima ## 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 | diff --git a/src/Plugins/ITKImageProcessing/docs/ITKBlackTopHatImage.rst b/src/Plugins/ITKImageProcessing/docs/ITKBlackTopHatImage.rst deleted file mode 100644 index 9f66331332..0000000000 --- a/src/Plugins/ITKImageProcessing/docs/ITKBlackTopHatImage.rst +++ /dev/null @@ -1,81 +0,0 @@ -============================== -ITK Black Top Hat Image Filter -============================== - - -Black top hat extracts local minima that are smaller than the structuring element. - -Group (Subgroup) -================ - -ITKMathematicalMorphology (MathematicalMorphology) - -Description -=========== - -Black top hat extracts local minima that are smaller than the structuring element. It subtracts the background from the -input image. The output of the filter transforms the black valleys into white peaks. - -Top-hats are described in Chapter 4.5 of Pierre Soille’s book “Morphological Image Analysis: Principles and -Applications”, Second Edition, Springer, 2003. - -Author ------- - -Gaetan Lehmann. Biologie du Developpement et de la Reproduction, INRA de Jouy-en-Josas, France. - -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 -======================= ======== ================================================================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKClosingByReconstructionImage.md b/src/Plugins/ITKImageProcessing/docs/ITKClosingByReconstructionImage.md index be98d26c5c..9dd5e06732 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKClosingByReconstructionImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKClosingByReconstructionImage.md @@ -28,7 +28,7 @@ Applications", Second Edition, Springer, 2003. ## 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 | diff --git a/src/Plugins/ITKImageProcessing/docs/ITKClosingByReconstructionImage.rst b/src/Plugins/ITKImageProcessing/docs/ITKClosingByReconstructionImage.rst deleted file mode 100644 index 872fdc6382..0000000000 --- a/src/Plugins/ITKImageProcessing/docs/ITKClosingByReconstructionImage.rst +++ /dev/null @@ -1,95 +0,0 @@ -========================================== -ITK Closing By Reconstruction Image Filter -========================================== - - -Closing by reconstruction of an image. - -Group (Subgroup) -================ - -ITKMathematicalMorphology (MathematicalMorphology) - -Description -=========== - -This filter is similar to the morphological closing, but contrary to the morphological closing, the closing by -reconstruction preserves the shape of the components. The closing by reconstruction of an image “f” is defined as: - -ClosingByReconstruction(f) = ErosionByReconstruction(f, Dilation(f)). - -Closing by reconstruction not only preserves structures preserved by the dilation, but also levels raises the contrast -of the darkest regions. If PreserveIntensities is on, a subsequent reconstruction by dilation using a marker image that -is the original image for all unaffected pixels. - -Closing by reconstruction is described in Chapter 6.3.9 of Pierre Soille’s book “Morphological Image Analysis: -Principles and Applications”, Second Edition, Springer, 2003. - -Author ------- - -Gaetan Lehmann. Biologie du Developpement et de la Reproduction, INRA de Jouy-en-Josas, France. - -Related Filters ---------------- - -- 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 -======================= ======== ================================================================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKCosImage.md b/src/Plugins/ITKImageProcessing/docs/ITKCosImage.md index 2a19c167de..6dc599f993 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKCosImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKCosImage.md @@ -24,7 +24,7 @@ The filter expects both images to have the same dimension (e.g. both 2D, or both ## Parameters | Name | Type | Description | -|------|------|-------------| +|------------|------| --------------------------------- | ## Required Geometry diff --git a/src/Plugins/ITKImageProcessing/docs/ITKCosImage.rst b/src/Plugins/ITKImageProcessing/docs/ITKCosImage.rst deleted file mode 100644 index b311ea3e50..0000000000 --- a/src/Plugins/ITKImageProcessing/docs/ITKCosImage.rst +++ /dev/null @@ -1,71 +0,0 @@ -==================== -ITK Cos Image Filter -==================== - - -Computes the cosine of each pixel. - -Group (Subgroup) -================ - -ITKImageIntensity (ImageIntensity) - -Description -=========== - -This filter is templated over the pixel type of the input image and the pixel type of the output image. - -The filter walks over all of the pixels in the input image, and for each pixel does the following: - -- cast the pixel value to double , -- apply the std::cos() function to the double value, -- cast the double value resulting from std::cos() to the pixel type of the output image, -- store the cast value into the output image. - -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 -======================= ======== ================================================================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKDilateObjectMorphologyImage.md b/src/Plugins/ITKImageProcessing/docs/ITKDilateObjectMorphologyImage.md index 013e25ca69..ce94ee092e 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKDilateObjectMorphologyImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKDilateObjectMorphologyImage.md @@ -16,7 +16,7 @@ If a pixel's value is equal to the object value and the pixel is adjacent to a n ## 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 | diff --git a/src/Plugins/ITKImageProcessing/docs/ITKDilateObjectMorphologyImage.rst b/src/Plugins/ITKImageProcessing/docs/ITKDilateObjectMorphologyImage.rst deleted file mode 100644 index e9a91d072a..0000000000 --- a/src/Plugins/ITKImageProcessing/docs/ITKDilateObjectMorphologyImage.rst +++ /dev/null @@ -1,71 +0,0 @@ -========================================= -ITK Dilate Object Morphology Image Filter -========================================= - - -dilation of an object in an image - -Group (Subgroup) -================ - -ITKBinaryMathematicalMorphology (BinaryMathematicalMorphology) - -Description -=========== - -Dilate an image using binary morphology. Pixel values matching the object value are considered the “foreground” and all -other pixels are “background”. This is useful in processing mask images containing only one object. - -If a pixel’s value is equal to the object value and the pixel is adjacent to a non-object valued pixel, then the kernel -is centered on the object-value pixel and neighboring pixels covered by the kernel are assigned the object value. The -structuring element is assumed to be composed of binary values (zero or one).\* ObjectMorphologyImageFilter , -ErodeObjectMorphologyImageFilter - 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 -======================= ======== ================================================================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKDiscreteGaussianImage.md b/src/Plugins/ITKImageProcessing/docs/ITKDiscreteGaussianImage.md index 2f8c21470e..2584c35231 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKDiscreteGaussianImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKDiscreteGaussianImage.md @@ -21,7 +21,7 @@ When the Gaussian kernel is small, this filter tends to run faster than itk::Rec ## 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 | | diff --git a/src/Plugins/ITKImageProcessing/docs/ITKDiscreteGaussianImage.rst b/src/Plugins/ITKImageProcessing/docs/ITKDiscreteGaussianImage.rst deleted file mode 100644 index 58222eafd6..0000000000 --- a/src/Plugins/ITKImageProcessing/docs/ITKDiscreteGaussianImage.rst +++ /dev/null @@ -1,85 +0,0 @@ -================================== -ITK Discrete Gaussian Image Filter -================================== - - -Blurs an image by separable convolution with discrete gaussian kernels. This filter performs Gaussian blurring by -separable convolution of an image and a discrete Gaussian operator (kernel). - -Group (Subgroup) -================ - -ITKSmoothing (Smoothing) - -Description -=========== - -The Gaussian operator used here was described by Tony Lindeberg (Discrete Scale-Space Theory and the Scale-Space Primal -Sketch. Dissertation. Royal Institute of Technology, Stockholm, Sweden. May 1991.) The Gaussian kernel used here was -designed so that smoothing and derivative operations commute after discretization. - -The variance or standard deviation (sigma) will be evaluated as pixel units if SetUseImageSpacing is off (false) or as -physical units if SetUseImageSpacing is on (true, default). The variance can be set independently in each dimension. - -When the Gaussian kernel is small, this filter tends to run faster than itk::RecursiveGaussianImageFilter .\* -GaussianOperator - Image - Neighborhood - 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 -======================= ======== ================================================================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKErodeObjectMorphologyImage.md b/src/Plugins/ITKImageProcessing/docs/ITKErodeObjectMorphologyImage.md index 647f209ba9..67e17fe7bd 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKErodeObjectMorphologyImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKErodeObjectMorphologyImage.md @@ -16,7 +16,7 @@ If the pixel covered by the center of the kernel has the pixel value ObjectValue ## 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 | diff --git a/src/Plugins/ITKImageProcessing/docs/ITKErodeObjectMorphologyImage.rst b/src/Plugins/ITKImageProcessing/docs/ITKErodeObjectMorphologyImage.rst deleted file mode 100644 index 23d42556c3..0000000000 --- a/src/Plugins/ITKImageProcessing/docs/ITKErodeObjectMorphologyImage.rst +++ /dev/null @@ -1,72 +0,0 @@ -======================================== -ITK Erode Object Morphology Image Filter -======================================== - - -Erosion of an object in an image. - -Group (Subgroup) -================ - -ITKBinaryMathematicalMorphology (BinaryMathematicalMorphology) - -Description -=========== - -Erosion of an image using binary morphology. Pixel values matching the object value are considered the “object” and all -other pixels are “background”. This is useful in processing mask images containing only one object. - -If the pixel covered by the center of the kernel has the pixel value ObjectValue and the pixel is adjacent to a -non-object valued pixel, then the kernel is centered on the object-value pixel and neighboring pixels covered by the -kernel are assigned the background value. The structuring element is assumed to be composed of binary values (zero or -one).\* ObjectMorphologyImageFilter , BinaryFunctionErodeImageFilter - 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 -======================= ======== ================================================================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKExpImage.md b/src/Plugins/ITKImageProcessing/docs/ITKExpImage.md index 7eb50745a5..e6b2ebe1a3 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKExpImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKExpImage.md @@ -13,7 +13,7 @@ The computation is performed using std::exp(x). ## Parameters | Name | Type | Description | -|------|------|-------------| +|------------|------| --------------------------------- | ## Required Geometry diff --git a/src/Plugins/ITKImageProcessing/docs/ITKExpImage.rst b/src/Plugins/ITKImageProcessing/docs/ITKExpImage.rst deleted file mode 100644 index 3606d14af1..0000000000 --- a/src/Plugins/ITKImageProcessing/docs/ITKExpImage.rst +++ /dev/null @@ -1,62 +0,0 @@ -==================== -ITK Exp Image Filter -==================== - - -Computes the exponential function of each pixel. - -Group (Subgroup) -================ - -ITKImageIntensity (ImageIntensity) - -Description -=========== - -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 -======================= ======== ================================================================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKExpNegativeImage.md b/src/Plugins/ITKImageProcessing/docs/ITKExpNegativeImage.md index d890a94d33..72f2622a12 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKExpNegativeImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKExpNegativeImage.md @@ -13,7 +13,7 @@ Every output pixel is equal to std::exp(-K.x ). where x is the intensity of the ## Parameters | Name | Type | Description | -|------|------|-------------| +|------------|------| --------------------------------- | ## Required Geometry diff --git a/src/Plugins/ITKImageProcessing/docs/ITKExpNegativeImage.rst b/src/Plugins/ITKImageProcessing/docs/ITKExpNegativeImage.rst deleted file mode 100644 index d5a4f15719..0000000000 --- a/src/Plugins/ITKImageProcessing/docs/ITKExpNegativeImage.rst +++ /dev/null @@ -1,63 +0,0 @@ -============================= -ITK Exp Negative Image Filter -============================= - - -Computes the function exp(-K.x) for each input pixel. - -Group (Subgroup) -================ - -ITKImageIntensity (ImageIntensity) - -Description -=========== - -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 -======================= ======== ================================================================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKGradientMagnitudeImage.md b/src/Plugins/ITKImageProcessing/docs/ITKGradientMagnitudeImage.md index 8a2bee927f..57245d331f 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKGradientMagnitudeImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKGradientMagnitudeImage.md @@ -20,7 +20,7 @@ Computes the gradient magnitude of an image region at each pixel. ## 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 diff --git a/src/Plugins/ITKImageProcessing/docs/ITKGradientMagnitudeImage.rst b/src/Plugins/ITKImageProcessing/docs/ITKGradientMagnitudeImage.rst deleted file mode 100644 index 27ef51a073..0000000000 --- a/src/Plugins/ITKImageProcessing/docs/ITKGradientMagnitudeImage.rst +++ /dev/null @@ -1,75 +0,0 @@ -=================================== -ITK Gradient Magnitude Image Filter -=================================== - - -Computes the gradient magnitude of an image region at each pixel. - -Group (Subgroup) -================ - -ITKImageGradient (ImageGradient) - -Description -=========== - -Computes the gradient magnitude of an image region at each pixel. - -Related Filters ---------------- - -- Image -- Neighborhood -- 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 -======================= ======== ================================================================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleDilateImage.md b/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleDilateImage.md index 05156d1572..179fc4dfb2 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleDilateImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleDilateImage.md @@ -15,7 +15,7 @@ The structuring element is assumed to be composed of binary values (zero or one) ## 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. | diff --git a/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleDilateImage.rst b/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleDilateImage.rst deleted file mode 100644 index ab3e33c03b..0000000000 --- a/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleDilateImage.rst +++ /dev/null @@ -1,69 +0,0 @@ -================================= -ITK Grayscale Dilate Image Filter -================================= - - -Grayscale dilation of an image. - -Group (Subgroup) -================ - -ITKMathematicalMorphology (MathematicalMorphology) - -Description -=========== - -Dilate an image using grayscale morphology. Dilation takes the maximum of all the pixels identified by the structuring -element. - -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 -======================= ======== ================================================================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleErodeImage.md b/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleErodeImage.md index ba9bf8ae74..03102a7f0d 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleErodeImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleErodeImage.md @@ -15,7 +15,7 @@ The structuring element is assumed to be composed of binary values (zero or one) ## 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. | diff --git a/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleErodeImage.rst b/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleErodeImage.rst deleted file mode 100644 index c42559d017..0000000000 --- a/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleErodeImage.rst +++ /dev/null @@ -1,69 +0,0 @@ -================================ -ITK Grayscale Erode Image Filter -================================ - - -Grayscale erosion of an image. - -Group (Subgroup) -================ - -ITKMathematicalMorphology (MathematicalMorphology) - -Description -=========== - -Erode an image using grayscale morphology. Erosion takes the maximum of all the pixels identified by the structuring -element. - -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 -======================= ======== ================================================================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleFillholeImage.md b/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleFillholeImage.md index 825dd9dfee..f83512a95f 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleFillholeImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleFillholeImage.md @@ -21,7 +21,7 @@ Principles and Applications", Second Edition, Springer, 2003.* ReconstructionByE ## 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 diff --git a/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleFillholeImage.rst b/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleFillholeImage.rst deleted file mode 100644 index d53daff7e8..0000000000 --- a/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleFillholeImage.rst +++ /dev/null @@ -1,78 +0,0 @@ -=================================== -ITK Grayscale Fillhole Image Filter -=================================== - - -Remove local minima not connected to the boundary of the image. - -Group (Subgroup) -================ - -ITKMathematicalMorphology (MathematicalMorphology) - -Description -=========== - -GrayscaleFillholeImageFilter fills holes in a grayscale image. Holes are local minima in the grayscale topography that -are not connected to boundaries of the image. Gray level values adjacent to a hole are extrapolated across the hole. - -This filter is used to smooth over local minima without affecting the values of local maxima. If you take the difference -between the output of this filter and the original image (and perhaps threshold the difference above a small value), -you’ll obtain a map of the local minima. - -This filter uses the ReconstructionByErosionImageFilter . It provides its own input as the “mask” input to the geodesic -erosion. The “marker” image for the geodesic erosion is constructed such that boundary pixels match the boundary pixels -of the input image and the interior pixels are set to the maximum pixel value in the input image. - -Geodesic morphology and the Fillhole algorithm is described in Chapter 6 of Pierre Soille’s book “Morphological Image -Analysis: Principles and Applications”, Second Edition, Springer, 2003.\* ReconstructionByErosionImageFilter - -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 -======================= ======== ================================================================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleGrindPeakImage.md b/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleGrindPeakImage.md index d215694e31..4a098ac7d5 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleGrindPeakImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleGrindPeakImage.md @@ -23,7 +23,7 @@ Principles and Applications", Second Edition, Springer, 2003.* GrayscaleGeodesic ## 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 diff --git a/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleGrindPeakImage.rst b/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleGrindPeakImage.rst deleted file mode 100644 index 7784ab1e5c..0000000000 --- a/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleGrindPeakImage.rst +++ /dev/null @@ -1,82 +0,0 @@ -===================================== -ITK Grayscale Grind Peak Image Filter -===================================== - - -Remove local maxima not connected to the boundary of the image. - -Group (Subgroup) -================ - -ITKMathematicalMorphology (MathematicalMorphology) - -Description -=========== - -GrayscaleGrindPeakImageFilter removes peaks in a grayscale image. Peaks are local maxima in the grayscale topography -that are not connected to boundaries of the image. Gray level values adjacent to a peak are extrapolated through the -peak. - -This filter is used to smooth over local maxima without affecting the values of local minima. If you take the difference -between the output of this filter and the original image (and perhaps threshold the difference above a small value), -you’ll obtain a map of the local maxima. - -This filter uses the GrayscaleGeodesicDilateImageFilter . It provides its own input as the “mask” input to the geodesic -erosion. The “marker” image for the geodesic erosion is constructed such that boundary pixels match the boundary pixels -of the input image and the interior pixels are set to the minimum pixel value in the input image. - -This filter is the dual to the GrayscaleFillholeImageFilter which implements the Fillhole algorithm. Since it is a dual, -it is somewhat superfluous but is provided as a convenience. - -Geodesic morphology and the Fillhole algorithm is described in Chapter 6 of Pierre Soille’s book “Morphological Image -Analysis: Principles and Applications”, Second Edition, Springer, 2003.\* GrayscaleGeodesicDilateImageFilter - -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 -======================= ======== ================================================================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleMorphologicalClosingImage.md b/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleMorphologicalClosingImage.md index d48ca7be44..9c2d596af8 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleMorphologicalClosingImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleMorphologicalClosingImage.md @@ -15,7 +15,7 @@ The structuring element is assumed to be composed of binary values (zero or one) ## 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 | diff --git a/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleMorphologicalClosingImage.rst b/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleMorphologicalClosingImage.rst deleted file mode 100644 index 2f4a7595f2..0000000000 --- a/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleMorphologicalClosingImage.rst +++ /dev/null @@ -1,73 +0,0 @@ -================================================ -ITK Grayscale Morphological Closing Image Filter -================================================ - - -Grayscale closing of an image. - -Group (Subgroup) -================ - -ITKMathematicalMorphology (MathematicalMorphology) - -Description -=========== - -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 -======================= ======== ================================================================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleMorphologicalOpeningImage.md b/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleMorphologicalOpeningImage.md index c5255dad22..c7e78861ec 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleMorphologicalOpeningImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleMorphologicalOpeningImage.md @@ -15,7 +15,7 @@ The structuring element is assumed to be composed of binary values (zero or one) ## 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 | diff --git a/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleMorphologicalOpeningImage.rst b/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleMorphologicalOpeningImage.rst deleted file mode 100644 index 4b0515b53c..0000000000 --- a/src/Plugins/ITKImageProcessing/docs/ITKGrayscaleMorphologicalOpeningImage.rst +++ /dev/null @@ -1,73 +0,0 @@ -================================================ -ITK Grayscale Morphological Opening Image Filter -================================================ - - -Grayscale opening of an image. - -Group (Subgroup) -================ - -ITKMathematicalMorphology (MathematicalMorphology) - -Description -=========== - -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 -======================= ======== ================================================================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKHConvexImage.md b/src/Plugins/ITKImageProcessing/docs/ITKHConvexImage.md index 55eedf6dac..ddd432ca1b 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKHConvexImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKHConvexImage.md @@ -19,7 +19,7 @@ Principles and Applications", Second Edition, Springer, 2003.* GrayscaleGeodesic ## 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 | diff --git a/src/Plugins/ITKImageProcessing/docs/ITKHConvexImage.rst b/src/Plugins/ITKImageProcessing/docs/ITKHConvexImage.rst deleted file mode 100644 index 71af5255c3..0000000000 --- a/src/Plugins/ITKImageProcessing/docs/ITKHConvexImage.rst +++ /dev/null @@ -1,78 +0,0 @@ -========================= -ITK H Convex Image Filter -========================= - - -Identify local maxima whose height above the baseline is greater than h. - -Group (Subgroup) -================ - -ITKMathematicalMorphology (MathematicalMorphology) - -Description -=========== - -HConvexImageFilter extract local maxima that are more than h intensity units above the (local) background. This has the -effect of extracting objects that are brighter than background by at least h intensity units. - -This filter uses the HMaximaImageFilter . - -Geodesic morphology and the H-Convex algorithm is described in Chapter 6 of Pierre Soille’s book “Morphological Image -Analysis: Principles and Applications”, Second Edition, Springer, 2003.\* GrayscaleGeodesicDilateImageFilter , -HMinimaImageFilter - 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 -======================= ======== ================================================================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKHMaximaImage.md b/src/Plugins/ITKImageProcessing/docs/ITKHMaximaImage.md index 3a872ab83f..6b76542afd 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKHMaximaImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKHMaximaImage.md @@ -23,7 +23,7 @@ The height parameter is set using SetHeight.* ReconstructionByDilationImageFilte ## 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 diff --git a/src/Plugins/ITKImageProcessing/docs/ITKHMaximaImage.rst b/src/Plugins/ITKImageProcessing/docs/ITKHMaximaImage.rst deleted file mode 100644 index 06de084dbe..0000000000 --- a/src/Plugins/ITKImageProcessing/docs/ITKHMaximaImage.rst +++ /dev/null @@ -1,82 +0,0 @@ -========================= -ITK H Maxima Image Filter -========================= - - -Suppress local maxima whose height above the baseline is less than h. - -Group (Subgroup) -================ - -ITKMathematicalMorphology (MathematicalMorphology) - -Description -=========== - -HMaximaImageFilter suppresses local maxima that are less than h intensity units above the (local) background. This has -the effect of smoothing over the “high” parts of the noise in the image without smoothing over large changes in -intensity (region boundaries). See the HMinimaImageFilter to suppress the local minima whose depth is less than h -intensity units below the (local) background. - -If the output of HMaximaImageFilter is subtracted from the original image, the significant “peaks” in the image can be -identified. This is what the HConvexImageFilter provides. - -This filter uses the ReconstructionByDilationImageFilter . It provides its own input as the “mask” input to the geodesic -dilation. The “marker” image for the geodesic dilation is the input image minus the height parameter h. - -Geodesic morphology and the H-Maxima algorithm is described in Chapter 6 of Pierre Soille’s book “Morphological Image -Analysis: Principles and Applications”, Second Edition, Springer, 2003. - -The height parameter is set using SetHeight.\* ReconstructionByDilationImageFilter , HMinimaImageFilter , -HConvexImageFilter - 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 -======================= ======== ================================================================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKHMinimaImage.md b/src/Plugins/ITKImageProcessing/docs/ITKHMinimaImage.md index 00744a3ea1..08d982b8c9 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKHMinimaImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKHMinimaImage.md @@ -21,7 +21,7 @@ Principles and Applications", Second Edition, Springer, 2003.* GrayscaleGeodesic ## 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 | diff --git a/src/Plugins/ITKImageProcessing/docs/ITKHMinimaImage.rst b/src/Plugins/ITKImageProcessing/docs/ITKHMinimaImage.rst deleted file mode 100644 index dd87315ba8..0000000000 --- a/src/Plugins/ITKImageProcessing/docs/ITKHMinimaImage.rst +++ /dev/null @@ -1,84 +0,0 @@ -========================= -ITK H Minima Image Filter -========================= - - -Suppress local minima whose depth below the baseline is less than h. - -Group (Subgroup) -================ - -ITKMathematicalMorphology (MathematicalMorphology) - -Description -=========== - -HMinimaImageFilter suppresses local minima that are less than h intensity units below the (local) background. This has -the effect of smoothing over the “low” parts of the noise in the image without smoothing over large changes in intensity -(region boundaries). See the HMaximaImageFilter to suppress the local maxima whose height is less than h intensity units -above the (local) background. - -If original image is subtracted from the output of HMinimaImageFilter , the significant “valleys” in the image can be -identified. This is what the HConcaveImageFilter provides. - -This filter uses the GrayscaleGeodesicErodeImageFilter . It provides its own input as the “mask” input to the geodesic -dilation. The “marker” image for the geodesic dilation is the input image plus the height parameter h. - -Geodesic morphology and the H-Minima algorithm is described in Chapter 6 of Pierre Soille’s book “Morphological Image -Analysis: Principles and Applications”, Second Edition, Springer, 2003.\* GrayscaleGeodesicDilateImageFilter , -HMinimaImageFilter , HConvexImageFilter - 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 -======================= ======== ================================================================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKImageReader.md b/src/Plugins/ITKImageProcessing/docs/ITKImageReader.md index 32f5e6b7b0..6e7bb66621 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKImageReader.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKImageReader.md @@ -2,33 +2,33 @@ This filter directly wraps an ITK filter of the same name. -## Group (Subgroup) ## +## Group (Subgroup) ITKImageProcessing (ITKImageProcessing) -## Description ## +## Description Reads images through ITK -## Parameters ## +## Parameters | Name | Type | |------------------|------| | Input File | String | Path to the input file to read. | -## Required Objects ## +## Required Objects -## Created Objects ## +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| Kind | Default Name | Type | Comp Dims | Description | +|---------------------------|--------------|----------|--------|---------------------------------------------| | Data Container | Data Container Name | N/A | N/A | Description of object... | -## Example Pipelines ## +## Example Pipelines + Image Histogram -## License & Copyright ## +## License & Copyright Please see the description file distributed with this plugin. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKImageReader.rst b/src/Plugins/ITKImageProcessing/docs/ITKImageReader.rst deleted file mode 100644 index b6006d4743..0000000000 --- a/src/Plugins/ITKImageProcessing/docs/ITKImageReader.rst +++ /dev/null @@ -1,53 +0,0 @@ -================= -ITK::Image Reader -================= - - -This filter directly wraps an ITK filter of the same name. - -Group (Subgroup) -================ - -ITKImageProcessing (ITKImageProcessing) - -Description -=========== - -Reads images through ITK - -Parameters -========== - -========== ====== -Name Type -========== ====== -Input File String -========== ====== - -Required Objects -================ - -Created Objects -=============== - -============== =================== ==== ========== ====================== -Kind Default Name Type Comp. Dims Description -============== =================== ==== ========== ====================== -Data Container Data Container Name N/A N/A Description of object… -============== =================== ==== ========== ====================== - -Example Pipelines -================= - -- Image Histogram - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKImageWriter.md b/src/Plugins/ITKImageProcessing/docs/ITKImageWriter.md index 4b1c6059ad..e0baf00b11 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKImageWriter.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKImageWriter.md @@ -1,16 +1,17 @@ # ITK::Image Writer (KW) -## Group (Subgroup) ## +## Group (Subgroup) ITKImageProcessing (ITKImageProcessing) -## Description ## +## Description This **Filter** will save images based on an array that represents grayscale, RGB or ARGB color values. If the input array represents a 3D volume, the **Filter** will output a series of slices along one of the orthogonal axes. The options are to produce XY slices along the Z axis, XZ slices along the Y axis or YZ slices along the X axis. The user has the option to save in one of 3 standard image formats: TIF, BMP, or PNG. The output files will be numbered sequentially starting at zero (0) and ending at the total dimensions for the chosen axis. For example, if the Z axis has 117 dimensions, 117 XY image files will be produced and numbered 0 to 116. Unless the data is a single slice then only a single image will be produced using the name given in the Output File parameter. -An example of a **Filter** that produces color data that can be used as input to this **Filter** is the [Generate IPF Colors](generateipfcolors.html) **Filter**, which will generate RGB values for each voxel in the volume. +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 ## +## Parameters | Name | Type | Description | |------------------|------| --------------| @@ -18,34 +19,31 @@ An example of a **Filter** that produces color data that can be used as input to | 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 ## +## Required Geometry -Image +Image -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 ## +## Created Objects None -## Example Pipelines ## +## Example Pipelines + INL Export + TxCopper_Exposed + TxCopper_Unexposed + Edax IPF Colors -## License & Copyright ## +## License & Copyright Please see the description file distributed with this plugin. ## DREAM3DNX 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. - - diff --git a/src/Plugins/ITKImageProcessing/docs/ITKImageWriter.rst b/src/Plugins/ITKImageProcessing/docs/ITKImageWriter.rst deleted file mode 100644 index 4cc39bdeb0..0000000000 --- a/src/Plugins/ITKImageProcessing/docs/ITKImageWriter.rst +++ /dev/null @@ -1,76 +0,0 @@ -====================== -ITK::Image Writer (KW) -====================== - - -Group (Subgroup) -================ - -ITKImageProcessing (ITKImageProcessing) - -Description -=========== - -This **Filter** will save images based on an array that represents grayscale, RGB or ARGB color values. If the input -array represents a 3D volume, the **Filter** will output a series of slices along one of the orthogonal axes. The -options are to produce XY slices along the Z axis, XZ slices along the Y axis or YZ slices along the X axis. The user -has the option to save in one of 3 standard image formats: TIF, BMP, or PNG. The output files will be numbered -sequentially starting at zero (0) and ending at the total dimensions for the chosen axis. For example, if the Z axis has -117 dimensions, 117 XY image files will be produced and numbered 0 to 116. Unless the data is a single slice then only a -single image will be produced using the name given in the Output File parameter. - -An example of a **Filter** that produces color data that can be used as input to this **Filter** is the `Generate IPF -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 - -Example Pipelines -================= - -- INL Export -- TxCopper_Exposed -- TxCopper_Unexposed -- Edax IPF Colors - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKImportFijiMontageFilter.md b/src/Plugins/ITKImageProcessing/docs/ITKImportFijiMontageFilter.md index 1d643f7d5d..29229c7906 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKImportFijiMontageFilter.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKImportFijiMontageFilter.md @@ -1,16 +1,16 @@ -# Import Fiji Montage # +# Import Fiji Montage -## Group (Subgroup) ## +## Group (Subgroup) Import/Export (Import) -## Description ## +## Description Imports multiple images for the purpose of montage assembly. Each image is stored in it's own *DataContaner/AttributeMatrix/AttributeArray* where the name of the *DataContainer* is based off the row & column index of the montage. The filter assumes that the Configuration File is in the same folder as the images. The created *AttributeMatrix* and *AttributeArray* will have the same name. The image files **MUST** be located in the same directory as the Fiji Configuration File. Utilizes the *itkReadImage* and *ColorToGrayScale* filters -## Example Registration File ## +## Example Registration File # Define the number of dimensions we are working on dim = 2 <===== THIS LINE IS REQUIRED @@ -23,7 +23,7 @@ Utilizes the *itkReadImage* and *ColorToGrayScale* filters SampleMosaic_p4.bmp; ; (0.23675, 1839.55) SampleMosaic_p5.bmp; ; (1227.31, 1839.55) -## Parameters ## +## Parameters | Name | Type | Comment | |------------------|------|---------| @@ -39,7 +39,7 @@ Utilizes the *itkReadImage* and *ColorToGrayScale* filters | 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 ### +### Color To Gray Scale Notes The luminosity method is a more sophisticated version of the average method. It also averages the values, but it forms a weighted average to account for human perception. We re more sensitive to green than other colors, so green is weighted most heavily. The default formula for luminosity is BT709 Gray scale: @@ -47,7 +47,7 @@ The luminosity method is a more sophisticated version of the average method. It The user can set the weightings to what ever values they would like. -### Lenght Unit ### +### Lenght Unit Yoctometer = 0 Zeptometer = 1 @@ -79,34 +79,34 @@ The user can set the weightings to what ever values they would like. Unspecified = 100U Unknown = 101U -## Required DataContainers ## +## Required DataContainers NONE -## Required Objects ## +## Required Objects NONE -## Created Objects ## +## 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 | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | -## Example Pipelines ## +## Example Pipelines Prebuilt Pipelines / Examples / ITKImageProcessing / Fiji Import -## License & Copyright ## +## License & Copyright Please see the description file distributed with this plugin. -## DREAM3D Mailing Lists ## +## DREAM3D Mailing Lists If you need more help with a filter, please consider asking your question on the DREAM3D Users mailing list: diff --git a/src/Plugins/ITKImageProcessing/docs/ITKImportFijiMontageFilter.rst b/src/Plugins/ITKImageProcessing/docs/ITKImportFijiMontageFilter.rst deleted file mode 100644 index e71f0bf5cd..0000000000 --- a/src/Plugins/ITKImageProcessing/docs/ITKImportFijiMontageFilter.rst +++ /dev/null @@ -1,167 +0,0 @@ -=================== -Import Fiji Montage -=================== - - -Group (Subgroup) -================ - -Import/Export (Import) - -Description -=========== - -Imports multiple images for the purpose of montage assembly. Each image is stored in it’s own -*DataContaner/AttributeMatrix/AttributeArray* where the name of the *DataContainer* is based off the row & column index -of the montage. The filter assumes that the Configuration File is in the same folder as the images. The created -*AttributeMatrix* and *AttributeArray* will have the same name. The image files **MUST** be located in the same -directory as the Fiji Configuration File. - -Utilizes the *itkReadImage* and *ColorToGrayScale* filters - -Example Registration File -========================= - -:: - - # Define the number of dimensions we are working on - dim = 2 <===== THIS LINE IS REQUIRED - - # Define the image coordinates <===== THIS LINE IS REQUIRED - SampleMosaic_p0.bmp; ; (0, 0) - SampleMosaic_p1.bmp; ; (1227.55, 0) - SampleMosaic_p3.bmp; ; (0.23675, 920.01) - SampleMosaic_p2.bmp; ; (1227.55, 919.774) - 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 -------------------------- - -The luminosity method is a more sophisticated version of the average method. It also averages the values, but it forms a -weighted average to account for human perception. We re more sensitive to green than other colors, so green is weighted -most heavily. The default formula for luminosity is BT709 Gray scale: - -:: - - Red: 0.2125 Green: 0.7154 Blue: 0.0721. - -The user can set the weightings to what ever values they would like. - -Lenght Unit ------------ - -:: - - Yoctometer = 0 - Zeptometer = 1 - Attometer = 2 - Femtometer = 3 - Picometer = 4 - Nanometer = 5 - Micrometer = 6 - Millimeter = 7 - Centimeter = 8 - Decimeter = 9 - Meter = 10 - Decameter = 11 - Hectometer = 12 - Kilometer = 13 - Megameter = 14 - Gigameter = 15 - Terameter = 16 - Petameter = 17 - Exameter = 18 - Zettameter = 19 - Yottameter = 20 - Angstrom = 21 - Mil = 22 - Inch = 23 - Foot = 24 - Mile = 25 - Fathom = 26 - 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 -=============== ============= ==== ========== ======================================================== - -Example Pipelines -================= - -Prebuilt Pipelines / Examples / ITKImageProcessing / Fiji Import - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3D Mailing Lists -===================== - -If you need more help with a filter, please consider asking your question on the DREAM3D Users mailing list: -https://groups.google.com/forum/?hl=en#!forum/dream3d-users diff --git a/src/Plugins/ITKImageProcessing/docs/ITKImportImageStack.md b/src/Plugins/ITKImageProcessing/docs/ITKImportImageStack.md index 536672303b..34fdd88807 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKImportImageStack.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKImportImageStack.md @@ -2,42 +2,42 @@ This filter directly wraps an ITK filter of the same name. -## Group (Subgroup) ## +## Group (Subgroup) ITKImageProcessing (ITKImageProcessing) -## Description ## +## Description Read in a stack of 2D images into a 3D volume with ITK. Supports most common 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 ## +## Parameters - Input Directory - File Ordering (Ascending or Descending) - Origin - Resolution -## Required Objects ## +## Required Objects None -## Created Objects ## +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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) | | -## Example Pipelines ## +## Example Pipelines + (08) Image Initial Visualization + (09) Image Segmentation -## License & Copyright ## +## License & Copyright Please see the description file distributed with this plugin. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKImportImageStack.rst b/src/Plugins/ITKImageProcessing/docs/ITKImportImageStack.rst deleted file mode 100644 index 591e5998a6..0000000000 --- a/src/Plugins/ITKImageProcessing/docs/ITKImportImageStack.rst +++ /dev/null @@ -1,66 +0,0 @@ -============================= -ITK::Import Images (3D Stack) -============================= - - -This filter directly wraps an ITK filter of the same name. - -Group (Subgroup) -================ - -ITKImageProcessing (ITKImageProcessing) - -Description -=========== - -Read in a stack of 2D images into a 3D volume with ITK. Supports most common 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) | | -+----------------------+--------------------+-----------------------+------------+---------------------------------------------------+ - -Example Pipelines -================= - -- - - (8) Image Initial Visualization - -- - - (9) Image Segmentation - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKIntensityWindowingImage.md b/src/Plugins/ITKImageProcessing/docs/ITKIntensityWindowingImage.md index cb1f73db08..e82f6a38d8 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKIntensityWindowingImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKIntensityWindowingImage.md @@ -15,7 +15,7 @@ All computations are performed in the precision of the input pixel's RealType. B ## 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. | diff --git a/src/Plugins/ITKImageProcessing/docs/ITKIntensityWindowingImage.rst b/src/Plugins/ITKImageProcessing/docs/ITKIntensityWindowingImage.rst deleted file mode 100644 index 6d555a244e..0000000000 --- a/src/Plugins/ITKImageProcessing/docs/ITKIntensityWindowingImage.rst +++ /dev/null @@ -1,73 +0,0 @@ -==================================== -ITK Intensity Windowing Image Filter -==================================== - - -Applies a linear transformation to the intensity levels of the input Image that are inside a user-defined interval. -Values below this interval are mapped to a constant. Values over the interval are mapped to another constant. - -Group (Subgroup) -================ - -ITKImageIntensity (ImageIntensity) - -Description -=========== - -IntensityWindowingImageFilter applies pixel-wise a linear transformation to the intensity values of input image pixels. -The linear transformation is defined by the user in terms of the minimum and maximum values that the output image should -have and the lower and upper limits of the intensity window of the input image. This operation is very common in -visualization, and can also be applied as a convenient preprocessing operation for image segmentation. - -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 -======================= ======== ================================================================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKInvertIntensityImage.md b/src/Plugins/ITKImageProcessing/docs/ITKInvertIntensityImage.md index 5e94f7dcc8..3bd204947f 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKInvertIntensityImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKInvertIntensityImage.md @@ -21,7 +21,7 @@ InvertIntensityImageFilter inverts intensity of pixels by subtracting pixel valu ## Parameters | Name | Type | Description | -|------|------|-------------| +|------------|------| --------------------------------- | | Maximum | float64 | Set/Get the maximum intensity value for the inversion. | ## Required Geometry diff --git a/src/Plugins/ITKImageProcessing/docs/ITKInvertIntensityImage.rst b/src/Plugins/ITKImageProcessing/docs/ITKInvertIntensityImage.rst deleted file mode 100644 index bd6b2179d9..0000000000 --- a/src/Plugins/ITKImageProcessing/docs/ITKInvertIntensityImage.rst +++ /dev/null @@ -1,75 +0,0 @@ -================================= -ITK Invert Intensity Image Filter -================================= - - -Invert the intensity of an image. - -Group (Subgroup) -================ - -ITKImageIntensity (ImageIntensity) - -Description -=========== - -InvertIntensityImageFilter inverts intensity of pixels by subtracting pixel value to a maximum value. The maximum value -can be set with SetMaximum and defaults the maximum of input pixel type. This filter can be used to invert, for example, -a binary image, a distance map, etc. - -Author ------- - -Gaetan Lehmann. Biologie du Developpement et de la Reproduction, INRA de Jouy-en-Josas, France. - -Related Filters ---------------- - -- 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 -======================= ======== ================================================================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKLabelContourImage.md b/src/Plugins/ITKImageProcessing/docs/ITKLabelContourImage.md index 468a36ff08..acbcfc217a 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKLabelContourImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKLabelContourImage.md @@ -25,7 +25,7 @@ https://www.insight-journal.org/browse/publication/217 ## 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. | diff --git a/src/Plugins/ITKImageProcessing/docs/ITKLabelContourImage.rst b/src/Plugins/ITKImageProcessing/docs/ITKLabelContourImage.rst deleted file mode 100644 index abe4bc0969..0000000000 --- a/src/Plugins/ITKImageProcessing/docs/ITKLabelContourImage.rst +++ /dev/null @@ -1,85 +0,0 @@ -============================== -ITK Label Contour Image Filter -============================== - - -Labels the pixels on the border of the objects in a labeled image. - -Group (Subgroup) -================ - -ITKImageLabel (ImageLabel) - -Description -=========== - -LabelContourImageFilter takes a labeled image as input, where the pixels in the objects are the pixels with a value -different of the BackgroundValue. Only the pixels on the contours of the objects are kept. The pixels not on the border -are changed to BackgroundValue. The labels of the object are the same in the input and in the output image. - -The connectivity can be changed to minimum or maximum connectivity with SetFullyConnected() . Full connectivity produces -thicker contours. - -https://www.insight-journal.org/browse/publication/217 - -Author ------- - -Gaetan Lehmann. Biologie du Developpement et de la Reproduction, INRA de Jouy-en-Josas, France. - -Related Filters ---------------- - -- 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 -======================= ======== ==================================================================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKLog10Image.md b/src/Plugins/ITKImageProcessing/docs/ITKLog10Image.md index cbb833e27f..ed126b97a7 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKLog10Image.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKLog10Image.md @@ -13,7 +13,7 @@ The computation is performed using std::log10(x). ## Parameters | Name | Type | Description | -|------|------|-------------| +|------------|------| --------------------------------- | ## Required Geometry diff --git a/src/Plugins/ITKImageProcessing/docs/ITKLog10Image.rst b/src/Plugins/ITKImageProcessing/docs/ITKLog10Image.rst deleted file mode 100644 index 838f043f63..0000000000 --- a/src/Plugins/ITKImageProcessing/docs/ITKLog10Image.rst +++ /dev/null @@ -1,62 +0,0 @@ -====================== -ITK Log10 Image Filter -====================== - - -Computes the log10 of each pixel. - -Group (Subgroup) -================ - -ITKImageIntensity (ImageIntensity) - -Description -=========== - -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 -======================= ======== ================================================================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKLogImage.md b/src/Plugins/ITKImageProcessing/docs/ITKLogImage.md index 8db4cfe386..e256e713f9 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKLogImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKLogImage.md @@ -13,7 +13,7 @@ ITKImageIntensity (ImageIntensity) ## Parameters | Name | Type | Description | -|------|------|-------------| +|------------|------| --------------------------------- | ## Required Geometry diff --git a/src/Plugins/ITKImageProcessing/docs/ITKLogImage.rst b/src/Plugins/ITKImageProcessing/docs/ITKLogImage.rst deleted file mode 100644 index 2aeef29aaf..0000000000 --- a/src/Plugins/ITKImageProcessing/docs/ITKLogImage.rst +++ /dev/null @@ -1,60 +0,0 @@ -==================== -ITK Log Image Filter -==================== - - -Computes the log() of each pixel. - -Group (Subgroup) -================ - -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 -======================= ======== ================================================================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKMaskImage.md b/src/Plugins/ITKImageProcessing/docs/ITKMaskImage.md index 8e50c8b0ea..7ff95f5edd 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKMaskImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKMaskImage.md @@ -2,11 +2,11 @@ This filter directly wraps an ITK filter of the same name. -## Group (Subgroup) ## +## Group (Subgroup) ITKImageProcessing (ITKImageProcessing) -## Description ## +## Description Mask an image with a mask. @@ -31,44 +31,44 @@ 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 ## +## Parameters | Name | Type | Description | -|------|------|-------------| +|------------|------| --------------------------------- | | OutsideValue | double| Method to explicitly set the outside value of the mask. Defaults to 0 | -## Required Geometry ## +## Required Geometry Image -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| Kind | Default Name | Type | Comp Dims | Description | +|---------------------------|--------------|----------|--------|---------------------------------------------| | Cell Attribute Array | None | N/A | (1) | Array containing input image -## Created Objects ## +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| Kind | Default Name | Type | Comp Dims | Description | +|---------------------------|--------------|----------|--------|---------------------------------------------| | Cell Attribute Array | None | | (1) | Array containing filtered image -## References ## +## References [1] T.S. Yoo, M. J. Ackerman, W. E. Lorensen, W. Schroeder, V. Chalana, S. Aylward, D. Metaxas, R. Whitaker. Engineering and Algorithm Design for an Image Processing API: A Technical Report on ITK - The Insight Toolkit. In Proc. of Medicine Meets Virtual Reality, J. Westwood, ed., IOS Press Amsterdam pp 586-592 (2002). [2] H. Johnson, M. McCormick, L. Ibanez. The ITK Software Guide: Design and Functionality. Fourth Edition. Published by Kitware Inc. 2015 ISBN: 9781-930934-28-3 [3] H. Johnson, M. McCormick, L. Ibanez. The ITK Software Guide: Introduction and Development Guidelines. Fourth Edition. Published by Kitware Inc. 2015 ISBN: 9781-930934-27-6 -## Example Pipelines ## +## Example Pipelines -## License & Copyright ## +## License & Copyright Please see the description file distributed with this plugin. -## DREAM3D Mailing Lists ## +## DREAM3D Mailing Lists If you need more help with a filter, please consider asking your question on the DREAM3D Users mailing list: https://groups.google.com/forum/?hl=en#!forum/dream3d-users diff --git a/src/Plugins/ITKImageProcessing/docs/ITKMaskImage.rst b/src/Plugins/ITKImageProcessing/docs/ITKMaskImage.rst deleted file mode 100644 index b704e3dbd4..0000000000 --- a/src/Plugins/ITKImageProcessing/docs/ITKMaskImage.rst +++ /dev/null @@ -1,94 +0,0 @@ -====================== -ITK::Mask Image Filter -====================== - - -This filter directly wraps an ITK filter of the same name. - -Group (Subgroup) -================ - -ITKImageProcessing (ITKImageProcessing) - -Description -=========== - -Mask an image with a mask. - -This class is templated over the types of the input image type, the mask image type and the type of the output image. -Numeric conversions (castings) are done by the C++ defaults. - -The pixel type of the input 2 image must have a valid definition of the operator != with zero. This condition is -required because internally this filter will perform the operation - -:: - - - if pixel_from_mask_image != masking_value - - pixel_output_image = pixel_input_image - - else - - pixel_output_image = outside_value - * - -The pixel from the input 1 is cast to the pixel type of the output image. - -Note that the input and the mask images must be of the same size. - -*WARNING* Any pixel value other than masking value (0 by default) will not be masked out.\* MaskNegatedImageFilter - -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 -==================== ============ ==== ========== =============================== - -References -========== - -[1] T.S. Yoo, M. J. Ackerman, W. E. Lorensen, W. Schroeder, V. Chalana, S. Aylward, D. Metaxas, R. Whitaker. Engineering -and Algorithm Design for an Image Processing API: A Technical Report on ITK - The Insight Toolkit. In Proc. of Medicine -Meets Virtual Reality, J. Westwood, ed., IOS Press Amsterdam pp 586-592 (2002). [2] H. Johnson, M. McCormick, L. Ibanez. -The ITK Software Guide: Design and Functionality. Fourth Edition. Published by Kitware Inc. 2015 ISBN: 9781-930934-28-3 -[3] H. Johnson, M. McCormick, L. Ibanez. The ITK Software Guide: Introduction and Development Guidelines. Fourth -Edition. Published by Kitware Inc. 2015 ISBN: 9781-930934-27-6 - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3D Mailing Lists -===================== - -If you need more help with a filter, please consider asking your question on the DREAM3D Users mailing list: -https://groups.google.com/forum/?hl=en#!forum/dream3d-users diff --git a/src/Plugins/ITKImageProcessing/docs/ITKMedianImage.md b/src/Plugins/ITKImageProcessing/docs/ITKMedianImage.md index fa59c4f158..b090b021b0 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKMedianImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKMedianImage.md @@ -20,7 +20,7 @@ This filter requires that the input pixel type provides an operator<() (LessThan ## Parameters | Name | Type | Description | -|------|------|-------------| +|------------|------| --------------------------------- | | Radius | uint32 | | ## Required Geometry diff --git a/src/Plugins/ITKImageProcessing/docs/ITKMedianImage.rst b/src/Plugins/ITKImageProcessing/docs/ITKMedianImage.rst deleted file mode 100644 index d3a05b4596..0000000000 --- a/src/Plugins/ITKImageProcessing/docs/ITKMedianImage.rst +++ /dev/null @@ -1,70 +0,0 @@ -======================= -ITK Median Image Filter -======================= - - -Applies a median filter to an image. - -Group (Subgroup) -================ - -ITKSmoothing (Smoothing) - -Description -=========== - -Computes an image where a given pixel is the median value of the the pixels in a neighborhood about the corresponding -input pixel. - -A median filter is one of the family of nonlinear filters. It is used to smooth an image without being biased by -outliers or shot noise. - -This filter requires that the input pixel type provides an operator<() (LessThan Comparable).\* Image - Neighborhood - -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 -======================= ======== ================================================================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKMhaFileReader.md b/src/Plugins/ITKImageProcessing/docs/ITKMhaFileReader.md index 165a0ac773..7c9c5b8526 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKMhaFileReader.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKMhaFileReader.md @@ -4,15 +4,15 @@ This filter reads the image data from an MHA file. The transformation matrix from the MHA file can be optionally read and saved as a data array and/or applied to the created image geometry. -## Group (Subgroup) ## +## Group (Subgroup) ITKImageProcessing (ITKImageProcessing) -## Description ## +## Description Reads MHA images and their transformation matrices using ITK -## Parameters ## +## Parameters | Name | Type | Description | |------------------|------|-------------| @@ -21,24 +21,24 @@ Reads MHA images and their transformation matrices using ITK | 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 ## +## Required Objects None. -## Created Objects ## +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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. | -## Example Pipelines ## +## Example Pipelines None. -## License & Copyright ## +## License & Copyright Please see the description file distributed with this plugin. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKMhaFileReader.rst b/src/Plugins/ITKImageProcessing/docs/ITKMhaFileReader.rst deleted file mode 100644 index 8f437a1828..0000000000 --- a/src/Plugins/ITKImageProcessing/docs/ITKMhaFileReader.rst +++ /dev/null @@ -1,85 +0,0 @@ -=================== -ITK MHA File Reader -=================== - - -This filter reads the image data from an MHA file. - -The transformation matrix from the MHA file can be optionally read and saved as a data array and/or applied to the -created image geometry. - -Group (Subgroup) -================ - -ITKImageProcessing (ITKImageProcessing) - -Description -=========== - -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 | ImageD | N/A | N/A | The created image geometry that contains the | -| | ataContainer | | | 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 | Transfor | float32 | 16 | 4x4 transformation matrix read from the .mha | -| | mationMatrix | | | input file. Only available if **Save Image | -| | | | | Transformation As Array** is set to True. | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Example Pipelines -================= - -None. - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKMorphologicalGradientImage.md b/src/Plugins/ITKImageProcessing/docs/ITKMorphologicalGradientImage.md index f3cd7967e4..f809bc6754 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKMorphologicalGradientImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKMorphologicalGradientImage.md @@ -13,7 +13,7 @@ The structuring element is assumed to be composed of binary values (zero or one) ## 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. | diff --git a/src/Plugins/ITKImageProcessing/docs/ITKMorphologicalGradientImage.rst b/src/Plugins/ITKImageProcessing/docs/ITKMorphologicalGradientImage.rst deleted file mode 100644 index 67fbbf6c20..0000000000 --- a/src/Plugins/ITKImageProcessing/docs/ITKMorphologicalGradientImage.rst +++ /dev/null @@ -1,66 +0,0 @@ -======================================= -ITK Morphological Gradient Image Filter -======================================= - - -Compute the gradient of a grayscale image. - -Group (Subgroup) -================ - -ITKMathematicalMorphology (MathematicalMorphology) - -Description -=========== - -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 -======================= ======== ================================================================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKMorphologicalWatershedImage.md b/src/Plugins/ITKImageProcessing/docs/ITKMorphologicalWatershedImage.md index f7f2f37c07..b8ecacc04a 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKMorphologicalWatershedImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKMorphologicalWatershedImage.md @@ -26,7 +26,7 @@ This code was contributed in the Insight Journal paper: "The watershed transform ## 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 | diff --git a/src/Plugins/ITKImageProcessing/docs/ITKMorphologicalWatershedImage.rst b/src/Plugins/ITKImageProcessing/docs/ITKMorphologicalWatershedImage.rst deleted file mode 100644 index dad022e2aa..0000000000 --- a/src/Plugins/ITKImageProcessing/docs/ITKMorphologicalWatershedImage.rst +++ /dev/null @@ -1,89 +0,0 @@ -======================================== -ITK Morphological Watershed Image Filter -======================================== - - -Watershed segmentation implementation with morphological operators. - -Group (Subgroup) -================ - -ITKWatersheds (Watersheds) - -Description -=========== - -Watershed pixel are labeled 0. TOutputImage should be an integer type. Labels of output image are in no particular -order. You can reorder the labels such that object labels are consecutive and sorted based on object size by passing the -output of this filter to a RelabelComponentImageFilter . - -The morphological watershed transform algorithm is described in Chapter 9.2 of Pierre Soille’s book “Morphological Image -Analysis: Principles and Applications”, Second Edition, Springer, 2003. - -This code was contributed in the Insight Journal paper: “The watershed transform in ITK - discussion and new -developments” by Beare R., Lehmann G. https://www.insight-journal.org/browse/publication/92 - -Author ------- - -Gaetan Lehmann. Biologie du Developpement et de la Reproduction, INRA de Jouy-en-Josas, France. - -Related Filters ---------------- - -- 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 -======================= ======== =================================================================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKNormalizeImage.md b/src/Plugins/ITKImageProcessing/docs/ITKNormalizeImage.md index c11d660721..5e37714871 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKNormalizeImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKNormalizeImage.md @@ -15,7 +15,7 @@ NB: since this filter normalizes the data such that the mean is at 0, and \f$-\s ## Parameters | Name | Type | Description | -|------|------|-------------| +|------------|------| --------------------------------- | ## Required Geometry diff --git a/src/Plugins/ITKImageProcessing/docs/ITKNormalizeImage.rst b/src/Plugins/ITKImageProcessing/docs/ITKNormalizeImage.rst deleted file mode 100644 index 4ff6ead547..0000000000 --- a/src/Plugins/ITKImageProcessing/docs/ITKNormalizeImage.rst +++ /dev/null @@ -1,73 +0,0 @@ -========================== -ITK Normalize Image Filter -========================== - - -.. role:: raw-latex(raw) - :format: latex -.. - -Normalize an image by setting its mean to zero and variance to one. - -Group (Subgroup) -================ - -ITKImageIntensity (ImageIntensity) - -Description -=========== - -NormalizeImageFilter shifts and scales an image so that the pixels in the image have a zero mean and unit variance. This -filter uses StatisticsImageFilter to compute the mean and variance of the input and then applies ShiftScaleImageFilter -to shift and scale the pixels. - -NB: since this filter normalizes the data such that the mean is at 0, and :raw-latex:`\f`\ :math:`-\sigma\f` to -:raw-latex:`\f`\ :math:`+\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 -======================= ======== ================================================================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKNotImage.md b/src/Plugins/ITKImageProcessing/docs/ITKNotImage.md index c8f9e11674..a82886be03 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKNotImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKNotImage.md @@ -33,7 +33,7 @@ Where "!" is the unary Logical NOT operator in C++. ## Parameters | Name | Type | Description | -|------|------|-------------| +|------------|------| --------------------------------- | ## Required Geometry diff --git a/src/Plugins/ITKImageProcessing/docs/ITKNotImage.rst b/src/Plugins/ITKImageProcessing/docs/ITKNotImage.rst deleted file mode 100644 index 3c1cb8d59e..0000000000 --- a/src/Plugins/ITKImageProcessing/docs/ITKNotImage.rst +++ /dev/null @@ -1,83 +0,0 @@ -==================== -ITK Not Image Filter -==================== - - -Implements the NOT logical operator pixel-wise on an image. - -Group (Subgroup) -================ - -ITKImageIntensity (ImageIntensity) - -Description -=========== - -This class is templated over the type of an input image and the type of the output image. Numeric conversions (castings) -are done by the C++ defaults. - -Since the logical NOT operation operates only on boolean types, the input type must be implicitly convertible to bool, -which is only defined in C++ for integer types, the images passed to this filter must comply with the requirement of -using integer pixel type. - -The total operation over one pixel will be - -:: - - if( !A ) - - { - - return this->m_ForegroundValue; - - } - - 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 -======================= ======== ==================================================================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKOpeningByReconstructionImage.md b/src/Plugins/ITKImageProcessing/docs/ITKOpeningByReconstructionImage.md index 294f3a64d0..6259d4fd9e 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKOpeningByReconstructionImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKOpeningByReconstructionImage.md @@ -28,7 +28,7 @@ Applications", Second Edition, Springer, 2003. ## 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 | diff --git a/src/Plugins/ITKImageProcessing/docs/ITKOpeningByReconstructionImage.rst b/src/Plugins/ITKImageProcessing/docs/ITKOpeningByReconstructionImage.rst deleted file mode 100644 index 9bc4de5ac5..0000000000 --- a/src/Plugins/ITKImageProcessing/docs/ITKOpeningByReconstructionImage.rst +++ /dev/null @@ -1,97 +0,0 @@ -========================================== -ITK Opening By Reconstruction Image Filter -========================================== - - -Opening by reconstruction of an image. - -Group (Subgroup) -================ - -ITKMathematicalMorphology (MathematicalMorphology) - -Description -=========== - -This filter preserves regions, in the foreground, that can completely contain the structuring element. At the same time, -this filter eliminates all other regions of foreground pixels. Contrary to the morphological opening, the opening by -reconstruction preserves the shape of the components that are not removed by erosion. The opening by reconstruction of -an image “f” is defined as: - -OpeningByReconstruction(f) = DilationByReconstruction(f, Erosion(f)). - -Opening by reconstruction not only removes structures destroyed by the erosion, but also levels down the contrast of the -brightest regions. If PreserveIntensities is on, a subsequent reconstruction by dilation using a marker image that is -the original image for all unaffected pixels. - -Opening by reconstruction is described in Chapter 6.3.9 of Pierre Soille’s book “Morphological Image Analysis: -Principles and Applications”, Second Edition, Springer, 2003. - -Author ------- - -Gaetan Lehmann. Biologie du Developpement et de la Reproduction, INRA de Jouy-en-Josas, France. - -Related Filters ---------------- - -- 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 -======================= ======== ================================================================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKOtsuMultipleThresholdsImage.md b/src/Plugins/ITKImageProcessing/docs/ITKOtsuMultipleThresholdsImage.md index 10c5974b93..153cdc0611 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKOtsuMultipleThresholdsImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKOtsuMultipleThresholdsImage.md @@ -17,7 +17,7 @@ This filter also includes an option to use the valley emphasis algorithm from H. ## 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. | diff --git a/src/Plugins/ITKImageProcessing/docs/ITKOtsuMultipleThresholdsImage.rst b/src/Plugins/ITKImageProcessing/docs/ITKOtsuMultipleThresholdsImage.rst deleted file mode 100644 index 650efee207..0000000000 --- a/src/Plugins/ITKImageProcessing/docs/ITKOtsuMultipleThresholdsImage.rst +++ /dev/null @@ -1,83 +0,0 @@ -========================================= -ITK Otsu Multiple Thresholds Image Filter -========================================= - - -Threshold an image using multiple Otsu Thresholds. - -Group (Subgroup) -================ - -ITKThresholding (Thresholding) - -Description -=========== - -This filter creates a labeled image that separates the input image into various classes. The filter computes the -thresholds using the OtsuMultipleThresholdsCalculator and applies those thresholds to the input image using the -ThresholdLabelerImageFilter . The NumberOfHistogramBins and NumberOfThresholds can be set for the Calculator. The -LabelOffset can be set for the ThresholdLabelerImageFilter . - -This filter also includes an option to use the valley emphasis algorithm from H.F. Ng, “Automatic thresholding for -defect detection”, Pattern Recognition Letters, (27): 1644-1649, 2006. The valley emphasis algorithm is particularly -effective when the object to be thresholded is small. See the following tests for examples: -itkOtsuMultipleThresholdsImageFilterTest3 and itkOtsuMultipleThresholdsImageFilterTest4 To use this algorithm, simple -call the setter: SetValleyEmphasis(true) It is turned off by default.\* ScalarImageToHistogramGenerator - -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 -======================= ======== ================================================================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKRelabelComponentImage.md b/src/Plugins/ITKImageProcessing/docs/ITKRelabelComponentImage.md index 96eccbcee2..d816854d5c 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKRelabelComponentImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKRelabelComponentImage.md @@ -23,7 +23,7 @@ RelabelComponentImageFilter can be run as an "in place" filter, where it will ov ## 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. | diff --git a/src/Plugins/ITKImageProcessing/docs/ITKRelabelComponentImage.rst b/src/Plugins/ITKImageProcessing/docs/ITKRelabelComponentImage.rst deleted file mode 100644 index 6d189f397f..0000000000 --- a/src/Plugins/ITKImageProcessing/docs/ITKRelabelComponentImage.rst +++ /dev/null @@ -1,96 +0,0 @@ -================================== -ITK Relabel Component Image Filter -================================== - - -Relabel the components in an image such that consecutive labels are used. - -Group (Subgroup) -================ - -ITKConnectedComponents (ConnectedComponents) - -Description -=========== - -RelabelComponentImageFilter remaps the labels associated with the objects in an image (as from the output of -ConnectedComponentImageFilter ) such that the label numbers are consecutive with no gaps between the label numbers used. -By default, the relabeling will also sort the labels based on the size of the object: the largest object will have label -#1, the second largest will have label #2, etc. If two labels have the same size their initial order is kept. The -sorting by size can be disabled using SetSortByObjectSize. - -Label #0 is assumed to be the background and is left unaltered by the relabeling. - -RelabelComponentImageFilter is typically used on the output of the ConnectedComponentImageFilter for those applications -that want to extract the largest object or the “k” largest objects. Any particular object can be extracted from the -relabeled output using a BinaryThresholdImageFilter . A group of objects can be extracted from the relabeled output -using a ThresholdImageFilter . - -Once all the objects are relabeled, the application can query the number of objects and the size of each object. Object -sizes are returned in a vector. The size of the background is not calculated. So the size of object #1 is -GetSizeOfObjectsInPixels() [0], the size of object #2 is GetSizeOfObjectsInPixels() [1], etc. - -If user sets a minimum object size, all objects with fewer pixels than the minimum will be discarded, so that the number -of objects reported will be only those remaining. The GetOriginalNumberOfObjects method can be called to find out how -many objects were present before the small ones were discarded. - -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 -======================= ======== ==================================================================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKRescaleIntensityImage.md b/src/Plugins/ITKImageProcessing/docs/ITKRescaleIntensityImage.md index 0404b95c0d..b15aa04d4c 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKRescaleIntensityImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKRescaleIntensityImage.md @@ -24,7 +24,7 @@ NOTE: In this filter the minimum and maximum values of the input image are compu ## Parameters | Name | Type | Description | -|------|------|-------------| +|------------|------| --------------------------------- | | OutputMinimum | float64 | | | OutputMaximum | float64 | | diff --git a/src/Plugins/ITKImageProcessing/docs/ITKRescaleIntensityImage.rst b/src/Plugins/ITKImageProcessing/docs/ITKRescaleIntensityImage.rst deleted file mode 100644 index 12840d61b2..0000000000 --- a/src/Plugins/ITKImageProcessing/docs/ITKRescaleIntensityImage.rst +++ /dev/null @@ -1,84 +0,0 @@ -================================== -ITK Rescale Intensity Image Filter -================================== - - -.. role:: raw-latex(raw) - :format: latex -.. - -Applies a linear transformation to the intensity levels of the input Image . - -Group (Subgroup) -================ - -ITKImageIntensity (ImageIntensity) - -Description -=========== - -RescaleIntensityImageFilter applies pixel-wise a linear transformation to the intensity values of input image pixels. -The linear transformation is defined by the user in terms of the minimum and maximum values that the output image should -have. - -The following equation gives the mapping of the intensity values - -:raw-latex:`\f[` outputPixel = ( inputPixel - inputMin) -:raw-latex:`\cdot `:raw-latex:`\frac{(outputMax - outputMin )}{(inputMax - inputMin)}` + outputMin :raw-latex:`\f]` - -All computations are performed in the precision of the input pixel’s RealType. Before assigning the computed value to -the output pixel. - -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 -======================= ======== ================================================================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKSigmoidImage.rst b/src/Plugins/ITKImageProcessing/docs/ITKSigmoidImage.rst deleted file mode 100644 index 57cd74ccf1..0000000000 --- a/src/Plugins/ITKImageProcessing/docs/ITKSigmoidImage.rst +++ /dev/null @@ -1,75 +0,0 @@ -======================== -ITK Sigmoid Image Filter -======================== - - -Computes the sigmoid function pixel-wise. - -Group (Subgroup) -================ - -ITKImageIntensity (ImageIntensity) - -Description -=========== - -A linear transformation is applied first on the argument of the sigmoid function. The resulting total transform is given -by - -.. figure:: Images/ITKSigmoidImage_Equation.png - :alt: Images/ITKSigmoidImage_Equation.png - - Images/ITKSigmoidImage_Equation.png - -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 -======================= ======== ================================================================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKSignedMaurerDistanceMapImage.md b/src/Plugins/ITKImageProcessing/docs/ITKSignedMaurerDistanceMapImage.md index 531de57133..15f0beb717 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKSignedMaurerDistanceMapImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKSignedMaurerDistanceMapImage.md @@ -27,7 +27,7 @@ Reference: C. R. Maurer, Jr., R. Qi, and V. Raghavan, "A Linear Time Algorithm ## 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. | diff --git a/src/Plugins/ITKImageProcessing/docs/ITKSignedMaurerDistanceMapImage.rst b/src/Plugins/ITKImageProcessing/docs/ITKSignedMaurerDistanceMapImage.rst deleted file mode 100644 index ddbe314a08..0000000000 --- a/src/Plugins/ITKImageProcessing/docs/ITKSignedMaurerDistanceMapImage.rst +++ /dev/null @@ -1,88 +0,0 @@ -=========================================== -ITK Signed Maurer Distance Map Image Filter -=========================================== - - -This filter calculates the Euclidean distance transform of a binary image in linear time for arbitrary dimensions. - -Group (Subgroup) -================ - -ITKDistanceMap (DistanceMap) - -Description -=========== - -Inputs and Outputs This is an image-to-image filter. The dimensionality is arbitrary. The only dimensionality constraint -is that the input and output images be of the same dimensions and size. To maintain integer arithmetic within the -filter, the default output is the signed squared distance. This implies that the input image should be of type “unsigned -int” or “int” whereas the output image is of type “int”. Obviously, if the user wishes to utilize the image spacing or -to have a filter with the Euclidean distance (as opposed to the squared distance), output image types of float or double -should be used. - -The inside is considered as having negative distances. Outside is treated as having positive distances. To change the -convention, use the InsideIsPositive(bool) function. - -Parameters Set/GetBackgroundValue specifies the background of the value of the input binary image. Normally this is zero -and, as such, zero is the default value. Other than that, the usage is completely analogous to the -itk::DanielssonDistanceImageFilter class except it does not return the Voronoi map. - -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 -======================= ======== ==================================================================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKSinImage.md b/src/Plugins/ITKImageProcessing/docs/ITKSinImage.md index c72cd8721a..8b0edff41c 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKSinImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKSinImage.md @@ -13,7 +13,7 @@ The computations are performed using std::sin(x). ## Parameters | Name | Type | Description | -|------|------|-------------| +|------------|------| --------------------------------- | ## Required Geometry diff --git a/src/Plugins/ITKImageProcessing/docs/ITKSinImage.rst b/src/Plugins/ITKImageProcessing/docs/ITKSinImage.rst deleted file mode 100644 index d16639bae2..0000000000 --- a/src/Plugins/ITKImageProcessing/docs/ITKSinImage.rst +++ /dev/null @@ -1,62 +0,0 @@ -==================== -ITK Sin Image Filter -==================== - - -Computes the sine of each pixel. - -Group (Subgroup) -================ - -ITKImageIntensity (ImageIntensity) - -Description -=========== - -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 -======================= ======== ================================================================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKSqrtImage.md b/src/Plugins/ITKImageProcessing/docs/ITKSqrtImage.md index f01f3808aa..3d52e58ca8 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKSqrtImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKSqrtImage.md @@ -13,7 +13,7 @@ The computations are performed using std::sqrt(x). ## Parameters | Name | Type | Description | -|------|------|-------------| +|------------|------| --------------------------------- | ## Required Geometry diff --git a/src/Plugins/ITKImageProcessing/docs/ITKSqrtImage.rst b/src/Plugins/ITKImageProcessing/docs/ITKSqrtImage.rst deleted file mode 100644 index 4dabb70efe..0000000000 --- a/src/Plugins/ITKImageProcessing/docs/ITKSqrtImage.rst +++ /dev/null @@ -1,62 +0,0 @@ -===================== -ITK Sqrt Image Filter -===================== - - -Computes the square root of each pixel. - -Group (Subgroup) -================ - -ITKImageIntensity (ImageIntensity) - -Description -=========== - -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 -======================= ======== ================================================================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKSquareImage.md b/src/Plugins/ITKImageProcessing/docs/ITKSquareImage.md index e3c7b8cb4b..8594a5ca5b 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKSquareImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKSquareImage.md @@ -13,7 +13,7 @@ ITKImageIntensity (ImageIntensity) ## Parameters | Name | Type | Description | -|------|------|-------------| +|------------|------| --------------------------------- | ## Required Geometry diff --git a/src/Plugins/ITKImageProcessing/docs/ITKSquareImage.rst b/src/Plugins/ITKImageProcessing/docs/ITKSquareImage.rst deleted file mode 100644 index 5b865f503f..0000000000 --- a/src/Plugins/ITKImageProcessing/docs/ITKSquareImage.rst +++ /dev/null @@ -1,60 +0,0 @@ -======================= -ITK Square Image Filter -======================= - - -Computes the square of the intensity values pixel-wise. - -Group (Subgroup) -================ - -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 -======================= ======== ================================================================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKTanImage.md b/src/Plugins/ITKImageProcessing/docs/ITKTanImage.md index 57242258ef..54cfbd234a 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKTanImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKTanImage.md @@ -13,7 +13,7 @@ The computations are performed using std::tan(x). ## Parameters | Name | Type | Description | -|------|------|-------------| +|------------|------| --------------------------------- | ## Required Geometry diff --git a/src/Plugins/ITKImageProcessing/docs/ITKTanImage.rst b/src/Plugins/ITKImageProcessing/docs/ITKTanImage.rst deleted file mode 100644 index 9f6faa7094..0000000000 --- a/src/Plugins/ITKImageProcessing/docs/ITKTanImage.rst +++ /dev/null @@ -1,62 +0,0 @@ -==================== -ITK Tan Image Filter -==================== - - -Computes the tangent of each input pixel. - -Group (Subgroup) -================ - -ITKImageIntensity (ImageIntensity) - -Description -=========== - -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 -======================= ======== ================================================================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKThresholdImage.md b/src/Plugins/ITKImageProcessing/docs/ITKThresholdImage.md index ce495c7dc7..088645b5de 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKThresholdImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKThresholdImage.md @@ -25,7 +25,7 @@ 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() . | diff --git a/src/Plugins/ITKImageProcessing/docs/ITKThresholdImage.rst b/src/Plugins/ITKImageProcessing/docs/ITKThresholdImage.rst deleted file mode 100644 index 90ebb4ade3..0000000000 --- a/src/Plugins/ITKImageProcessing/docs/ITKThresholdImage.rst +++ /dev/null @@ -1,84 +0,0 @@ -========================== -ITK Threshold Image Filter -========================== - - -Set image values to a user-specified value if they are below, above, or between simple threshold values. - -Group (Subgroup) -================ - -ITKThresholding (Thresholding) - -Description -=========== - -ThresholdImageFilter sets image values to a user-specified “outside” value (by default, “black”) if the image values are -below, above, or between simple threshold values. - -The available methods are: - -ThresholdAbove() : The values greater than the threshold value are set to OutsideValue - -ThresholdBelow() : The values less than the threshold value are set to OutsideValue - -ThresholdOutside() : The values outside the threshold range (less than lower or greater than upper) are set to -OutsideValue - -Note that these definitions indicate that pixels equal to the threshold value are not set to OutsideValue in any of -these methods - -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 -======================= ======== ================================================================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKValuedRegionalMaximaImage.md b/src/Plugins/ITKImageProcessing/docs/ITKValuedRegionalMaximaImage.md index bd23475a87..ca683045d2 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKValuedRegionalMaximaImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKValuedRegionalMaximaImage.md @@ -33,7 +33,7 @@ This code was contributed in the Insight Journal paper: "Finding regional extrem ## 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 diff --git a/src/Plugins/ITKImageProcessing/docs/ITKValuedRegionalMaximaImage.rst b/src/Plugins/ITKImageProcessing/docs/ITKValuedRegionalMaximaImage.rst deleted file mode 100644 index 75562f51a1..0000000000 --- a/src/Plugins/ITKImageProcessing/docs/ITKValuedRegionalMaximaImage.rst +++ /dev/null @@ -1,89 +0,0 @@ -======================================= -ITK Valued Regional Maxima Image Filter -======================================= - - -Transforms the image so that any pixel that is not a regional maxima is set to the minimum value for the pixel type. -Pixels that are regional maxima retain their value. - -The pixel neighborhood is controlled by the FullyConnected attribute. All adjacent pixels are included in the -neighborhood when FullyConnected=True and the diagonally adjacent pixels are not included when FullyConnected=False. -Different terminology is often used to describe neighborhoods – one common ex- ample is the “connectivity” notation, -which refers to the number of pixels in the neighborhood. FullyCon- nected=False corresponds to a connectivty of 4 in 2D -and 6 in 3D, while FullyConnected=True corresponds to a connectivity of 8 in 2D and 26 in 3D. FullyConnected=False is -also commonly referred to as “face connected”. - -Group (Subgroup) -================ - -ITKMathematicalMorphology (MathematicalMorphology) - -Description -=========== - -Regional maxima are flat zones surrounded by pixels of lower value. A completely flat image will be marked as a regional -maxima by this filter. - -This code was contributed in the Insight Journal paper: “Finding regional extrema - methods and performance” by Beare -R., Lehmann G. https://www.insight-journal.org/browse/publication/65 - -Author ------- - -Richard Beare. Department of Medicine, Monash University, Melbourne, Australia. - -Related Filters ---------------- - -- ValuedRegionalMinimaImageFilter -- 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 -======================= ======== =================================================================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKValuedRegionalMinimaImage.md b/src/Plugins/ITKImageProcessing/docs/ITKValuedRegionalMinimaImage.md index b40fab8a91..ee35cff93f 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKValuedRegionalMinimaImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKValuedRegionalMinimaImage.md @@ -24,7 +24,7 @@ This code was contributed in the Insight Journal paper: "Finding regional extrem ## 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 diff --git a/src/Plugins/ITKImageProcessing/docs/ITKValuedRegionalMinimaImage.rst b/src/Plugins/ITKImageProcessing/docs/ITKValuedRegionalMinimaImage.rst deleted file mode 100644 index 7af28dad40..0000000000 --- a/src/Plugins/ITKImageProcessing/docs/ITKValuedRegionalMinimaImage.rst +++ /dev/null @@ -1,81 +0,0 @@ -======================================= -ITK Valued Regional Minima Image Filter -======================================= - - -Transforms the image so that any pixel that is not a regional minima is set to the maximum value for the pixel type. -Pixels that are regional minima retain their value. - -Group (Subgroup) -================ - -ITKMathematicalMorphology (MathematicalMorphology) - -Description -=========== - -Regional minima are flat zones surrounded by pixels of higher value. A completely flat image will be marked as a -regional minima by this filter. - -This code was contributed in the Insight Journal paper: “Finding regional extrema - methods and performance” by Beare -R., Lehmann G. https://www.insight-journal.org/browse/publication/65 - -Author ------- - -Richard Beare. Department of Medicine, Monash University, Melbourne, Australia. - -Related Filters ---------------- - -- 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 -======================= ======== =================================================================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ITKImageProcessing/docs/ITKWhiteTopHatImage.md b/src/Plugins/ITKImageProcessing/docs/ITKWhiteTopHatImage.md index 5cb9a45847..805f1bd5fb 100644 --- a/src/Plugins/ITKImageProcessing/docs/ITKWhiteTopHatImage.md +++ b/src/Plugins/ITKImageProcessing/docs/ITKWhiteTopHatImage.md @@ -20,7 +20,7 @@ Top-hats are described in Chapter 4.5 of Pierre Soille's book "Morphological Ima ## 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 | diff --git a/src/Plugins/ITKImageProcessing/docs/ITKWhiteTopHatImage.rst b/src/Plugins/ITKImageProcessing/docs/ITKWhiteTopHatImage.rst deleted file mode 100644 index c6fade09ad..0000000000 --- a/src/Plugins/ITKImageProcessing/docs/ITKWhiteTopHatImage.rst +++ /dev/null @@ -1,78 +0,0 @@ -============================== -ITK White Top Hat Image Filter -============================== - - -White top hat extracts local maxima that are larger than the structuring element. - -Group (Subgroup) -================ - -ITKMathematicalMorphology (MathematicalMorphology) - -Description -=========== - -Top-hats are described in Chapter 4.5 of Pierre Soille’s book “Morphological Image Analysis: Principles and -Applications”, Second Edition, Springer, 2003. - -Author ------- - -Gaetan Lehmann. Biologie du Developpement et de la Reproduction, INRA de Jouy-en-Josas, France. - -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 -======================= ======== ================================================================== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/ITKImageProcessing/tools/ReadMe.rst b/src/Plugins/ITKImageProcessing/tools/ReadMe.rst deleted file mode 100644 index 9d3dc485cd..0000000000 --- a/src/Plugins/ITKImageProcessing/tools/ReadMe.rst +++ /dev/null @@ -1,24 +0,0 @@ -================= -Using these tools -================= - - -You will need to clone SimpleITK from: https://github.com/SimpleITK/SimpleITK - -From the file ``itk_filter_generator.py``, you will need to update the python variable ``filters_to_process`` to include -the filters that you want to generate. - -Then you can run the ``itk_filter_generator.py`` file to generate the filters. - -An example usage of the python script is this: - -:: - - python itk_filter_generator.py `pwd` `pwd`/SimpleITK/Code/BasicFilters/json /Users/mjackson/Workspace1/complex/src/Plugins/ITKImageProcessing/src/ITKImageProcessing/Filters /Users/mjackson/Workspace1/complex/src/Plugins/ITKImageProcessing/test - -Modification Notes -================== - -For the ITKDiscreteGaussianImageTest that is generated, for the test against the ``short`` type, the tolerance should be -1.0. It is set at ``0.6`` in the JSON file. This will not work because we are comparing an integer type. The input, -baseline and generated files were all visually compared to ensure the output is indeed correct (M. A. Jackson) diff --git a/src/Plugins/OrientationAnalysis/3rdParty/canvas_ity/ReadMe.rst b/src/Plugins/OrientationAnalysis/3rdParty/canvas_ity/ReadMe.rst deleted file mode 100644 index 62b6d6e701..0000000000 --- a/src/Plugins/OrientationAnalysis/3rdParty/canvas_ity/ReadMe.rst +++ /dev/null @@ -1,6 +0,0 @@ -commit f32fbb37e2fe7c0fcaee6ebdc02d3e5385603fd5 (HEAD -> main, origin/main, origin/HEAD) Author: Andrew Kensler -andrew@eastfarthing.com Date: Sun Oct 9 23:25:20 2022 -0700 - -:: - - v1.00 release diff --git a/src/Plugins/OrientationAnalysis/PortingOrientationAnalysisFilter.md b/src/Plugins/OrientationAnalysis/PortingOrientationAnalysisFilter.md index 16486e2f38..1080a007fb 100644 --- a/src/Plugins/OrientationAnalysis/PortingOrientationAnalysisFilter.md +++ b/src/Plugins/OrientationAnalysis/PortingOrientationAnalysisFilter.md @@ -1,14 +1,14 @@ -# Porting Orientation Analysis Filter # +# Porting Orientation Analysis Filter -## Updating the Legacy UUID Maps ## +## Updating the Legacy UUID Maps This **Plugin** contains two folders of filters instructions for both are below: -> ### If Porting From ***SIMPL*** to ***Filters Folder*** ### +> ### If Porting From ***SIMPL*** to ***Filters Folder*** > Use the **ComplexFilterGen** module distributed in ***SIMPL DREAM3D***. This module will automatically update the LegacyUUIDMapping for this **Plugin**. > -> ### If Moving to ***Filters*** ### +> ### If Moving to ***Filters*** >
          1. Open the LegacyUUIDMapping header file for this Plugin
          2. Uncomment the include statement for the filter being moved
          3. diff --git a/src/Plugins/OrientationAnalysis/PortingOrientationAnalysisFilter.rst b/src/Plugins/OrientationAnalysis/PortingOrientationAnalysisFilter.rst deleted file mode 100644 index 28039f4190..0000000000 --- a/src/Plugins/OrientationAnalysis/PortingOrientationAnalysisFilter.rst +++ /dev/null @@ -1,63 +0,0 @@ -=================================== -Porting Orientation Analysis Filter -=================================== - - -Updating the Legacy UUID Maps -============================= - -This **Plugin** contains two folders of filters instructions for both are below: - - .. rubric:: If Porting From **SIMPL** to **Filters Folder** - :name: if-porting-from-simpl-to-filters-folder - - Use the **ComplexFilterGen** module distributed in **SIMPL DREAM3D**. This module will automatically update the - LegacyUUIDMapping for this **Plugin**. - - .. rubric:: If Moving to **Filters** - :name: if-moving-to-filters - - .. raw:: html - -
              - - .. raw:: html - -
            1. - - Open the LegacyUUIDMapping header file for this Plugin - - .. raw:: html - -
            2. - - .. raw:: html - -
            3. - - Uncomment the include statement for the filter being moved - - .. raw:: html - -
            4. - - .. raw:: html - -
            5. - - Uncomment the map entry for the filter being moved - - .. raw:: html - -
            6. - - .. raw:: html - -
            - -When working with the **LegacyUUIDMapping** header file in this **Plugin** be sure to make sure the commented out tokens -are not removed. Their syntax is one of the following: > \*\ **@@\__HEADER\__TOKEN\__DO\__NOT\__DELETE\_\_@@\*** - -or - - \*\ **@@\__MAP\__UPDATE\__TOKEN\__DO\__NOT\__DELETE\_\_@@\*** diff --git a/src/Plugins/OrientationAnalysis/Support/GMT/UsingGMT.md b/src/Plugins/OrientationAnalysis/Support/GMT/UsingGMT.md index 4335c8a2dc..0bbe7dfef5 100644 --- a/src/Plugins/OrientationAnalysis/Support/GMT/UsingGMT.md +++ b/src/Plugins/OrientationAnalysis/Support/GMT/UsingGMT.md @@ -1,7 +1,7 @@ -# Using GMT With DREAM3D # +# Using GMT With DREAM3D -## Tools Needed ## +## Tools Needed + GMT version 5.x + ImageMagick installed (which has the "convert" utility) @@ -9,25 +9,25 @@ + Shell environment that can run 'bash'. This means "MSys" on windows. -## Windows Setup ## +## Windows Setup -### Install ImageMagick ### +### Install ImageMagick Download the zip version of *ImageMagick* from [http://www.imagemagick.org/script/binary-releases.php](http://www.imagemagick.org/script/binary-releases.php). Select the type if release that you are allowed to install. Note for windows that there is a .zip which does not require an installer to be executed. This is probably the best route for those without sys-admin privileges on their machines. -### Install Ghostscript ### +### Install Ghostscript Download Ghostscript from [http://www.ghostscript.com/download/gsdnld.html](http://www.ghostscript.com/download/gsdnld.html). **NOTE:** Download the **32bit** version regardless of what version of Windows you are running. The ImageMagick installation seems to default to using a 32 bit version of Ghostscript. There are ways around this that involve hacking the ImageMagick Installation. -### Install an MSys Environment ### +### Install an MSys Environment I just used the MSys that came with "Git-Bash" for windows. -### Install GMT Version 5.x ### +### Install GMT Version 5.x Download and install GMT version 5.x from the GMT website [http://gmt.soest.hawaii.edu/projects/gmt/wiki/Download](http://gmt.soest.hawaii.edu/projects/gmt/wiki/Download). Again select what works best for your system and access privileges. -### Getting started with GMT ### +### Getting started with GMT Launch a "Git Bash" shell which is an MSys shell. Now we need to export the paths to all the packages we just got done installing. For example I have installed all the packages (GMT, ImageMagick, Ghostscript) into C:/Applications so I would need to do the following: export PATH=/c/Applications/gmt5/bin:$PATH @@ -44,11 +44,11 @@ After you have executed those commands (Which you could put in your .bashrc file /c/Applications/ImageMagick-6.8.8-4/gswin32c -## Unix/Linux Setup ## +## Unix/Linux Setup Use your package manager to install/verify that GMT5, ImageMagick and Ghostscript are all installed. -## OS X Setup ## +## OS X Setup Download the GMT standalone installer which is a .dmg file. Double click the .dmg, copy the gmt.app into your applications folder. ### Use Homebrew to install ImageMagick @@ -60,7 +60,7 @@ brew install imagemagick export PATH=$PATH:/Applications/ -## Command Line 5D Parameter GBCD ## +## Command Line 5D Parameter GBCD + Generate the GMT .dat file from DREAM.3D + Make sure the GMT environment is setup completely @@ -70,7 +70,7 @@ export PATH=$PATH:/Applications/ ./DrawStereograms [number_of_files] [Stereo_file_name] 5d rainbow [Lo] [Hi] [step] stereo HEX|CUBIC -### Example ### +### Example ./Draw_stereograms 1 gbcd_Mg_9bins_gmt_ 5d rainbow 0.79 9.71 0.89 diff --git a/src/Plugins/OrientationAnalysis/Support/GMT/UsingGMT.rst b/src/Plugins/OrientationAnalysis/Support/GMT/UsingGMT.rst deleted file mode 100644 index 81ed240ee7..0000000000 --- a/src/Plugins/OrientationAnalysis/Support/GMT/UsingGMT.rst +++ /dev/null @@ -1,110 +0,0 @@ -====================== -Using GMT With DREAM3D -====================== - - -Tools Needed -============ - -- GMT version 5.x -- ImageMagick installed (which has the “convert” utility) -- Ghostscript installed (to convert postscript files to image files) -- Shell environment that can run ‘bash’. This means “MSys” on windows. - -Windows Setup -============= - -Install ImageMagick -------------------- - -Download the zip version of *ImageMagick* from http://www.imagemagick.org/script/binary-releases.php. Select the type if -release that you are allowed to install. Note for windows that there is a .zip which does not require an installer to be -executed. This is probably the best route for those without sys-admin privileges on their machines. - -Install Ghostscript -------------------- - -Download Ghostscript from http://www.ghostscript.com/download/gsdnld.html. **NOTE:** Download the **32bit** version -regardless of what version of Windows you are running. The ImageMagick installation seems to default to using a 32 bit -version of Ghostscript. There are ways around this that involve hacking the ImageMagick Installation. - -Install an MSys Environment ---------------------------- - -I just used the MSys that came with “Git-Bash” for windows. - -Install GMT Version 5.x ------------------------ - -Download and install GMT version 5.x from the GMT website http://gmt.soest.hawaii.edu/projects/gmt/wiki/Download. Again -select what works best for your system and access privileges. - -Getting started with GMT ------------------------- - -Launch a “Git Bash” shell which is an MSys shell. Now we need to export the paths to all the packages we just got done -installing. For example I have installed all the packages (GMT, ImageMagick, Ghostscript) into C:/Applications so I -would need to do the following: - -:: - - export PATH=/c/Applications/gmt5/bin:$PATH - export PATH=/c/Applications/gs/gs9.10/bin:$PATH - export PATH=/c/Applications/ImageMagick-6.8.8-4:$PATH - -After you have executed those commands (Which you could put in your .bashrc file) you can then verify that the -executables are in the path: - -:: - - $ which gmt - /c/Applications/gmt5/bin/gmt - $ which convert - /c/Applications/gs/gs9.10/bin/convert - $ which gswin32c - /c/Applications/ImageMagick-6.8.8-4/gswin32c - -Unix/Linux Setup -================ - -Use your package manager to install/verify that GMT5, ImageMagick and Ghostscript are all installed. - -OS X Setup -========== - -Download the GMT standalone installer which is a .dmg file. Double click the .dmg, copy the gmt.app into your -applications folder. - -Use Homebrew to install ImageMagick ------------------------------------ - -Download the HomeBrew installer - -:: - - brew install imagemagick - -export PATH=$PATH:/Applications/ - -Command Line 5D Parameter GBCD -============================== - -- Generate the GMT .dat file from DREAM.3D - -- Make sure the GMT environment is setup completely - -- Execute the following: - - :: - - ./DrawStereograms [number_of_files] [Stereo_file_name] 5d rainbow [Lo] [Hi] [step] stereo HEX|CUBIC - -Example -------- - -:: - - ./Draw_stereograms 1 gbcd_Mg_9bins_gmt_ 5d rainbow 0.79 9.71 0.89 - -Note the actual input file is named *gbcd_Mg_9bins_gmt_1.dat* but we are using a substring of that file name as the -argument to the script diff --git a/src/Plugins/OrientationAnalysis/data/ReadMe.rst b/src/Plugins/OrientationAnalysis/data/ReadMe.rst deleted file mode 100644 index 142b474af0..0000000000 --- a/src/Plugins/OrientationAnalysis/data/ReadMe.rst +++ /dev/null @@ -1,18 +0,0 @@ -================= -Data Descriptions -================= - -+----------------------------------+--------------------+--------------------+-----------------------+----------------+ -| FileName | Type | Dims | Notes | MD5 | -+==================================+====================+====================+=======================+================+ -| fz_quats.raw | Float 32 | 100 x 100 x 2 x 4 | Quaternions from | 7a69 | -| | | | Small IN100 converted | b4d01447fcdb59 | -| | | | to Fundamental Zone | d32f416be22492 | -| | | | \*\* | | -+----------------------------------+--------------------+--------------------+-----------------------+----------------+ -| quats.raw | Float 32 | 100 x 100 x 2 x 4 | Quaternions from | f163 | -| | | | Small IN100 Data Set | cc7930c6f19a83 | -| | | | | c2b9cd1dd26938 | -+----------------------------------+--------------------+--------------------+-----------------------+----------------+ - -\*\* Cropped from X 41-140 (inclusive), Y 41-140 (inclusive), Z 0-1 (inclusive) for a dim of 100 x 100 x 2 diff --git a/src/Plugins/OrientationAnalysis/docs/AlignSectionsMisorientationFilter.md b/src/Plugins/OrientationAnalysis/docs/AlignSectionsMisorientationFilter.md index 99e71696d9..49e5b61e3e 100644 --- a/src/Plugins/OrientationAnalysis/docs/AlignSectionsMisorientationFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/AlignSectionsMisorientationFilter.md @@ -1,11 +1,11 @@ # Align Sections (Misorientation) -## Group (Subgroup) ## +## Group (Subgroup) Reconstruction (Alignment) -## Description ## +## Description This **Filter** attempts to align consecutive 'sections' perpendicular to the Z-direction of the sample by determining the position that results in the minimum amount of misorientation between **Cells** directly above-below each other. The algorithm of this **Filter** is as follows: @@ -24,10 +24,10 @@ 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 ## +## 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 | @@ -35,29 +35,29 @@ The user can also decide to remove a *background shift* present in the sample. T | Use Mask Array | bool | Whether to remove some **Cells** from consideration in the alignment process | -## Required Geometry ## +## Required Geometry Image -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | +| Ensemble Attribute Array | CrystalStructures | uint32_t | (1) | Enumeration representing the crystal structure for each Ensemble | -## Created Objects ## +## Created Objects None -## Example Pipelines ## +## Example Pipelines + (10) SmallIN100 Full Reconstruction + (03) SmallIN100 Alignment -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/OrientationAnalysis/docs/AlignSectionsMisorientationFilter.rst b/src/Plugins/OrientationAnalysis/docs/AlignSectionsMisorientationFilter.rst deleted file mode 100644 index 217f33eb50..0000000000 --- a/src/Plugins/OrientationAnalysis/docs/AlignSectionsMisorientationFilter.rst +++ /dev/null @@ -1,121 +0,0 @@ -=============================== -Align Sections (Misorientation) -=============================== - - -Group (Subgroup) -================ - -Reconstruction (Alignment) - -Description -=========== - -This **Filter** attempts to align consecutive ‘sections’ perpendicular to the Z-direction of the sample by determining -the position that results in the minimum amount of misorientation between **Cells** directly above-below each other. The -algorithm of this **Filter** is as follows: - -1. Calculate the misorientation between each **Cell** in a section and the **Cell** directly above it in the next - section -2. Count the number of **Cell** pairs that have a misorientation above the user defined tolerance and store that as the - misalignment value for that position -3. Repeat steps 1 and 2 for each position when shifting the second slice (relative to the first) from three (3) - **Cells** to the left to three (3) **Cells** to the right, as well as from three (3) **Cells** up to three (3) - **Cells** down. *Note that this creates a 7x7 grid* -4. Determine the position in the 7x7 grid that has the lowest misalignment value. (It will be the position with the - fewest different **Cell** pairs) -5. Repeat steps 1-4 with the center of each (new) 7x7 grid at the best position from the last 7x7 grid until the best - position in the current/new 7x7 grid is the same as the last 7x7 grid - -6) Repeat steps 1-5 for each pair of neighboring sections - -**Note that this is similar to a downhill simplex and can get caught in a local minimum!** - -If the user elects to use a mask array, the **Cells** flagged as *false* in the mask array will not be considered during -the alignment process. - -The user can choose to write the determined shift to an output file by enabling *Write Alignment Shifts File* and -providing a file path. - -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 | bool | Whether to remove a *background shift* present in the | -| Subtraction | | 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 | Cryst | uint32_t | (1) | Enumeration representing the crystal structure | -| | alStructures | | | for each \**Ensemble | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Created Objects -=============== - -None - -Example Pipelines -================= - -- - - (10) SmallIN100 Full Reconstruction - -- - - (3) SmallIN100 Alignment - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/OrientationAnalysis/docs/AlignSectionsMutualInformationFilter.md b/src/Plugins/OrientationAnalysis/docs/AlignSectionsMutualInformationFilter.md index eed24d6f41..a259d6cb53 100644 --- a/src/Plugins/OrientationAnalysis/docs/AlignSectionsMutualInformationFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/AlignSectionsMutualInformationFilter.md @@ -1,11 +1,11 @@ -# Align Sections (Mutual Information) # +# Align Sections (Mutual Information) -## Group (Subgroup) ## +## Group (Subgroup) Reconstruction (Alignment) -## Description ## +## Description This **Filter** segments each 2D slice, creating *Feature Ids* that are used when determining the *mutual information* between neighboring slices. The slices are shifted relative to one another until the position of maximum *mutual information* is determined for each section. The *Feature Ids* are temporary, they apply to this **Filter** only and are not related to the *Feature Ids* generated in other **Filters**. The algorithm of this **Filter** is listed below: @@ -29,33 +29,33 @@ 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 ## +## 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 ## +## Required Geometry Image -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | +| Ensemble Attribute Array | CrystalStructures | uint32_t | (1) | Enumeration representing the crystal structure for each Ensemble | -## Created Objects ## +## Created Objects None -## References ## +## References [Scholar Pedia](http://www.scholarpedia.org/article/Mutual_information) @@ -67,11 +67,11 @@ Journal articles on *Mutual Information* that are useful: + _The mathematical theory of communication_. University of Illinois Press, Urbana, Illinois. M zard, M. and Monatanari, A. (2009). + _Information, Physics, and Computation_. Oxford University Press, Oxford. -## Example Pipelines ## +## Example Pipelines AlignSectionsMutualInformation -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/OrientationAnalysis/docs/AlignSectionsMutualInformationFilter.rst b/src/Plugins/OrientationAnalysis/docs/AlignSectionsMutualInformationFilter.rst deleted file mode 100644 index 80a9a0f7f6..0000000000 --- a/src/Plugins/OrientationAnalysis/docs/AlignSectionsMutualInformationFilter.rst +++ /dev/null @@ -1,134 +0,0 @@ -=================================== -Align Sections (Mutual Information) -=================================== - - -Group (Subgroup) -================ - -Reconstruction (Alignment) - -Description -=========== - -This **Filter** segments each 2D slice, creating *Feature Ids* that are used when determining the *mutual information* -between neighboring slices. The slices are shifted relative to one another until the position of maximum *mutual -information* is determined for each section. The *Feature Ids* are temporary, they apply to this **Filter** only and are -not related to the *Feature Ids* generated in other **Filters**. The algorithm of this **Filter** is listed below: - -1. Segment *Features* on each ‘section’ of the sample perpendicular to the Z-direction. This is done using the same - algorithm in the `Segment Features (Misorientation) <@ref%20alignsectionsmisorientation>`__ **Filter** (only in 2D on - each section) -2. Calculate the *mutual information* between neighboring sections and store that as the misalignment value for that - position. *Mutual information* is related to the ratio of joint probability to individual probabilities of variables - (i.e., p(x,y)/p(x)p(y) ). Details of the actual *mutual information* calculation can be found in the references - below, but can be thought of as the inherent dependence between variables (here the *Feature Ids* on neighboring - sections). -3. Repeat step 2 for each position when shifting the second slice (relative to the first) from three (3) **Cells** to - the left to three (3) **Cells** to the right, as well as from three (3) **Cells** up to three (3) **Cells** down - *Note that this creates a 7x7 grid* -4. Determine the position in the 7x7 grid that has the highest *mutual information* value -5. Repeat steps 2-4 with the center of each (new) 7x7 grid at the best position from the last 7x7 grid until the best - position in the current/new 7x7 grid is the same as the last 7x7 grid - -6) Repeat steps 2-5 for each pair of neighboring sections - -**Note that this is similar to a downhill simplex and can get caught in a local minimum!** - -The user choses the level of *misorientation tolerance* by which to align **Cells**, where here the tolerance means the -*misorientation* cannot exceed a given value. If the rotation angle is below the tolerance, then the **Cell** is grouped -with other **Cells** that satisfy the criterion. - -The approach used in this **Filter** is to group neighboring **Cells** on a slice that have a *misorientation* below the -tolerance the user entered. *Misorientation* here means the minimum rotation angle of one **Cell’s** crystal axis needed -to coincide with another **Cell’s** crystal axis. When the **Features** in the slices are defined, they are moved until -*disks* in neighboring slices align with each other. - -If the user elects to use a mask array, the **Cells** flagged as *false* in the mask array will not be considered during -the alignment process. - -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 | Cryst | uint32_t | (1) | Enumeration representing the crystal structure | -| | alStructures | | | for each \**Ensemble | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Created Objects -=============== - -None - -References -========== - -`Scholar Pedia `__ - -Journal articles on *Mutual Information* that are useful: - -- *Elements of information theory*. John Wiley & Sons, New York, NY.Gray, R.M. (1990). -- *Entropy and Information Theory*. Springer-Verlag, New York, NY. Nirenberg, S. and Latham, P.E. (2003). -- *Decoding neuronal spike trains: how important are correlations?* Proc. Natl. Acad. Sci. 100:7348-7353. Shannon, C.E. - and Weaver, W. (1949). -- *The mathematical theory of communication*. University of Illinois Press, Urbana, Illinois. M zard, M. and - Monatanari, A. (2009). -- *Information, Physics, and Computation*. Oxford University Press, Oxford. - -Example Pipelines -================= - -AlignSectionsMutualInformation - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/OrientationAnalysis/docs/BadDataNeighborOrientationCheckFilter.md b/src/Plugins/OrientationAnalysis/docs/BadDataNeighborOrientationCheckFilter.md index 03a89b3ca4..db24b7937a 100644 --- a/src/Plugins/OrientationAnalysis/docs/BadDataNeighborOrientationCheckFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/BadDataNeighborOrientationCheckFilter.md @@ -1,11 +1,11 @@ -# Neighbor Orientation Comparison (Bad Data) # +# Neighbor Orientation Comparison (Bad Data) -## Group (Subgroup) ## +## Group (Subgroup) Orientation Analysis (Cleanup) -## Description ## +## Description This **Filter** compares the orientations of *bad* **Cells** with their neighbor **Cells**. If the misorientation is below a user defined tolerance for a user defined number of neighbor **Cells** , then the *bad* **Cell** will be changed to a *good* **Cell**. @@ -13,38 +13,38 @@ 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 ## +## 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 ## +## Required Geometry Image -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 ## +## Created Objects None -## Example Pipelines ## +## Example Pipelines + (10) SmallIN100 Full Reconstruction + (04) SmallIN100 Presegmentation Processing + INL Export + 04_Steiner Compact -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/OrientationAnalysis/docs/BadDataNeighborOrientationCheckFilter.rst b/src/Plugins/OrientationAnalysis/docs/BadDataNeighborOrientationCheckFilter.rst deleted file mode 100644 index e3b618f0cb..0000000000 --- a/src/Plugins/OrientationAnalysis/docs/BadDataNeighborOrientationCheckFilter.rst +++ /dev/null @@ -1,90 +0,0 @@ -========================================== -Neighbor Orientation Comparison (Bad Data) -========================================== - - -Group (Subgroup) -================ - -Orientation Analysis (Cleanup) - -Description -=========== - -This **Filter** compares the orientations of *bad* **Cells** with their neighbor **Cells**. If the misorientation is -below a user defined tolerance for a user defined number of neighbor **Cells** , then the *bad* **Cell** will be changed -to a *good* **Cell**. - -*Note:* Only the boolean value defining the **Cell** as *good* or *bad* is changed, not the data at **Cell**. - -*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 | float | Angular tolerance used to compare with neighboring \**Cells | -| (Degrees) | | | -+---------------------------+---------------------------+-------------------------------------------------------------+ -| Required Number of | int32_t | Minimum number of neighbor **Cells** that must have | -| Neighbors | | 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 | uint32_t | (1) | Enumeration representing the crystal structure | -| | Structures | | | for each phase | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Created Objects -=============== - -None - -Example Pipelines -================= - -- - - (10) SmallIN100 Full Reconstruction - -- - - (4) SmallIN100 Presegmentation Processing - -- INL Export - -- 04_Steiner Compact - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/OrientationAnalysis/docs/CAxisSegmentFeaturesFilter.md b/src/Plugins/OrientationAnalysis/docs/CAxisSegmentFeaturesFilter.md index 56dcf68bc0..9f77e17067 100644 --- a/src/Plugins/OrientationAnalysis/docs/CAxisSegmentFeaturesFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/CAxisSegmentFeaturesFilter.md @@ -5,7 +5,7 @@ Reconstruction (Segmentation) -## Description +## Description This **Filter** segments the **Features** by grouping neighboring **Cells** that satisfy the *C-axis misalignment tolerance*, i.e., have misalignment angle less than the value set by the user. The *C-axis misalignment* refers to the angle between the <001> directions (C-axis in the hexagonal system) that is present between neighboring **Cells**. The process by which the **Features** are identified is given below and is a standard *burn algorithm*. @@ -19,10 +19,10 @@ 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 +## 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 | @@ -30,30 +30,30 @@ After all the **Features** have been identified, a **Feature Attribute Matrix** Image -## Required Objects +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | +| Ensemble Attribute Array | CrystalStructures | uint32_t | (1) | Enumeration representing the crystal structure for each Ensemble | -## Created Objects +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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* | -## Example Pipelines +## Example Pipelines Combo-EBSD-osc_r0c0 -## License & Copyright +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/OrientationAnalysis/docs/CAxisSegmentFeaturesFilter.rst b/src/Plugins/OrientationAnalysis/docs/CAxisSegmentFeaturesFilter.rst deleted file mode 100644 index 0cb0da41bb..0000000000 --- a/src/Plugins/OrientationAnalysis/docs/CAxisSegmentFeaturesFilter.rst +++ /dev/null @@ -1,109 +0,0 @@ -====================================== -Segment Features (C-Axis Misalignment) -====================================== - - -Group (Subgroup) -================ - -Reconstruction (Segmentation) - -Description -=========== - -This **Filter** segments the **Features** by grouping neighboring **Cells** that satisfy the *C-axis misalignment -tolerance*, i.e., have misalignment angle less than the value set by the user. The *C-axis misalignment* refers to the -angle between the <001> directions (C-axis in the hexagonal system) that is present between neighboring **Cells**. The -process by which the **Features** are identified is given below and is a standard *burn algorithm*. - -1. Randomly select a **Cell**, add it to an empty list and set its *Feature Id* to the current **Feature** -2. Compare the **Cell** to each of its six (6) face-sharing neighbors (i.e., calculate the c-axis misalignment with each - neighbor) -3. Add each neighbor **Cell** that has a C-axis misalignment below the user defined tolerance to the list created in 1. - and set the *Feature Id* of the neighbor **Cell** to the current **Feature** -4. Remove the current **Cell** from the list and move to the next **Cell** and repeat 2. and 3.; continue until no - **Cells** are left in the list -5. Increment the current **Feature** counter and repeat steps 1. through 4.; continue until no **Cells** remain - unassigned in the dataset - -The user has the option to *Use Mask Array*, which allows the user to set a boolean array for the **Cells** that remove -**Cells** with a value of *false* from consideration in the above algorithm. This option is useful if the user has an -array that either specifies the domain of the “sample” in the “image” or specifies if the orientation on the **Cell** is -trusted/correct. - -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 | float | Tolerance (in degrees) used to determine if | -| Tolerance (Degrees) | | 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 | Cryst | uint32_t | (1) | Enumeration representing the crystal structure | -| | alStructures | | | 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 | Cel | Cell | N/A | Created **Feature Attribute Matrix** name | -| | lFeatureData | Feature | | | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| 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* | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Example Pipelines -================= - -Combo-EBSD-osc_r0c0 - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/OrientationAnalysis/docs/ConvertOrientations.md b/src/Plugins/OrientationAnalysis/docs/ConvertOrientations.md index 7e90231e14..3e5729bdfb 100644 --- a/src/Plugins/OrientationAnalysis/docs/ConvertOrientations.md +++ b/src/Plugins/OrientationAnalysis/docs/ConvertOrientations.md @@ -1,15 +1,15 @@ -# Convert Orientation Representations # +# Convert Orientation Representations -## Group (Subgroup) ## +## Group (Subgroup) Orientation Analysis (Conversion) -## Description ## +## Description This **Filter** generates a new orientation representation (see Data Layout Table below) for each **Element**, given the *Input Orientation Representation* for the **Element**. The following table lists the various orientation representations that are supported. DREAM3D is capable of converting between any representation with some caveats. -#### Data Layout #### +#### Data Layout | Orientation Representation | No. of Components | Representation Type | Data Layout | |----------------------------|----------|---------------------|-------------| @@ -24,7 +24,7 @@ This **Filter** generates a new orientation representation (see Data Layout Tabl -#### Data Range #### +#### Data Range The valid range for Euler angles is (Degrees): @@ -32,15 +32,15 @@ The valid range for Euler angles is (Degrees): + Phi : 0 to 180 + phi-2: 0 to 360 -#### Data Conversion Notes #### +#### Data Conversion Notes If the angles fall outside of this range the **original** Euler Input data **WILL BE CHANGED** to ensure they are within this range. -## Precision Notes ## +## Precision Notes 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 ## +## Parameters | Name | Type | Description | |------------------|------|-------------| @@ -48,25 +48,25 @@ While every effort has been made to ensure the correctness of each transformatio | 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 ## +## Required Geometry Not Applicable -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| Kind | Default Name | Type | Comp Dims | Description | +|---------------------------|--------------|----------|--------|---------------------------------------------| | Any **Data Array | Input Orientations | float | See above table | Incoming orientation representation | -## Created Objects ## +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| Kind | Default Name | Type | Comp Dims | Description | +|---------------------------|--------------|----------|--------|---------------------------------------------| | Any **Data Array | *Output Orientations* | float | See above table | Converted orientation representation | -## Example Pipelines ## +## Example Pipelines + 02_Adaptive Alignment - Misorientation - Zero Shifts + (10) SmallIN100 Full Reconstruction @@ -77,7 +77,7 @@ Not Applicable + 04_Steiner Compact + (03) SmallIN100 Alignment -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/OrientationAnalysis/docs/ConvertOrientations.rst b/src/Plugins/OrientationAnalysis/docs/ConvertOrientations.rst deleted file mode 100644 index f8c6cb2e5d..0000000000 --- a/src/Plugins/OrientationAnalysis/docs/ConvertOrientations.rst +++ /dev/null @@ -1,128 +0,0 @@ -=================================== -Convert Orientation Representations -=================================== - - -Group (Subgroup) -================ - -Orientation Analysis (Conversion) - -Description -=========== - -This **Filter** generates a new orientation representation (see Data Layout Table below) for each **Element**, given the -*Input Orientation Representation* for the **Element**. The following table lists the various orientation -representations that are supported. DREAM3D is capable of converting between any representation with some caveats. - -Data Layout ------------ - -========================== ================= =================== =========================================== -Orientation Representation No. of Components Representation Type Data Layout -========================== ================= =================== =========================================== -EulerAngles 3 0 phi1, Phi, phi2 -Orientation Matrix 9 1 Row Major Format -Quaternions 4 2 ( [x, y, z], w ) -Axis Angle 4 3 ( [x, y, z], Angle) -Rodrigues Vectors 4 4 *Internally DREAM.3D keeps a 4th component* -Homochoric 3 5 [x, y, z] -Cubochoric 3 6 [x, y, z] -StereoGraphic 3 7 [x, y, z] -========================== ================= =================== =========================================== - -Data Range ----------- - -The valid range for Euler angles is (Degrees): - -:: - - + phi-1: 0 to 360 - + Phi : 0 to 180 - + phi-2: 0 to 360 - -Data Conversion Notes ---------------------- - -If the angles fall outside of this range the **original** Euler Input data **WILL BE CHANGED** to ensure they are within -this range. - -Precision Notes -=============== - -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 -================= ===================== ===== =============== ==================================== - -Example Pipelines -================= - -- 02_Adaptive Alignment - Misorientation - Zero Shifts - -- - - (10) SmallIN100 Full Reconstruction - -- INL Export - -- 03_Adaptive Alignment - Mutual Information - SEM Images - -- MassifPipeline - -- InsertTransformationPhase - -- 04_Steiner Compact - -- - - (3) SmallIN100 Alignment - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/OrientationAnalysis/docs/ConvertQuaternionFilter.md b/src/Plugins/OrientationAnalysis/docs/ConvertQuaternionFilter.md index be0b0544c0..87ba072619 100644 --- a/src/Plugins/OrientationAnalysis/docs/ConvertQuaternionFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/ConvertQuaternionFilter.md @@ -1,43 +1,43 @@ # Convert Quaternion Order -## Group (Subgroup) ## +## Group (Subgroup) OrientationAnalysis (Conversions) -## Description ## +## Description Internally DREAM.3D assumes that a quaternion is laid out in the order such that < x, y, z >, w or Vector-Scalar ordering. Codes and algorithms external to DREAM.3D may store quaternions in the opposite or Scalar-Vector order (w < x,y,z >). This filter will allow the user to easily convert imported Quaternions into the representation that DREAM.3D expects. 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 ## +## 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 ## +## Required Geometry Not Applicable -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| Kind | Default Name | Type | Comp Dims | Description | +|---------------------------|--------------|----------|--------|---------------------------------------------| | Attribute Array | Quaternion Input | float | (4) | | -## Created Objects ## +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| Kind | Default Name | Type | Comp Dims | Description | +|---------------------------|--------------|----------|--------|---------------------------------------------| | Attribute Array | Quaternion Ouput | float | (4) | | -## Example Pipelines ## +## Example Pipelines -## License & Copyright ## +## License & Copyright Please see the description file distributed with this plugin. diff --git a/src/Plugins/OrientationAnalysis/docs/ConvertQuaternionFilter.rst b/src/Plugins/OrientationAnalysis/docs/ConvertQuaternionFilter.rst deleted file mode 100644 index f42b1c91de..0000000000 --- a/src/Plugins/OrientationAnalysis/docs/ConvertQuaternionFilter.rst +++ /dev/null @@ -1,72 +0,0 @@ -======================== -Convert Quaternion Order -======================== - - -Group (Subgroup) -================ - -OrientationAnalysis (Conversions) - -Description -=========== - -Internally DREAM.3D assumes that a quaternion is laid out in the order such that < x, y, z >, w or Vector-Scalar -ordering. Codes and algorithms external to DREAM.3D may store quaternions in the opposite or Scalar-Vector order (w < -x,y,z >). This filter will allow the user to easily convert imported Quaternions into the representation that DREAM.3D -expects. - -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) -=============== ================ ===== ========== =========== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/OrientationAnalysis/docs/CreateEnsembleInfoFilter.md b/src/Plugins/OrientationAnalysis/docs/CreateEnsembleInfoFilter.md index 1e53d59214..0fce5f46e6 100644 --- a/src/Plugins/OrientationAnalysis/docs/CreateEnsembleInfoFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/CreateEnsembleInfoFilter.md @@ -1,11 +1,11 @@ # Create Ensemble Info -## Group (Subgroup) ## +## Group (Subgroup) Processing (Generation) -## Description ## +## Description This **Filter** allows the user to enter basic crystallographic information about each phase. The Laue class, Phase Type, and Phase Name can all be entered by the user. The information is stored in an EnsembleAttributeMatrix. These values are needed to allow the calculation of certain kinds of crystallographic statistics on the volume, if they have not already been provided by some other means. Each row in the table lists the __Crystal Structure__, __Phase Type__, and __Phase Name__. The proper values for the crystal structure and phase type come from internal constants within DREAM.3D and are listed here: @@ -38,35 +38,35 @@ This **Filter** allows the user to enter basic crystallographic information abou | UnknownPhaseType | 999 | -## Parameters ## +## Parameters | Name | Type | Description | -|------|------|-------------| +|------------|------| --------------------------------- | | Ensemble | Create Ensemble Info | The created Ensemble crystal structures, phase types, and phase names | -## Required Geometry ## +## Required Geometry Not Applicable -## Required Objects ## +## Required Objects None -## Created Objects ## +## 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 | +| 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 | -## Example Pipelines ## +## Example Pipelines Import_ASCII -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/OrientationAnalysis/docs/CreateEnsembleInfoFilter.rst b/src/Plugins/OrientationAnalysis/docs/CreateEnsembleInfoFilter.rst deleted file mode 100644 index 366007ef08..0000000000 --- a/src/Plugins/OrientationAnalysis/docs/CreateEnsembleInfoFilter.rst +++ /dev/null @@ -1,106 +0,0 @@ -==================== -Create Ensemble Info -==================== - - -Group (Subgroup) -================ - -Processing (Generation) - -Description -=========== - -This **Filter** allows the user to enter basic crystallographic information about each phase. The Laue class, Phase -Type, and Phase Name can all be entered by the user. The information is stored in an EnsembleAttributeMatrix. These -values are needed to allow the calculation of certain kinds of crystallographic statistics on the volume, if they have -not already been provided by some other means. Each row in the table lists the **Crystal Structure**, **Phase Type**, -and **Phase Name**. The proper values for the crystal structure and phase type come from internal constants within -DREAM.3D and are listed here: - -Crystal Structure ------------------ - -======================= ============== ================================ -String Name Internal Value Laue Name -======================= ============== ================================ -Hexagonal_High 0 Hexagonal-High 6/mmm -Cubic_High 1 Cubic Cubic-High m3m -Hexagonal_Low 2 Hexagonal-Low 6/m -Cubic_Low 3 Cubic Cubic-Low m3 (Tetrahedral) -Triclinic 4 Triclinic -1 -Monoclinic 5 Monoclinic 2/m -OrthoRhombic 6 Orthorhombic mmm -Tetragonal_Low 7 Tetragonal-Low 4/m -Tetragonal_High 8 Tetragonal-High 4/mmm -Trigonal_Low 9 Trigonal-Low -3 -Trigonal_High 10 Trigonal-High -3m -UnknownCrystalStructure 999 Undefined Crystal Structure -======================= ============== ================================ - -Phase Type ----------- - -=================== ============== -String Name Internal Value -=================== ============== -PrimaryPhase 0 -PrecipitatePhase 1 -TransformationPhase 2 -MatrixPhase 3 -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 | EnsembleAtt | Ensemble | N/A | Created **Ensemble Attribute Matrix** name | -| | ributeMatrix | | | | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Ensemble Attribute Array | Cryst | uint32_t | (1) | Enumeration representing the crystal structure | -| | alStructures | | | 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 | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Example Pipelines -================= - -Import_ASCII - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/OrientationAnalysis/docs/EBSDSegmentFeaturesFilter.md b/src/Plugins/OrientationAnalysis/docs/EBSDSegmentFeaturesFilter.md index d7999e5d80..3ca75c6618 100644 --- a/src/Plugins/OrientationAnalysis/docs/EBSDSegmentFeaturesFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/EBSDSegmentFeaturesFilter.md @@ -1,11 +1,11 @@ # Segment Features (Misorientation) -## Group (Subgroup) ## +## Group (Subgroup) Reconstruction (Segmentation) -## Description ## +## Description This **Filter** segments the **Features** by grouping neighboring **Cells** that satisfy the *misorientation tolerance*, i.e., have misorientation angle less than the value set by the user. The process by which the **Features** are identified is given below and is a standard *burn algorithm*. @@ -19,44 +19,44 @@ 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 ## +## 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 ## +## Required Geometry Image -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | +| Ensemble Attribute Array | CrystalStructures | uint32_t | (1) | Enumeration representing the crystal structure for each Ensemble | -## Created Objects ## +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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* | -## Example Pipelines ## +## Example Pipelines + (10) SmallIN100 Full Reconstruction + INL Export + (05) SmallIN100 Segmentation + 04_Steiner Compact -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/OrientationAnalysis/docs/EBSDSegmentFeaturesFilter.rst b/src/Plugins/OrientationAnalysis/docs/EBSDSegmentFeaturesFilter.rst deleted file mode 100644 index 6d4cce3f13..0000000000 --- a/src/Plugins/OrientationAnalysis/docs/EBSDSegmentFeaturesFilter.rst +++ /dev/null @@ -1,118 +0,0 @@ -================================= -Segment Features (Misorientation) -================================= - - -Group (Subgroup) -================ - -Reconstruction (Segmentation) - -Description -=========== - -This **Filter** segments the **Features** by grouping neighboring **Cells** that satisfy the *misorientation tolerance*, -i.e., have misorientation angle less than the value set by the user. The process by which the **Features** are -identified is given below and is a standard *burn algorithm*. - -1. Randomly select a **Cell**, add it to an empty list and set its *Feature Id* to the current **Feature** -2. Compare the **Cell** to each of its six (6) face-sharing neighbors (i.e., calculate the misorientation with each - neighbor) -3. Add each neighbor **Cell** that has a misorientation below the user defined tolerance to the list created in 1. and - set the *Feature Id* of the neighbor **Cell** to the current **Feature** -4. Remove the current **Cell** from the list and move to the next **Cell** and repeat 2. and 3.; continue until no - **Cells** are left in the list -5. Increment the current **Feature** counter and repeat steps 1. through 4.; continue until no **Cells** remain - unassigned in the dataset - -The user has the option to *Use Mask Array*, which allows the user to set a boolean array for the **Cells** that remove -**Cells** with a value of *false* from consideration in the above algorithm. This option is useful if the user has an -array that either specifies the domain of the “sample” in the “image” or specifies if the orientation on the **Cell** is -trusted/correct. - -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 | float | Tolerance (in degrees) used to determine if | -| (Degrees) | | 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 | Cryst | uint32_t | (1) | Enumeration representing the crystal structure | -| | alStructures | | | 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 | Cel | Cell | N/A | Created **Feature Attribute Matrix** name | -| | lFeatureData | Feature | | | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| 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* | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Example Pipelines -================= - -- - - (10) SmallIN100 Full Reconstruction - -- INL Export - -- - - (5) SmallIN100 Segmentation - -- 04_Steiner Compact - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/OrientationAnalysis/docs/EbsdToH5EbsdFilter.md b/src/Plugins/OrientationAnalysis/docs/EbsdToH5EbsdFilter.md index f11f0bfb9e..2119e7a18e 100644 --- a/src/Plugins/OrientationAnalysis/docs/EbsdToH5EbsdFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/EbsdToH5EbsdFilter.md @@ -1,47 +1,39 @@ # Import Orientation File(s) to H5EBSD -## Group (Subgroup) ## +## Group (Subgroup) IO (Input) -## Description ## +## Description This **Filter** will convert orientation data obtained from Electron Backscatter Diffraction (EBSD) experiments into a single file archive based on the [HDF5](http://www.hdfgroup.org) file specification. See the **Supported File Formats** section below for information on file compatibility. This **Filter** is typically run as a single **Filter** **Pipeline** to perform the conversion. All subsequent **Pipelines** should then use the Read H5EBSD File **Filter** to import the H5EBSD file into DREAM.3D for analysis, as opposed to re-importing the raw EBSD files. The primary purpose of this **Filter** is to import a stack of data that forms a 3D volume. If the user wishes to import a single data file, then the **Filters** Read EDAX EBSD Data (.ang), Read EDAX EBSD Data (.h5), or Read Oxford Instr. EBSD Data (.ctf) should be used for EDAX .ang, EDAX .h5, or Oxford .ctf files, respectively. -### Converting Orientation Data to H5EBSD Archive ### +### Converting Orientation Data to H5EBSD Archive In order to work with orientation data, DREAM.3D needs to read the data from an archive file based on the [HDF5](http://www.hdfgroup.org) specification. In order to convert the data, the user will first build a single **Filter** **Pipeline** by selecting the Import Orientation File(s) to H5EBSD **Filter**. This **Filter** will convert a directory of sequentially numbered files into a single [HDF5](http://www.hdfgroup.org) file that retains all the meta data from the header(s) of the files. The user selects the directory that contains all the files to be imported then uses the additional input widgets on the **Filter** interface (_File Prefix_, _File Suffix_, _File Extension_, and _Padding Digits_) to make adjustments to the generated file name until the correct number of files is found. The user may also select starting and ending indices to import. The user interface indicates through red and green icons if an expected file exists on the file system and will also display a warning message at the bottom of the **Filter** interface if any of the generated file names do not appear on the file system. -### Stacking Order ### +### Stacking Order Due to different experimental setups, the definition of the *bottom* slice or the **Z=0** slice can be different. The user should verify that the proper button box is checked for their data set. + **Low to High** This means that the file with the lowest index, closest to zero (0), will be considered the Z=0 slice. + **High to Low** This means that the file with the highest index, farthest from zero (0), will be considered the Z=0 slice. -### Z Resolution ### +### Z Resolution Many serial sectioning systems are inherently a series of 2D scans stacked together to form a 3D volume of material. Therefore, the experimental systems have no knowledge of the amount of material that was removed between each slice and so the user is responsible for setting this value correctly for their data set. ------ - ![Import Orientation Files User Interface](Images/EbsdToH5Ebsd_Image_1.png) ------ - -## Orientations, Reference Frames and Coordinate Systems ## +## Orientations, Reference Frames and Coordinate Systems DREAM.3D's origin follows the specimen's coordinate system so that the physical location of the 0 row and 0 column voxel should visually appear in the lower left corner of a computer graphics display as shown in the figure below, where the specimen coordinate system (white) overlaid with EBSD coordinate system (yellow). ------ - ![TSL Coordinate System (Spatial)](Images/EbsdToH5Ebsd_CoordinateSystem.png) ------ - Commercial EBSD acquisition systems do not typically follow this convention, and DREAM.3D needs input from the user so that the proper transformations to the data can be applied during subsequent analysis. Commercial EBSD software packages allow for some initial transformations of the data, in which case the DREAM.3D environment does not have any way of determining if those transformations have already occurred. During the import process the user is asked a few questions regarding the orientation of the EBSD data in relation to the specimen coordinate system. -### Setting the Spatial Reference Frame ### +### Setting the Spatial Reference Frame The user needs to click the *Set Reference Frame* button to set the proper reference frame for the data set which will be written to the H5EBSD file as meta data. Below are a number of examples showing the differences in the data sets due to the selection of different reference frames. @@ -50,12 +42,8 @@ The user needs to click the *Set Reference Frame* button to set the proper refer | ![No Transform or Unknown Manufacturer or HEDM Data](Images/EbsdToH5Ebsd_NoUnknown_HEDM_RefFrame.png) | ![TSL or HKL Transform](Images/EbsdToH5Ebsd_EDAX_HKL_RefFrame.png) | -### Preset Transformations ### - ------ +### Preset Transformations ![Selecting the Reference Frame](Images/EbsdToH5Ebsd_ReferenceFrameDialog.png) ------ - | Manufacturer | Sample Reference Transformation | Euler Transformation | | ------| ------| ------| | Edax - TSL | 180 @ <010> | 90 @ <001> | @@ -63,7 +51,7 @@ The user needs to click the *Set Reference Frame* button to set the proper refer | No Transform | 0 @ <001> | 0 @ <001> | HEDM - IceNine| 0 @ <001> | 0 @ <001> -### Supported File Formats ### +### Supported File Formats | Manufacturer | File Extension | Comments | |---------------|----------------|----------| @@ -71,32 +59,32 @@ The user needs to click the *Set Reference Frame* button to set the proper refer | Oxford Instruments | .ctf | Euler Angles can be stored in Degrees or Radians. | | HEDM from APS | .mic | A .config file with the same name is needed for each .mic file | -### Completing the Conversion ### +### Completing the Conversion 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 ## +## Parameters See Description -## Required Geometry ## +## Required Geometry Not Applicable -## Required Objects ## +## Required Objects None -## Created Objects ## +## Created Objects None -## Example Pipelines ## +## Example Pipelines + (01) SmallIN100 Archive + 01_Import Data -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/OrientationAnalysis/docs/EbsdToH5EbsdFilter.rst b/src/Plugins/OrientationAnalysis/docs/EbsdToH5EbsdFilter.rst deleted file mode 100644 index 380f9546af..0000000000 --- a/src/Plugins/OrientationAnalysis/docs/EbsdToH5EbsdFilter.rst +++ /dev/null @@ -1,174 +0,0 @@ -==================================== -Import Orientation File(s) to H5EBSD -==================================== - - -Group (Subgroup) -================ - -IO (Input) - -Description -=========== - -This **Filter** will convert orientation data obtained from Electron Backscatter Diffraction (EBSD) experiments into a -single file archive based on the `HDF5 `__ file specification. See the **Supported File -Formats** section below for information on file compatibility. This **Filter** is typically run as a single **Filter** -**Pipeline** to perform the conversion. All subsequent **Pipelines** should then use the Read H5EBSD File **Filter** to -import the H5EBSD file into DREAM.3D for analysis, as opposed to re-importing the raw EBSD files. The primary purpose of -this **Filter** is to import a stack of data that forms a 3D volume. If the user wishes to import a single data file, -then the **Filters** Read EDAX EBSD Data (.ang), Read EDAX EBSD Data (.h5), or Read Oxford Instr. EBSD Data (.ctf) -should be used for EDAX .ang, EDAX .h5, or Oxford .ctf files, respectively. - -Converting Orientation Data to H5EBSD Archive ---------------------------------------------- - -In order to work with orientation data, DREAM.3D needs to read the data from an archive file based on the -`HDF5 `__ specification. In order to convert the data, the user will first build a single -**Filter** **Pipeline** by selecting the Import Orientation File(s) to H5EBSD **Filter**. This **Filter** will convert a -directory of sequentially numbered files into a single `HDF5 `__ file that retains all the meta -data from the header(s) of the files. The user selects the directory that contains all the files to be imported then -uses the additional input widgets on the **Filter** interface (*File Prefix*, *File Suffix*, *File Extension*, and -*Padding Digits*) to make adjustments to the generated file name until the correct number of files is found. The user -may also select starting and ending indices to import. The user interface indicates through red and green icons if an -expected file exists on the file system and will also display a warning message at the bottom of the **Filter** -interface if any of the generated file names do not appear on the file system. - -Stacking Order --------------- - -Due to different experimental setups, the definition of the *bottom* slice or the **Z=0** slice can be different. The -user should verify that the proper button box is checked for their data set. - -- **Low to High** This means that the file with the lowest index, closest to zero (0), will be considered the Z=0 - slice. -- **High to Low** This means that the file with the highest index, farthest from zero (0), will be considered the Z=0 - slice. - -Z Resolution ------------- - -Many serial sectioning systems are inherently a series of 2D scans stacked together to form a 3D volume of material. -Therefore, the experimental systems have no knowledge of the amount of material that was removed between each slice and -so the user is responsible for setting this value correctly for their data set. - --------------- - -.. figure:: Images/EbsdToH5Ebsd_Image_1.png - :alt: Import Orientation Files User Interface - - Import Orientation Files User Interface - --------------- - -Orientations, Reference Frames and Coordinate Systems -===================================================== - -DREAM.3D’s origin follows the specimen’s coordinate system so that the physical location of the 0 row and 0 column voxel -should visually appear in the lower left corner of a computer graphics display as shown in the figure below, where the -specimen coordinate system (white) overlaid with EBSD coordinate system (yellow). - --------------- - -.. figure:: Images/EbsdToH5Ebsd_CoordinateSystem.png - :alt: TSL Coordinate System (Spatial) - - TSL Coordinate System (Spatial) - --------------- - -Commercial EBSD acquisition systems do not typically follow this convention, and DREAM.3D needs input from the user so -that the proper transformations to the data can be applied during subsequent analysis. Commercial EBSD software packages -allow for some initial transformations of the data, in which case the DREAM.3D environment does not have any way of -determining if those transformations have already occurred. During the import process the user is asked a few questions -regarding the orientation of the EBSD data in relation to the specimen coordinate system. - -Setting the Spatial Reference Frame ------------------------------------ - -The user needs to click the *Set Reference Frame* button to set the proper reference frame for the data set which will -be written to the H5EBSD file as meta data. Below are a number of examples showing the differences in the data sets due -to the selection of different reference frames. - -+-----------------------------------------------------------+-----------------------------------------------------------+ -| No Sample Transform | Edax/HKL Sample Transform | -+===========================================================+===========================================================+ -| |No Transform or Unknown Manufacturer or HEDM Data| | |TSL or HKL Transform| | -+-----------------------------------------------------------+-----------------------------------------------------------+ - -Preset Transformations ----------------------- - -+---------------------------------+ -| |Selecting the Reference Frame| | -+---------------------------------+ - -============== =============================== ==================== -Manufacturer Sample Reference Transformation Euler Transformation -============== =============================== ==================== -Edax - TSL 180 @ <010> 90 @ <001> -Oxford - HKL 180 @ <010> 0 @ <001> -No Transform 0 @ <001> 0 @ <001> -HEDM - IceNine 0 @ <001> 0 @ <001> -============== =============================== ==================== - -Supported File Formats ----------------------- - -================== ============== ============================================================== -Manufacturer File Extension Comments -================== ============== ============================================================== -EDAX .ang – -Oxford Instruments .ctf Euler Angles can be stored in Degrees or Radians. -HEDM from APS .mic A .config file with the same name is needed for each .mic file -================== ============== ============================================================== - -Completing the Conversion -------------------------- - -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 - -Example Pipelines -================= - -- - - (1) SmallIN100 Archive - -- 01_Import Data - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. - -.. |No Transform or Unknown Manufacturer or HEDM Data| image:: Images/EbsdToH5Ebsd_NoUnknown_HEDM_RefFrame.png -.. |TSL or HKL Transform| image:: Images/EbsdToH5Ebsd_EDAX_HKL_RefFrame.png -.. |Selecting the Reference Frame| image:: Images/EbsdToH5Ebsd_ReferenceFrameDialog.png diff --git a/src/Plugins/OrientationAnalysis/docs/EnsembleInfoReaderFilter.md b/src/Plugins/OrientationAnalysis/docs/EnsembleInfoReaderFilter.md index 720e4332e7..f07f52e044 100644 --- a/src/Plugins/OrientationAnalysis/docs/EnsembleInfoReaderFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/EnsembleInfoReaderFilter.md @@ -5,7 +5,7 @@ IO (Input) -## Description +## Description This **Filter** reads in information about the crystal structure and phase types of all the **Features** that are contained in a **Cell** based volume. These values are needed to allow the calculation of statistics on the volume, if they have not already been provided by some other means. The format of the input file is a simple ASCII text file with the extension .ini or .txt. The first group in the file is the name [EnsembleInfo] in square brackets with the key Number_Phases=*number of phases* that are contained in the volume. Subsequent groups in the file list the __Phase Number__, __Crystal Structure__ and __Phase Type__. The proper values for the crystal structure and phase type come from internal constants within DREAM.3D and are listed here: @@ -54,32 +54,32 @@ For example, if you have a structure that has 2 phases that consist of a Cubic P PhaseType=MatrixPhase -## Parameters +## Parameters | Name | Type | Description | -|------|------|-------------| +|------------|------| --------------------------------- | | Input Ensemble Info File | File Path | The input file path | ## Required Geometry Not Applicable -## Required Objects +## Required Objects None -## Created Objects +## 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 | +| 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 | -## Example Pipelines +## Example Pipelines -## License & Copyright +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/OrientationAnalysis/docs/EnsembleInfoReaderFilter.rst b/src/Plugins/OrientationAnalysis/docs/EnsembleInfoReaderFilter.rst deleted file mode 100644 index edf45242ff..0000000000 --- a/src/Plugins/OrientationAnalysis/docs/EnsembleInfoReaderFilter.rst +++ /dev/null @@ -1,121 +0,0 @@ -========================= -Import Ensemble Info File -========================= - - -Group (Subgroup) -================ - -IO (Input) - -Description -=========== - -This **Filter** reads in information about the crystal structure and phase types of all the **Features** that are -contained in a **Cell** based volume. These values are needed to allow the calculation of statistics on the volume, if -they have not already been provided by some other means. The format of the input file is a simple ASCII text file with -the extension .ini or .txt. The first group in the file is the name [EnsembleInfo] in square brackets with the key -Number_Phases=\ *number of phases* that are contained in the volume. Subsequent groups in the file list the **Phase -Number**, **Crystal Structure** and **Phase Type**. The proper values for the crystal structure and phase type come from -internal constants within DREAM.3D and are listed here: - -**Crystal Structure** - -======================= ============== ================================ -String Name Internal Value Laue Name -======================= ============== ================================ -Hexagonal_High 0 Hexagonal-High 6/mmm -Cubic_High 1 Cubic Cubic-High m3m -Hexagonal_Low 2 Hexagonal-Low 6/m -Cubic_Low 3 Cubic Cubic-Low m3 (Tetrahedral) -Triclinic 4 Triclinic -1 -Monoclinic 5 Monoclinic 2/m -OrthoRhombic 6 Orthorhombic mmm -Tetragonal_Low 7 Tetragonal-Low 4/m -Tetragonal_High 8 Tetragonal-High 4/mmm -Trigonal_Low 9 Trigonal-Low -3 -Trigonal_High 10 Trigonal-High -3m -UnknownCrystalStructure 999 Undefined Crystal Structure -======================= ============== ================================ - -**Phase Type** - -=================== ============== -String Name Internal Value -=================== ============== -PrimaryPhase 0 -PrecipitatePhase 1 -TransformationPhase 2 -MatrixPhase 3 -BoundaryPhase 4 -UnknownPhaseType 999 -=================== ============== - -Example Input -============= - -**Phase numbering starts at One (1). Phase Zero (0) is reserved for internal use in DREAM.3D** For example, if you have -a structure that has 2 phases that consist of a Cubic Primary phase and a Hexagonal Matrix phase the file would be the -following: - -:: - - [EnsembleInfo] - Number_Phases=2 - - [1] - CrystalStructure=Cubic_High - PhaseType=PrimaryPhase - - [2] - 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 | EnsembleAtt | Ensemble | N/A | Created **Ensemble Attribute Matrix** name | -| | ributeMatrix | | | | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Ensemble Attribute Array | Cryst | uint32_t | (1) | Enumeration representing the crystal structure | -| | alStructures | | | for each \**Ensemble | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Ensemble Attribute Array | PhaseTypes | uint32_t | (1) | Enumeration representing the phase type for | -| | | | | each \**Ensemble | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/OrientationAnalysis/docs/ExportGBCDGMTFileFilter.md b/src/Plugins/OrientationAnalysis/docs/ExportGBCDGMTFileFilter.md index 6295a7ace1..b70e7d4924 100644 --- a/src/Plugins/OrientationAnalysis/docs/ExportGBCDGMTFileFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/ExportGBCDGMTFileFilter.md @@ -1,48 +1,44 @@ # Write GBCD Pole Figure (GMT 5) -## Group (Subgroup) ## +## Group (Subgroup) IO (Output) -## Description ## +## Description This **Filter** creates a .dat file that can be used in conjunction with [GMT](http://gmt.soest.hawaii.edu/) to generate a grain boundary character distribution (GBCD) pole figure. The user must select the relevant phase for which to write the pole figure by entering the *phase index*. ------ - ![GMT Visualization of the Small IN100 GBCD Results](Images/ExportGBCDGMTFile.png) ------ - -## Parameters ## +## 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 ## +## Required Geometry Triangle -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 ## +## Created Objects None -## Example Pipelines ## +## Example Pipelines + (04) SmallIN100 GBCD -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/OrientationAnalysis/docs/ExportGBCDGMTFileFilter.rst b/src/Plugins/OrientationAnalysis/docs/ExportGBCDGMTFileFilter.rst deleted file mode 100644 index 39b4edd6cd..0000000000 --- a/src/Plugins/OrientationAnalysis/docs/ExportGBCDGMTFileFilter.rst +++ /dev/null @@ -1,80 +0,0 @@ -============================== -Write GBCD Pole Figure (GMT 5) -============================== - - -Group (Subgroup) -================ - -IO (Output) - -Description -=========== - -This **Filter** creates a .dat file that can be used in conjunction with `GMT `__ to -generate a grain boundary character distribution (GBCD) pole figure. The user must select the relevant phase for which -to write the pole figure by entering the *phase index*. - --------------- - -.. figure:: Images/ExportGBCDGMTFile.png - :alt: GMT Visualization of the Small IN100 GBCD Results - - GMT Visualization of the Small IN100 GBCD Results - --------------- - -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, | 5 parameter GBCD data. The 6th component is | -| | | | m,l,o,q,r) | used internally to track the northern | -| | | | | vs. southern hemisphere of the Lambert sphere | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Created Objects -=============== - -None - -Example Pipelines -================= - -- - - (4) SmallIN100 GBCD - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/OrientationAnalysis/docs/ExportGBCDTriangleDataFilter.md b/src/Plugins/OrientationAnalysis/docs/ExportGBCDTriangleDataFilter.md index f1d77c62d8..6b4f906f81 100644 --- a/src/Plugins/OrientationAnalysis/docs/ExportGBCDTriangleDataFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/ExportGBCDTriangleDataFilter.md @@ -1,11 +1,11 @@ # Write GBCD Triangles File -## Group (Subgroup) ## +## Group (Subgroup) IO (Output) -## Description ## +## Description This **Filter** writes relevant information about the Grain Boundary Character Distribution (GBCD) on an existing set of triangles. The information written includes the inward and outward Euler angles, normals, and areas for each triangle. The file format was originally defined by Prof. Greg Rohrer (CMU). @@ -28,34 +28,34 @@ 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 ## +## Parameters | Name | Type | Description | -|------|------|-------------| +|------------|------| --------------------------------- | | Output File | File Path | The output GBCD triangle file path | -## Required Geometry ## +## Required Geometry Image + Triangle -## Required Objects ## +## 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 | +| 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 ## +## Created Objects None -## Example Pipelines ## +## Example Pipelines -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/OrientationAnalysis/docs/ExportGBCDTriangleDataFilter.rst b/src/Plugins/OrientationAnalysis/docs/ExportGBCDTriangleDataFilter.rst deleted file mode 100644 index 27dcb5864f..0000000000 --- a/src/Plugins/OrientationAnalysis/docs/ExportGBCDTriangleDataFilter.rst +++ /dev/null @@ -1,88 +0,0 @@ -========================= -Write GBCD Triangles File -========================= - - -Group (Subgroup) -================ - -IO (Output) - -Description -=========== - -This **Filter** writes relevant information about the Grain Boundary Character Distribution (GBCD) on an existing set of -triangles. The information written includes the inward and outward Euler angles, normals, and areas for each triangle. -The file format was originally defined by Prof. Greg Rohrer (CMU). - -Example Output -============== - -:: - - # Triangles Produced from DREAM3D version 5.2 - # Column 1-3: right hand average orientation (phi1, PHI, phi2 in RADIANS) - # Column 4-6: left hand average orientation (phi1, PHI, phi2 in RADIANS) - # Column 7-9: triangle normal - # Column 8: surface area - 0.2662 0.6970 4.4347 0.7993 0.6738 3.5200 0.0000 0.8829 -0.4696 0.0240 - 0.2662 0.6970 4.4347 0.7993 0.6738 3.5200 0.4532 0.3203 -0.8319 0.0211 - 0.2662 0.6970 4.4347 0.7993 0.6738 3.5200 1.0000 0.0000 0.0000 0.0312 - 0.2662 0.6970 4.4347 0.7993 0.6738 3.5200 0.9939 0.0780 0.0780 0.0315 - 0.2662 0.6970 4.4347 0.7993 0.6738 3.5200 0.0000 0.9985 0.0551 0.0332 - 0.2662 0.6970 4.4347 0.7993 0.6738 3.5200 0.5074 0.7638 -0.3989 0.0260 - 0.7993 0.6738 3.5200 0.2662 0.6970 4.4347 0.0000 -0.7792 0.6268 0.0182 - 0.7993 0.6738 3.5200 0.2662 0.6970 4.4347 -0.5737 -0.0995 0.8130 0.0221 - 3.4109 0.6178 1.0586 0.2662 0.6970 4.4347 1.0000 0.0000 0.0000 0.0312 - 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*\* | Av | float | (3) | Three angles defining the orientation of the | -| | gEulerAngles | | | **Feature** in Bunge convention (Z-X-Z). | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Created Objects -=============== - -None - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/OrientationAnalysis/docs/FindAvgCAxesFilter.md b/src/Plugins/OrientationAnalysis/docs/FindAvgCAxesFilter.md index d6fcbd7b35..26af4f0ba8 100644 --- a/src/Plugins/OrientationAnalysis/docs/FindAvgCAxesFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/FindAvgCAxesFilter.md @@ -5,7 +5,7 @@ Statistics (Crystallographic) -## Description +## Description This **Filter** determines the average C-axis location of each **Feature** by the following algorithm: @@ -15,7 +15,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 +## Parameters None @@ -23,27 +23,27 @@ None Not Applicable -## Required Objects +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | +| Ensemble Attribute Array | CrystalStructures | uint32_t | (1) | Enumeration representing the crystal structure for each Ensemble | -## Created Objects +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | -## Example Pipelines +## Example Pipelines Combo-EBSD-osc_r0c0 -## License & Copyright +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/OrientationAnalysis/docs/FindAvgCAxesFilter.rst b/src/Plugins/OrientationAnalysis/docs/FindAvgCAxesFilter.rst deleted file mode 100644 index 8aa1814b6c..0000000000 --- a/src/Plugins/OrientationAnalysis/docs/FindAvgCAxesFilter.rst +++ /dev/null @@ -1,79 +0,0 @@ -================================ -Find Average C-Axis Orientations -================================ - - -Group (Subgroup) -================ - -Statistics (Crystallographic) - -Description -=========== - -This **Filter** determines the average C-axis location of each **Feature** by the following algorithm: - -1. Gather all **Elements** that belong to the **Feature** -2. Determine the location of the c-axis in the sample *reference frame* for the rotated quaternions for all **Elements** -3. Average the locations and store as the average for the **Feature** - -*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 | Cryst | uint32_t | (1) | Enumeration representing the crystal structure | -| | alStructures | | | 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 | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Example Pipelines -================= - -Combo-EBSD-osc_r0c0 - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/OrientationAnalysis/docs/FindAvgOrientationsFilter.md b/src/Plugins/OrientationAnalysis/docs/FindAvgOrientationsFilter.md index 3027f0a157..052e10d14c 100644 --- a/src/Plugins/OrientationAnalysis/docs/FindAvgOrientationsFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/FindAvgOrientationsFilter.md @@ -1,11 +1,11 @@ # Find Feature Average Orientations -## Group (Subgroup) ## +## Group (Subgroup) Statistics (Crystallographic) -## Description ## +## Description This **Filter** determines the average orientation of each **Feature** by the following algorithm: @@ -18,32 +18,32 @@ 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 ## +## Parameters None -## Required Geometry ## +## Required Geometry Not Applicable -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | +| Ensemble Attribute Array | CrystalStructures | uint32_t | (1) | Enumeration representing the crystal structure for each Ensemble | -## Created Objects ## +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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) | -## Example Pipelines ## +## Example Pipelines + (10) SmallIN100 Full Reconstruction + InsertTransformationPhase @@ -51,7 +51,7 @@ Not Applicable + (05) SmallIN100 Crystallographic Statistics + (06) SmallIN100 Synthetic -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/OrientationAnalysis/docs/FindAvgOrientationsFilter.rst b/src/Plugins/OrientationAnalysis/docs/FindAvgOrientationsFilter.rst deleted file mode 100644 index 3b8d2e3243..0000000000 --- a/src/Plugins/OrientationAnalysis/docs/FindAvgOrientationsFilter.rst +++ /dev/null @@ -1,101 +0,0 @@ -================================= -Find Feature Average Orientations -================================= - - -Group (Subgroup) -================ - -Statistics (Crystallographic) - -Description -=========== - -This **Filter** determines the average orientation of each **Feature** by the following algorithm: - -1. Gather all **Elements** that belong to the **Feature** -2. Using the symmetry operators of the phase of the **Feature**, rotate the quaternion of the **Feature**\ ’s first - **Element** into the *Fundamental Zone* nearest to the origin -3. Rotate each subsequent **Elements**\ ’s quaternion (with same symmetry operators) looking for the quaternion closest - to the quaternion selected in Step 2 -4. Average the rotated quaternions for all **Elements** and store as the average for the **Feature** - -*Note:* The process of finding the nearest quaternion in Step 3 is to account for the periodicity of orientation space, -which would cause problems in the averaging if all quaternions were forced to be rotated into the same *Fundamental -Zone* - -*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 | Cryst | uint32_t | (1) | Enumeration representing the crystal structure | -| | alStructures | | | 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 | Av | float | (3) | Specifies the orientation of each **Feature** | -| | gEulerAngles | | | in Bunge convention (Z-X-Z) | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Example Pipelines -================= - -- - - (10) SmallIN100 Full Reconstruction - -- InsertTransformationPhase - -- - - (6) SmallIN100 Postsegmentation Processing - -- - - (5) SmallIN100 Crystallographic Statistics - -- - - (6) SmallIN100 Synthetic - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/OrientationAnalysis/docs/FindBoundaryStrengthsFilter.md b/src/Plugins/OrientationAnalysis/docs/FindBoundaryStrengthsFilter.md index cfddf5d6b6..6c803a2c12 100644 --- a/src/Plugins/OrientationAnalysis/docs/FindBoundaryStrengthsFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/FindBoundaryStrengthsFilter.md @@ -20,7 +20,7 @@ This **Filter** calculates the same metrics as in the Find Neighbor Slip Transmi ## Parameters | Name | Type | Description | -|------|------| ----------- | +|------------|------| --------------------------------- | | Loading Direction | float32 (3x) | The loading axis for the sample | ## Required Geometry @@ -29,17 +29,17 @@ 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 | +| 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 | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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) | | diff --git a/src/Plugins/OrientationAnalysis/docs/FindBoundaryStrengthsFilter.rst b/src/Plugins/OrientationAnalysis/docs/FindBoundaryStrengthsFilter.rst deleted file mode 100644 index 06ab927147..0000000000 --- a/src/Plugins/OrientationAnalysis/docs/FindBoundaryStrengthsFilter.rst +++ /dev/null @@ -1,87 +0,0 @@ -====================================== -Find Feature Boundary Strength Metrics -====================================== - - -Group (Subgroup) -================ - -Statistics (Crystallographic) - -Description -=========== - -This **Filter** calculates the same metrics as in the Find Neighbor Slip Transmission Metrics **Filter**. However, this -**Filter** stores the values in the **Face Attribute Matrix** of a **Triangle Geometry**. The algorithm the **Filter** -uses is as follows: - -1. Find the two **Features** that are separated by a **Face** in the **Triangle Geometry** -2. Get the average orientation of both of the **Features** -3. Calculate the transmission metrics from both directions (i.e. **Feature** 1 to **Feature** 2 and **Feature** 2 to - **Feature** 1) -4. Store the metrics in the **Face** map -5. Repeat for all **Faces** - -*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 | Cryst | uint32 | (1) | Enumeration representing the crystal structure | -| | alStructures | | | 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) -==================== ============ ======= ========== =========== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/OrientationAnalysis/docs/FindCAxisLocationsFilter.md b/src/Plugins/OrientationAnalysis/docs/FindCAxisLocationsFilter.md index 2f1498eea7..bccc87b9cc 100644 --- a/src/Plugins/OrientationAnalysis/docs/FindCAxisLocationsFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/FindCAxisLocationsFilter.md @@ -21,16 +21,16 @@ Not Applicable ## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | +| Ensemble Attribute Array | CrystalStructures | uint32_t | (1) | Enumeration representing the crystal structure for each Ensemble | ## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | diff --git a/src/Plugins/OrientationAnalysis/docs/FindCAxisLocationsFilter.rst b/src/Plugins/OrientationAnalysis/docs/FindCAxisLocationsFilter.rst deleted file mode 100644 index 4c41079567..0000000000 --- a/src/Plugins/OrientationAnalysis/docs/FindCAxisLocationsFilter.rst +++ /dev/null @@ -1,74 +0,0 @@ -===================== -Find C-Axis Locations -===================== - - -Group (Subgroup) -================ - -Statistics (Crystallographic) - -Description -=========== - -This **Filter** determines the direction of the C-axis for each **Element** by applying the quaternion of the -**Element** to the <001> direction, which is the C-axis for *Hexagonal* materials. This will tell where the C-axis of -the **Element** sits in the *sample reference frame*. - -*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 | Cryst | uint32_t | (1) | Enumeration representing the crystal structure | -| | alStructures | | | for each \**Ensemble | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Created Objects -=============== - -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Kind | Default Name | Type | Comp. Dims | Description | -+=============================+==============+==========+============+=================================================+ -| Element Attribute Array | C | float | (3) | Direction of the C-axis for each | -| | AxisLocation | | | **Element** in the sample reference frame | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Example Pipelines -================= - -Combo-EBSD-osc_r0c0 - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/OrientationAnalysis/docs/FindFeatureNeighborCAxisMisalignmentsFilter.md b/src/Plugins/OrientationAnalysis/docs/FindFeatureNeighborCAxisMisalignmentsFilter.md index bd36df7046..54df5ec5a0 100644 --- a/src/Plugins/OrientationAnalysis/docs/FindFeatureNeighborCAxisMisalignmentsFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/FindFeatureNeighborCAxisMisalignmentsFilter.md @@ -16,7 +16,7 @@ __NOTE:__ Only features with identical phase values and a crystal structure of * ## 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 @@ -25,26 +25,26 @@ Not Applicable ## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | +| Ensemble Attribute Array | CrystalStructures | uint32_t | (1) | Enumeration representing the crystal structure for each Ensemble | -## Created Objects +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | -## Example Pipelines +## Example Pipelines Combo-EBSD-osc_r0c0 -## License & Copyright +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/OrientationAnalysis/docs/FindFeatureNeighborCAxisMisalignmentsFilter.rst b/src/Plugins/OrientationAnalysis/docs/FindFeatureNeighborCAxisMisalignmentsFilter.rst deleted file mode 100644 index 396eed94c2..0000000000 --- a/src/Plugins/OrientationAnalysis/docs/FindFeatureNeighborCAxisMisalignmentsFilter.rst +++ /dev/null @@ -1,88 +0,0 @@ -========================================== -Find Feature Neighbor C-Axis Misalignments -========================================== - - -Group (Subgroup) -================ - -Statistics (Crystallographic) - -Description -=========== - -This **Filter** determines, for each **Feature**, the C-axis misalignments with the **Features** that are in contact -with it. The C-axis misalignments are stored as a list (for each **Feature**) of angles (in degrees). - -Notes ------ - -**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 | bool | Whether the *average* of the C-axis misalignments with | -| Per Feature | | 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 | N | List of | (1) | List of the contiguous neighboring **Features** | -| | eighborLists | int32_t | | 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 | Cryst | uint32_t | (1) | Enumeration representing the crystal structure | -| | alStructures | | | for each \**Ensemble | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Created Objects -=============== - -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Kind | Default Name | Type | Comp. Dims | Description | -+=============================+==============+==========+============+=================================================+ -| Feature Attribute Array | CAxisMisa | List of | (1) | List of the C-axis misalignment angles (in | -| | lignmentList | float | | degrees) with the contiguous neighboring | -| | | | | **Features** for a given \**Feature | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Feature Attribute Array | AvgCAxisM | float | (1) | Number weighted average of neighbor C-axis | -| | isalignments | | | misalignments. Only created if *Find Average | -| | | | | Misalignment Per Feature* is checked | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Example Pipelines -================= - -Combo-EBSD-osc_r0c0 - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/OrientationAnalysis/docs/FindFeatureReferenceCAxisMisorientationsFilter.md b/src/Plugins/OrientationAnalysis/docs/FindFeatureReferenceCAxisMisorientationsFilter.md index 121a688430..e87ae6a603 100644 --- a/src/Plugins/OrientationAnalysis/docs/FindFeatureReferenceCAxisMisorientationsFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/FindFeatureReferenceCAxisMisorientationsFilter.md @@ -5,13 +5,13 @@ Statistics (Crystallographic) -## Description +## Description This **Filter** calculates the misorientation angle between the C-axis of each **Cell** within a **Feature** and the average C-axis for that **Feature** and stores that value for each **Cell**. The average and standard deviation of those values for all **Cells** belonging to the same **Feature** is also stored for each **Feature**. 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 +## Parameters None @@ -19,30 +19,30 @@ None Image -## Required Objects +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | +| Ensemble Attribute Array | CrystalStructures | uint32_t | (1) | Enumeration representing the crystal structure for each Ensemble | -## Created Objects +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | -## Example Pipelines +## Example Pipelines Combo-EBSD-osc_r0c0 -## License & Copyright +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/OrientationAnalysis/docs/FindFeatureReferenceCAxisMisorientationsFilter.rst b/src/Plugins/OrientationAnalysis/docs/FindFeatureReferenceCAxisMisorientationsFilter.rst deleted file mode 100644 index b9f92eb4c1..0000000000 --- a/src/Plugins/OrientationAnalysis/docs/FindFeatureReferenceCAxisMisorientationsFilter.rst +++ /dev/null @@ -1,89 +0,0 @@ -=========================================== -Find Feature Reference C-Axis Misalignments -=========================================== - - -Group (Subgroup) -================ - -Statistics (Crystallographic) - -Description -=========== - -This **Filter** calculates the misorientation angle between the C-axis of each **Cell** within a **Feature** and the -average C-axis for that **Feature** and stores that value for each **Cell**. The average and standard deviation of those -values for all **Cells** belonging to the same **Feature** is also stored for each **Feature**. - -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 | Cryst | uint32_t | (1) | Enumeration representing the crystal structure | -| | alStructures | | | for each \**Ensemble | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Created Objects -=============== - -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Kind | Default Name | Type | Comp. Dims | Description | -+=============================+==============+==========+============+=================================================+ -| Cell Attribute Array | FeatureRefer | float | (1) | Misorientation angle (in degrees) between | -| | enceCAxisMis | | | **Cell’s** C-axis and the C-axis of the | -| | orientations | | | **Feature** that owns that \**Cell | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Feature Attribute Array | Featur | float | (1) | Average of the | -| | eAvgCAxisMis | | | *FeatureReferenceCAxisMisorientation* values | -| | orientations | | | for all of the **Cells** that belong to the | -| | | | | \**Feature | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Feature Attribute Array | FeatureS | float | (1) | Standard deviation of the | -| | tdevCAxisMis | | | *FeatureReferenceCAxisMisorientation* values | -| | orientations | | | for all of the **Cells** that belong to the | -| | | | | \**Feature | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Example Pipelines -================= - -Combo-EBSD-osc_r0c0 - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/OrientationAnalysis/docs/FindFeatureReferenceMisorientationsFilter.md b/src/Plugins/OrientationAnalysis/docs/FindFeatureReferenceMisorientationsFilter.md index bcb7bc839a..2a720d1e3b 100644 --- a/src/Plugins/OrientationAnalysis/docs/FindFeatureReferenceMisorientationsFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/FindFeatureReferenceMisorientationsFilter.md @@ -1,50 +1,50 @@ # Find Feature Reference Misorientations -## Group (Subgroup) ## +## Group (Subgroup) Statistics (Crystallographic) -## Description ## +## Description This **Filter** calculates the misorientation angle between each **Cell** within a **Feature** and a *reference orientation* for that **Feature**. The user can choose the *reference orientation* to be used for the **Features** from a drop-down menu. The options for the *reference orientation* are the average orientation of the **Feature** or the orientation of the **Cell** that is furthest from the *boundary* of the **Feature**. 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 ## +## Parameters | Name | Type | Description | -|------|------| ----------- | +|------------|------| --------------------------------- | | Reference Orientation | Enumeration | Specifies the *reference orientation* to use when comparing to each **Cell | -## Required Geometry ## +## Required Geometry Image -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | +| Ensemble Attribute Array | CrystalStructures | uint32_t | (1) | Enumeration representing the crystal structure for each Ensemble | -## Created Objects ## +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | -## Example Pipelines ## +## Example Pipelines + (05) SmallIN100 Crystallographic Statistics -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/OrientationAnalysis/docs/FindFeatureReferenceMisorientationsFilter.rst b/src/Plugins/OrientationAnalysis/docs/FindFeatureReferenceMisorientationsFilter.rst deleted file mode 100644 index 0d47829731..0000000000 --- a/src/Plugins/OrientationAnalysis/docs/FindFeatureReferenceMisorientationsFilter.rst +++ /dev/null @@ -1,101 +0,0 @@ -====================================== -Find Feature Reference Misorientations -====================================== - - -Group (Subgroup) -================ - -Statistics (Crystallographic) - -Description -=========== - -This **Filter** calculates the misorientation angle between each **Cell** within a **Feature** and a *reference -orientation* for that **Feature**. The user can choose the *reference orientation* to be used for the **Features** from -a drop-down menu. The options for the *reference orientation* are the average orientation of the **Feature** or the -orientation of the **Cell** that is furthest from the *boundary* of the **Feature**. - -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 | GBEuclid | float | (1) | Distance the **Cells** are from the *boundary* | -| | eanDistances | | | 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 | Cryst | uint32_t | (1) | Enumeration representing the crystal structure | -| | alStructures | | | for each \**Ensemble | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Created Objects -=============== - -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Kind | Default Name | Type | Comp. Dims | Description | -+=============================+==============+==========+============+=================================================+ -| Cell Attribute Array | Feature | float | (1) | Misorientation angle (in degrees) between | -| | ReferenceMis | | | **Cell’s** orientation and the reference | -| | orientations | | | orientation of the **Feature** that owns that | -| | | | | \**Cell | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Feature Attribute Array | F | float | (1) | Average of the *FeatureReferenceMisorientation* | -| | eatureAvgMis | | | values for all of the **Cells** that belong to | -| | orientations | | | the \**Feature | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Example Pipelines -================= - -- - - (5) SmallIN100 Crystallographic Statistics - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/OrientationAnalysis/docs/FindGBCDFilter.md b/src/Plugins/OrientationAnalysis/docs/FindGBCDFilter.md index 5191d317dc..c87dd8f06b 100644 --- a/src/Plugins/OrientationAnalysis/docs/FindGBCDFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/FindGBCDFilter.md @@ -1,52 +1,52 @@ # Find GBCD -## Group (Subgroup) ## +## Group (Subgroup) Statistics (Crystallographic) -## Description ## +## Description 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 ## +## Parameters | Name | Type | Description | -|------|------| ----------- | +|------------|------| --------------------------------- | | GBCD Resolution (Degrees) | float | The resolution in degrees for the GBCD calculation | -## Required Geometry ## +## Required Geometry Image + Triangle -## Required Objects (From Triangle Geometry) ## +## 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 | +| 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) ## +## Required Objects(From Image Geometry) -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | +| Ensemble Attribute Array | CrystalStructures | uint32_t | (1) | Enumeration representing the crystal structure for each Ensemble | -## Created Objects ## +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | -## Example Pipelines ## +## Example Pipelines + (04) SmallIN100 GBCD -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/OrientationAnalysis/docs/FindGBCDFilter.rst b/src/Plugins/OrientationAnalysis/docs/FindGBCDFilter.rst deleted file mode 100644 index 51f36a79a1..0000000000 --- a/src/Plugins/OrientationAnalysis/docs/FindGBCDFilter.rst +++ /dev/null @@ -1,86 +0,0 @@ -========= -Find GBCD -========= - - -Group (Subgroup) -================ - -Statistics (Crystallographic) - -Description -=========== - -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 | Av | float | (3) | Three angles defining the orientation of the | -| | gEulerAngles | | | **Feature** in Bunge convention (Z-X-Z) | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Feature Attribute Array | Phases | int32_t | (1) | Specifies to which phase each **Feature** | -| | | | | belongs | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Ensemble Attribute Array | Cryst | uint32_t | (1) | Enumeration representing the crystal structure | -| | alStructures | | | for each \**Ensemble | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Created Objects -=============== - -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Kind | Default Name | Type | Comp. Dims | Description | -+=============================+==============+==========+============+=================================================+ -| Ensemble Attribute Array | GBDC | Double | (n, | 5 parameter GBCD data. The 6th component is | -| | | | m,l,o,q,r) | used internally to track the northern | -| | | | | vs. southern hemisphere of the Lambert sphere | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Example Pipelines -================= - -- - - (4) SmallIN100 GBCD - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/OrientationAnalysis/docs/FindGBCDMetricBasedFilter.md b/src/Plugins/OrientationAnalysis/docs/FindGBCDMetricBasedFilter.md index e28b08098e..bcd4eca709 100644 --- a/src/Plugins/OrientationAnalysis/docs/FindGBCDMetricBasedFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/FindGBCDMetricBasedFilter.md @@ -5,7 +5,7 @@ Statistics (Crystallographic) -## Description +## Description This **Filter** computes a section through the five-dimensional grain boundary distirbution for a fixed misorientation. An example of such a section is shown in Fig. 1. Differently than **Find GBCD Filter**, which uses a method based on partition of the boundary space into bins, this **Filter** implements an alternative metric-based approach described by K. Glowinski and A. Morawiec in [Analysis of experimental grain boundary distributions based on boundary-space metrics, Metall. Mater. Trans. A 45, 3189-3194 (2014)](https://link.springer.com/article/10.1007/s11661-014-2325-y) @@ -42,10 +42,10 @@ 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 +## 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 | @@ -59,18 +59,18 @@ Then, the directions are given as [ sin θ × cos φ , sin θ Image + Triangle -## Required Objects +## 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 | +| 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 @@ -80,13 +80,13 @@ In the case of any questions, suggestions, bugs, etc., please feel free to emai [1] K. Glowinski and A. Morawiec, Analysis of experimental grain boundary distributions based on boundary-space metrics, Metall. Mater. Trans. A 45, 3189-3194 (2014) -## Example Pipelines +## Example Pipelines `(05) SmallIN100 GBCD Metric.d3dpipeline` This pipeline depends on previous pipelines in the Small IN100 reconstruction pipeline series. -## License & Copyright +## License & Copyright Please see the description file distributed with this **Plugin**. diff --git a/src/Plugins/OrientationAnalysis/docs/FindGBCDMetricBasedFilter.rst b/src/Plugins/OrientationAnalysis/docs/FindGBCDMetricBasedFilter.rst deleted file mode 100644 index 20723d89ed..0000000000 --- a/src/Plugins/OrientationAnalysis/docs/FindGBCDMetricBasedFilter.rst +++ /dev/null @@ -1,233 +0,0 @@ -================================= -Find GBCD (Metric-Based Approach) -================================= - - -Group (Subgroup) -================ - -Statistics (Crystallographic) - -Description -=========== - -This **Filter** computes a section through the five-dimensional grain boundary distirbution for a fixed misorientation. -An example of such a section is shown in Fig. 1. Differently than **Find GBCD Filter**, which uses a method based on -partition of the boundary space into bins, this **Filter** implements an alternative metric-based approach described by -K. Glowinski and A. Morawiec in `Analysis of experimental grain boundary distributions based on boundary-space metrics, -Metall. Mater. Trans. A 45, 3189-3194 (2014) `__ - -.. figure:: Images/FindGBCDMetricBased_dist.png - :alt: Fig. 1: Section for the 17.9 deg./[111] misorientation through the grain boundary distribution obtained using - this Filter for the small IN100 data set. Units are multiples of random distribution (MRDs). - - Fig. 1: Section for the 17.9 deg./[111] misorientation through the grain boundary distribution obtained using this - Filter for the small IN100 data set. Units are multiples of random distribution (MRDs). - -Metrics in the boundary space can be defined in a number of ways, but it is essential that two boundaries are close -(distant) if they have similar (different) geometric features, and that symmetrically equivalent representations of -boundaries are taken into consideration. Formally, the boundary space is a Cartesian product of the misorientation and -boundary-normal subspaces. For computational reasons and because of considerably different resolutions in -determinination of grain misorientation and boundary-plane parameters, it is convenient to use a separate metric in each -subspace. With separate metrics, the procedure for computing distribution values for a selected misorientation has two -stages. First, boundary segments with misorientations located not farther from the fixed misorientation than a limiting -distance ρm are selected. In the second stage, the distribution is probed at evenly distributed normal directions (see -Fig. 2), and areas of boundaries whose normals deviate from a given direction by less than ρp are summed. (The radii ρm -and ρp should be tailored to resolution, amount, and quality of data and set.) Eventually, the obtained distribution is -normalized in order to express it in the conventional units, i.e., multiples of the random distribution. - -+-----------------------------------------------------------------------------------------------------------------------+ -| Image | -+=======================================================================================================================+ -| |image1| | -+-----------------------------------------------------------------------------------------------------------------------+ -| Fig. 2: End-points (drawn in stereographic projection) of sampling directions used for probing distribution values; | -| the number of points here is about 1500. Additionally, distributions are probed at points lying at the equator | -| (marked with red); this is helpful for some plotting software. | -+-----------------------------------------------------------------------------------------------------------------------+ - -This **Filter** also calculates statistical errors of the distributions using the formula - -ε = ( *f* *n* *v* )1/2 - -where ε is the relative error of the distribution function at a given point, *f* is the value of the function at that -point, *n* stands for the number of grain boundaries (**not** the number of mesh triangles) in the considered network, -and *v* denotes the volume restricted by ρm and ρp. The errors can be calculated either as their absolute values, i.e., -ε × *f* (Fig. 3a) or as relative errors, i.e., 100% × ε (Fig. 3b). The latter are computed in a way that if the relative -error exceeds 100%, it is rounded down to 100%. - -+-----------------------------------------------------------------------------------------------------------------------+ -| Image | -+=======================================================================================================================+ -| |image2| | -+-----------------------------------------------------------------------------------------------------------------------+ -| |Fig. 3: (a) Errors (absolute values of one standard deviation) corresponding to the distribution shown in Fig. 1. | -| Levels are given in MRDs. (b) Relative errors (given in %) of the distribution from Fig. 1.| | -+-----------------------------------------------------------------------------------------------------------------------+ - -Format of Output Files -====================== - -Output files are formatted to be readable by GMT plotting program. The first line contains the fixed misorientation axis -and angle. Each of the remaining lines contains three numbers. The first two columns are angles (in degrees) describing -a given sampling direction; let us denote them *col*\ 1 and *col*\ 2, respectively. The third column is either the value -of the GBCD (in MRD) for that direction or its error (in MRD or %, depending on user’s selection). If you use other -software, you can retrive spherical angles θ and φ of the sampling directions in the following way: - -θ = 90° - *col*\ 1 - -φ = *col*\ 2 - -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 | bool | If checked, only interiors of **Faces** are included in | -| Directly Neighboring | | GBCD | -| Triple Lines | | | -+---------------------------+---------------------------+-------------------------------------------------------------+ -| Output Distribution File | File Path | The output file path (extension .dat, GMT format) | -+---------------------------+---------------------------+-------------------------------------------------------------+ -| Output Distribution | File Path | The output file path (extension .dat, GMT format) | -| Errors File | | | -+---------------------------+---------------------------+-------------------------------------------------------------+ -| Save Relative Errors | bool | What type of errors to save (see above description for more | -| Instead of Their Absolute | | detail) | -| Values | | | -+---------------------------+---------------------------+-------------------------------------------------------------+ - -Required Geometry -================= - -Image + Triangle - -Required Objects -================ - -+----------------+----------------------------------+-------------------------------+---------------------+-----------+ -| Kind | Default Name | Type | Comp Dims | De | -| | | | | scription | -+================+==================================+===============================+=====================+===========+ -| Vertex | NodeTypes | int8_t | (1) | Specifies | -| Attribute | | | | the type | -| Array*\* | | | | of node | -| | | | | in the | -| | | | | Geometry | -+----------------+----------------------------------+-------------------------------+---------------------+-----------+ -| Face Attribute | FaceLabels | int32_t | (2) | Specifies | -| Array | | | | which | -| | | | | **F | -| | | | | eatures** | -| | | | | are on | -| | | | | either | -| | | | | side of | -| | | | | each | -| | | | | \**Face | -+----------------+----------------------------------+-------------------------------+---------------------+-----------+ -| Face Attribute | FaceNormals | double | (3) | Specifies | -| Array | | | | the | -| | | | | normal of | -| | | | | each | -| | | | | \**Face | -+----------------+----------------------------------+-------------------------------+---------------------+-----------+ -| Face Attribute | FaceAreas | double | (1) | Specifies | -| Array | | | | the area | -| | | | | of each | -| | | | | \**Face | -+----------------+----------------------------------+-------------------------------+---------------------+-----------+ -| Feature | FaceLabels | int32_t | (2) | Specifies | -| Attribute | | | | which | -| Array | | | | * | -| | | | | original* | -| | | | | **F | -| | | | | eatures** | -| | | | | are on | -| | | | | either | -| | | | | side of | -| | | | | each | -| | | | | boundary | -| | | | | \ | -| | | | | **Feature | -+----------------+----------------------------------+-------------------------------+---------------------+-----------+ -| Feature | AvgEulerAngles | float | (3) | Three | -| Attribute | | | | angles | -| Array | | | | defining | -| | | | | the | -| | | | | or | -| | | | | ientation | -| | | | | of the | -| | | | | ** | -| | | | | Feature** | -| | | | | in Bunge | -| | | | | c | -| | | | | onvention | -| | | | | (Z-X-Z) | -+----------------+----------------------------------+-------------------------------+---------------------+-----------+ -| Feature | Phases | int32_t | (1) | Specifies | -| Attribute | | | | to which | -| Array | | | | phase | -| | | | | each | -| | | | | ** | -| | | | | Feature** | -| | | | | belongs | -+----------------+----------------------------------+-------------------------------+---------------------+-----------+ -| Ensemble | CrystalStructures | uint32_t | (1) | En | -| Attribute | | | | umeration | -| Array | | | | rep | -| | | | | resenting | -| | | | | 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 - -References -========== - -[1] K. Glowinski and A. Morawiec, Analysis of experimental grain boundary distributions based on boundary-space metrics, -Metall. Mater. Trans. A 45, 3189-3194 (2014) - -Example Pipelines -================= - -``(05) SmallIN100 GBCD Metric.d3dpipeline`` - -This pipeline depends on previous pipelines in the Small IN100 reconstruction pipeline series. - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin**. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. - -.. |image1| image:: Images/FindGBCDMetricBased_samplpts.png -.. |image2| image:: Images/FindGBCDMetricBased_err2.png -.. |Fig. 3: (a) Errors (absolute values of one standard deviation) corresponding to the distribution shown in Fig. 1. Levels are given in MRDs. (b) Relative errors (given in %) of the distribution from Fig. 1.| image:: Images/FindGBCDMetricBased_err2.png diff --git a/src/Plugins/OrientationAnalysis/docs/FindGBPDMetricBasedFilter.md b/src/Plugins/OrientationAnalysis/docs/FindGBPDMetricBasedFilter.md index 0a9c694bb4..c91778ea48 100644 --- a/src/Plugins/OrientationAnalysis/docs/FindGBPDMetricBasedFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/FindGBPDMetricBasedFilter.md @@ -5,7 +5,7 @@ Statistics (Crystallographic) -## Description +## Description This **Filter** computes the grain boundary plane distribution (GBPD) like that shown in Fig. 1. It should be noted that most GBPDs presented so far in literature were obtained using a method based on partition of the grain boundary space into bins, similar to that implemented in the *Find GBCD* **Filter**. This **Filter** calculates the GBPD using an alternative approach adapted from the one included in the *Find GBCD (Metric-based Approach)* **Filter** and described by K. Glowinski and A. Morawiec in [Analysis of experimental grain boundary distributions based on boundary-space metrics, Metall. Mater. Trans. A 45, 3189-3194 (2014)](http://link.springer.com/article/10.1007%2Fs11661-014-2325-y). Briefly, the GBPD is probed at evenly distributed sampling directions (similarly to *Find GBCD (Metric-based Approach)* **Filter**) and areas of mesh segments with their normal vectors deviated by less than a limiting angle ρp from a given direction are summed. If *n*S is the number of crystal symmetry transformations, each boundary plane segment is represented by up to 4 × *n*S equivalent vectors, and all of them are processed. It is enough to sample the distribution at directions corresponding to the standard stereographic triangle (or, in general, to a fundamental region corresponding to a considered crystallographic point group); values at remaining points are obtained based on crystal symmetries. After summing the boundary areas, the distribution is normalized. First, the values at sampling vectors are divided by the total area of all segments. Then, in order to express the distribution in the conventional units, i.e., multiples of random distribution (MRDs), the obtained fractional values are divided by the volume *v* = (*A* nS) / (4π), where *A* is the area of a spherical cap determined by ρp. @@ -19,10 +19,10 @@ is the relative error of the distribution function at a given point, *f* is the See also the documentation for [Find GBCD (Metric-based Approach)](../FindGBCDMetricBasedFilter/index.html) **Filter** for additional information. -## Parameters +## 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 | @@ -35,20 +35,20 @@ See also the documentation for [Find GBCD (Metric-based Approach)](../FindGBCDMe Image + Triangle -## Required Objects +## Required Objects | 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 | 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 | +| 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 ## +## Format of Output Files Output files are formatted to be readable by GMT plotting program. The first line is always "0.0 0.0 0.0 0.0". Each of the remaining lines contains three numbers. The first two columns are angles (in degrees) describing a given sampling direction; let us denote them *col*1 and *col*2, respectively. The third column is either the value of the GBCD (in MRD) for that direction or its error (in MRD or %, depending on user's selection). If you use other software, you can retrive spherical angles θ and φ of the sampling directions in the following way: @@ -66,11 +66,11 @@ In the case of any questions, suggestions, bugs, etc., please feel free to email [1] K. Glowinski and A. Morawiec, Analysis of experimental grain boundary distributions based on boundary-space metrics, Metall. Mater. Trans. A 45, 3189-3194 (2014) -## Example Pipelines +## Example Pipelines -## License & Copyright +## License & Copyright Please see the description file distributed with this **Plugin**. diff --git a/src/Plugins/OrientationAnalysis/docs/FindGBPDMetricBasedFilter.rst b/src/Plugins/OrientationAnalysis/docs/FindGBPDMetricBasedFilter.rst deleted file mode 100644 index 91ad50eb46..0000000000 --- a/src/Plugins/OrientationAnalysis/docs/FindGBPDMetricBasedFilter.rst +++ /dev/null @@ -1,198 +0,0 @@ -================================= -Find GBPD (Metric-Based Approach) -================================= - - -Group (Subgroup) -================ - -Statistics (Crystallographic) - -Description -=========== - -This **Filter** computes the grain boundary plane distribution (GBPD) like that shown in Fig. 1. It should be noted that -most GBPDs presented so far in literature were obtained using a method based on partition of the grain boundary space -into bins, similar to that implemented in the *Find GBCD* **Filter**. This **Filter** calculates the GBPD using an -alternative approach adapted from the one included in the *Find GBCD (Metric-based Approach)* **Filter** and described -by K. Glowinski and A. Morawiec in `Analysis of experimental grain boundary distributions based on boundary-space -metrics, Metall. Mater. Trans. A 45, 3189-3194 (2014) `__. -Briefly, the GBPD is probed at evenly distributed sampling directions (similarly to *Find GBCD (Metric-based Approach)* -**Filter**) and areas of mesh segments with their normal vectors deviated by less than a limiting angle ρp from a given -direction are summed. If *n*\ S is the number of crystal symmetry transformations, each boundary plane segment is -represented by up to 4 × *n*\ S equivalent vectors, and all of them are processed. It is enough to sample the -distribution at directions corresponding to the standard stereographic triangle (or, in general, to a fundamental region -corresponding to a considered crystallographic point group); values at remaining points are obtained based on crystal -symmetries. After summing the boundary areas, the distribution is normalized. First, the values at sampling vectors are -divided by the total area of all segments. Then, in order to express the distribution in the conventional units, i.e., -multiples of random distribution (MRDs), the obtained fractional values are divided by the volume *v* = (*A* nS) / (4π), -where *A* is the area of a spherical cap determined by ρp. - -.. figure:: Images/FindGBPDMetricBased_example.png - :alt: Fig. 1: GBPD obtained for Small IN100 with the limiting distance set to 7° and with triangles adjacent to - triple lines removed. Units are MRDs. - - Fig. 1: GBPD obtained for Small IN100 with the limiting distance set to 7° and with triangles adjacent to triple - lines removed. Units are MRDs. - -This **Filter** also calculates statistical errors of the distributions using the formula - -ε = ( *f* *n* *v* )1/2, where ε - -is the relative error of the distribution function at a given point, *f* is the value of the function at that point, and -*n* stands for the number of grain boundaries (**not** the number of mesh triangles) in the considered network. The -errors can be calculated either as their absolute values, i.e., ε × *f* or as relative errors, i.e., 100% × ε. The -latter are computed in a way that if the relative error exceeds 100%, it is rounded down to 100%. - -See also the documentation for `Find GBCD (Metric-based Approach) <../FindGBCDMetricBasedFilter/index.html>`__ -**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 | bool | Only interiors of **Faces** are included in GBPD | -| Directly Neighboring | | | -| Triple Lines | | | -+---------------------------+---------------------------+-------------------------------------------------------------+ -| Output Distribution File | File Path | The output file path (extension .dat, GMT format) | -+---------------------------+---------------------------+-------------------------------------------------------------+ -| Output Distribution | File Path | The output file path (extension .dat, GMT format) | -| Errors File | | | -+---------------------------+---------------------------+-------------------------------------------------------------+ -| Save Relative Errors | bool | What type of errors to save (see above description for more | -| Instead of Their Absolute | | detail) | -| Values | | | -+---------------------------+---------------------------+-------------------------------------------------------------+ - -Required Geometry -================= - -Image + Triangle - -Required Objects -================ - -+----------------+----------------------------------+-------------------------------+---------------------+-----------+ -| Kind | Default Name | Type | Comp Dims | De | -| | | | | scription | -+================+==================================+===============================+=====================+===========+ -| Ensemble | CrystalStructures | uint32_t | (1) | En | -| Attribute | | | | umeration | -| Array | | | | rep | -| | | | | resenting | -| | | | | the | -| | | | | crystal | -| | | | | structure | -| | | | | for each | -| | | | | \* | -| | | | | *Ensemble | -+----------------+----------------------------------+-------------------------------+---------------------+-----------+ -| Feature | AvgEulerAngles | float | (3) | Three | -| Attribute | | | | angles | -| Array | | | | defining | -| | | | | the | -| | | | | or | -| | | | | ientation | -| | | | | of the | -| | | | | ** | -| | | | | Feature** | -| | | | | in Bunge | -| | | | | c | -| | | | | onvention | -| | | | | (Z-X-Z) | -+----------------+----------------------------------+-------------------------------+---------------------+-----------+ -| Feature | Phases | int32_t | (1) | Specifies | -| Attribute | | | | to which | -| Array | | | | phase | -| | | | | each | -| | | | | ** | -| | | | | Feature** | -| | | | | belongs | -+----------------+----------------------------------+-------------------------------+---------------------+-----------+ -| Face Attribute | FaceLabels | int32_t | (2) | Specifies | -| Array | | | | which | -| | | | | **F | -| | | | | eatures** | -| | | | | are on | -| | | | | either | -| | | | | side of | -| | | | | each | -| | | | | \**Face | -+----------------+----------------------------------+-------------------------------+---------------------+-----------+ -| Face Attribute | FaceNormals | double | (3) | Specifies | -| Array | | | | the | -| | | | | normal of | -| | | | | each | -| | | | | \**Face | -+----------------+----------------------------------+-------------------------------+---------------------+-----------+ -| Face Attribute | FaceAreas | double | (1) | Specifies | -| Array | | | | the area | -| | | | | of each | -| | | | | \**Face | -+----------------+----------------------------------+-------------------------------+---------------------+-----------+ -| Feature Face | FaceLabels | int32_t | (2) | Specifies | -| Attribute | | | | to which | -| Array*\* | | | | phase | -| | | | | each | -| | | | | **Face | -| | | | | Feature** | -| | | | | belongs | -+----------------+----------------------------------+-------------------------------+---------------------+-----------+ -| Vertex | NodeTypes | int8_t | (1) | Specifies | -| Attribute | | | | the type | -| Array*\* | | | | of node | -| | | | | in the | -| | | | | Geometry | -+----------------+----------------------------------+-------------------------------+---------------------+-----------+ - -Format of Output Files -====================== - -Output files are formatted to be readable by GMT plotting program. The first line is always “0.0 0.0 0.0 0.0”. Each of -the remaining lines contains three numbers. The first two columns are angles (in degrees) describing a given sampling -direction; let us denote them *col*\ 1 and *col*\ 2, respectively. The third column is either the value of the GBCD (in -MRD) for that direction or its error (in MRD or %, depending on user’s selection). If you use other software, you can -retrive spherical angles θ and φ of the sampling directions in the following way: - -θ = 90° - *col*\ 1 - -φ = *col*\ 2 - -Then, the directions are given as [ sin θ × cos φ , sin θ × sin φ , cos θ ]. - -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 - -References -========== - -[1] K. Glowinski and A. Morawiec, Analysis of experimental grain boundary distributions based on boundary-space metrics, -Metall. Mater. Trans. A 45, 3189-3194 (2014) - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin**. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/OrientationAnalysis/docs/FindKernelAvgMisorientationsFilter.md b/src/Plugins/OrientationAnalysis/docs/FindKernelAvgMisorientationsFilter.md index 1698fa42fa..9afc659717 100644 --- a/src/Plugins/OrientationAnalysis/docs/FindKernelAvgMisorientationsFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/FindKernelAvgMisorientationsFilter.md @@ -1,10 +1,10 @@ # Find Kernel Average Misorientations -## Group (Subgroup) ## +## Group (Subgroup) Statistics (Crystallographic) -## Description ## +## Description This **Filter** determines the Kernel Average Misorientation (KAM) for each **Cell**. The user can select the size of the kernel to be used in the calculation. The kernel size entered by the user is the *radius* of the kernel (i.e., entering values of *1*, *2*, *3* will result in a kernel that is *3*, *5*, and *7* **Cells** in size in the X, Y and Z directions, respectively). The algorithm for determination of KAM is as follows: @@ -13,37 +13,37 @@ 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 ## +## 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 ## +## Required Geometry Image -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | +| Ensemble Attribute Array | CrystalStructures | uint32_t | (1) | Enumeration representing the crystal structure for each Ensemble | -## Created Objects ## +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | -## Example Pipelines ## +## Example Pipelines + MassifPipeline + (05) SmallIN100 Crystallographic Statistics -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/OrientationAnalysis/docs/FindKernelAvgMisorientationsFilter.rst b/src/Plugins/OrientationAnalysis/docs/FindKernelAvgMisorientationsFilter.rst deleted file mode 100644 index 41567407eb..0000000000 --- a/src/Plugins/OrientationAnalysis/docs/FindKernelAvgMisorientationsFilter.rst +++ /dev/null @@ -1,87 +0,0 @@ -=================================== -Find Kernel Average Misorientations -=================================== - - -Group (Subgroup) -================ - -Statistics (Crystallographic) - -Description -=========== - -This **Filter** determines the Kernel Average Misorientation (KAM) for each **Cell**. The user can select the size of -the kernel to be used in the calculation. The kernel size entered by the user is the *radius* of the kernel (i.e., -entering values of *1*, *2*, *3* will result in a kernel that is *3*, *5*, and *7* **Cells** in size in the X, Y and Z -directions, respectively). The algorithm for determination of KAM is as follows: - -1. Calculate the misorientation angle between each **Cell** in a kernel and the central **Cell** of the kernel -2. Average all of the misorientations for the kernel and store at the central **Cell** - -*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 | Cryst | uint32_t | (1) | Enumeration representing the crystal structure | -| | alStructures | | | for each \**Ensemble | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Created Objects -=============== - -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Kind | Default Name | Type | Comp. Dims | Description | -+=============================+==============+==========+============+=================================================+ -| Cell Attribute Array | Kern | float | (1) | Average misorientation (in Degrees) for all | -| | elAverageMis | | | **Cells** within the kernel and the central | -| | orientations | | | \**Cell | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Example Pipelines -================= - -- MassifPipeline - -- - - (5) SmallIN100 Crystallographic Statistics - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/OrientationAnalysis/docs/FindMisorientationsFilter.md b/src/Plugins/OrientationAnalysis/docs/FindMisorientationsFilter.md index c68ad57345..2622fdc21b 100644 --- a/src/Plugins/OrientationAnalysis/docs/FindMisorientationsFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/FindMisorientationsFilter.md @@ -1,52 +1,52 @@ # Find Feature Neighbor Misorientations -## Group (Subgroup) ## +## Group (Subgroup) Statistics (Crystallographic) -## Description ## +## Description This **Filter** determines, for each **Feature**, the misorientations with each of the **Features** that are in contact with it. The misorientations are stored as a list (for each **Feature**) of angles (in degrees). The axis of the misorientation is not stored by this **Filter**. The user can also calculate the average misorientation between the feature and all contacting features. -### Notes ### +### Notes __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 ## +## 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 ## +## Required Geometry Not Applicable -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | +| Ensemble Attribute Array | CrystalStructures | uint32_t | (1) | Enumeration representing the crystal structure for each Ensemble | -## Created Objects ## +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | -## Example Pipelines ## +## Example Pipelines + (05) SmallIN100 Crystallographic Statistics -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/OrientationAnalysis/docs/FindMisorientationsFilter.rst b/src/Plugins/OrientationAnalysis/docs/FindMisorientationsFilter.rst deleted file mode 100644 index e86ad49aef..0000000000 --- a/src/Plugins/OrientationAnalysis/docs/FindMisorientationsFilter.rst +++ /dev/null @@ -1,92 +0,0 @@ -===================================== -Find Feature Neighbor Misorientations -===================================== - - -Group (Subgroup) -================ - -Statistics (Crystallographic) - -Description -=========== - -This **Filter** determines, for each **Feature**, the misorientations with each of the **Features** that are in contact -with it. The misorientations are stored as a list (for each **Feature**) of angles (in degrees). The axis of the -misorientation is not stored by this **Filter**. - -The user can also calculate the average misorientation between the feature and all contacting features. - -Notes ------ - -**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 | bool | Specifies if the *average* of the misorienations with the | -| Misorientation Per | | neighboring **Features** should be stored for each | -| Feature | | \**Feature | -+---------------------------+---------------------------+-------------------------------------------------------------+ - -Required Geometry -================= - -Not Applicable - -Required Objects -================ - -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Kind | Default Name | Type | Comp. Dims | Description | -+=============================+==============+==========+============+=================================================+ -| Feature Attribute Array | N | List of | (1) | List of the contiguous neighboring **Features** | -| | eighborLists | int32_t | | 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 | Cryst | uint32_t | (1) | Enumeration representing the crystal structure | -| | alStructures | | | for each \**Ensemble | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Created Objects -=============== - -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Kind | Default Name | Type | Comp. Dims | Description | -+=============================+==============+==========+============+=================================================+ -| Feature Attribute Array | Misorie | List of | (1) | List of the misorientation angles with the | -| | ntationLists | float | | contiguous neighboring **Features** for a given | -| | | | | \**Feature | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Feature Attribute Array | AvgMi | float | (1) | Number weighted average of neighbor | -| | sorientation | | | misorientations. Only created if *Find Average | -| | | | | Misorientation Per Feature* is checked | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Example Pipelines -================= - -- - - (5) SmallIN100 Crystallographic Statistics - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/OrientationAnalysis/docs/FindSchmidsFilter.md b/src/Plugins/OrientationAnalysis/docs/FindSchmidsFilter.md index cacbf8ba33..d8198cd431 100644 --- a/src/Plugins/OrientationAnalysis/docs/FindSchmidsFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/FindSchmidsFilter.md @@ -1,11 +1,11 @@ # Find Schmid Factors -## Group (Subgroup) ## +## Group (Subgroup) Statistics (Crystallographic) -## Description ## +## Description This **Filter** calculates the Schmid factor of each **Feature** given its average orientation and a user defined loading axis. The Schmid Factor is the combination of the component of the axial force *F* that lies parallel to the slip direction and the component that lies perpendicular to the slip plane. The equation for the Schmid Factor is given as: @@ -15,32 +15,32 @@ 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 ## +## 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 ## +## Required Geometry Not Applicable -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | +| Ensemble Attribute Array | CrystalStructures | uint32_t | (1) | Enumeration representing the crystal structure for each Ensemble | -## Created Objects ## +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | @@ -48,11 +48,11 @@ Not Applicable | Feature Attribute Array | SchmidLambdas | Float | (1) | Angle between tensile axis and splid drirection. Only created if *Store Angle Components of Schmid Factor* is checked | -## Example Pipelines ## +## Example Pipelines + (05) SmallIN100 Crystallographic Statistics -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/OrientationAnalysis/docs/FindSchmidsFilter.rst b/src/Plugins/OrientationAnalysis/docs/FindSchmidsFilter.rst deleted file mode 100644 index 71ba526a64..0000000000 --- a/src/Plugins/OrientationAnalysis/docs/FindSchmidsFilter.rst +++ /dev/null @@ -1,112 +0,0 @@ -=================== -Find Schmid Factors -=================== - - -Group (Subgroup) -================ - -Statistics (Crystallographic) - -Description -=========== - -This **Filter** calculates the Schmid factor of each **Feature** given its average orientation and a user defined -loading axis. The Schmid Factor is the combination of the component of the axial force *F* that lies parallel to the -slip direction and the component that lies perpendicular to the slip plane. The equation for the Schmid Factor is given -as: - -Schmid Factor = (cos φ cos λ) - -*The angle φ is the angle between the tensile axis and the slip plane normal, and λ is the angle between the tensile -axis and the slip direction in the slip plane.* - -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 | bool | Whether to store the φ and λ for each \**Feature | -| Schmid Factor | | | -+------------------------------+------------------------------+--------------------------------------------------------+ -| 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 | Cryst | uint32_t | (1) | Enumeration representing the crystal structure | -| | alStructures | | | 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 | S | Float | (1) | Angle between tensile axis and splid | -| | chmidLambdas | | | drirection. Only created if *Store Angle | -| | | | | Components of Schmid Factor* is checked | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Example Pipelines -================= - -- - - (5) SmallIN100 Crystallographic Statistics - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/OrientationAnalysis/docs/FindShapesFilter.md b/src/Plugins/OrientationAnalysis/docs/FindShapesFilter.md index 196d11ed98..35bc3d4f15 100644 --- a/src/Plugins/OrientationAnalysis/docs/FindShapesFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/FindShapesFilter.md @@ -1,11 +1,11 @@ # Find Feature Shapes -## Group (Subgroup) ## +## Group (Subgroup) Statistics (Morphological) -## Description ## +## Description This **Filter** calculates the second-order moments of each **Feature** in order to determine the *principal axis lengths, principal axis directions, aspect ratios and moment invariant Omega3s*. The *principal axis lengths* are those of a "best-fit" ellipsoid. The algorithm for determining the moments and these values is as follows: @@ -18,26 +18,26 @@ 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 ## +## Parameters None -## Required Geometry ## +## Required Geometry Image -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 ## +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | @@ -54,12 +54,12 @@ Image [4] M. Groeber, M. Uchic, D. Dimiduk, and S. Ghosh. A Framework for Automated Analysis and Simulation of 3D Polycrystalline Microstructures, Part 1: Statistical Characterization Acta Materialia, 56 (2008), 1257-1273. -## Example Pipelines ## +## Example Pipelines + (01) SmallIN100 Morphological Statistics + (06) SmallIN100 Synthetic -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/OrientationAnalysis/docs/FindShapesFilter.rst b/src/Plugins/OrientationAnalysis/docs/FindShapesFilter.rst deleted file mode 100644 index 7fec759044..0000000000 --- a/src/Plugins/OrientationAnalysis/docs/FindShapesFilter.rst +++ /dev/null @@ -1,115 +0,0 @@ -=================== -Find Feature Shapes -=================== - - -Group (Subgroup) -================ - -Statistics (Morphological) - -Description -=========== - -This **Filter** calculates the second-order moments of each **Feature** in order to determine the *principal axis -lengths, principal axis directions, aspect ratios and moment invariant Omega3s*. The *principal axis lengths* are those -of a “best-fit” ellipsoid. The algorithm for determining the moments and these values is as follows: - -1. For each **Cell**, determine the x, y and z distance to the centroid of the **Feature** that owns the **Cell** -2. For each **Cell**, calculate Ixx, Iyy, Izz, Ixy, Ixz and Iyz using the x, y and z distances determined in step 1. -3. Sum the individual Ixx, Iyy, Izz, Ixy, Ixz and Iyz values for all **Cells** belonging to the same **Feature** -4. Find the *eigenvalues* and *eigenvectors* of the *3x3* symmetric matrix defined by the *6* values calculated in step - 3 for each **Feature** -5. Use the relationship of *principal moments* to the *principal axis lengths* for an ellipsoid, which can be found in - [4], to determine the *Semi-Axis Lengths* -6. Calculate the *Aspect Ratios* from the *Semi-Axis Lengths* found in step 5. -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 | Cel | Cell | N/A | Feature Attribute Matrix*\* of the selected | -| | lFeatureData | Feature | | *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 | Axi | float | (3) | Euler angles (in radians) necessary to rotate | -| | sEulerAngles | | | 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 | Sem | float | (3) | Semi-axis lengths (a, b, c) for best-fit | -| | iAxisLengths | | | 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 | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -References -========== - -[1] Representation and Reconstruction of Three-dimensional Microstructures in Ni-based Superalloys, AFOSR -FA9550-07-1-0179 Final Report, 20 Dec 2010. - -[2] On the use of moment invariants for the automated classifcation of 3-D particle shapes, J. MacSleyne, J.P. Simmons -and M. De Graef, Modeling and Simulations in Materials Science and Engineering, 16, 045008 (2008). - -[3] n-Dimensional Moment Invariants and Conceptual Mathematical Theory of Recognition n-Dimensional Solids, Alexander G. -Mamistvalov, IEEE TRANSACTIONS ON PATTERN ANALYSIS AND MACHINE INTELLIGENCE, VOL. 20, NO. 8, AUGUST 1998, p. 819-831. - -[4] M. Groeber, M. Uchic, D. Dimiduk, and S. Ghosh. A Framework for Automated Analysis and Simulation of 3D -Polycrystalline Microstructures, Part 1: Statistical Characterization Acta Materialia, 56 (2008), 1257-1273. - -Example Pipelines -================= - -- - - (1) SmallIN100 Morphological Statistics - -- - - (6) SmallIN100 Synthetic - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/OrientationAnalysis/docs/FindSlipTransmissionMetricsFilter.md b/src/Plugins/OrientationAnalysis/docs/FindSlipTransmissionMetricsFilter.md index eb3e6d98be..50d5b55d31 100644 --- a/src/Plugins/OrientationAnalysis/docs/FindSlipTransmissionMetricsFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/FindSlipTransmissionMetricsFilter.md @@ -1,10 +1,10 @@ -# Find Neighbor Slip Transmission Metrics # +# Find Neighbor Slip Transmission Metrics -## Group (Subgroup) ## +## Group (Subgroup) Statistics (Crystallographic) -## Description ## +## Description This **Filter** calculates a suite of *slip transmission metrics* that are related to the alignment of slip directions and planes across **Feature** boundaries. The algorithm for calculation of these metrics is as follows: @@ -17,35 +17,35 @@ 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 ## +## Parameters None -## Required Geometry ## +## Required Geometry Not Applicable -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | +| Ensemble Attribute Array | CrystalStructures | uint32 | (1) | Enumeration representing the crystal structure for each Ensemble | -## Created Objects ## +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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) | | -## Example Pipelines ## +## Example Pipelines -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/OrientationAnalysis/docs/FindSlipTransmissionMetricsFilter.rst b/src/Plugins/OrientationAnalysis/docs/FindSlipTransmissionMetricsFilter.rst deleted file mode 100644 index 6235d3bcc8..0000000000 --- a/src/Plugins/OrientationAnalysis/docs/FindSlipTransmissionMetricsFilter.rst +++ /dev/null @@ -1,82 +0,0 @@ -======================================= -Find Neighbor Slip Transmission Metrics -======================================= - - -Group (Subgroup) -================ - -Statistics (Crystallographic) - -Description -=========== - -This **Filter** calculates a suite of *slip transmission metrics* that are related to the alignment of slip directions -and planes across **Feature** boundaries. The algorithm for calculation of these metrics is as follows: - -1. Get the average orientation of the **Feature** -2. Get the **Feature**\ ’s list of neighboring **Features** -3. Get the average orientation of each neighboring **Feature** -4. Calculate metrics given by equations in *slip transmission metrics* -5. Store metrics in lists for the **Feature** -6. Repeat for all **Features** - -*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 | (1) | List of the contiguous neighboring **Features** | -| | | int32 | | 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 | Cryst | uint32 | (1) | Enumeration representing the crystal structure | -| | alStructures | | | 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) -======================= ============ ======= ========== =========== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/OrientationAnalysis/docs/FindTriangleGeomShapesFilter.md b/src/Plugins/OrientationAnalysis/docs/FindTriangleGeomShapesFilter.md index 0dee334e42..1598414046 100644 --- a/src/Plugins/OrientationAnalysis/docs/FindTriangleGeomShapesFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/FindTriangleGeomShapesFilter.md @@ -1,10 +1,10 @@ # Find Feature Shapes from Triangle Geometry -## Group (Subgroup) ## +## Group (Subgroup) Statistics (Morphological) -## Description ## +## Description This **Filter** calculates the second-order moments of each enclosed **Feature** in a **Triangle Geometry**. The second-order moments allow for the determination of the *principal axis lengths, principal axis directions, aspect @@ -30,15 +30,15 @@ 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 ## +## Parameters None -## Required Geometry ## +## Required Geometry Triangle -## Required Objects ## +## Required Objects | Kind | Default Name | Type | Comp Dims | Description | |-----------------------------|-----------------|--------------|-------------|--------------------------------------------------------------------| @@ -47,7 +47,7 @@ Triangle | 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 ## +## Created Objects | Kind | Default Name | Type | Comp Dims | Description | |-----------------------------|-----------------|-------|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -70,9 +70,9 @@ Mamistvalov, IEEE TRANSACTIONS ON PATTERN ANALYSIS AND MACHINE INTELLIGENCE, VOL [4] M. Groeber, M. Uchic, D. Dimiduk, and S. Ghosh. A Framework for Automated Analysis and Simulation of 3D Polycrystalline Microstructures, Part 1: Statistical Characterization Acta Materialia, 56 (2008), 1257-1273. -## Example Pipelines ## +## Example Pipelines -## License & Copyright ## +## License & Copyright Please see the description file distributed with this plugin. diff --git a/src/Plugins/OrientationAnalysis/docs/FindTriangleGeomShapesFilter.rst b/src/Plugins/OrientationAnalysis/docs/FindTriangleGeomShapesFilter.rst deleted file mode 100644 index 9a25b95371..0000000000 --- a/src/Plugins/OrientationAnalysis/docs/FindTriangleGeomShapesFilter.rst +++ /dev/null @@ -1,129 +0,0 @@ -========================================== -Find Feature Shapes from Triangle Geometry -========================================== - - -Group (Subgroup) -================ - -Statistics (Morphological) - -Description -=========== - -This **Filter** calculates the second-order moments of each enclosed **Feature** in a **Triangle Geometry**. The -second-order moments allow for the determination of the *principal axis lengths, principal axis directions, aspect -ratios and moment invariant Omega3s*. The *principal axis lengths* are those of a “best-fit” ellipsoid. The algorithm -for determining the moments and these values is as follows: - -1. For each **Triangle** on the bounding surface of a **Feature**, construct a tetrahedron whose fourth vertex is the - centroid of the **Feature**, ensuring normals are consistent (this **Filter** uses the convention where normals point - inwards; note that the actual winding of the **Triangle Geometry** is not modified) -2. Subdivide each constructed tetrahedron into 8 smaller tetrahedra -3. For each subdivided tetrahedron, compute the distance from that tetrahedron’s centroid to the centroid of the parent - **Feature** -4. For each subdivided tetrahedron, calculate Ixx, Iyy, Izz, Ixy, Ixz and Iyz using the x, y and z distances determined - in step 1 -5. Use the relationship of *principal moments* to the *principal axis lengths* for an ellipsoid, which can be found in - [4], to determine the *Axis Lengths* -6. Calculate the *Aspect Ratios* from the *Axis Lengths* found in step 5. -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 invariant Omega3 as defined in [2] and is discussed further in [1] and [3] - -*Note:* Due to the method used to subdivide the tetrahedra, some sharp corners of shapes may not be properly -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 | Type | Comp | Description | -| | Name | | Dims | | -+=======================+=============+==========+==========+========================================================+ -| Face Attribute | FaceLabels | int32_t | (2) | Specifies which **Features** are on either side of | -| Array*\* | | | | each **Face** | -+-----------------------+-------------+----------+----------+--------------------------------------------------------+ -| Feature Attribute | Centroids | float | (3) | Coordinates of the center of mass for a given enclosed | -| Array | | | | \**Feature | -+-----------------------+-------------+----------+----------+--------------------------------------------------------+ -| Feature Attribute | Volumes | float | (1) | Volume of the enclosed **Feature** | -| Array | | | | | -+-----------------------+-------------+----------+----------+--------------------------------------------------------+ -| Attribute Matrix*\* | Face | Face | N/A | Feature Attribute Matrix*\* of the selected \_Face | -| | FeatureData | Feature | | Labels | -+-----------------------+-------------+----------+----------+--------------------------------------------------------+ - -Created Objects -=============== - -+------------+------+---+-----+----------------------------------------------------------------------------------------+ -| Kind | Def | T | C | Description | -| | ault | y | omp | | -| | Name | p | D | | -| | | e | ims | | -+============+======+===+=====+========================================================================================+ -| Feature | Aspe | f | (2) | Ratio of axis lengths (b/a and c/a) for best-fit ellipsoid to enclosed **Feature** | -| Attribute | ctRa | l | | | -| Array | tios | o | | | -| | | a | | | -| | | t | | | -+------------+------+---+-----+----------------------------------------------------------------------------------------+ -| Feature | Axi | f | (3) | Euler angles (in radians) necessary to rotate the sample reference frame to the | -| Attribute | sEul | l | | reference frame of the enclosed **Feature**, where the principal axes of the best-fit | -| Array | erAn | o | | ellipsoid are (X, Y, Z) | -| | gles | a | | | -| | | t | | | -+------------+------+---+-----+----------------------------------------------------------------------------------------+ -| Feature | Axi | f | (3) | Axis lengths (a, b, c) for best-fit ellipsoid to enclosed **Feature** | -| Attribute | sLen | l | | | -| Array | gths | o | | | -| | | a | | | -| | | t | | | -+------------+------+---+-----+----------------------------------------------------------------------------------------+ -| Feature | Ome | f | (1) | 3rd invariant of the second-order moment matrix for the enclosed **Feature**, does not | -| Attribute | ga3s | l | | assume a shape type (i.e., ellipsoid) | -| Array | | o | | | -| | | a | | | -| | | t | | | -+------------+------+---+-----+----------------------------------------------------------------------------------------+ - -References -========== - -[1] Representation and Reconstruction of Three-dimensional Microstructures in Ni-based Superalloys, AFOSR -FA9550-07-1-0179 Final Report, 20 Dec 2010. - -[2] On the use of moment invariants for the automated classification of 3-D particle shapes, J. MacSleyne, J.P. Simmons -and M. De Graef, Modeling and Simulations in Materials Science and Engineering, 16, 045008 (2008). - -[3] n-Dimensional Moment Invariants and Conceptual Mathematical Theory of Recognition n-Dimensional Solids, Alexander G. -Mamistvalov, IEEE TRANSACTIONS ON PATTERN ANALYSIS AND MACHINE INTELLIGENCE, VOL. 20, NO. 8, AUGUST 1998, p. 819-831. - -[4] M. Groeber, M. Uchic, D. Dimiduk, and S. Ghosh. A Framework for Automated Analysis and Simulation of 3D -Polycrystalline Microstructures, Part 1: Statistical Characterization Acta Materialia, 56 (2008), 1257-1273. - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/OrientationAnalysis/docs/GenerateFZQuaternions.md b/src/Plugins/OrientationAnalysis/docs/GenerateFZQuaternions.md index 3b49419182..253eb05c4e 100644 --- a/src/Plugins/OrientationAnalysis/docs/GenerateFZQuaternions.md +++ b/src/Plugins/OrientationAnalysis/docs/GenerateFZQuaternions.md @@ -1,11 +1,11 @@ # GenerateFZQuaternions -## Group (Subgroup) ## +## Group (Subgroup) OrientationAnalysis (OrientationAnalysis) -## Description ## +## Description This **Filter** reduces input orientations (Quaternions) into the fundamental zone for the given Laue group. @@ -20,20 +20,20 @@ The following figures represent a BCC Interstitial steel EBSD data set courtesy | 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 ## +## 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 ## +## Required Geometry Not Applicable -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | @@ -57,24 +57,24 @@ Not Applicable | Trigonal_High | 10 | Trigonal-High -3m | | UnknownCrystalStructure | 999 | Undefined Crystal Structure | -## Created Objects ## +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | -## References ## +## References [1]: N. Allain-Bonasso, F. Wagner, S. Berbenni, D.P. Field, A study of the heterogeneity of plastic deformation in IF steel by EBSD, Materials Science and Engineering: A, Volume 548, 30 June 2012, Pages 56-63, ISSN 0921-5093, http://dx.doi.org/10.1016/j.msea.2012.03.068. (http://www.sciencedirect.com/science/article/pii/S0921509312004388) [2]: http://reference.iucr.org/dictionary/Laue_classes -## Example Pipelines ## +## Example Pipelines -## License & Copyright ## +## License & Copyright Please see the description file distributed with this plugin. diff --git a/src/Plugins/OrientationAnalysis/docs/GenerateFZQuaternions.rst b/src/Plugins/OrientationAnalysis/docs/GenerateFZQuaternions.rst deleted file mode 100644 index f6b0baf104..0000000000 --- a/src/Plugins/OrientationAnalysis/docs/GenerateFZQuaternions.rst +++ /dev/null @@ -1,114 +0,0 @@ -===================== -GenerateFZQuaternions -===================== - - -Group (Subgroup) -================ - -OrientationAnalysis (OrientationAnalysis) - -Description -=========== - -This **Filter** reduces input orientations (Quaternions) into the fundamental zone for the given Laue group. - -The following figures represent a BCC Interstitial steel EBSD data set courtesy of -`1 `__. - -+-----------------------------------------------------------+-----------------------------------------------------------+ -| |image1| | |image2| | -+-----------------------------------------------------------+-----------------------------------------------------------+ -| Original IPF Colored dataset | IPF Color Legend for m-3m Laue group | -+-----------------------------------------------------------+-----------------------------------------------------------+ -| |image3| | |image4| | -+-----------------------------------------------------------+-----------------------------------------------------------+ -| EBSD Dataset **before** the filter. IPF Colors are using | EBSD Dataset **after** the filter. IPF Colors are using a | -| a reference direction of < 001 >. The data is visualized | reference direction of < 001 >. The data is visualized in | -| in the 3D stereographic unit spheres with a superimposed | the 3D stereographic unit spheres with a superimposed | -| Rodrigues Fundamental Zone. | Rodrigues Fundamental Zone. | -+-----------------------------------------------------------+-----------------------------------------------------------+ - -Parameters -========== - -+---------------------------------------+---------------------------------------+---------------------------------------+ -| Name | Type | Description | -+=======================================+=======================================+=======================================+ -| Apply to Good Elements Only (Bad | bool | Whether to assign a black color to | -| Elements Will Be Black) | | “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 | Cryst | uint32_t | (1) | Enumeration representing the crystal structure | -| | alStructures | | | for each **Ensemble**. | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -**Crystal Structure Table** - -======================= ============== ================================ -String Name Internal Value Laue Name -======================= ============== ================================ -Hexagonal_High 0 Hexagonal-High 6/mmm -Cubic_High 1 Cubic Cubic-High m3m -Hexagonal_Low 2 Hexagonal-Low 6/m -Cubic_Low 3 Cubic Cubic-Low m3 (Tetrahedral) -Triclinic 4 Triclinic -1 -Monoclinic 5 Monoclinic 2/m -OrthoRhombic 6 Orthorhombic mmm -Tetragonal_Low 7 Tetragonal-Low 4/m -Tetragonal_High 8 Tetragonal-High 4/mmm -Trigonal_Low 9 Trigonal-Low -3 -Trigonal_High 10 Trigonal-High -3m -UnknownCrystalStructure 999 Undefined Crystal Structure -======================= ============== ================================ - -Created Objects -=============== - -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Kind | Default Name | Type | Comp. Dims | Description | -+=============================+==============+==========+============+=================================================+ -| Element Attribute Array | FZ | float | (4) | The Quaternion that represents an orientation | -| | Quaternions | | | within the fundamental zone for each \**Element | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -References -========== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. - -.. |image1| image:: Images/ReadH5Ebsd_Right.png -.. |image2| image:: Images/Cubic_m3m_IPFLegend.png -.. |image3| image:: Images/GenerateFZQuats_1.png -.. |image4| image:: Images/GenerateFZQuats_2.png diff --git a/src/Plugins/OrientationAnalysis/docs/GenerateFaceIPFColoringFilter.md b/src/Plugins/OrientationAnalysis/docs/GenerateFaceIPFColoringFilter.md index b28461e466..4f254be687 100644 --- a/src/Plugins/OrientationAnalysis/docs/GenerateFaceIPFColoringFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/GenerateFaceIPFColoringFilter.md @@ -1,11 +1,11 @@ # Generate IPF Colors (Face) -## Group (Subgroup) ## +## Group (Subgroup) Processing (Crystallography) -## Description ## +## Description This **Filter** generates a pair of colors for each **Triangle** in a **Triangle Geometry** based on the inverse pole figure (IPF) color scheme for the present crystal structure. Each **Triangle** has 2 colors since any **Face** sits at a boundary between 2 **Features** for a well-connected set of **Features** that represent _grains_. The reference direction used for the IPF color generation is the *normal* of the **Triangle**. @@ -15,36 +15,36 @@ This **Filter** generates a pair of colors for each **Triangle** in a **Triangle ------------ -## Parameters ## +## Parameters None -## Required Geometry ## +## Required Geometry Image + Triangle -## Required Objects ## +## 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 | +| 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 | +| Ensemble Attribute Array | CrystalStructures | uint32_t | (1) | Enumeration representing the crystal structure for each Ensemble | -## Created Objects ## +## 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 | +| 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 | -## Example Pipelines ## +## Example Pipelines + (03) SmallIN100 Mesh Statistics -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/OrientationAnalysis/docs/GenerateFaceIPFColoringFilter.rst b/src/Plugins/OrientationAnalysis/docs/GenerateFaceIPFColoringFilter.rst deleted file mode 100644 index 21ac955860..0000000000 --- a/src/Plugins/OrientationAnalysis/docs/GenerateFaceIPFColoringFilter.rst +++ /dev/null @@ -1,85 +0,0 @@ -========================== -Generate IPF Colors (Face) -========================== - - -Group (Subgroup) -================ - -Processing (Crystallography) - -Description -=========== - -This **Filter** generates a pair of colors for each **Triangle** in a **Triangle Geometry** based on the inverse pole -figure (IPF) color scheme for the present crystal structure. Each **Triangle** has 2 colors since any **Face** sits at a -boundary between 2 **Features** for a well-connected set of **Features** that represent *grains*. The reference -direction used for the IPF color generation is the *normal* of the **Triangle**. - --------------- - -.. figure:: Images/GenerateFaceIPFColoring.png - :alt: Face IPF Coloring - - Face IPF Coloring - --------------- - -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 | Av | float | (3) | Three angles defining the orientation of the | -| | gEulerAngles | | | **Feature** in Bunge convention (Z-X-Z) | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Feature Attribute Array | Phases | int32_t | (1) | Specifies to which phase each **Feature** | -| | | | | belongs | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Ensemble Attribute Array | Cryst | uint32_t | (1) | Enumeration representing the crystal structure | -| | alStructures | | | 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 | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Example Pipelines -================= - -- - - (3) SmallIN100 Mesh Statistics - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/OrientationAnalysis/docs/GenerateFaceMisorientationColoringFilter.md b/src/Plugins/OrientationAnalysis/docs/GenerateFaceMisorientationColoringFilter.md index e4ff150242..90e4645905 100644 --- a/src/Plugins/OrientationAnalysis/docs/GenerateFaceMisorientationColoringFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/GenerateFaceMisorientationColoringFilter.md @@ -1,44 +1,44 @@ # Generate Misorientation Colors (Face) -## Group (Subgroup) ## +## Group (Subgroup) Processing (Crystallography) -## Description ## +## Description 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 ## +## Parameters None -## Required Geometry ## +## Required Geometry Image + Triangle -## Required Objects ## +## 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 | +| 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 | +| Ensemble Attribute Array | CrystalStructures | uint32_t | (1) | Enumeration representing the crystal structure for each Ensemble | -## Created Objects ## +## 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 | +| 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 | -## Example Pipelines ## +## Example Pipelines + (03) SmallIN100 Mesh Statistics -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/OrientationAnalysis/docs/GenerateFaceMisorientationColoringFilter.rst b/src/Plugins/OrientationAnalysis/docs/GenerateFaceMisorientationColoringFilter.rst deleted file mode 100644 index 97f070c4dc..0000000000 --- a/src/Plugins/OrientationAnalysis/docs/GenerateFaceMisorientationColoringFilter.rst +++ /dev/null @@ -1,73 +0,0 @@ -===================================== -Generate Misorientation Colors (Face) -===================================== - - -Group (Subgroup) -================ - -Processing (Crystallography) - -Description -=========== - -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 | Cryst | uint32_t | (1) | Enumeration representing the crystal structure | -| | alStructures | | | for each \**Ensemble | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Created Objects -=============== - -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Kind | Default Name | Type | Comp. Dims | Description | -+=============================+==============+==========+============+=================================================+ -| Face Attribute Array | Misorien | float | (3) | A set of RGB color schemes encoded as floats | -| | tationColors | | | for each \**Face | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Example Pipelines -================= - -- - - (3) SmallIN100 Mesh Statistics - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/OrientationAnalysis/docs/GenerateGBCDPoleFigureFilter.md b/src/Plugins/OrientationAnalysis/docs/GenerateGBCDPoleFigureFilter.md index 6232b198fd..8ea9498da4 100644 --- a/src/Plugins/OrientationAnalysis/docs/GenerateGBCDPoleFigureFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/GenerateGBCDPoleFigureFilter.md @@ -1,42 +1,38 @@ # Generate GBCD Pole Figure -## Group (Subgroup) ## +## Group (Subgroup) IO (Output) -## Description ## +## Description This **Filter** creates a pole figure from the Grain Boundary Character Distribution (GBCD) data. The user must select the relevant phase for which to generate the pole figure by entering the *phase index*. ------ - ![Regular Grid Visualization of the Small IN100 GBCD results](Images/Small_IN00_GBCD_RegularGrid.png) ![Using ParaView's Threshold filter + Cells to Points + Delaunay2D Filters](Images/Small_IN100_GBCD_Delaunay2D.png) ------ - -## Parameters ## +## 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 ## +## Required Geometry Triangle -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 ## +## Created Objects | Kind | Default Name | Description | |------|--------------|-------------| @@ -44,11 +40,11 @@ Triangle | 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 | -## Example Pipelines ## +## Example Pipelines + (04) SmallIN100 GBCD -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/OrientationAnalysis/docs/GenerateGBCDPoleFigureFilter.rst b/src/Plugins/OrientationAnalysis/docs/GenerateGBCDPoleFigureFilter.rst deleted file mode 100644 index 9da7a9695e..0000000000 --- a/src/Plugins/OrientationAnalysis/docs/GenerateGBCDPoleFigureFilter.rst +++ /dev/null @@ -1,98 +0,0 @@ -========================= -Generate GBCD Pole Figure -========================= - - -Group (Subgroup) -================ - -IO (Output) - -Description -=========== - -This **Filter** creates a pole figure from the Grain Boundary Character Distribution (GBCD) data. The user must select -the relevant phase for which to generate the pole figure by entering the *phase index*. - --------------- - -.. figure:: Images/Small_IN00_GBCD_RegularGrid.png - :alt: Regular Grid Visualization of the Small IN100 GBCD results - - Regular Grid Visualization of the Small IN100 GBCD results - -.. figure:: Images/Small_IN100_GBCD_Delaunay2D.png - :alt: Using ParaView’s Threshold filter + Cells to Points + Delaunay2D Filters - - Using ParaView’s Threshold filter + Cells to Points + Delaunay2D Filters - --------------- - -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, | 5 parameter GBCD data. The 6th component is | -| | | | m,l,o,q,r) | used internally to track the northern | -| | | | | vs. southern hemisphere of the Lambert sphere | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Crystal Structure | Cryst | Enu | 1 | Crystal structure for GBCD. Currently supports | -| | alStructures | meration | | 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 | Cell Data | The name of the cell attribute matrix | -| Matrix | | created for the Image Geometry | -+--------------------+-------------------------------------------------+----------------------------------------------+ -| Cell Intensity | Intensity | The data array to be created from the pole | -| Array | | figures and stored in the Image Geometry | -| | | cell attribute matrix | -+--------------------+-------------------------------------------------+----------------------------------------------+ - -Example Pipelines -================= - -- - - (4) SmallIN100 GBCD - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/OrientationAnalysis/docs/GenerateIPFColorsFilter.md b/src/Plugins/OrientationAnalysis/docs/GenerateIPFColorsFilter.md index 10ff0924c0..a7a6919686 100644 --- a/src/Plugins/OrientationAnalysis/docs/GenerateIPFColorsFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/GenerateIPFColorsFilter.md @@ -1,15 +1,15 @@ # Generate IPF Colors -## Group (Subgroup) ## +## Group (Subgroup) Processing (Crystallography) -## Description ## +## Description This **Filter** will generate *inverse pole figure* (IPF) colors for cubic, hexagonal or trigonal crystal structures. The user can enter the *Reference Direction*, which defaults to [001]. The **Filter** also has the option to apply a black color to all "bad" **Elements**, as defined by a boolean *mask* array, which can be generated using the Threshold Objects **Filter**. -### Originating Data Notes ### +### Originating Data Notes + TSL (.ang file) - If the data originates from a TSL .ang file, then **Elements** that the TSL software could not reliably identify the Euler angles for will have a "Fit of Solution" = 180 and/or an "Image Quality" = 0.0. @@ -19,43 +19,37 @@ This **Filter** will generate *inverse pole figure* (IPF) colors for cubic, hexa - This means that when the user runs some sort of threshold **Filter** the *mask* will be those **Elements** that have an Error = 0 ------ - ![IPF Color Triangle](Images/IPFFilterLegend.png) ------ - ![Example Data Set](Images/IPFColor_1.png) ------ - -## Parameters ## +## 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 ## +## Required Geometry Not Applicable -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | +| Ensemble Data Array | Crystal Structures | uint32 | (1) | Enumeration representing the crystal structure for each Ensemble | -## Created Objects ## +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| Kind | Default Name | Type | Comp Dims | Description | +|---------------------------|--------------|----------|--------|---------------------------------------------| | Element Data Array | IPFColor | uint8 | (3) | The RGB colors encoded as unsigned chars for each **Element | -## Example Pipelines ## +## Example Pipelines + (10) SmallIN100 Full Reconstruction + (04) SmallIN100 Presegmentation Processing @@ -72,7 +66,7 @@ Not Applicable + (03) SmallIN100 Alignment + (06) SmallIN100 Synthetic -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/OrientationAnalysis/docs/GenerateIPFColorsFilter.rst b/src/Plugins/OrientationAnalysis/docs/GenerateIPFColorsFilter.rst deleted file mode 100644 index c3db7d770d..0000000000 --- a/src/Plugins/OrientationAnalysis/docs/GenerateIPFColorsFilter.rst +++ /dev/null @@ -1,154 +0,0 @@ -=================== -Generate IPF Colors -=================== - - -Group (Subgroup) -================ - -Processing (Crystallography) - -Description -=========== - -This **Filter** will generate *inverse pole figure* (IPF) colors for cubic, hexagonal or trigonal crystal structures. -The user can enter the *Reference Direction*, which defaults to [001]. The **Filter** also has the option to apply a -black color to all “bad” **Elements**, as defined by a boolean *mask* array, which can be generated using the Threshold -Objects **Filter**. - -Originating Data Notes ----------------------- - -- TSL (.ang file) - - - If the data originates from a TSL .ang file, then **Elements** that the TSL software could not reliably identify - the Euler angles for will have a “Fit of Solution” = 180 and/or an “Image Quality” = 0.0. - - This means that when the user runs some sort of threshold **Filter** the *mask* will be those **Elements** that - have an Image Quality > 0 and/or Fit < 180.0 - -- HKL (.ctf file) - - - If the data originates from an HKL (or Bruker) system (.ctf file) then bad voxels can typically be found by - setting “Error” > 0 - - This means that when the user runs some sort of threshold **Filter** the *mask* will be those **Elements** that - have an Error = 0 - --------------- - -.. figure:: Images/IPFFilterLegend.png - :alt: IPF Color Triangle - - IPF Color Triangle - --------------- - -.. figure:: Images/IPFColor_1.png - :alt: Example Data Set - - Example Data Set - --------------- - -Parameters -========== - -+------------------------------+------------------------------+--------------------------------------------------------+ -| Name | Type | Description | -+==============================+==============================+========================================================+ -| Reference Direction | float (3x) | The reference axis with respect to compute the IPF | -| | | colors | -+------------------------------+------------------------------+--------------------------------------------------------+ -| Apply to Good Elements Only | bool | Whether to assign a black color to “bad” \**Elements | -| (Bad Elements Will Be Black) | | | -+------------------------------+------------------------------+--------------------------------------------------------+ - -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 | uint32 | (1) | Enumeration representing the crystal structure | -| | Structures | | | 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 -================== ============ ===== ========== ============================================================ - -Example Pipelines -================= - -- - - (10) SmallIN100 Full Reconstruction - -- - - (4) SmallIN100 Presegmentation Processing - -- - - (2) Single Hexagonal Phase Equiaxed - -- - - (3) Single Cubic Phase Rolled - -- INL Export - -- TxCopper_Exposed - -- TxCopper_Unexposed - -- MassifPipeline - -- InsertTransformationPhase - -- Edax IPF Colors - -- - - (1) Single Cubic Phase Equiaxed - -- - - (4) Two Phase Cubic Hexagonal Particles Equiaxed - -- - - (3) SmallIN100 Alignment - -- - - (6) SmallIN100 Synthetic - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/OrientationAnalysis/docs/GeneratePoleFigureFilter.md b/src/Plugins/OrientationAnalysis/docs/GeneratePoleFigureFilter.md index 6cdecabfa6..b8cfd9e720 100644 --- a/src/Plugins/OrientationAnalysis/docs/GeneratePoleFigureFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/GeneratePoleFigureFilter.md @@ -8,25 +8,21 @@ IO (Output) This **Filter** creates a standard pole figure image for each **Ensemble** in a selected **Data Container** with an **Image Geometry**. The **Filter** uses Euler angles in radians and requires the crystal structures for each **Ensemble** array and the corresponding **Ensemble** Ids on the **Cells**. The **Filter** also requires a *mask* array to determine which **Cells** are valid for the pole figure computation. -### Algorithm Choice ### +### Algorithm Choice 1: The pole figure algorithm uses a *modified Lambert square* to perform the interpolations onto the circle. This is an alternate type of interpolation that the EBSD OEMs do not perform which may make the output from DREAM.3D look slightly different than output obtained from the OEM programs. **Only an advanced user with intimate knowledge of the modified Lambert projection should attempt to change the value for the "Lambert Image Size (Pixels)" input parameter.** 2: Discrete Pole Figure ------ - | Lambert Projection | Discrete | |-----|--------| | ![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 | -|------|------| ----------- | +|------------|------| --------------------------------- | | Pole Figure Type | Enumeration: 0=Lambert, 1=Discrete | Controls the type of pole figure | | Image Format | Enumeration | Image file format to write. Currently supports .tif, .bmp, and .png file formats | | Lambert Image Size (Pixels) | int32_t | Size of the Lambert square in pixels | @@ -43,12 +39,12 @@ NONE ## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | +| Ensemble Attribute Array | CrystalStructures | uint32_t | (1) | Enumeration representing the crystal structure for each Ensemble | ## Created Objects diff --git a/src/Plugins/OrientationAnalysis/docs/GeneratePoleFigureFilter.rst b/src/Plugins/OrientationAnalysis/docs/GeneratePoleFigureFilter.rst deleted file mode 100644 index cabcf68691..0000000000 --- a/src/Plugins/OrientationAnalysis/docs/GeneratePoleFigureFilter.rst +++ /dev/null @@ -1,117 +0,0 @@ -========================= -Export Pole Figure Images -========================= - - -Group (Subgroup) -================ - -IO (Output) - -Description -=========== - -This **Filter** creates a standard pole figure image for each **Ensemble** in a selected **Data Container** with an -**Image Geometry**. The **Filter** uses Euler angles in radians and requires the crystal structures for each -**Ensemble** array and the corresponding **Ensemble** Ids on the **Cells**. The **Filter** also requires a *mask* array -to determine which **Cells** are valid for the pole figure computation. - -Algorithm Choice ----------------- - -1: The pole figure algorithm uses a *modified Lambert square* to perform the interpolations onto the circle. This is an -alternate type of interpolation that the EBSD OEMs do not perform which may make the output from DREAM.3D look slightly -different than output obtained from the OEM programs. - -**Only an advanced user with intimate knowledge of the modified Lambert projection should attempt to change the value -for the “Lambert Image Size (Pixels)” input parameter.** - -2: Discrete Pole Figure - --------------- - -+---------------------------------------------+------------------------------------------------------------------------+ -| Lambert Projection | Discrete | -+=============================================+========================================================================+ -| |Example Pole Figure Using Square Layout| | |image1| | -+---------------------------------------------+------------------------------------------------------------------------+ - --------------- - -Parameters -========== - -+------------------------------+------------------------------+--------------------------------------------------------+ -| Name | Type | Description | -+==============================+==============================+========================================================+ -| Pole Figure Type | Enumeration: 0=Lambert, | Controls the type of pole figure | -| | 1=Discrete | | -+------------------------------+------------------------------+--------------------------------------------------------+ -| Image Format | Enumeration | Image file format to write. Currently supports .tif, | -| | | .bmp, and .png file formats | -+------------------------------+------------------------------+--------------------------------------------------------+ -| 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. | -+------------------------------+------------------------------+--------------------------------------------------------+ - -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 | Cryst | uint32_t | (1) | Enumeration representing the crystal structure | -| | alStructures | | | for each \**Ensemble | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Created Objects -=============== - -None - -Example Pipelines -================= - -- TxCopper_Exposed -- TxCopper_Unexposed - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. - -.. |Example Pole Figure Using Square Layout| image:: Images/PoleFigure_Example.png -.. |image1| image:: Images/Pole_Figure_Discrete_Example.png diff --git a/src/Plugins/OrientationAnalysis/docs/GenerateQuaternionConjugateFilter.md b/src/Plugins/OrientationAnalysis/docs/GenerateQuaternionConjugateFilter.md index 24218891fc..74c0903a4c 100644 --- a/src/Plugins/OrientationAnalysis/docs/GenerateQuaternionConjugateFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/GenerateQuaternionConjugateFilter.md @@ -1,10 +1,10 @@ # Generate Quaternion Conjugate -## Group (Subgroup) ## +## Group (Subgroup) Processing (OrientationAnalysis) -## Description ## +## Description This filter will generate the transpose of a [1x4] *Quaternion* laid out in memory such that < x, y, z >, w. This can be handy when the user wants to convert the orientation transformation to an opposite effect. The algorihtm will calculate @@ -15,31 +15,31 @@ 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 ## +## Parameters -| Name | Type | Description | -|-----------------------|---------|---------------------------------------------------------------------------------------------------| +| 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 Not Applicable -## Required Objects ## +## Required Objects | Kind | Default Name | Type | Comp Dims | Description | |---------------------|------------------|-------|-------------|-------------| | Attribute Array | Quaternion Input | float | (4) | | -## Created Objects ## +## Created Objects | Kind | Default Name | Type | Comp Dims | Description | |---------------------|------------------|-------|-------------|-------------| | Attribute Array | Quaternion Ouput | float | (4) | | -## Example Pipelines ## +## Example Pipelines -## License & Copyright ## +## License & Copyright Please see the description file distributed with this plugin. diff --git a/src/Plugins/OrientationAnalysis/docs/GenerateQuaternionConjugateFilter.rst b/src/Plugins/OrientationAnalysis/docs/GenerateQuaternionConjugateFilter.rst deleted file mode 100644 index c4eaa649ac..0000000000 --- a/src/Plugins/OrientationAnalysis/docs/GenerateQuaternionConjugateFilter.rst +++ /dev/null @@ -1,68 +0,0 @@ -============================= -Generate Quaternion Conjugate -============================= - - -Group (Subgroup) -================ - -Processing (OrientationAnalysis) - -Description -=========== - -This filter will generate the transpose of a [1x4] *Quaternion* laid out in memory such that < x, y, z >, w. This can be -handy when the user wants to convert the orientation transformation to an opposite effect. The algorihtm will calculate -the conjugate of each quaternion in the array of input quaternions - -**NOTES**: Internally DREAM.3D assumes that the internal reference transformation is a **Sample to Crystal** -transformation. If the incoming data was collected in such a way that the orientation representation that is stored ( -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 | Bo | Set this to TRUE/ON to have the original 3 component data array deleted at the end of | -| Array | olean | 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) -=============== ================ ===== ========= =========== - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/OrientationAnalysis/docs/INLWriterFilter.md b/src/Plugins/OrientationAnalysis/docs/INLWriterFilter.md index 2c039243bf..8518ab1326 100644 --- a/src/Plugins/OrientationAnalysis/docs/INLWriterFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/INLWriterFilter.md @@ -1,10 +1,10 @@ -# Export INL File # +# Export INL File -## Group (Subgroup) ## +## Group (Subgroup) IO (Output) -## Description ## +## Description This **Filter** writes out **Cell** data from an **Image Geometry** to a file format used by the Idaho National Laboratory (INL). The format is columnar and space delimited, with header lines denoted by the "#" character. The columns are the following: @@ -20,7 +20,7 @@ This **Filter** writes out **Cell** data from an **Image Geometry** to a file fo Some information about the phase is included in the header section of the file in addition to values for the origin, step size, dimensions and number of **Features** in the file. -## Example Output ## +## Example Output # File written from DREAM3DLib Version 5.2.1789.6419a8d # DateTime: Fri Jun 19 10:13:25 2015 @@ -64,36 +64,36 @@ 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 ## +## Parameters | Name | Type | Description | -|------|------|-------------| +|------------|------| --------------------------------- | | Output File | File Path | The output .inl file path | -## Required Geometry ## +## Required Geometry Image -## Required Objects ## +## Required Objects -| Kind | Default Name |Type | Comp Dims | Description | -|------|--------------|-------------|---------|-----| +| 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 | +| 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 ## +## Created Objects None -## Example Pipelines ## +## Example Pipelines - INL Export -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/OrientationAnalysis/docs/INLWriterFilter.rst b/src/Plugins/OrientationAnalysis/docs/INLWriterFilter.rst deleted file mode 100644 index 29949ba249..0000000000 --- a/src/Plugins/OrientationAnalysis/docs/INLWriterFilter.rst +++ /dev/null @@ -1,172 +0,0 @@ -=============== -Export INL File -=============== - - -Group (Subgroup) -================ - -IO (Output) - -Description -=========== - -This **Filter** writes out **Cell** data from an **Image Geometry** to a file format used by the Idaho National -Laboratory (INL). The format is columnar and space delimited, with header lines denoted by the “#” character. The -columns are the following: - -- phi1 -- Phi -- phi2 -- x Position (Microns) -- y Position (Microns) -- z Position (Microns) -- Feature Id -- Phase Id -- Symmetry - -Some information about the phase is included in the header section of the file in addition to values for the origin, -step size, dimensions and number of **Features** in the file. - -Example Output -============== - -:: - - # File written from DREAM3DLib Version 5.2.1789.6419a8d - # DateTime: Fri Jun 19 10:13:25 2015 - # X_STEP: 0.250000 - # Y_STEP: 0.250000 - # Z_STEP: 0.250000 - # - - # X_MIN: -36.750004 - # Y_MIN: 10.250000 - # Z_MIN: -29.000000 - # - - # X_MAX: -11.750004 - # Y_MAX: 35.250000 - # Z_MAX: -4.000000 - # - - # X_DIM: 100 - # Y_DIM: 100 - # Z_DIM: 100 - # - - # Phase_1: Nickel - # Symmetry_1: 43 - # Features_1: 796 - # - - # Num_Features: 796 - # - - # phi1 PHI phi2 x y z FeatureId PhaseId Symmetry - 0.266984 0.696910 4.434039 -36.750004 10.250000 -29.000000 639 1 43 - 0.266984 0.696910 4.434039 -36.500004 10.250000 -29.000000 639 1 43 - 0.266984 0.696910 4.434039 -36.250004 10.250000 -29.000000 639 1 43 - 0.266984 0.696910 4.434039 -36.000004 10.250000 -29.000000 639 1 43 - 0.267274 0.697210 4.432979 -35.750004 10.250000 -29.000000 639 1 43 - 0.266984 0.696910 4.434039 -35.500004 10.250000 -29.000000 639 1 43 - 0.266984 0.696910 4.434039 -35.250004 10.250000 -29.000000 639 1 43 - 0.266984 0.696910 4.434039 -35.000004 10.250000 -29.000000 639 1 43 - 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 | De | -| | | | | scription | -+==============+==================================+================================+=====================+===========+ -| Cell | FeatureIds | int32 | (1) | Specifies | -| Attribute | | | | to which | -| Array | | | | ** | -| | | | | Feature** | -| | | | | each | -| | | | | **Cell** | -| | | | | belongs | -+--------------+----------------------------------+--------------------------------+---------------------+-----------+ -| Cell | Phases | int32 | (1) | Specifies | -| Attribute | | | | to which | -| Array | | | | **E | -| | | | | nsemble** | -| | | | | each | -| | | | | **Cell** | -| | | | | belongs | -+--------------+----------------------------------+--------------------------------+---------------------+-----------+ -| Cell | EulerAngles | float32 | (3) | Three | -| Attribute | | | | angles | -| Array | | | | defining | -| | | | | the | -| | | | | or | -| | | | | ientation | -| | | | | of the | -| | | | | **Cell** | -| | | | | in Bunge | -| | | | | c | -| | | | | onvention | -| | | | | (Z-X-Z) | -+--------------+----------------------------------+--------------------------------+---------------------+-----------+ -| Ensemble | CrystalStructures | uint32 | (1) | En | -| Attribute | | | | umeration | -| Array | | | | rep | -| | | | | resenting | -| | | | | the | -| | | | | crystal | -| | | | | structure | -| | | | | for each | -| | | | | \* | -| | | | | *Ensemble | -+--------------+----------------------------------+--------------------------------+---------------------+-----------+ -| Ensemble | Material Names | String | (1) | Name of | -| Attribute | | | | each | -| Array | | | | \* | -| | | | | *Ensemble | -+--------------+----------------------------------+--------------------------------+---------------------+-----------+ -| Ensemble | Number of Features | int32 | (1) | The | -| Attribute | | | | number of | -| Array | | | | **F | -| | | | | eatures** | -| | | | | per | -| | | | | \* | -| | | | | *Ensemble | -+--------------+----------------------------------+--------------------------------+---------------------+-----------+ - -Created Objects -=============== - -None - -Example Pipelines -================= - -- INL Export - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/OrientationAnalysis/docs/ImportH5EspritDataFilter.md b/src/Plugins/OrientationAnalysis/docs/ImportH5EspritDataFilter.md index 253a26869a..43f810c456 100644 --- a/src/Plugins/OrientationAnalysis/docs/ImportH5EspritDataFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/ImportH5EspritDataFilter.md @@ -5,9 +5,9 @@ Import/Export (Import) -## Description +## Description -This **Filter** will read a single .h5 file into a new **Image Geometry**, allowing the immediate use of **Filters** on the data instead of having to generate the intermediate .h5ebsd file. A **Cell Attribute Matrix** and **Ensemble Attribute Matrix** will also be created to hold the imported EBSD information. Currently, the user has no control over the names of the created **Attribute Arrays**. +This **Filter** will read a single .h5 file into a new **Image Geometry**, allowing the immediate use of **Filters** on the data instead of having to generate the intermediate .h5ebsd file. A **Cell Attribute Matrix** and Ensemble Attribute Matrix** will also be created to hold the imported EBSD information. Currently, the user has no control over the names of the created **Attribute Arrays**. | User interface before entering a proper "Z Spacing" value and selecting which scans to include. | |-------| @@ -23,20 +23,20 @@ This **Filter** will read a single .h5 file into a new **Image Geometry**, allow The user should be aware that simply reading the file then performing operations that are dependent on the proper crystallographic and sample reference frame will be undefined or simply **wrong**. In order to bring the crystal reference frame and sample reference frame into coincidence, rotations will need to be applied to the data. The recommended filters are: -+ [Rotate Euler Reference Frame](../RotateEulerRefFrameFilter/index.html) -+ [Rotate Sample Reference Frame](../RotateSampleRefFrameFilter/index.html) ++ {ref}`Rotate Euler Reference Frame ` ++ {ref}`Rotate Sample Reference Frame ` If the data has come from a TSL acquisition system and the settings of the acquisition software were in the default modes, the following reference frame transformations may need to be performed based on the version of the OIM Analysis software being used to collect the data: + Sample Reference Frame: 180o about the <010> Axis + Crystal Reference Frame: 90o about the <001> Axis -The user also may want to assign un-indexed pixels to be ignored by flagging them as "bad". The [Threshold Objects](../MultiThresholdObjects/index.html) **Filter** can be used to define this *mask* by thresholding on values such as *MAD* > xx. +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 +## 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. | @@ -49,15 +49,15 @@ The user also may want to assign un-indexed pixels to be ignored by flagging the Not Applicable -## Required Objects +## Required Objects None -## Created Objects +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | @@ -66,8 +66,8 @@ None 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 | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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) | | @@ -90,18 +90,18 @@ These arrays will **most likely** be created but is not guaranteed. Additional a 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 | +| 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 | +| Ensemble Attribute Array | MaterialName | String | (1) | Name of each Ensemble | -## Example Pipelines +## Example Pipelines -## License & Copyright +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/OrientationAnalysis/docs/ImportH5EspritDataFilter.rst b/src/Plugins/OrientationAnalysis/docs/ImportH5EspritDataFilter.rst deleted file mode 100644 index 8f5ea27d1e..0000000000 --- a/src/Plugins/OrientationAnalysis/docs/ImportH5EspritDataFilter.rst +++ /dev/null @@ -1,180 +0,0 @@ -========================================= -Import Bruker Nano Esprit EBSD Data (.h5) -========================================= - - -Group (Subgroup) -================ - -Import/Export (Import) - -Description -=========== - -This **Filter** will read a single .h5 file into a new **Image Geometry**, allowing the immediate use of **Filters** on -the data instead of having to generate the intermediate .h5ebsd file. A **Cell Attribute Matrix** and **Ensemble -Attribute Matrix** will also be created to hold the imported EBSD information. Currently, the user has no control over -the names of the created **Attribute Arrays**. - -+-------------------------------------------------------------------------------------------------+ -| User interface before entering a proper “Z Spacing” value and selecting which scans to include. | -+=================================================================================================+ -| |image1| | -+-------------------------------------------------------------------------------------------------+ - -+-------------------------------------------------------------------+ -| User interface AFTER setting the “Z Spacing” and selecting files. | -+===================================================================+ -| |image2| | -+-------------------------------------------------------------------+ - -Notes About Reference Frames -============================ - -The user should be aware that simply reading the file then performing operations that are dependent on the proper -crystallographic and sample reference frame will be undefined or simply **wrong**. In order to bring the crystal -reference frame and sample reference frame into coincidence, rotations will need to be applied to the data. The -recommended filters are: - -- `Rotate Euler Reference Frame <../RotateEulerRefFrameFilter/index.html>`__ -- `Rotate Sample Reference Frame <../RotateSampleRefFrameFilter/index.html>`__ - -If the data has come from a TSL acquisition system and the settings of the acquisition software were in the default -modes, the following reference frame transformations may need to be performed based on the version of the OIM Analysis -software being used to collect the data: - -- Sample Reference Frame: 180o about the <010> Axis -- Crystal Reference Frame: 90o about the <001> Axis - -The user also may want to assign un-indexed pixels to be ignored by flagging them as “bad”. The `Threshold -Objects <../MultiThresholdObjects/index.html>`__ **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 | bool | Default=ON | -| Attribute Array | | | -+--------------------------------------------------+-------------+--------------------------------------------------+ -| 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 | N | int | (1) | | -| | IndexedBands | | | | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| 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 | Ra | int | (1) | | -| | donBandCount | | | | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| 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 | Cryst | uint32_t | (1) | Enumeration representing the crystal structure | -| | alStructures | | | for each \**Ensemble | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Ensemble Attribute Array | Latt | float | (6) | The 6 values that define the lattice constants | -| | iceConstants | | | for each **Ensemble** | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Ensemble Attribute Array | MaterialName | String | (1) | Name of each \**Ensemble | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. - -.. |image1| image:: Images/ReadEspritH5_1.png -.. |image2| image:: Images/ReadEspritH5_2.png diff --git a/src/Plugins/OrientationAnalysis/docs/ImportH5OimDataFilter.md b/src/Plugins/OrientationAnalysis/docs/ImportH5OimDataFilter.md index 6cde3c29a6..6ad5fba033 100644 --- a/src/Plugins/OrientationAnalysis/docs/ImportH5OimDataFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/ImportH5OimDataFilter.md @@ -7,7 +7,7 @@ Import/Export (Import) ## Description -This **Filter** will read a single .h5 file into a new **Image Geometry**, allowing the immediate use of **Filters** on the data instead of having to generate the intermediate .h5ebsd file. A **Cell Attribute Matrix** and **Ensemble Attribute Matrix** will also be created to hold the imported EBSD information. Currently, the user has no control over the names of the created **Attribute Arrays**. +This **Filter** will read a single .h5 file into a new **Image Geometry**, allowing the immediate use of **Filters** on the data instead of having to generate the intermediate .h5ebsd file. A **Cell Attribute Matrix** and Ensemble Attribute Matrix** will also be created to hold the imported EBSD information. Currently, the user has no control over the names of the created **Attribute Arrays**. | User interface before entering a proper "Z Spacing" value and selecting which scans to include. | |-------| @@ -23,20 +23,20 @@ This **Filter** will read a single .h5 file into a new **Image Geometry**, allow The user should be aware that simply reading the file then performing operations that are dependent on the proper crystallographic and sample reference frame will be undefined or simply **wrong**. In order to bring the crystal reference frame and sample reference frame into coincidence, rotations will need to be applied to the data. The recommended filters are: -+ [Rotate Euler Reference Frame](../RotateEulerRefFrameFilter/index.html) -+ [Rotate Sample Reference Frame](../RotateSampleRefFrameFilter/index.html) ++ {ref}`Rotate Euler Reference Frame ` ++ {ref}`Rotate Sample Reference Frame ` If the data has come from a TSL acquisition system and the settings of the acquisition software were in the default modes, the following reference frame transformations may need to be performed based on the version of the OIM Analysis software being used to collect the data: + Sample Reference Frame: 180o about the <010> Axis + Crystal Reference Frame: 90o about the <001> Axis -The user also may want to assign un-indexed pixels to be ignored by flagging them as "bad". The [Threshold Objects](../MultiThresholdObjects/index.html) **Filter** can be used to define this *mask* by thresholding on values such as *Confidence Index* > xx or *Image Quality* > desired quality. +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. | @@ -54,8 +54,8 @@ None ## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | @@ -64,8 +64,8 @@ None 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 | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | @@ -81,19 +81,19 @@ These arrays will **most likely** be created but is not guaranteed. Additional a 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 | +| 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 | +| Ensemble Attribute Array | MaterialName | String | (1) | Name of each Ensemble | -## Example Pipelines +## Example Pipelines -## License & Copyright +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/OrientationAnalysis/docs/ImportH5OimDataFilter.rst b/src/Plugins/OrientationAnalysis/docs/ImportH5OimDataFilter.rst deleted file mode 100644 index eadb1c1bf9..0000000000 --- a/src/Plugins/OrientationAnalysis/docs/ImportH5OimDataFilter.rst +++ /dev/null @@ -1,155 +0,0 @@ -=========================== -Import EDAX EBSD Data (.h5) -=========================== - - -Group (Subgroup) -================ - -Import/Export (Import) - -Description -=========== - -This **Filter** will read a single .h5 file into a new **Image Geometry**, allowing the immediate use of **Filters** on -the data instead of having to generate the intermediate .h5ebsd file. A **Cell Attribute Matrix** and **Ensemble -Attribute Matrix** will also be created to hold the imported EBSD information. Currently, the user has no control over -the names of the created **Attribute Arrays**. - -+-------------------------------------------------------------------------------------------------+ -| User interface before entering a proper “Z Spacing” value and selecting which scans to include. | -+=================================================================================================+ -| |image1| | -+-------------------------------------------------------------------------------------------------+ - -+-------------------------------------------------------------------+ -| User interface AFTER setting the “Z Spacing” and selecting files. | -+===================================================================+ -| |image2| | -+-------------------------------------------------------------------+ - -Notes About Reference Frames -============================ - -The user should be aware that simply reading the file then performing operations that are dependent on the proper -crystallographic and sample reference frame will be undefined or simply **wrong**. In order to bring the crystal -reference frame and sample reference frame into coincidence, rotations will need to be applied to the data. The -recommended filters are: - -- `Rotate Euler Reference Frame <../RotateEulerRefFrameFilter/index.html>`__ -- `Rotate Sample Reference Frame <../RotateSampleRefFrameFilter/index.html>`__ - -If the data has come from a TSL acquisition system and the settings of the acquisition software were in the default -modes, the following reference frame transformations may need to be performed based on the version of the OIM Analysis -software being used to collect the data: - -- Sample Reference Frame: 180o about the <010> Axis -- Crystal Reference Frame: 90o about the <001> Axis - -The user also may want to assign un-indexed pixels to be ignored by flagging them as “bad”. The `Threshold -Objects <../MultiThresholdObjects/index.html>`__ **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 | float | (1) | Confidence of indexing | -| | Index | | | | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| 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 | float | (1) | Quality of image | -| | Quality | | | | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| 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 | Cryst | uint32_t | (1) | Enumeration representing the crystal structure | -| | alStructures | | | for each \**Ensemble | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Ensemble Attribute Array | Latt | float | (6) | The 6 values that define the lattice constants | -| | iceConstants | | | for each **Ensemble** | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Ensemble Attribute Array | MaterialName | String | (1) | Name of each \**Ensemble | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Example Pipelines -================= - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. - -.. |image1| image:: Images/ReadEDAXH5_1.png -.. |image2| image:: Images/ReadEDAXH5_2.png diff --git a/src/Plugins/OrientationAnalysis/docs/MergeTwinsFilter.md b/src/Plugins/OrientationAnalysis/docs/MergeTwinsFilter.md index 678f7bedf4..2fd5fcd2bd 100644 --- a/src/Plugins/OrientationAnalysis/docs/MergeTwinsFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/MergeTwinsFilter.md @@ -1,55 +1,54 @@ -# Merge Twins +# Merge Twins - -## Group (Subgroup) ## +## Group (Subgroup) Reconstruction (Grouping) -## Description ## +## Description *THIS FILTER ONLY WORKS ON CUBIC-HIGH (m3m) Laue Classes.* 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 ## +## 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 ## +## Required Geometry Not Applicable -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | +| Ensemble Attribute Array | CrystalStructures | uint32_t | (1) | Enumeration representing the crystal structure for each Ensemble | -## Created Objects ## +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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* | -## Example Pipelines ## +## Example Pipelines + (10) SmallIN100 Full Reconstruction + (06) SmallIN100 Postsegmentation Processing -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/OrientationAnalysis/docs/MergeTwinsFilter.rst b/src/Plugins/OrientationAnalysis/docs/MergeTwinsFilter.rst deleted file mode 100644 index 94a3e8a61b..0000000000 --- a/src/Plugins/OrientationAnalysis/docs/MergeTwinsFilter.rst +++ /dev/null @@ -1,110 +0,0 @@ -=========== -Merge Twins -=========== - - -Group (Subgroup) -================ - -Reconstruction (Grouping) - -Description -=========== - -*THIS FILTER ONLY WORKS ON CUBIC-HIGH (m3m) Laue Classes.* - -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 | NonContigu | List of | (1) | List of non-contiguous neighbors for each | -| | ousNeighbors | int32_t | | **Feature**. Only needed if *Use Non-Contiguous | -| | | | | Neighbors* is checked | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Feature Attribute Array | NeighborList | List of | (1) | List of neighbors for each \**Feature | -| | | int32_t | | | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| 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 | Cryst | uint32_t | (1) | Enumeration representing the crystal structure | -| | alStructures | | | 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 | Ne | Feature | N/A | Created **Feature Attribute Matrix** name | -| | wFeatureData | | | | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| 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* | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Example Pipelines -================= - -- - - (10) SmallIN100 Full Reconstruction - -- - - (6) SmallIN100 Postsegmentation Processing - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/OrientationAnalysis/docs/NeighborOrientationCorrelationFilter.md b/src/Plugins/OrientationAnalysis/docs/NeighborOrientationCorrelationFilter.md index 025c7911d9..8af83a2168 100644 --- a/src/Plugins/OrientationAnalysis/docs/NeighborOrientationCorrelationFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/NeighborOrientationCorrelationFilter.md @@ -1,10 +1,10 @@ # Neighbor Orientation Correlation -## Group (Subgroup) ## +## Group (Subgroup) Processing (Cleanup) -## Description ## +## Description This **Filter** first identifies all **Cells** that have a *confidence index* below the minimum set by the user. Then, for each of those **Cells**, their neighboring **Cells** are checked to determine the number of neighbor **Cells** with orientations different than the reference **Cell** by more than the user defined *misorientation tolerance*. In addition the neighboring **Cells** are compared with each other to determine the number of neighboring **Cells** that have the same orientation (again within the user defined tolerance). The *Cleanup Level* set by the user is then used to determine which **Cells** are replaced. If a level of 5 is set, then at least 5 of the neighboring **Cells** must be different than the reference **Cell** and at least 5 of the neighboring **Cells** must be the same as each other (and so on for other *Cleanup Level*). If a **Cell** meets the replacement criteria, then all of its attributes are replaced with the attributes of one of the neighboring **Cells** that are the same as each other. @@ -13,7 +13,7 @@ This **Filter** first identifies all **Cells** that have a *confidence index* be Neighbors are defined as a the "nearest neighbors" which share a "face". For 3D structures it is 6 neighbors that share a common face with the current cell. -### Example ### +### Example | | 0 | 1 | 2 | |---|---|---|---| @@ -25,40 +25,40 @@ 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 ## +## 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 ## +## Required Geometry Image -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | +| Ensemble Attribute Array | Crystal Structures | uint32 | (1) | Enumeration representing the crystal structure for each Ensemble | -## Created Objects ## +## Created Objects None -## Example Pipelines ## +## Example Pipelines + (10) SmallIN100 Full Reconstruction + (04) SmallIN100 Presegmentation Processing + INL Export + 04_Steiner Compact -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/OrientationAnalysis/docs/NeighborOrientationCorrelationFilter.rst b/src/Plugins/OrientationAnalysis/docs/NeighborOrientationCorrelationFilter.rst deleted file mode 100644 index 3b90d7e4fd..0000000000 --- a/src/Plugins/OrientationAnalysis/docs/NeighborOrientationCorrelationFilter.rst +++ /dev/null @@ -1,117 +0,0 @@ -================================ -Neighbor Orientation Correlation -================================ - - -Group (Subgroup) -================ - -Processing (Cleanup) - -Description -=========== - -This **Filter** first identifies all **Cells** that have a *confidence index* below the minimum set by the user. Then, -for each of those **Cells**, their neighboring **Cells** are checked to determine the number of neighbor **Cells** with -orientations different than the reference **Cell** by more than the user defined *misorientation tolerance*. In addition -the neighboring **Cells** are compared with each other to determine the number of neighboring **Cells** that have the -same orientation (again within the user defined tolerance). The *Cleanup Level* set by the user is then used to -determine which **Cells** are replaced. If a level of 5 is set, then at least 5 of the neighboring **Cells** must be -different than the reference **Cell** and at least 5 of the neighboring **Cells** must be the same as each other (and so -on for other *Cleanup Level*). If a **Cell** meets the replacement criteria, then all of its attributes are replaced -with the attributes of one of the neighboring **Cells** that are the same as each other. - -*Note:* The **Filter** will iteratively reduce the *Cleanup Level* from 6 until it reaches the user defined number. So, -if the user selects a level of 4, then the **Filter** will run with a level of 6, then 5, then 4 before finishing. - -Neighbors are defined as a the “nearest neighbors” which share a “face”. For 3D structures it is 6 neighbors that share -a common face with the current cell. - -Example -------- - -== ======================= ======================= ======================= -\ 0 1 2 -== ======================= ======================= ======================= -0 (14.0, 0.0, 0.0) CI=0.2 -1 (13.0, 0.0, 0.0) CI=0.2 (0.0, 0.0, 0.0) CI=0.05 (12.0, 0.0, 0.0) CI=0.2 -2 (15.0, 0.0, 0.0) CI=0.2 -== ======================= ======================= ======================= - -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 | Float32 | Angular tolerance used to compare with neighboring \**Cells | -| (Degrees) | | | -+---------------------------+---------------------------+-------------------------------------------------------------+ -| 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 | float32 | (1) | Specifies the confidence in the orientation of | -| | Index | | | 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 | uint32 | (1) | Enumeration representing the crystal structure | -| | Structures | | | for each \**Ensemble | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Created Objects -=============== - -None - -Example Pipelines -================= - -- - - (10) SmallIN100 Full Reconstruction - -- - - (4) SmallIN100 Presegmentation Processing - -- INL Export - -- 04_Steiner Compact - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/OrientationAnalysis/docs/ReadAngDataFilter.md b/src/Plugins/OrientationAnalysis/docs/ReadAngDataFilter.md index 0eaea19c95..f61c84d143 100644 --- a/src/Plugins/OrientationAnalysis/docs/ReadAngDataFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/ReadAngDataFilter.md @@ -1,15 +1,14 @@ -# Import EDAX EBSD Data (.ang) +# Import EDAX EBSD Data (.ang) - -## Group (Subgroup) ## +## Group (Subgroup) IO (Input) -## Description ## +## Description -This **Filter** will read a single .ang file into a new **Image Geometry**, allowing the immediate use of **Filters** on the data instead of having to generate the intermediate .h5ebsd file. A **Cell Attribute Matrix** and **Ensemble Attribute Matrix** will also be created to hold the imported EBSD information. Currently, the user has no control over the names of the created **Attribute Arrays**. The user should be aware that simply reading the file then performing operations that are dependent on the proper crystallographic and sample reference frame will be undefined or simply **wrong**. In order to bring the crystal reference frame and sample reference frame into coincidence, rotations will need to be applied to the data. +This **Filter** will read a single .ang file into a new **Image Geometry**, allowing the immediate use of **Filters** on the data instead of having to generate the intermediate .h5ebsd file. A **Cell Attribute Matrix** and Ensemble Attribute Matrix** will also be created to hold the imported EBSD information. Currently, the user has no control over the names of the created **Attribute Arrays**. The user should be aware that simply reading the file then performing operations that are dependent on the proper crystallographic and sample reference frame will be undefined or simply **wrong**. In order to bring the crystal reference frame and sample reference frame into coincidence, rotations will need to be applied to the data. -### Default TSL Transformations ### +### Default TSL Transformations If the data has come from a TSL acquisition system and the settings of the acquisition software were in the default modes, he following reference frame transformations may need to be performed based on the version of the OIM Analysis software being used to collect the data: @@ -18,23 +17,24 @@ 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 ## +## Parameters | Name | Type | Description | -|------|------| ----------- | +|------------|------| --------------------------------- | | Input File | File Path | The input .ang file path | -## Required Geometry ## +## Required Geometry Not Applicable -## Required Objects ## +## Required Objects None -## Created Objects ## -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +## 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 | @@ -46,23 +46,21 @@ None | 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 | 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 | +| Ensemble Attribute Array | MaterialName | String | (1) | Name of each Ensemble | -## Example Pipelines ## +## Example Pipelines + INL Export + Export Small IN100 ODF Data (StatsGenerator) + Edax IPF Colors + Confidence Index Histogram -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** ## DREAM3DNX 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. - - diff --git a/src/Plugins/OrientationAnalysis/docs/ReadAngDataFilter.rst b/src/Plugins/OrientationAnalysis/docs/ReadAngDataFilter.rst deleted file mode 100644 index 79e7ba6001..0000000000 --- a/src/Plugins/OrientationAnalysis/docs/ReadAngDataFilter.rst +++ /dev/null @@ -1,114 +0,0 @@ -============================ -Import EDAX EBSD Data (.ang) -============================ - - -Group (Subgroup) -================ - -IO (Input) - -Description -=========== - -This **Filter** will read a single .ang file into a new **Image Geometry**, allowing the immediate use of **Filters** on -the data instead of having to generate the intermediate .h5ebsd file. A **Cell Attribute Matrix** and **Ensemble -Attribute Matrix** will also be created to hold the imported EBSD information. Currently, the user has no control over -the names of the created **Attribute Arrays**. The user should be aware that simply reading the file then performing -operations that are dependent on the proper crystallographic and sample reference frame will be undefined or simply -**wrong**. In order to bring the crystal reference frame and sample reference frame into coincidence, rotations will -need to be applied to the data. - -Default TSL Transformations ---------------------------- - -If the data has come from a TSL acquisition system and the settings of the acquisition software were in the default -modes, he following reference frame transformations may need to be performed based on the version of the OIM Analysis -software being used to collect the data: - -- Sample Reference Frame: 180o about the <010> Axis -- Crystal Reference Frame: 90o about the <001> Axis - -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 | ImageD | N/A | N/A | Created **Data Container** name with an | -| | ataContainer | | | \**Image Geometry | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Attribute Matrix*\* | CellData | Cell | N/A | Created **Cell Attribute Matrix** name | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Attribute Matrix*\* | Cell | Cell | N/A | Created **Cell Ensemble Attribute Matrix** name | -| | EnsembleData | Ensemble | | | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Cell Attribute Array | Confidence | float | (1) | Confidence of indexing | -| | Index | | | | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| 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 | float | (1) | Quality of image | -| | Quality | | | | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| 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 | Cryst | uint32_t | (1) | Enumeration representing the crystal structure | -| | alStructures | | | for each \**Ensemble | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Ensemble Attribute Array | Latt | float | (6) | The 6 values that define the lattice constants | -| | iceConstants | | | for each **Ensemble** | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Ensemble Attribute Array | MaterialName | String | (1) | Name of each \**Ensemble | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Example Pipelines -================= - -- INL Export -- Export Small IN100 ODF Data (StatsGenerator) -- Edax IPF Colors -- Confidence Index Histogram - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/OrientationAnalysis/docs/ReadCtfDataFilter.md b/src/Plugins/OrientationAnalysis/docs/ReadCtfDataFilter.md index ebe8e64bb8..845bd1dd7f 100644 --- a/src/Plugins/OrientationAnalysis/docs/ReadCtfDataFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/ReadCtfDataFilter.md @@ -1,16 +1,15 @@ -# Import Oxford Instr. Ebsd Data +# Import Oxford Instr. Ebsd Data - -## Group (Subgroup) ## +## Group (Subgroup) IO (Input) -## Description ## +## Description -This **Filter** will read a single .ctf file into a new **Image Geometry**, allowing the immediate use of **Filters** on the data instead of having to generate the intermediate .h5ebsd file. A **Cell Attribute Matrix** and **Ensemble Attribute Matrix** will also be created to hold the imported EBSD information. Currently, the user has no control over the names of the created **Attribute Arrays**. The user should be aware that simply reading the file then performing operations that are dependent on the proper crystallographic and sample reference frame will be **undefined, inaccurate and/or wrong**. In order to bring the crystal reference frame and sample reference frame into coincidence, rotations will need to be applied to the data. An excellant reference for this is the following PDF file: +This **Filter** will read a single .ctf file into a new **Image Geometry**, allowing the immediate use of **Filters** on the data instead of having to generate the intermediate .h5ebsd file. A **Cell Attribute Matrix** and Ensemble Attribute Matrix** will also be created to hold the imported EBSD information. Currently, the user has no control over the names of the created **Attribute Arrays**. The user should be aware that simply reading the file then performing operations that are dependent on the proper crystallographic and sample reference frame will be **undefined, inaccurate and/or wrong**. In order to bring the crystal reference frame and sample reference frame into coincidence, rotations will need to be applied to the data. An excellant reference for this is the following PDF file: [http://pajarito.materials.cmu.edu/rollett/27750/L17-EBSD-analysis-31Mar16.pdf](http://pajarito.materials.cmu.edu/rollett/27750/L17-EBSD-analysis-31Mar16.pdf) -### Default HKL Transformations ### +### Default HKL Transformations If the data has come from a HKL acquisition system and the settings of the acquisition software were in the default modes, then the following reference frame transformations need to be performed: @@ -19,11 +18,11 @@ If the data has come from a HKL 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 *Error* = 0. -### Radians and Degrees ### +### Radians and Degrees Most 2D .ctf files have their angles in **degrees** where as DREAM.3D expects radians. The filter provides an option to convert the Euler Angles to Radians and is turned on by default. The user is encouraged to create an IPF Image of their EBSD data to ensure that they do in-fact need to have this option enabled. -### The Axis Alignment Issue for Hexagonal Symmetry [1] ### +### The Axis Alignment Issue for Hexagonal Symmetry [1] + The issue with hexagonal materials is the alignment of the Cartesian coordinate system used for calculations with the crystal coordinate system (the Bravais lattice). + In one convention (e.g. EDAX.TSL), the x-axis, i.e. [1,0,0], is aligned with the crystal a1 axis, i.e. the [2,-1,-1,0] direction. In this case, the y-axis is aligned with the [0,1,-1,0] direction. (Green Axis in Figure 1) @@ -32,33 +31,33 @@ Most 2D .ctf files have their angles in **degrees** where as DREAM.3D expects ra + Caution: it appears that the axis alignment is a choice that must be made when installing TSL software so determination of which convention is in use must be made on a case-by-case basis. It is fixed to the y-convention in the HKL software. + The main clue that something is wrong in a conversion is that either the 2110 & 1010 pole figures are transposed, or that a peak in the inverse pole figure that should be present at 2110 has shifted over to 1010. + DREAM.3D uses the TSL/EDAX convention. -+ __The result of this is that the filter will by default add 30 degrees to the second Euler Angle (phi2) when reading Oxford Instr (.ctf) files. This can be disabled by the user if necessary.__ ++ **The result of this is that the filter will by default add 30 degrees to the second Euler Angle (phi2) when reading Oxford Instr (.ctf) files. This can be disabled by the user if necessary.** | Figure 1 | |--------| | ![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 | +| Figure 1:**showing TSL and Oxford Instr. conventions. EDAX/TSL is in **Green**. Oxford Inst. is in**Red | -## Parameters ## +## 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 ## +## Required Geometry Not Applicable -## Required Objects ## +## Required Objects None -## Created Objects ## +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | @@ -71,25 +70,23 @@ None | 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 | 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 | +| Ensemble Attribute Array | MaterialName | String | (1) | Name of each Ensemble | -## Example Pipelines ## +## Example Pipelines + TxCopper_Exposed + TxCopper_Unexposed -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** -## References ## +## References [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 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. - - diff --git a/src/Plugins/OrientationAnalysis/docs/ReadCtfDataFilter.rst b/src/Plugins/OrientationAnalysis/docs/ReadCtfDataFilter.rst deleted file mode 100644 index f8e8107044..0000000000 --- a/src/Plugins/OrientationAnalysis/docs/ReadCtfDataFilter.rst +++ /dev/null @@ -1,162 +0,0 @@ -============================== -Import Oxford Instr. Ebsd Data -============================== - - -Group (Subgroup) -================ - -IO (Input) - -Description -=========== - -This **Filter** will read a single .ctf file into a new **Image Geometry**, allowing the immediate use of **Filters** on -the data instead of having to generate the intermediate .h5ebsd file. A **Cell Attribute Matrix** and **Ensemble -Attribute Matrix** will also be created to hold the imported EBSD information. Currently, the user has no control over -the names of the created **Attribute Arrays**. The user should be aware that simply reading the file then performing -operations that are dependent on the proper crystallographic and sample reference frame will be **undefined, inaccurate -and/or wrong**. In order to bring the crystal reference frame and sample reference frame into coincidence, rotations -will need to be applied to the data. An excellant reference for this is the following PDF file: -http://pajarito.materials.cmu.edu/rollett/27750/L17-EBSD-analysis-31Mar16.pdf - -Default HKL Transformations ---------------------------- - -If the data has come from a HKL acquisition system and the settings of the acquisition software were in the default -modes, then the following reference frame transformations need to be performed: - -- Sample Reference Frame: 180o about the <010> Axis -- Crystal Reference Frame: None - -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 *Error* = 0. - -Radians and Degrees -------------------- - -Most 2D .ctf files have their angles in **degrees** where as DREAM.3D expects radians. The filter provides an option to -convert the Euler Angles to Radians and is turned on by default. The user is encouraged to create an IPF Image of their -EBSD data to ensure that they do in-fact need to have this option enabled. - -The Axis Alignment Issue for Hexagonal Symmetry [1] ---------------------------------------------------- - -- The issue with hexagonal materials is the alignment of the Cartesian coordinate system used for calculations with the - crystal coordinate system (the Bravais lattice). -- In one convention (e.g. EDAX.TSL), the x-axis, i.e. [1,0,0], is aligned with the crystal a1 axis, i.e. the - [2,-1,-1,0] direction. In this case, the y-axis is aligned with the [0,1,-1,0] direction. (Green Axis in Figure 1) -- In the other convention, (e.g. Oxford Instr, Univ. Metz software), the x-axis, i.e. [1,0,0], is aligned with the - crystal [1,0,-1,0] direction. In this case, the y-axis is aligned with the [-1,2,-1,0] direction. (Red Axis in Figure - 1) -- This is important because texture analysis can lead to an ambiguity as to the alignment of [2,-1,-1,0] versus - [1,0,-1,0], with apparent **30 Degree** shifts in the data. -- Caution: it appears that the axis alignment is a choice that must be made when installing TSL software so - determination of which convention is in use must be made on a case-by-case basis. It is fixed to the y-convention in - the HKL software. -- The main clue that something is wrong in a conversion is that either the 2110 & 1010 pole figures are transposed, or - that a peak in the inverse pole figure that should be present at 2110 has shifted over to 1010. -- DREAM.3D uses the TSL/EDAX convention. -- **The result of this is that the filter will by default add 30 degrees to the second Euler Angle (phi2) when reading - Oxford Instr (.ctf) files. This can be disabled by the user if necessary.** - -+--------------------------------------------------------------------------------------------------------------+ -| Figure 1 | -+==============================================================================================================+ -| |Figure showing 30 Degree conversions| | -+--------------------------------------------------------------------------------------------------------------+ -| 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 | ImageD | N/A | N/A | Created **Data Container** name with an | -| | ataContainer | | | \**Image Geometry | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Attribute Matrix*\* | CellData | Cell | N/A | Created **Cell Attribute Matrix** name | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Attribute Matrix*\* | Cell | Cell | N/A | Created **Cell Ensemble Attribute Matrix** name | -| | EnsembleData | Ensemble | | | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| 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 | Cryst | uint32_t | (1) | Enumeration representing the crystal structure | -| | alStructures | | | for each \**Ensemble | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Ensemble Attribute Array | Latt | float | (6) | The 6 values that define the lattice constants | -| | iceConstants | | | for each **Ensemble** | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ -| Ensemble Attribute Array | MaterialName | String | (1) | Name of each \**Ensemble | -+-----------------------------+--------------+----------+------------+-------------------------------------------------+ - -Example Pipelines -================= - -- TxCopper_Exposed -- TxCopper_Unexposed - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -References -========== - -[1] Rollett, A.D. Lecture Slides located at -http://pajarito.materials.cmu.edu/rollett/27750/L17-EBSD-analysis-31Mar16.pdf - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. - -.. |Figure showing 30 Degree conversions| image:: Images/Hexagonal_Axis_Alignment.png diff --git a/src/Plugins/OrientationAnalysis/docs/ReadH5EbsdFilter.md b/src/Plugins/OrientationAnalysis/docs/ReadH5EbsdFilter.md index 70225eb669..b1572c7df8 100644 --- a/src/Plugins/OrientationAnalysis/docs/ReadH5EbsdFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/ReadH5EbsdFilter.md @@ -1,26 +1,21 @@ # ReadH5Ebsd -## Group (Subgroup) ## +## Group (Subgroup) IO (Input) -## Description ## +## Description -This **Filter** reads from the .h5ebsd file that was generated with the *Import Orientation File(s) to H5EBSD* **Filter**. - ------ +This **Filter** reads from the .h5ebsd file that was generated with the *Import Orientation File(s) to H5EBSD* **Filter**. ![Read H5Ebsd File User Interface](Images/ReadH5Ebsd_UI.png) ------ - - + The user can use the checkboxes under the *Data Arrays to Read* section to select which specific data arrays they are interested in importing. + The user can select a subset of the slices if they do not wish to import the entire volume. + The type of transformations that are recommended based on the manufacturer of the data are also listed with a checkbox that allows the user to toggle the recommended transformations on and off. + The user should select the Euler angle representation. (This is **only** available if the **Use Recommended Transformations** is turned **on**.) -### Notes About Transformations ### +### Notes About Transformations The **user** is solely responsible for knowing any sample reference frame transformations, crystal reference frame transformations and how the Euler angles are represented in the file. DREAM.3D provides historically correct transformations from a few of the EBSD manufacturers under the assumption that the EBSD instrument has been setup according to their guidelines. The **user** is strongly encouraged to discuss these topics with the person(s) who were responsible for collecting the data. For example the IPF images presented below were generated from an H5Ebsd file that was generated using a CTF file. The difference is that the **Incorrect** image did not correctly select the **Angle Representation** combo box on the filter's user interface. The Euler angles were actually in degrees but were treated as if the values were in radians. The correct image is on the right. @@ -33,30 +28,29 @@ If the user does not want the **Read H5Ebsd** filter to perform any transformati An excellant reference for this is the following PDF file: [http://pajarito.materials.cmu.edu/rollett/27750/L17-EBSD-analysis-31Mar16.pdf](http://pajarito.materials.cmu.edu/rollett/27750/L17-EBSD-analysis-31Mar16.pdf) - | Incorrect | Correct | |---------|---------| |![Read H5Ebsd File User Interface](Images/ReadH5Ebsd_Wrong.png) | ![Read H5Ebsd File User Interface](Images/ReadH5Ebsd_Right.png) | | Euler angles were treated as Radians | Euler angles were converted from Degrees to Radians | |"Interstitial Free (IF) Steel courtesy of [1]"| | -### The Axis Alignment Issue for Hexagonal Symmetry [2] ### +### The Axis Alignment Issue for Hexagonal Symmetry [2] + The issue with hexagonal materials is the alignment of the Cartesian coordinate system used for calculations with the crystal coordinate system (the Bravais lattice). + In one convention (e.g. EDAX.TSL), the x-axis, i.e. [1,0,0], is aligned with the crystal a1 axis, i.e. the [2,-1,-1,0] direction. In this case, the y-axis is aligned with the [0,1,-1,0] direction. (Green Axis in Figure 1) + In the other convention, (e.g. Oxford Instr, Univ. Metz software), the x-axis, i.e. [1,0,0], is aligned with the crystal [1,0,-1,0] direction. In this case, the y-axis is aligned with the [-1,2,-1,0] direction. (Red Axis in Figure 1) -+ This is important because texture analysis can lead to an ambiguity as to the alignment of [2,-1,-1,0] versus [1,0,-1,0], with apparent **30 ** shifts in the data. ++ This is important because texture analysis can lead to an ambiguity as to the alignment of [2,-1,-1,0] versus [1,0,-1,0], with apparent **30** shifts in the data. + Caution: it appears that the axis alignment is a choice that must be made when installing TSL software so determination of which convention is in use must be made on a case-by-case basis. It is fixed to the y-convention in the HKL software. + The main clue that something is wrong in a conversion is that either the 2110 & 1010 pole figures are transposed, or that a peak in the inverse pole figure that should be present at 2110 has shifted over to 1010. + DREAM.3D uses the TSL/EDAX convention. -+ **The result of this is that the filter will *AUTOMATICALLY* add 30 to phi2 when reading Oxford Instr (.ctf) files or .h5ebsd files denoted with the HKL manufacturer ID. There is no way to turn off this behavior. ** ++ **The result of this is that the filter will *AUTOMATICALLY* add 30 to phi2 when reading Oxford Instr (.ctf) files or .h5ebsd files denoted with the HKL manufacturer ID. There is no way to turn off this behavior.** ![Figure 1 showing TSL \& Oxford Instr. conventions.](Images/Hexagonal_Axis_Alignment.png) -## Parameters ## +## 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 | @@ -64,25 +58,25 @@ An excellant reference for this is the following PDF file: | 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 ## +## Required Geometry Not Applicable -## Required Objects ## +## Required Objects None -## Created Objects ## +## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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. -## Example Pipelines ## +## Example Pipelines + 02_Adaptive Alignment - Misorientation - Zero Shifts + (10) SmallIN100 Full Reconstruction @@ -91,20 +85,17 @@ An array for each of the arrays selected in the *Data Arrays to Read* section wi + (02) SmallIN100 Initial Visualization + (03) SmallIN100 Alignment -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** -## References ## +## References -[1] N. Allain-Bonasso, F. Wagner, S. Berbenni, D.P. Field, A study of the heterogeneity of plastic deformation in IF steel by EBSD, Materials Science and Engineering: A, Volume 548, 30 June 2012, Pages 56-63, ISSN 0921-5093, http://dx.doi.org/10.1016/j.msea.2012.03.068. -(http://www.sciencedirect.com/science/article/pii/S0921509312004388) +[1] N. Allain-Bonasso, F. Wagner, S. Berbenni, D.P. Field, A study of the heterogeneity of plastic deformation in IF steel by EBSD, Materials Science and Engineering: A, Volume 548, 30 June 2012, Pages 56-63, ISSN 0921-5093, . +() [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 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. - - diff --git a/src/Plugins/OrientationAnalysis/docs/ReadH5EbsdFilter.rst b/src/Plugins/OrientationAnalysis/docs/ReadH5EbsdFilter.rst deleted file mode 100644 index 7cf3dc9bf4..0000000000 --- a/src/Plugins/OrientationAnalysis/docs/ReadH5EbsdFilter.rst +++ /dev/null @@ -1,173 +0,0 @@ -========== -ReadH5Ebsd -========== - - -Group (Subgroup) -================ - -IO (Input) - -Description -=========== - -This **Filter** reads from the .h5ebsd file that was generated with the *Import Orientation File(s) to H5EBSD* -**Filter**. - --------------- - -.. figure:: Images/ReadH5Ebsd_UI.png - :alt: Read H5Ebsd File User Interface - - Read H5Ebsd File User Interface - --------------- - -- The user can use the checkboxes under the *Data Arrays to Read* section to select which specific data arrays they are - interested in importing. -- The user can select a subset of the slices if they do not wish to import the entire volume. -- The type of transformations that are recommended based on the manufacturer of the data are also listed with a - checkbox that allows the user to toggle the recommended transformations on and off. -- The user should select the Euler angle representation. (This is **only** available if the **Use Recommended - Transformations** is turned **on**.) - -Notes About Transformations ---------------------------- - -The **user** is solely responsible for knowing any sample reference frame transformations, crystal reference frame -transformations and how the Euler angles are represented in the file. DREAM.3D provides historically correct -transformations from a few of the EBSD manufacturers under the assumption that the EBSD instrument has been setup -according to their guidelines. The **user** is strongly encouraged to discuss these topics with the person(s) who were -responsible for collecting the data. For example the IPF images presented below were generated from an H5Ebsd file that -was generated using a CTF file. The difference is that the **Incorrect** image did not correctly select the **Angle -Representation** combo box on the filter’s user interface. The Euler angles were actually in degrees but were treated as -if the values were in radians. The correct image is on the right. - -If the user does not want the **Read H5Ebsd** filter to perform any transformations then the checkbox can be unchecked -and the user can manually perform any desired transformations by inserting the appropriate filters into the pipeline. -The suggested filters are: - -- `Rotate Euler Reference Frame `__ -- `Rotate Sample Reference Frame `__ -- `Convert Angles to Degrees or Radians `__ - -An excellant reference for this is the following PDF file: -http://pajarito.materials.cmu.edu/rollett/27750/L17-EBSD-analysis-31Mar16.pdf - -+-----------------------------------------------------------+-----------------------------------------------------------+ -| Incorrect | Correct | -+===========================================================+===========================================================+ -| |Read H5Ebsd File User Interface| | |image1| | -+-----------------------------------------------------------+-----------------------------------------------------------+ -| Euler angles were treated as Radians | Euler angles were converted from Degrees to Radians | -+-----------------------------------------------------------+-----------------------------------------------------------+ -| “Interstitial Free (IF) Steel courtesy of [1]” | | -+-----------------------------------------------------------+-----------------------------------------------------------+ - -The Axis Alignment Issue for Hexagonal Symmetry [2] ---------------------------------------------------- - -- The issue with hexagonal materials is the alignment of the Cartesian coordinate system used for calculations with the - crystal coordinate system (the Bravais lattice). -- In one convention (e.g. EDAX.TSL), the x-axis, i.e. [1,0,0], is aligned with the crystal a1 axis, i.e. the - [2,-1,-1,0] direction. In this case, the y-axis is aligned with the [0,1,-1,0] direction. (Green Axis in Figure 1) -- In the other convention, (e.g. Oxford Instr, Univ. Metz software), the x-axis, i.e. [1,0,0], is aligned with the - crystal [1,0,-1,0] direction. In this case, the y-axis is aligned with the [-1,2,-1,0] direction. (Red Axis in Figure - 1) -- This is important because texture analysis can lead to an ambiguity as to the alignment of [2,-1,-1,0] versus - [1,0,-1,0], with apparent **30** shifts in the data. -- Caution: it appears that the axis alignment is a choice that must be made when installing TSL software so - determination of which convention is in use must be made on a case-by-case basis. It is fixed to the y-convention in - the HKL software. -- The main clue that something is wrong in a conversion is that either the 2110 & 1010 pole figures are transposed, or - that a peak in the inverse pole figure that should be present at 2110 has shifted over to 1010. -- DREAM.3D uses the TSL/EDAX convention. -- **The result of this is that the filter will AUTOMATICALLY add 30 to phi2 when reading Oxford Instr (.ctf) files or - .h5ebsd files denoted with the HKL manufacturer ID. There is no way to turn off this behavior.** - -.. figure:: Images/Hexagonal_Axis_Alignment.png - :alt: Figure 1 showing TSL & Oxford Instr. conventions. - - Figure 1 showing TSL & Oxford Instr. conventions. - -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. - -Example Pipelines -================= - -- 02_Adaptive Alignment - Misorientation - Zero Shifts - -- - - (10) SmallIN100 Full Reconstruction - -- 03_Adaptive Alignment - Mutual Information - SEM Images - -- 04_Steiner Compact - -- - - (2) SmallIN100 Initial Visualization - -- - - (3) SmallIN100 Alignment - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -References -========== - -[1] N. Allain-Bonasso, F. Wagner, S. Berbenni, D.P. Field, A study of the heterogeneity of plastic deformation in IF -steel by EBSD, Materials Science and Engineering: A, Volume 548, 30 June 2012, Pages 56-63, ISSN 0921-5093, -http://dx.doi.org/10.1016/j.msea.2012.03.068. (http://www.sciencedirect.com/science/article/pii/S0921509312004388) - -[2] Rollett, A.D. Lecture Slides located at -http://pajarito.materials.cmu.edu/rollett/27750/L17-EBSD-analysis-31Mar16.pdf - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. - -.. |Read H5Ebsd File User Interface| image:: Images/ReadH5Ebsd_Wrong.png -.. |image1| image:: Images/ReadH5Ebsd_Right.png diff --git a/src/Plugins/OrientationAnalysis/docs/RodriguesConvertorFilter.md b/src/Plugins/OrientationAnalysis/docs/RodriguesConvertorFilter.md index 817e28c918..353bcda19d 100644 --- a/src/Plugins/OrientationAnalysis/docs/RodriguesConvertorFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/RodriguesConvertorFilter.md @@ -1,10 +1,10 @@ # Rodrigues Convertor -## Group (Subgroup) ## +## Group (Subgroup) OrientationAnalysis (Processing) -## Description ## +## Description This *filter* will convert a 3 component Rodrigues vector into a 4 component vector that DREAM.3D expects in its equations and algorithms. The algorithm is the following: @@ -13,38 +13,36 @@ 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 ## +## Parameters -| Name | Type | Description | -|-----------------------|---------|---------------------------------------------------------------------------------------------------| +| 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 Required Geometry Type -or- Not Applicable -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------|------------------------|-------|-------------|-------------| +| Kind | Default Name | Type | Comp Dims | Description | +|---------------------------|--------------|----------|--------|---------------------------------------------| | Attribute Array | Rodrigues Input Vector | float | (3) | | -## Created Objects ## +## Created Objects -| Kind | Default Name | Type | Comp Dims | Description | -|---------------------|------------------------|-------|-------------|-------------| +| Kind | Default Name | Type | Comp Dims | Description | +|---------------------------|--------------|----------|--------|---------------------------------------------| | Attribute Array | Rodrigues Ouput Vector | float | (4) | | -## Example Pipelines ## +## Example Pipelines List the names of the example pipelines where this filter is used. -## License & Copyright ## +## License & Copyright Please see the description file distributed with this plugin. ## DREAM3DNX 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. - - diff --git a/src/Plugins/OrientationAnalysis/docs/RodriguesConvertorFilter.rst b/src/Plugins/OrientationAnalysis/docs/RodriguesConvertorFilter.rst deleted file mode 100644 index 7bcb753619..0000000000 --- a/src/Plugins/OrientationAnalysis/docs/RodriguesConvertorFilter.rst +++ /dev/null @@ -1,68 +0,0 @@ -=================== -Rodrigues Convertor -=================== - - -Group (Subgroup) -================ - -OrientationAnalysis (Processing) - -Description -=========== - -This *filter* will convert a 3 component Rodrigues vector into a 4 component vector that DREAM.3D expects in its -equations and algorithms. The algorithm is the following: - -- Find the length of the 3 component vector. -- Divide each component by the length -- Store the length as the 4th component in the output array - -Parameters -========== - -+--------------------+-------+-----------------------------------------------------------------------------------------+ -| Name | Type | Description | -+====================+=======+=========================================================================================+ -| Delete Original | Bo | Set this to TRUE/ON to have the original 3 component data array deleted at the end of | -| Array | olean | 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) -=============== ====================== ===== ========= =========== - -Example Pipelines -================= - -List the names of the example pipelines where this filter is used. - -License & Copyright -=================== - -Please see the description file distributed with this plugin. - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/OrientationAnalysis/docs/RotateEulerRefFrameFilter.md b/src/Plugins/OrientationAnalysis/docs/RotateEulerRefFrameFilter.md index 1e27554d27..5d364c9501 100644 --- a/src/Plugins/OrientationAnalysis/docs/RotateEulerRefFrameFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/RotateEulerRefFrameFilter.md @@ -1,41 +1,41 @@ # RotateEulerRefFrame -## Group (Subgroup) ## +## Group (Subgroup) Orientation Analysis (Conversion) -## Description ## +## Description 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 ## +## Parameters | Name | Type | Description | -|------|------|-------------| +|------------|------| --------------------------------- | | Rotation Axis-Angle | float (4x) | Axis-Angle in sample reference frame to rotate about. | -## Required Geometry ## +## Required Geometry Not Applicable -## Required Objects ## +## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 ## +## Created Objects None -## Example Pipelines ## +## Example Pipelines + INL Export + Export Small IN100 ODF Data (StatsGenerator) + Edax IPF Colors + Confidence Index Histogram -## License & Copyright ## +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/OrientationAnalysis/docs/RotateEulerRefFrameFilter.rst b/src/Plugins/OrientationAnalysis/docs/RotateEulerRefFrameFilter.rst deleted file mode 100644 index b3316585a0..0000000000 --- a/src/Plugins/OrientationAnalysis/docs/RotateEulerRefFrameFilter.rst +++ /dev/null @@ -1,65 +0,0 @@ -=================== -RotateEulerRefFrame -=================== - - -Group (Subgroup) -================ - -Orientation Analysis (Conversion) - -Description -=========== - -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 - -Example Pipelines -================= - -- INL Export -- Export Small IN100 ODF Data (StatsGenerator) -- Edax IPF Colors -- Confidence Index Histogram - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/OrientationAnalysis/docs/WritePoleFigureFilter.md b/src/Plugins/OrientationAnalysis/docs/WritePoleFigureFilter.md index db442a503d..30712c86e0 100644 --- a/src/Plugins/OrientationAnalysis/docs/WritePoleFigureFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/WritePoleFigureFilter.md @@ -21,18 +21,14 @@ This **Filter** creates a standard pole figure image for each **Ensemble** in a The 3 pole figures can be laid out in a Square, Horizontal row or vertical column. Supporting informatio (including the color bar legend for color pole figures) will also be printed on the image. ------ - | Lambert Projection | Discrete | |--------------------|----------| | ![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 | @@ -51,17 +47,17 @@ NONE ## Required Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | +| Ensemble Attribute Array | CrystalStructures | uint32_t | (1) | Enumeration representing the crystal structure for each Ensemble | ## Created Objects -| Kind | Default Name | Type | Comp. Dims | Description | -|---------------------------|--------------|----------|------------|---------------------------------------------| +| 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 | diff --git a/src/Plugins/OrientationAnalysis/docs/WritePoleFigureFilter.rst b/src/Plugins/OrientationAnalysis/docs/WritePoleFigureFilter.rst deleted file mode 100644 index 5e33aa0db8..0000000000 --- a/src/Plugins/OrientationAnalysis/docs/WritePoleFigureFilter.rst +++ /dev/null @@ -1,132 +0,0 @@ -========================= -Export Pole Figure Images -========================= - - -Group (Subgroup) -================ - -IO (Output) - -Description -=========== - -This **Filter** creates a standard pole figure image for each **Ensemble** in a selected **Data Container** with an -**Image Geometry**. The **Filter** uses Euler angles in radians and requires the crystal structures for each -**Ensemble** array and the corresponding **Ensemble** Ids on the **Cells**. The **Filter** also optionally can use a -*mask* array to determine which **Cells** are valid for the pole figure computation. - -Algorithm Choice ----------------- - -1: The pole figure algorithm uses a *modified Lambert square* to perform the interpolations onto the unit circle. This -is an alternate type of interpolation that the EBSD OEMs do not perform which may make the output from DREAM.3D look -slightly different than output obtained from the OEM programs. - -**Only an advanced user with intimate knowledge of the modified Lambert projection should attempt to change the value -for the “Lambert Image Size (Pixels)” input parameter.** - -2: Discrete Pole figure. The algorithm will simply mark each pixel that had at least 1 count as a black pixel. - -Layout ------- - -The 3 pole figures can be laid out in a Square, Horizontal row or vertical column. Supporting informatio (including the -color bar legend for color pole figures) will also be printed on the image. - --------------- - -+-------------------------------------------------------------------------------+---------------------------------------+ -| Lambert Projection | Discrete | -+===============================================================================+=======================================+ -| |Example Pole Figure Using Square Layout| | |image1| | -+-------------------------------------------------------------------------------+---------------------------------------+ - --------------- - -Parameters -========== - -+------------------------------+------------------------------+--------------------------------------------------------+ -| Name | Type | Description | -+==============================+==============================+========================================================+ -| Figure Title | String | The title of the figure. | -+------------------------------+------------------------------+--------------------------------------------------------+ -| Pole Figure Type | Enumeration: 0=Lambert, | Controls the type of pole figure | -| | 1=Discrete | | -+------------------------------+------------------------------+--------------------------------------------------------+ -| 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 | Cryst | uint32_t | (1) | Enumeration representing the crystal structure | -| | alStructures | | | 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 -================ ============= ================== ========== ====================================== - -Example Pipelines -================= - -- TxCopper_Exposed -- TxCopper_Unexposed - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. - -.. |Example Pole Figure Using Square Layout| image:: Images/PoleFigure_Example.png -.. |image1| image:: Images/Pole_Figure_Discrete_Example.png diff --git a/src/Plugins/OrientationAnalysis/docs/WriteStatsGenOdfAngleFileFilter.md b/src/Plugins/OrientationAnalysis/docs/WriteStatsGenOdfAngleFileFilter.md index c1b6f8fd1d..714e920a81 100644 --- a/src/Plugins/OrientationAnalysis/docs/WriteStatsGenOdfAngleFileFilter.md +++ b/src/Plugins/OrientationAnalysis/docs/WriteStatsGenOdfAngleFileFilter.md @@ -4,7 +4,7 @@ IO (Output) -## Description +## Description This **Filter** is used in a workflow where the user would like to generate a synthetic microstructure with an ODF that matches (as closely as possible) an existing experimental data set or other data set that is being mimicked. The basic workflow is the following: @@ -22,7 +22,7 @@ This **Filter** is used in a workflow where the user would like to generate a sy ## Important Change from Earlier Versions of StatsGenerator -**StatsGenerator can not load data from standard .ang or .ctf files. If you want to get the ODF from an existing experimental data set and you have one of those files then you must use the functionality of this filter** +StatsGenerator can not load data from standard .ang or .ctf files. If you want to get the ODF from an existing experimental data set and you have one of those files then you must use the functionality of this filter ## Notes on Implementation @@ -54,7 +54,7 @@ The **only** required header line is: There are 5 columns of data which are the 3 Euler Angles, the Weight Value and the Sigma Value. -### Delimiter +### Delimiter Choice of delimiter is as follows: @@ -65,10 +65,10 @@ Choice of delimiter is as follows: 4 = \t (tab) -## Parameters +## 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 | @@ -76,24 +76,23 @@ Choice of delimiter is as follows: | 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 -## Required Objects - -| Kind | Default Name | Type | Comp Dims | Description | -|-------|---------------------|--------|---------------------------------|-----------------| +| 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 +## Created Objects None -## Example Pipelines +## Example Pipelines + Export Small IN100 ODF Data (StatsGenerator) -## License & Copyright +## License & Copyright Please see the description file distributed with this **Plugin** diff --git a/src/Plugins/OrientationAnalysis/docs/WriteStatsGenOdfAngleFileFilter.rst b/src/Plugins/OrientationAnalysis/docs/WriteStatsGenOdfAngleFileFilter.rst deleted file mode 100644 index 8d8db421b6..0000000000 --- a/src/Plugins/OrientationAnalysis/docs/WriteStatsGenOdfAngleFileFilter.rst +++ /dev/null @@ -1,157 +0,0 @@ -==================================== -Export StatsGenerator ODF Angle File -==================================== - - -Group (Subgroup) -================ - -IO (Output) - -Description -=========== - -This **Filter** is used in a workflow where the user would like to generate a synthetic microstructure with an ODF that -matches (as closely as possible) an existing experimental data set or other data set that is being mimicked. The basic -workflow is the following: - -1. Import Euler angle data (e.g., ANG or CTF files) -2. Optionally threshold the data so each cell is marked as allowable or not-allowable -3. Insert the “Export StatsGenerator ODF Angle File” **Filter** in the **Pipeline** -4. Run the **Pipeline** to produce the file -5. Launch **StatsGenerator** -6. Generate the data -7. Click on the ODF Tab -8. Click on the *Bulk Load* sub tab -9. Select the file that was just written -10. Load the data and inspect the ODF that was generated - -Important Change from Earlier Versions of StatsGenerator -======================================================== - -**StatsGenerator can not load data from standard .ang or .ctf files. If you want to get the ODF from an existing -experimental data set and you have one of those files then you must use the functionality of this filter** - -Notes on Implementation -======================= - -- A separate file is written for each phase -- Spaces are the default as the delimiters between values. The user can select another value -- Default values of 1.0 are used for both the *weight* and *sigma*. **If the user needs a stronger texture due to a low - number of angles then larger values should be used such as 10, 100 or even 1000.** -- The user has the option to convert the supplied Euler angles to degrees. **StatsGenerator** is able to import Euler - angles as either degrees or radians based on user input, so the output type from this **Filter** could remain as - radians or be converted to degrees. The user should remain cognizant of what representation their angles are in so - that the correct option is chosen during the import process in **StatsGenerator** - -Example File -============ - -The file written is a simple text file that contains a short comment section and a single *Header* line of data. All -comment lines should come **BEFORE** the actual header line. There is a single header line in the form of “Key:Value” -and then the lines of data. - -:: - - # All lines starting with '#' are comments and should come before the header. - # DREAM.3D StatsGenerator Angles Input File - # DREAM.3D Version 6.1.107.0d8bad9 - # Angle Data is space delimited. - # Euler0 Euler1 Euler2 Weight Sigma - Angle Count:100 - 0 0 0 1 1 - 3.6 1.8 3.6 1 1 - 7.2 3.6 7.2 1 1 - 10.8 5.4 10.8 1 1 - 14.4 7.2 14.4 1 1 - -The **only** required header line is: - -:: - - Angle Count:100 - -There are 5 columns of data which are the 3 Euler Angles, the Weight Value and the Sigma Value. - -Delimiter ---------- - -Choice of delimiter is as follows: - -:: - - 0 = , (comma) - 1 = ; (semicolon) - 2 = (space) <==== DEFAULT VALUE - 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 | -+========+============================+==========+=============================================+======================+ -| E | EulerAngles | float | (3) | Three angles | -| lement | | | | defining the | -| Att | | | | orientation of the | -| ribute | | | | **Element** in Bunge | -| Array | | | | convention (Z-X-Z) | -+--------+----------------------------+----------+---------------------------------------------+----------------------+ -| E | Phases | int32_t | (1) | Specifies to which | -| lement | | | | **Ensemble** each | -| Att | | | | **Element** belongs | -| ribute | | | | | -| Array | | | | | -+--------+----------------------------+----------+---------------------------------------------+----------------------+ -| E | Mask | bool | (1) | Used to define | -| lement | | | | **Elements** as | -| Att | | | | *good* or *bad*. | -| ribute | | | | Only required if | -| Array | | | | *Only Write Good | -| | | | | Elements* is checked | -+--------+----------------------------+----------+---------------------------------------------+----------------------+ - -Created Objects -=============== - -None - -Example Pipelines -================= - -- Export Small IN100 ODF Data (StatsGenerator) - -License & Copyright -=================== - -Please see the description file distributed with this **Plugin** - -DREAM3DNX Help -============== - -Check out our GitHub community page at `DREAM3DNX-Issues `__ to -report bugs, ask the community for help, discuss features, or get help from the developers. diff --git a/src/Plugins/TestOne/docs/DynamicTableExample.rst b/src/Plugins/TestOne/docs/DynamicTableExample.rst deleted file mode 100644 index 6fb4c10ee2..0000000000 --- a/src/Plugins/TestOne/docs/DynamicTableExample.rst +++ /dev/null @@ -1,12 +0,0 @@ -=================== -DynamicTableExample -=================== - - -Group (Subgroup) -================ - -Description -=========== - -This is just a test filter diff --git a/src/Plugins/TestOne/docs/ErrorWarningFilter.rst b/src/Plugins/TestOne/docs/ErrorWarningFilter.rst deleted file mode 100644 index 4c45406b47..0000000000 --- a/src/Plugins/TestOne/docs/ErrorWarningFilter.rst +++ /dev/null @@ -1,12 +0,0 @@ -================== -ErrorWarningFilter -================== - - -Group (Subgroup) -================ - -Description -=========== - -This is just a test filter diff --git a/src/Plugins/TestOne/docs/ExampleFilter1.rst b/src/Plugins/TestOne/docs/ExampleFilter1.rst deleted file mode 100644 index 22549f9b35..0000000000 --- a/src/Plugins/TestOne/docs/ExampleFilter1.rst +++ /dev/null @@ -1,12 +0,0 @@ -============== -ExampleFilter1 -============== - - -Group (Subgroup) -================ - -Description -=========== - -This is just a test filter diff --git a/src/Plugins/TestOne/docs/ExampleFilter2.rst b/src/Plugins/TestOne/docs/ExampleFilter2.rst deleted file mode 100644 index 1464cb2190..0000000000 --- a/src/Plugins/TestOne/docs/ExampleFilter2.rst +++ /dev/null @@ -1,12 +0,0 @@ -============== -ExampleFilter2 -============== - - -Group (Subgroup) -================ - -Description -=========== - -This is just a test filter diff --git a/src/Plugins/TestOne/docs/TestFilter.rst b/src/Plugins/TestOne/docs/TestFilter.rst deleted file mode 100644 index 0f516b4bfc..0000000000 --- a/src/Plugins/TestOne/docs/TestFilter.rst +++ /dev/null @@ -1,12 +0,0 @@ -========== -TestFilter -========== - - -Group (Subgroup) -================ - -Description -=========== - -This is just a test filter diff --git a/src/Plugins/TestTwo/docs/Test2Filter.rst b/src/Plugins/TestTwo/docs/Test2Filter.rst deleted file mode 100644 index 5f1f2b3aad..0000000000 --- a/src/Plugins/TestTwo/docs/Test2Filter.rst +++ /dev/null @@ -1,12 +0,0 @@ -=========== -Test2Filter -=========== - - -Group (Subgroup) -================ - -Description -=========== - -This is just a test filter diff --git a/wrapping/python/docs/CMakeLists.txt b/wrapping/python/docs/CMakeLists.txt index a086649b08..04dcf9f0ca 100644 --- a/wrapping/python/docs/CMakeLists.txt +++ b/wrapping/python/docs/CMakeLists.txt @@ -51,7 +51,7 @@ add_custom_target(sphinx_copy_sources ALL DEPENDS generate_sphinx_docs COMMAND ${CMAKE_COMMAND} -E remove_directory "${COMPLEX_SPHINX_DOCS_DIR}/source" COMMAND ${CMAKE_COMMAND} -E copy_directory "${CMAKE_CURRENT_SOURCE_DIR}/source" "${COMPLEX_SPHINX_DOCS_DIR}/source" - COMMENT "SPHINX: Copying static doc files to build directory at ${COMPLEX_SPHINX_DOCS_DIR}" + COMMENT "COMPLEX Python Docs: Copying static doc files to build directory at ${COMPLEX_SPHINX_DOCS_DIR}" ) #------------------------------------------------------------------------------ @@ -60,7 +60,7 @@ add_custom_target(sphinx_copy_sources ALL add_custom_target(sphinx_generate_plugin_rst ALL DEPENDS sphinx_copy_sources COMMAND "$" - COMMENT "SPHINX: Generated Plugin .rst docs file" + COMMENT "COMPLEX Python Docs: Generated Plugin .rst docs file" ) #------------------------------------------------------------------------------ @@ -91,7 +91,7 @@ if(WIN32) DEPENDS sphinx_generate_plugin_rst COMMAND "${SPHINX_MAKE_BAT_FILE}" clean COMMAND "${SPHINX_MAKE_BAT_FILE}" html - COMMENT "SPHINX: Generating Python HTML Documentation" + COMMENT "COMPLEX Python Docs: Generating Python HTML Documentation" WORKING_DIRECTORY "${COMPLEX_SPHINX_DOCS_DIR}" ) else() @@ -99,7 +99,7 @@ else() DEPENDS sphinx_generate_plugin_rst COMMAND "/usr/bin/make" clean COMMAND "/usr/bin/make" html - COMMENT "SPHINX: Generating Python HTML Documentation" + COMMENT "COMPLEX Python Docs: Generating Python HTML Documentation" WORKING_DIRECTORY "${COMPLEX_SPHINX_DOCS_DIR}" ) endif()