ImageBase.h

// This file is a part of the OpenSurgSim project.
// Copyright 2016, SimQuest Solutions Inc.
//
// 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
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// 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 SURGSIM_DATASTRUCTURES_IMAGEBASE_H
#define SURGSIM_DATASTRUCTURES_IMAGEBASE_H

#include <array>
#include <Eigen/Core>


namespace SurgSim
{
namespace DataStructures
{

template<class T>
class ImageBase
{
public:
    virtual ~ImageBase();

    size_t getWidth() const;

    size_t getHeight() const;

    std::array<size_t, 3> getSize() const;

    size_t getNumChannels() const;

    Eigen::Map<Eigen::Matrix<T, Eigen::Dynamic, 1>> operator()(size_t x, size_t y);

    Eigen::Map<const Eigen::Matrix<T, Eigen::Dynamic, 1>> operator()(size_t x, size_t y) const;

    typedef Eigen::Matrix<T, Eigen::Dynamic, Eigen::Dynamic> ChannelType;

    Eigen::Map<ChannelType, Eigen::Unaligned, Eigen::Stride<-1, -1>> getChannel(size_t index);

    Eigen::Map<const ChannelType, Eigen::Unaligned, Eigen::Stride<-1, -1>> getChannel(size_t index) const;

    void setChannel(size_t index, const Eigen::Ref<const ChannelType>& data);

    typedef Eigen::Matrix<T, Eigen::Dynamic, 1> VectorType;

    Eigen::Map<VectorType, Eigen::Unaligned> getAsVector();

    Eigen::Map<const VectorType, Eigen::Unaligned> getAsVector() const;

    void setAsVector(const Eigen::Ref<const VectorType>& data);

    virtual T* const getData() = 0;

    virtual const T* const getData() const = 0;

protected:
    void setSize(size_t width, size_t height, size_t channels);

private:
    size_t m_width = 0;
    size_t m_height = 0;
    size_t m_channels = 0;
};

};
};

#include "SurgSim/DataStructures/ImageBase-inl.h"

#endif //SURGSIM_DATASTRUCTURES_IMAGEBASE_H