ConnectedComponentImageFilter doc

Fijoy_Vadakkumpadan · October 23, 2018, 3:09pm

Hello,

The documentation for ConnectedComponentImageFilter:

https://itk.org/Doxygen/html/classitk_1_1ConnectedComponentImageFilter.html

states that “The final object labels start with 1 and are consecutive”, but I’m noticing that this true only if the output background value is set to zero (default). If the output background is set to a non-zero value (by calling the SetBackgroundValue() routine of the filter), labels start at 0. They remain consecutive, except for skipping the background value if needed.

Does the documentation need an update?

–Fijoy

dzenanz · October 23, 2018, 3:25pm

It does. Do you want to update it?

dzenanz · October 23, 2018, 3:27pm

The code for the function which constructs consecutive labels can be found here.

Fijoy_Vadakkumpadan · October 24, 2018, 2:48pm

Dženan, Yes, gladly. Should I create a pull request after updating the Doxygen comment block in this file?:

github.com

InsightSoftwareConsortium/ITK/blob/fb76d3eaaf060ef023336f850a55191f7822a18d/Modules/Segmentation/ConnectedComponents/include/itkConnectedComponentImageFilter.h

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
#ifndef itkConnectedComponentImageFilter_h
#define itkConnectedComponentImageFilter_h

This file has been truncated. show original

–Fijoy

dzenanz · October 24, 2018, 5:54pm

We are in the process of switching from gerrit to GitHub code review. While we still haven’t switched, I guess a doc-only change can be done as a GitHub pull request. @matt.mccormick

matt.mccormick · October 24, 2018, 10:44pm

Contributions are certainly welcome @Fijoy_Vadakkumpadan!

As @dzenanz noted, we have note moved to using GitHub as the main repository, and we can not merge PR’s until that happens. However, this is slated for next week, so you are welcome to stage a PR on GitHub .