mirror of
https://gitlab.kitware.com/vtk/vtk-m
synced 2024-09-16 17:22:55 +00:00
c238cfea50
VTK-m has a deprecation method that supports API changes in minor releases. When an API change is made, the old API is marked with the VTKM_DEPRECATED macro. If code attempts to use the old API, it still works, but the compiler issues a warning that the thing is deprecated and where to find the new API. We have recently run into an issue when the API changes have a header file renamed or moved. We still keep the old header file with the old API, so code including that file will still work. However, sometimes code expected the contents of that header file without directly including that header file. In these cases, the code could get an error about missing classes. As an example, consider the change from `DynamicCellSet` to `UnknownCellSet`/`UncertainCellSet`. The deprecated `DynamicCellSet` is still around. But there is a lot of code that did not directly include DynamicCellSet.h. This header file was necessarily included by DataSet.h. Now, when this code uses `vtkm::cont::DynamicCellSet`, you get a confusing error that the class does not exist. Backward compatibility broken. In response to this, we should be more careful about where we put the deprecated API. Instead of containing the deprecated API, moved headers should be empty except for a warning and an inclusion of the new header file. The deprecated API should be moved to the new header file. For example, in the case of `DynamicCellSet`, the implementation for the deprecated `DynamicCellSet` is moved to UnknownCellSet.h, which is included by anything that was including DynamicCellSet.h before.
56 lines
1.8 KiB
C++
56 lines
1.8 KiB
C++
//============================================================================
|
|
// Copyright (c) Kitware, Inc.
|
|
// All rights reserved.
|
|
// See LICENSE.txt for details.
|
|
//
|
|
// This software is distributed WITHOUT ANY WARRANTY; without even
|
|
// the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
|
|
// PURPOSE. See the above copyright notice for more information.
|
|
//============================================================================
|
|
|
|
#ifndef vtk_m_filter_image_processing_ImageMedian_h
|
|
#define vtk_m_filter_image_processing_ImageMedian_h
|
|
|
|
#include <vtkm/filter/NewFilterField.h>
|
|
#include <vtkm/filter/image_processing/vtkm_filter_image_processing_export.h>
|
|
|
|
/// \brief Median algorithm for general image blur
|
|
///
|
|
/// The ImageMedian filter finds the median value for each pixel in an image.
|
|
/// Currently the algorithm has the following restrictions.
|
|
/// - Only supports a neighborhood of 5x5x1 or 3x3x1
|
|
///
|
|
/// This means that volumes are basically treated as an image stack
|
|
/// along the z axis
|
|
///
|
|
/// Default output field name is 'median'
|
|
namespace vtkm
|
|
{
|
|
namespace filter
|
|
{
|
|
namespace image_processing
|
|
{
|
|
class VTKM_FILTER_IMAGE_PROCESSING_EXPORT ImageMedian : public vtkm::filter::NewFilterField
|
|
{
|
|
public:
|
|
VTKM_CONT ImageMedian() { this->SetOutputFieldName("median"); }
|
|
|
|
VTKM_CONT void Perform3x3() { this->Neighborhood = 1; };
|
|
VTKM_CONT void Perform5x5() { this->Neighborhood = 2; };
|
|
|
|
private:
|
|
VTKM_CONT vtkm::cont::DataSet DoExecute(const vtkm::cont::DataSet& input) override;
|
|
|
|
int Neighborhood = 1;
|
|
};
|
|
} // namespace image_processing
|
|
class VTKM_DEPRECATED(1.8, "Use vtkm::filter::image_processing::ImageMedian.") ImageMedian
|
|
: public vtkm::filter::image_processing::ImageMedian
|
|
{
|
|
using image_processing::ImageMedian::ImageMedian;
|
|
};
|
|
} // namespace filter
|
|
} // namespace vtkm
|
|
|
|
#endif //vtk_m_filter_image_processing_ImageMedian_h
|