Skip to content

File ImageUtilityPolarization.h

File List > include > ImageUtilityPolarization.h

Go to the documentation of this file

//=============================================================================
// Copyright (c) 2026 FLIR Integrated Imaging Solutions, Inc. All Rights Reserved.
//
// This software is the confidential and proprietary information of FLIR
// Integrated Imaging Solutions, Inc. ("Confidential Information"). You
// shall not disclose such Confidential Information and shall use it only in
// accordance with the terms of the license agreement you entered into
// with FLIR Integrated Imaging Solutions, Inc. (FLIR).
//
// FLIR MAKES NO REPRESENTATIONS OR WARRANTIES ABOUT THE SUITABILITY OF THE
// SOFTWARE, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
// PURPOSE, OR NON-INFRINGEMENT. FLIR SHALL NOT BE LIABLE FOR ANY DAMAGES
// SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR DISTRIBUTING
// THIS SOFTWARE OR ITS DERIVATIVES.
//=============================================================================

#ifndef FLIR_SPINNAKER_IMAGE_UTILITY_POLARIZATION_H
#define FLIR_SPINNAKER_IMAGE_UTILITY_POLARIZATION_H

#include "SpinnakerPlatform.h"
#include "SpinnakerDefs.h"

namespace Spinnaker
{
    class ImagePtr;

    class SPINNAKER_API ImageUtilityPolarization
    {
      public:
        static ImagePtr ExtractPolarQuadrant(const ImagePtr& srcImage, const PolarizationQuadrant desiredQuadrant);

        static void ExtractPolarQuadrant(
            const ImagePtr& srcImage,
            ImagePtr& destQuadImage,
            const PolarizationQuadrant desiredQuadrant);

        static ImagePtr CreateGlareReduced(const ImagePtr& srcImage);

        static void CreateGlareReduced(const ImagePtr& srcImage, ImagePtr& destGlareReducedImage);

        static ImagePtr CreateStokesS0(
            const ImagePtr& srcImage,
            const ColorProcessingAlgorithm colorProcessingAlg = SPINNAKER_COLOR_PROCESSING_ALGORITHM_NEAREST_NEIGHBOR);

        static void CreateStokesS0(
            const ImagePtr& srcImage,
            ImagePtr& destStokesS0Image,
            const ColorProcessingAlgorithm colorProcessingAlg = SPINNAKER_COLOR_PROCESSING_ALGORITHM_NEAREST_NEIGHBOR);

        static ImagePtr CreateStokesS1(
            const ImagePtr& srcImage,
            const ColorProcessingAlgorithm colorProcessingAlg = SPINNAKER_COLOR_PROCESSING_ALGORITHM_NEAREST_NEIGHBOR);

        static void CreateStokesS1(
            const ImagePtr& srcImage,
            ImagePtr& destStokesS1Image,
            const ColorProcessingAlgorithm colorProcessingAlg = SPINNAKER_COLOR_PROCESSING_ALGORITHM_NEAREST_NEIGHBOR);

        static ImagePtr CreateStokesS2(
            const ImagePtr& srcImage,
            const ColorProcessingAlgorithm colorProcessingAlg = SPINNAKER_COLOR_PROCESSING_ALGORITHM_NEAREST_NEIGHBOR);

        static void CreateStokesS2(
            const ImagePtr& srcImage,
            ImagePtr& destStokesS2Image,
            const ColorProcessingAlgorithm colorProcessingAlg = SPINNAKER_COLOR_PROCESSING_ALGORITHM_NEAREST_NEIGHBOR);

        static ImagePtr CreateDolp(
            const ImagePtr& srcImage,
            const ColorProcessingAlgorithm colorProcessingAlg = SPINNAKER_COLOR_PROCESSING_ALGORITHM_NEAREST_NEIGHBOR);

        static void CreateDolp(
            const ImagePtr& srcImage,
            ImagePtr& destDolpImage,
            const ColorProcessingAlgorithm colorProcessingAlg = SPINNAKER_COLOR_PROCESSING_ALGORITHM_NEAREST_NEIGHBOR);

        static ImagePtr CreateAolp(
            const ImagePtr& srcImage,
            const ColorProcessingAlgorithm colorProcessingAlg = SPINNAKER_COLOR_PROCESSING_ALGORITHM_NEAREST_NEIGHBOR);

        static void CreateAolp(
            const ImagePtr& srcImage,
            ImagePtr& destAolpImg,
            const ColorProcessingAlgorithm colorProcessingAlg = SPINNAKER_COLOR_PROCESSING_ALGORITHM_NEAREST_NEIGHBOR);
    };

} // namespace Spinnaker

#endif // FLIR_SPINNAKER_IMAGE_UTILITY_POLARIZATION_H