1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134
|
/*=========================================================================
*
* Copyright NumFOCUS
*
* 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
*
* https://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 itkShiftScaleImageFilter_h
#define itkShiftScaleImageFilter_h
#include "itkImageToImageFilter.h"
#include "itkArray.h"
#include <mutex>
namespace itk
{
/** \class ShiftScaleImageFilter
* \brief Shift and scale the pixels in an image.
*
* ShiftScaleImageFilter shifts the input pixel by Shift (default 0.0)
* and then scales the pixel by Scale (default 1.0). All computations
* are performed in the precision of the input pixel's RealType. Before
* assigning the computed value to the output pixel, the value is clamped
* at the NonpositiveMin and max of the pixel type.
* \ingroup IntensityImageFilters
*
* \ingroup ITKImageIntensity
*/
template <typename TInputImage, typename TOutputImage>
class ITK_TEMPLATE_EXPORT ShiftScaleImageFilter : public ImageToImageFilter<TInputImage, TOutputImage>
{
public:
ITK_DISALLOW_COPY_AND_MOVE(ShiftScaleImageFilter);
/** Standard class type aliases. */
using Self = ShiftScaleImageFilter;
using Superclass = ImageToImageFilter<TInputImage, TOutputImage>;
using Pointer = SmartPointer<Self>;
using ConstPointer = SmartPointer<const Self>;
/** Method for creation through the object factory. */
itkNewMacro(Self);
/** Typedef to describe the output and input image region types. */
using InputImageRegionType = typename TInputImage::RegionType;
using OutputImageRegionType = typename TOutputImage::RegionType;
/** Typedef to describe the pointer to the input/output. */
using InputImagePointer = typename TInputImage::Pointer;
using OutputImagePointer = typename TOutputImage::Pointer;
/** Typedef to describe the type of pixel. */
using InputImagePixelType = typename TInputImage::PixelType;
using OutputImagePixelType = typename TOutputImage::PixelType;
/** Typedef to describe the output and input image index and size types. */
using InputImageIndexType = typename TInputImage::IndexType;
using InputImageSizeType = typename TInputImage::SizeType;
using InputImageOffsetType = typename TInputImage::OffsetType;
using OutputImageIndexType = typename TOutputImage::IndexType;
using OutputImageSizeType = typename TOutputImage::SizeType;
using OutputImageOffsetType = typename TOutputImage::OffsetType;
/** Type to use form computations. */
using RealType = typename NumericTraits<OutputImagePixelType>::RealType;
/** Image related type alias. */
static constexpr unsigned int ImageDimension = TInputImage::ImageDimension;
/** \see LightObject::GetNameOfClass() */
itkOverrideGetNameOfClassMacro(ShiftScaleImageFilter);
/** Set/Get the amount to Shift each Pixel. The shift is followed by a Scale.
*/
itkSetMacro(Shift, RealType);
itkGetConstMacro(Shift, RealType);
/** Set/Get the amount to Scale each Pixel. The Scale is applied after the
Shift. */
itkSetMacro(Scale, RealType);
itkGetConstMacro(Scale, RealType);
/** Get the number of pixels that underflowed and overflowed. */
itkGetConstMacro(UnderflowCount, SizeValueType);
itkGetConstMacro(OverflowCount, SizeValueType);
#ifdef ITK_USE_CONCEPT_CHECKING
// Begin concept checking
itkConceptMacro(OutputHasNumericTraitsCheck, (Concept::HasNumericTraits<OutputImagePixelType>));
itkConceptMacro(InputPlusRealTypeCheck, (Concept::AdditiveOperators<InputImagePixelType, RealType, RealType>));
itkConceptMacro(RealTypeMultiplyOperatorCheck, (Concept::MultiplyOperator<RealType>));
// End concept checking
#endif
protected:
ShiftScaleImageFilter() = default;
~ShiftScaleImageFilter() override = default;
void
PrintSelf(std::ostream & os, Indent indent) const override;
/** Initialize some accumulators before the threads run. */
void
BeforeThreadedGenerateData() override;
void
DynamicThreadedGenerateData(const OutputImageRegionType &) override;
private:
RealType m_Shift{};
RealType m_Scale{ NumericTraits<RealType>::OneValue() };
SizeValueType m_UnderflowCount{ 0 };
SizeValueType m_OverflowCount{ 0 };
std::mutex m_Mutex{};
};
} // end namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
# include "itkShiftScaleImageFilter.hxx"
#endif
#endif
|