insightsoftwareconsortium / itksplitcomponents

This ITK module contains a filter that generates component images from an itk::Image of itk::Vector, itk::CovariantVector, or itk::SymmetricSecondRankTensor.

ITKSplitComponents

Overview

This ITK module contains a filter called itk::SplitComponentsImageFilter. This filter generates component images from an itk::Image of, for example, itk::Vector, itk::CovariantVector, or itk::SymmetricSecondRankTensor.

For more information, see the Insight Journal article:

McCormick M.
An ITK Class that Splits Multi-Component Images
The Insight Journal. January-December. 2010.
https://hdl.handle.net/10380/3230
https://www.insight-journal.org/browse/publication/774

Installation

This module is available in the ITK source tree as a Remote module. To enable it, set:

Module_SplitComponents:BOOL=ON

in ITK's CMake build configuration.

Alternatively, build the module externally with:

git clone https://github.com/InsightSoftwareConsortium/ITKSplitComponents.git
mkdir ITKSplitComponents-build
cd ITKSplitComponents-build
cmake -DITK_DIR=/path/to/ITK-build ../ITKSplitComponents
make

License

This software is distributed under the Apache 2.0 license. Please see the LICENSE file for details.

itksplitcomponents's Issues

Python Wrapping errors with ITK v5.1.1

We are unable to run Python Wrapping for ITKSplitComponents without wrapping errors. The terminal output is provided below when ran in the following conditions:

• Ubuntu 18.04.5
• ITK v5.1.1
• Python 3.5.9

These errors are consistent amongst MacOS and Windows builds as well. I have provided a link to all 3 failing builds here. This issue will require the following changes:

• Fix Python Wrapping for Ubuntu, Windows and MacOS.
• Create PR containing wrapping changes and uncomment Python Package Builds in GitHub Actions CI with TODO removed. Verify all Python Packages build correctly.
• Create an API token on PyPI for the package, and put in the repository Settings -> Secrets under the key pypi_password.
• Create new Git tag, either locally and pushing, or in the GitHub web Release page, this will trigger builds and push the packages to PyPI.

Bump `cmake_minimum_required`

CMake minimum version should be updated at https://github.com/InsightSoftwareConsortium/ITKSplitComponents/blob/master/CMakeLists.txt#L1

See warnings discussed in InsightSoftwareConsortium/ITKPythonPackage#191

Add license file.

The license file is missing from this module.

SplitComponents does not work properly with VectorImage or RGB in Python

With 2D RGB or VectorImages, images = itk.split_components_image_filter(image) produces a list of length 2, instead of 3 for RGB, and N for VectorImage.

Merge into ITK

This filter implements a basic and really useful operation. It can be considered as the inverse of the ComposeImageFilter, which already exists in ITK proper.

Lint failure

Simplify `wrapping/itkSplitComponentsImageFilter.wrap`

When a new ITK build package is generated and contains the CMake variable WRAP_ITK_SCALAR_IMAGE_PIXEL_TYPES, update wrapping/itkSplitComponentsImageFilter.wrap to use this variable.