Skip to content

Commit

Permalink
DOC: Fix various documentation bugs. (BlueQuartzSoftware#973)
Browse files Browse the repository at this point in the history
Signed-off-by: Michael Jackson <[email protected]>
  • Loading branch information
imikejackson committed May 23, 2024
1 parent 8178323 commit 017da90
Show file tree
Hide file tree
Showing 7 changed files with 9 additions and 9 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ Parameters ITKLabelContourImageFilter::parameters() const
params.insertSeparator(Parameters::Separator{"Input Parameter(s)"});
params.insert(std::make_unique<BoolParameter>(k_FullyConnected_Key, "Fully Connected",
"Set/Get whether the connected components are defined strictly by face connectivity or by face+edge+vertex connectivity. Default is FullyConnectedOff. "
"\note For objects that are 1 pixel wide, use FullyConnectedOn.",
"Note For objects that are 1 pixel wide, use FullyConnectedOn.",
false));
params.insert(std::make_unique<Float64Parameter>(k_BackgroundValue_Key, "Background Value",
"Set/Get the background value used to identify the objects and mark the pixels not on the border of the objects.", 0));
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ If the data has come from a TSL acquisition system and the settings of the acqui
+ Sample Reference Frame: 180<sup>o</sup> about the <010> Axis
+ Crystal Reference Frame: 90<sup>o</sup> about the <001> Axis

The user also may want to assign un-indexed pixels to be ignored by flagging them as "bad". The {ref}`Threshold Objects <SimplnxCore/MultiThresholdObjects:Description>` 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 <SimplnxCore/MultiThresholdObjectsFilter:Description>` Filter can be used to define this *mask* by thresholding on values such as *MAD* > xx.

+ Note: If the X Step or Y Step within the HDF5 file for a scan is ZERO, those values will be set to 1.0 when the filter runs. This is needed
as the user has no effective way to fix the HDF5 file. If the user needs a different
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ the user should **CHECK** the option **ON** for "Perform Slice By Slice Transfor

## Thresholding out Unindexed Scan Points

The user also may want to assign un-indexed pixels to be ignored by flagging them as "bad". The {ref}`Threshold Objects <SimplnxCore/MultiThresholdObjects:Description>` **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 <SimplnxCore/MultiThresholdObjectsFilter:Description>` **Filter** can be used to define this *mask* by thresholding on values such as *Confidence Index* > xx or *Image Quality* > desired quality.

% Auto generated parameter table will be inserted here

Expand Down
4 changes: 2 additions & 2 deletions src/Plugins/OrientationAnalysis/docs/ReadH5OinaDataFilter.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ needs additional data from the file, the "Import HDF5 Dataset" filter can be use

In order to bring the crystal reference frame and sample reference frame into coincidence, rotations **MAY** need to be applied to the data. There are 2 filters that can perform the necessary rotations.

+ [Rotate Euler Reference Frame](../RotateEulerRefFrameFilter/index.html)
+ [Rotate Sample Reference Frame](../RotateSampleRefFrameFilter/index.html)
- {ref}`Rotate Euler Reference Frame <OrientationAnalysis/RotateEulerRefFrameFilter:Description>`
- {ref}`Rotate Sample Reference Frame <SimplnxCore/RotateSampleRefFrameFilter:Description>`

Historical reference frame operations for a .ctf file are the following:

Expand Down
4 changes: 2 additions & 2 deletions wrapping/python/docs/source/Developer_API.rst
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ General Parameters
~~~~~~~~~~~
The ``ArrayThresholdsParameter`` is used to specify thresholds for an array, allowing for filtering based on those thresholds.

This parameter holds a ArrayThresholdSet_ object and is used specifically for the :ref:`simplnx.MultiThresholdObjects() <MultiThresholdObjects>` filter.
This parameter holds a ArrayThresholdSet_ object and is used specifically for the :ref:`simplnx.MultiThresholdObjects() <MultiThresholdObjectsFilter>` filter.
This parameter should not be directly invoked but instead its ArrayThresholdSet_ is invoked and used.

Inputs
Expand Down Expand Up @@ -188,7 +188,7 @@ General Parameters
.. _ArrayThreshold:
.. py:class:: ArrayThresholdSet.ArrayThreshold
This class holds the values that are used for comparison in the :ref:`simplnx.MultiThresholdObjects() <MultiThresholdObjects>` filter.
This class holds the values that are used for comparison in the :ref:`simplnx.MultiThresholdObjects() <MultiThresholdObjectsFilter>` filter.

:ivar array_path: The :ref:`DataPath <DataPath>` to the array to use for this ArrayThreshold
:ivar comparison: Int. The comparison operator to use. 0=">", 1="<", 2="=", 3="!="
Expand Down
4 changes: 2 additions & 2 deletions wrapping/python/docs/source/User_API.rst
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ General Parameters
.. _ArrayThresholdsParameter:
.. py:class:: ArrayThresholdsParameter
This parameter holds a ArrayThresholdSet_ object and is used specifically for the :ref:`simplnx.MultiThresholdObjects() <MultiThresholdObjects>` filter.
This parameter holds a ArrayThresholdSet_ object and is used specifically for the :ref:`simplnx.MultiThresholdObjects() <MultiThresholdObjectsFilter>` filter.
This parameter should not be directly invoked but instead it's ArrayThresholdSet_ is invoked and used.


Expand All @@ -70,7 +70,7 @@ General Parameters
.. _ArrayThreshold:
.. py:class:: ArrayThresholdSet.ArrayThreshold
This class holds the values that are used for comparison in the :ref:`simplnx.MultiThresholdObjects() <MultiThresholdObjects>` filter.
This class holds the values that are used for comparison in the :ref:`simplnx.MultiThresholdObjects() <MultiThresholdObjectsFilter>` filter.

:ivar array_path: The :ref:`DataPath <DataPath>` to the array to use for this ArrayThreshold
:ivar comparison: Int. The comparison operator to use. 0=">", 1="<", 2="=", 3="!="
Expand Down

0 comments on commit 017da90

Please sign in to comment.