Skip to content

Commit

Permalink
ENH: Various ReadPeregrineHDF5File Improvements (#1016)
Browse files Browse the repository at this point in the history 
- It is now possible to choose to enable/disable the importing of any dataset.  If all dataset imports are disabled, then the filter returns an error telling the user that they have to enable at least one dataset import.
- The user can now choose the parent path to the camera data datasets, and can also choose the specific datasets to import using a comma-separated list (similar to the segmentation results comma-separated list).
- Defaults all dataset import boolean parameters to False, since not every Peregrine HDF5 file will have every possible dataset.
- Updated documentation to reflect the changes to the filter parameters.

Signed-off-by: Joey Kleingers <[email protected]>
  • Loading branch information
@joeykleingers @imikejackson
joeykleingers authored and imikejackson committed Jul 12, 2024
1 parent c62fa7f commit 8346cd3
Show file tree
Hide file tree
Showing 2 changed files with 342 additions and 257 deletions.
38 changes: 22 additions & 16 deletions wrapping/python/plugins/NXDataAnalysisToolkit/docs/ReadPeregrineHDF5FileFilter.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,40 +10,46 @@ The `ReadPeregrineHDF5File` filter is designed to read an HDF5 file that is in a

### Input Parameters
- **`Input Peregrine HDF5 File`** (string): Specifies the complete file path to the target HDF5 file.

## Slice Data Parameters
- **`Slice Data Geometry`**: Path to the Slice Data image geometry to be created.
- **`Slice Data Cell Attribute Matrix Name`**: Name of the Slice Data cell attribute matrix to be created.
- **`Read Segmentation Results`** (boolean): Toggles the reading of segmentation results stored in the HDF5 file.
- **`Segmentation Results`** (string): Comma-delimited string that specifies which segmentation results datasets should be read.
- **`Read Camera Data`** (boolean): Toggles the reading of camera data stored in the HDF5 file.
- **`Camera Data HDF5 Parent Path`**: The path to the parent group of the camera datasets in the HDF5 file.
- **`Camera Data Datasets`**: Comma-delimited string that specifies which camera data datasets should be read.
- **`Read Part Ids`** (boolean): Determines whether part ids data should be read.
- **`Part Ids Array Name`**: Name of the part ids array to be created.
- **`Read Sample Ids`** (boolean): Determines whether sample ids data should be read.
- **`Read Anomaly Detection`** (boolean): Determines whether anomaly detection data should be read.
- **`Read X-Ray CT`** (boolean): Determines whether X-ray computed tomography data should be read.
- **`Read Slices Subvolume`** (boolean): Enables or disables the reading of a specific subvolume of slices data within the HDF5 file. If set to True, additional parameters for specifying the subvolume bounds (`Slices Subvolume X Bounds`, `Slices Subvolume Y Bounds`, `Slices Subvolume Z Bounds`) are required.
- **`Sample Ids Array Name`**: Name of the sample ids array to be created.
- **`Enable Slices Subvolume`** (boolean): Enables or disables the reading of a specific subvolume of slices data within the HDF5 file. If set to True, additional parameters for specifying the subvolume bounds (`Slices Subvolume X Bounds`, `Slices Subvolume Y Bounds`, `Slices Subvolume Z Bounds`) are required.
- **`Slices Subvolume X Bounds`** (tuple of integers): Defines the minimum and maximum x-coordinates of the slices subvolume to be read.
- **`Slices Subvolume Y Bounds`** (tuple of integers): Defines the minimum and maximum y-coordinates of the slices subvolume to be read.
- **`Slices Subvolume Z Bounds`** (tuple of integers): Defines the minimum and maximum z-coordinates of the slices subvolume to be read.
- **`Read Registered Data Subvolume`** (boolean): Enables or disables the reading of a specific subvolume of registered data within the HDF5 file. If set to True, additional parameters for specifying the subvolume bounds (`Registered Data Subvolume X Bounds`, `Registered Data Subvolume Y Bounds`, `Registered Data Subvolume Z Bounds`) are required.
- **`Registered Data Subvolume X Bounds`** (tuple of integers): Defines the minimum and maximum x-coordinates of the registered data subvolume to be read.
- **`Registered Data Subvolume Y Bounds`** (tuple of integers): Defines the minimum and maximum y-coordinates of the registered data subvolume to be read.
- **`Registered Data Subvolume Z Bounds`** (tuple of integers): Defines the minimum and maximum z-coordinates of the registered data subvolume to be read.
- **`Read Scan Data Subvolume`** (boolean): Enables or disables the reading of specific slices of scan data within the HDF5 file. If set to True, an additional parameter for specifying the slice bounds (`Scan Data Slice Bounds`) is required.
- **`Scan Data Slice Bounds`** (tuple of integers): Defines the minimum and maximum slices of the scan data to be read.

### Created Data Objects
- **`Slice Data Geometry`**: Path to the Slice Data image geometry to be created.
- **`Slice Data Cell Attribute Matrix Name`**: Name of the Slice Data cell attribute matrix to be created.
- **`Camera Data 0 Array Name`**: Name of the first camera data array to be created.
- **`Camera Data 1 Array Name`**: Name of the second camera data array to be created.
- **`Part Ids Array Name`**: Name of the part ids array to be created.
- **`Sample Ids Array Name`**: Name of the sample ids array to be created.
## Registered Data Parameters
- **`Registered Data Geometry`**: Path to the Registered Data image geometry to be created.
- **`Registered Data Cell Attribute Matrix Name`**: Name of the Registered Data cell attribute matrix to be created.
- **`Read Anomaly Detection`** (boolean): Determines whether anomaly detection data should be read.
- **`Anomaly Detection Array Name`**: Name of the Anomaly Detection array to be created.
- **`Read X-Ray CT`** (boolean): Determines whether X-ray computed tomography data should be read.
- **`X-Ray CT Array Name`**: Name of the X-Ray CT array to be created.
- **`Enable Registered Data Subvolume`** (boolean): Enables or disables the reading of a specific subvolume of registered data within the HDF5 file. If set to True, additional parameters for specifying the subvolume bounds (`Registered Data Subvolume X Bounds`, `Registered Data Subvolume Y Bounds`, `Registered Data Subvolume Z Bounds`) are required.
- **`Registered Data Subvolume X Bounds`** (tuple of integers): Defines the minimum and maximum x-coordinates of the registered data subvolume to be read.
- **`Registered Data Subvolume Y Bounds`** (tuple of integers): Defines the minimum and maximum y-coordinates of the registered data subvolume to be read.
- **`Registered Data Subvolume Z Bounds`** (tuple of integers): Defines the minimum and maximum z-coordinates of the registered data subvolume to be read.

### Scan Data Parameters
- **`Read Scan Datasets`** (boolean): Toggles the reading of the scan datasets stored in the HDF5 file.
- **`Scan Data Geometry`**: Path to the Scan Data edge geometry to be created.
- **`Scan Data Edge Attribute Matrix Name`**: Name of the Scan Data edge attribute matrix to be created.
- **`Scan Data Vertex Attribute Matrix Name`**: Name of the Scan Data vertex attribute matrix to be created.
- **`Scan Data Vertex List Array Name`**: Name of the Scan Data vertex list array to be created.
- **`Scan Data Edge List Array Name`**: Name of the Scan Data edge list array to be created.
- **`Scan Data Time of Travel Array Name`**: Name of the Scan Data Time of Travel array to be created.
- **`Enable Scan Data Subvolume`** (boolean): Enables or disables the reading of specific slices of scan data within the HDF5 file. If set to True, an additional parameter for specifying the slice bounds (`Scan Data Slice Bounds`) is required.
- **`Scan Data Slice Bounds`** (tuple of integers): Defines the minimum and maximum slices of the scan data to be read.

## Example Pipelines

Expand Down
Loading

0 comments on commit 8346cd3

Please sign in to comment.