itkConvertPixelBuffer.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  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 itkConvertPixelBuffer_h
#define itkConvertPixelBuffer_h
#include "ITKIOImageBaseExport.h"
 
#include "itkObject.h"
#include "itkNumericTraits.h"
#include <type_traits> // for enable_if
 
namespace itk
{
template <typename InputPixelType, typename OutputPixelType, typename OutputConvertTraits>
class ITK_TEMPLATE_EXPORT ConvertPixelBuffer
{
public:
  using OutputComponentType = typename OutputConvertTraits::ComponentType;
  using Self = ConvertPixelBuffer;
 
  // Remove all constructor/ destructor / assignments for class with only static member functions.
  ConvertPixelBuffer(const ConvertPixelBuffer &) = delete;
  ConvertPixelBuffer(ConvertPixelBuffer &&) = delete;
  ConvertPixelBuffer &
  operator=(const ConvertPixelBuffer &) = delete;
  ConvertPixelBuffer &
  operator=(ConvertPixelBuffer &&) = delete;
  virtual ~ConvertPixelBuffer() = delete;

  static void
  Convert(const InputPixelType * inputData, int inputNumberOfComponents, OutputPixelType * outputData, size_t size);
 
  static void
  ConvertVectorImage(const InputPixelType * inputData,
                     int                    inputNumberOfComponents,
                     OutputPixelType *      outputData,
                     size_t                 size);
 
protected:
  static void
  ConvertGrayToGray(const InputPixelType * inputData, OutputPixelType * outputData, size_t size);

  static void
  ConvertRGBToGray(const InputPixelType * inputData, OutputPixelType * outputData, size_t size);

  static void
  ConvertRGBAToGray(const InputPixelType * inputData, OutputPixelType * outputData, size_t size);
 
  static void
  ConvertMultiComponentToGray(const InputPixelType * inputData,
                              int                    inputNumberOfComponents,
                              OutputPixelType *      outputData,
                              size_t                 size);

  static void
  ConvertGrayToRGB(const InputPixelType * inputData, OutputPixelType * outputData, size_t size);

  static void
  ConvertRGBToRGB(const InputPixelType * inputData, OutputPixelType * outputData, size_t size);

  static void
  ConvertRGBAToRGB(const InputPixelType * inputData, OutputPixelType * outputData, size_t size);

  static void
  ConvertMultiComponentToRGB(const InputPixelType * inputData,
                             int                    inputNumberOfComponents,
                             OutputPixelType *      outputData,
                             size_t                 size);

  static void
  ConvertGrayToRGBA(const InputPixelType * inputData, OutputPixelType * outputData, size_t size);
 
  static void
  ConvertRGBToRGBA(const InputPixelType * inputData, OutputPixelType * outputData, size_t size);
 
  static void
  ConvertRGBAToRGBA(const InputPixelType * inputData, OutputPixelType * outputData, size_t size);
 
  static void
  ConvertMultiComponentToRGBA(const InputPixelType * inputData,
                              int                    inputNumberOfComponents,
                              OutputPixelType *      outputData,
                              size_t                 size);

  static void
  ConvertVectorToVector(const InputPixelType * inputData,
                        int                    inputNumberOfComponents,
                        OutputPixelType *      outputData,
                        size_t                 size);

  static void
  ConvertTensor6ToTensor6(const InputPixelType * inputData, OutputPixelType * outputData, size_t size);
 
  static void
  ConvertTensor9ToTensor6(const InputPixelType * inputData, OutputPixelType * outputData, size_t size);

  static void
  ConvertGrayToComplex(const InputPixelType * inputData, OutputPixelType * outputData, size_t size);
 
  static void
  ConvertComplexToComplex(const InputPixelType * inputData, OutputPixelType * outputData, size_t size);
 
  static void
  ConvertMultiComponentToComplex(const InputPixelType * inputData,
                                 int                    inputNumberOfComponents,
                                 OutputPixelType *      outputData,
                                 size_t                 size);

  template <typename UComponentType>
  static std::enable_if_t<!std::is_integral_v<UComponentType>, UComponentType>
  DefaultAlphaValue();
 
  template <typename UComponentType>
  static std::enable_if_t<std::is_integral_v<UComponentType>, UComponentType>
  DefaultAlphaValue();
};
} // namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkConvertPixelBuffer.hxx"
#endif
 
#endif // itkConvertPixelBuffer_h