Mask.h

Go to the documentation of this file.

/*******************************************************************************
 * This file is part of the Zivid API
 *
 * Copyright 2015-2026 (C) Zivid AS
 * All rights reserved.
 *
 * Zivid Software License, v1.0
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * 3. Neither the name of Zivid AS nor the names of its contributors may be used
 * to endorse or promote products derived from this software without specific
 * prior written permission.
 *
 * 4. This software, with or without modification, must not be used with any
 * other 3D camera than from Zivid AS.
 *
 * 5. Any software provided in binary form under this license must not be
 * reverse engineered, decompiled, modified and/or disassembled.
 *
 * THIS SOFTWARE IS PROVIDED BY ZIVID AS "AS IS" AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL ZIVID AS OR CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * Contact: Zivid Customer Success Team <customersuccess@zivid.com>
 * Info:    http://www.zivid.com
 ******************************************************************************/
 
#pragma once
 
#include "Zivid/Array2D.h"
#include "Zivid/Detail/UtilsExport.h"
#include "Zivid/Resolution.h"
 
#include <cstdint>
#include <iosfwd>
#include <string>
 
namespace Zivid
{
    class Mask : public Array2D<uint8_t>
    {
    public:
        ZIVID_UTILS_EXPORT Mask();

        ZIVID_UTILS_EXPORT explicit Mask(const Resolution &resolution);

        ZIVID_UTILS_EXPORT Mask(const Resolution &resolution, const uint8_t *beginIt, const uint8_t *endIt);

        template<
            typename Iterator,
            typename std::enable_if_t<
                std::is_convertible_v<typename std::iterator_traits<Iterator>::value_type, uint8_t>,
                std::nullptr_t> = nullptr>
        Mask(const Resolution &resolution, Iterator beginIt, Iterator endIt)
            : Array2D<uint8_t>(resolution, beginIt, endIt)
        {}

        ZIVID_UTILS_EXPORT Resolution resolution() const;

        ZIVID_UTILS_EXPORT std::string toString() const;

        ZIVID_UTILS_EXPORT uint8_t *data()
        {
            return Array2D<uint8_t>::mutableData();
        }

        ZIVID_UTILS_EXPORT const uint8_t *data() const
        {
            return Array2D<uint8_t>::data();
        }

        ZIVID_UTILS_EXPORT uint8_t *begin()
        {
            return Array2D<uint8_t>::mutableBegin();
        }

        ZIVID_UTILS_EXPORT uint8_t *end()
        {
            return Array2D<uint8_t>::mutableEnd();
        }

        ZIVID_UTILS_EXPORT uint8_t &operator()(size_t idx)
        {
#ifdef __clang__
#    if __has_warning("-Wunsafe-buffer-usage")
#        pragma clang diagnostic push
#        pragma clang diagnostic ignored "-Wunsafe-buffer-usage"
#    endif
#endif
            return *(data() + idx);
#ifdef __clang__
#    if __has_warning("-Wunsafe-buffer-usage")
#        pragma clang diagnostic pop
#    endif
#endif
        }

        ZIVID_UTILS_EXPORT uint8_t &operator()(size_t i, size_t j)
        {
#ifdef __clang__
#    if __has_warning("-Wunsafe-buffer-usage")
#        pragma clang diagnostic push
#        pragma clang diagnostic ignored "-Wunsafe-buffer-usage"
#    endif
#endif
            return operator()((width() * i) + j);
#ifdef __clang__
#    if __has_warning("-Wunsafe-buffer-usage")
#        pragma clang diagnostic pop
#    endif
#endif
        }

        ZIVID_UTILS_EXPORT const uint8_t &operator()(size_t idx) const
        {
            return Array2D<uint8_t>::operator()(idx);
        }

        ZIVID_UTILS_EXPORT const uint8_t &operator()(size_t i, size_t j) const
        {
            return Array2D<uint8_t>::operator()(i, j);
        }
    };

    ZIVID_UTILS_EXPORT std::ostream &operator<<(std::ostream &stream, const Mask &mask);
 
} // namespace Zivid