VoxelPoolingGradOpKernel.h

Go to the documentation of this file.

// ----------------------------------------------------------------------------
// -                        Open3D: www.open3d.org                            -
// ----------------------------------------------------------------------------
// Copyright (c) 2018-2024 www.open3d.org
// SPDX-License-Identifier: MIT
// ----------------------------------------------------------------------------
 
#pragma once
 
#include <cstdint>
 
#include "absl/status/status.h"
#include "open3d/ml/impl/misc/VoxelPooling.h"
#include "tensorflow/core/framework/op.h"
#include "tensorflow/core/framework/op_kernel.h"
#include "tensorflow/core/lib/core/errors.h"
 
// namespace for code that is common for all kernels
namespace voxel_pooling_opkernel {
 
template <class TReal, class TFeat>
class OutputAllocator {
public:
    OutputAllocator(tensorflow::OpKernelContext* context) : context(context) {}
 
    void AllocPooledPositions(TReal** ptr, size_t num) {
        using namespace tensorflow;
        *ptr = nullptr;
        Tensor* tensor = 0;
        TensorShape shape({int64_t(num), 3});
        OP_REQUIRES_OK(context, context->allocate_output(0, shape, &tensor));
        auto flat_tensor = tensor->flat<TReal>();
        *ptr = flat_tensor.data();
    }
 
    void AllocPooledFeatures(TFeat** ptr, size_t num, int channels) {
        using namespace tensorflow;
        *ptr = nullptr;
        Tensor* tensor = 0;
        TensorShape shape({int64_t(num), channels});
        OP_REQUIRES_OK(context, context->allocate_output(1, shape, &tensor));
        auto flat_tensor = tensor->flat<TFeat>();
        *ptr = flat_tensor.data();
    }
 
private:
    tensorflow::OpKernelContext* context;
};
 
// Base class with common code for the OpKernel implementations
class VoxelPoolingGradOpKernel : public tensorflow::OpKernel {
public:
    explicit VoxelPoolingGradOpKernel(
            tensorflow::OpKernelConstruction* construction)
        : OpKernel(construction) {
        using namespace tensorflow;
        using namespace open3d::ml::impl;
        std::string pos_fn_str;
        OP_REQUIRES_OK(construction,
                       construction->GetAttr("position_fn", &pos_fn_str));
 
        if (pos_fn_str == "average")
            position_fn = AVERAGE;
        else if (pos_fn_str == "nearest_neighbor")
            position_fn = NEAREST_NEIGHBOR;
        else
            position_fn = CENTER;
 
        std::string feat_fn_str;
        OP_REQUIRES_OK(construction,
                       construction->GetAttr("feature_fn", &feat_fn_str));
 
        if (feat_fn_str == "average")
            feature_fn = AVERAGE;
        else if (feat_fn_str == "nearest_neighbor")
            feature_fn = NEAREST_NEIGHBOR;
        else
            feature_fn = MAX;
    }
 
    void Compute(tensorflow::OpKernelContext* context) override {
        using namespace tensorflow;
        using namespace open3d::ml::impl;
 
        const Tensor& positions = context->input(0);
        OP_REQUIRES(context, positions.shape().dims() == 2,
                    absl::InvalidArgumentError(
                            "positions must be a rank 2 tensor"));
 
        const Tensor& features = context->input(1);
        OP_REQUIRES(
                context, features.shape().dims() == 2,
                absl::InvalidArgumentError("features must be a rank 2 tensor"));
 
        const Tensor& voxel_size = context->input(2);
        OP_REQUIRES(
                context, TensorShapeUtils::IsScalar(voxel_size.shape()),
                absl::InvalidArgumentError(
                        std::string("voxel_size must be a scalar, but is ") +
                        voxel_size.shape().DebugString()));
 
        const Tensor& pooled_positions = context->input(3);
        OP_REQUIRES(context, pooled_positions.shape().dims() == 2,
                    absl::InvalidArgumentError(
                            "pooled_positions must be a rank 2 tensor"));
 
        const Tensor& pooled_features_gradient = context->input(4);
        OP_REQUIRES(
                context, pooled_features_gradient.shape().dims() == 2,
                absl::InvalidArgumentError(
                        "pooled_features_gradient must be a rank 2 tensor"));
 
        Tensor* features_backprop = nullptr;
        OP_REQUIRES_OK(context, context->allocate_output(0, features.shape(),
                                                         &features_backprop));
 
        Kernel(context, *features_backprop, positions, features,
               pooled_positions, pooled_features_gradient, voxel_size);
    }
 
    // Function with the device specific code
    virtual void Kernel(tensorflow::OpKernelContext* context,
                        tensorflow::Tensor& features_backprop,
                        const tensorflow::Tensor& positions,
                        const tensorflow::Tensor& features,
                        const tensorflow::Tensor& pooled_positions,
                        const tensorflow::Tensor& pooled_features_gradient,
                        const tensorflow::Tensor& voxel_size) = 0;
 
protected:
    open3d::ml::impl::AccumulationFn position_fn;
    open3d::ml::impl::AccumulationFn feature_fn;
};
 
}  // namespace voxel_pooling_opkernel